Module mailslurp_client.models.agent_capabilities_dto

MailSlurp API

MailSlurp is an API for sending and receiving emails and SMS from dynamically allocated email addresses and phone numbers. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - Homepage - Get an API KEY - Generated SDK Clients - Examples repository # noqa: E501

The version of the OpenAPI document: 6.5.2 Contact: contact@mailslurp.dev Generated by: https://openapi-generator.tech

Classes

class AgentCapabilitiesDto (connection_id=None, account_id=None, name=None, role=None, permissions=None, scope=None, features=None, limits=None, api_version=None, local_vars_configuration=None)

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

AgentCapabilitiesDto - a model defined in OpenAPI

Expand source code

class AgentCapabilitiesDto(object):
    """NOTE: This class is auto generated by OpenAPI Generator.
    Ref: https://openapi-generator.tech

    Do not edit the class manually.
    """

    """
    Attributes:
      openapi_types (dict): The key is attribute name
                            and the value is attribute type.
      attribute_map (dict): The key is attribute name
                            and the value is json key in definition.
    """
    openapi_types = {
        'connection_id': 'str',
        'account_id': 'str',
        'name': 'str',
        'role': 'str',
        'permissions': 'list[str]',
        'scope': 'AgentCapabilityScopeDto',
        'features': 'AgentCapabilityFeaturesDto',
        'limits': 'AgentCapabilityLimitsDto',
        'api_version': 'str'
    }

    attribute_map = {
        'connection_id': 'connectionId',
        'account_id': 'accountId',
        'name': 'name',
        'role': 'role',
        'permissions': 'permissions',
        'scope': 'scope',
        'features': 'features',
        'limits': 'limits',
        'api_version': 'apiVersion'
    }

    def __init__(self, connection_id=None, account_id=None, name=None, role=None, permissions=None, scope=None, features=None, limits=None, api_version=None, local_vars_configuration=None):  # noqa: E501
        """AgentCapabilitiesDto - a model defined in OpenAPI"""  # noqa: E501
        if local_vars_configuration is None:
            local_vars_configuration = Configuration()
        self.local_vars_configuration = local_vars_configuration

        self._connection_id = None
        self._account_id = None
        self._name = None
        self._role = None
        self._permissions = None
        self._scope = None
        self._features = None
        self._limits = None
        self._api_version = None
        self.discriminator = None

        self.connection_id = connection_id
        self.account_id = account_id
        self.name = name
        self.role = role
        self.permissions = permissions
        self.scope = scope
        self.features = features
        self.limits = limits
        self.api_version = api_version

    @property
    def connection_id(self):
        """Gets the connection_id of this AgentCapabilitiesDto.  # noqa: E501


        :return: The connection_id of this AgentCapabilitiesDto.  # noqa: E501
        :rtype: str
        """
        return self._connection_id

    @connection_id.setter
    def connection_id(self, connection_id):
        """Sets the connection_id of this AgentCapabilitiesDto.


        :param connection_id: The connection_id of this AgentCapabilitiesDto.  # noqa: E501
        :type: str
        """
        if self.local_vars_configuration.client_side_validation and connection_id is None:  # noqa: E501
            raise ValueError("Invalid value for `connection_id`, must not be `None`")  # noqa: E501

        self._connection_id = connection_id

    @property
    def account_id(self):
        """Gets the account_id of this AgentCapabilitiesDto.  # noqa: E501


        :return: The account_id of this AgentCapabilitiesDto.  # noqa: E501
        :rtype: str
        """
        return self._account_id

    @account_id.setter
    def account_id(self, account_id):
        """Sets the account_id of this AgentCapabilitiesDto.


        :param account_id: The account_id of this AgentCapabilitiesDto.  # noqa: E501
        :type: str
        """
        if self.local_vars_configuration.client_side_validation and account_id is None:  # noqa: E501
            raise ValueError("Invalid value for `account_id`, must not be `None`")  # noqa: E501

        self._account_id = account_id

    @property
    def name(self):
        """Gets the name of this AgentCapabilitiesDto.  # noqa: E501


        :return: The name of this AgentCapabilitiesDto.  # noqa: E501
        :rtype: str
        """
        return self._name

    @name.setter
    def name(self, name):
        """Sets the name of this AgentCapabilitiesDto.


        :param name: The name of this AgentCapabilitiesDto.  # noqa: E501
        :type: str
        """
        if self.local_vars_configuration.client_side_validation and name is None:  # noqa: E501
            raise ValueError("Invalid value for `name`, must not be `None`")  # noqa: E501

        self._name = name

    @property
    def role(self):
        """Gets the role of this AgentCapabilitiesDto.  # noqa: E501


        :return: The role of this AgentCapabilitiesDto.  # noqa: E501
        :rtype: str
        """
        return self._role

    @role.setter
    def role(self, role):
        """Sets the role of this AgentCapabilitiesDto.


        :param role: The role of this AgentCapabilitiesDto.  # noqa: E501
        :type: str
        """
        if self.local_vars_configuration.client_side_validation and role is None:  # noqa: E501
            raise ValueError("Invalid value for `role`, must not be `None`")  # noqa: E501
        allowed_values = ["AGENT_READ_ONLY", "AGENT_DRAFT_ONLY", "AGENT_RESPONDER", "AGENT_INBOX_MANAGER", "AGENT_SUPPORT", "AGENT_TOTP_MANAGER"]  # noqa: E501
        if self.local_vars_configuration.client_side_validation and role not in allowed_values:  # noqa: E501
            raise ValueError(
                "Invalid value for `role` ({0}), must be one of {1}"  # noqa: E501
                .format(role, allowed_values)
            )

        self._role = role

    @property
    def permissions(self):
        """Gets the permissions of this AgentCapabilitiesDto.  # noqa: E501


        :return: The permissions of this AgentCapabilitiesDto.  # noqa: E501
        :rtype: list[str]
        """
        return self._permissions

    @permissions.setter
    def permissions(self, permissions):
        """Sets the permissions of this AgentCapabilitiesDto.


        :param permissions: The permissions of this AgentCapabilitiesDto.  # noqa: E501
        :type: list[str]
        """
        if self.local_vars_configuration.client_side_validation and permissions is None:  # noqa: E501
            raise ValueError("Invalid value for `permissions`, must not be `None`")  # noqa: E501

        self._permissions = permissions

    @property
    def scope(self):
        """Gets the scope of this AgentCapabilitiesDto.  # noqa: E501


        :return: The scope of this AgentCapabilitiesDto.  # noqa: E501
        :rtype: AgentCapabilityScopeDto
        """
        return self._scope

    @scope.setter
    def scope(self, scope):
        """Sets the scope of this AgentCapabilitiesDto.


        :param scope: The scope of this AgentCapabilitiesDto.  # noqa: E501
        :type: AgentCapabilityScopeDto
        """
        if self.local_vars_configuration.client_side_validation and scope is None:  # noqa: E501
            raise ValueError("Invalid value for `scope`, must not be `None`")  # noqa: E501

        self._scope = scope

    @property
    def features(self):
        """Gets the features of this AgentCapabilitiesDto.  # noqa: E501


        :return: The features of this AgentCapabilitiesDto.  # noqa: E501
        :rtype: AgentCapabilityFeaturesDto
        """
        return self._features

    @features.setter
    def features(self, features):
        """Sets the features of this AgentCapabilitiesDto.


        :param features: The features of this AgentCapabilitiesDto.  # noqa: E501
        :type: AgentCapabilityFeaturesDto
        """
        if self.local_vars_configuration.client_side_validation and features is None:  # noqa: E501
            raise ValueError("Invalid value for `features`, must not be `None`")  # noqa: E501

        self._features = features

    @property
    def limits(self):
        """Gets the limits of this AgentCapabilitiesDto.  # noqa: E501


        :return: The limits of this AgentCapabilitiesDto.  # noqa: E501
        :rtype: AgentCapabilityLimitsDto
        """
        return self._limits

    @limits.setter
    def limits(self, limits):
        """Sets the limits of this AgentCapabilitiesDto.


        :param limits: The limits of this AgentCapabilitiesDto.  # noqa: E501
        :type: AgentCapabilityLimitsDto
        """
        if self.local_vars_configuration.client_side_validation and limits is None:  # noqa: E501
            raise ValueError("Invalid value for `limits`, must not be `None`")  # noqa: E501

        self._limits = limits

    @property
    def api_version(self):
        """Gets the api_version of this AgentCapabilitiesDto.  # noqa: E501


        :return: The api_version of this AgentCapabilitiesDto.  # noqa: E501
        :rtype: str
        """
        return self._api_version

    @api_version.setter
    def api_version(self, api_version):
        """Sets the api_version of this AgentCapabilitiesDto.


        :param api_version: The api_version of this AgentCapabilitiesDto.  # noqa: E501
        :type: str
        """
        if self.local_vars_configuration.client_side_validation and api_version is None:  # noqa: E501
            raise ValueError("Invalid value for `api_version`, must not be `None`")  # noqa: E501

        self._api_version = api_version

    def to_dict(self):
        """Returns the model properties as a dict"""
        result = {}

        for attr, _ in six.iteritems(self.openapi_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, AgentCapabilitiesDto):
            return False

        return self.to_dict() == other.to_dict()

    def __ne__(self, other):
        """Returns true if both objects are not equal"""
        if not isinstance(other, AgentCapabilitiesDto):
            return True

        return self.to_dict() != other.to_dict()

Class variables

var attribute_map

var openapi_types

Instance variables

prop account_id

Gets the account_id of this AgentCapabilitiesDto. # noqa: E501

:return: The account_id of this AgentCapabilitiesDto. # noqa: E501 :rtype: str

Expand source code

@property
def account_id(self):
    """Gets the account_id of this AgentCapabilitiesDto.  # noqa: E501


    :return: The account_id of this AgentCapabilitiesDto.  # noqa: E501
    :rtype: str
    """
    return self._account_id

prop api_version

Gets the api_version of this AgentCapabilitiesDto. # noqa: E501

:return: The api_version of this AgentCapabilitiesDto. # noqa: E501 :rtype: str

Expand source code

@property
def api_version(self):
    """Gets the api_version of this AgentCapabilitiesDto.  # noqa: E501


    :return: The api_version of this AgentCapabilitiesDto.  # noqa: E501
    :rtype: str
    """
    return self._api_version

prop connection_id

Gets the connection_id of this AgentCapabilitiesDto. # noqa: E501

:return: The connection_id of this AgentCapabilitiesDto. # noqa: E501 :rtype: str

Expand source code

@property
def connection_id(self):
    """Gets the connection_id of this AgentCapabilitiesDto.  # noqa: E501


    :return: The connection_id of this AgentCapabilitiesDto.  # noqa: E501
    :rtype: str
    """
    return self._connection_id

prop features

Gets the features of this AgentCapabilitiesDto. # noqa: E501

:return: The features of this AgentCapabilitiesDto. # noqa: E501 :rtype: AgentCapabilityFeaturesDto

Expand source code

@property
def features(self):
    """Gets the features of this AgentCapabilitiesDto.  # noqa: E501


    :return: The features of this AgentCapabilitiesDto.  # noqa: E501
    :rtype: AgentCapabilityFeaturesDto
    """
    return self._features

prop limits

Gets the limits of this AgentCapabilitiesDto. # noqa: E501

:return: The limits of this AgentCapabilitiesDto. # noqa: E501 :rtype: AgentCapabilityLimitsDto

Expand source code

@property
def limits(self):
    """Gets the limits of this AgentCapabilitiesDto.  # noqa: E501


    :return: The limits of this AgentCapabilitiesDto.  # noqa: E501
    :rtype: AgentCapabilityLimitsDto
    """
    return self._limits

prop name

Gets the name of this AgentCapabilitiesDto. # noqa: E501

:return: The name of this AgentCapabilitiesDto. # noqa: E501 :rtype: str

Expand source code

@property
def name(self):
    """Gets the name of this AgentCapabilitiesDto.  # noqa: E501


    :return: The name of this AgentCapabilitiesDto.  # noqa: E501
    :rtype: str
    """
    return self._name

prop permissions

Gets the permissions of this AgentCapabilitiesDto. # noqa: E501

:return: The permissions of this AgentCapabilitiesDto. # noqa: E501 :rtype: list[str]

Expand source code

@property
def permissions(self):
    """Gets the permissions of this AgentCapabilitiesDto.  # noqa: E501


    :return: The permissions of this AgentCapabilitiesDto.  # noqa: E501
    :rtype: list[str]
    """
    return self._permissions

prop role

Gets the role of this AgentCapabilitiesDto. # noqa: E501

:return: The role of this AgentCapabilitiesDto. # noqa: E501 :rtype: str

Expand source code

@property
def role(self):
    """Gets the role of this AgentCapabilitiesDto.  # noqa: E501


    :return: The role of this AgentCapabilitiesDto.  # noqa: E501
    :rtype: str
    """
    return self._role

prop scope

Gets the scope of this AgentCapabilitiesDto. # noqa: E501

:return: The scope of this AgentCapabilitiesDto. # noqa: E501 :rtype: AgentCapabilityScopeDto

Expand source code

@property
def scope(self):
    """Gets the scope of this AgentCapabilitiesDto.  # noqa: E501


    :return: The scope of this AgentCapabilitiesDto.  # noqa: E501
    :rtype: AgentCapabilityScopeDto
    """
    return self._scope

Methods

def to_dict(self)

Returns the model properties as a dict

def to_str(self)

Returns the string representation of the model