docusign_esign.models.reminders

  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 Reminders(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        'maximum_reminder_count': 'str',
 37        'reminder_delay': 'str',
 38        'reminder_enabled': 'str',
 39        'reminder_frequency': 'str',
 40        'smart_reminder_enabled': 'str'
 41    }
 42
 43    attribute_map = {
 44        'maximum_reminder_count': 'maximumReminderCount',
 45        'reminder_delay': 'reminderDelay',
 46        'reminder_enabled': 'reminderEnabled',
 47        'reminder_frequency': 'reminderFrequency',
 48        'smart_reminder_enabled': 'smartReminderEnabled'
 49    }
 50
 51    def __init__(self, _configuration=None, **kwargs):  # noqa: E501
 52        """Reminders - a model defined in Swagger"""  # noqa: E501
 53        if _configuration is None:
 54            _configuration = Configuration()
 55        self._configuration = _configuration
 56
 57        self._maximum_reminder_count = None
 58        self._reminder_delay = None
 59        self._reminder_enabled = None
 60        self._reminder_frequency = None
 61        self._smart_reminder_enabled = None
 62        self.discriminator = None
 63
 64        setattr(self, "_{}".format('maximum_reminder_count'), kwargs.get('maximum_reminder_count', None))
 65        setattr(self, "_{}".format('reminder_delay'), kwargs.get('reminder_delay', None))
 66        setattr(self, "_{}".format('reminder_enabled'), kwargs.get('reminder_enabled', None))
 67        setattr(self, "_{}".format('reminder_frequency'), kwargs.get('reminder_frequency', None))
 68        setattr(self, "_{}".format('smart_reminder_enabled'), kwargs.get('smart_reminder_enabled', None))
 69
 70    @property
 71    def maximum_reminder_count(self):
 72        """Gets the maximum_reminder_count of this Reminders.  # noqa: E501
 73
 74          # noqa: E501
 75
 76        :return: The maximum_reminder_count of this Reminders.  # noqa: E501
 77        :rtype: str
 78        """
 79        return self._maximum_reminder_count
 80
 81    @maximum_reminder_count.setter
 82    def maximum_reminder_count(self, maximum_reminder_count):
 83        """Sets the maximum_reminder_count of this Reminders.
 84
 85          # noqa: E501
 86
 87        :param maximum_reminder_count: The maximum_reminder_count of this Reminders.  # noqa: E501
 88        :type: str
 89        """
 90
 91        self._maximum_reminder_count = maximum_reminder_count
 92
 93    @property
 94    def reminder_delay(self):
 95        """Gets the reminder_delay of this Reminders.  # noqa: E501
 96
 97        An interger that sets the number of days after the recipient receives the envelope that reminder emails are sent to the recipient.  # noqa: E501
 98
 99        :return: The reminder_delay of this Reminders.  # noqa: E501
100        :rtype: str
101        """
102        return self._reminder_delay
103
104    @reminder_delay.setter
105    def reminder_delay(self, reminder_delay):
106        """Sets the reminder_delay of this Reminders.
107
108        An interger that sets the number of days after the recipient receives the envelope that reminder emails are sent to the recipient.  # noqa: E501
109
110        :param reminder_delay: The reminder_delay of this Reminders.  # noqa: E501
111        :type: str
112        """
113
114        self._reminder_delay = reminder_delay
115
116    @property
117    def reminder_enabled(self):
118        """Gets the reminder_enabled of this Reminders.  # noqa: E501
119
120        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
121
122        :return: The reminder_enabled of this Reminders.  # noqa: E501
123        :rtype: str
124        """
125        return self._reminder_enabled
126
127    @reminder_enabled.setter
128    def reminder_enabled(self, reminder_enabled):
129        """Sets the reminder_enabled of this Reminders.
130
131        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
132
133        :param reminder_enabled: The reminder_enabled of this Reminders.  # noqa: E501
134        :type: str
135        """
136
137        self._reminder_enabled = reminder_enabled
138
139    @property
140    def reminder_frequency(self):
141        """Gets the reminder_frequency of this Reminders.  # noqa: E501
142
143        An interger that sets the interval, in days, between reminder emails.  # noqa: E501
144
145        :return: The reminder_frequency of this Reminders.  # noqa: E501
146        :rtype: str
147        """
148        return self._reminder_frequency
149
150    @reminder_frequency.setter
151    def reminder_frequency(self, reminder_frequency):
152        """Sets the reminder_frequency of this Reminders.
153
154        An interger that sets the interval, in days, between reminder emails.  # noqa: E501
155
156        :param reminder_frequency: The reminder_frequency of this Reminders.  # noqa: E501
157        :type: str
158        """
159
160        self._reminder_frequency = reminder_frequency
161
162    @property
163    def smart_reminder_enabled(self):
164        """Gets the smart_reminder_enabled of this Reminders.  # noqa: E501
165
166          # noqa: E501
167
168        :return: The smart_reminder_enabled of this Reminders.  # noqa: E501
169        :rtype: str
170        """
171        return self._smart_reminder_enabled
172
173    @smart_reminder_enabled.setter
174    def smart_reminder_enabled(self, smart_reminder_enabled):
175        """Sets the smart_reminder_enabled of this Reminders.
176
177          # noqa: E501
178
179        :param smart_reminder_enabled: The smart_reminder_enabled of this Reminders.  # noqa: E501
180        :type: str
181        """
182
183        self._smart_reminder_enabled = smart_reminder_enabled
184
185    def to_dict(self):
186        """Returns the model properties as a dict"""
187        result = {}
188
189        for attr, _ in six.iteritems(self.swagger_types):
190            value = getattr(self, attr)
191            if isinstance(value, list):
192                result[attr] = list(map(
193                    lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
194                    value
195                ))
196            elif hasattr(value, "to_dict"):
197                result[attr] = value.to_dict()
198            elif isinstance(value, dict):
199                result[attr] = dict(map(
200                    lambda item: (item[0], item[1].to_dict())
201                    if hasattr(item[1], "to_dict") else item,
202                    value.items()
203                ))
204            else:
205                result[attr] = value
206        if issubclass(Reminders, dict):
207            for key, value in self.items():
208                result[key] = value
209
210        return result
211
212    def to_str(self):
213        """Returns the string representation of the model"""
214        return pprint.pformat(self.to_dict())
215
216    def __repr__(self):
217        """For `print` and `pprint`"""
218        return self.to_str()
219
220    def __eq__(self, other):
221        """Returns true if both objects are equal"""
222        if not isinstance(other, Reminders):
223            return False
224
225        return self.to_dict() == other.to_dict()
226
227    def __ne__(self, other):
228        """Returns true if both objects are not equal"""
229        if not isinstance(other, Reminders):
230            return True
231
232        return self.to_dict() != other.to_dict()