docusign_esign.models.envelope_transaction_status

  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 EnvelopeTransactionStatus(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        'envelope_id': 'str',
 37        'error_details': 'ErrorDetails',
 38        'status': 'str',
 39        'transaction_id': 'str'
 40    }
 41
 42    attribute_map = {
 43        'envelope_id': 'envelopeId',
 44        'error_details': 'errorDetails',
 45        'status': 'status',
 46        'transaction_id': 'transactionId'
 47    }
 48
 49    def __init__(self, _configuration=None, **kwargs):  # noqa: E501
 50        """EnvelopeTransactionStatus - a model defined in Swagger"""  # noqa: E501
 51        if _configuration is None:
 52            _configuration = Configuration()
 53        self._configuration = _configuration
 54
 55        self._envelope_id = None
 56        self._error_details = None
 57        self._status = None
 58        self._transaction_id = None
 59        self.discriminator = None
 60
 61        setattr(self, "_{}".format('envelope_id'), kwargs.get('envelope_id', None))
 62        setattr(self, "_{}".format('error_details'), kwargs.get('error_details', None))
 63        setattr(self, "_{}".format('status'), kwargs.get('status', None))
 64        setattr(self, "_{}".format('transaction_id'), kwargs.get('transaction_id', None))
 65
 66    @property
 67    def envelope_id(self):
 68        """Gets the envelope_id of this EnvelopeTransactionStatus.  # noqa: E501
 69
 70        The envelope ID of the envelope status that failed to post.  # noqa: E501
 71
 72        :return: The envelope_id of this EnvelopeTransactionStatus.  # noqa: E501
 73        :rtype: str
 74        """
 75        return self._envelope_id
 76
 77    @envelope_id.setter
 78    def envelope_id(self, envelope_id):
 79        """Sets the envelope_id of this EnvelopeTransactionStatus.
 80
 81        The envelope ID of the envelope status that failed to post.  # noqa: E501
 82
 83        :param envelope_id: The envelope_id of this EnvelopeTransactionStatus.  # noqa: E501
 84        :type: str
 85        """
 86
 87        self._envelope_id = envelope_id
 88
 89    @property
 90    def error_details(self):
 91        """Gets the error_details of this EnvelopeTransactionStatus.  # noqa: E501
 92
 93        Array or errors.  # noqa: E501
 94
 95        :return: The error_details of this EnvelopeTransactionStatus.  # noqa: E501
 96        :rtype: ErrorDetails
 97        """
 98        return self._error_details
 99
100    @error_details.setter
101    def error_details(self, error_details):
102        """Sets the error_details of this EnvelopeTransactionStatus.
103
104        Array or errors.  # noqa: E501
105
106        :param error_details: The error_details of this EnvelopeTransactionStatus.  # noqa: E501
107        :type: ErrorDetails
108        """
109
110        self._error_details = error_details
111
112    @property
113    def status(self):
114        """Gets the status of this EnvelopeTransactionStatus.  # noqa: E501
115
116        Indicates the envelope status. Valid values are:  * sent - The envelope is sent to the recipients.  * created - The envelope is saved as a draft and can be modified and sent later.  # noqa: E501
117
118        :return: The status of this EnvelopeTransactionStatus.  # noqa: E501
119        :rtype: str
120        """
121        return self._status
122
123    @status.setter
124    def status(self, status):
125        """Sets the status of this EnvelopeTransactionStatus.
126
127        Indicates the envelope status. Valid values are:  * sent - The envelope is sent to the recipients.  * created - The envelope is saved as a draft and can be modified and sent later.  # noqa: E501
128
129        :param status: The status of this EnvelopeTransactionStatus.  # noqa: E501
130        :type: str
131        """
132
133        self._status = status
134
135    @property
136    def transaction_id(self):
137        """Gets the transaction_id of this EnvelopeTransactionStatus.  # noqa: E501
138
139         Used to identify an envelope. The id is a sender-generated value and is valid in the DocuSign system for 7 days. It is recommended that a transaction ID is used for offline signing to ensure that an envelope is not sent multiple times. The `transactionId` property can be used determine an envelope's status (i.e. was it created or not) in cases where the internet connection was lost before the envelope status was returned.  # noqa: E501
140
141        :return: The transaction_id of this EnvelopeTransactionStatus.  # noqa: E501
142        :rtype: str
143        """
144        return self._transaction_id
145
146    @transaction_id.setter
147    def transaction_id(self, transaction_id):
148        """Sets the transaction_id of this EnvelopeTransactionStatus.
149
150         Used to identify an envelope. The id is a sender-generated value and is valid in the DocuSign system for 7 days. It is recommended that a transaction ID is used for offline signing to ensure that an envelope is not sent multiple times. The `transactionId` property can be used determine an envelope's status (i.e. was it created or not) in cases where the internet connection was lost before the envelope status was returned.  # noqa: E501
151
152        :param transaction_id: The transaction_id of this EnvelopeTransactionStatus.  # noqa: E501
153        :type: str
154        """
155
156        self._transaction_id = transaction_id
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(EnvelopeTransactionStatus, 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, EnvelopeTransactionStatus):
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, EnvelopeTransactionStatus):
203            return True
204
205        return self.to_dict() != other.to_dict()