docusign_esign.models.expirations

  1# coding: utf-8
  2
  3"""
  4    Docusign eSignature REST API
  5
  6    The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign.  # noqa: E501
  7
  8    OpenAPI spec version: v2.1
  9    Contact: devcenter@docusign.com
 10    Generated by: https://github.com/swagger-api/swagger-codegen.git
 11"""
 12
 13
 14import pprint
 15import re  # noqa: F401
 16
 17import six
 18
 19from docusign_esign.client.configuration import Configuration
 20
 21
 22class Expirations(object):
 23    """NOTE: This class is auto generated by the swagger code generator program.
 24
 25    Do not edit the class manually.
 26    """
 27
 28    """
 29    Attributes:
 30      swagger_types (dict): The key is attribute name
 31                            and the value is attribute type.
 32      attribute_map (dict): The key is attribute name
 33                            and the value is json key in definition.
 34    """
 35    swagger_types = {
 36        'expire_after': 'str',
 37        'expire_enabled': 'str',
 38        'expire_warn': 'str'
 39    }
 40
 41    attribute_map = {
 42        'expire_after': 'expireAfter',
 43        'expire_enabled': 'expireEnabled',
 44        'expire_warn': 'expireWarn'
 45    }
 46
 47    def __init__(self, _configuration=None, **kwargs):  # noqa: E501
 48        """Expirations - a model defined in Swagger"""  # noqa: E501
 49        if _configuration is None:
 50            _configuration = Configuration()
 51        self._configuration = _configuration
 52
 53        self._expire_after = None
 54        self._expire_enabled = None
 55        self._expire_warn = None
 56        self.discriminator = None
 57
 58        setattr(self, "_{}".format('expire_after'), kwargs.get('expire_after', None))
 59        setattr(self, "_{}".format('expire_enabled'), kwargs.get('expire_enabled', None))
 60        setattr(self, "_{}".format('expire_warn'), kwargs.get('expire_warn', None))
 61
 62    @property
 63    def expire_after(self):
 64        """Gets the expire_after of this Expirations.  # noqa: E501
 65
 66        An integer that sets the number of days the envelope is active.  # noqa: E501
 67
 68        :return: The expire_after of this Expirations.  # noqa: E501
 69        :rtype: str
 70        """
 71        return self._expire_after
 72
 73    @expire_after.setter
 74    def expire_after(self, expire_after):
 75        """Sets the expire_after of this Expirations.
 76
 77        An integer that sets the number of days the envelope is active.  # noqa: E501
 78
 79        :param expire_after: The expire_after of this Expirations.  # noqa: E501
 80        :type: str
 81        """
 82
 83        self._expire_after = expire_after
 84
 85    @property
 86    def expire_enabled(self):
 87        """Gets the expire_enabled of this Expirations.  # noqa: E501
 88
 89        When set to **true**, the envelope expires (is no longer available for signing) in the set number of days. If false, the account default setting is used. If the account does not have an expiration setting, the DocuSign default value of 120 days is used.  # noqa: E501
 90
 91        :return: The expire_enabled of this Expirations.  # noqa: E501
 92        :rtype: str
 93        """
 94        return self._expire_enabled
 95
 96    @expire_enabled.setter
 97    def expire_enabled(self, expire_enabled):
 98        """Sets the expire_enabled of this Expirations.
 99
100        When set to **true**, the envelope expires (is no longer available for signing) in the set number of days. If false, the account default setting is used. If the account does not have an expiration setting, the DocuSign default value of 120 days is used.  # noqa: E501
101
102        :param expire_enabled: The expire_enabled of this Expirations.  # noqa: E501
103        :type: str
104        """
105
106        self._expire_enabled = expire_enabled
107
108    @property
109    def expire_warn(self):
110        """Gets the expire_warn of this Expirations.  # noqa: E501
111
112        An integer that sets the number of days before envelope expiration that an expiration warning email is sent to the recipient. If set to 0 (zero), no warning email is sent.  # noqa: E501
113
114        :return: The expire_warn of this Expirations.  # noqa: E501
115        :rtype: str
116        """
117        return self._expire_warn
118
119    @expire_warn.setter
120    def expire_warn(self, expire_warn):
121        """Sets the expire_warn of this Expirations.
122
123        An integer that sets the number of days before envelope expiration that an expiration warning email is sent to the recipient. If set to 0 (zero), no warning email is sent.  # noqa: E501
124
125        :param expire_warn: The expire_warn of this Expirations.  # noqa: E501
126        :type: str
127        """
128
129        self._expire_warn = expire_warn
130
131    def to_dict(self):
132        """Returns the model properties as a dict"""
133        result = {}
134
135        for attr, _ in six.iteritems(self.swagger_types):
136            value = getattr(self, attr)
137            if isinstance(value, list):
138                result[attr] = list(map(
139                    lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
140                    value
141                ))
142            elif hasattr(value, "to_dict"):
143                result[attr] = value.to_dict()
144            elif isinstance(value, dict):
145                result[attr] = dict(map(
146                    lambda item: (item[0], item[1].to_dict())
147                    if hasattr(item[1], "to_dict") else item,
148                    value.items()
149                ))
150            else:
151                result[attr] = value
152        if issubclass(Expirations, dict):
153            for key, value in self.items():
154                result[key] = value
155
156        return result
157
158    def to_str(self):
159        """Returns the string representation of the model"""
160        return pprint.pformat(self.to_dict())
161
162    def __repr__(self):
163        """For `print` and `pprint`"""
164        return self.to_str()
165
166    def __eq__(self, other):
167        """Returns true if both objects are equal"""
168        if not isinstance(other, Expirations):
169            return False
170
171        return self.to_dict() == other.to_dict()
172
173    def __ne__(self, other):
174        """Returns true if both objects are not equal"""
175        if not isinstance(other, Expirations):
176            return True
177
178        return self.to_dict() != other.to_dict()