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

flywheel/api/devices_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 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 DeviceCreate body: (required)
-        :param bool async_: Perform the request asynchronously
-        :return: EgressDevice
+        :param body:
+        :type body: DeviceCreate
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: EgressDevice
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -63,9 +58,11 @@ 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 DeviceCreate body: (required)
-        :param bool async_: Perform the request asynchronously
-        :return: EgressDevice
+        :param body:
+        :type body: DeviceCreate
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: EgressDevice
         """
 
         all_params = ['body',]  # noqa: E501
@@ -145,9 +142,11 @@ class DevicesApi(object):
         Delete a device
         This method makes a synchronous HTTP request by default.
 
-        :param str device_id: (required)
-        :param bool async_: Perform the request asynchronously
-        :return: None
+        :param device_id:
+        :type device_id: str
+        :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
@@ -171,9 +170,11 @@ class DevicesApi(object):
         Delete a device
         This method makes a synchronous HTTP request by default.
 
-        :param str device_id: (required)
-        :param bool async_: Perform the request asynchronously
-        :return: None
+        :param device_id:
+        :type device_id: str
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: None
         """
 
         all_params = ['device_id',]  # noqa: E501
@@ -241,10 +242,13 @@ class DevicesApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param str device_id: (required)
-        :param str key_id: (required)
-        :param bool async_: Perform the request asynchronously
-        :return: None
+        :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
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -267,10 +271,13 @@ class DevicesApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param str device_id: (required)
-        :param str key_id: (required)
-        :param bool async_: Perform the request asynchronously
-        :return: None
+        :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
         """
 
         all_params = ['device_id','key_id',]  # noqa: E501
@@ -345,10 +352,13 @@ class DevicesApi(object):
         Regenerate device API key
         This method makes a synchronous HTTP request by default.
 
-        :param str device_id: (required)
-        :param ApiKeyInputWithOptionalLabel body:
-        :param bool async_: Perform the request asynchronously
-        :return: ApiKeyOutput
+        :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
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -372,10 +382,13 @@ class DevicesApi(object):
         Regenerate device API key
         This method makes a synchronous HTTP request by default.
 
-        :param str device_id: (required)
-        :param ApiKeyInputWithOptionalLabel body:
-        :param bool async_: Perform the request asynchronously
-        :return: ApiKeyOutput
+        :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
         """
 
         all_params = ['device_id','body',]  # noqa: E501
@@ -457,16 +470,25 @@ class DevicesApi(object):
         Requires login.
         This method makes a synchronous HTTP request by default.
 
-        :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]
+        :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]
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -490,16 +512,25 @@ class DevicesApi(object):
         Requires login.
         This method makes a synchronous HTTP request by default.
 
-        :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]
+        :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]
         """
 
         all_params = ['join_keys','filter','sort','limit','skip','page','after_id','x_accept_feature',]  # noqa: E501
@@ -579,8 +610,9 @@ class DevicesApi(object):
         ok - missing - error - unknown
         This method makes a synchronous HTTP request by default.
 
-        :param bool async_: Perform the request asynchronously
-        :return: dict(str, DeviceStatusEntry)
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: dict(str, DeviceStatusEntry)
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -604,8 +636,9 @@ class DevicesApi(object):
         ok - missing - error - unknown
         This method makes a synchronous HTTP request by default.
 
-        :param bool async_: Perform the request asynchronously
-        :return: dict(str, DeviceStatusEntry)
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: dict(str, DeviceStatusEntry)
         """
 
         all_params = []  # noqa: E501
@@ -668,8 +701,9 @@ class DevicesApi(object):
         Get current device.
         This method makes a synchronous HTTP request by default.
 
-        :param bool async_: Perform the request asynchronously
-        :return: EgressDevice
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: EgressDevice
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -693,8 +727,9 @@ class DevicesApi(object):
         Get current device.
         This method makes a synchronous HTTP request by default.
 
-        :param bool async_: Perform the request asynchronously
-        :return: EgressDevice
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: EgressDevice
         """
 
         all_params = []  # noqa: E501
@@ -756,9 +791,11 @@ class DevicesApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param str device_id: (required)
-        :param bool async_: Perform the request asynchronously
-        :return: EgressDevice
+        :param device_id:
+        :type device_id: str
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: EgressDevice
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -781,9 +818,11 @@ class DevicesApi(object):
 
         This method makes a synchronous HTTP request by default.
 
-        :param str device_id: (required)
-        :param bool async_: Perform the request asynchronously
-        :return: EgressDevice
+        :param device_id:
+        :type device_id: str
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: EgressDevice
         """
 
         all_params = ['device_id',]  # noqa: E501
@@ -852,10 +891,13 @@ class DevicesApi(object):
         Update a device
         This method makes a synchronous HTTP request by default.
 
-        :param str device_id: (required)
-        :param DeviceAdminUpdate body: (required)
-        :param bool async_: Perform the request asynchronously
-        :return: EgressDevice
+        :param device_id:
+        :type device_id: str
+        :param body:
+        :type body: DeviceAdminUpdate
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: EgressDevice
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -879,10 +921,13 @@ class DevicesApi(object):
         Update a device
         This method makes a synchronous HTTP request by default.
 
-        :param str device_id: (required)
-        :param DeviceAdminUpdate body: (required)
-        :param bool async_: Perform the request asynchronously
-        :return: EgressDevice
+        :param device_id:
+        :type device_id: str
+        :param body:
+        :type body: DeviceAdminUpdate
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: EgressDevice
         """
 
         all_params = ['device_id','body',]  # noqa: E501
@@ -968,9 +1013,11 @@ 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 DeviceSelfUpdate body: (required)
-        :param bool async_: Perform the request asynchronously
-        :return: EgressDevice
+        :param body:
+        :type body: DeviceSelfUpdate
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: EgressDevice
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -994,9 +1041,11 @@ 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 DeviceSelfUpdate body: (required)
-        :param bool async_: Perform the request asynchronously
-        :return: EgressDevice
+        :param body:
+        :type body: DeviceSelfUpdate
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: EgressDevice
         """
 
         all_params = ['body',]  # noqa: E501

flywheel/api/dimse_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 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 ProjectAETInput body: (required)
-        :param bool async_: Perform the request asynchronously
-        :return: BaseAET
+        :param body:
+        :type body: ProjectAETInput
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: BaseAET
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -63,9 +58,11 @@ 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 ProjectAETInput body: (required)
-        :param bool async_: Perform the request asynchronously
-        :return: BaseAET
+        :param body:
+        :type body: ProjectAETInput
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: BaseAET
         """
 
         all_params = ['body',]  # noqa: E501
@@ -145,9 +142,11 @@ 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 union[ProjectAETInput,ServiceAETInput] body: (required)
-        :param bool async_: Perform the request asynchronously
-        :return: ServiceAET
+        :param body:
+        :type body: union[ProjectAETInput,ServiceAETInput]
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: ServiceAET
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -171,9 +170,11 @@ 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 union[ProjectAETInput,ServiceAETInput] body: (required)
-        :param bool async_: Perform the request asynchronously
-        :return: ServiceAET
+        :param body:
+        :type body: union[ProjectAETInput,ServiceAETInput]
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: ServiceAET
         """
 
         all_params = ['body',]  # noqa: E501
@@ -253,9 +254,11 @@ 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 str project_aet: (required)
-        :param bool async_: Perform the request asynchronously
-        :return: dict(str, int)
+        :param project_aet:
+        :type project_aet: str
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: dict(str, int)
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -279,9 +282,11 @@ 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 str project_aet: (required)
-        :param bool async_: Perform the request asynchronously
-        :return: dict(str, int)
+        :param project_aet:
+        :type project_aet: str
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: dict(str, int)
         """
 
         all_params = ['project_aet',]  # noqa: E501
@@ -350,9 +355,11 @@ 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 str service_aet: (required)
-        :param bool async_: Perform the request asynchronously
-        :return: dict(str, int)
+        :param service_aet:
+        :type service_aet: str
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: dict(str, int)
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -376,9 +383,11 @@ 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 str service_aet: (required)
-        :param bool async_: Perform the request asynchronously
-        :return: dict(str, int)
+        :param service_aet:
+        :type service_aet: str
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: dict(str, int)
         """
 
         all_params = ['service_aet',]  # noqa: E501
@@ -447,8 +456,9 @@ 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 bool async_: Perform the request asynchronously
-        :return: list[ProjectAET]
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: list[ProjectAET]
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -472,8 +482,9 @@ 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 bool async_: Perform the request asynchronously
-        :return: list[ProjectAET]
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: list[ProjectAET]
         """
 
         all_params = []  # noqa: E501
@@ -536,8 +547,9 @@ 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 bool async_: Perform the request asynchronously
-        :return: list[ServiceAET]
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: list[ServiceAET]
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -561,8 +573,9 @@ 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 bool async_: Perform the request asynchronously
-        :return: list[ServiceAET]
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: list[ServiceAET]
         """
 
         all_params = []  # noqa: E501
@@ -625,9 +638,11 @@ 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 str project_aet: (required)
-        :param bool async_: Perform the request asynchronously
-        :return: ProjectAET
+        :param project_aet:
+        :type project_aet: str
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: ProjectAET
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -651,9 +666,11 @@ 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 str project_aet: (required)
-        :param bool async_: Perform the request asynchronously
-        :return: ProjectAET
+        :param project_aet:
+        :type project_aet: str
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: ProjectAET
         """
 
         all_params = ['project_aet',]  # noqa: E501
@@ -722,9 +739,11 @@ class DimseApi(object):
         Get a DIMSE service. Requires login and admin privilege.
         This method makes a synchronous HTTP request by default.
 
-        :param str service_aet: (required)
-        :param bool async_: Perform the request asynchronously
-        :return: ServiceAET
+        :param service_aet:
+        :type service_aet: str
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: ServiceAET
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -748,9 +767,11 @@ class DimseApi(object):
         Get a DIMSE service. Requires login and admin privilege.
         This method makes a synchronous HTTP request by default.
 
-        :param str service_aet: (required)
-        :param bool async_: Perform the request asynchronously
-        :return: ServiceAET
+        :param service_aet:
+        :type service_aet: str
+        :param async_: Perform the request asynchronously
+        :type async_: bool, optional
+        :rtype: ServiceAET
         """
 
         all_params = ['service_aet',]  # noqa: E501