docusign_esign.models.group

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
 19from docusign_esign.client.configuration import Configuration
 20
 21
 22class Group(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        'ds_group_id': 'str',
 37        'error_details': 'ErrorDetails',
 38        'group_id': 'str',
 39        'group_name': 'str',
 40        'group_type': 'str',
 41        'permission_profile_id': 'str',
 42        'users': 'list[UserInfo]',
 43        'users_count': 'str'
 44    }
 45
 46    attribute_map = {
 47        'ds_group_id': 'dsGroupId',
 48        'error_details': 'errorDetails',
 49        'group_id': 'groupId',
 50        'group_name': 'groupName',
 51        'group_type': 'groupType',
 52        'permission_profile_id': 'permissionProfileId',
 53        'users': 'users',
 54        'users_count': 'usersCount'
 55    }
 56
 57    def __init__(self, _configuration=None, **kwargs):  # noqa: E501
 58        """Group - a model defined in Swagger"""  # noqa: E501
 59        if _configuration is None:
 60            _configuration = Configuration()
 61        self._configuration = _configuration
 62
 63        self._ds_group_id = None
 64        self._error_details = None
 65        self._group_id = None
 66        self._group_name = None
 67        self._group_type = None
 68        self._permission_profile_id = None
 69        self._users = None
 70        self._users_count = None
 71        self.discriminator = None
 72
 73        setattr(self, "_{}".format('ds_group_id'), kwargs.get('ds_group_id', None))
 74        setattr(self, "_{}".format('error_details'), kwargs.get('error_details', None))
 75        setattr(self, "_{}".format('group_id'), kwargs.get('group_id', None))
 76        setattr(self, "_{}".format('group_name'), kwargs.get('group_name', None))
 77        setattr(self, "_{}".format('group_type'), kwargs.get('group_type', None))
 78        setattr(self, "_{}".format('permission_profile_id'), kwargs.get('permission_profile_id', None))
 79        setattr(self, "_{}".format('users'), kwargs.get('users', None))
 80        setattr(self, "_{}".format('users_count'), kwargs.get('users_count', None))
 81
 82    @property
 83    def ds_group_id(self):
 84        """Gets the ds_group_id of this Group.  # noqa: E501
 85
 86          # noqa: E501
 87
 88        :return: The ds_group_id of this Group.  # noqa: E501
 89        :rtype: str
 90        """
 91        return self._ds_group_id
 92
 93    @ds_group_id.setter
 94    def ds_group_id(self, ds_group_id):
 95        """Sets the ds_group_id of this Group.
 96
 97          # noqa: E501
 98
 99        :param ds_group_id: The ds_group_id of this Group.  # noqa: E501
100        :type: str
101        """
102
103        self._ds_group_id = ds_group_id
104
105    @property
106    def error_details(self):
107        """Gets the error_details of this Group.  # noqa: E501
108
109        Array or errors.  # noqa: E501
110
111        :return: The error_details of this Group.  # noqa: E501
112        :rtype: ErrorDetails
113        """
114        return self._error_details
115
116    @error_details.setter
117    def error_details(self, error_details):
118        """Sets the error_details of this Group.
119
120        Array or errors.  # noqa: E501
121
122        :param error_details: The error_details of this Group.  # noqa: E501
123        :type: ErrorDetails
124        """
125
126        self._error_details = error_details
127
128    @property
129    def group_id(self):
130        """Gets the group_id of this Group.  # noqa: E501
131
132        The DocuSign group ID for the group.  # noqa: E501
133
134        :return: The group_id of this Group.  # noqa: E501
135        :rtype: str
136        """
137        return self._group_id
138
139    @group_id.setter
140    def group_id(self, group_id):
141        """Sets the group_id of this Group.
142
143        The DocuSign group ID for the group.  # noqa: E501
144
145        :param group_id: The group_id of this Group.  # noqa: E501
146        :type: str
147        """
148
149        self._group_id = group_id
150
151    @property
152    def group_name(self):
153        """Gets the group_name of this Group.  # noqa: E501
154
155        The name of the group.  # noqa: E501
156
157        :return: The group_name of this Group.  # noqa: E501
158        :rtype: str
159        """
160        return self._group_name
161
162    @group_name.setter
163    def group_name(self, group_name):
164        """Sets the group_name of this Group.
165
166        The name of the group.  # noqa: E501
167
168        :param group_name: The group_name of this Group.  # noqa: E501
169        :type: str
170        """
171
172        self._group_name = group_name
173
174    @property
175    def group_type(self):
176        """Gets the group_type of this Group.  # noqa: E501
177
178        The group type.  # noqa: E501
179
180        :return: The group_type of this Group.  # noqa: E501
181        :rtype: str
182        """
183        return self._group_type
184
185    @group_type.setter
186    def group_type(self, group_type):
187        """Sets the group_type of this Group.
188
189        The group type.  # noqa: E501
190
191        :param group_type: The group_type of this Group.  # noqa: E501
192        :type: str
193        """
194
195        self._group_type = group_type
196
197    @property
198    def permission_profile_id(self):
199        """Gets the permission_profile_id of this Group.  # noqa: E501
200
201        The ID of the permission profile associated with the group.  # noqa: E501
202
203        :return: The permission_profile_id of this Group.  # noqa: E501
204        :rtype: str
205        """
206        return self._permission_profile_id
207
208    @permission_profile_id.setter
209    def permission_profile_id(self, permission_profile_id):
210        """Sets the permission_profile_id of this Group.
211
212        The ID of the permission profile associated with the group.  # noqa: E501
213
214        :param permission_profile_id: The permission_profile_id of this Group.  # noqa: E501
215        :type: str
216        """
217
218        self._permission_profile_id = permission_profile_id
219
220    @property
221    def users(self):
222        """Gets the users of this Group.  # noqa: E501
223
224          # noqa: E501
225
226        :return: The users of this Group.  # noqa: E501
227        :rtype: list[UserInfo]
228        """
229        return self._users
230
231    @users.setter
232    def users(self, users):
233        """Sets the users of this Group.
234
235          # noqa: E501
236
237        :param users: The users of this Group.  # noqa: E501
238        :type: list[UserInfo]
239        """
240
241        self._users = users
242
243    @property
244    def users_count(self):
245        """Gets the users_count of this Group.  # noqa: E501
246
247          # noqa: E501
248
249        :return: The users_count of this Group.  # noqa: E501
250        :rtype: str
251        """
252        return self._users_count
253
254    @users_count.setter
255    def users_count(self, users_count):
256        """Sets the users_count of this Group.
257
258          # noqa: E501
259
260        :param users_count: The users_count of this Group.  # noqa: E501
261        :type: str
262        """
263
264        self._users_count = users_count
265
266    def to_dict(self):
267        """Returns the model properties as a dict"""
268        result = {}
269
270        for attr, _ in six.iteritems(self.swagger_types):
271            value = getattr(self, attr)
272            if isinstance(value, list):
273                result[attr] = list(map(
274                    lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
275                    value
276                ))
277            elif hasattr(value, "to_dict"):
278                result[attr] = value.to_dict()
279            elif isinstance(value, dict):
280                result[attr] = dict(map(
281                    lambda item: (item[0], item[1].to_dict())
282                    if hasattr(item[1], "to_dict") else item,
283                    value.items()
284                ))
285            else:
286                result[attr] = value
287        if issubclass(Group, dict):
288            for key, value in self.items():
289                result[key] = value
290
291        return result
292
293    def to_str(self):
294        """Returns the string representation of the model"""
295        return pprint.pformat(self.to_dict())
296
297    def __repr__(self):
298        """For `print` and `pprint`"""
299        return self.to_str()
300
301    def __eq__(self, other):
302        """Returns true if both objects are equal"""
303        if not isinstance(other, Group):
304            return False
305
306        return self.to_dict() == other.to_dict()
307
308    def __ne__(self, other):
309        """Returns true if both objects are not equal"""
310        if not isinstance(other, Group):
311            return True
312
313        return self.to_dict() != other.to_dict()
class Group:
 23class Group(object):
 24    """NOTE: This class is auto generated by the swagger code generator program.
 25
 26    Do not edit the class manually.
 27    """
 28
 29    """
 30    Attributes:
 31      swagger_types (dict): The key is attribute name
 32                            and the value is attribute type.
 33      attribute_map (dict): The key is attribute name
 34                            and the value is json key in definition.
 35    """
 36    swagger_types = {
 37        'ds_group_id': 'str',
 38        'error_details': 'ErrorDetails',
 39        'group_id': 'str',
 40        'group_name': 'str',
 41        'group_type': 'str',
 42        'permission_profile_id': 'str',
 43        'users': 'list[UserInfo]',
 44        'users_count': 'str'
 45    }
 46
 47    attribute_map = {
 48        'ds_group_id': 'dsGroupId',
 49        'error_details': 'errorDetails',
 50        'group_id': 'groupId',
 51        'group_name': 'groupName',
 52        'group_type': 'groupType',
 53        'permission_profile_id': 'permissionProfileId',
 54        'users': 'users',
 55        'users_count': 'usersCount'
 56    }
 57
 58    def __init__(self, _configuration=None, **kwargs):  # noqa: E501
 59        """Group - a model defined in Swagger"""  # noqa: E501
 60        if _configuration is None:
 61            _configuration = Configuration()
 62        self._configuration = _configuration
 63
 64        self._ds_group_id = None
 65        self._error_details = None
 66        self._group_id = None
 67        self._group_name = None
 68        self._group_type = None
 69        self._permission_profile_id = None
 70        self._users = None
 71        self._users_count = None
 72        self.discriminator = None
 73
 74        setattr(self, "_{}".format('ds_group_id'), kwargs.get('ds_group_id', None))
 75        setattr(self, "_{}".format('error_details'), kwargs.get('error_details', None))
 76        setattr(self, "_{}".format('group_id'), kwargs.get('group_id', None))
 77        setattr(self, "_{}".format('group_name'), kwargs.get('group_name', None))
 78        setattr(self, "_{}".format('group_type'), kwargs.get('group_type', None))
 79        setattr(self, "_{}".format('permission_profile_id'), kwargs.get('permission_profile_id', None))
 80        setattr(self, "_{}".format('users'), kwargs.get('users', None))
 81        setattr(self, "_{}".format('users_count'), kwargs.get('users_count', None))
 82
 83    @property
 84    def ds_group_id(self):
 85        """Gets the ds_group_id of this Group.  # noqa: E501
 86
 87          # noqa: E501
 88
 89        :return: The ds_group_id of this Group.  # noqa: E501
 90        :rtype: str
 91        """
 92        return self._ds_group_id
 93
 94    @ds_group_id.setter
 95    def ds_group_id(self, ds_group_id):
 96        """Sets the ds_group_id of this Group.
 97
 98          # noqa: E501
 99
100        :param ds_group_id: The ds_group_id of this Group.  # noqa: E501
101        :type: str
102        """
103
104        self._ds_group_id = ds_group_id
105
106    @property
107    def error_details(self):
108        """Gets the error_details of this Group.  # noqa: E501
109
110        Array or errors.  # noqa: E501
111
112        :return: The error_details of this Group.  # noqa: E501
113        :rtype: ErrorDetails
114        """
115        return self._error_details
116
117    @error_details.setter
118    def error_details(self, error_details):
119        """Sets the error_details of this Group.
120
121        Array or errors.  # noqa: E501
122
123        :param error_details: The error_details of this Group.  # noqa: E501
124        :type: ErrorDetails
125        """
126
127        self._error_details = error_details
128
129    @property
130    def group_id(self):
131        """Gets the group_id of this Group.  # noqa: E501
132
133        The DocuSign group ID for the group.  # noqa: E501
134
135        :return: The group_id of this Group.  # noqa: E501
136        :rtype: str
137        """
138        return self._group_id
139
140    @group_id.setter
141    def group_id(self, group_id):
142        """Sets the group_id of this Group.
143
144        The DocuSign group ID for the group.  # noqa: E501
145
146        :param group_id: The group_id of this Group.  # noqa: E501
147        :type: str
148        """
149
150        self._group_id = group_id
151
152    @property
153    def group_name(self):
154        """Gets the group_name of this Group.  # noqa: E501
155
156        The name of the group.  # noqa: E501
157
158        :return: The group_name of this Group.  # noqa: E501
159        :rtype: str
160        """
161        return self._group_name
162
163    @group_name.setter
164    def group_name(self, group_name):
165        """Sets the group_name of this Group.
166
167        The name of the group.  # noqa: E501
168
169        :param group_name: The group_name of this Group.  # noqa: E501
170        :type: str
171        """
172
173        self._group_name = group_name
174
175    @property
176    def group_type(self):
177        """Gets the group_type of this Group.  # noqa: E501
178
179        The group type.  # noqa: E501
180
181        :return: The group_type of this Group.  # noqa: E501
182        :rtype: str
183        """
184        return self._group_type
185
186    @group_type.setter
187    def group_type(self, group_type):
188        """Sets the group_type of this Group.
189
190        The group type.  # noqa: E501
191
192        :param group_type: The group_type of this Group.  # noqa: E501
193        :type: str
194        """
195
196        self._group_type = group_type
197
198    @property
199    def permission_profile_id(self):
200        """Gets the permission_profile_id of this Group.  # noqa: E501
201
202        The ID of the permission profile associated with the group.  # noqa: E501
203
204        :return: The permission_profile_id of this Group.  # noqa: E501
205        :rtype: str
206        """
207        return self._permission_profile_id
208
209    @permission_profile_id.setter
210    def permission_profile_id(self, permission_profile_id):
211        """Sets the permission_profile_id of this Group.
212
213        The ID of the permission profile associated with the group.  # noqa: E501
214
215        :param permission_profile_id: The permission_profile_id of this Group.  # noqa: E501
216        :type: str
217        """
218
219        self._permission_profile_id = permission_profile_id
220
221    @property
222    def users(self):
223        """Gets the users of this Group.  # noqa: E501
224
225          # noqa: E501
226
227        :return: The users of this Group.  # noqa: E501
228        :rtype: list[UserInfo]
229        """
230        return self._users
231
232    @users.setter
233    def users(self, users):
234        """Sets the users of this Group.
235
236          # noqa: E501
237
238        :param users: The users of this Group.  # noqa: E501
239        :type: list[UserInfo]
240        """
241
242        self._users = users
243
244    @property
245    def users_count(self):
246        """Gets the users_count of this Group.  # noqa: E501
247
248          # noqa: E501
249
250        :return: The users_count of this Group.  # noqa: E501
251        :rtype: str
252        """
253        return self._users_count
254
255    @users_count.setter
256    def users_count(self, users_count):
257        """Sets the users_count of this Group.
258
259          # noqa: E501
260
261        :param users_count: The users_count of this Group.  # noqa: E501
262        :type: str
263        """
264
265        self._users_count = users_count
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(Group, 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, Group):
305            return False
306
307        return self.to_dict() == other.to_dict()
308
309    def __ne__(self, other):
310        """Returns true if both objects are not equal"""
311        if not isinstance(other, Group):
312            return True
313
314        return self.to_dict() != other.to_dict()

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

Do not edit the class manually.

Group(_configuration=None, **kwargs)
58    def __init__(self, _configuration=None, **kwargs):  # noqa: E501
59        """Group - a model defined in Swagger"""  # noqa: E501
60        if _configuration is None:
61            _configuration = Configuration()
62        self._configuration = _configuration
63
64        self._ds_group_id = None
65        self._error_details = None
66        self._group_id = None
67        self._group_name = None
68        self._group_type = None
69        self._permission_profile_id = None
70        self._users = None
71        self._users_count = None
72        self.discriminator = None
73
74        setattr(self, "_{}".format('ds_group_id'), kwargs.get('ds_group_id', None))
75        setattr(self, "_{}".format('error_details'), kwargs.get('error_details', None))
76        setattr(self, "_{}".format('group_id'), kwargs.get('group_id', None))
77        setattr(self, "_{}".format('group_name'), kwargs.get('group_name', None))
78        setattr(self, "_{}".format('group_type'), kwargs.get('group_type', None))
79        setattr(self, "_{}".format('permission_profile_id'), kwargs.get('permission_profile_id', None))
80        setattr(self, "_{}".format('users'), kwargs.get('users', None))
81        setattr(self, "_{}".format('users_count'), kwargs.get('users_count', None))

Group - a model defined in Swagger

swagger_types = {'ds_group_id': 'str', 'error_details': 'ErrorDetails', 'group_id': 'str', 'group_name': 'str', 'group_type': 'str', 'permission_profile_id': 'str', 'users': 'list[UserInfo]', 'users_count': 'str'}
attribute_map = {'ds_group_id': 'dsGroupId', 'error_details': 'errorDetails', 'group_id': 'groupId', 'group_name': 'groupName', 'group_type': 'groupType', 'permission_profile_id': 'permissionProfileId', 'users': 'users', 'users_count': 'usersCount'}
ds_group_id

Gets the ds_group_id of this Group. # noqa: E501

# noqa: E501

Returns

The ds_group_id of this Group. # noqa: E501

error_details

Gets the error_details of this Group. # noqa: E501

Array or errors. # noqa: E501

Returns

The error_details of this Group. # noqa: E501

group_id

Gets the group_id of this Group. # noqa: E501

The DocuSign group ID for the group. # noqa: E501

Returns

The group_id of this Group. # noqa: E501

group_name

Gets the group_name of this Group. # noqa: E501

The name of the group. # noqa: E501

Returns

The group_name of this Group. # noqa: E501

group_type

Gets the group_type of this Group. # noqa: E501

The group type. # noqa: E501

Returns

The group_type of this Group. # noqa: E501

permission_profile_id

Gets the permission_profile_id of this Group. # noqa: E501

The ID of the permission profile associated with the group. # noqa: E501

Returns

The permission_profile_id of this Group. # noqa: E501

users

Gets the users of this Group. # noqa: E501

# noqa: E501

Returns

The users of this Group. # noqa: E501

users_count

Gets the users_count of this Group. # noqa: E501

# noqa: E501

Returns

The users_count of this Group. # noqa: E501

def to_dict(self)
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(Group, dict):
289            for key, value in self.items():
290                result[key] = value
291
292        return result

Returns the model properties as a dict

def to_str(self)
294    def to_str(self):
295        """Returns the string representation of the model"""
296        return pprint.pformat(self.to_dict())

Returns the string representation of the model