universal-mcp-applications 0.1.20__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.
- universal_mcp/applications/BEST_PRACTICES.md +166 -0
- universal_mcp/applications/airtable/app.py +0 -1
- universal_mcp/applications/apollo/app.py +0 -1
- universal_mcp/applications/aws_s3/app.py +40 -39
- universal_mcp/applications/browser_use/README.md +1 -0
- universal_mcp/applications/browser_use/__init__.py +0 -0
- universal_mcp/applications/browser_use/app.py +76 -0
- universal_mcp/applications/calendly/app.py +125 -125
- universal_mcp/applications/canva/app.py +95 -99
- universal_mcp/applications/confluence/app.py +0 -1
- universal_mcp/applications/contentful/app.py +4 -5
- universal_mcp/applications/domain_checker/app.py +11 -15
- universal_mcp/applications/e2b/app.py +4 -4
- universal_mcp/applications/elevenlabs/app.py +18 -15
- universal_mcp/applications/exa/app.py +17 -17
- universal_mcp/applications/falai/app.py +28 -29
- universal_mcp/applications/file_system/app.py +9 -9
- universal_mcp/applications/firecrawl/app.py +36 -36
- universal_mcp/applications/fireflies/app.py +55 -56
- universal_mcp/applications/fpl/app.py +49 -50
- universal_mcp/applications/ghost_content/app.py +0 -1
- universal_mcp/applications/github/app.py +41 -43
- universal_mcp/applications/google_calendar/app.py +40 -39
- universal_mcp/applications/google_docs/app.py +56 -56
- universal_mcp/applications/google_drive/app.py +212 -215
- universal_mcp/applications/google_gemini/app.py +1 -5
- universal_mcp/applications/google_mail/app.py +91 -90
- universal_mcp/applications/google_searchconsole/app.py +29 -29
- universal_mcp/applications/google_sheet/app.py +115 -115
- universal_mcp/applications/hashnode/README.md +6 -3
- universal_mcp/applications/hashnode/app.py +174 -25
- universal_mcp/applications/http_tools/app.py +10 -11
- universal_mcp/applications/hubspot/__init__.py +1 -1
- universal_mcp/applications/hubspot/api_segments/api_segment_base.py +36 -7
- universal_mcp/applications/hubspot/api_segments/crm_api.py +368 -368
- universal_mcp/applications/hubspot/api_segments/marketing_api.py +115 -115
- universal_mcp/applications/hubspot/app.py +131 -72
- universal_mcp/applications/jira/app.py +0 -1
- universal_mcp/applications/linkedin/app.py +20 -20
- universal_mcp/applications/markitdown/app.py +10 -5
- universal_mcp/applications/ms_teams/app.py +123 -123
- universal_mcp/applications/openai/app.py +40 -39
- universal_mcp/applications/outlook/app.py +32 -32
- universal_mcp/applications/perplexity/app.py +4 -4
- universal_mcp/applications/reddit/app.py +69 -70
- universal_mcp/applications/resend/app.py +116 -117
- universal_mcp/applications/rocketlane/app.py +0 -1
- universal_mcp/applications/scraper/__init__.py +1 -1
- universal_mcp/applications/scraper/app.py +234 -16
- universal_mcp/applications/serpapi/app.py +14 -14
- universal_mcp/applications/sharepoint/app.py +19 -20
- universal_mcp/applications/shopify/app.py +0 -1
- universal_mcp/applications/slack/app.py +48 -48
- universal_mcp/applications/tavily/app.py +4 -4
- universal_mcp/applications/twitter/api_segments/compliance_api.py +13 -15
- universal_mcp/applications/twitter/api_segments/dm_conversations_api.py +20 -20
- universal_mcp/applications/twitter/api_segments/dm_events_api.py +12 -12
- universal_mcp/applications/twitter/api_segments/likes_api.py +12 -12
- universal_mcp/applications/twitter/api_segments/lists_api.py +37 -39
- universal_mcp/applications/twitter/api_segments/spaces_api.py +24 -24
- universal_mcp/applications/twitter/api_segments/trends_api.py +4 -4
- universal_mcp/applications/twitter/api_segments/tweets_api.py +105 -105
- universal_mcp/applications/twitter/api_segments/usage_api.py +4 -4
- universal_mcp/applications/twitter/api_segments/users_api.py +136 -136
- universal_mcp/applications/twitter/app.py +6 -2
- universal_mcp/applications/unipile/app.py +321 -71
- universal_mcp/applications/whatsapp/app.py +53 -54
- universal_mcp/applications/whatsapp/audio.py +39 -35
- universal_mcp/applications/whatsapp/whatsapp.py +176 -154
- universal_mcp/applications/whatsapp_business/app.py +92 -92
- universal_mcp/applications/yahoo_finance/app.py +105 -63
- universal_mcp/applications/youtube/app.py +206 -199
- universal_mcp/applications/zenquotes/__init__.py +2 -0
- universal_mcp/applications/zenquotes/app.py +3 -3
- {universal_mcp_applications-0.1.20.dist-info → universal_mcp_applications-0.1.22.dist-info}/METADATA +2 -1
- {universal_mcp_applications-0.1.20.dist-info → universal_mcp_applications-0.1.22.dist-info}/RECORD +78 -74
- {universal_mcp_applications-0.1.20.dist-info → universal_mcp_applications-0.1.22.dist-info}/WHEEL +0 -0
- {universal_mcp_applications-0.1.20.dist-info → universal_mcp_applications-0.1.22.dist-info}/licenses/LICENSE +0 -0
|
@@ -2,7 +2,6 @@ from datetime import UTC, datetime, timedelta
|
|
|
2
2
|
from typing import Any
|
|
3
3
|
|
|
4
4
|
from loguru import logger
|
|
5
|
-
|
|
6
5
|
from universal_mcp.applications.application import APIApplication
|
|
7
6
|
from universal_mcp.integrations import Integration
|
|
8
7
|
|
|
@@ -55,18 +54,18 @@ class GoogleCalendarApp(APIApplication):
|
|
|
55
54
|
) -> dict[str, Any]:
|
|
56
55
|
"""
|
|
57
56
|
Retrieves events for a specified number of days, starting from today. This function simplifies date-range queries by auto-calculating start/end times, unlike the more comprehensive `list_events` function, which offers granular control with explicit time filters, text search, and custom sorting.
|
|
58
|
-
|
|
57
|
+
|
|
59
58
|
Args:
|
|
60
59
|
days: Number of days to retrieve events for (default: 1, which is just today)
|
|
61
60
|
max_results: Maximum number of events to return (optional)
|
|
62
61
|
time_zone: Time zone used in the response (optional, default is calendar's time zone)
|
|
63
|
-
|
|
62
|
+
|
|
64
63
|
Returns:
|
|
65
64
|
Dictionary containing the complete API response with all events and metadata
|
|
66
|
-
|
|
65
|
+
|
|
67
66
|
Raises:
|
|
68
67
|
HTTPError: Raised when the API request fails or returns an error status code
|
|
69
|
-
|
|
68
|
+
|
|
70
69
|
Tags:
|
|
71
70
|
fetch, list, calendar, events, date-time, important, api
|
|
72
71
|
"""
|
|
@@ -99,19 +98,19 @@ class GoogleCalendarApp(APIApplication):
|
|
|
99
98
|
) -> dict[str, Any]:
|
|
100
99
|
"""
|
|
101
100
|
Retrieves a specific calendar event using its unique ID. Unlike `list_events`, which fetches multiple events based on date ranges or search queries, this function targets a single, known event. It can optionally limit attendees returned and specify a time zone for date formatting in the response.
|
|
102
|
-
|
|
101
|
+
|
|
103
102
|
Args:
|
|
104
103
|
event_id: The unique identifier of the calendar event to retrieve
|
|
105
104
|
max_attendees: Optional. The maximum number of attendees to include in the response. If None, includes all attendees
|
|
106
105
|
time_zone: Optional. The time zone to use for formatting dates in the response. If None, uses the calendar's default time zone
|
|
107
|
-
|
|
106
|
+
|
|
108
107
|
Returns:
|
|
109
108
|
Dictionary containing the complete API response with all event details
|
|
110
|
-
|
|
109
|
+
|
|
111
110
|
Raises:
|
|
112
111
|
HTTPError: Raised when the API request fails or returns an error status code
|
|
113
112
|
JSONDecodeError: Raised when the API response cannot be parsed as JSON
|
|
114
|
-
|
|
113
|
+
|
|
115
114
|
Tags:
|
|
116
115
|
retrieve, calendar, event, api, important
|
|
117
116
|
"""
|
|
@@ -138,7 +137,7 @@ class GoogleCalendarApp(APIApplication):
|
|
|
138
137
|
) -> dict[str, Any]:
|
|
139
138
|
"""
|
|
140
139
|
Fetches a customizable list of events using filters for date range, text search, sorting, and pagination. This advanced function provides more granular control than `get_upcoming_events`, which is limited to fetching events for a specific number of upcoming days.
|
|
141
|
-
|
|
140
|
+
|
|
142
141
|
Args:
|
|
143
142
|
max_results: Maximum number of events to return (default: 10, max: 2500)
|
|
144
143
|
time_min: Start time in ISO format (e.g., '2023-12-01T00:00:00Z'). Defaults to current time if not specified
|
|
@@ -148,14 +147,14 @@ class GoogleCalendarApp(APIApplication):
|
|
|
148
147
|
single_events: Whether to expand recurring events into individual instances (default: True)
|
|
149
148
|
time_zone: Time zone for response formatting (defaults to calendar's time zone)
|
|
150
149
|
page_token: Token for retrieving a specific page of results in paginated responses
|
|
151
|
-
|
|
150
|
+
|
|
152
151
|
Returns:
|
|
153
152
|
Dictionary containing the complete API response with all events and metadata
|
|
154
|
-
|
|
153
|
+
|
|
155
154
|
Raises:
|
|
156
155
|
HTTPError: Raised when the API request fails or returns an error status code
|
|
157
156
|
JSONDecodeError: Raised when the API response cannot be parsed as JSON
|
|
158
|
-
|
|
157
|
+
|
|
159
158
|
Tags:
|
|
160
159
|
list, retrieve, calendar, events, pagination, api, important
|
|
161
160
|
"""
|
|
@@ -197,7 +196,7 @@ class GoogleCalendarApp(APIApplication):
|
|
|
197
196
|
) -> dict[str, Any]:
|
|
198
197
|
"""
|
|
199
198
|
Creates a calendar event using structured data for start/end times, summary, attendees, and recurrence. This method provides precise control for complex appointments, unlike `create_event_from_text` which parses natural language, making it ideal for detailed or recurring event creation.
|
|
200
|
-
|
|
199
|
+
|
|
201
200
|
Args:
|
|
202
201
|
start: Start time of the event (required). Must include timezone offset or timeZone field.
|
|
203
202
|
Examples:
|
|
@@ -222,13 +221,13 @@ class GoogleCalendarApp(APIApplication):
|
|
|
222
221
|
"RRULE:FREQ=DAILY;UNTIL=20150628;INTERVAL=3"
|
|
223
222
|
],
|
|
224
223
|
calendar_id: Calendar identifier (default: "primary")
|
|
225
|
-
|
|
224
|
+
|
|
226
225
|
Returns:
|
|
227
226
|
Dictionary containing the complete API response with the created event details
|
|
228
|
-
|
|
227
|
+
|
|
229
228
|
Raises:
|
|
230
229
|
HTTPError: Raised when the API request fails or returns an error status code
|
|
231
|
-
|
|
230
|
+
|
|
232
231
|
Tags:
|
|
233
232
|
create, calendar, event, insert, recurring, important
|
|
234
233
|
"""
|
|
@@ -252,20 +251,22 @@ class GoogleCalendarApp(APIApplication):
|
|
|
252
251
|
|
|
253
252
|
return self._handle_response(response)
|
|
254
253
|
|
|
255
|
-
def create_event_from_text(
|
|
254
|
+
def create_event_from_text(
|
|
255
|
+
self, text: str, send_updates: str = "none"
|
|
256
|
+
) -> dict[str, Any]:
|
|
256
257
|
"""
|
|
257
258
|
Creates a calendar event by parsing a natural language string (e.g., "Meeting tomorrow at 10am"). This offers a user-friendly shortcut, contrasting with the structured `create_event` function which requires explicit fields like start and end times.
|
|
258
|
-
|
|
259
|
+
|
|
259
260
|
Args:
|
|
260
261
|
text: Natural language text describing the event (e.g., 'Meeting with John at Coffee Shop tomorrow 3pm-4pm')
|
|
261
262
|
send_updates: Specifies who should receive event notifications: 'all', 'externalOnly', or 'none' (default)
|
|
262
|
-
|
|
263
|
+
|
|
263
264
|
Returns:
|
|
264
265
|
Dictionary containing the complete API response with the created event details
|
|
265
|
-
|
|
266
|
+
|
|
266
267
|
Raises:
|
|
267
268
|
HTTPError: Raised when the API request fails or returns an error status code
|
|
268
|
-
|
|
269
|
+
|
|
269
270
|
Tags:
|
|
270
271
|
create, calendar, event, quick-add, natural-language, important
|
|
271
272
|
"""
|
|
@@ -288,7 +289,7 @@ class GoogleCalendarApp(APIApplication):
|
|
|
288
289
|
) -> dict[str, Any]:
|
|
289
290
|
"""
|
|
290
291
|
Retrieves all individual occurrences of a specific recurring event using its ID. Unlike `list_events`, which fetches multiple distinct events, this function expands a single recurring event into its separate instances, allowing filtering by time range and pagination for detailed scheduling views.
|
|
291
|
-
|
|
292
|
+
|
|
292
293
|
Args:
|
|
293
294
|
event_id: ID of the recurring event
|
|
294
295
|
max_results: Maximum number of event instances to return (default: 25, max: 2500)
|
|
@@ -297,14 +298,14 @@ class GoogleCalendarApp(APIApplication):
|
|
|
297
298
|
time_zone: Time zone used in the response (defaults to calendar's time zone)
|
|
298
299
|
show_deleted: Whether to include deleted instances (default: False)
|
|
299
300
|
page_token: Token for retrieving a specific page of results
|
|
300
|
-
|
|
301
|
+
|
|
301
302
|
Returns:
|
|
302
303
|
Dictionary containing the complete API response with all event instances and metadata
|
|
303
|
-
|
|
304
|
+
|
|
304
305
|
Raises:
|
|
305
306
|
HTTPError: Raised when the API request fails or returns an error status code
|
|
306
307
|
JSONDecodeError: Raised when the API response cannot be parsed as JSON
|
|
307
|
-
|
|
308
|
+
|
|
308
309
|
Tags:
|
|
309
310
|
list, retrieve, calendar, events, recurring, pagination, api, important
|
|
310
311
|
"""
|
|
@@ -342,7 +343,7 @@ class GoogleCalendarApp(APIApplication):
|
|
|
342
343
|
) -> Any:
|
|
343
344
|
"""
|
|
344
345
|
Permanently deletes a specific event from a Google Calendar using its event and calendar IDs. It can optionally send cancellation notifications to attendees, distinguishing it from functions that retrieve (`get_event_by_id`) or modify events (`replace_event`), which do not remove entries from the calendar.
|
|
345
|
-
|
|
346
|
+
|
|
346
347
|
Args:
|
|
347
348
|
calendarId (string): calendarId
|
|
348
349
|
eventId (string): eventId
|
|
@@ -355,10 +356,10 @@ class GoogleCalendarApp(APIApplication):
|
|
|
355
356
|
prettyPrint (string): Returns response with indentations and line breaks. Example: 'true'.
|
|
356
357
|
quotaUser (string): An opaque string that represents a user for quota purposes. Must not exceed 40 characters. Example: 'amet in'.
|
|
357
358
|
userIp (string): Deprecated. Please use quotaUser instead. Example: 'amet in'.
|
|
358
|
-
|
|
359
|
+
|
|
359
360
|
Returns:
|
|
360
361
|
Any: No Content
|
|
361
|
-
|
|
362
|
+
|
|
362
363
|
Tags:
|
|
363
364
|
calendars, {calendarId}, events, {eventId}
|
|
364
365
|
"""
|
|
@@ -401,7 +402,7 @@ class GoogleCalendarApp(APIApplication):
|
|
|
401
402
|
) -> dict[str, Any]:
|
|
402
403
|
"""
|
|
403
404
|
Replaces an existing calendar event, identified by its ID, with new data. This function performs a full update, overwriting all event properties like start/end times and summary. It does not support partial modifications, requiring all necessary fields for the replacement to be provided.
|
|
404
|
-
|
|
405
|
+
|
|
405
406
|
Args:
|
|
406
407
|
event_id: The unique identifier of the calendar event to update (required)
|
|
407
408
|
start: Start time of the event (required). Must include timezone offset or timeZone field.
|
|
@@ -423,13 +424,13 @@ class GoogleCalendarApp(APIApplication):
|
|
|
423
424
|
calendar_id: Calendar identifier (default: "primary")
|
|
424
425
|
send_updates: Specifies who should receive event notifications: 'all', 'externalOnly', or 'none' (default)
|
|
425
426
|
max_attendees: Maximum number of attendees to include in the response (optional)
|
|
426
|
-
|
|
427
|
+
|
|
427
428
|
Returns:
|
|
428
429
|
Dictionary containing the complete API response with the updated event details
|
|
429
|
-
|
|
430
|
+
|
|
430
431
|
Raises:
|
|
431
432
|
HTTPError: Raised when the API request fails or returns an error status code
|
|
432
|
-
|
|
433
|
+
|
|
433
434
|
Tags:
|
|
434
435
|
update, calendar, event, modify, important
|
|
435
436
|
"""
|
|
@@ -459,13 +460,13 @@ class GoogleCalendarApp(APIApplication):
|
|
|
459
460
|
def get_primary_calendar_details(self) -> dict[str, Any]:
|
|
460
461
|
"""
|
|
461
462
|
Retrieves metadata for the user's primary calendar, including its default timezone. This information is essential for creating new events with accurate, timezone-aware start and end times using other functions like `create_event`, preventing potential scheduling errors across different regions.
|
|
462
|
-
|
|
463
|
+
|
|
463
464
|
Returns:
|
|
464
465
|
Dictionary containing the user's timezone information
|
|
465
|
-
|
|
466
|
+
|
|
466
467
|
Raises:
|
|
467
468
|
HTTPError: Raised when the API request fails or returns an error status code
|
|
468
|
-
|
|
469
|
+
|
|
469
470
|
Tags:
|
|
470
471
|
get, calendar, timezone, settings, important
|
|
471
472
|
"""
|
|
@@ -492,8 +493,8 @@ class GoogleCalendarApp(APIApplication):
|
|
|
492
493
|
) -> dict[str, Any]:
|
|
493
494
|
"""
|
|
494
495
|
Queries the free/busy status for one or more calendars within a specified time range. It returns a list of busy time intervals, making it ideal for finding open slots and scheduling new events without conflicts.
|
|
495
|
-
|
|
496
|
-
|
|
496
|
+
|
|
497
|
+
|
|
497
498
|
Args:
|
|
498
499
|
alt (string): Data format for the response. Example: 'json'.
|
|
499
500
|
fields (string): Selector specifying which fields to include in a partial response. Example: 'amet in'.
|
|
@@ -526,7 +527,7 @@ class GoogleCalendarApp(APIApplication):
|
|
|
526
527
|
"timeZone": "UTC"
|
|
527
528
|
}
|
|
528
529
|
```
|
|
529
|
-
|
|
530
|
+
|
|
530
531
|
Returns:
|
|
531
532
|
dict[str, Any]: Successful response
|
|
532
533
|
"""
|
|
@@ -12,17 +12,17 @@ class GoogleDocsApp(APIApplication):
|
|
|
12
12
|
def create_document(self, title: str) -> dict[str, Any]:
|
|
13
13
|
"""
|
|
14
14
|
Creates a blank Google Document with a specified title using a POST request to the Google Docs API. This is the primary creation method, returning the document's metadata, including the ID required by functions like `get_document` or `insert_text` to perform subsequent operations on the new file.
|
|
15
|
-
|
|
15
|
+
|
|
16
16
|
Args:
|
|
17
17
|
title: The title for the new Google Document to be created
|
|
18
|
-
|
|
18
|
+
|
|
19
19
|
Returns:
|
|
20
20
|
A dictionary containing the Google Docs API response with document details and metadata
|
|
21
|
-
|
|
21
|
+
|
|
22
22
|
Raises:
|
|
23
23
|
HTTPError: If the API request fails due to network issues, authentication errors, or invalid parameters
|
|
24
24
|
RequestException: If there are connection errors or timeout issues during the API request
|
|
25
|
-
|
|
25
|
+
|
|
26
26
|
Tags:
|
|
27
27
|
create, document, api, important, google-docs, http
|
|
28
28
|
"""
|
|
@@ -35,17 +35,17 @@ class GoogleDocsApp(APIApplication):
|
|
|
35
35
|
def get_document(self, document_id: str) -> dict[str, Any]:
|
|
36
36
|
"""
|
|
37
37
|
Retrieves the complete content and metadata for a specific Google Document using its unique ID. This function performs a GET request to the API, returning the full JSON response. It's the primary read operation, contrasting with `create_document` which creates new documents.
|
|
38
|
-
|
|
38
|
+
|
|
39
39
|
Args:
|
|
40
40
|
document_id: The unique identifier of the document to retrieve
|
|
41
|
-
|
|
41
|
+
|
|
42
42
|
Returns:
|
|
43
43
|
A dictionary containing the document data from the Google Docs API response
|
|
44
|
-
|
|
44
|
+
|
|
45
45
|
Raises:
|
|
46
46
|
HTTPError: If the API request fails or the document is not found
|
|
47
47
|
JSONDecodeError: If the API response cannot be parsed as JSON
|
|
48
|
-
|
|
48
|
+
|
|
49
49
|
Tags:
|
|
50
50
|
retrieve, read, api, document, google-docs, important
|
|
51
51
|
"""
|
|
@@ -58,19 +58,19 @@ class GoogleDocsApp(APIApplication):
|
|
|
58
58
|
) -> dict[str, Any]:
|
|
59
59
|
"""
|
|
60
60
|
Inserts a text string at a specified index within an existing Google Document using the `batchUpdate` API. This function adds new textual content, distinguishing it from functions that insert non-text elements like tables or apply formatting (`apply_text_style`) to existing content.
|
|
61
|
-
|
|
61
|
+
|
|
62
62
|
Args:
|
|
63
63
|
document_id: The unique identifier of the Google Document to be updated
|
|
64
64
|
content: The text content to be inserted into the document
|
|
65
65
|
index: The zero-based position in the document where the text should be inserted (default: 1)
|
|
66
|
-
|
|
66
|
+
|
|
67
67
|
Returns:
|
|
68
68
|
A dictionary containing the Google Docs API response after performing the batch update operation
|
|
69
|
-
|
|
69
|
+
|
|
70
70
|
Raises:
|
|
71
71
|
HTTPError: When the API request fails, such as invalid document_id or insufficient permissions
|
|
72
72
|
RequestException: When there are network connectivity issues or API endpoint problems
|
|
73
|
-
|
|
73
|
+
|
|
74
74
|
Tags:
|
|
75
75
|
update, insert, document, api, google-docs, batch, content-management, important
|
|
76
76
|
"""
|
|
@@ -99,7 +99,7 @@ class GoogleDocsApp(APIApplication):
|
|
|
99
99
|
) -> dict[str, Any]:
|
|
100
100
|
"""
|
|
101
101
|
Applies character-level formatting such as bold, italic, font size, color, and hyperlinks to a specified text range in a document. This function modifies text appearance, distinguishing it from `update_paragraph_style`, which handles block-level formatting like alignment and headings.
|
|
102
|
-
|
|
102
|
+
|
|
103
103
|
Args:
|
|
104
104
|
document_id: The unique identifier of the Google Document to be updated
|
|
105
105
|
start_index: The zero-based start index of the text range to style
|
|
@@ -111,14 +111,14 @@ class GoogleDocsApp(APIApplication):
|
|
|
111
111
|
link_url: URL to make the text a hyperlink
|
|
112
112
|
foreground_color: RGB color dict with 'red', 'green', 'blue' values (0.0 to 1.0)
|
|
113
113
|
background_color: RGB color dict with 'red', 'green', 'blue' values (0.0 to 1.0)
|
|
114
|
-
|
|
114
|
+
|
|
115
115
|
Returns:
|
|
116
116
|
A dictionary containing the Google Docs API response
|
|
117
|
-
|
|
117
|
+
|
|
118
118
|
Raises:
|
|
119
119
|
HTTPError: When the API request fails
|
|
120
120
|
RequestException: When there are network connectivity issues
|
|
121
|
-
|
|
121
|
+
|
|
122
122
|
Tags:
|
|
123
123
|
style, format, text, document, api, google-docs, simple
|
|
124
124
|
"""
|
|
@@ -205,7 +205,7 @@ class GoogleDocsApp(APIApplication):
|
|
|
205
205
|
) -> dict[str, Any]:
|
|
206
206
|
"""
|
|
207
207
|
Applies paragraph-level formatting, such as named styles (e.g., 'HEADING_1'), alignment, or text direction, to a specified text range. This function handles block-level styles, distinguishing it from `apply_text_style`, which formats individual characters with attributes like bold or italic.
|
|
208
|
-
|
|
208
|
+
|
|
209
209
|
Args:
|
|
210
210
|
document_id: The unique identifier of the Google Document to be updated
|
|
211
211
|
start_index: The zero-based start index of the paragraph range to style
|
|
@@ -216,14 +216,14 @@ class GoogleDocsApp(APIApplication):
|
|
|
216
216
|
spacing_mode: The spacing mode ('NEVER_COLLAPSE', 'COLLAPSE_LISTS')
|
|
217
217
|
segment_id: The segment ID for the range (optional)
|
|
218
218
|
tab_id: The tab ID for the range (optional)
|
|
219
|
-
|
|
219
|
+
|
|
220
220
|
Returns:
|
|
221
221
|
A dictionary containing the Google Docs API response
|
|
222
|
-
|
|
222
|
+
|
|
223
223
|
Raises:
|
|
224
224
|
HTTPError: When the API request fails
|
|
225
225
|
RequestException: When there are network connectivity issues
|
|
226
|
-
|
|
226
|
+
|
|
227
227
|
Tags:
|
|
228
228
|
style, format, paragraph, document, api, google-docs, batch, content-management
|
|
229
229
|
"""
|
|
@@ -287,21 +287,21 @@ class GoogleDocsApp(APIApplication):
|
|
|
287
287
|
) -> dict[str, Any]:
|
|
288
288
|
"""
|
|
289
289
|
Deletes content within a specified index range in a Google Document via the batchUpdate API. It removes any content based on location, distinguishing it from functions like `delete_header` or `delete_paragraph_bullets`, which remove specific structures or styles instead.
|
|
290
|
-
|
|
290
|
+
|
|
291
291
|
Args:
|
|
292
292
|
document_id: The unique identifier of the Google Document to be updated
|
|
293
293
|
start_index: The zero-based start index of the content range to delete
|
|
294
294
|
end_index: The zero-based end index of the content range to delete (exclusive)
|
|
295
295
|
segment_id: The ID of the header, footer, or footnote segment (optional)
|
|
296
296
|
tab_id: The ID of the tab containing the content to delete (optional)
|
|
297
|
-
|
|
297
|
+
|
|
298
298
|
Returns:
|
|
299
299
|
A dictionary containing the Google Docs API response after performing the delete operation
|
|
300
|
-
|
|
300
|
+
|
|
301
301
|
Raises:
|
|
302
302
|
HTTPError: When the API request fails, such as invalid document_id or insufficient permissions
|
|
303
303
|
RequestException: When there are network connectivity issues or API endpoint problems
|
|
304
|
-
|
|
304
|
+
|
|
305
305
|
Tags:
|
|
306
306
|
delete, remove, content, document, api, google-docs, batch, content-management, important
|
|
307
307
|
"""
|
|
@@ -334,7 +334,7 @@ class GoogleDocsApp(APIApplication):
|
|
|
334
334
|
) -> dict[str, Any]:
|
|
335
335
|
"""
|
|
336
336
|
Inserts a table with specified row and column dimensions at a given index in a Google Document. This function uses the `batchUpdate` API for precise placement, allowing the table to be added to the document's body, a header, or a footer, returning the API's response.
|
|
337
|
-
|
|
337
|
+
|
|
338
338
|
Args:
|
|
339
339
|
document_id: The unique identifier of the Google Document to be updated
|
|
340
340
|
location_index: The zero-based index where the table should be inserted
|
|
@@ -342,14 +342,14 @@ class GoogleDocsApp(APIApplication):
|
|
|
342
342
|
columns: The number of columns in the table
|
|
343
343
|
segment_id: The ID of the header, footer or footnote segment (optional)
|
|
344
344
|
tab_id: The ID of the tab containing the location (optional)
|
|
345
|
-
|
|
345
|
+
|
|
346
346
|
Returns:
|
|
347
347
|
A dictionary containing the Google Docs API response after performing the insert table operation
|
|
348
|
-
|
|
348
|
+
|
|
349
349
|
Raises:
|
|
350
350
|
HTTPError: When the API request fails, such as invalid document_id or insufficient permissions
|
|
351
351
|
RequestException: When there are network connectivity issues or API endpoint problems
|
|
352
|
-
|
|
352
|
+
|
|
353
353
|
Tags:
|
|
354
354
|
table, insert, document, api, google-docs, batch, content-management
|
|
355
355
|
"""
|
|
@@ -391,21 +391,21 @@ class GoogleDocsApp(APIApplication):
|
|
|
391
391
|
) -> dict[str, Any]:
|
|
392
392
|
"""
|
|
393
393
|
Creates a footer of a specified type in a Google Document via the batch update API. The footer can optionally be associated with a specific section break, enabling distinct footers for different document sections, distinguishing it from the `create_header` and `create_footnote` functions.
|
|
394
|
-
|
|
394
|
+
|
|
395
395
|
Args:
|
|
396
396
|
document_id: The unique identifier of the Google Document to be updated
|
|
397
397
|
footer_type: The type of footer to create (DEFAULT, HEADER_FOOTER_TYPE_UNSPECIFIED)
|
|
398
398
|
section_break_location_index: The index of the SectionBreak location (optional)
|
|
399
399
|
section_break_segment_id: The segment ID of the SectionBreak location (optional)
|
|
400
400
|
section_break_tab_id: The tab ID of the SectionBreak location (optional)
|
|
401
|
-
|
|
401
|
+
|
|
402
402
|
Returns:
|
|
403
403
|
A dictionary containing the Google Docs API response after performing the create footer operation
|
|
404
|
-
|
|
404
|
+
|
|
405
405
|
Raises:
|
|
406
406
|
HTTPError: When the API request fails, such as invalid document_id or insufficient permissions
|
|
407
407
|
RequestException: When there are network connectivity issues or API endpoint problems
|
|
408
|
-
|
|
408
|
+
|
|
409
409
|
Tags:
|
|
410
410
|
footer, create, document, api, google-docs, batch, content-management
|
|
411
411
|
"""
|
|
@@ -443,7 +443,7 @@ class GoogleDocsApp(APIApplication):
|
|
|
443
443
|
) -> dict[str, Any]:
|
|
444
444
|
"""
|
|
445
445
|
Creates a footnote via the batch update API, inserting a numbered reference at a specified index or a segment's end. This function adds an in-body citation, distinguishing it from `create_footer` which creates a content block at the bottom of the page.
|
|
446
|
-
|
|
446
|
+
|
|
447
447
|
Args:
|
|
448
448
|
document_id: The unique identifier of the Google Document to be updated
|
|
449
449
|
location_index: The index where to insert the footnote reference (optional)
|
|
@@ -452,14 +452,14 @@ class GoogleDocsApp(APIApplication):
|
|
|
452
452
|
end_of_segment_location: Whether to insert at end of segment (optional)
|
|
453
453
|
end_of_segment_segment_id: The segment ID for end of segment location (optional)
|
|
454
454
|
end_of_segment_tab_id: The tab ID for end of segment location (optional)
|
|
455
|
-
|
|
455
|
+
|
|
456
456
|
Returns:
|
|
457
457
|
A dictionary containing the Google Docs API response after performing the create footnote operation
|
|
458
|
-
|
|
458
|
+
|
|
459
459
|
Raises:
|
|
460
460
|
HTTPError: When the API request fails, such as invalid document_id or insufficient permissions
|
|
461
461
|
RequestException: When there are network connectivity issues or API endpoint problems
|
|
462
|
-
|
|
462
|
+
|
|
463
463
|
Tags:
|
|
464
464
|
footnote, create, document, api, google-docs, batch, content-management
|
|
465
465
|
"""
|
|
@@ -506,19 +506,19 @@ class GoogleDocsApp(APIApplication):
|
|
|
506
506
|
) -> dict[str, Any]:
|
|
507
507
|
"""
|
|
508
508
|
Deletes a specific footer from a Google Document using its unique ID via a `batchUpdate` request. This operation, the counterpart to `create_footer`, removes an entire footer section, unlike `delete_content_range` which targets text within a specified index range.
|
|
509
|
-
|
|
509
|
+
|
|
510
510
|
Args:
|
|
511
511
|
document_id: The unique identifier of the Google Document to be updated
|
|
512
512
|
footer_id: The ID of the footer to delete
|
|
513
513
|
tab_id: The tab that contains the footer to delete (optional)
|
|
514
|
-
|
|
514
|
+
|
|
515
515
|
Returns:
|
|
516
516
|
A dictionary containing the Google Docs API response after performing the delete footer operation
|
|
517
|
-
|
|
517
|
+
|
|
518
518
|
Raises:
|
|
519
519
|
HTTPError: When the API request fails, such as invalid document_id or insufficient permissions
|
|
520
520
|
RequestException: When there are network connectivity issues or API endpoint problems
|
|
521
|
-
|
|
521
|
+
|
|
522
522
|
Tags:
|
|
523
523
|
footer, delete, remove, document, api, google-docs, batch, content-management
|
|
524
524
|
"""
|
|
@@ -546,21 +546,21 @@ class GoogleDocsApp(APIApplication):
|
|
|
546
546
|
) -> dict[str, Any]:
|
|
547
547
|
"""
|
|
548
548
|
Creates a header in a specified Google Document via the batchUpdate API endpoint. This function allows defining the header type and can optionally associate it with a specific section break location. It complements the `delete_header` and `create_footer` functions for managing document structure.
|
|
549
|
-
|
|
549
|
+
|
|
550
550
|
Args:
|
|
551
551
|
document_id: The unique identifier of the Google Document to be updated
|
|
552
552
|
header_type: The type of header to create (DEFAULT, HEADER_FOOTER_TYPE_UNSPECIFIED)
|
|
553
553
|
section_break_location_index: The index of the SectionBreak location (optional)
|
|
554
554
|
section_break_segment_id: The segment ID of the SectionBreak location (optional)
|
|
555
555
|
section_break_tab_id: The tab ID of the SectionBreak location (optional)
|
|
556
|
-
|
|
556
|
+
|
|
557
557
|
Returns:
|
|
558
558
|
A dictionary containing the Google Docs API response after performing the create header operation
|
|
559
|
-
|
|
559
|
+
|
|
560
560
|
Raises:
|
|
561
561
|
HTTPError: When the API request fails, such as invalid document_id or insufficient permissions
|
|
562
562
|
RequestException: When there are network connectivity issues or API endpoint problems
|
|
563
|
-
|
|
563
|
+
|
|
564
564
|
Tags:
|
|
565
565
|
header, create, document, api, google-docs, batch, content-management, important
|
|
566
566
|
"""
|
|
@@ -594,19 +594,19 @@ class GoogleDocsApp(APIApplication):
|
|
|
594
594
|
) -> dict[str, Any]:
|
|
595
595
|
"""
|
|
596
596
|
Removes a specific header from a Google Document using its unique ID. This function sends a `deleteHeader` request to the batch update API, acting as the direct counterpart to `create_header` and distinguishing it from `delete_footer` which removes footers.
|
|
597
|
-
|
|
597
|
+
|
|
598
598
|
Args:
|
|
599
599
|
document_id: The unique identifier of the Google Document to be updated
|
|
600
600
|
header_id: The ID of the header to delete
|
|
601
601
|
tab_id: The tab containing the header to delete (optional)
|
|
602
|
-
|
|
602
|
+
|
|
603
603
|
Returns:
|
|
604
604
|
A dictionary containing the Google Docs API response after performing the delete header operation
|
|
605
|
-
|
|
605
|
+
|
|
606
606
|
Raises:
|
|
607
607
|
HTTPError: When the API request fails, such as invalid document_id or insufficient permissions
|
|
608
608
|
RequestException: When there are network connectivity issues or API endpoint problems
|
|
609
|
-
|
|
609
|
+
|
|
610
610
|
Tags:
|
|
611
611
|
header, delete, remove, document, api, google-docs, batch, content-management
|
|
612
612
|
"""
|
|
@@ -635,7 +635,7 @@ class GoogleDocsApp(APIApplication):
|
|
|
635
635
|
) -> dict[str, Any]:
|
|
636
636
|
"""
|
|
637
637
|
Applies a predefined bulleted or numbered list format to paragraphs within a specified range using a `bullet_preset`. This function adds list formatting, distinguishing it from its counterpart, `delete_paragraph_bullets`, and other styling functions like `update_paragraph_style`, which handles alignment and headings.
|
|
638
|
-
|
|
638
|
+
|
|
639
639
|
Args:
|
|
640
640
|
document_id: The unique identifier of the Google Document to be updated
|
|
641
641
|
start_index: The zero-based start index of the range to apply bullets to
|
|
@@ -659,14 +659,14 @@ class GoogleDocsApp(APIApplication):
|
|
|
659
659
|
- NUMBERED_ZERODECIMAL_ALPHA_ROMAN: ZERODECIMAL, ALPHA and ROMAN with periods
|
|
660
660
|
segment_id: The segment ID for the range (optional)
|
|
661
661
|
tab_id: The tab ID for the range (optional)
|
|
662
|
-
|
|
662
|
+
|
|
663
663
|
Returns:
|
|
664
664
|
A dictionary containing the Google Docs API response after performing the create bullets operation
|
|
665
|
-
|
|
665
|
+
|
|
666
666
|
Raises:
|
|
667
667
|
HTTPError: When the API request fails, such as invalid document_id or insufficient permissions
|
|
668
668
|
RequestException: When there are network connectivity issues or API endpoint problems
|
|
669
|
-
|
|
669
|
+
|
|
670
670
|
Tags:
|
|
671
671
|
bullets, list, paragraph, document, api, google-docs, batch, content-management
|
|
672
672
|
"""
|
|
@@ -705,21 +705,21 @@ class GoogleDocsApp(APIApplication):
|
|
|
705
705
|
) -> dict[str, Any]:
|
|
706
706
|
"""
|
|
707
707
|
Removes bullet points or numbering from paragraphs within a specified range in a Google Document. This function reverts list formatting via the batch update API, acting as the direct counterpart to `apply_list_style` and preserving the underlying text content, unlike `delete_content_range`.
|
|
708
|
-
|
|
708
|
+
|
|
709
709
|
Args:
|
|
710
710
|
document_id: The unique identifier of the Google Document to be updated
|
|
711
711
|
start_index: The zero-based start index of the range to remove bullets from
|
|
712
712
|
end_index: The zero-based end index of the range to remove bullets from (exclusive)
|
|
713
713
|
segment_id: The segment ID for the range (optional)
|
|
714
714
|
tab_id: The tab ID for the range (optional)
|
|
715
|
-
|
|
715
|
+
|
|
716
716
|
Returns:
|
|
717
717
|
A dictionary containing the Google Docs API response after performing the delete bullets operation
|
|
718
|
-
|
|
718
|
+
|
|
719
719
|
Raises:
|
|
720
720
|
HTTPError: When the API request fails, such as invalid document_id or insufficient permissions
|
|
721
721
|
RequestException: When there are network connectivity issues or API endpoint problems
|
|
722
|
-
|
|
722
|
+
|
|
723
723
|
Tags:
|
|
724
724
|
bullets, delete, remove, list, paragraph, document, api, google-docs, batch, content-management
|
|
725
725
|
"""
|