docusign_esign.models.sign_hash_document
DocuSign REST API
The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. # noqa: E501
OpenAPI spec version: v2.1 Contact: devcenter@docusign.com Generated by: https://github.com/swagger-api/swagger-codegen.git
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 19 20class SignHashDocument(object): 21 """NOTE: This class is auto generated by the swagger code generator program. 22 23 Do not edit the class manually. 24 """ 25 26 """ 27 Attributes: 28 swagger_types (dict): The key is attribute name 29 and the value is attribute type. 30 attribute_map (dict): The key is attribute name 31 and the value is json key in definition. 32 """ 33 swagger_types = { 34 'data': 'str', 35 'document_id': 'str', 36 'format': 'str', 37 'name': 'str', 38 'remaining_signatures': 'int', 39 'revisions': 'list[Revision]', 40 'signature_properties': 'SignatureProperties', 41 'signature_type': 'str' 42 } 43 44 attribute_map = { 45 'data': 'data', 46 'document_id': 'documentId', 47 'format': 'format', 48 'name': 'name', 49 'remaining_signatures': 'remainingSignatures', 50 'revisions': 'revisions', 51 'signature_properties': 'signatureProperties', 52 'signature_type': 'signatureType' 53 } 54 55 def __init__(self, data=None, document_id=None, format=None, name=None, remaining_signatures=None, revisions=None, signature_properties=None, signature_type=None): # noqa: E501 56 """SignHashDocument - a model defined in Swagger""" # noqa: E501 57 58 self._data = None 59 self._document_id = None 60 self._format = None 61 self._name = None 62 self._remaining_signatures = None 63 self._revisions = None 64 self._signature_properties = None 65 self._signature_type = None 66 self.discriminator = None 67 68 if data is not None: 69 self.data = data 70 if document_id is not None: 71 self.document_id = document_id 72 if format is not None: 73 self.format = format 74 if name is not None: 75 self.name = name 76 if remaining_signatures is not None: 77 self.remaining_signatures = remaining_signatures 78 if revisions is not None: 79 self.revisions = revisions 80 if signature_properties is not None: 81 self.signature_properties = signature_properties 82 if signature_type is not None: 83 self.signature_type = signature_type 84 85 @property 86 def data(self): 87 """Gets the data of this SignHashDocument. # noqa: E501 88 89 # noqa: E501 90 91 :return: The data of this SignHashDocument. # noqa: E501 92 :rtype: str 93 """ 94 return self._data 95 96 @data.setter 97 def data(self, data): 98 """Sets the data of this SignHashDocument. 99 100 # noqa: E501 101 102 :param data: The data of this SignHashDocument. # noqa: E501 103 :type: str 104 """ 105 106 self._data = data 107 108 @property 109 def document_id(self): 110 """Gets the document_id of this SignHashDocument. # noqa: E501 111 112 Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. # noqa: E501 113 114 :return: The document_id of this SignHashDocument. # noqa: E501 115 :rtype: str 116 """ 117 return self._document_id 118 119 @document_id.setter 120 def document_id(self, document_id): 121 """Sets the document_id of this SignHashDocument. 122 123 Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. # noqa: E501 124 125 :param document_id: The document_id of this SignHashDocument. # noqa: E501 126 :type: str 127 """ 128 129 self._document_id = document_id 130 131 @property 132 def format(self): 133 """Gets the format of this SignHashDocument. # noqa: E501 134 135 # noqa: E501 136 137 :return: The format of this SignHashDocument. # noqa: E501 138 :rtype: str 139 """ 140 return self._format 141 142 @format.setter 143 def format(self, format): 144 """Sets the format of this SignHashDocument. 145 146 # noqa: E501 147 148 :param format: The format of this SignHashDocument. # noqa: E501 149 :type: str 150 """ 151 152 self._format = format 153 154 @property 155 def name(self): 156 """Gets the name of this SignHashDocument. # noqa: E501 157 158 # noqa: E501 159 160 :return: The name of this SignHashDocument. # noqa: E501 161 :rtype: str 162 """ 163 return self._name 164 165 @name.setter 166 def name(self, name): 167 """Sets the name of this SignHashDocument. 168 169 # noqa: E501 170 171 :param name: The name of this SignHashDocument. # noqa: E501 172 :type: str 173 """ 174 175 self._name = name 176 177 @property 178 def remaining_signatures(self): 179 """Gets the remaining_signatures of this SignHashDocument. # noqa: E501 180 181 # noqa: E501 182 183 :return: The remaining_signatures of this SignHashDocument. # noqa: E501 184 :rtype: int 185 """ 186 return self._remaining_signatures 187 188 @remaining_signatures.setter 189 def remaining_signatures(self, remaining_signatures): 190 """Sets the remaining_signatures of this SignHashDocument. 191 192 # noqa: E501 193 194 :param remaining_signatures: The remaining_signatures of this SignHashDocument. # noqa: E501 195 :type: int 196 """ 197 198 self._remaining_signatures = remaining_signatures 199 200 @property 201 def revisions(self): 202 """Gets the revisions of this SignHashDocument. # noqa: E501 203 204 # noqa: E501 205 206 :return: The revisions of this SignHashDocument. # noqa: E501 207 :rtype: list[Revision] 208 """ 209 return self._revisions 210 211 @revisions.setter 212 def revisions(self, revisions): 213 """Sets the revisions of this SignHashDocument. 214 215 # noqa: E501 216 217 :param revisions: The revisions of this SignHashDocument. # noqa: E501 218 :type: list[Revision] 219 """ 220 221 self._revisions = revisions 222 223 @property 224 def signature_properties(self): 225 """Gets the signature_properties of this SignHashDocument. # noqa: E501 226 227 228 :return: The signature_properties of this SignHashDocument. # noqa: E501 229 :rtype: SignatureProperties 230 """ 231 return self._signature_properties 232 233 @signature_properties.setter 234 def signature_properties(self, signature_properties): 235 """Sets the signature_properties of this SignHashDocument. 236 237 238 :param signature_properties: The signature_properties of this SignHashDocument. # noqa: E501 239 :type: SignatureProperties 240 """ 241 242 self._signature_properties = signature_properties 243 244 @property 245 def signature_type(self): 246 """Gets the signature_type of this SignHashDocument. # noqa: E501 247 248 # noqa: E501 249 250 :return: The signature_type of this SignHashDocument. # noqa: E501 251 :rtype: str 252 """ 253 return self._signature_type 254 255 @signature_type.setter 256 def signature_type(self, signature_type): 257 """Sets the signature_type of this SignHashDocument. 258 259 # noqa: E501 260 261 :param signature_type: The signature_type of this SignHashDocument. # noqa: E501 262 :type: str 263 """ 264 265 self._signature_type = signature_type 266 267 def to_dict(self): 268 """Returns the model properties as a dict""" 269 result = {} 270 271 for attr, _ in six.iteritems(self.swagger_types): 272 value = getattr(self, attr) 273 if isinstance(value, list): 274 result[attr] = list(map( 275 lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 276 value 277 )) 278 elif hasattr(value, "to_dict"): 279 result[attr] = value.to_dict() 280 elif isinstance(value, dict): 281 result[attr] = dict(map( 282 lambda item: (item[0], item[1].to_dict()) 283 if hasattr(item[1], "to_dict") else item, 284 value.items() 285 )) 286 else: 287 result[attr] = value 288 if issubclass(SignHashDocument, dict): 289 for key, value in self.items(): 290 result[key] = value 291 292 return result 293 294 def to_str(self): 295 """Returns the string representation of the model""" 296 return pprint.pformat(self.to_dict()) 297 298 def __repr__(self): 299 """For `print` and `pprint`""" 300 return self.to_str() 301 302 def __eq__(self, other): 303 """Returns true if both objects are equal""" 304 if not isinstance(other, SignHashDocument): 305 return False 306 307 return self.__dict__ == other.__dict__ 308 309 def __ne__(self, other): 310 """Returns true if both objects are not equal""" 311 return not self == other
class
SignHashDocument:
21class SignHashDocument(object): 22 """NOTE: This class is auto generated by the swagger code generator program. 23 24 Do not edit the class manually. 25 """ 26 27 """ 28 Attributes: 29 swagger_types (dict): The key is attribute name 30 and the value is attribute type. 31 attribute_map (dict): The key is attribute name 32 and the value is json key in definition. 33 """ 34 swagger_types = { 35 'data': 'str', 36 'document_id': 'str', 37 'format': 'str', 38 'name': 'str', 39 'remaining_signatures': 'int', 40 'revisions': 'list[Revision]', 41 'signature_properties': 'SignatureProperties', 42 'signature_type': 'str' 43 } 44 45 attribute_map = { 46 'data': 'data', 47 'document_id': 'documentId', 48 'format': 'format', 49 'name': 'name', 50 'remaining_signatures': 'remainingSignatures', 51 'revisions': 'revisions', 52 'signature_properties': 'signatureProperties', 53 'signature_type': 'signatureType' 54 } 55 56 def __init__(self, data=None, document_id=None, format=None, name=None, remaining_signatures=None, revisions=None, signature_properties=None, signature_type=None): # noqa: E501 57 """SignHashDocument - a model defined in Swagger""" # noqa: E501 58 59 self._data = None 60 self._document_id = None 61 self._format = None 62 self._name = None 63 self._remaining_signatures = None 64 self._revisions = None 65 self._signature_properties = None 66 self._signature_type = None 67 self.discriminator = None 68 69 if data is not None: 70 self.data = data 71 if document_id is not None: 72 self.document_id = document_id 73 if format is not None: 74 self.format = format 75 if name is not None: 76 self.name = name 77 if remaining_signatures is not None: 78 self.remaining_signatures = remaining_signatures 79 if revisions is not None: 80 self.revisions = revisions 81 if signature_properties is not None: 82 self.signature_properties = signature_properties 83 if signature_type is not None: 84 self.signature_type = signature_type 85 86 @property 87 def data(self): 88 """Gets the data of this SignHashDocument. # noqa: E501 89 90 # noqa: E501 91 92 :return: The data of this SignHashDocument. # noqa: E501 93 :rtype: str 94 """ 95 return self._data 96 97 @data.setter 98 def data(self, data): 99 """Sets the data of this SignHashDocument. 100 101 # noqa: E501 102 103 :param data: The data of this SignHashDocument. # noqa: E501 104 :type: str 105 """ 106 107 self._data = data 108 109 @property 110 def document_id(self): 111 """Gets the document_id of this SignHashDocument. # noqa: E501 112 113 Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. # noqa: E501 114 115 :return: The document_id of this SignHashDocument. # noqa: E501 116 :rtype: str 117 """ 118 return self._document_id 119 120 @document_id.setter 121 def document_id(self, document_id): 122 """Sets the document_id of this SignHashDocument. 123 124 Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. # noqa: E501 125 126 :param document_id: The document_id of this SignHashDocument. # noqa: E501 127 :type: str 128 """ 129 130 self._document_id = document_id 131 132 @property 133 def format(self): 134 """Gets the format of this SignHashDocument. # noqa: E501 135 136 # noqa: E501 137 138 :return: The format of this SignHashDocument. # noqa: E501 139 :rtype: str 140 """ 141 return self._format 142 143 @format.setter 144 def format(self, format): 145 """Sets the format of this SignHashDocument. 146 147 # noqa: E501 148 149 :param format: The format of this SignHashDocument. # noqa: E501 150 :type: str 151 """ 152 153 self._format = format 154 155 @property 156 def name(self): 157 """Gets the name of this SignHashDocument. # noqa: E501 158 159 # noqa: E501 160 161 :return: The name of this SignHashDocument. # noqa: E501 162 :rtype: str 163 """ 164 return self._name 165 166 @name.setter 167 def name(self, name): 168 """Sets the name of this SignHashDocument. 169 170 # noqa: E501 171 172 :param name: The name of this SignHashDocument. # noqa: E501 173 :type: str 174 """ 175 176 self._name = name 177 178 @property 179 def remaining_signatures(self): 180 """Gets the remaining_signatures of this SignHashDocument. # noqa: E501 181 182 # noqa: E501 183 184 :return: The remaining_signatures of this SignHashDocument. # noqa: E501 185 :rtype: int 186 """ 187 return self._remaining_signatures 188 189 @remaining_signatures.setter 190 def remaining_signatures(self, remaining_signatures): 191 """Sets the remaining_signatures of this SignHashDocument. 192 193 # noqa: E501 194 195 :param remaining_signatures: The remaining_signatures of this SignHashDocument. # noqa: E501 196 :type: int 197 """ 198 199 self._remaining_signatures = remaining_signatures 200 201 @property 202 def revisions(self): 203 """Gets the revisions of this SignHashDocument. # noqa: E501 204 205 # noqa: E501 206 207 :return: The revisions of this SignHashDocument. # noqa: E501 208 :rtype: list[Revision] 209 """ 210 return self._revisions 211 212 @revisions.setter 213 def revisions(self, revisions): 214 """Sets the revisions of this SignHashDocument. 215 216 # noqa: E501 217 218 :param revisions: The revisions of this SignHashDocument. # noqa: E501 219 :type: list[Revision] 220 """ 221 222 self._revisions = revisions 223 224 @property 225 def signature_properties(self): 226 """Gets the signature_properties of this SignHashDocument. # noqa: E501 227 228 229 :return: The signature_properties of this SignHashDocument. # noqa: E501 230 :rtype: SignatureProperties 231 """ 232 return self._signature_properties 233 234 @signature_properties.setter 235 def signature_properties(self, signature_properties): 236 """Sets the signature_properties of this SignHashDocument. 237 238 239 :param signature_properties: The signature_properties of this SignHashDocument. # noqa: E501 240 :type: SignatureProperties 241 """ 242 243 self._signature_properties = signature_properties 244 245 @property 246 def signature_type(self): 247 """Gets the signature_type of this SignHashDocument. # noqa: E501 248 249 # noqa: E501 250 251 :return: The signature_type of this SignHashDocument. # noqa: E501 252 :rtype: str 253 """ 254 return self._signature_type 255 256 @signature_type.setter 257 def signature_type(self, signature_type): 258 """Sets the signature_type of this SignHashDocument. 259 260 # noqa: E501 261 262 :param signature_type: The signature_type of this SignHashDocument. # noqa: E501 263 :type: str 264 """ 265 266 self._signature_type = signature_type 267 268 def to_dict(self): 269 """Returns the model properties as a dict""" 270 result = {} 271 272 for attr, _ in six.iteritems(self.swagger_types): 273 value = getattr(self, attr) 274 if isinstance(value, list): 275 result[attr] = list(map( 276 lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 277 value 278 )) 279 elif hasattr(value, "to_dict"): 280 result[attr] = value.to_dict() 281 elif isinstance(value, dict): 282 result[attr] = dict(map( 283 lambda item: (item[0], item[1].to_dict()) 284 if hasattr(item[1], "to_dict") else item, 285 value.items() 286 )) 287 else: 288 result[attr] = value 289 if issubclass(SignHashDocument, dict): 290 for key, value in self.items(): 291 result[key] = value 292 293 return result 294 295 def to_str(self): 296 """Returns the string representation of the model""" 297 return pprint.pformat(self.to_dict()) 298 299 def __repr__(self): 300 """For `print` and `pprint`""" 301 return self.to_str() 302 303 def __eq__(self, other): 304 """Returns true if both objects are equal""" 305 if not isinstance(other, SignHashDocument): 306 return False 307 308 return self.__dict__ == other.__dict__ 309 310 def __ne__(self, other): 311 """Returns true if both objects are not equal""" 312 return not self == other
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
SignHashDocument( data=None, document_id=None, format=None, name=None, remaining_signatures=None, revisions=None, signature_properties=None, signature_type=None)
56 def __init__(self, data=None, document_id=None, format=None, name=None, remaining_signatures=None, revisions=None, signature_properties=None, signature_type=None): # noqa: E501 57 """SignHashDocument - a model defined in Swagger""" # noqa: E501 58 59 self._data = None 60 self._document_id = None 61 self._format = None 62 self._name = None 63 self._remaining_signatures = None 64 self._revisions = None 65 self._signature_properties = None 66 self._signature_type = None 67 self.discriminator = None 68 69 if data is not None: 70 self.data = data 71 if document_id is not None: 72 self.document_id = document_id 73 if format is not None: 74 self.format = format 75 if name is not None: 76 self.name = name 77 if remaining_signatures is not None: 78 self.remaining_signatures = remaining_signatures 79 if revisions is not None: 80 self.revisions = revisions 81 if signature_properties is not None: 82 self.signature_properties = signature_properties 83 if signature_type is not None: 84 self.signature_type = signature_type
SignHashDocument - a model defined in Swagger
swagger_types = {'data': 'str', 'document_id': 'str', 'format': 'str', 'name': 'str', 'remaining_signatures': 'int', 'revisions': 'list[Revision]', 'signature_properties': 'SignatureProperties', 'signature_type': 'str'}
attribute_map = {'data': 'data', 'document_id': 'documentId', 'format': 'format', 'name': 'name', 'remaining_signatures': 'remainingSignatures', 'revisions': 'revisions', 'signature_properties': 'signatureProperties', 'signature_type': 'signatureType'}
data
Gets the data of this SignHashDocument. # noqa: E501
# noqa: E501
Returns
The data of this SignHashDocument. # noqa: E501
document_id
Gets the document_id of this SignHashDocument. # noqa: E501
Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. # noqa: E501
Returns
The document_id of this SignHashDocument. # noqa: E501
format
Gets the format of this SignHashDocument. # noqa: E501
# noqa: E501
Returns
The format of this SignHashDocument. # noqa: E501
name
Gets the name of this SignHashDocument. # noqa: E501
# noqa: E501
Returns
The name of this SignHashDocument. # noqa: E501
remaining_signatures
Gets the remaining_signatures of this SignHashDocument. # noqa: E501
# noqa: E501
Returns
The remaining_signatures of this SignHashDocument. # noqa: E501
revisions
Gets the revisions of this SignHashDocument. # noqa: E501
# noqa: E501
Returns
The revisions of this SignHashDocument. # noqa: E501
signature_properties
Gets the signature_properties of this SignHashDocument. # noqa: E501
Returns
The signature_properties of this SignHashDocument. # noqa: E501
signature_type
Gets the signature_type of this SignHashDocument. # noqa: E501
# noqa: E501
Returns
The signature_type of this SignHashDocument. # noqa: E501
def
to_dict(self)
268 def to_dict(self): 269 """Returns the model properties as a dict""" 270 result = {} 271 272 for attr, _ in six.iteritems(self.swagger_types): 273 value = getattr(self, attr) 274 if isinstance(value, list): 275 result[attr] = list(map( 276 lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 277 value 278 )) 279 elif hasattr(value, "to_dict"): 280 result[attr] = value.to_dict() 281 elif isinstance(value, dict): 282 result[attr] = dict(map( 283 lambda item: (item[0], item[1].to_dict()) 284 if hasattr(item[1], "to_dict") else item, 285 value.items() 286 )) 287 else: 288 result[attr] = value 289 if issubclass(SignHashDocument, dict): 290 for key, value in self.items(): 291 result[key] = value 292 293 return result
Returns the model properties as a dict