Skip to content

Commit 52b3a2e

Browse files
cmlcciecmlccie
committed
Update Docs for new Admin API wrappers
1 parent 6b43188 commit 52b3a2e

File tree

3 files changed

+93
-29
lines changed

3 files changed

+93
-29
lines changed

‎ciscosparkapi/api/people.py‎

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -197,18 +197,18 @@ def create(self, emails, **person_attributes):
197197
single email address for a person. The list data type was
198198
selected to enable future support for providing multiple email
199199
address.
200-
**person_attributes:
201-
displayName(string_types): Full name of the person
202-
firstName(string_types): First name of the person
203-
lastName(string_types): Last name of the person
204-
avatar(string_types): URL to the person's avatar in PNG format
205-
orgId(string_types): ID of the organization to which this
206-
person belongs
207-
roles(list): Roles of the person (list of strings containing
208-
the role IDs to be assigned to the person)
209-
licenses(list): Licenses allocated to the person (list of
210-
strings containing the license IDs to be allocated to the
211-
person)
200+
**person_attributes
201+
displayName(string_types): Full name of the person
202+
firstName(string_types): First name of the person
203+
lastName(string_types): Last name of the person
204+
avatar(string_types): URL to the person's avatar in PNG format
205+
orgId(string_types): ID of the organization to which this
206+
person belongs
207+
roles(list): Roles of the person (list of strings containing
208+
the role IDs to be assigned to the person)
209+
licenses(list): Licenses allocated to the person (list of
210+
strings containing the license IDs to be allocated to the
211+
person)
212212
213213
Returns:
214214
Person: With the details of the created person.
@@ -238,23 +238,23 @@ def update(self, personId, **person_attributes):
238238
239239
Args:
240240
personId(string_types): The ID of the person to be updated.
241-
**person_attributes:
242-
emails(list): Email address(es) of the person. (list of
243-
strings) CURRENT LIMITATION: Spark (today) only allows you
244-
to provide a single email address for a person. The list
245-
data type was selected to enable future support for
246-
providing multiple email address.
247-
displayName(string_types): Full name of the person
248-
firstName(string_types): First name of the person
249-
lastName(string_types): Last name of the person
250-
avatar(string_types): URL to the person's avatar in PNG format
251-
orgId(string_types): ID of the organization to which this
252-
person belongs
253-
roles(list): Roles of the person (list of strings containing
254-
the role IDs to be assigned to the person)
255-
licenses(list): Licenses allocated to the person (list of
256-
strings containing the license IDs to be allocated to the
257-
person)
241+
**person_attributes
242+
emails(list): Email address(es) of the person. (list of
243+
strings) CURRENT LIMITATION: Spark (today) only allows you
244+
to provide a single email address for a person. The list
245+
data type was selected to enable future support for
246+
providing multiple email address.
247+
displayName(string_types): Full name of the person
248+
firstName(string_types): First name of the person
249+
lastName(string_types): Last name of the person
250+
avatar(string_types): URL to the person's avatar in PNG format
251+
orgId(string_types): ID of the organization to which this
252+
person belongs
253+
roles(list): Roles of the person (list of strings containing
254+
the role IDs to be assigned to the person)
255+
licenses(list): Licenses allocated to the person (list of
256+
strings containing the license IDs to be allocated to the
257+
person)
258258
259259
Returns:
260260
Person: With the updated person details.

‎docs/user/api.rst‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,30 @@ webhooks
7676
.. autoclass:: WebhooksAPI()
7777

7878

79+
.. _organizations:
80+
81+
organizations
82+
-------------
83+
84+
.. autoclass:: OrganizationsAPI()
85+
86+
87+
.. _licenses:
88+
89+
licenses
90+
--------
91+
92+
.. autoclass:: LicensesAPI()
93+
94+
95+
.. _roles:
96+
97+
roles
98+
-----
99+
100+
.. autoclass:: RolesAPI()
101+
102+
79103
.. _access_tokens:
80104

81105
access_tokens
@@ -156,6 +180,30 @@ Webhook
156180
.. autoclass:: Webhook()
157181

158182

183+
.. _Organization:
184+
185+
Organization
186+
------------
187+
188+
.. autoclass:: Organization()
189+
190+
191+
.. _License:
192+
193+
License
194+
-------
195+
196+
.. autoclass:: License()
197+
198+
199+
.. _Role:
200+
201+
Role
202+
----
203+
204+
.. autoclass:: Role()
205+
206+
159207
.. _Access Token:
160208

161209
Access Token

‎docs/user/quickstart.rst‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -161,8 +161,12 @@ structure is provided here.
161161
+-----------------------+-------------------------+-------------------------------------+
162162
|:class:`CiscoSparkAPI` | :ref:`people` | :meth:`~PeopleAPI.list` |
163163
| | +-------------------------------------+
164+
| | | :meth:`~PeopleAPI.create` |
165+
| | +-------------------------------------+
164166
| | | :meth:`~PeopleAPI.get` |
165167
| | +-------------------------------------+
168+
| | | :meth:`~PeopleAPI.update` |
169+
| | +-------------------------------------+
166170
| | | :meth:`~PeopleAPI.me` |
167171
+-----------------------+-------------------------+-------------------------------------+
168172
| | :ref:`rooms` | :meth:`~RoomsAPI.list` |
@@ -223,6 +227,18 @@ structure is provided here.
223227
| | +-------------------------------------+
224228
| | | :meth:`~WebhooksAPI.delete` |
225229
+-----------------------+-------------------------+-------------------------------------+
230+
| | :ref:`organizations` | :meth:`~OrganizationsAPI.list` |
231+
| | +-------------------------------------+
232+
| | | :meth:`~OrganizationsAPI.create` |
233+
+-----------------------+-------------------------+-------------------------------------+
234+
| | :ref:`licenses` | :meth:`~LicensesAPI.list` |
235+
| | +-------------------------------------+
236+
| | | :meth:`~LicensesAPI.create` |
237+
+-----------------------+-------------------------+-------------------------------------+
238+
| | :ref:`roles` | :meth:`~RolesAPI.list` |
239+
| | +-------------------------------------+
240+
| | | :meth:`~RolesAPI.create` |
241+
+-----------------------+-------------------------+-------------------------------------+
226242
| | :ref:`access_tokens` | :meth:`~AccessTokensAPI.get` |
227243
| | +-------------------------------------+
228244
| | | :meth:`~AccessTokensAPI.refresh` |

0 commit comments

Comments
 (0)