docusign_esign.models.bulk_envelopes_response

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 BulkEnvelopesResponse(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        'bulk_envelope_statuses': 'list[BulkEnvelopeStatus]',
 35        'end_position': 'str',
 36        'next_uri': 'str',
 37        'previous_uri': 'str',
 38        'result_set_size': 'str',
 39        'start_position': 'str',
 40        'total_set_size': 'str'
 41    }
 42
 43    attribute_map = {
 44        'bulk_envelope_statuses': 'bulkEnvelopeStatuses',
 45        'end_position': 'endPosition',
 46        'next_uri': 'nextUri',
 47        'previous_uri': 'previousUri',
 48        'result_set_size': 'resultSetSize',
 49        'start_position': 'startPosition',
 50        'total_set_size': 'totalSetSize'
 51    }
 52
 53    def __init__(self, bulk_envelope_statuses=None, end_position=None, next_uri=None, previous_uri=None, result_set_size=None, start_position=None, total_set_size=None):  # noqa: E501
 54        """BulkEnvelopesResponse - a model defined in Swagger"""  # noqa: E501
 55
 56        self._bulk_envelope_statuses = None
 57        self._end_position = None
 58        self._next_uri = None
 59        self._previous_uri = None
 60        self._result_set_size = None
 61        self._start_position = None
 62        self._total_set_size = None
 63        self.discriminator = None
 64
 65        if bulk_envelope_statuses is not None:
 66            self.bulk_envelope_statuses = bulk_envelope_statuses
 67        if end_position is not None:
 68            self.end_position = end_position
 69        if next_uri is not None:
 70            self.next_uri = next_uri
 71        if previous_uri is not None:
 72            self.previous_uri = previous_uri
 73        if result_set_size is not None:
 74            self.result_set_size = result_set_size
 75        if start_position is not None:
 76            self.start_position = start_position
 77        if total_set_size is not None:
 78            self.total_set_size = total_set_size
 79
 80    @property
 81    def bulk_envelope_statuses(self):
 82        """Gets the bulk_envelope_statuses of this BulkEnvelopesResponse.  # noqa: E501
 83
 84        Reserved: TBD  # noqa: E501
 85
 86        :return: The bulk_envelope_statuses of this BulkEnvelopesResponse.  # noqa: E501
 87        :rtype: list[BulkEnvelopeStatus]
 88        """
 89        return self._bulk_envelope_statuses
 90
 91    @bulk_envelope_statuses.setter
 92    def bulk_envelope_statuses(self, bulk_envelope_statuses):
 93        """Sets the bulk_envelope_statuses of this BulkEnvelopesResponse.
 94
 95        Reserved: TBD  # noqa: E501
 96
 97        :param bulk_envelope_statuses: The bulk_envelope_statuses of this BulkEnvelopesResponse.  # noqa: E501
 98        :type: list[BulkEnvelopeStatus]
 99        """
100
101        self._bulk_envelope_statuses = bulk_envelope_statuses
102
103    @property
104    def end_position(self):
105        """Gets the end_position of this BulkEnvelopesResponse.  # noqa: E501
106
107        The last position in the result set.   # noqa: E501
108
109        :return: The end_position of this BulkEnvelopesResponse.  # noqa: E501
110        :rtype: str
111        """
112        return self._end_position
113
114    @end_position.setter
115    def end_position(self, end_position):
116        """Sets the end_position of this BulkEnvelopesResponse.
117
118        The last position in the result set.   # noqa: E501
119
120        :param end_position: The end_position of this BulkEnvelopesResponse.  # noqa: E501
121        :type: str
122        """
123
124        self._end_position = end_position
125
126    @property
127    def next_uri(self):
128        """Gets the next_uri of this BulkEnvelopesResponse.  # noqa: E501
129
130        The URI to the next chunk of records based on the search request. If the endPosition is the entire results of the search, this is null.   # noqa: E501
131
132        :return: The next_uri of this BulkEnvelopesResponse.  # noqa: E501
133        :rtype: str
134        """
135        return self._next_uri
136
137    @next_uri.setter
138    def next_uri(self, next_uri):
139        """Sets the next_uri of this BulkEnvelopesResponse.
140
141        The URI to the next chunk of records based on the search request. If the endPosition is the entire results of the search, this is null.   # noqa: E501
142
143        :param next_uri: The next_uri of this BulkEnvelopesResponse.  # noqa: E501
144        :type: str
145        """
146
147        self._next_uri = next_uri
148
149    @property
150    def previous_uri(self):
151        """Gets the previous_uri of this BulkEnvelopesResponse.  # noqa: E501
152
153        The postal code for the billing address.  # noqa: E501
154
155        :return: The previous_uri of this BulkEnvelopesResponse.  # noqa: E501
156        :rtype: str
157        """
158        return self._previous_uri
159
160    @previous_uri.setter
161    def previous_uri(self, previous_uri):
162        """Sets the previous_uri of this BulkEnvelopesResponse.
163
164        The postal code for the billing address.  # noqa: E501
165
166        :param previous_uri: The previous_uri of this BulkEnvelopesResponse.  # noqa: E501
167        :type: str
168        """
169
170        self._previous_uri = previous_uri
171
172    @property
173    def result_set_size(self):
174        """Gets the result_set_size of this BulkEnvelopesResponse.  # noqa: E501
175
176        The number of results returned in this response.   # noqa: E501
177
178        :return: The result_set_size of this BulkEnvelopesResponse.  # noqa: E501
179        :rtype: str
180        """
181        return self._result_set_size
182
183    @result_set_size.setter
184    def result_set_size(self, result_set_size):
185        """Sets the result_set_size of this BulkEnvelopesResponse.
186
187        The number of results returned in this response.   # noqa: E501
188
189        :param result_set_size: The result_set_size of this BulkEnvelopesResponse.  # noqa: E501
190        :type: str
191        """
192
193        self._result_set_size = result_set_size
194
195    @property
196    def start_position(self):
197        """Gets the start_position of this BulkEnvelopesResponse.  # noqa: E501
198
199        Starting position of the current result set.  # noqa: E501
200
201        :return: The start_position of this BulkEnvelopesResponse.  # noqa: E501
202        :rtype: str
203        """
204        return self._start_position
205
206    @start_position.setter
207    def start_position(self, start_position):
208        """Sets the start_position of this BulkEnvelopesResponse.
209
210        Starting position of the current result set.  # noqa: E501
211
212        :param start_position: The start_position of this BulkEnvelopesResponse.  # noqa: E501
213        :type: str
214        """
215
216        self._start_position = start_position
217
218    @property
219    def total_set_size(self):
220        """Gets the total_set_size of this BulkEnvelopesResponse.  # noqa: E501
221
222        The total number of items available in the result set. This will always be greater than or equal to the value of the property returning the results in the in the response.  # noqa: E501
223
224        :return: The total_set_size of this BulkEnvelopesResponse.  # noqa: E501
225        :rtype: str
226        """
227        return self._total_set_size
228
229    @total_set_size.setter
230    def total_set_size(self, total_set_size):
231        """Sets the total_set_size of this BulkEnvelopesResponse.
232
233        The total number of items available in the result set. This will always be greater than or equal to the value of the property returning the results in the in the response.  # noqa: E501
234
235        :param total_set_size: The total_set_size of this BulkEnvelopesResponse.  # noqa: E501
236        :type: str
237        """
238
239        self._total_set_size = total_set_size
240
241    def to_dict(self):
242        """Returns the model properties as a dict"""
243        result = {}
244
245        for attr, _ in six.iteritems(self.swagger_types):
246            value = getattr(self, attr)
247            if isinstance(value, list):
248                result[attr] = list(map(
249                    lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
250                    value
251                ))
252            elif hasattr(value, "to_dict"):
253                result[attr] = value.to_dict()
254            elif isinstance(value, dict):
255                result[attr] = dict(map(
256                    lambda item: (item[0], item[1].to_dict())
257                    if hasattr(item[1], "to_dict") else item,
258                    value.items()
259                ))
260            else:
261                result[attr] = value
262        if issubclass(BulkEnvelopesResponse, dict):
263            for key, value in self.items():
264                result[key] = value
265
266        return result
267
268    def to_str(self):
269        """Returns the string representation of the model"""
270        return pprint.pformat(self.to_dict())
271
272    def __repr__(self):
273        """For `print` and `pprint`"""
274        return self.to_str()
275
276    def __eq__(self, other):
277        """Returns true if both objects are equal"""
278        if not isinstance(other, BulkEnvelopesResponse):
279            return False
280
281        return self.__dict__ == other.__dict__
282
283    def __ne__(self, other):
284        """Returns true if both objects are not equal"""
285        return not self == other
class BulkEnvelopesResponse:
 21class BulkEnvelopesResponse(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        'bulk_envelope_statuses': 'list[BulkEnvelopeStatus]',
 36        'end_position': 'str',
 37        'next_uri': 'str',
 38        'previous_uri': 'str',
 39        'result_set_size': 'str',
 40        'start_position': 'str',
 41        'total_set_size': 'str'
 42    }
 43
 44    attribute_map = {
 45        'bulk_envelope_statuses': 'bulkEnvelopeStatuses',
 46        'end_position': 'endPosition',
 47        'next_uri': 'nextUri',
 48        'previous_uri': 'previousUri',
 49        'result_set_size': 'resultSetSize',
 50        'start_position': 'startPosition',
 51        'total_set_size': 'totalSetSize'
 52    }
 53
 54    def __init__(self, bulk_envelope_statuses=None, end_position=None, next_uri=None, previous_uri=None, result_set_size=None, start_position=None, total_set_size=None):  # noqa: E501
 55        """BulkEnvelopesResponse - a model defined in Swagger"""  # noqa: E501
 56
 57        self._bulk_envelope_statuses = None
 58        self._end_position = None
 59        self._next_uri = None
 60        self._previous_uri = None
 61        self._result_set_size = None
 62        self._start_position = None
 63        self._total_set_size = None
 64        self.discriminator = None
 65
 66        if bulk_envelope_statuses is not None:
 67            self.bulk_envelope_statuses = bulk_envelope_statuses
 68        if end_position is not None:
 69            self.end_position = end_position
 70        if next_uri is not None:
 71            self.next_uri = next_uri
 72        if previous_uri is not None:
 73            self.previous_uri = previous_uri
 74        if result_set_size is not None:
 75            self.result_set_size = result_set_size
 76        if start_position is not None:
 77            self.start_position = start_position
 78        if total_set_size is not None:
 79            self.total_set_size = total_set_size
 80
 81    @property
 82    def bulk_envelope_statuses(self):
 83        """Gets the bulk_envelope_statuses of this BulkEnvelopesResponse.  # noqa: E501
 84
 85        Reserved: TBD  # noqa: E501
 86
 87        :return: The bulk_envelope_statuses of this BulkEnvelopesResponse.  # noqa: E501
 88        :rtype: list[BulkEnvelopeStatus]
 89        """
 90        return self._bulk_envelope_statuses
 91
 92    @bulk_envelope_statuses.setter
 93    def bulk_envelope_statuses(self, bulk_envelope_statuses):
 94        """Sets the bulk_envelope_statuses of this BulkEnvelopesResponse.
 95
 96        Reserved: TBD  # noqa: E501
 97
 98        :param bulk_envelope_statuses: The bulk_envelope_statuses of this BulkEnvelopesResponse.  # noqa: E501
 99        :type: list[BulkEnvelopeStatus]
100        """
101
102        self._bulk_envelope_statuses = bulk_envelope_statuses
103
104    @property
105    def end_position(self):
106        """Gets the end_position of this BulkEnvelopesResponse.  # noqa: E501
107
108        The last position in the result set.   # noqa: E501
109
110        :return: The end_position of this BulkEnvelopesResponse.  # noqa: E501
111        :rtype: str
112        """
113        return self._end_position
114
115    @end_position.setter
116    def end_position(self, end_position):
117        """Sets the end_position of this BulkEnvelopesResponse.
118
119        The last position in the result set.   # noqa: E501
120
121        :param end_position: The end_position of this BulkEnvelopesResponse.  # noqa: E501
122        :type: str
123        """
124
125        self._end_position = end_position
126
127    @property
128    def next_uri(self):
129        """Gets the next_uri of this BulkEnvelopesResponse.  # noqa: E501
130
131        The URI to the next chunk of records based on the search request. If the endPosition is the entire results of the search, this is null.   # noqa: E501
132
133        :return: The next_uri of this BulkEnvelopesResponse.  # noqa: E501
134        :rtype: str
135        """
136        return self._next_uri
137
138    @next_uri.setter
139    def next_uri(self, next_uri):
140        """Sets the next_uri of this BulkEnvelopesResponse.
141
142        The URI to the next chunk of records based on the search request. If the endPosition is the entire results of the search, this is null.   # noqa: E501
143
144        :param next_uri: The next_uri of this BulkEnvelopesResponse.  # noqa: E501
145        :type: str
146        """
147
148        self._next_uri = next_uri
149
150    @property
151    def previous_uri(self):
152        """Gets the previous_uri of this BulkEnvelopesResponse.  # noqa: E501
153
154        The postal code for the billing address.  # noqa: E501
155
156        :return: The previous_uri of this BulkEnvelopesResponse.  # noqa: E501
157        :rtype: str
158        """
159        return self._previous_uri
160
161    @previous_uri.setter
162    def previous_uri(self, previous_uri):
163        """Sets the previous_uri of this BulkEnvelopesResponse.
164
165        The postal code for the billing address.  # noqa: E501
166
167        :param previous_uri: The previous_uri of this BulkEnvelopesResponse.  # noqa: E501
168        :type: str
169        """
170
171        self._previous_uri = previous_uri
172
173    @property
174    def result_set_size(self):
175        """Gets the result_set_size of this BulkEnvelopesResponse.  # noqa: E501
176
177        The number of results returned in this response.   # noqa: E501
178
179        :return: The result_set_size of this BulkEnvelopesResponse.  # noqa: E501
180        :rtype: str
181        """
182        return self._result_set_size
183
184    @result_set_size.setter
185    def result_set_size(self, result_set_size):
186        """Sets the result_set_size of this BulkEnvelopesResponse.
187
188        The number of results returned in this response.   # noqa: E501
189
190        :param result_set_size: The result_set_size of this BulkEnvelopesResponse.  # noqa: E501
191        :type: str
192        """
193
194        self._result_set_size = result_set_size
195
196    @property
197    def start_position(self):
198        """Gets the start_position of this BulkEnvelopesResponse.  # noqa: E501
199
200        Starting position of the current result set.  # noqa: E501
201
202        :return: The start_position of this BulkEnvelopesResponse.  # noqa: E501
203        :rtype: str
204        """
205        return self._start_position
206
207    @start_position.setter
208    def start_position(self, start_position):
209        """Sets the start_position of this BulkEnvelopesResponse.
210
211        Starting position of the current result set.  # noqa: E501
212
213        :param start_position: The start_position of this BulkEnvelopesResponse.  # noqa: E501
214        :type: str
215        """
216
217        self._start_position = start_position
218
219    @property
220    def total_set_size(self):
221        """Gets the total_set_size of this BulkEnvelopesResponse.  # noqa: E501
222
223        The total number of items available in the result set. This will always be greater than or equal to the value of the property returning the results in the in the response.  # noqa: E501
224
225        :return: The total_set_size of this BulkEnvelopesResponse.  # noqa: E501
226        :rtype: str
227        """
228        return self._total_set_size
229
230    @total_set_size.setter
231    def total_set_size(self, total_set_size):
232        """Sets the total_set_size of this BulkEnvelopesResponse.
233
234        The total number of items available in the result set. This will always be greater than or equal to the value of the property returning the results in the in the response.  # noqa: E501
235
236        :param total_set_size: The total_set_size of this BulkEnvelopesResponse.  # noqa: E501
237        :type: str
238        """
239
240        self._total_set_size = total_set_size
241
242    def to_dict(self):
243        """Returns the model properties as a dict"""
244        result = {}
245
246        for attr, _ in six.iteritems(self.swagger_types):
247            value = getattr(self, attr)
248            if isinstance(value, list):
249                result[attr] = list(map(
250                    lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
251                    value
252                ))
253            elif hasattr(value, "to_dict"):
254                result[attr] = value.to_dict()
255            elif isinstance(value, dict):
256                result[attr] = dict(map(
257                    lambda item: (item[0], item[1].to_dict())
258                    if hasattr(item[1], "to_dict") else item,
259                    value.items()
260                ))
261            else:
262                result[attr] = value
263        if issubclass(BulkEnvelopesResponse, dict):
264            for key, value in self.items():
265                result[key] = value
266
267        return result
268
269    def to_str(self):
270        """Returns the string representation of the model"""
271        return pprint.pformat(self.to_dict())
272
273    def __repr__(self):
274        """For `print` and `pprint`"""
275        return self.to_str()
276
277    def __eq__(self, other):
278        """Returns true if both objects are equal"""
279        if not isinstance(other, BulkEnvelopesResponse):
280            return False
281
282        return self.__dict__ == other.__dict__
283
284    def __ne__(self, other):
285        """Returns true if both objects are not equal"""
286        return not self == other

NOTE: This class is auto generated by the swagger code generator program.

Do not edit the class manually.

BulkEnvelopesResponse( bulk_envelope_statuses=None, end_position=None, next_uri=None, previous_uri=None, result_set_size=None, start_position=None, total_set_size=None)
54    def __init__(self, bulk_envelope_statuses=None, end_position=None, next_uri=None, previous_uri=None, result_set_size=None, start_position=None, total_set_size=None):  # noqa: E501
55        """BulkEnvelopesResponse - a model defined in Swagger"""  # noqa: E501
56
57        self._bulk_envelope_statuses = None
58        self._end_position = None
59        self._next_uri = None
60        self._previous_uri = None
61        self._result_set_size = None
62        self._start_position = None
63        self._total_set_size = None
64        self.discriminator = None
65
66        if bulk_envelope_statuses is not None:
67            self.bulk_envelope_statuses = bulk_envelope_statuses
68        if end_position is not None:
69            self.end_position = end_position
70        if next_uri is not None:
71            self.next_uri = next_uri
72        if previous_uri is not None:
73            self.previous_uri = previous_uri
74        if result_set_size is not None:
75            self.result_set_size = result_set_size
76        if start_position is not None:
77            self.start_position = start_position
78        if total_set_size is not None:
79            self.total_set_size = total_set_size

BulkEnvelopesResponse - a model defined in Swagger

swagger_types = {'bulk_envelope_statuses': 'list[BulkEnvelopeStatus]', 'end_position': 'str', 'next_uri': 'str', 'previous_uri': 'str', 'result_set_size': 'str', 'start_position': 'str', 'total_set_size': 'str'}
attribute_map = {'bulk_envelope_statuses': 'bulkEnvelopeStatuses', 'end_position': 'endPosition', 'next_uri': 'nextUri', 'previous_uri': 'previousUri', 'result_set_size': 'resultSetSize', 'start_position': 'startPosition', 'total_set_size': 'totalSetSize'}
bulk_envelope_statuses

Gets the bulk_envelope_statuses of this BulkEnvelopesResponse. # noqa: E501

Reserved: TBD # noqa: E501

Returns

The bulk_envelope_statuses of this BulkEnvelopesResponse. # noqa: E501

end_position

Gets the end_position of this BulkEnvelopesResponse. # noqa: E501

The last position in the result set. # noqa: E501

Returns

The end_position of this BulkEnvelopesResponse. # noqa: E501

next_uri

Gets the next_uri of this BulkEnvelopesResponse. # noqa: E501

The URI to the next chunk of records based on the search request. If the endPosition is the entire results of the search, this is null. # noqa: E501

Returns

The next_uri of this BulkEnvelopesResponse. # noqa: E501

previous_uri

Gets the previous_uri of this BulkEnvelopesResponse. # noqa: E501

The postal code for the billing address. # noqa: E501

Returns

The previous_uri of this BulkEnvelopesResponse. # noqa: E501

result_set_size

Gets the result_set_size of this BulkEnvelopesResponse. # noqa: E501

The number of results returned in this response. # noqa: E501

Returns

The result_set_size of this BulkEnvelopesResponse. # noqa: E501

start_position

Gets the start_position of this BulkEnvelopesResponse. # noqa: E501

Starting position of the current result set. # noqa: E501

Returns

The start_position of this BulkEnvelopesResponse. # noqa: E501

total_set_size

Gets the total_set_size of this BulkEnvelopesResponse. # noqa: E501

The total number of items available in the result set. This will always be greater than or equal to the value of the property returning the results in the in the response. # noqa: E501

Returns

The total_set_size of this BulkEnvelopesResponse. # noqa: E501

def to_dict(self)
242    def to_dict(self):
243        """Returns the model properties as a dict"""
244        result = {}
245
246        for attr, _ in six.iteritems(self.swagger_types):
247            value = getattr(self, attr)
248            if isinstance(value, list):
249                result[attr] = list(map(
250                    lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
251                    value
252                ))
253            elif hasattr(value, "to_dict"):
254                result[attr] = value.to_dict()
255            elif isinstance(value, dict):
256                result[attr] = dict(map(
257                    lambda item: (item[0], item[1].to_dict())
258                    if hasattr(item[1], "to_dict") else item,
259                    value.items()
260                ))
261            else:
262                result[attr] = value
263        if issubclass(BulkEnvelopesResponse, dict):
264            for key, value in self.items():
265                result[key] = value
266
267        return result

Returns the model properties as a dict

def to_str(self)
269    def to_str(self):
270        """Returns the string representation of the model"""
271        return pprint.pformat(self.to_dict())

Returns the string representation of the model