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

flywheel/models/report_access_log_origin.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,7 +30,13 @@ class ReportAccessLogOrigin(object):
     }
 
     def __init__(self, type=None, id=None):  # noqa: E501
-        """ReportAccessLogOrigin - a model defined in Swagger"""
+        """ReportAccessLogOrigin - a model defined in Swagger
+
+        :param type: The origin type (e.g. user), defaults to None
+        :type type: str, optional
+        :param id: The origin id (e.g. user id), defaults to None
+        :type id: str, optional
+        """
         super(ReportAccessLogOrigin, self).__init__()
 
         self._type = None
@@ -55,7 +54,7 @@ class ReportAccessLogOrigin(object):
 
         The origin type (e.g. user)
 
-        :return: The type of this ReportAccessLogOrigin.
+        :return: The type of this ReportAccessLogOrigin
         :rtype: str
         """
         return self._type
@@ -66,8 +65,8 @@ class ReportAccessLogOrigin(object):
 
         The origin type (e.g. user)
 
-        :param type: The type of this ReportAccessLogOrigin.  # noqa: E501
-        :type: str
+        :param type: The type of this ReportAccessLogOrigin
+        :type type: str
         """
 
         self._type = type
@@ -78,7 +77,7 @@ class ReportAccessLogOrigin(object):
 
         The origin id (e.g. user id)
 
-        :return: The id of this ReportAccessLogOrigin.
+        :return: The id of this ReportAccessLogOrigin
         :rtype: str
         """
         return self._id
@@ -89,8 +88,8 @@ class ReportAccessLogOrigin(object):
 
         The origin id (e.g. user id)
 
-        :param id: The id of this ReportAccessLogOrigin.  # noqa: E501
-        :type: str
+        :param id: The id of this ReportAccessLogOrigin
+        :type id: str
         """
 
         self._id = id

flywheel/models/report_availability_list.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,7 +30,11 @@ class ReportAvailabilityList(object):
     }
 
     def __init__(self, available_reports=None):  # noqa: E501
-        """ReportAvailabilityList - a model defined in Swagger"""
+        """ReportAvailabilityList - a model defined in Swagger
+
+        :param available_reports:, defaults to None
+        :type available_reports: list[ReportTimePeriod], optional
+        """
         super(ReportAvailabilityList, self).__init__()
 
         self._available_reports = None
@@ -52,7 +49,7 @@ class ReportAvailabilityList(object):
         """Gets the available_reports of this ReportAvailabilityList.
 
 
-        :return: The available_reports of this ReportAvailabilityList.
+        :return: The available_reports of this ReportAvailabilityList
         :rtype: list[ReportTimePeriod]
         """
         return self._available_reports
@@ -62,8 +59,8 @@ class ReportAvailabilityList(object):
         """Sets the available_reports of this ReportAvailabilityList.
 
 
-        :param available_reports: The available_reports of this ReportAvailabilityList.  # noqa: E501
-        :type: list[ReportTimePeriod]
+        :param available_reports: The available_reports of this ReportAvailabilityList
+        :type available_reports: list[ReportTimePeriod]
         """
 
         self._available_reports = available_reports

flywheel/models/report_daily_usage_entry.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
 """
 
 
@@ -70,7 +63,35 @@ class ReportDailyUsageEntry(object):
     }
 
     def __init__(self, year=None, month=None, day=None, group=None, project=None, project_label=None, session_count=None, center_job_count=None, group_job_count=None, center_compute_ms=None, group_compute_ms=None, center_storage_bytes=None, group_storage_bytes=None):  # noqa: E501
-        """ReportDailyUsageEntry - a model defined in Swagger"""
+        """ReportDailyUsageEntry - a model defined in Swagger
+
+        :param year: The year that this record represents, defaults to None
+        :type year: int, optional
+        :param month: The month that this record represents, defaults to None
+        :type month: int, optional
+        :param day: The day that this record represents, defaults to None
+        :type day: int, optional
+        :param group: The group label, defaults to None
+        :type group: str, optional
+        :param project: Unique database ID, defaults to None
+        :type project: str, optional
+        :param project_label: Application-specific label, defaults to None
+        :type project_label: str, optional
+        :param session_count: The number of sessions that existed at the last collection time, defaults to None
+        :type session_count: int, optional
+        :param center_job_count: The number of center-designated gear jobs that completed during the time frame (billable to the center), defaults to None
+        :type center_job_count: int, optional
+        :param group_job_count: The number of non-center-designated (lab) gear jobs that completed during the time frame (billable to the group), defaults to None
+        :type group_job_count: int, optional
+        :param center_compute_ms: The compute time of center-designated gear jobs completed during the time frame (billable to the center), defaults to None
+        :type center_compute_ms: int, optional
+        :param group_compute_ms: The compute time of non-center-designated (lab) gear jobs completed during the time frame (billable to the group), defaults to None
+        :type group_compute_ms: int, optional
+        :param center_storage_bytes: The total storage used by files originating from devices or center-designated gears on this day (billable to the center), defaults to None
+        :type center_storage_bytes: int, optional
+        :param group_storage_bytes: The total storage used by files not originating from devices or non-center-designated (lab) gears on this day (billable to the group), defaults to None
+        :type group_storage_bytes: int, optional
+        """
         super(ReportDailyUsageEntry, self).__init__()
 
         self._year = None
@@ -109,7 +130,7 @@ class ReportDailyUsageEntry(object):
 
         The year that this record represents
 
-        :return: The year of this ReportDailyUsageEntry.
+        :return: The year of this ReportDailyUsageEntry
         :rtype: int
         """
         return self._year
@@ -120,8 +141,8 @@ class ReportDailyUsageEntry(object):
 
         The year that this record represents
 
-        :param year: The year of this ReportDailyUsageEntry.  # noqa: E501
-        :type: int
+        :param year: The year of this ReportDailyUsageEntry
+        :type year: int
         """
 
         self._year = year
@@ -132,7 +153,7 @@ class ReportDailyUsageEntry(object):
 
         The month that this record represents
 
-        :return: The month of this ReportDailyUsageEntry.
+        :return: The month of this ReportDailyUsageEntry
         :rtype: int
         """
         return self._month
@@ -143,8 +164,8 @@ class ReportDailyUsageEntry(object):
 
         The month that this record represents
 
-        :param month: The month of this ReportDailyUsageEntry.  # noqa: E501
-        :type: int
+        :param month: The month of this ReportDailyUsageEntry
+        :type month: int
         """
 
         self._month = month
@@ -155,7 +176,7 @@ class ReportDailyUsageEntry(object):
 
         The day that this record represents
 
-        :return: The day of this ReportDailyUsageEntry.
+        :return: The day of this ReportDailyUsageEntry
         :rtype: int
         """
         return self._day
@@ -166,8 +187,8 @@ class ReportDailyUsageEntry(object):
 
         The day that this record represents
 
-        :param day: The day of this ReportDailyUsageEntry.  # noqa: E501
-        :type: int
+        :param day: The day of this ReportDailyUsageEntry
+        :type day: int
         """
 
         self._day = day
@@ -178,7 +199,7 @@ class ReportDailyUsageEntry(object):
 
         The group label
 
-        :return: The group of this ReportDailyUsageEntry.
+        :return: The group of this ReportDailyUsageEntry
         :rtype: str
         """
         return self._group
@@ -189,8 +210,8 @@ class ReportDailyUsageEntry(object):
 
         The group label
 
-        :param group: The group of this ReportDailyUsageEntry.  # noqa: E501
-        :type: str
+        :param group: The group of this ReportDailyUsageEntry
+        :type group: str
         """
 
         self._group = group
@@ -201,7 +222,7 @@ class ReportDailyUsageEntry(object):
 
         Unique database ID
 
-        :return: The project of this ReportDailyUsageEntry.
+        :return: The project of this ReportDailyUsageEntry
         :rtype: str
         """
         return self._project
@@ -212,8 +233,8 @@ class ReportDailyUsageEntry(object):
 
         Unique database ID
 
-        :param project: The project of this ReportDailyUsageEntry.  # noqa: E501
-        :type: str
+        :param project: The project of this ReportDailyUsageEntry
+        :type project: str
         """
 
         self._project = project
@@ -224,7 +245,7 @@ class ReportDailyUsageEntry(object):
 
         Application-specific label
 
-        :return: The project_label of this ReportDailyUsageEntry.
+        :return: The project_label of this ReportDailyUsageEntry
         :rtype: str
         """
         return self._project_label
@@ -235,8 +256,8 @@ class ReportDailyUsageEntry(object):
 
         Application-specific label
 
-        :param project_label: The project_label of this ReportDailyUsageEntry.  # noqa: E501
-        :type: str
+        :param project_label: The project_label of this ReportDailyUsageEntry
+        :type project_label: str
         """
 
         self._project_label = project_label
@@ -247,7 +268,7 @@ class ReportDailyUsageEntry(object):
 
         The number of sessions that existed at the last collection time
 
-        :return: The session_count of this ReportDailyUsageEntry.
+        :return: The session_count of this ReportDailyUsageEntry
         :rtype: int
         """
         return self._session_count
@@ -258,8 +279,8 @@ class ReportDailyUsageEntry(object):
 
         The number of sessions that existed at the last collection time
 
-        :param session_count: The session_count of this ReportDailyUsageEntry.  # noqa: E501
-        :type: int
+        :param session_count: The session_count of this ReportDailyUsageEntry
+        :type session_count: int
         """
 
         self._session_count = session_count
@@ -270,7 +291,7 @@ class ReportDailyUsageEntry(object):
 
         The number of center-designated gear jobs that completed during the time frame (billable to the center)
 
-        :return: The center_job_count of this ReportDailyUsageEntry.
+        :return: The center_job_count of this ReportDailyUsageEntry
         :rtype: int
         """
         return self._center_job_count
@@ -281,8 +302,8 @@ class ReportDailyUsageEntry(object):
 
         The number of center-designated gear jobs that completed during the time frame (billable to the center)
 
-        :param center_job_count: The center_job_count of this ReportDailyUsageEntry.  # noqa: E501
-        :type: int
+        :param center_job_count: The center_job_count of this ReportDailyUsageEntry
+        :type center_job_count: int
         """
 
         self._center_job_count = center_job_count
@@ -293,7 +314,7 @@ class ReportDailyUsageEntry(object):
 
         The number of non-center-designated (lab) gear jobs that completed during the time frame (billable to the group)
 
-        :return: The group_job_count of this ReportDailyUsageEntry.
+        :return: The group_job_count of this ReportDailyUsageEntry
         :rtype: int
         """
         return self._group_job_count
@@ -304,8 +325,8 @@ class ReportDailyUsageEntry(object):
 
         The number of non-center-designated (lab) gear jobs that completed during the time frame (billable to the group)
 
-        :param group_job_count: The group_job_count of this ReportDailyUsageEntry.  # noqa: E501
-        :type: int
+        :param group_job_count: The group_job_count of this ReportDailyUsageEntry
+        :type group_job_count: int
         """
 
         self._group_job_count = group_job_count
@@ -316,7 +337,7 @@ class ReportDailyUsageEntry(object):
 
         The compute time of center-designated gear jobs completed during the time frame (billable to the center)
 
-        :return: The center_compute_ms of this ReportDailyUsageEntry.
+        :return: The center_compute_ms of this ReportDailyUsageEntry
         :rtype: int
         """
         return self._center_compute_ms
@@ -327,8 +348,8 @@ class ReportDailyUsageEntry(object):
 
         The compute time of center-designated gear jobs completed during the time frame (billable to the center)
 
-        :param center_compute_ms: The center_compute_ms of this ReportDailyUsageEntry.  # noqa: E501
-        :type: int
+        :param center_compute_ms: The center_compute_ms of this ReportDailyUsageEntry
+        :type center_compute_ms: int
         """
 
         self._center_compute_ms = center_compute_ms
@@ -339,7 +360,7 @@ class ReportDailyUsageEntry(object):
 
         The compute time of non-center-designated (lab) gear jobs completed during the time frame (billable to the group)
 
-        :return: The group_compute_ms of this ReportDailyUsageEntry.
+        :return: The group_compute_ms of this ReportDailyUsageEntry
         :rtype: int
         """
         return self._group_compute_ms
@@ -350,8 +371,8 @@ class ReportDailyUsageEntry(object):
 
         The compute time of non-center-designated (lab) gear jobs completed during the time frame (billable to the group)
 
-        :param group_compute_ms: The group_compute_ms of this ReportDailyUsageEntry.  # noqa: E501
-        :type: int
+        :param group_compute_ms: The group_compute_ms of this ReportDailyUsageEntry
+        :type group_compute_ms: int
         """
 
         self._group_compute_ms = group_compute_ms
@@ -362,7 +383,7 @@ class ReportDailyUsageEntry(object):
 
         The total storage used by files originating from devices or center-designated gears on this day (billable to the center)
 
-        :return: The center_storage_bytes of this ReportDailyUsageEntry.
+        :return: The center_storage_bytes of this ReportDailyUsageEntry
         :rtype: int
         """
         return self._center_storage_bytes
@@ -373,8 +394,8 @@ class ReportDailyUsageEntry(object):
 
         The total storage used by files originating from devices or center-designated gears on this day (billable to the center)
 
-        :param center_storage_bytes: The center_storage_bytes of this ReportDailyUsageEntry.  # noqa: E501
-        :type: int
+        :param center_storage_bytes: The center_storage_bytes of this ReportDailyUsageEntry
+        :type center_storage_bytes: int
         """
 
         self._center_storage_bytes = center_storage_bytes
@@ -385,7 +406,7 @@ class ReportDailyUsageEntry(object):
 
         The total storage used by files not originating from devices or non-center-designated (lab) gears on this day (billable to the group)
 
-        :return: The group_storage_bytes of this ReportDailyUsageEntry.
+        :return: The group_storage_bytes of this ReportDailyUsageEntry
         :rtype: int
         """
         return self._group_storage_bytes
@@ -396,8 +417,8 @@ class ReportDailyUsageEntry(object):
 
         The total storage used by files not originating from devices or non-center-designated (lab) gears on this day (billable to the group)
 
-        :param group_storage_bytes: The group_storage_bytes of this ReportDailyUsageEntry.  # noqa: E501
-        :type: int
+        :param group_storage_bytes: The group_storage_bytes of this ReportDailyUsageEntry
+        :type group_storage_bytes: int
         """
 
         self._group_storage_bytes = group_storage_bytes

flywheel/models/report_demographics_grid.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
 """
 
 

flywheel/models/report_ethnicity_grid.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
 """
 
 
@@ -45,7 +38,17 @@ class ReportEthnicityGrid(object):
     }
 
     def __init__(self, not_hispanic_or_latino=None, hispanic_or_latino=None, unknown_or_not_reported=None, total=None):  # noqa: E501
-        """ReportEthnicityGrid - a model defined in Swagger"""
+        """ReportEthnicityGrid - a model defined in Swagger
+
+        :param not_hispanic_or_latino:, defaults to None
+        :type not_hispanic_or_latino: ReportGenderCount, optional
+        :param hispanic_or_latino:, defaults to None
+        :type hispanic_or_latino: ReportGenderCount, optional
+        :param unknown_or_not_reported:, defaults to None
+        :type unknown_or_not_reported: ReportGenderCount, optional
+        :param total:, defaults to None
+        :type total: int, optional
+        """
         super(ReportEthnicityGrid, self).__init__()
         warnings.warn(
             f"The {self.__class__.__name__} model has been deprecated and "
@@ -74,7 +77,7 @@ class ReportEthnicityGrid(object):
         """Gets the not_hispanic_or_latino of this ReportEthnicityGrid.
 
 
-        :return: The not_hispanic_or_latino of this ReportEthnicityGrid.
+        :return: The not_hispanic_or_latino of this ReportEthnicityGrid
         :rtype: ReportGenderCount
         """
         return self._not_hispanic_or_latino
@@ -84,8 +87,8 @@ class ReportEthnicityGrid(object):
         """Sets the not_hispanic_or_latino of this ReportEthnicityGrid.
 
 
-        :param not_hispanic_or_latino: The not_hispanic_or_latino of this ReportEthnicityGrid.  # noqa: E501
-        :type: ReportGenderCount
+        :param not_hispanic_or_latino: The not_hispanic_or_latino of this ReportEthnicityGrid
+        :type not_hispanic_or_latino: ReportGenderCount
         """
 
         self._not_hispanic_or_latino = not_hispanic_or_latino
@@ -95,7 +98,7 @@ class ReportEthnicityGrid(object):
         """Gets the hispanic_or_latino of this ReportEthnicityGrid.
 
 
-        :return: The hispanic_or_latino of this ReportEthnicityGrid.
+        :return: The hispanic_or_latino of this ReportEthnicityGrid
         :rtype: ReportGenderCount
         """
         return self._hispanic_or_latino
@@ -105,8 +108,8 @@ class ReportEthnicityGrid(object):
         """Sets the hispanic_or_latino of this ReportEthnicityGrid.
 
 
-        :param hispanic_or_latino: The hispanic_or_latino of this ReportEthnicityGrid.  # noqa: E501
-        :type: ReportGenderCount
+        :param hispanic_or_latino: The hispanic_or_latino of this ReportEthnicityGrid
+        :type hispanic_or_latino: ReportGenderCount
         """
 
         self._hispanic_or_latino = hispanic_or_latino
@@ -116,7 +119,7 @@ class ReportEthnicityGrid(object):
         """Gets the unknown_or_not_reported of this ReportEthnicityGrid.
 
 
-        :return: The unknown_or_not_reported of this ReportEthnicityGrid.
+        :return: The unknown_or_not_reported of this ReportEthnicityGrid
         :rtype: ReportGenderCount
         """
         return self._unknown_or_not_reported
@@ -126,8 +129,8 @@ class ReportEthnicityGrid(object):
         """Sets the unknown_or_not_reported of this ReportEthnicityGrid.
 
 
-        :param unknown_or_not_reported: The unknown_or_not_reported of this ReportEthnicityGrid.  # noqa: E501
-        :type: ReportGenderCount
+        :param unknown_or_not_reported: The unknown_or_not_reported of this ReportEthnicityGrid
+        :type unknown_or_not_reported: ReportGenderCount
         """
 
         self._unknown_or_not_reported = unknown_or_not_reported
@@ -137,7 +140,7 @@ class ReportEthnicityGrid(object):
         """Gets the total of this ReportEthnicityGrid.
 
 
-        :return: The total of this ReportEthnicityGrid.
+        :return: The total of this ReportEthnicityGrid
         :rtype: int
         """
         return self._total
@@ -147,8 +150,8 @@ class ReportEthnicityGrid(object):
         """Sets the total of this ReportEthnicityGrid.
 
 
-        :param total: The total of this ReportEthnicityGrid.  # noqa: E501
-        :type: int
+        :param total: The total of this ReportEthnicityGrid
+        :type total: int
         """
 
         self._total = total

flywheel/models/report_gender_count.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
 """
 
 
@@ -42,7 +35,15 @@ class ReportGenderCount(object):
     }
 
     def __init__(self, male=None, unknown_or_not_reported=None, female=None):  # noqa: E501
-        """ReportGenderCount - a model defined in Swagger"""
+        """ReportGenderCount - a model defined in Swagger
+
+        :param male:, defaults to None
+        :type male: int, optional
+        :param unknown_or_not_reported:, defaults to None
+        :type unknown_or_not_reported: int, optional
+        :param female:, defaults to None
+        :type female: int, optional
+        """
         super(ReportGenderCount, self).__init__()
         warnings.warn(
             f"The {self.__class__.__name__} model has been deprecated and "
@@ -65,7 +66,7 @@ class ReportGenderCount(object):
         """Gets the male of this ReportGenderCount.
 
 
-        :return: The male of this ReportGenderCount.
+        :return: The male of this ReportGenderCount
         :rtype: int
         """
         return self._male
@@ -75,8 +76,8 @@ class ReportGenderCount(object):
         """Sets the male of this ReportGenderCount.
 
 
-        :param male: The male of this ReportGenderCount.  # noqa: E501
-        :type: int
+        :param male: The male of this ReportGenderCount
+        :type male: int
         """
 
         self._male = male
@@ -86,7 +87,7 @@ class ReportGenderCount(object):
         """Gets the unknown_or_not_reported of this ReportGenderCount.
 
 
-        :return: The unknown_or_not_reported of this ReportGenderCount.
+        :return: The unknown_or_not_reported of this ReportGenderCount
         :rtype: int
         """
         return self._unknown_or_not_reported
@@ -96,8 +97,8 @@ class ReportGenderCount(object):
         """Sets the unknown_or_not_reported of this ReportGenderCount.
 
 
-        :param unknown_or_not_reported: The unknown_or_not_reported of this ReportGenderCount.  # noqa: E501
-        :type: int
+        :param unknown_or_not_reported: The unknown_or_not_reported of this ReportGenderCount
+        :type unknown_or_not_reported: int
         """
 
         self._unknown_or_not_reported = unknown_or_not_reported
@@ -107,7 +108,7 @@ class ReportGenderCount(object):
         """Gets the female of this ReportGenderCount.
 
 
-        :return: The female of this ReportGenderCount.
+        :return: The female of this ReportGenderCount
         :rtype: int
         """
         return self._female
@@ -117,8 +118,8 @@ class ReportGenderCount(object):
         """Sets the female of this ReportGenderCount.
 
 
-        :param female: The female of this ReportGenderCount.  # noqa: E501
-        :type: int
+        :param female: The female of this ReportGenderCount
+        :type female: int
         """
 
         self._female = female