universal-mcp-applications 0.1.21__py3-none-any.whl → 0.1.22__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of universal-mcp-applications might be problematic. Click here for more details.

Files changed (78) hide show
  1. universal_mcp/applications/BEST_PRACTICES.md +166 -0
  2. universal_mcp/applications/airtable/app.py +0 -1
  3. universal_mcp/applications/apollo/app.py +0 -1
  4. universal_mcp/applications/aws_s3/app.py +40 -39
  5. universal_mcp/applications/browser_use/README.md +1 -0
  6. universal_mcp/applications/browser_use/__init__.py +0 -0
  7. universal_mcp/applications/browser_use/app.py +76 -0
  8. universal_mcp/applications/calendly/app.py +125 -125
  9. universal_mcp/applications/canva/app.py +95 -99
  10. universal_mcp/applications/confluence/app.py +0 -1
  11. universal_mcp/applications/contentful/app.py +4 -5
  12. universal_mcp/applications/domain_checker/app.py +11 -15
  13. universal_mcp/applications/e2b/app.py +4 -4
  14. universal_mcp/applications/elevenlabs/app.py +18 -15
  15. universal_mcp/applications/exa/app.py +17 -17
  16. universal_mcp/applications/falai/app.py +28 -29
  17. universal_mcp/applications/file_system/app.py +9 -9
  18. universal_mcp/applications/firecrawl/app.py +36 -36
  19. universal_mcp/applications/fireflies/app.py +55 -56
  20. universal_mcp/applications/fpl/app.py +49 -50
  21. universal_mcp/applications/ghost_content/app.py +0 -1
  22. universal_mcp/applications/github/app.py +41 -43
  23. universal_mcp/applications/google_calendar/app.py +40 -39
  24. universal_mcp/applications/google_docs/app.py +56 -56
  25. universal_mcp/applications/google_drive/app.py +212 -215
  26. universal_mcp/applications/google_gemini/app.py +1 -5
  27. universal_mcp/applications/google_mail/app.py +91 -90
  28. universal_mcp/applications/google_searchconsole/app.py +29 -29
  29. universal_mcp/applications/google_sheet/app.py +115 -115
  30. universal_mcp/applications/hashnode/README.md +6 -3
  31. universal_mcp/applications/hashnode/app.py +174 -25
  32. universal_mcp/applications/http_tools/app.py +10 -11
  33. universal_mcp/applications/hubspot/__init__.py +1 -1
  34. universal_mcp/applications/hubspot/api_segments/api_segment_base.py +36 -7
  35. universal_mcp/applications/hubspot/api_segments/crm_api.py +368 -368
  36. universal_mcp/applications/hubspot/api_segments/marketing_api.py +115 -115
  37. universal_mcp/applications/hubspot/app.py +131 -72
  38. universal_mcp/applications/jira/app.py +0 -1
  39. universal_mcp/applications/linkedin/app.py +20 -20
  40. universal_mcp/applications/markitdown/app.py +10 -5
  41. universal_mcp/applications/ms_teams/app.py +123 -123
  42. universal_mcp/applications/openai/app.py +40 -39
  43. universal_mcp/applications/outlook/app.py +32 -32
  44. universal_mcp/applications/perplexity/app.py +4 -4
  45. universal_mcp/applications/reddit/app.py +69 -70
  46. universal_mcp/applications/resend/app.py +116 -117
  47. universal_mcp/applications/rocketlane/app.py +0 -1
  48. universal_mcp/applications/scraper/__init__.py +1 -1
  49. universal_mcp/applications/scraper/app.py +80 -81
  50. universal_mcp/applications/serpapi/app.py +14 -14
  51. universal_mcp/applications/sharepoint/app.py +19 -20
  52. universal_mcp/applications/shopify/app.py +0 -1
  53. universal_mcp/applications/slack/app.py +48 -48
  54. universal_mcp/applications/tavily/app.py +4 -4
  55. universal_mcp/applications/twitter/api_segments/compliance_api.py +13 -15
  56. universal_mcp/applications/twitter/api_segments/dm_conversations_api.py +20 -20
  57. universal_mcp/applications/twitter/api_segments/dm_events_api.py +12 -12
  58. universal_mcp/applications/twitter/api_segments/likes_api.py +12 -12
  59. universal_mcp/applications/twitter/api_segments/lists_api.py +37 -39
  60. universal_mcp/applications/twitter/api_segments/spaces_api.py +24 -24
  61. universal_mcp/applications/twitter/api_segments/trends_api.py +4 -4
  62. universal_mcp/applications/twitter/api_segments/tweets_api.py +105 -105
  63. universal_mcp/applications/twitter/api_segments/usage_api.py +4 -4
  64. universal_mcp/applications/twitter/api_segments/users_api.py +136 -136
  65. universal_mcp/applications/twitter/app.py +6 -2
  66. universal_mcp/applications/unipile/app.py +90 -97
  67. universal_mcp/applications/whatsapp/app.py +53 -54
  68. universal_mcp/applications/whatsapp/audio.py +39 -35
  69. universal_mcp/applications/whatsapp/whatsapp.py +176 -154
  70. universal_mcp/applications/whatsapp_business/app.py +92 -92
  71. universal_mcp/applications/yahoo_finance/app.py +105 -63
  72. universal_mcp/applications/youtube/app.py +193 -196
  73. universal_mcp/applications/zenquotes/__init__.py +2 -0
  74. universal_mcp/applications/zenquotes/app.py +3 -3
  75. {universal_mcp_applications-0.1.21.dist-info → universal_mcp_applications-0.1.22.dist-info}/METADATA +2 -1
  76. {universal_mcp_applications-0.1.21.dist-info → universal_mcp_applications-0.1.22.dist-info}/RECORD +78 -74
  77. {universal_mcp_applications-0.1.21.dist-info → universal_mcp_applications-0.1.22.dist-info}/WHEEL +0 -0
  78. {universal_mcp_applications-0.1.21.dist-info → universal_mcp_applications-0.1.22.dist-info}/licenses/LICENSE +0 -0
@@ -12,19 +12,19 @@ class LikesApi(APISegmentBase):
12
12
  ) -> Any:
13
13
  """
14
14
  Streams compliance-related data for 'like' events, such as un-likes, with optional time and backfill filters. This endpoint is for compliance monitoring, differing from the firehose and sample streams which provide real-time like creation events.
15
-
15
+
16
16
  Args:
17
17
  backfill_minutes (integer): Specifies the number of minutes of missed data to recover in case of a disconnection, allowing retrieval of up to five minutes of past data.
18
18
  start_time (string): The optional start_time query parameter specifies the earliest timestamp from which to retrieve compliance stream data. Example: '2021-02-01T18:40:40.000Z'.
19
19
  end_time (string): Optional end time to filter the compliance stream, specified as a string. Example: '2021-02-01T18:40:40.000Z'.
20
-
20
+
21
21
  Returns:
22
22
  Any: The request has succeeded.
23
-
23
+
24
24
  Raises:
25
25
  HTTPError: Raised when the API request fails (e.g., non-2XX status code).
26
26
  JSONDecodeError: Raised if the response body cannot be parsed as JSON.
27
-
27
+
28
28
  Tags:
29
29
  Compliance
30
30
  """
@@ -55,7 +55,7 @@ class LikesApi(APISegmentBase):
55
55
  ) -> dict[str, Any]:
56
56
  """
57
57
  Streams a comprehensive, real-time 'firehose' of all like events from a specified data partition. This function allows time-based filtering and customization of returned fields, providing a complete data flow distinct from the compliance or sampled stream methods.
58
-
58
+
59
59
  Args:
60
60
  partition (integer): The partition query parameter specifies the integer identifier of the data subset or bucket to stream from the firehose endpoint, enabling segmented retrieval of likes data.
61
61
  backfill_minutes (integer): The number of minutes (up to five) to backfill and recover missed data from the stream after a disconnection.
@@ -65,14 +65,14 @@ class LikesApi(APISegmentBase):
65
65
  expansions (array): A comma separated list of fields to expand. Example: "['liked_tweet_author_id', 'liked_tweet_id']".
66
66
  user_fields (array): A comma separated list of User fields to display. Example: "['affiliation', 'connection_status', 'created_at', 'description', 'entities', 'id', 'location', 'most_recent_tweet_id', 'name', 'pinned_tweet_id', 'profile_banner_url', 'profile_image_url', 'protected', 'public_metrics', 'receives_your_dm', 'subscription_type', 'url', 'username', 'verified', 'verified_type', 'withheld']".
67
67
  tweet_fields (array): A comma separated list of Tweet fields to display. Example: "['article', 'attachments', 'author_id', 'card_uri', 'context_annotations', 'conversation_id', 'created_at', 'edit_controls', 'edit_history_tweet_ids', 'entities', 'geo', 'id', 'in_reply_to_user_id', 'lang', 'non_public_metrics', 'note_tweet', 'organic_metrics', 'possibly_sensitive', 'promoted_metrics', 'public_metrics', 'referenced_tweets', 'reply_settings', 'scopes', 'source', 'text', 'username', 'withheld']".
68
-
68
+
69
69
  Returns:
70
70
  dict[str, Any]: The request has succeeded.
71
-
71
+
72
72
  Raises:
73
73
  HTTPError: Raised when the API request fails (e.g., non-2XX status code).
74
74
  JSONDecodeError: Raised if the response body cannot be parsed as JSON.
75
-
75
+
76
76
  Tags:
77
77
  Likes
78
78
  """
@@ -108,7 +108,7 @@ class LikesApi(APISegmentBase):
108
108
  ) -> dict[str, Any]:
109
109
  """
110
110
  Streams a 10% sample of real-time like events, a low-volume alternative to the full firehose stream. It allows filtering by partition and time range, and supports data enrichment by specifying tweet, user, and expansion fields to customize the response.
111
-
111
+
112
112
  Args:
113
113
  partition (integer): The partition query parameter specifies the integer identifier of the data partition to retrieve in the sample10 likes stream.
114
114
  backfill_minutes (integer): Optional integer parameter to specify the number of minutes of missed data to recover, used for reconnecting after a disconnection in the stream.
@@ -118,14 +118,14 @@ class LikesApi(APISegmentBase):
118
118
  expansions (array): A comma separated list of fields to expand. Example: "['liked_tweet_author_id', 'liked_tweet_id']".
119
119
  user_fields (array): A comma separated list of User fields to display. Example: "['affiliation', 'connection_status', 'created_at', 'description', 'entities', 'id', 'location', 'most_recent_tweet_id', 'name', 'pinned_tweet_id', 'profile_banner_url', 'profile_image_url', 'protected', 'public_metrics', 'receives_your_dm', 'subscription_type', 'url', 'username', 'verified', 'verified_type', 'withheld']".
120
120
  tweet_fields (array): A comma separated list of Tweet fields to display. Example: "['article', 'attachments', 'author_id', 'card_uri', 'context_annotations', 'conversation_id', 'created_at', 'edit_controls', 'edit_history_tweet_ids', 'entities', 'geo', 'id', 'in_reply_to_user_id', 'lang', 'non_public_metrics', 'note_tweet', 'organic_metrics', 'possibly_sensitive', 'promoted_metrics', 'public_metrics', 'referenced_tweets', 'reply_settings', 'scopes', 'source', 'text', 'username', 'withheld']".
121
-
121
+
122
122
  Returns:
123
123
  dict[str, Any]: The request has succeeded.
124
-
124
+
125
125
  Raises:
126
126
  HTTPError: Raised when the API request fails (e.g., non-2XX status code).
127
127
  JSONDecodeError: Raised if the response body cannot be parsed as JSON.
128
-
128
+
129
129
  Tags:
130
130
  Likes
131
131
  """
@@ -7,24 +7,22 @@ class ListsApi(APISegmentBase):
7
7
  def __init__(self, main_app_client: Any):
8
8
  super().__init__(main_app_client)
9
9
 
10
- def create_list(
11
- self, description=None, name=None, private=None
12
- ) -> dict[str, Any]:
10
+ def create_list(self, description=None, name=None, private=None) -> dict[str, Any]:
13
11
  """
14
12
  Creates a new list on X (formerly Twitter) with an optional name, description, and privacy setting. It sends a POST request to the `/2/lists` endpoint and returns the JSON data of the newly created list upon success.
15
-
13
+
16
14
  Args:
17
15
  description (string): description
18
16
  name (string): name
19
17
  private (boolean): private
20
-
18
+
21
19
  Returns:
22
20
  dict[str, Any]: The request has succeeded.
23
-
21
+
24
22
  Raises:
25
23
  HTTPError: Raised when the API request fails (e.g., non-2XX status code).
26
24
  JSONDecodeError: Raised if the response body cannot be parsed as JSON.
27
-
25
+
28
26
  Tags:
29
27
  Lists, important
30
28
  """
@@ -51,17 +49,17 @@ class ListsApi(APISegmentBase):
51
49
  def delete_list(self, id) -> dict[str, Any]:
52
50
  """
53
51
  Permanently deletes a specific Twitter List identified by its unique ID. This function sends an authorized DELETE request to the API's `/2/lists/{id}` endpoint, returning a confirmation response upon successful removal. It is distinct from `list_remove_member`, which only removes a user from a list.
54
-
52
+
55
53
  Args:
56
54
  id (string): id
57
-
55
+
58
56
  Returns:
59
57
  dict[str, Any]: The request has succeeded.
60
-
58
+
61
59
  Raises:
62
60
  HTTPError: Raised when the API request fails (e.g., non-2XX status code).
63
61
  JSONDecodeError: Raised if the response body cannot be parsed as JSON.
64
-
62
+
65
63
  Tags:
66
64
  Lists
67
65
  """
@@ -78,20 +76,20 @@ class ListsApi(APISegmentBase):
78
76
  ) -> dict[str, Any]:
79
77
  """
80
78
  Retrieves detailed information for a specific list by its ID. This function allows for response customization by specifying which list and user fields to return and supports expansions to include related objects like the owner's user data.
81
-
79
+
82
80
  Args:
83
81
  id (string): id
84
82
  list_fields (array): A comma separated list of List fields to display. Example: "['created_at', 'description', 'follower_count', 'id', 'member_count', 'name', 'owner_id', 'private']".
85
83
  expansions (array): A comma separated list of fields to expand. Example: "['owner_id']".
86
84
  user_fields (array): A comma separated list of User fields to display. Example: "['affiliation', 'connection_status', 'created_at', 'description', 'entities', 'id', 'location', 'most_recent_tweet_id', 'name', 'pinned_tweet_id', 'profile_banner_url', 'profile_image_url', 'protected', 'public_metrics', 'receives_your_dm', 'subscription_type', 'url', 'username', 'verified', 'verified_type', 'withheld']".
87
-
85
+
88
86
  Returns:
89
87
  dict[str, Any]: The request has succeeded.
90
-
88
+
91
89
  Raises:
92
90
  HTTPError: Raised when the API request fails (e.g., non-2XX status code).
93
91
  JSONDecodeError: Raised if the response body cannot be parsed as JSON.
94
-
92
+
95
93
  Tags:
96
94
  Lists
97
95
  """
@@ -116,20 +114,20 @@ class ListsApi(APISegmentBase):
116
114
  ) -> dict[str, Any]:
117
115
  """
118
116
  Modifies an existing Twitter list identified by its unique ID. This function updates the list's name, description, or privacy status by sending a PUT request to the API and returns the updated list data upon success.
119
-
117
+
120
118
  Args:
121
119
  id (string): id
122
120
  description (string): description
123
121
  name (string): name
124
122
  private (boolean): private
125
-
123
+
126
124
  Returns:
127
125
  dict[str, Any]: The request has succeeded.
128
-
126
+
129
127
  Raises:
130
128
  HTTPError: Raised when the API request fails (e.g., non-2XX status code).
131
129
  JSONDecodeError: Raised if the response body cannot be parsed as JSON.
132
-
130
+
133
131
  Tags:
134
132
  Lists
135
133
  """
@@ -166,7 +164,7 @@ class ListsApi(APISegmentBase):
166
164
  ) -> dict[str, Any]:
167
165
  """
168
166
  Retrieves the users who follow a specific list, identified by its ID. Supports pagination and allows for the customization of returned user, tweet, and expansion fields to tailor the response data, differentiating it from fetching list members.
169
-
167
+
170
168
  Args:
171
169
  id (string): id
172
170
  max_results (integer): Specifies the maximum number of follower results to return, with a default value of 100.
@@ -174,14 +172,14 @@ class ListsApi(APISegmentBase):
174
172
  user_fields (array): A comma separated list of User fields to display. Example: "['affiliation', 'connection_status', 'created_at', 'description', 'entities', 'id', 'location', 'most_recent_tweet_id', 'name', 'pinned_tweet_id', 'profile_banner_url', 'profile_image_url', 'protected', 'public_metrics', 'receives_your_dm', 'subscription_type', 'url', 'username', 'verified', 'verified_type', 'withheld']".
175
173
  expansions (array): A comma separated list of fields to expand. Example: "['affiliation.user_id', 'most_recent_tweet_id', 'pinned_tweet_id']".
176
174
  tweet_fields (array): A comma separated list of Tweet fields to display. Example: "['article', 'attachments', 'author_id', 'card_uri', 'context_annotations', 'conversation_id', 'created_at', 'edit_controls', 'edit_history_tweet_ids', 'entities', 'geo', 'id', 'in_reply_to_user_id', 'lang', 'non_public_metrics', 'note_tweet', 'organic_metrics', 'possibly_sensitive', 'promoted_metrics', 'public_metrics', 'referenced_tweets', 'reply_settings', 'scopes', 'source', 'text', 'username', 'withheld']".
177
-
175
+
178
176
  Returns:
179
177
  dict[str, Any]: The request has succeeded.
180
-
178
+
181
179
  Raises:
182
180
  HTTPError: Raised when the API request fails (e.g., non-2XX status code).
183
181
  JSONDecodeError: Raised if the response body cannot be parsed as JSON.
184
-
182
+
185
183
  Tags:
186
184
  Users
187
185
  """
@@ -214,7 +212,7 @@ class ListsApi(APISegmentBase):
214
212
  ) -> dict[str, Any]:
215
213
  """
216
214
  Retrieves users who are members of a specific Twitter list, identified by its ID. Unlike `list_get_followers`, this returns users explicitly added to the list, not subscribers. Supports pagination and customization of the returned user data fields to include expanded objects and specific details.
217
-
215
+
218
216
  Args:
219
217
  id (string): id
220
218
  max_results (integer): The maximum number of list members to return per page, defaulting to 100.
@@ -222,14 +220,14 @@ class ListsApi(APISegmentBase):
222
220
  user_fields (array): A comma separated list of User fields to display. Example: "['affiliation', 'connection_status', 'created_at', 'description', 'entities', 'id', 'location', 'most_recent_tweet_id', 'name', 'pinned_tweet_id', 'profile_banner_url', 'profile_image_url', 'protected', 'public_metrics', 'receives_your_dm', 'subscription_type', 'url', 'username', 'verified', 'verified_type', 'withheld']".
223
221
  expansions (array): A comma separated list of fields to expand. Example: "['affiliation.user_id', 'most_recent_tweet_id', 'pinned_tweet_id']".
224
222
  tweet_fields (array): A comma separated list of Tweet fields to display. Example: "['article', 'attachments', 'author_id', 'card_uri', 'context_annotations', 'conversation_id', 'created_at', 'edit_controls', 'edit_history_tweet_ids', 'entities', 'geo', 'id', 'in_reply_to_user_id', 'lang', 'non_public_metrics', 'note_tweet', 'organic_metrics', 'possibly_sensitive', 'promoted_metrics', 'public_metrics', 'referenced_tweets', 'reply_settings', 'scopes', 'source', 'text', 'username', 'withheld']".
225
-
223
+
226
224
  Returns:
227
225
  dict[str, Any]: The request has succeeded.
228
-
226
+
229
227
  Raises:
230
228
  HTTPError: Raised when the API request fails (e.g., non-2XX status code).
231
229
  JSONDecodeError: Raised if the response body cannot be parsed as JSON.
232
-
230
+
233
231
  Tags:
234
232
  Users
235
233
  """
@@ -254,18 +252,18 @@ class ListsApi(APISegmentBase):
254
252
  def list_add_member(self, id, user_id=None) -> dict[str, Any]:
255
253
  """
256
254
  Adds a user to a specified Twitter list via a POST request to the `/2/lists/{id}/members` endpoint, requiring list and user IDs. This function modifies a list's membership, distinguishing it from `list_get_members` (retrieves) and its counterpart `list_remove_member` (deletes).
257
-
255
+
258
256
  Args:
259
257
  id (string): id
260
258
  user_id (string): Unique identifier of this User. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers. Example: '2244994945'.
261
-
259
+
262
260
  Returns:
263
261
  dict[str, Any]: The request has succeeded.
264
-
262
+
265
263
  Raises:
266
264
  HTTPError: Raised when the API request fails (e.g., non-2XX status code).
267
265
  JSONDecodeError: Raised if the response body cannot be parsed as JSON.
268
-
266
+
269
267
  Tags:
270
268
  Lists
271
269
  """
@@ -290,18 +288,18 @@ class ListsApi(APISegmentBase):
290
288
  def delete_list_member(self, id, user_id) -> dict[str, Any]:
291
289
  """
292
290
  Removes a specific user from a Twitter list. This function sends a DELETE request to the `/2/lists/{id}/members/{user_id}` API endpoint, requiring both the list ID and the user ID to perform the action and confirm the member's removal.
293
-
291
+
294
292
  Args:
295
293
  id (string): id
296
294
  user_id (string): user_id
297
-
295
+
298
296
  Returns:
299
297
  dict[str, Any]: The request has succeeded.
300
-
298
+
301
299
  Raises:
302
300
  HTTPError: Raised when the API request fails (e.g., non-2XX status code).
303
301
  JSONDecodeError: Raised if the response body cannot be parsed as JSON.
304
-
302
+
305
303
  Tags:
306
304
  Lists
307
305
  """
@@ -329,7 +327,7 @@ class ListsApi(APISegmentBase):
329
327
  ) -> dict[str, Any]:
330
328
  """
331
329
  Retrieves tweets from a specified Twitter List using its ID. Supports pagination and allows extensive customization of returned fields for tweets, users, media, and other entities. This function uniquely fetches the list's tweet timeline, distinguishing it from functions that retrieve list members or followers.
332
-
330
+
333
331
  Args:
334
332
  id (string): id
335
333
  max_results (integer): The maximum number of tweets to return per request, with a default value of 100.
@@ -340,14 +338,14 @@ class ListsApi(APISegmentBase):
340
338
  poll_fields (array): A comma separated list of Poll fields to display. Example: "['duration_minutes', 'end_datetime', 'id', 'options', 'voting_status']".
341
339
  user_fields (array): A comma separated list of User fields to display. Example: "['affiliation', 'connection_status', 'created_at', 'description', 'entities', 'id', 'location', 'most_recent_tweet_id', 'name', 'pinned_tweet_id', 'profile_banner_url', 'profile_image_url', 'protected', 'public_metrics', 'receives_your_dm', 'subscription_type', 'url', 'username', 'verified', 'verified_type', 'withheld']".
342
340
  place_fields (array): A comma separated list of Place fields to display. Example: "['contained_within', 'country', 'country_code', 'full_name', 'geo', 'id', 'name', 'place_type']".
343
-
341
+
344
342
  Returns:
345
343
  dict[str, Any]: The request has succeeded.
346
-
344
+
347
345
  Raises:
348
346
  HTTPError: Raised when the API request fails (e.g., non-2XX status code).
349
347
  JSONDecodeError: Raised if the response body cannot be parsed as JSON.
350
-
348
+
351
349
  Tags:
352
350
  Tweets
353
351
  """
@@ -17,21 +17,21 @@ class SpacesApi(APISegmentBase):
17
17
  ) -> dict[str, Any]:
18
18
  """
19
19
  Retrieves detailed information for a batch of spaces, specified by a list of their unique IDs. Optional parameters allow for customizing the response by including specific fields and expansions. This method is distinct from `find_space_by_id`, which fetches only a single space per call.
20
-
20
+
21
21
  Args:
22
22
  ids (array): Required array of IDs for the requested spaces.
23
23
  space_fields (array): A comma separated list of Space fields to display. Example: "['created_at', 'creator_id', 'ended_at', 'host_ids', 'id', 'invited_user_ids', 'is_ticketed', 'lang', 'participant_count', 'scheduled_start', 'speaker_ids', 'started_at', 'state', 'subscriber_count', 'title', 'topic_ids', 'updated_at']".
24
24
  expansions (array): A comma separated list of fields to expand. Example: "['creator_id', 'host_ids', 'invited_user_ids', 'speaker_ids', 'topic_ids']".
25
25
  user_fields (array): A comma separated list of User fields to display. Example: "['affiliation', 'connection_status', 'created_at', 'description', 'entities', 'id', 'location', 'most_recent_tweet_id', 'name', 'pinned_tweet_id', 'profile_banner_url', 'profile_image_url', 'protected', 'public_metrics', 'receives_your_dm', 'subscription_type', 'url', 'username', 'verified', 'verified_type', 'withheld']".
26
26
  topic_fields (array): A comma separated list of Topic fields to display. Example: "['description', 'id', 'name']".
27
-
27
+
28
28
  Returns:
29
29
  dict[str, Any]: The request has succeeded.
30
-
30
+
31
31
  Raises:
32
32
  HTTPError: Raised when the API request fails (e.g., non-2XX status code).
33
33
  JSONDecodeError: Raised if the response body cannot be parsed as JSON.
34
-
34
+
35
35
  Tags:
36
36
  Spaces
37
37
  """
@@ -61,21 +61,21 @@ class SpacesApi(APISegmentBase):
61
61
  ) -> dict[str, Any]:
62
62
  """
63
63
  Fetches a list of spaces created by specified users, identified by their user IDs. This function is distinct from `find_spaces_by_ids`, which retrieves spaces by their own unique IDs. Optional parameters allow for customizing the fields returned for spaces, users, and topics.
64
-
64
+
65
65
  Args:
66
66
  user_ids (array): **user_ids**: Required array of user IDs for filtering spaces by their creators.
67
67
  space_fields (array): A comma separated list of Space fields to display. Example: "['created_at', 'creator_id', 'ended_at', 'host_ids', 'id', 'invited_user_ids', 'is_ticketed', 'lang', 'participant_count', 'scheduled_start', 'speaker_ids', 'started_at', 'state', 'subscriber_count', 'title', 'topic_ids', 'updated_at']".
68
68
  expansions (array): A comma separated list of fields to expand. Example: "['creator_id', 'host_ids', 'invited_user_ids', 'speaker_ids', 'topic_ids']".
69
69
  user_fields (array): A comma separated list of User fields to display. Example: "['affiliation', 'connection_status', 'created_at', 'description', 'entities', 'id', 'location', 'most_recent_tweet_id', 'name', 'pinned_tweet_id', 'profile_banner_url', 'profile_image_url', 'protected', 'public_metrics', 'receives_your_dm', 'subscription_type', 'url', 'username', 'verified', 'verified_type', 'withheld']".
70
70
  topic_fields (array): A comma separated list of Topic fields to display. Example: "['description', 'id', 'name']".
71
-
71
+
72
72
  Returns:
73
73
  dict[str, Any]: The request has succeeded.
74
-
74
+
75
75
  Raises:
76
76
  HTTPError: Raised when the API request fails (e.g., non-2XX status code).
77
77
  JSONDecodeError: Raised if the response body cannot be parsed as JSON.
78
-
78
+
79
79
  Tags:
80
80
  Spaces
81
81
  """
@@ -107,7 +107,7 @@ class SpacesApi(APISegmentBase):
107
107
  ) -> dict[str, Any]:
108
108
  """
109
109
  Performs a keyword-based search for Twitter Spaces, allowing filters by state (e.g., 'live', 'scheduled'). The function supports customizing the response data by specifying fields for spaces, users, and topics, distinguishing it from methods that find spaces by specific IDs.
110
-
110
+
111
111
  Args:
112
112
  query (string): The "query" parameter is a required string input for the GET operation at path "/2/spaces/search", used to specify search terms for finding spaces. Example: 'crypto'.
113
113
  state (string): Optional query parameter to filter search results by space state, which can be "live," "scheduled," or "all" (default).
@@ -116,14 +116,14 @@ class SpacesApi(APISegmentBase):
116
116
  expansions (array): A comma separated list of fields to expand. Example: "['creator_id', 'host_ids', 'invited_user_ids', 'speaker_ids', 'topic_ids']".
117
117
  user_fields (array): A comma separated list of User fields to display. Example: "['affiliation', 'connection_status', 'created_at', 'description', 'entities', 'id', 'location', 'most_recent_tweet_id', 'name', 'pinned_tweet_id', 'profile_banner_url', 'profile_image_url', 'protected', 'public_metrics', 'receives_your_dm', 'subscription_type', 'url', 'username', 'verified', 'verified_type', 'withheld']".
118
118
  topic_fields (array): A comma separated list of Topic fields to display. Example: "['description', 'id', 'name']".
119
-
119
+
120
120
  Returns:
121
121
  dict[str, Any]: The request has succeeded.
122
-
122
+
123
123
  Raises:
124
124
  HTTPError: Raised when the API request fails (e.g., non-2XX status code).
125
125
  JSONDecodeError: Raised if the response body cannot be parsed as JSON.
126
-
126
+
127
127
  Tags:
128
128
  Spaces
129
129
  """
@@ -155,21 +155,21 @@ class SpacesApi(APISegmentBase):
155
155
  ) -> dict[str, Any]:
156
156
  """
157
157
  Retrieves detailed information for a single space using its unique ID. Optional parameters allow customizing the response by specifying fields and expansions. Unlike `find_spaces_by_ids`, which fetches multiple spaces, this function targets only one specific space.
158
-
158
+
159
159
  Args:
160
160
  id (string): id
161
161
  space_fields (array): A comma separated list of Space fields to display. Example: "['created_at', 'creator_id', 'ended_at', 'host_ids', 'id', 'invited_user_ids', 'is_ticketed', 'lang', 'participant_count', 'scheduled_start', 'speaker_ids', 'started_at', 'state', 'subscriber_count', 'title', 'topic_ids', 'updated_at']".
162
162
  expansions (array): A comma separated list of fields to expand. Example: "['creator_id', 'host_ids', 'invited_user_ids', 'speaker_ids', 'topic_ids']".
163
163
  user_fields (array): A comma separated list of User fields to display. Example: "['affiliation', 'connection_status', 'created_at', 'description', 'entities', 'id', 'location', 'most_recent_tweet_id', 'name', 'pinned_tweet_id', 'profile_banner_url', 'profile_image_url', 'protected', 'public_metrics', 'receives_your_dm', 'subscription_type', 'url', 'username', 'verified', 'verified_type', 'withheld']".
164
164
  topic_fields (array): A comma separated list of Topic fields to display. Example: "['description', 'id', 'name']".
165
-
165
+
166
166
  Returns:
167
167
  dict[str, Any]: The request has succeeded.
168
-
168
+
169
169
  Raises:
170
170
  HTTPError: Raised when the API request fails (e.g., non-2XX status code).
171
171
  JSONDecodeError: Raised if the response body cannot be parsed as JSON.
172
-
172
+
173
173
  Tags:
174
174
  Spaces
175
175
  """
@@ -201,7 +201,7 @@ class SpacesApi(APISegmentBase):
201
201
  ) -> dict[str, Any]:
202
202
  """
203
203
  Retrieves a list of users who have purchased tickets for a specific ticketed Space, identified by its ID. This function supports pagination and allows for the customization of user and tweet fields in the API response.
204
-
204
+
205
205
  Args:
206
206
  id (string): id
207
207
  pagination_token (string): Optional token used for pagination to retrieve the next set of results in a sequence.
@@ -209,14 +209,14 @@ class SpacesApi(APISegmentBase):
209
209
  user_fields (array): A comma separated list of User fields to display. Example: "['affiliation', 'connection_status', 'created_at', 'description', 'entities', 'id', 'location', 'most_recent_tweet_id', 'name', 'pinned_tweet_id', 'profile_banner_url', 'profile_image_url', 'protected', 'public_metrics', 'receives_your_dm', 'subscription_type', 'url', 'username', 'verified', 'verified_type', 'withheld']".
210
210
  expansions (array): A comma separated list of fields to expand. Example: "['affiliation.user_id', 'most_recent_tweet_id', 'pinned_tweet_id']".
211
211
  tweet_fields (array): A comma separated list of Tweet fields to display. Example: "['article', 'attachments', 'author_id', 'card_uri', 'context_annotations', 'conversation_id', 'created_at', 'edit_controls', 'edit_history_tweet_ids', 'entities', 'geo', 'id', 'in_reply_to_user_id', 'lang', 'non_public_metrics', 'note_tweet', 'organic_metrics', 'possibly_sensitive', 'promoted_metrics', 'public_metrics', 'referenced_tweets', 'reply_settings', 'scopes', 'source', 'text', 'username', 'withheld']".
212
-
212
+
213
213
  Returns:
214
214
  dict[str, Any]: The request has succeeded.
215
-
215
+
216
216
  Raises:
217
217
  HTTPError: Raised when the API request fails (e.g., non-2XX status code).
218
218
  JSONDecodeError: Raised if the response body cannot be parsed as JSON.
219
-
219
+
220
220
  Tags:
221
221
  Spaces, Tweets
222
222
  """
@@ -251,7 +251,7 @@ class SpacesApi(APISegmentBase):
251
251
  ) -> dict[str, Any]:
252
252
  """
253
253
  Fetches tweets from a specific Space using its ID. Allows extensive customization of returned data fields (e.g., media, user) and limits results. Unlike `space_buyers`, which retrieves users who purchased tickets, this function returns the actual tweets shared within the Space.
254
-
254
+
255
255
  Args:
256
256
  id (string): id
257
257
  max_results (integer): The `max_results` parameter limits the number of tweets returned in the response for the GET operation at "/2/spaces/{id}/tweets", with a default of 100. Example: '25'.
@@ -261,14 +261,14 @@ class SpacesApi(APISegmentBase):
261
261
  poll_fields (array): A comma separated list of Poll fields to display. Example: "['duration_minutes', 'end_datetime', 'id', 'options', 'voting_status']".
262
262
  user_fields (array): A comma separated list of User fields to display. Example: "['affiliation', 'connection_status', 'created_at', 'description', 'entities', 'id', 'location', 'most_recent_tweet_id', 'name', 'pinned_tweet_id', 'profile_banner_url', 'profile_image_url', 'protected', 'public_metrics', 'receives_your_dm', 'subscription_type', 'url', 'username', 'verified', 'verified_type', 'withheld']".
263
263
  place_fields (array): A comma separated list of Place fields to display. Example: "['contained_within', 'country', 'country_code', 'full_name', 'geo', 'id', 'name', 'place_type']".
264
-
264
+
265
265
  Returns:
266
266
  dict[str, Any]: The request has succeeded.
267
-
267
+
268
268
  Raises:
269
269
  HTTPError: Raised when the API request fails (e.g., non-2XX status code).
270
270
  JSONDecodeError: Raised if the response body cannot be parsed as JSON.
271
-
271
+
272
272
  Tags:
273
273
  Spaces, Tweets
274
274
  """
@@ -10,18 +10,18 @@ class TrendsApi(APISegmentBase):
10
10
  def get_trends_by_woeid(self, woeid, trend_fields=None) -> dict[str, Any]:
11
11
  """
12
12
  Fetches trending topics for a specific location identified by its Where On Earth ID (WOEID). It builds and executes an authenticated API request, optionally allowing users to specify which trend-related fields (e.g., 'tweet_count') to include in the returned JSON response.
13
-
13
+
14
14
  Args:
15
15
  woeid (string): woeid
16
16
  trend_fields (array): A comma separated list of Trend fields to display. Example: "['trend_name', 'tweet_count']".
17
-
17
+
18
18
  Returns:
19
19
  dict[str, Any]: The request has succeeded.
20
-
20
+
21
21
  Raises:
22
22
  HTTPError: Raised when the API request fails (e.g., non-2XX status code).
23
23
  JSONDecodeError: Raised if the response body cannot be parsed as JSON.
24
-
24
+
25
25
  Tags:
26
26
  Trends
27
27
  """