flywheel-sdk 21.2.0__py3-none-any.whl

flywheel/models/protocol.py

@@ -0,0 +1,515 @@
+# 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
+"""
+
+
+## NOTE: This file is auto generated by the swagger code generator program.
+## Do not edit the file manually.
+
+import pprint
+import re  # noqa: F401
+import six
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from flywheel.models.container_reference import ContainerReference  # noqa: F401,E501
+    from flywheel.models.custom_form import CustomForm  # noqa: F401,E501
+    from flywheel.models.protocol_e_signature_config import ProtocolESignatureConfig  # noqa: F401,E501
+    from flywheel.models.protocol_status import ProtocolStatus  # noqa: F401,E501
+    from flywheel.models.reader_task_config import ReaderTaskConfig  # noqa: F401,E501
+
+class Protocol(object):
+
+    swagger_types = {
+        'id': 'str',
+        'label': 'str',
+        'form': 'CustomForm',
+        'protocol_config': 'ReaderTaskConfig',
+        'created': 'datetime',
+        'modified': 'datetime',
+        'replaced': 'datetime',
+        'version': 'int',
+        'status': 'ProtocolStatus',
+        'parent_ref': 'ContainerReference',
+        'task_type': 'str',
+        'completion_tags': 'list[str]',
+        'notes': 'str',
+        'esignature_config': 'ProtocolESignatureConfig'
+    }
+
+    attribute_map = {
+        'id': '_id',
+        'label': 'label',
+        'form': 'form',
+        'protocol_config': 'protocol_config',
+        'created': 'created',
+        'modified': 'modified',
+        'replaced': 'replaced',
+        'version': 'version',
+        'status': 'status',
+        'parent_ref': 'parent_ref',
+        'task_type': 'task_type',
+        'completion_tags': 'completion_tags',
+        'notes': 'notes',
+        'esignature_config': 'esignature_config'
+    }
+
+    rattribute_map = {
+        '_id': 'id',
+        'label': 'label',
+        'form': 'form',
+        'protocol_config': 'protocol_config',
+        'created': 'created',
+        'modified': 'modified',
+        'replaced': 'replaced',
+        'version': 'version',
+        'status': 'status',
+        'parent_ref': 'parent_ref',
+        'task_type': 'task_type',
+        'completion_tags': 'completion_tags',
+        'notes': 'notes',
+        'esignature_config': 'esignature_config'
+    }
+
+    def __init__(self, id=None, label=None, form=None, protocol_config=None, created=None, modified=None, replaced=None, version=None, status=None, parent_ref=None, task_type=None, completion_tags=None, notes=None, esignature_config=None):  # noqa: E501
+        """Protocol - a model defined in Swagger"""
+        super(Protocol, self).__init__()
+
+        self._id = None
+        self._label = None
+        self._form = None
+        self._protocol_config = None
+        self._created = None
+        self._modified = None
+        self._replaced = None
+        self._version = None
+        self._status = None
+        self._parent_ref = None
+        self._task_type = None
+        self._completion_tags = None
+        self._notes = None
+        self._esignature_config = None
+        self.discriminator = None
+        self.alt_discriminator = None
+
+        self.id = id
+        self.label = label
+        if form is not None:
+            self.form = form
+        self.protocol_config = protocol_config
+        self.created = created
+        if modified is not None:
+            self.modified = modified
+        if replaced is not None:
+            self.replaced = replaced
+        self.version = version
+        if status is not None:
+            self.status = status
+        self.parent_ref = parent_ref
+        self.task_type = task_type
+        if completion_tags is not None:
+            self.completion_tags = completion_tags
+        if notes is not None:
+            self.notes = notes
+        if esignature_config is not None:
+            self.esignature_config = esignature_config
+
+    @property
+    def id(self):
+        """Gets the id of this Protocol.
+
+
+        :return: The id of this Protocol.
+        :rtype: str
+        """
+        return self._id
+
+    @id.setter
+    def id(self, id):
+        """Sets the id of this Protocol.
+
+
+        :param id: The id of this Protocol.  # noqa: E501
+        :type: str
+        """
+
+        self._id = id
+
+    @property
+    def label(self):
+        """Gets the label of this Protocol.
+
+
+        :return: The label of this Protocol.
+        :rtype: str
+        """
+        return self._label
+
+    @label.setter
+    def label(self, label):
+        """Sets the label of this Protocol.
+
+
+        :param label: The label of this Protocol.  # noqa: E501
+        :type: str
+        """
+
+        self._label = label
+
+    @property
+    def form(self):
+        """Gets the form of this Protocol.
+
+
+        :return: The form of this Protocol.
+        :rtype: CustomForm
+        """
+        return self._form
+
+    @form.setter
+    def form(self, form):
+        """Sets the form of this Protocol.
+
+
+        :param form: The form of this Protocol.  # noqa: E501
+        :type: CustomForm
+        """
+
+        self._form = form
+
+    @property
+    def protocol_config(self):
+        """Gets the protocol_config of this Protocol.
+
+
+        :return: The protocol_config of this Protocol.
+        :rtype: ReaderTaskConfig
+        """
+        return self._protocol_config
+
+    @protocol_config.setter
+    def protocol_config(self, protocol_config):
+        """Sets the protocol_config of this Protocol.
+
+
+        :param protocol_config: The protocol_config of this Protocol.  # noqa: E501
+        :type: ReaderTaskConfig
+        """
+
+        self._protocol_config = protocol_config
+
+    @property
+    def created(self):
+        """Gets the created of this Protocol.
+
+
+        :return: The created of this Protocol.
+        :rtype: datetime
+        """
+        return self._created
+
+    @created.setter
+    def created(self, created):
+        """Sets the created of this Protocol.
+
+
+        :param created: The created of this Protocol.  # noqa: E501
+        :type: datetime
+        """
+
+        self._created = created
+
+    @property
+    def modified(self):
+        """Gets the modified of this Protocol.
+
+
+        :return: The modified of this Protocol.
+        :rtype: datetime
+        """
+        return self._modified
+
+    @modified.setter
+    def modified(self, modified):
+        """Sets the modified of this Protocol.
+
+
+        :param modified: The modified of this Protocol.  # noqa: E501
+        :type: datetime
+        """
+
+        self._modified = modified
+
+    @property
+    def replaced(self):
+        """Gets the replaced of this Protocol.
+
+
+        :return: The replaced of this Protocol.
+        :rtype: datetime
+        """
+        return self._replaced
+
+    @replaced.setter
+    def replaced(self, replaced):
+        """Sets the replaced of this Protocol.
+
+
+        :param replaced: The replaced of this Protocol.  # noqa: E501
+        :type: datetime
+        """
+
+        self._replaced = replaced
+
+    @property
+    def version(self):
+        """Gets the version of this Protocol.
+
+
+        :return: The version of this Protocol.
+        :rtype: int
+        """
+        return self._version
+
+    @version.setter
+    def version(self, version):
+        """Sets the version of this Protocol.
+
+
+        :param version: The version of this Protocol.  # noqa: E501
+        :type: int
+        """
+
+        self._version = version
+
+    @property
+    def status(self):
+        """Gets the status of this Protocol.
+
+
+        :return: The status of this Protocol.
+        :rtype: ProtocolStatus
+        """
+        return self._status
+
+    @status.setter
+    def status(self, status):
+        """Sets the status of this Protocol.
+
+
+        :param status: The status of this Protocol.  # noqa: E501
+        :type: ProtocolStatus
+        """
+
+        self._status = status
+
+    @property
+    def parent_ref(self):
+        """Gets the parent_ref of this Protocol.
+
+
+        :return: The parent_ref of this Protocol.
+        :rtype: ContainerReference
+        """
+        return self._parent_ref
+
+    @parent_ref.setter
+    def parent_ref(self, parent_ref):
+        """Sets the parent_ref of this Protocol.
+
+
+        :param parent_ref: The parent_ref of this Protocol.  # noqa: E501
+        :type: ContainerReference
+        """
+
+        self._parent_ref = parent_ref
+
+    @property
+    def task_type(self):
+        """Gets the task_type of this Protocol.
+
+
+        :return: The task_type of this Protocol.
+        :rtype: str
+        """
+        return self._task_type
+
+    @task_type.setter
+    def task_type(self, task_type):
+        """Sets the task_type of this Protocol.
+
+
+        :param task_type: The task_type of this Protocol.  # noqa: E501
+        :type: str
+        """
+
+        self._task_type = task_type
+
+    @property
+    def completion_tags(self):
+        """Gets the completion_tags of this Protocol.
+
+
+        :return: The completion_tags of this Protocol.
+        :rtype: list[str]
+        """
+        return self._completion_tags
+
+    @completion_tags.setter
+    def completion_tags(self, completion_tags):
+        """Sets the completion_tags of this Protocol.
+
+
+        :param completion_tags: The completion_tags of this Protocol.  # noqa: E501
+        :type: list[str]
+        """
+
+        self._completion_tags = completion_tags
+
+    @property
+    def notes(self):
+        """Gets the notes of this Protocol.
+
+
+        :return: The notes of this Protocol.
+        :rtype: str
+        """
+        return self._notes
+
+    @notes.setter
+    def notes(self, notes):
+        """Sets the notes of this Protocol.
+
+
+        :param notes: The notes of this Protocol.  # noqa: E501
+        :type: str
+        """
+
+        self._notes = notes
+
+    @property
+    def esignature_config(self):
+        """Gets the esignature_config of this Protocol.
+
+
+        :return: The esignature_config of this Protocol.
+        :rtype: ProtocolESignatureConfig
+        """
+        return self._esignature_config
+
+    @esignature_config.setter
+    def esignature_config(self, esignature_config):
+        """Sets the esignature_config of this Protocol.
+
+
+        :param esignature_config: The esignature_config of this Protocol.  # noqa: E501
+        :type: ProtocolESignatureConfig
+        """
+
+        self._esignature_config = esignature_config
+
+
+    @staticmethod
+    def positional_to_model(value):
+        """Converts a positional argument to a model value"""
+        return value
+
+    def return_value(self):
+        """Unwraps return value from model"""
+        return self
+
+    def to_dict(self):
+        """Returns the model properties as a dict"""
+        result = {}
+
+        for attr, _ in six.iteritems(self.swagger_types):
+            value = getattr(self, attr)
+            if isinstance(value, list):
+                result[attr] = list(map(
+                    lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+                    value
+                ))
+            elif hasattr(value, "to_dict"):
+                result[attr] = value.to_dict()
+            elif isinstance(value, dict):
+                result[attr] = dict(map(
+                    lambda item: (item[0], item[1].to_dict())
+                    if hasattr(item[1], "to_dict") else item,
+                    value.items()
+                ))
+            else:
+                result[attr] = value
+
+        return result
+
+    def to_str(self):
+        """Returns the string representation of the model"""
+        return pprint.pformat(self.to_dict())
+
+    def __repr__(self):
+        """For `print` and `pprint`"""
+        return self.to_str()
+
+    def __eq__(self, other):
+        """Returns true if both objects are equal"""
+        if not isinstance(other, Protocol):
+            return False
+
+        return self.__dict__ == other.__dict__
+
+    def __ne__(self, other):
+        """Returns true if both objects are not equal"""
+        return not self == other
+
+    # Container emulation
+    def __getitem__(self, key):
+        """Returns the value of key"""
+        key = self._map_key(key)
+        return getattr(self, key)
+
+    def __setitem__(self, key, value):
+        """Sets the value of key"""
+        key = self._map_key(key)
+        setattr(self, key, value)
+
+    def __contains__(self, key):
+        """Checks if the given value is a key in this object"""
+        key = self._map_key(key, raise_on_error=False)
+        return key is not None
+
+    def keys(self):
+        """Returns the list of json properties in the object"""
+        return self.__class__.rattribute_map.keys()
+
+    def values(self):
+        """Returns the list of values in the object"""
+        for key in self.__class__.attribute_map.keys():
+            yield getattr(self, key)
+
+    def items(self):
+        """Returns the list of json property to value mapping"""
+        for key, prop in self.__class__.rattribute_map.items():
+            yield key, getattr(self, prop)
+
+    def get(self, key, default=None):
+        """Get the value of the provided json property, or default"""
+        key = self._map_key(key, raise_on_error=False)
+        if key:
+            return getattr(self, key, default)
+        return default
+
+    def _map_key(self, key, raise_on_error=True):
+        result = self.__class__.rattribute_map.get(key)
+        if result is None:
+            if raise_on_error:
+                raise AttributeError('Invalid attribute name: {}'.format(key))
+            return None
+        return '_' + result

flywheel/models/protocol_e_signature_config.py

@@ -0,0 +1,191 @@
+# 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
+"""
+
+
+## NOTE: This file is auto generated by the swagger code generator program.
+## Do not edit the file manually.
+
+import pprint
+import re  # noqa: F401
+import six
+from typing import TYPE_CHECKING
+
+class ProtocolESignatureConfig(object):
+
+    swagger_types = {
+        'required': 'bool',
+        'reasons': 'list[str]'
+    }
+
+    attribute_map = {
+        'required': 'required',
+        'reasons': 'reasons'
+    }
+
+    rattribute_map = {
+        'required': 'required',
+        'reasons': 'reasons'
+    }
+
+    def __init__(self, required=False, reasons=None):  # noqa: E501
+        """ProtocolESignatureConfig - a model defined in Swagger"""
+        super(ProtocolESignatureConfig, self).__init__()
+
+        self._required = None
+        self._reasons = None
+        self.discriminator = None
+        self.alt_discriminator = None
+
+        if required is not None:
+            self.required = required
+        if reasons is not None:
+            self.reasons = reasons
+
+    @property
+    def required(self):
+        """Gets the required of this ProtocolESignatureConfig.
+
+
+        :return: The required of this ProtocolESignatureConfig.
+        :rtype: bool
+        """
+        return self._required
+
+    @required.setter
+    def required(self, required):
+        """Sets the required of this ProtocolESignatureConfig.
+
+
+        :param required: The required of this ProtocolESignatureConfig.  # noqa: E501
+        :type: bool
+        """
+
+        self._required = required
+
+    @property
+    def reasons(self):
+        """Gets the reasons of this ProtocolESignatureConfig.
+
+
+        :return: The reasons of this ProtocolESignatureConfig.
+        :rtype: list[str]
+        """
+        return self._reasons
+
+    @reasons.setter
+    def reasons(self, reasons):
+        """Sets the reasons of this ProtocolESignatureConfig.
+
+
+        :param reasons: The reasons of this ProtocolESignatureConfig.  # noqa: E501
+        :type: list[str]
+        """
+
+        self._reasons = reasons
+
+
+    @staticmethod
+    def positional_to_model(value):
+        """Converts a positional argument to a model value"""
+        return value
+
+    def return_value(self):
+        """Unwraps return value from model"""
+        return self
+
+    def to_dict(self):
+        """Returns the model properties as a dict"""
+        result = {}
+
+        for attr, _ in six.iteritems(self.swagger_types):
+            value = getattr(self, attr)
+            if isinstance(value, list):
+                result[attr] = list(map(
+                    lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+                    value
+                ))
+            elif hasattr(value, "to_dict"):
+                result[attr] = value.to_dict()
+            elif isinstance(value, dict):
+                result[attr] = dict(map(
+                    lambda item: (item[0], item[1].to_dict())
+                    if hasattr(item[1], "to_dict") else item,
+                    value.items()
+                ))
+            else:
+                result[attr] = value
+
+        return result
+
+    def to_str(self):
+        """Returns the string representation of the model"""
+        return pprint.pformat(self.to_dict())
+
+    def __repr__(self):
+        """For `print` and `pprint`"""
+        return self.to_str()
+
+    def __eq__(self, other):
+        """Returns true if both objects are equal"""
+        if not isinstance(other, ProtocolESignatureConfig):
+            return False
+
+        return self.__dict__ == other.__dict__
+
+    def __ne__(self, other):
+        """Returns true if both objects are not equal"""
+        return not self == other
+
+    # Container emulation
+    def __getitem__(self, key):
+        """Returns the value of key"""
+        key = self._map_key(key)
+        return getattr(self, key)
+
+    def __setitem__(self, key, value):
+        """Sets the value of key"""
+        key = self._map_key(key)
+        setattr(self, key, value)
+
+    def __contains__(self, key):
+        """Checks if the given value is a key in this object"""
+        key = self._map_key(key, raise_on_error=False)
+        return key is not None
+
+    def keys(self):
+        """Returns the list of json properties in the object"""
+        return self.__class__.rattribute_map.keys()
+
+    def values(self):
+        """Returns the list of values in the object"""
+        for key in self.__class__.attribute_map.keys():
+            yield getattr(self, key)
+
+    def items(self):
+        """Returns the list of json property to value mapping"""
+        for key, prop in self.__class__.rattribute_map.items():
+            yield key, getattr(self, prop)
+
+    def get(self, key, default=None):
+        """Get the value of the provided json property, or default"""
+        key = self._map_key(key, raise_on_error=False)
+        if key:
+            return getattr(self, key, default)
+        return default
+
+    def _map_key(self, key, raise_on_error=True):
+        result = self.__class__.rattribute_map.get(key)
+        if result is None:
+            if raise_on_error:
+                raise AttributeError('Invalid attribute name: {}'.format(key))
+            return None
+        return '_' + result