docusign_esign.models.scheduled_sending_api_model

  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 ScheduledSendingApiModel(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        'resume_date': 'str',
 37        'rules': 'list[EnvelopeDelayRuleApiModel]',
 38        'status': 'str'
 39    }
 40
 41    attribute_map = {
 42        'resume_date': 'resumeDate',
 43        'rules': 'rules',
 44        'status': 'status'
 45    }
 46
 47    def __init__(self, _configuration=None, **kwargs):  # noqa: E501
 48        """ScheduledSendingApiModel - a model defined in Swagger"""  # noqa: E501
 49        if _configuration is None:
 50            _configuration = Configuration()
 51        self._configuration = _configuration
 52
 53        self._resume_date = None
 54        self._rules = None
 55        self._status = None
 56        self.discriminator = None
 57
 58        setattr(self, "_{}".format('resume_date'), kwargs.get('resume_date', None))
 59        setattr(self, "_{}".format('rules'), kwargs.get('rules', None))
 60        setattr(self, "_{}".format('status'), kwargs.get('status', None))
 61
 62    @property
 63    def resume_date(self):
 64        """Gets the resume_date of this ScheduledSendingApiModel.  # noqa: E501
 65
 66        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
 67
 68        :return: The resume_date of this ScheduledSendingApiModel.  # noqa: E501
 69        :rtype: str
 70        """
 71        return self._resume_date
 72
 73    @resume_date.setter
 74    def resume_date(self, resume_date):
 75        """Sets the resume_date of this ScheduledSendingApiModel.
 76
 77        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
 78
 79        :param resume_date: The resume_date of this ScheduledSendingApiModel.  # noqa: E501
 80        :type: str
 81        """
 82
 83        self._resume_date = resume_date
 84
 85    @property
 86    def rules(self):
 87        """Gets the rules of this ScheduledSendingApiModel.  # noqa: E501
 88
 89        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
 90
 91        :return: The rules of this ScheduledSendingApiModel.  # noqa: E501
 92        :rtype: list[EnvelopeDelayRuleApiModel]
 93        """
 94        return self._rules
 95
 96    @rules.setter
 97    def rules(self, rules):
 98        """Sets the rules of this ScheduledSendingApiModel.
 99
100        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
101
102        :param rules: The rules of this ScheduledSendingApiModel.  # noqa: E501
103        :type: list[EnvelopeDelayRuleApiModel]
104        """
105
106        self._rules = rules
107
108    @property
109    def status(self):
110        """Gets the status of this ScheduledSendingApiModel.  # noqa: E501
111
112        \"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
113
114        :return: The status of this ScheduledSendingApiModel.  # noqa: E501
115        :rtype: str
116        """
117        return self._status
118
119    @status.setter
120    def status(self, status):
121        """Sets the status of this ScheduledSendingApiModel.
122
123        \"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
124
125        :param status: The status of this ScheduledSendingApiModel.  # noqa: E501
126        :type: str
127        """
128
129        self._status = status
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(ScheduledSendingApiModel, 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, ScheduledSendingApiModel):
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, ScheduledSendingApiModel):
176            return True
177
178        return self.to_dict() != other.to_dict()