docusign_esign.models.scheduled_sending

  1# coding: utf-8
  2
  3"""
  4    DocuSign REST API
  5
  6    The DocuSign 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 ScheduledSending(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        'bulk_list_id': 'str',
 37        'resume_date': 'str',
 38        'rules': 'list[EnvelopeDelayRule]',
 39        'status': 'str'
 40    }
 41
 42    attribute_map = {
 43        'bulk_list_id': 'bulkListId',
 44        'resume_date': 'resumeDate',
 45        'rules': 'rules',
 46        'status': 'status'
 47    }
 48
 49    def __init__(self, _configuration=None, **kwargs):  # noqa: E501
 50        """ScheduledSending - a model defined in Swagger"""  # noqa: E501
 51        if _configuration is None:
 52            _configuration = Configuration()
 53        self._configuration = _configuration
 54
 55        self._bulk_list_id = None
 56        self._resume_date = None
 57        self._rules = None
 58        self._status = None
 59        self.discriminator = None
 60
 61        setattr(self, "_{}".format('bulk_list_id'), kwargs.get('bulk_list_id', None))
 62        setattr(self, "_{}".format('resume_date'), kwargs.get('resume_date', None))
 63        setattr(self, "_{}".format('rules'), kwargs.get('rules', None))
 64        setattr(self, "_{}".format('status'), kwargs.get('status', None))
 65
 66    @property
 67    def bulk_list_id(self):
 68        """Gets the bulk_list_id of this ScheduledSending.  # noqa: E501
 69
 70          # noqa: E501
 71
 72        :return: The bulk_list_id of this ScheduledSending.  # noqa: E501
 73        :rtype: str
 74        """
 75        return self._bulk_list_id
 76
 77    @bulk_list_id.setter
 78    def bulk_list_id(self, bulk_list_id):
 79        """Sets the bulk_list_id of this ScheduledSending.
 80
 81          # noqa: E501
 82
 83        :param bulk_list_id: The bulk_list_id of this ScheduledSending.  # noqa: E501
 84        :type: str
 85        """
 86
 87        self._bulk_list_id = bulk_list_id
 88
 89    @property
 90    def resume_date(self):
 91        """Gets the resume_date of this ScheduledSending.  # noqa: E501
 92
 93        An ISO 8601 formatted datetime string indicating the date and time that the envelope is (or was) scheduled to be sent or null if the envelope has not yet been sent.  # noqa: E501
 94
 95        :return: The resume_date of this ScheduledSending.  # noqa: E501
 96        :rtype: str
 97        """
 98        return self._resume_date
 99
100    @resume_date.setter
101    def resume_date(self, resume_date):
102        """Sets the resume_date of this ScheduledSending.
103
104        An ISO 8601 formatted datetime string indicating the date and time that the envelope is (or was) scheduled to be sent or null if the envelope has not yet been sent.  # noqa: E501
105
106        :param resume_date: The resume_date of this ScheduledSending.  # noqa: E501
107        :type: str
108        """
109
110        self._resume_date = resume_date
111
112    @property
113    def rules(self):
114        """Gets the rules of this ScheduledSending.  # noqa: E501
115
116        A list of envelope delay rules specified by the user indicating how and when the envelope should be scheduled for sending in the future. Currently only 1 rule may be specified.  # noqa: E501
117
118        :return: The rules of this ScheduledSending.  # noqa: E501
119        :rtype: list[EnvelopeDelayRule]
120        """
121        return self._rules
122
123    @rules.setter
124    def rules(self, rules):
125        """Sets the rules of this ScheduledSending.
126
127        A list of envelope delay rules specified by the user indicating how and when the envelope should be scheduled for sending in the future. Currently only 1 rule may be specified.  # noqa: E501
128
129        :param rules: The rules of this ScheduledSending.  # noqa: E501
130        :type: list[EnvelopeDelayRule]
131        """
132
133        self._rules = rules
134
135    @property
136    def status(self):
137        """Gets the status of this ScheduledSending.  # noqa: E501
138
139        \\\"pending\\\" if the envelope has not yet been sent and the scheduled sending delay has not iniaited. \\\"started\\\" if the scheduled sending delay is in progress. \\\"completed\\\" if the scheduled sending delay has elapsed and the envelope has been sent.  # noqa: E501
140
141        :return: The status of this ScheduledSending.  # noqa: E501
142        :rtype: str
143        """
144        return self._status
145
146    @status.setter
147    def status(self, status):
148        """Sets the status of this ScheduledSending.
149
150        \\\"pending\\\" if the envelope has not yet been sent and the scheduled sending delay has not iniaited. \\\"started\\\" if the scheduled sending delay is in progress. \\\"completed\\\" if the scheduled sending delay has elapsed and the envelope has been sent.  # noqa: E501
151
152        :param status: The status of this ScheduledSending.  # noqa: E501
153        :type: str
154        """
155
156        self._status = status
157
158    def to_dict(self):
159        """Returns the model properties as a dict"""
160        result = {}
161
162        for attr, _ in six.iteritems(self.swagger_types):
163            value = getattr(self, attr)
164            if isinstance(value, list):
165                result[attr] = list(map(
166                    lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
167                    value
168                ))
169            elif hasattr(value, "to_dict"):
170                result[attr] = value.to_dict()
171            elif isinstance(value, dict):
172                result[attr] = dict(map(
173                    lambda item: (item[0], item[1].to_dict())
174                    if hasattr(item[1], "to_dict") else item,
175                    value.items()
176                ))
177            else:
178                result[attr] = value
179        if issubclass(ScheduledSending, dict):
180            for key, value in self.items():
181                result[key] = value
182
183        return result
184
185    def to_str(self):
186        """Returns the string representation of the model"""
187        return pprint.pformat(self.to_dict())
188
189    def __repr__(self):
190        """For `print` and `pprint`"""
191        return self.to_str()
192
193    def __eq__(self, other):
194        """Returns true if both objects are equal"""
195        if not isinstance(other, ScheduledSending):
196            return False
197
198        return self.to_dict() == other.to_dict()
199
200    def __ne__(self, other):
201        """Returns true if both objects are not equal"""
202        if not isinstance(other, ScheduledSending):
203            return True
204
205        return self.to_dict() != other.to_dict()