Skip to content

Commit 916b935

Browse files
committed
Spark to Webex Teams name changes
More Spark to Webex Teams name changes.
1 parent 03a6842 commit 916b935

31 files changed

+72
-74
lines changed

webexteamssdk/api/__init__.py

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -122,8 +122,7 @@ def __init__(self, access_token=None, base_url=DEFAULT_BASE_URL,
122122
Raises:
123123
TypeError: If the parameter types are incorrect.
124124
AccessTokenError: If an access token is not provided via the
125-
access_token argument or SPARK_ACCESS_TOKEN environment
126-
variable.
125+
access_token argument or an environment variable.
127126
128127
"""
129128
check_type(access_token, basestring)
@@ -135,7 +134,7 @@ def __init__(self, access_token=None, base_url=DEFAULT_BASE_URL,
135134
if not access_token:
136135
raise AccessTokenError(
137136
"You must provide a Webex Teams access token to interact with "
138-
"the Webex Teams APIs, either via a SPARK_ACCESS_TOKEN "
137+
"the Webex Teams APIs, either via a WEBEX_TEAMS_ACCESS_TOKEN "
139138
"environment variable or via the access_token argument."
140139
)
141140

@@ -150,7 +149,7 @@ def __init__(self, access_token=None, base_url=DEFAULT_BASE_URL,
150149
wait_on_rate_limit=wait_on_rate_limit
151150
)
152151

153-
# Spark API wrappers
152+
# API wrappers
154153
self.people = PeopleAPI(self._session, object_factory)
155154
self.rooms = RoomsAPI(self._session, object_factory)
156155
self.memberships = MembershipsAPI(self._session, object_factory)

webexteamssdk/api/events.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ def list(self, resource=None, type=None, actorId=None, _from=None, to=None,
8787
Linking to provide pagination support. It returns a generator
8888
container that incrementally yields all events returned by the
8989
query. The generator will automatically request additional 'pages' of
90-
responses from Spark as needed until all responses have been returned.
90+
responses from Wevex as needed until all responses have been returned.
9191
The container makes the generator safe for reuse. A new API call will
9292
be made, using the same parameters that were specified when the
9393
generator was created, every time a new iterator is requested from the
@@ -104,8 +104,8 @@ def list(self, resource=None, type=None, actorId=None, _from=None, to=None,
104104
date and time, in ISO8601 format (yyyy-MM-dd'T'HH:mm:ss.SSSZ).
105105
to(basestring): Limit results to events which occurred before a
106106
date and time, in ISO8601 format (yyyy-MM-dd'T'HH:mm:ss.SSSZ).
107-
max(int): Limit the maximum number of items returned from the Spark
108-
service per request.
107+
max(int): Limit the maximum number of items returned from the Webex
108+
Teams service per request.
109109
**request_parameters: Additional request parameters (provides
110110
support for parameters that may be added in the future).
111111

webexteamssdk/api/licenses.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -83,16 +83,16 @@ def list(self, orgId=None, max=None, **request_parameters):
8383
Linking to provide pagination support. It returns a generator
8484
container that incrementally yields all objects returned by the
8585
query. The generator will automatically request additional 'pages' of
86-
responses from Spark as needed until all responses have been returned.
86+
responses from Webex as needed until all responses have been returned.
8787
The container makes the generator safe for reuse. A new API call will
8888
be made, using the same parameters that were specified when the
8989
generator was created, every time a new iterator is requested from the
9090
container.
9191
9292
Args:
9393
orgId(basestring): Specify the organization, by ID.
94-
max(int): Limit the maximum number of items returned from the Spark
95-
service per request.
94+
max(int): Limit the maximum number of items returned from the Webex
95+
Teams service per request.
9696
**request_parameters: Additional request parameters (provides
9797
support for parameters that may be added in the future).
9898

webexteamssdk/api/memberships.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ def list(self, roomId=None, personId=None, personEmail=None, max=None,
9090
Linking to provide pagination support. It returns a generator
9191
container that incrementally yields all memberships returned by the
9292
query. The generator will automatically request additional 'pages' of
93-
responses from Spark as needed until all responses have been returned.
93+
responses from Webex as needed until all responses have been returned.
9494
The container makes the generator safe for reuse. A new API call will
9595
be made, using the same parameters that were specified when the
9696
generator was created, every time a new iterator is requested from the
@@ -101,8 +101,8 @@ def list(self, roomId=None, personId=None, personEmail=None, max=None,
101101
personId(basestring): Limit results to a specific person, by ID.
102102
personEmail(basestring): Limit results to a specific person, by
103103
email address.
104-
max(int): Limit the maximum number of items returned from the Spark
105-
service per request.
104+
max(int): Limit the maximum number of items returned from the Webex
105+
Teams service per request.
106106
**request_parameters: Additional request parameters (provides
107107
support for parameters that may be added in the future).
108108
@@ -211,8 +211,8 @@ def update(self, membershipId, isModerator=None, **request_parameters):
211211
support for parameters that may be added in the future).
212212
213213
Returns:
214-
Membership: A Membership object with the updated Spark membership
215-
details.
214+
Membership: A Membership object with the updated Webex Teams
215+
membership details.
216216
217217
Raises:
218218
TypeError: If the parameter types are incorrect.

webexteamssdk/api/messages.py

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ def list(self, roomId, mentionedPeople=None, before=None,
8484
Linking to provide pagination support. It returns a generator
8585
container that incrementally yields all messages returned by the
8686
query. The generator will automatically request additional 'pages' of
87-
responses from Spark as needed until all responses have been returned.
87+
responses from Webex as needed until all responses have been returned.
8888
The container makes the generator safe for reuse. A new API call will
8989
be made, using the same parameters that were specified when the
9090
generator was created, every time a new iterator is requested from the
@@ -98,8 +98,8 @@ def list(self, roomId, mentionedPeople=None, before=None,
9898
ISO8601 format.
9999
beforeMessage(basestring): List messages sent before a message,
100100
by ID.
101-
max(int): Limit the maximum number of items returned from the Spark
102-
service per request.
101+
max(int): Limit the maximum number of items returned from the Webex
102+
Teams service per request.
103103
**request_parameters: Additional request parameters (provides
104104
support for parameters that may be added in the future).
105105
@@ -154,8 +154,6 @@ def create(self, roomId=None, toPersonId=None, toPersonEmail=None,
154154
markdown(basestring): The message, in markdown format.
155155
files(list): A list of public URL(s) or local path(s) to files to
156156
be posted into the room. Only one file is allowed per message.
157-
Uploaded files are automatically converted into a format that
158-
all Spark clients can render.
159157
**request_parameters: Additional request parameters (provides
160158
support for parameters that may be added in the future).
161159

webexteamssdk/api/organizations.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -77,15 +77,15 @@ def list(self, max=None, **request_parameters):
7777
Linking to provide pagination support. It returns a generator
7878
container that incrementally yields all objects returned by the
7979
query. The generator will automatically request additional 'pages' of
80-
responses from Spark as needed until all responses have been returned.
80+
responses from Webex as needed until all responses have been returned.
8181
The container makes the generator safe for reuse. A new API call will
8282
be made, using the same parameters that were specified when the
8383
generator was created, every time a new iterator is requested from the
8484
container.
8585
8686
Args:
87-
max(int): Limit the maximum number of items returned from the Spark
88-
service per request.
87+
max(int): Limit the maximum number of items returned from the
88+
Webex Teams service per request.
8989
**request_parameters: Additional request parameters (provides
9090
support for parameters that may be added in the future).
9191

webexteamssdk/api/people.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ def list(self, email=None, displayName=None, id=None, orgId=None, max=None,
8181
Linking to provide pagination support. It returns a generator
8282
container that incrementally yields all people returned by the
8383
query. The generator will automatically request additional 'pages' of
84-
responses from Spark as needed until all responses have been returned.
84+
responses from Webex as needed until all responses have been returned.
8585
The container makes the generator safe for reuse. A new API call will
8686
be made, using the same parameters that were specified when the
8787
generator was created, every time a new iterator is requested from the
@@ -94,8 +94,8 @@ def list(self, email=None, displayName=None, id=None, orgId=None, max=None,
9494
id(basestring): List people by ID. Accepts up to 85 person IDs
9595
separated by commas.
9696
orgId(basestring): The organization ID.
97-
max(int): Limit the maximum number of items returned from the Spark
98-
service per request.
97+
max(int): Limit the maximum number of items returned from the Webex
98+
Teams service per request.
9999
**request_parameters: Additional request parameters (provides
100100
support for parameters that may be added in the future).
101101
@@ -217,7 +217,7 @@ def update(self, personId, emails=None, displayName=None, firstName=None,
217217
218218
Only an admin can update a person's details.
219219
220-
Email addresses for a person cannot be changed via the Spark API.
220+
Email addresses for a person cannot be changed via the Webex Teams API.
221221
222222
Include all details for the person. This action expects all user
223223
details to be present in the request. A common approach is to first GET

webexteamssdk/api/roles.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -80,15 +80,15 @@ def list(self, max=None, **request_parameters):
8080
Linking to provide pagination support. It returns a generator
8181
container that incrementally yields all objects returned by the
8282
query. The generator will automatically request additional 'pages' of
83-
responses from Spark as needed until all responses have been returned.
83+
responses from Webex as needed until all responses have been returned.
8484
The container makes the generator safe for reuse. A new API call will
8585
be made, using the same parameters that were specified when the
8686
generator was created, every time a new iterator is requested from the
8787
container.
8888
8989
Args:
90-
max(int): Limit the maximum number of items returned from the Spark
91-
service per request.
90+
max(int): Limit the maximum number of items returned from the Webex
91+
Teams service per request.
9292
**request_parameters: Additional request parameters (provides
9393
support for parameters that may be added in the future).
9494

webexteamssdk/api/rooms.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ def list(self, teamId=None, type=None, sortBy=None, max=None,
8383
Linking to provide pagination support. It returns a generator
8484
container that incrementally yields all rooms returned by the
8585
query. The generator will automatically request additional 'pages' of
86-
responses from Spark as needed until all responses have been returned.
86+
responses from Webex as needed until all responses have been returned.
8787
The container makes the generator safe for reuse. A new API call will
8888
be made, using the same parameters that were specified when the
8989
generator was created, every time a new iterator is requested from the
@@ -98,8 +98,8 @@ def list(self, teamId=None, type=None, sortBy=None, max=None,
9898
sortBy(basestring): Sort results by room ID (`id`), most recent
9999
activity (`lastactivity`), or most recently created
100100
(`created`).
101-
max(int): Limit the maximum number of items returned from the Spark
102-
service per request.
101+
max(int): Limit the maximum number of items returned from the Webex
102+
Teams service per request.
103103
**request_parameters: Additional request parameters (provides
104104
support for parameters that may be added in the future).
105105
@@ -199,7 +199,7 @@ def update(self, roomId, title=None, **request_parameters):
199199
support for parameters that may be added in the future).
200200
201201
Returns:
202-
Room: A Room object with the updated Spark room details.
202+
Room: A Room object with the updated Webex Teams room details.
203203
204204
Raises:
205205
TypeError: If the parameter types are incorrect.

webexteamssdk/api/team_memberships.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -80,16 +80,16 @@ def list(self, teamId, max=None, **request_parameters):
8080
Linking to provide pagination support. It returns a generator
8181
container that incrementally yields all team memberships returned by
8282
the query. The generator will automatically request additional 'pages'
83-
of responses from Spark as needed until all responses have been
83+
of responses from Webex as needed until all responses have been
8484
returned. The container makes the generator safe for reuse. A new API
8585
call will be made, using the same parameters that were specified when
8686
the generator was created, every time a new iterator is requested from
8787
the container.
8888
8989
Args:
9090
teamId(basestring): List team memberships for a team, by ID.
91-
max(int): Limit the maximum number of items returned from the Spark
92-
service per request.
91+
max(int): Limit the maximum number of items returned from the Webex
92+
Teams service per request.
9393
**request_parameters: Additional request parameters (provides
9494
support for parameters that may be added in the future).
9595
@@ -195,8 +195,8 @@ def update(self, membershipId, isModerator=None, **request_parameters):
195195
support for parameters that may be added in the future).
196196
197197
Returns:
198-
TeamMembership: A TeamMembership object with the updated Spark team
199-
membership details.
198+
TeamMembership: A TeamMembership object with the updated Webex
199+
Teams team-membership details.
200200
201201
Raises:
202202
TypeError: If the parameter types are incorrect.

0 commit comments

Comments
 (0)