From f99518b8370c555389f88fcea6d70b92e0760043 Mon Sep 17 00:00:00 2001 From: Waleed Date: Thu, 29 Jan 2026 20:37:30 -0800 Subject: [PATCH] feat(calcom): added calcom (#3070) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * feat(tools): added calcom * added more triggers, tested * updated regex in script for release to be more lenient * fix(tag-dropdown): performance improvements and scroll bug fixes - Add flatTagIndexMap for O(1) tag lookups (replaces O(n²) findIndex calls) - Memoize caret position calculation to avoid DOM manipulation on every render - Use refs for inputValue/cursorPosition to keep handleTagSelect callback stable - Change itemRefs from index-based to tag-based keys to prevent stale refs - Fix scroll jump in nested folders by removing scroll reset from registerFolder - Add onFolderEnter callback for scroll reset when entering folder via keyboard - Disable keyboard navigation wrap-around at boundaries - Simplify selection reset to single effect on flatTagList.length change Also: - Add safeCompare utility for timing-safe string comparison - Refactor webhook signature validation to use safeCompare Co-Authored-By: Claude Opus 4.5 * updated types * fix(calcom): simplify required field constraints for booking attendee The condition field already restricts these to calcom_create_booking, so simplified to required: true. Per Cal.com API docs, email is optional while name and timeZone are required. Co-Authored-By: Claude Opus 4.5 * added tests * updated folder multi select, updated calcom and github tools and docs generator script * updated drag, updated outputs for tools, regen docs with nested docs script * updated setup instructions links, destructure trigger outputs, fix text subblock styling * updated docs gen script * updated docs script * updated docs script * updated script * remove destructuring of stripe webhook * expanded wand textarea, updated calcom tools --------- Co-authored-by: Claude Opus 4.5 --- apps/docs/components/icons.tsx | 39 + apps/docs/components/ui/icon-mapping.ts | 2 + apps/docs/content/docs/en/tools/a2a.mdx | 64 +- apps/docs/content/docs/en/tools/ahrefs.mdx | 28 +- apps/docs/content/docs/en/tools/asana.mdx | 22 +- apps/docs/content/docs/en/tools/calcom.mdx | 789 +++++++ apps/docs/content/docs/en/tools/calendly.mdx | 166 +- apps/docs/content/docs/en/tools/clay.mdx | 10 +- apps/docs/content/docs/en/tools/clerk.mdx | 8 +- .../docs/content/docs/en/tools/confluence.mdx | 76 +- apps/docs/content/docs/en/tools/datadog.mdx | 80 +- apps/docs/content/docs/en/tools/discord.mdx | 226 +- apps/docs/content/docs/en/tools/dropbox.mdx | 82 +- apps/docs/content/docs/en/tools/exa.mdx | 2 +- apps/docs/content/docs/en/tools/firecrawl.mdx | 48 +- apps/docs/content/docs/en/tools/fireflies.mdx | 48 +- apps/docs/content/docs/en/tools/github.mdx | 1394 ++++++++---- .../content/docs/en/tools/google_docs.mdx | 24 +- .../content/docs/en/tools/google_drive.mdx | 424 ++-- .../content/docs/en/tools/google_forms.mdx | 50 +- .../content/docs/en/tools/google_groups.mdx | 12 +- .../content/docs/en/tools/google_search.mdx | 12 +- .../content/docs/en/tools/google_sheets.mdx | 32 +- .../content/docs/en/tools/google_slides.mdx | 102 +- apps/docs/content/docs/en/tools/hubspot.mdx | 285 ++- .../content/docs/en/tools/huggingface.mdx | 12 +- apps/docs/content/docs/en/tools/hunter.mdx | 127 +- .../content/docs/en/tools/image_generator.mdx | 8 +- .../docs/content/docs/en/tools/incidentio.mdx | 672 +++--- apps/docs/content/docs/en/tools/intercom.mdx | 588 ++--- apps/docs/content/docs/en/tools/jina.mdx | 6 + apps/docs/content/docs/en/tools/kalshi.mdx | 563 +++-- apps/docs/content/docs/en/tools/knowledge.mdx | 28 +- apps/docs/content/docs/en/tools/linear.mdx | 675 ++++-- apps/docs/content/docs/en/tools/mailchimp.mdx | 298 +-- apps/docs/content/docs/en/tools/mem0.mdx | 33 +- apps/docs/content/docs/en/tools/meta.json | 1 + .../content/docs/en/tools/microsoft_excel.mdx | 8 +- .../docs/en/tools/microsoft_planner.mdx | 46 +- .../content/docs/en/tools/microsoft_teams.mdx | 18 +- .../content/docs/en/tools/mistral_parse.mdx | 24 +- apps/docs/content/docs/en/tools/notion.mdx | 111 +- apps/docs/content/docs/en/tools/openai.mdx | 10 +- apps/docs/content/docs/en/tools/outlook.mdx | 35 +- .../content/docs/en/tools/parallel_ai.mdx | 6 +- .../docs/content/docs/en/tools/perplexity.mdx | 10 +- apps/docs/content/docs/en/tools/pinecone.mdx | 8 +- apps/docs/content/docs/en/tools/pipedrive.mdx | 75 + .../docs/content/docs/en/tools/polymarket.mdx | 170 +- .../docs/content/docs/en/tools/postgresql.mdx | 21 + apps/docs/content/docs/en/tools/posthog.mdx | 304 +-- apps/docs/content/docs/en/tools/qdrant.mdx | 20 +- apps/docs/content/docs/en/tools/reddit.mdx | 25 +- .../docs/content/docs/en/tools/salesforce.mdx | 383 ++-- apps/docs/content/docs/en/tools/sentry.mdx | 510 ++--- apps/docs/content/docs/en/tools/serper.mdx | 14 +- .../docs/content/docs/en/tools/sharepoint.mdx | 100 +- apps/docs/content/docs/en/tools/shopify.mdx | 251 +++ apps/docs/content/docs/en/tools/slack.mdx | 551 +++-- apps/docs/content/docs/en/tools/stagehand.mdx | 20 +- apps/docs/content/docs/en/tools/stripe.mdx | 1983 +++++++++++++++-- apps/docs/content/docs/en/tools/stt.mdx | 24 + apps/docs/content/docs/en/tools/supabase.mdx | 50 + apps/docs/content/docs/en/tools/tavily.mdx | 31 +- apps/docs/content/docs/en/tools/telegram.mdx | 356 +-- apps/docs/content/docs/en/tools/textract.mdx | 28 +- apps/docs/content/docs/en/tools/typeform.mdx | 26 +- apps/docs/content/docs/en/tools/vision.mdx | 6 +- apps/docs/content/docs/en/tools/wealthbox.mdx | 72 +- apps/docs/content/docs/en/tools/webflow.mdx | 15 +- apps/docs/content/docs/en/tools/wikipedia.mdx | 88 +- apps/docs/content/docs/en/tools/wordpress.mdx | 440 ++-- apps/docs/content/docs/en/tools/x.mdx | 48 +- apps/docs/content/docs/en/tools/zendesk.mdx | 690 +++++- apps/docs/content/docs/en/tools/zep.mdx | 60 +- apps/docs/content/docs/en/tools/zoom.mdx | 221 +- .../components/short-input/short-input.tsx | 48 +- .../keyboard-navigation-handler.tsx | 9 +- .../components/tag-dropdown/tag-dropdown.tsx | 116 +- .../sub-block/components/text/text.tsx | 6 +- .../components/sub-block/sub-block.test.ts | 261 +++ .../editor/components/sub-block/sub-block.tsx | 76 +- .../components/delete-modal/delete-modal.tsx | 36 +- .../components/folder-item/folder-item.tsx | 306 ++- .../workflow-item/avatars/avatars.tsx | 4 +- .../workflow-item/workflow-item.tsx | 242 +- .../workflow-list/workflow-list.tsx | 97 +- .../workspace-header/workspace-header.tsx | 34 +- .../w/components/sidebar/hooks/index.ts | 6 + .../components/sidebar/hooks/use-drag-drop.ts | 422 ++-- .../sidebar/hooks/use-folder-selection.ts | 61 + .../components/sidebar/hooks/use-item-drag.ts | 24 +- .../sidebar/hooks/use-sidebar-drag-context.ts | 36 + .../sidebar/hooks/use-workflow-selection.ts | 5 +- .../workspace/[workspaceId]/w/hooks/index.ts | 3 + .../w/hooks/use-delete-selection.ts | 166 ++ .../w/hooks/use-duplicate-selection.ts | 153 ++ .../w/hooks/use-export-selection.ts | 207 ++ apps/sim/blocks/blocks/calcom.ts | 828 +++++++ apps/sim/blocks/registry.ts | 2 + apps/sim/blocks/types.ts | 1 + .../emcn/components/popover/popover.tsx | 22 +- apps/sim/components/icons.tsx | 39 + apps/sim/lib/auth/auth.ts | 50 + apps/sim/lib/core/config/env.ts | 1 + apps/sim/lib/core/security/encryption.ts | 16 +- apps/sim/lib/oauth/oauth.ts | 50 +- apps/sim/lib/oauth/types.ts | 2 + apps/sim/lib/webhooks/processor.ts | 26 + apps/sim/lib/webhooks/utils.server.ts | 142 +- .../sim/lib/workflows/blocks/block-outputs.ts | 83 +- .../workflows/subblocks/visibility.test.ts | 171 ++ apps/sim/stores/folders/index.ts | 2 +- apps/sim/stores/folders/store.ts | 100 +- apps/sim/tools/a2a/cancel_task.ts | 11 +- .../sim/tools/a2a/delete_push_notification.ts | 6 +- apps/sim/tools/a2a/get_agent_card.ts | 42 +- apps/sim/tools/a2a/get_push_notification.ts | 16 +- apps/sim/tools/a2a/get_task.ts | 26 +- apps/sim/tools/a2a/resubscribe.ts | 31 +- apps/sim/tools/a2a/send_message.ts | 31 +- apps/sim/tools/a2a/set_push_notification.ts | 16 +- apps/sim/tools/a2a/types.ts | 219 +- apps/sim/tools/calcom/cancel_booking.ts | 104 + apps/sim/tools/calcom/confirm_booking.ts | 95 + apps/sim/tools/calcom/create_booking.ts | 152 ++ apps/sim/tools/calcom/create_event_type.ts | 221 ++ apps/sim/tools/calcom/create_schedule.ts | 132 ++ apps/sim/tools/calcom/decline_booking.ts | 105 + apps/sim/tools/calcom/delete_event_type.ts | 81 + apps/sim/tools/calcom/delete_schedule.ts | 68 + apps/sim/tools/calcom/get_booking.ts | 97 + apps/sim/tools/calcom/get_default_schedule.ts | 61 + apps/sim/tools/calcom/get_event_type.ts | 75 + apps/sim/tools/calcom/get_schedule.ts | 62 + apps/sim/tools/calcom/get_slots.ts | 173 ++ apps/sim/tools/calcom/index.ts | 39 + apps/sim/tools/calcom/list_bookings.ts | 142 ++ apps/sim/tools/calcom/list_event_types.ts | 92 + apps/sim/tools/calcom/list_schedules.ts | 59 + apps/sim/tools/calcom/reschedule_booking.ts | 127 ++ apps/sim/tools/calcom/types.ts | 716 ++++++ apps/sim/tools/calcom/update_event_type.ts | 223 ++ apps/sim/tools/calcom/update_schedule.ts | 138 ++ apps/sim/tools/confluence/index.ts | 64 + apps/sim/tools/confluence/list_attachments.ts | 5 +- apps/sim/tools/confluence/list_comments.ts | 5 +- apps/sim/tools/confluence/list_labels.ts | 10 +- apps/sim/tools/confluence/list_spaces.ts | 5 +- apps/sim/tools/confluence/search.ts | 10 +- apps/sim/tools/confluence/types.ts | 403 +++- apps/sim/tools/firecrawl/crawl.ts | 17 +- apps/sim/tools/firecrawl/scrape.ts | 4 +- apps/sim/tools/firecrawl/search.ts | 15 +- apps/sim/tools/firecrawl/types.ts | 332 ++- apps/sim/tools/github/close_issue.ts | 25 +- apps/sim/tools/github/comment.ts | 9 +- apps/sim/tools/github/compare_commits.ts | 55 +- apps/sim/tools/github/create_branch.ts | 8 +- .../tools/github/create_comment_reaction.ts | 25 +- apps/sim/tools/github/create_issue.ts | 32 +- .../sim/tools/github/create_issue_reaction.ts | 25 +- apps/sim/tools/github/create_milestone.ts | 12 +- apps/sim/tools/github/create_release.ts | 32 +- apps/sim/tools/github/delete_branch.ts | 6 +- apps/sim/tools/github/fork_repo.ts | 33 +- apps/sim/tools/github/get_branch.ts | 5 +- .../sim/tools/github/get_branch_protection.ts | 31 +- apps/sim/tools/github/get_commit.ts | 125 +- apps/sim/tools/github/get_gist.ts | 52 +- apps/sim/tools/github/get_issue.ts | 35 +- apps/sim/tools/github/get_milestone.ts | 33 +- apps/sim/tools/github/get_pr_files.ts | 18 +- apps/sim/tools/github/get_release.ts | 32 +- apps/sim/tools/github/get_workflow.ts | 13 +- apps/sim/tools/github/get_workflow_run.ts | 41 +- apps/sim/tools/github/issue_comment.ts | 9 +- apps/sim/tools/github/latest_commit.ts | 13 +- apps/sim/tools/github/list_branches.ts | 7 +- apps/sim/tools/github/list_commits.ts | 96 +- apps/sim/tools/github/list_forks.ts | 35 +- apps/sim/tools/github/list_gists.ts | 39 +- apps/sim/tools/github/list_issue_comments.ts | 9 +- apps/sim/tools/github/list_issues.ts | 32 +- apps/sim/tools/github/list_milestones.ts | 33 +- apps/sim/tools/github/list_pr_comments.ts | 12 +- apps/sim/tools/github/list_prs.ts | 15 +- apps/sim/tools/github/list_releases.ts | 31 +- apps/sim/tools/github/list_stargazers.ts | 10 +- apps/sim/tools/github/list_workflow_runs.ts | 36 +- apps/sim/tools/github/list_workflows.ts | 14 +- apps/sim/tools/github/pr.ts | 29 +- apps/sim/tools/github/repo_info.ts | 16 +- apps/sim/tools/github/search_repos.ts | 42 +- apps/sim/tools/github/types.ts | 883 +++++++- .../tools/github/update_branch_protection.ts | 24 +- apps/sim/tools/github/update_comment.ts | 9 +- apps/sim/tools/github/update_issue.ts | 32 +- apps/sim/tools/github/update_release.ts | 32 +- apps/sim/tools/google/search.ts | 22 +- apps/sim/tools/google/types.ts | 55 +- apps/sim/tools/hubspot/create_company.ts | 3 +- apps/sim/tools/hubspot/create_contact.ts | 3 +- apps/sim/tools/hubspot/get_company.ts | 3 +- apps/sim/tools/hubspot/get_contact.ts | 3 +- apps/sim/tools/hubspot/get_users.ts | 3 +- apps/sim/tools/hubspot/list_companies.ts | 7 +- apps/sim/tools/hubspot/list_contacts.ts | 7 +- apps/sim/tools/hubspot/list_deals.ts | 7 +- apps/sim/tools/hubspot/search_companies.ts | 7 +- apps/sim/tools/hubspot/search_contacts.ts | 7 +- apps/sim/tools/hubspot/types.ts | 325 ++- apps/sim/tools/hubspot/update_company.ts | 3 +- apps/sim/tools/hubspot/update_contact.ts | 3 +- apps/sim/tools/hunter/companies_find.ts | 8 +- apps/sim/tools/hunter/discover.ts | 7 +- apps/sim/tools/hunter/domain_search.ts | 35 +- apps/sim/tools/hunter/email_count.ts | 20 +- apps/sim/tools/hunter/email_finder.ts | 14 +- apps/sim/tools/hunter/email_verifier.ts | 28 +- apps/sim/tools/hunter/types.ts | 218 +- apps/sim/tools/incidentio/incidents_list.ts | 55 +- apps/sim/tools/incidentio/types.ts | 271 ++- apps/sim/tools/intercom/get_contact.ts | 72 +- apps/sim/tools/intercom/types.ts | 1013 +++++++++ apps/sim/tools/jina/search.ts | 5 + apps/sim/tools/jina/types.ts | 95 +- apps/sim/tools/kalshi/get_events.ts | 35 +- apps/sim/tools/kalshi/get_fills.ts | 33 +- apps/sim/tools/kalshi/get_markets.ts | 67 +- apps/sim/tools/kalshi/get_orders.ts | 48 +- apps/sim/tools/kalshi/get_positions.ts | 34 +- apps/sim/tools/kalshi/get_trades.ts | 18 +- apps/sim/tools/kalshi/types.ts | 311 +++ apps/sim/tools/linear/create_attachment.ts | 9 +- apps/sim/tools/linear/create_comment.ts | 9 +- apps/sim/tools/linear/create_customer.ts | 12 +- .../tools/linear/create_customer_status.ts | 2 + apps/sim/tools/linear/create_customer_tier.ts | 2 + apps/sim/tools/linear/create_issue.ts | 23 +- apps/sim/tools/linear/create_label.ts | 9 +- apps/sim/tools/linear/create_project.ts | 11 +- apps/sim/tools/linear/get_customer.ts | 12 +- apps/sim/tools/linear/get_cycle.ts | 11 +- apps/sim/tools/linear/get_issue.ts | 15 +- apps/sim/tools/linear/get_project.ts | 13 +- apps/sim/tools/linear/get_viewer.ts | 11 +- apps/sim/tools/linear/list_attachments.ts | 14 +- apps/sim/tools/linear/list_comments.ts | 18 +- .../tools/linear/list_customer_statuses.ts | 5 + apps/sim/tools/linear/list_customer_tiers.ts | 5 + apps/sim/tools/linear/list_customers.ts | 17 +- apps/sim/tools/linear/list_cycles.ts | 17 +- apps/sim/tools/linear/list_labels.ts | 14 +- apps/sim/tools/linear/list_projects.ts | 16 +- apps/sim/tools/linear/list_teams.ts | 13 +- apps/sim/tools/linear/list_users.ts | 16 +- apps/sim/tools/linear/list_workflow_states.ts | 18 +- apps/sim/tools/linear/read_issues.ts | 33 +- apps/sim/tools/linear/search_issues.ts | 20 +- apps/sim/tools/linear/types.ts | 495 +++- apps/sim/tools/linear/update_attachment.ts | 9 +- apps/sim/tools/linear/update_comment.ts | 8 +- apps/sim/tools/linear/update_customer.ts | 2 + apps/sim/tools/linear/update_issue.ts | 20 +- apps/sim/tools/linear/update_label.ts | 8 +- apps/sim/tools/linear/update_project.ts | 13 +- apps/sim/tools/mem0/add_memories.ts | 13 +- apps/sim/tools/mem0/get_memories.ts | 13 +- apps/sim/tools/mem0/search_memories.ts | 29 +- apps/sim/tools/mem0/types.ts | 169 +- apps/sim/tools/mistral/types.ts | 137 +- apps/sim/tools/notion/add_database_row.ts | 9 +- apps/sim/tools/notion/create_database.ts | 16 +- apps/sim/tools/notion/create_page.ts | 16 +- apps/sim/tools/notion/index.ts | 21 + apps/sim/tools/notion/query_database.ts | 40 +- apps/sim/tools/notion/read.ts | 13 +- apps/sim/tools/notion/read_database.ts | 20 +- apps/sim/tools/notion/search.ts | 26 +- apps/sim/tools/notion/types.ts | 561 ++++- apps/sim/tools/notion/update_page.ts | 17 +- apps/sim/tools/outlook/read.ts | 10 +- apps/sim/tools/outlook/types.ts | 108 +- apps/sim/tools/pipedrive/get_activities.ts | 10 +- apps/sim/tools/pipedrive/get_all_deals.ts | 14 +- apps/sim/tools/pipedrive/get_files.ts | 10 +- apps/sim/tools/pipedrive/get_leads.ts | 6 + apps/sim/tools/pipedrive/get_pipelines.ts | 10 +- apps/sim/tools/pipedrive/types.ts | 243 +- apps/sim/tools/postgresql/introspect.ts | 11 +- apps/sim/tools/postgresql/types.ts | 107 +- apps/sim/tools/qdrant/fetch_points.ts | 10 +- apps/sim/tools/qdrant/search_vector.ts | 13 +- apps/sim/tools/qdrant/types.ts | 95 +- apps/sim/tools/qdrant/upsert_points.ts | 10 +- apps/sim/tools/reddit/edit.ts | 5 + apps/sim/tools/reddit/hot_posts.ts | 18 + apps/sim/tools/reddit/reply.ts | 6 + apps/sim/tools/reddit/submit_post.ts | 6 + apps/sim/tools/reddit/types.ts | 237 +- apps/sim/tools/registry.ts | 40 + apps/sim/tools/salesforce/create_account.ts | 7 +- apps/sim/tools/salesforce/create_case.ts | 7 +- apps/sim/tools/salesforce/create_contact.ts | 7 +- apps/sim/tools/salesforce/create_lead.ts | 7 +- .../tools/salesforce/create_opportunity.ts | 7 +- apps/sim/tools/salesforce/create_task.ts | 7 +- apps/sim/tools/salesforce/delete_account.ts | 6 +- apps/sim/tools/salesforce/delete_case.ts | 6 +- apps/sim/tools/salesforce/delete_contact.ts | 6 +- apps/sim/tools/salesforce/delete_lead.ts | 6 +- .../tools/salesforce/delete_opportunity.ts | 6 +- apps/sim/tools/salesforce/delete_task.ts | 6 +- apps/sim/tools/salesforce/describe_object.ts | 21 +- apps/sim/tools/salesforce/get_accounts.ts | 24 +- apps/sim/tools/salesforce/get_cases.ts | 24 +- apps/sim/tools/salesforce/get_contacts.ts | 24 +- apps/sim/tools/salesforce/get_dashboard.ts | 15 +- apps/sim/tools/salesforce/get_leads.ts | 24 +- .../sim/tools/salesforce/get_opportunities.ts | 24 +- apps/sim/tools/salesforce/get_report.ts | 7 +- apps/sim/tools/salesforce/get_tasks.ts | 24 +- apps/sim/tools/salesforce/list_dashboards.ts | 4 +- apps/sim/tools/salesforce/list_objects.ts | 9 +- .../sim/tools/salesforce/list_report_types.ts | 4 +- apps/sim/tools/salesforce/list_reports.ts | 4 +- apps/sim/tools/salesforce/query.ts | 25 +- apps/sim/tools/salesforce/query_more.ts | 24 +- .../sim/tools/salesforce/refresh_dashboard.ts | 15 +- apps/sim/tools/salesforce/run_report.ts | 27 +- apps/sim/tools/salesforce/types.ts | 1219 +++++++++- apps/sim/tools/salesforce/update_account.ts | 6 +- apps/sim/tools/salesforce/update_case.ts | 6 +- apps/sim/tools/salesforce/update_contact.ts | 6 +- apps/sim/tools/salesforce/update_lead.ts | 6 +- .../tools/salesforce/update_opportunity.ts | 6 +- apps/sim/tools/salesforce/update_task.ts | 6 +- apps/sim/tools/serper/search.ts | 7 +- apps/sim/tools/serper/types.ts | 464 +++- apps/sim/tools/shopify/adjust_inventory.ts | 2 + apps/sim/tools/shopify/cancel_order.ts | 2 + apps/sim/tools/shopify/create_customer.ts | 2 + apps/sim/tools/shopify/create_fulfillment.ts | 2 + apps/sim/tools/shopify/create_product.ts | 2 + apps/sim/tools/shopify/get_collection.ts | 2 + apps/sim/tools/shopify/get_customer.ts | 2 + apps/sim/tools/shopify/get_inventory_level.ts | 2 + apps/sim/tools/shopify/get_order.ts | 2 + apps/sim/tools/shopify/get_product.ts | 2 + apps/sim/tools/shopify/list_collections.ts | 6 + apps/sim/tools/shopify/list_customers.ts | 6 + .../sim/tools/shopify/list_inventory_items.ts | 6 + apps/sim/tools/shopify/list_locations.ts | 6 + apps/sim/tools/shopify/list_orders.ts | 6 + apps/sim/tools/shopify/list_products.ts | 6 + apps/sim/tools/shopify/types.ts | 539 ++++- apps/sim/tools/shopify/update_customer.ts | 2 + apps/sim/tools/shopify/update_order.ts | 2 + apps/sim/tools/shopify/update_product.ts | 2 + apps/sim/tools/slack/add_reaction.ts | 7 +- apps/sim/tools/slack/canvas.ts | 7 +- apps/sim/tools/slack/delete_message.ts | 6 +- apps/sim/tools/slack/download.ts | 7 +- apps/sim/tools/slack/get_message.ts | 76 +- apps/sim/tools/slack/get_thread.ts | 55 +- apps/sim/tools/slack/get_user.ts | 38 +- apps/sim/tools/slack/list_channels.ts | 19 +- apps/sim/tools/slack/list_users.ts | 18 +- apps/sim/tools/slack/message.ts | 2 + apps/sim/tools/slack/message_reader.ts | 89 +- apps/sim/tools/slack/types.ts | 505 ++++- apps/sim/tools/slack/update_message.ts | 5 +- apps/sim/tools/spotify/get_album.ts | 16 +- apps/sim/tools/spotify/get_album_tracks.ts | 7 +- apps/sim/tools/spotify/get_albums.ts | 23 +- .../tools/spotify/get_artist_top_tracks.ts | 14 +- apps/sim/tools/spotify/get_artists.ts | 7 +- .../tools/spotify/get_currently_playing.ts | 8 +- .../sim/tools/spotify/get_followed_artists.ts | 7 +- apps/sim/tools/spotify/get_new_releases.ts | 7 +- apps/sim/tools/spotify/get_playback_state.ts | 15 +- apps/sim/tools/spotify/get_playlist.ts | 7 +- apps/sim/tools/spotify/get_playlist_tracks.ts | 7 +- apps/sim/tools/spotify/get_queue.ts | 14 +- apps/sim/tools/spotify/get_recently_played.ts | 7 +- apps/sim/tools/spotify/get_saved_albums.ts | 29 +- apps/sim/tools/spotify/get_saved_tracks.ts | 7 +- apps/sim/tools/spotify/get_top_tracks.ts | 13 +- apps/sim/tools/spotify/get_track.ts | 13 +- apps/sim/tools/spotify/get_tracks.ts | 15 +- apps/sim/tools/spotify/search.ts | 23 +- apps/sim/tools/spotify/types.ts | 249 ++- apps/sim/tools/stagehand/agent.ts | 19 +- apps/sim/tools/stagehand/types.ts | 249 ++- .../sim/tools/stripe/cancel_payment_intent.ts | 14 +- apps/sim/tools/stripe/cancel_subscription.ts | 10 +- .../tools/stripe/capture_payment_intent.ts | 14 +- .../tools/stripe/confirm_payment_intent.ts | 14 +- apps/sim/tools/stripe/create_customer.ts | 9 +- apps/sim/tools/stripe/create_invoice.ts | 13 +- .../sim/tools/stripe/create_payment_intent.ts | 13 +- apps/sim/tools/stripe/create_subscription.ts | 9 +- apps/sim/tools/stripe/delete_customer.ts | 11 +- apps/sim/tools/stripe/finalize_invoice.ts | 14 +- apps/sim/tools/stripe/list_customers.ts | 10 +- apps/sim/tools/stripe/list_payment_intents.ts | 10 +- apps/sim/tools/stripe/list_subscriptions.ts | 10 +- apps/sim/tools/stripe/pay_invoice.ts | 14 +- apps/sim/tools/stripe/resume_subscription.ts | 10 +- apps/sim/tools/stripe/retrieve_customer.ts | 10 +- apps/sim/tools/stripe/retrieve_invoice.ts | 14 +- .../tools/stripe/retrieve_payment_intent.ts | 14 +- .../sim/tools/stripe/retrieve_subscription.ts | 10 +- apps/sim/tools/stripe/search_customers.ts | 10 +- .../tools/stripe/search_payment_intents.ts | 10 +- apps/sim/tools/stripe/search_subscriptions.ts | 10 +- apps/sim/tools/stripe/types.ts | 1284 ++++++++++- apps/sim/tools/stripe/update_customer.ts | 9 +- apps/sim/tools/stripe/update_invoice.ts | 13 +- .../sim/tools/stripe/update_payment_intent.ts | 13 +- apps/sim/tools/stripe/update_subscription.ts | 9 +- apps/sim/tools/stripe/void_invoice.ts | 14 +- apps/sim/tools/stt/assemblyai.ts | 32 +- apps/sim/tools/stt/deepgram.ts | 10 +- apps/sim/tools/stt/types.ts | 60 +- apps/sim/tools/stt/whisper.ts | 10 +- apps/sim/tools/supabase/introspect.ts | 20 +- apps/sim/tools/supabase/storage_copy.ts | 7 +- .../tools/supabase/storage_create_bucket.ts | 8 +- apps/sim/tools/supabase/storage_delete.ts | 11 +- .../tools/supabase/storage_delete_bucket.ts | 8 +- apps/sim/tools/supabase/storage_download.ts | 13 +- apps/sim/tools/supabase/storage_list.ts | 10 +- .../tools/supabase/storage_list_buckets.ts | 11 +- apps/sim/tools/supabase/storage_move.ts | 7 +- apps/sim/tools/supabase/storage_upload.ts | 8 +- apps/sim/tools/supabase/types.ts | 307 ++- apps/sim/tools/tavily/crawl.ts | 15 +- apps/sim/tools/tavily/extract.ts | 20 +- apps/sim/tools/tavily/map.ts | 13 +- apps/sim/tools/tavily/search.ts | 29 +- apps/sim/tools/tavily/types.ts | 140 +- apps/sim/tools/types.ts | 19 +- apps/sim/tools/webflow/list_items.ts | 13 +- apps/sim/tools/webflow/types.ts | 45 + apps/sim/tools/wikipedia/content.ts | 9 +- apps/sim/tools/wikipedia/random.ts | 9 +- apps/sim/tools/wikipedia/search.ts | 7 +- apps/sim/tools/wikipedia/summary.ts | 10 +- apps/sim/tools/wikipedia/types.ts | 202 +- .../zendesk/autocomplete_organizations.ts | 36 +- apps/sim/tools/zendesk/create_organization.ts | 8 +- .../zendesk/create_organizations_bulk.ts | 4 +- apps/sim/tools/zendesk/create_ticket.ts | 8 +- apps/sim/tools/zendesk/create_tickets_bulk.ts | 4 +- apps/sim/tools/zendesk/create_user.ts | 8 +- apps/sim/tools/zendesk/create_users_bulk.ts | 4 +- apps/sim/tools/zendesk/get_current_user.ts | 8 +- apps/sim/tools/zendesk/get_organization.ts | 8 +- apps/sim/tools/zendesk/get_organizations.ts | 36 +- apps/sim/tools/zendesk/get_ticket.ts | 8 +- apps/sim/tools/zendesk/get_tickets.ts | 40 +- apps/sim/tools/zendesk/get_user.ts | 8 +- apps/sim/tools/zendesk/get_users.ts | 36 +- apps/sim/tools/zendesk/merge_tickets.ts | 4 +- apps/sim/tools/zendesk/search.ts | 32 +- apps/sim/tools/zendesk/search_users.ts | 36 +- apps/sim/tools/zendesk/types.ts | 455 ++++ apps/sim/tools/zendesk/update_organization.ts | 8 +- apps/sim/tools/zendesk/update_ticket.ts | 8 +- apps/sim/tools/zendesk/update_tickets_bulk.ts | 4 +- apps/sim/tools/zendesk/update_user.ts | 8 +- apps/sim/tools/zendesk/update_users_bulk.ts | 4 +- apps/sim/tools/zep/add_messages.ts | 11 +- apps/sim/tools/zep/add_user.ts | 37 +- apps/sim/tools/zep/create_thread.ts | 27 +- apps/sim/tools/zep/delete_thread.ts | 1 - apps/sim/tools/zep/get_context.ts | 1 - apps/sim/tools/zep/get_messages.ts | 17 +- apps/sim/tools/zep/get_threads.ts | 17 +- apps/sim/tools/zep/get_user.ts | 42 +- apps/sim/tools/zep/get_user_threads.ts | 12 +- apps/sim/tools/zep/index.ts | 13 + apps/sim/tools/zep/types.ts | 186 +- apps/sim/tools/zoom/create_meeting.ts | 20 +- apps/sim/tools/zoom/get_meeting.ts | 22 +- apps/sim/tools/zoom/get_meeting_recordings.ts | 12 +- apps/sim/tools/zoom/list_meetings.ts | 16 +- apps/sim/tools/zoom/list_past_participants.ts | 14 +- apps/sim/tools/zoom/list_recordings.ts | 16 +- apps/sim/tools/zoom/types.ts | 323 ++- apps/sim/triggers/airtable/webhook.ts | 95 +- apps/sim/triggers/calcom/booking_cancelled.ts | 35 + apps/sim/triggers/calcom/booking_created.ts | 36 + apps/sim/triggers/calcom/booking_paid.ts | 35 + apps/sim/triggers/calcom/booking_rejected.ts | 35 + apps/sim/triggers/calcom/booking_requested.ts | 35 + .../triggers/calcom/booking_rescheduled.ts | 35 + apps/sim/triggers/calcom/index.ts | 9 + apps/sim/triggers/calcom/meeting_ended.ts | 35 + apps/sim/triggers/calcom/recording_ready.ts | 35 + apps/sim/triggers/calcom/utils.ts | 664 ++++++ apps/sim/triggers/calcom/webhook.ts | 40 + apps/sim/triggers/calendly/utils.ts | 2 +- apps/sim/triggers/circleback/utils.ts | 51 +- apps/sim/triggers/grain/utils.ts | 2 +- apps/sim/triggers/hubspot/utils.ts | 96 +- apps/sim/triggers/index.ts | 83 +- apps/sim/triggers/jira/utils.ts | 2 +- apps/sim/triggers/lemlist/utils.ts | 2 +- apps/sim/triggers/linear/utils.ts | 2 +- apps/sim/triggers/microsoftteams/webhook.ts | 2 +- apps/sim/triggers/registry.ts | 20 + apps/sim/triggers/slack/webhook.ts | 82 +- apps/sim/triggers/stripe/webhook.ts | 6 +- apps/sim/triggers/telegram/webhook.ts | 117 +- apps/sim/triggers/twilio_voice/webhook.ts | 13 +- apps/sim/triggers/typeform/webhook.ts | 127 +- apps/sim/triggers/webflow/form_submission.ts | 21 +- apps/sim/triggers/whatsapp/webhook.ts | 48 +- bun.lock | 369 +-- scripts/create-single-release.ts | 4 +- scripts/generate-docs.ts | 859 ++++++- 524 files changed, 32699 insertions(+), 8698 deletions(-) create mode 100644 apps/docs/content/docs/en/tools/calcom.mdx create mode 100644 apps/sim/app/workspace/[workspaceId]/w/[workflowId]/components/panel/components/editor/components/sub-block/sub-block.test.ts create mode 100644 apps/sim/app/workspace/[workspaceId]/w/components/sidebar/hooks/use-folder-selection.ts create mode 100644 apps/sim/app/workspace/[workspaceId]/w/components/sidebar/hooks/use-sidebar-drag-context.ts create mode 100644 apps/sim/app/workspace/[workspaceId]/w/hooks/use-delete-selection.ts create mode 100644 apps/sim/app/workspace/[workspaceId]/w/hooks/use-duplicate-selection.ts create mode 100644 apps/sim/app/workspace/[workspaceId]/w/hooks/use-export-selection.ts create mode 100644 apps/sim/blocks/blocks/calcom.ts create mode 100644 apps/sim/lib/workflows/subblocks/visibility.test.ts create mode 100644 apps/sim/tools/calcom/cancel_booking.ts create mode 100644 apps/sim/tools/calcom/confirm_booking.ts create mode 100644 apps/sim/tools/calcom/create_booking.ts create mode 100644 apps/sim/tools/calcom/create_event_type.ts create mode 100644 apps/sim/tools/calcom/create_schedule.ts create mode 100644 apps/sim/tools/calcom/decline_booking.ts create mode 100644 apps/sim/tools/calcom/delete_event_type.ts create mode 100644 apps/sim/tools/calcom/delete_schedule.ts create mode 100644 apps/sim/tools/calcom/get_booking.ts create mode 100644 apps/sim/tools/calcom/get_default_schedule.ts create mode 100644 apps/sim/tools/calcom/get_event_type.ts create mode 100644 apps/sim/tools/calcom/get_schedule.ts create mode 100644 apps/sim/tools/calcom/get_slots.ts create mode 100644 apps/sim/tools/calcom/index.ts create mode 100644 apps/sim/tools/calcom/list_bookings.ts create mode 100644 apps/sim/tools/calcom/list_event_types.ts create mode 100644 apps/sim/tools/calcom/list_schedules.ts create mode 100644 apps/sim/tools/calcom/reschedule_booking.ts create mode 100644 apps/sim/tools/calcom/types.ts create mode 100644 apps/sim/tools/calcom/update_event_type.ts create mode 100644 apps/sim/tools/calcom/update_schedule.ts create mode 100644 apps/sim/triggers/calcom/booking_cancelled.ts create mode 100644 apps/sim/triggers/calcom/booking_created.ts create mode 100644 apps/sim/triggers/calcom/booking_paid.ts create mode 100644 apps/sim/triggers/calcom/booking_rejected.ts create mode 100644 apps/sim/triggers/calcom/booking_requested.ts create mode 100644 apps/sim/triggers/calcom/booking_rescheduled.ts create mode 100644 apps/sim/triggers/calcom/index.ts create mode 100644 apps/sim/triggers/calcom/meeting_ended.ts create mode 100644 apps/sim/triggers/calcom/recording_ready.ts create mode 100644 apps/sim/triggers/calcom/utils.ts create mode 100644 apps/sim/triggers/calcom/webhook.ts diff --git a/apps/docs/components/icons.tsx b/apps/docs/components/icons.tsx index f9b47f43c..60ad1d6fe 100644 --- a/apps/docs/components/icons.tsx +++ b/apps/docs/components/icons.tsx @@ -5113,3 +5113,42 @@ export function PulseIcon(props: SVGProps) { ) } + +export function CalComIcon(props: SVGProps) { + return ( + + + + + + + + + + ) +} diff --git a/apps/docs/components/ui/icon-mapping.ts b/apps/docs/components/ui/icon-mapping.ts index 046410d29..97c0e93d4 100644 --- a/apps/docs/components/ui/icon-mapping.ts +++ b/apps/docs/components/ui/icon-mapping.ts @@ -13,6 +13,7 @@ import { AsanaIcon, BrainIcon, BrowserUseIcon, + CalComIcon, CalendlyIcon, CirclebackIcon, ClayIcon, @@ -141,6 +142,7 @@ export const blockTypeToIconMap: Record = { arxiv: ArxivIcon, asana: AsanaIcon, browser_use: BrowserUseIcon, + calcom: CalComIcon, calendly: CalendlyIcon, circleback: CirclebackIcon, clay: ClayIcon, diff --git a/apps/docs/content/docs/en/tools/a2a.mdx b/apps/docs/content/docs/en/tools/a2a.mdx index 9e7ea9ee4..01dca2369 100644 --- a/apps/docs/content/docs/en/tools/a2a.mdx +++ b/apps/docs/content/docs/en/tools/a2a.mdx @@ -52,12 +52,12 @@ Send a message to an external A2A-compatible agent. | Parameter | Type | Description | | --------- | ---- | ----------- | -| `content` | string | The text response from the agent | -| `taskId` | string | Task ID for follow-up interactions | -| `contextId` | string | Context ID for conversation continuity | -| `state` | string | Task state | -| `artifacts` | array | Structured output artifacts | -| `history` | array | Full message history | +| `content` | string | Text response content from the agent | +| `taskId` | string | Unique task identifier | +| `contextId` | string | Groups related tasks/messages | +| `state` | string | Current lifecycle state \(working, completed, failed, canceled, rejected, input_required, auth_required\) | +| `artifacts` | array | Task output artifacts | +| `history` | array | Conversation history \(Message array\) | ### `a2a_get_task` @@ -76,11 +76,11 @@ Query the status of an existing A2A task. | Parameter | Type | Description | | --------- | ---- | ----------- | -| `taskId` | string | Task ID | -| `contextId` | string | Context ID | -| `state` | string | Task state | -| `artifacts` | array | Output artifacts | -| `history` | array | Message history | +| `taskId` | string | Unique task identifier | +| `contextId` | string | Groups related tasks/messages | +| `state` | string | Current lifecycle state \(working, completed, failed, canceled, rejected, input_required, auth_required\) | +| `artifacts` | array | Task output artifacts | +| `history` | array | Conversation history \(Message array\) | ### `a2a_cancel_task` @@ -99,7 +99,7 @@ Cancel a running A2A task. | Parameter | Type | Description | | --------- | ---- | ----------- | | `cancelled` | boolean | Whether cancellation was successful | -| `state` | string | Task state after cancellation | +| `state` | string | Current lifecycle state \(working, completed, failed, canceled, rejected, input_required, auth_required\) | ### `a2a_get_agent_card` @@ -116,14 +116,15 @@ Fetch the Agent Card (discovery document) for an A2A agent. | Parameter | Type | Description | | --------- | ---- | ----------- | -| `name` | string | Agent name | -| `description` | string | Agent description | -| `url` | string | Agent endpoint URL | -| `version` | string | Agent version | -| `capabilities` | object | Agent capabilities \(streaming, pushNotifications, etc.\) | -| `skills` | array | Skills the agent can perform | -| `defaultInputModes` | array | Default input modes \(text, file, data\) | -| `defaultOutputModes` | array | Default output modes \(text, file, data\) | +| `name` | string | Agent display name | +| `description` | string | Agent purpose/capabilities | +| `url` | string | Service endpoint URL | +| `provider` | object | Creator organization details | +| `capabilities` | object | Feature support matrix | +| `skills` | array | Available operations | +| `version` | string | A2A protocol version supported by the agent | +| `defaultInputModes` | array | Default input content types accepted by the agent | +| `defaultOutputModes` | array | Default output content types produced by the agent | ### `a2a_resubscribe` @@ -141,12 +142,12 @@ Reconnect to an ongoing A2A task stream after connection interruption. | Parameter | Type | Description | | --------- | ---- | ----------- | -| `taskId` | string | Task ID | -| `contextId` | string | Context ID | -| `state` | string | Current task state | +| `taskId` | string | Unique task identifier | +| `contextId` | string | Groups related tasks/messages | +| `state` | string | Current lifecycle state \(working, completed, failed, canceled, rejected, input_required, auth_required\) | | `isRunning` | boolean | Whether the task is still running | -| `artifacts` | array | Output artifacts | -| `history` | array | Message history | +| `artifacts` | array | Task output artifacts | +| `history` | array | Conversation history \(Message array\) | ### `a2a_set_push_notification` @@ -166,9 +167,9 @@ Configure a webhook to receive task update notifications. | Parameter | Type | Description | | --------- | ---- | ----------- | -| `url` | string | Configured webhook URL | -| `token` | string | Token for webhook validation | -| `success` | boolean | Whether configuration was successful | +| `url` | string | HTTPS webhook URL for notifications | +| `token` | string | Authentication token for webhook validation | +| `success` | boolean | Whether the operation was successful | ### `a2a_get_push_notification` @@ -186,9 +187,8 @@ Get the push notification webhook configuration for a task. | Parameter | Type | Description | | --------- | ---- | ----------- | -| `url` | string | Configured webhook URL | -| `token` | string | Token for webhook validation | -| `exists` | boolean | Whether a push notification config exists | +| `token` | string | Authentication token for webhook validation | +| `exists` | boolean | Whether the resource exists | ### `a2a_delete_push_notification` @@ -207,6 +207,6 @@ Delete the push notification webhook configuration for a task. | Parameter | Type | Description | | --------- | ---- | ----------- | -| `success` | boolean | Whether deletion was successful | +| `success` | boolean | Whether the operation was successful | diff --git a/apps/docs/content/docs/en/tools/ahrefs.mdx b/apps/docs/content/docs/en/tools/ahrefs.mdx index 0326071dd..fd8a1b3cd 100644 --- a/apps/docs/content/docs/en/tools/ahrefs.mdx +++ b/apps/docs/content/docs/en/tools/ahrefs.mdx @@ -98,12 +98,12 @@ Get backlink statistics for a target domain or URL. Returns totals for different | Parameter | Type | Description | | --------- | ---- | ----------- | | `stats` | object | Backlink statistics summary | -| ↳ `total` | number | Total number of live backlinks | -| ↳ `dofollow` | number | Number of dofollow backlinks | -| ↳ `nofollow` | number | Number of nofollow backlinks | -| ↳ `text` | number | Number of text backlinks | -| ↳ `image` | number | Number of image backlinks | -| ↳ `redirect` | number | Number of redirect backlinks | +| ↳ `total` | number | Total number of live backlinks | +| ↳ `dofollow` | number | Number of dofollow backlinks | +| ↳ `nofollow` | number | Number of nofollow backlinks | +| ↳ `text` | number | Number of text backlinks | +| ↳ `image` | number | Number of image backlinks | +| ↳ `redirect` | number | Number of redirect backlinks | ### `ahrefs_referring_domains` @@ -205,14 +205,14 @@ Get detailed metrics for a keyword including search volume, keyword difficulty, | Parameter | Type | Description | | --------- | ---- | ----------- | | `overview` | object | Keyword metrics overview | -| ↳ `keyword` | string | The analyzed keyword | -| ↳ `searchVolume` | number | Monthly search volume | -| ↳ `keywordDifficulty` | number | Keyword difficulty score \(0-100\) | -| ↳ `cpc` | number | Cost per click in USD | -| ↳ `clicks` | number | Estimated clicks per month | -| ↳ `clicksPercentage` | number | Percentage of searches that result in clicks | -| ↳ `parentTopic` | string | The parent topic for this keyword | -| ↳ `trafficPotential` | number | Estimated traffic potential if ranking #1 | +| ↳ `keyword` | string | The analyzed keyword | +| ↳ `searchVolume` | number | Monthly search volume | +| ↳ `keywordDifficulty` | number | Keyword difficulty score \(0-100\) | +| ↳ `cpc` | number | Cost per click in USD | +| ↳ `clicks` | number | Estimated clicks per month | +| ↳ `clicksPercentage` | number | Percentage of searches that result in clicks | +| ↳ `parentTopic` | string | The parent topic for this keyword | +| ↳ `trafficPotential` | number | Estimated traffic potential if ranking #1 | ### `ahrefs_broken_backlinks` diff --git a/apps/docs/content/docs/en/tools/asana.mdx b/apps/docs/content/docs/en/tools/asana.mdx index 858ae4b94..3b43bc352 100644 --- a/apps/docs/content/docs/en/tools/asana.mdx +++ b/apps/docs/content/docs/en/tools/asana.mdx @@ -59,11 +59,11 @@ Retrieve a single task by GID or get multiple tasks with filters | `notes` | string | Task notes or description | | `completed` | boolean | Whether the task is completed | | `assignee` | object | Assignee details | -| ↳ `gid` | string | Assignee GID | -| ↳ `name` | string | Assignee name | +| ↳ `gid` | string | Assignee GID | +| ↳ `name` | string | Assignee name | | `created_by` | object | Creator details | -| ↳ `gid` | string | Creator GID | -| ↳ `name` | string | Creator name | +| ↳ `gid` | string | Creator GID | +| ↳ `name` | string | Creator name | | `due_on` | string | Due date \(YYYY-MM-DD\) | | `created_at` | string | Task creation timestamp | | `modified_at` | string | Task last modified timestamp | @@ -175,15 +175,15 @@ Search for tasks in an Asana workspace | ↳ `notes` | string | Task notes | | ↳ `completed` | boolean | Completion status | | ↳ `assignee` | object | Assignee details | -| ↳ `gid` | string | Assignee GID | -| ↳ `name` | string | Assignee name | +| ↳ `gid` | string | Assignee GID | +| ↳ `name` | string | Assignee name | | ↳ `due_on` | string | Due date | | ↳ `created_at` | string | Creation timestamp | | ↳ `modified_at` | string | Modified timestamp | | `next_page` | object | Pagination info | -| ↳ `offset` | string | Offset token | -| ↳ `path` | string | API path | -| ↳ `uri` | string | Full URI | +| ↳ `offset` | string | Offset token | +| ↳ `path` | string | API path | +| ↳ `uri` | string | Full URI | ### `asana_add_comment` @@ -206,7 +206,7 @@ Add a comment (story) to an Asana task | `text` | string | Comment text content | | `created_at` | string | Comment creation timestamp | | `created_by` | object | Comment author details | -| ↳ `gid` | string | Author GID | -| ↳ `name` | string | Author name | +| ↳ `gid` | string | Author GID | +| ↳ `name` | string | Author name | diff --git a/apps/docs/content/docs/en/tools/calcom.mdx b/apps/docs/content/docs/en/tools/calcom.mdx new file mode 100644 index 000000000..7f08ef91d --- /dev/null +++ b/apps/docs/content/docs/en/tools/calcom.mdx @@ -0,0 +1,789 @@ +--- +title: CalCom +description: Manage Cal.com bookings, event types, schedules, and availability +--- + +import { BlockInfoCard } from "@/components/ui/block-info-card" + + + +{/* MANUAL-CONTENT-START:intro */} +[Cal.com](https://cal.com/) is a flexible and open-source scheduling platform that makes it easy to manage appointments, bookings, event types, and team availabilities. + +With Cal.com, you can: + +- **Automate scheduling**: Allow users to view your available time slots and book meetings automatically, without back-and-forth emails. +- **Manage events**: Create and customize event types, durations, and rules for one-on-one or group meetings. +- **Integrate calendars**: Seamlessly connect with Google, Outlook, Apple, or other calendar providers to avoid double bookings. +- **Handle attendees and guests**: Collect attendee information, manage guests, and send invitations or reminders. +- **Control availability**: Define custom working hours, buffer times, and cancellation/rebooking rules. +- **Power workflows**: Trigger custom actions via webhooks when a booking is created, cancelled, or rescheduled. + +In Sim, the Cal.com integration enables your agents to book meetings, check availabilities, manage event types, and automate scheduling tasks programmatically. This helps agents coordinate meetings, send bookings on behalf of users, check schedules, or respond to booking events—all without manual intervention. By connecting Sim with Cal.com, you unlock highly automated and intelligent scheduling workflows that can integrate seamlessly with your broader automation needs. +{/* MANUAL-CONTENT-END */} + + +## Usage Instructions + +Integrate Cal.com into your workflow. Create and manage bookings, event types, schedules, and check availability slots. Supports creating, listing, rescheduling, and canceling bookings, as well as managing event types and schedules. Can also trigger workflows based on Cal.com webhook events (booking created, cancelled, rescheduled). Connect your Cal.com account via OAuth. + + + +## Tools + +### `calcom_create_booking` + +Create a new booking on Cal.com + +#### Input + +| Parameter | Type | Required | Description | +| --------- | ---- | -------- | ----------- | +| `eventTypeId` | number | Yes | The ID of the event type to book | +| `start` | string | Yes | Start time in UTC ISO 8601 format \(e.g., 2024-01-15T09:00:00Z\) | +| `attendee` | object | Yes | Attendee information object with name, email, timeZone, and optional phoneNumber \(constructed from individual attendee fields\) | +| `guests` | array | No | Array of guest email addresses | +| `items` | string | No | Guest email address | +| `lengthInMinutes` | number | No | Duration of the booking in minutes \(overrides event type default\) | +| `metadata` | object | No | Custom metadata to attach to the booking | + +#### Output + +| Parameter | Type | Description | +| --------- | ---- | ----------- | +| `status` | string | Response status | +| `data` | object | Created booking details | +| ↳ `eventType` | object | Event type details | +| ↳ `id` | number | Event type ID | +| ↳ `slug` | string | Event type slug | +| ↳ `attendees` | array | List of attendees | +| ↳ `name` | string | Attendee name | +| ↳ `email` | string | Attendee actual email address | +| ↳ `displayEmail` | string | Email shown publicly \(may differ from actual email\) | +| ↳ `timeZone` | string | Attendee timezone \(IANA format\) | +| ↳ `phoneNumber` | string | Attendee phone number | +| ↳ `language` | string | Attendee language preference \(ISO code\) | +| ↳ `absent` | boolean | Whether attendee was absent | +| ↳ `hosts` | array | List of hosts | +| ↳ `id` | number | Host user ID | +| ↳ `name` | string | Host display name | +| ↳ `email` | string | Host actual email address | +| ↳ `displayEmail` | string | Email shown publicly \(may differ from actual email\) | +| ↳ `username` | string | Host Cal.com username | +| ↳ `timeZone` | string | Host timezone \(IANA format\) | +| ↳ `id` | number | Numeric booking ID | +| ↳ `uid` | string | Unique identifier for the booking | +| ↳ `title` | string | Title of the booking | +| ↳ `status` | string | Booking status \(e.g., accepted, pending, cancelled\) | +| ↳ `start` | string | Start time in ISO 8601 format | +| ↳ `end` | string | End time in ISO 8601 format | +| ↳ `duration` | number | Duration in minutes | +| ↳ `eventTypeId` | number | Event type ID | +| ↳ `meetingUrl` | string | URL to join the meeting | +| ↳ `location` | string | Location of the booking | +| ↳ `absentHost` | boolean | Whether the host was absent | +| ↳ `guests` | array | Guest email addresses | +| ↳ `bookingFieldsResponses` | json | Custom booking field responses \(dynamic keys based on event type configuration\) | +| ↳ `metadata` | json | Custom metadata attached to the booking \(dynamic key-value pairs\) | +| ↳ `icsUid` | string | ICS calendar UID | +| ↳ `createdAt` | string | When the booking was created | + +### `calcom_get_booking` + +Get details of a specific booking by its UID + +#### Input + +| Parameter | Type | Required | Description | +| --------- | ---- | -------- | ----------- | +| `bookingUid` | string | Yes | Unique identifier \(UID\) of the booking | + +#### Output + +| Parameter | Type | Description | +| --------- | ---- | ----------- | +| `status` | string | Response status | +| `data` | object | Booking details | +| ↳ `eventType` | object | Event type details | +| ↳ `id` | number | Event type ID | +| ↳ `slug` | string | Event type slug | +| ↳ `attendees` | array | List of attendees | +| ↳ `name` | string | Attendee name | +| ↳ `email` | string | Attendee actual email address | +| ↳ `displayEmail` | string | Email shown publicly \(may differ from actual email\) | +| ↳ `timeZone` | string | Attendee timezone \(IANA format\) | +| ↳ `phoneNumber` | string | Attendee phone number | +| ↳ `language` | string | Attendee language preference \(ISO code\) | +| ↳ `absent` | boolean | Whether attendee was absent | +| ↳ `hosts` | array | List of hosts | +| ↳ `id` | number | Host user ID | +| ↳ `name` | string | Host display name | +| ↳ `email` | string | Host actual email address | +| ↳ `displayEmail` | string | Email shown publicly \(may differ from actual email\) | +| ↳ `username` | string | Host Cal.com username | +| ↳ `timeZone` | string | Host timezone \(IANA format\) | +| ↳ `id` | number | Numeric booking ID | +| ↳ `uid` | string | Unique identifier for the booking | +| ↳ `title` | string | Title of the booking | +| ↳ `description` | string | Description of the booking | +| ↳ `status` | string | Booking status \(e.g., accepted, pending, cancelled\) | +| ↳ `start` | string | Start time in ISO 8601 format | +| ↳ `end` | string | End time in ISO 8601 format | +| ↳ `duration` | number | Duration in minutes | +| ↳ `eventTypeId` | number | Event type ID | +| ↳ `meetingUrl` | string | URL to join the meeting | +| ↳ `location` | string | Location of the booking | +| ↳ `absentHost` | boolean | Whether the host was absent | +| ↳ `guests` | array | Guest email addresses | +| ↳ `bookingFieldsResponses` | json | Custom booking field responses \(dynamic keys based on event type configuration\) | +| ↳ `metadata` | json | Custom metadata attached to the booking \(dynamic key-value pairs\) | +| ↳ `rating` | number | Booking rating | +| ↳ `icsUid` | string | ICS calendar UID | +| ↳ `cancellationReason` | string | Reason for cancellation if cancelled | +| ↳ `reschedulingReason` | string | Reason for rescheduling if rescheduled | +| ↳ `rescheduledFromUid` | string | Original booking UID if this booking was rescheduled | +| ↳ `rescheduledToUid` | string | New booking UID after reschedule | +| ↳ `cancelledByEmail` | string | Email of person who cancelled the booking | +| ↳ `rescheduledByEmail` | string | Email of person who rescheduled the booking | +| ↳ `createdAt` | string | When the booking was created | +| ↳ `updatedAt` | string | When the booking was last updated | + +### `calcom_list_bookings` + +List all bookings with optional status filter + +#### Input + +| Parameter | Type | Required | Description | +| --------- | ---- | -------- | ----------- | +| `status` | string | No | Filter bookings by status: upcoming, recurring, past, cancelled, or unconfirmed | +| `take` | number | No | Number of bookings to return \(pagination limit\) | +| `skip` | number | No | Number of bookings to skip \(pagination offset\) | + +#### Output + +| Parameter | Type | Description | +| --------- | ---- | ----------- | +| `status` | string | Response status | +| `data` | array | Array of bookings | +| ↳ `eventType` | object | Event type details | +| ↳ `id` | number | Event type ID | +| ↳ `slug` | string | Event type slug | +| ↳ `attendees` | array | List of attendees | +| ↳ `name` | string | Attendee name | +| ↳ `email` | string | Attendee actual email address | +| ↳ `displayEmail` | string | Email shown publicly \(may differ from actual email\) | +| ↳ `timeZone` | string | Attendee timezone \(IANA format\) | +| ↳ `phoneNumber` | string | Attendee phone number | +| ↳ `language` | string | Attendee language preference \(ISO code\) | +| ↳ `absent` | boolean | Whether attendee was absent | +| ↳ `hosts` | array | List of hosts | +| ↳ `id` | number | Host user ID | +| ↳ `name` | string | Host display name | +| ↳ `email` | string | Host actual email address | +| ↳ `displayEmail` | string | Email shown publicly \(may differ from actual email\) | +| ↳ `username` | string | Host Cal.com username | +| ↳ `timeZone` | string | Host timezone \(IANA format\) | +| ↳ `id` | number | Numeric booking ID | +| ↳ `uid` | string | Unique identifier for the booking | +| ↳ `title` | string | Title of the booking | +| ↳ `description` | string | Description of the booking | +| ↳ `status` | string | Booking status \(e.g., accepted, pending, cancelled\) | +| ↳ `start` | string | Start time in ISO 8601 format | +| ↳ `end` | string | End time in ISO 8601 format | +| ↳ `duration` | number | Duration in minutes | +| ↳ `eventTypeId` | number | Event type ID | +| ↳ `meetingUrl` | string | URL to join the meeting | +| ↳ `location` | string | Location of the booking | +| ↳ `absentHost` | boolean | Whether the host was absent | +| ↳ `guests` | array | Guest email addresses | +| ↳ `bookingFieldsResponses` | json | Custom booking field responses \(dynamic keys based on event type configuration\) | +| ↳ `metadata` | json | Custom metadata attached to the booking \(dynamic key-value pairs\) | +| ↳ `rating` | number | Booking rating | +| ↳ `icsUid` | string | ICS calendar UID | +| ↳ `cancellationReason` | string | Reason for cancellation if cancelled | +| ↳ `cancelledByEmail` | string | Email of person who cancelled the booking | +| ↳ `reschedulingReason` | string | Reason for rescheduling if rescheduled | +| ↳ `rescheduledByEmail` | string | Email of person who rescheduled the booking | +| ↳ `rescheduledFromUid` | string | Original booking UID if this booking was rescheduled | +| ↳ `rescheduledToUid` | string | New booking UID after reschedule | +| ↳ `createdAt` | string | When the booking was created | +| ↳ `updatedAt` | string | When the booking was last updated | +| `pagination` | object | Pagination metadata | +| ↳ `totalItems` | number | Total number of items | +| ↳ `remainingItems` | number | Remaining items after current page | +| ↳ `returnedItems` | number | Number of items returned in this response | +| ↳ `itemsPerPage` | number | Items per page | +| ↳ `currentPage` | number | Current page number | +| ↳ `totalPages` | number | Total number of pages | +| ↳ `hasNextPage` | boolean | Whether there is a next page | +| ↳ `hasPreviousPage` | boolean | Whether there is a previous page | + +### `calcom_cancel_booking` + +Cancel an existing booking + +#### Input + +| Parameter | Type | Required | Description | +| --------- | ---- | -------- | ----------- | +| `bookingUid` | string | Yes | Unique identifier \(UID\) of the booking to cancel | +| `cancellationReason` | string | No | Reason for cancelling the booking | + +#### Output + +| Parameter | Type | Description | +| --------- | ---- | ----------- | +| `status` | string | Response status | +| `data` | object | Cancelled booking details | +| ↳ `eventType` | object | Event type details | +| ↳ `id` | number | Event type ID | +| ↳ `slug` | string | Event type slug | +| ↳ `attendees` | array | List of attendees | +| ↳ `name` | string | Attendee name | +| ↳ `email` | string | Attendee actual email address | +| ↳ `displayEmail` | string | Email shown publicly \(may differ from actual email\) | +| ↳ `timeZone` | string | Attendee timezone \(IANA format\) | +| ↳ `phoneNumber` | string | Attendee phone number | +| ↳ `language` | string | Attendee language preference \(ISO code\) | +| ↳ `absent` | boolean | Whether attendee was absent | +| ↳ `hosts` | array | List of hosts | +| ↳ `id` | number | Host user ID | +| ↳ `name` | string | Host display name | +| ↳ `email` | string | Host actual email address | +| ↳ `displayEmail` | string | Email shown publicly \(may differ from actual email\) | +| ↳ `username` | string | Host Cal.com username | +| ↳ `timeZone` | string | Host timezone \(IANA format\) | +| ↳ `id` | number | Numeric booking ID | +| ↳ `uid` | string | Unique identifier for the booking | +| ↳ `title` | string | Title of the booking | +| ↳ `cancellationReason` | string | Reason for cancellation if cancelled | +| ↳ `cancelledByEmail` | string | Email of person who cancelled the booking | +| ↳ `start` | string | Start time in ISO 8601 format | +| ↳ `end` | string | End time in ISO 8601 format | +| ↳ `duration` | number | Duration in minutes | +| ↳ `eventTypeId` | number | Event type ID | +| ↳ `location` | string | Location of the booking | +| ↳ `metadata` | json | Custom metadata attached to the booking \(dynamic key-value pairs\) | +| ↳ `createdAt` | string | When the booking was created | +| ↳ `status` | string | Booking status \(should be cancelled\) | + +### `calcom_reschedule_booking` + +Reschedule an existing booking to a new time + +#### Input + +| Parameter | Type | Required | Description | +| --------- | ---- | -------- | ----------- | +| `bookingUid` | string | Yes | Unique identifier \(UID\) of the booking to reschedule | +| `start` | string | Yes | New start time in UTC ISO 8601 format \(e.g., 2024-01-15T09:00:00Z\) | +| `reschedulingReason` | string | No | Reason for rescheduling the booking | + +#### Output + +| Parameter | Type | Description | +| --------- | ---- | ----------- | +| `status` | string | Response status | +| `data` | object | Rescheduled booking details | +| ↳ `eventType` | object | Event type details | +| ↳ `id` | number | Event type ID | +| ↳ `slug` | string | Event type slug | +| ↳ `attendees` | array | List of attendees | +| ↳ `name` | string | Attendee name | +| ↳ `email` | string | Attendee actual email address | +| ↳ `displayEmail` | string | Email shown publicly \(may differ from actual email\) | +| ↳ `timeZone` | string | Attendee timezone \(IANA format\) | +| ↳ `phoneNumber` | string | Attendee phone number | +| ↳ `language` | string | Attendee language preference \(ISO code\) | +| ↳ `absent` | boolean | Whether attendee was absent | +| ↳ `hosts` | array | List of hosts | +| ↳ `id` | number | Host user ID | +| ↳ `name` | string | Host display name | +| ↳ `email` | string | Host actual email address | +| ↳ `displayEmail` | string | Email shown publicly \(may differ from actual email\) | +| ↳ `username` | string | Host Cal.com username | +| ↳ `timeZone` | string | Host timezone \(IANA format\) | +| ↳ `id` | number | Numeric booking ID | +| ↳ `title` | string | Title of the booking | +| ↳ `status` | string | Booking status \(e.g., accepted, pending, cancelled\) | +| ↳ `reschedulingReason` | string | Reason for rescheduling if rescheduled | +| ↳ `rescheduledFromUid` | string | Original booking UID if this booking was rescheduled | +| ↳ `rescheduledByEmail` | string | Email of person who rescheduled the booking | +| ↳ `duration` | number | Duration in minutes | +| ↳ `eventTypeId` | number | Event type ID | +| ↳ `meetingUrl` | string | URL to join the meeting | +| ↳ `location` | string | Location of the booking | +| ↳ `guests` | array | Guest email addresses | +| ↳ `metadata` | json | Custom metadata attached to the booking \(dynamic key-value pairs\) | +| ↳ `icsUid` | string | ICS calendar UID | +| ↳ `createdAt` | string | When the booking was created | +| ↳ `uid` | string | Unique identifier for the new booking | +| ↳ `start` | string | New start time in ISO 8601 format | +| ↳ `end` | string | New end time in ISO 8601 format | + +### `calcom_confirm_booking` + +Confirm a pending booking that requires confirmation + +#### Input + +| Parameter | Type | Required | Description | +| --------- | ---- | -------- | ----------- | +| `bookingUid` | string | Yes | Unique identifier \(UID\) of the booking to confirm | + +#### Output + +| Parameter | Type | Description | +| --------- | ---- | ----------- | +| `status` | string | Response status | +| `data` | object | Confirmed booking details | +| ↳ `eventType` | object | Event type details | +| ↳ `id` | number | Event type ID | +| ↳ `slug` | string | Event type slug | +| ↳ `attendees` | array | List of attendees | +| ↳ `name` | string | Attendee name | +| ↳ `email` | string | Attendee actual email address | +| ↳ `displayEmail` | string | Email shown publicly \(may differ from actual email\) | +| ↳ `timeZone` | string | Attendee timezone \(IANA format\) | +| ↳ `phoneNumber` | string | Attendee phone number | +| ↳ `language` | string | Attendee language preference \(ISO code\) | +| ↳ `absent` | boolean | Whether attendee was absent | +| ↳ `hosts` | array | List of hosts | +| ↳ `id` | number | Host user ID | +| ↳ `name` | string | Host display name | +| ↳ `email` | string | Host actual email address | +| ↳ `displayEmail` | string | Email shown publicly \(may differ from actual email\) | +| ↳ `username` | string | Host Cal.com username | +| ↳ `timeZone` | string | Host timezone \(IANA format\) | +| ↳ `id` | number | Numeric booking ID | +| ↳ `uid` | string | Unique identifier for the booking | +| ↳ `title` | string | Title of the booking | +| ↳ `start` | string | Start time in ISO 8601 format | +| ↳ `end` | string | End time in ISO 8601 format | +| ↳ `duration` | number | Duration in minutes | +| ↳ `eventTypeId` | number | Event type ID | +| ↳ `meetingUrl` | string | URL to join the meeting | +| ↳ `location` | string | Location of the booking | +| ↳ `guests` | array | Guest email addresses | +| ↳ `metadata` | json | Custom metadata attached to the booking \(dynamic key-value pairs\) | +| ↳ `icsUid` | string | ICS calendar UID | +| ↳ `createdAt` | string | When the booking was created | +| ↳ `status` | string | Booking status \(should be accepted/confirmed\) | + +### `calcom_decline_booking` + +Decline a pending booking request + +#### Input + +| Parameter | Type | Required | Description | +| --------- | ---- | -------- | ----------- | +| `bookingUid` | string | Yes | Unique identifier \(UID\) of the booking to decline | +| `reason` | string | No | Reason for declining the booking | + +#### Output + +| Parameter | Type | Description | +| --------- | ---- | ----------- | +| `status` | string | Response status | +| `data` | object | Declined booking details | +| ↳ `eventType` | object | Event type details | +| ↳ `id` | number | Event type ID | +| ↳ `slug` | string | Event type slug | +| ↳ `attendees` | array | List of attendees | +| ↳ `name` | string | Attendee name | +| ↳ `email` | string | Attendee actual email address | +| ↳ `displayEmail` | string | Email shown publicly \(may differ from actual email\) | +| ↳ `timeZone` | string | Attendee timezone \(IANA format\) | +| ↳ `phoneNumber` | string | Attendee phone number | +| ↳ `language` | string | Attendee language preference \(ISO code\) | +| ↳ `absent` | boolean | Whether attendee was absent | +| ↳ `hosts` | array | List of hosts | +| ↳ `id` | number | Host user ID | +| ↳ `name` | string | Host display name | +| ↳ `email` | string | Host actual email address | +| ↳ `displayEmail` | string | Email shown publicly \(may differ from actual email\) | +| ↳ `username` | string | Host Cal.com username | +| ↳ `timeZone` | string | Host timezone \(IANA format\) | +| ↳ `id` | number | Numeric booking ID | +| ↳ `uid` | string | Unique identifier for the booking | +| ↳ `title` | string | Title of the booking | +| ↳ `cancellationReason` | string | Reason for cancellation if cancelled | +| ↳ `start` | string | Start time in ISO 8601 format | +| ↳ `end` | string | End time in ISO 8601 format | +| ↳ `duration` | number | Duration in minutes | +| ↳ `eventTypeId` | number | Event type ID | +| ↳ `location` | string | Location of the booking | +| ↳ `metadata` | json | Custom metadata attached to the booking \(dynamic key-value pairs\) | +| ↳ `createdAt` | string | When the booking was created | +| ↳ `status` | string | Booking status \(should be cancelled/rejected\) | + +### `calcom_create_event_type` + +Create a new event type in Cal.com + +#### Input + +| Parameter | Type | Required | Description | +| --------- | ---- | -------- | ----------- | +| `title` | string | Yes | Title of the event type | +| `slug` | string | Yes | Unique slug for the event type URL | +| `lengthInMinutes` | number | Yes | Duration of the event in minutes | +| `description` | string | No | Description of the event type | +| `slotInterval` | number | No | Interval between available booking slots in minutes | +| `minimumBookingNotice` | number | No | Minimum notice required before booking in minutes | +| `beforeEventBuffer` | number | No | Buffer time before the event in minutes | +| `afterEventBuffer` | number | No | Buffer time after the event in minutes | +| `scheduleId` | number | No | ID of the schedule to use for availability | +| `disableGuests` | boolean | No | Whether to disable guests from being added to bookings | + +#### Output + +| Parameter | Type | Description | +| --------- | ---- | ----------- | +| `status` | string | Response status | +| `data` | object | Created event type details | +| ↳ `id` | number | Event type ID | +| ↳ `title` | string | Event type title | +| ↳ `slug` | string | Event type slug | +| ↳ `description` | string | Event type description | +| ↳ `lengthInMinutes` | number | Duration in minutes | +| ↳ `slotInterval` | number | Slot interval in minutes | +| ↳ `minimumBookingNotice` | number | Minimum booking notice in minutes | +| ↳ `beforeEventBuffer` | number | Buffer before event in minutes | +| ↳ `afterEventBuffer` | number | Buffer after event in minutes | +| ↳ `scheduleId` | number | Schedule ID | +| ↳ `disableGuests` | boolean | Whether guests are disabled | +| ↳ `createdAt` | string | ISO timestamp of creation | +| ↳ `updatedAt` | string | ISO timestamp of last update | + +### `calcom_get_event_type` + +Get detailed information about a specific event type + +#### Input + +| Parameter | Type | Required | Description | +| --------- | ---- | -------- | ----------- | +| `eventTypeId` | number | Yes | Event type ID to retrieve | + +#### Output + +| Parameter | Type | Description | +| --------- | ---- | ----------- | +| `status` | string | Response status | +| `data` | object | Event type details | +| ↳ `id` | number | Event type ID | +| ↳ `title` | string | Event type title | +| ↳ `slug` | string | Event type slug | +| ↳ `description` | string | Event type description | +| ↳ `lengthInMinutes` | number | Duration in minutes | +| ↳ `slotInterval` | number | Slot interval in minutes | +| ↳ `minimumBookingNotice` | number | Minimum booking notice in minutes | +| ↳ `beforeEventBuffer` | number | Buffer before event in minutes | +| ↳ `afterEventBuffer` | number | Buffer after event in minutes | +| ↳ `scheduleId` | number | Schedule ID | +| ↳ `disableGuests` | boolean | Whether guests are disabled | +| ↳ `createdAt` | string | ISO timestamp of creation | +| ↳ `updatedAt` | string | ISO timestamp of last update | + +### `calcom_list_event_types` + +Retrieve a list of all event types + +#### Input + +| Parameter | Type | Required | Description | +| --------- | ---- | -------- | ----------- | +| `sortCreatedAt` | string | No | Sort by creation date: "asc" or "desc" | + +#### Output + +| Parameter | Type | Description | +| --------- | ---- | ----------- | +| `status` | string | Response status | +| `data` | array | Array of event types | +| ↳ `id` | number | Event type ID | +| ↳ `title` | string | Event type title | +| ↳ `slug` | string | Event type slug | +| ↳ `description` | string | Event type description | +| ↳ `lengthInMinutes` | number | Duration in minutes | +| ↳ `slotInterval` | number | Slot interval in minutes | +| ↳ `minimumBookingNotice` | number | Minimum booking notice in minutes | +| ↳ `beforeEventBuffer` | number | Buffer before event in minutes | +| ↳ `afterEventBuffer` | number | Buffer after event in minutes | +| ↳ `scheduleId` | number | Schedule ID | +| ↳ `disableGuests` | boolean | Whether guests are disabled | +| ↳ `createdAt` | string | ISO timestamp of creation | +| ↳ `updatedAt` | string | ISO timestamp of last update | + +### `calcom_update_event_type` + +Update an existing event type in Cal.com + +#### Input + +| Parameter | Type | Required | Description | +| --------- | ---- | -------- | ----------- | +| `eventTypeId` | number | Yes | Event type ID to update | +| `title` | string | No | Title of the event type | +| `slug` | string | No | Unique slug for the event type URL | +| `lengthInMinutes` | number | No | Duration of the event in minutes | +| `description` | string | No | Description of the event type | +| `slotInterval` | number | No | Interval between available booking slots in minutes | +| `minimumBookingNotice` | number | No | Minimum notice required before booking in minutes | +| `beforeEventBuffer` | number | No | Buffer time before the event in minutes | +| `afterEventBuffer` | number | No | Buffer time after the event in minutes | +| `scheduleId` | number | No | ID of the schedule to use for availability | +| `disableGuests` | boolean | No | Whether to disable guests from being added to bookings | + +#### Output + +| Parameter | Type | Description | +| --------- | ---- | ----------- | +| `status` | string | Response status | +| `data` | object | Updated event type details | +| ↳ `id` | number | Event type ID | +| ↳ `title` | string | Event type title | +| ↳ `slug` | string | Event type slug | +| ↳ `description` | string | Event type description | +| ↳ `lengthInMinutes` | number | Duration in minutes | +| ↳ `slotInterval` | number | Slot interval in minutes | +| ↳ `minimumBookingNotice` | number | Minimum booking notice in minutes | +| ↳ `beforeEventBuffer` | number | Buffer before event in minutes | +| ↳ `afterEventBuffer` | number | Buffer after event in minutes | +| ↳ `scheduleId` | number | Schedule ID | +| ↳ `disableGuests` | boolean | Whether guests are disabled | +| ↳ `createdAt` | string | ISO timestamp of creation | +| ↳ `updatedAt` | string | ISO timestamp of last update | + +### `calcom_delete_event_type` + +Delete an event type from Cal.com + +#### Input + +| Parameter | Type | Required | Description | +| --------- | ---- | -------- | ----------- | +| `eventTypeId` | number | Yes | Event type ID to delete | + +#### Output + +| Parameter | Type | Description | +| --------- | ---- | ----------- | +| `status` | string | Response status | +| `data` | object | Deleted event type details | +| ↳ `id` | number | Event type ID | +| ↳ `lengthInMinutes` | number | Duration in minutes | +| ↳ `title` | string | Event type title | +| ↳ `slug` | string | Event type slug | + +### `calcom_create_schedule` + +Create a new availability schedule in Cal.com + +#### Input + +| Parameter | Type | Required | Description | +| --------- | ---- | -------- | ----------- | +| `name` | string | Yes | Name of the schedule | +| `timeZone` | string | Yes | Timezone for the schedule \(e.g., America/New_York\) | +| `isDefault` | boolean | Yes | Whether this schedule should be the default | +| `availability` | array | No | Availability intervals for the schedule | +| `items` | object | No | Availability interval | +| `properties` | array | No | Days of the week \(Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday\) | +| `days` | array | No | Days of the week \(Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday\) | +| `startTime` | string | No | Start time in HH:MM format | +| `endTime` | string | No | End time in HH:MM format | + +#### Output + +| Parameter | Type | Description | +| --------- | ---- | ----------- | +| `status` | string | Response status | +| `data` | object | Created schedule data | +| ↳ `id` | number | Schedule ID | +| ↳ `ownerId` | number | Owner user ID | +| ↳ `name` | string | Schedule name | +| ↳ `timeZone` | string | Timezone \(e.g., America/New_York\) | +| ↳ `isDefault` | boolean | Whether this is the default schedule | +| ↳ `availability` | array | Availability windows | +| ↳ `days` | array | Days of the week \(Monday, Tuesday, etc.\) | +| ↳ `startTime` | string | Start time in HH:MM format | +| ↳ `endTime` | string | End time in HH:MM format | +| ↳ `overrides` | array | Date-specific availability overrides | +| ↳ `date` | string | Date in YYYY-MM-DD format | +| ↳ `startTime` | string | Start time in HH:MM format | +| ↳ `endTime` | string | End time in HH:MM format | + +### `calcom_get_schedule` + +Get a specific schedule by ID from Cal.com + +#### Input + +| Parameter | Type | Required | Description | +| --------- | ---- | -------- | ----------- | +| `scheduleId` | string | Yes | ID of the schedule to retrieve | + +#### Output + +| Parameter | Type | Description | +| --------- | ---- | ----------- | +| `status` | string | Response status | +| `data` | object | Schedule data | +| ↳ `id` | number | Schedule ID | +| ↳ `ownerId` | number | Owner user ID | +| ↳ `name` | string | Schedule name | +| ↳ `timeZone` | string | Timezone \(e.g., America/New_York\) | +| ↳ `isDefault` | boolean | Whether this is the default schedule | +| ↳ `availability` | array | Availability windows | +| ↳ `days` | array | Days of the week \(Monday, Tuesday, etc.\) | +| ↳ `startTime` | string | Start time in HH:MM format | +| ↳ `endTime` | string | End time in HH:MM format | +| ↳ `overrides` | array | Date-specific availability overrides | +| ↳ `date` | string | Date in YYYY-MM-DD format | +| ↳ `startTime` | string | Start time in HH:MM format | +| ↳ `endTime` | string | End time in HH:MM format | + +### `calcom_list_schedules` + +List all availability schedules from Cal.com + +#### Input + +| Parameter | Type | Required | Description | +| --------- | ---- | -------- | ----------- | + +#### Output + +| Parameter | Type | Description | +| --------- | ---- | ----------- | +| `status` | string | Response status | +| `data` | array | Array of schedule objects | +| ↳ `id` | number | Schedule ID | +| ↳ `ownerId` | number | Owner user ID | +| ↳ `name` | string | Schedule name | +| ↳ `timeZone` | string | Timezone \(e.g., America/New_York\) | +| ↳ `isDefault` | boolean | Whether this is the default schedule | +| ↳ `availability` | array | Availability windows | +| ↳ `days` | array | Days of the week \(Monday, Tuesday, etc.\) | +| ↳ `startTime` | string | Start time in HH:MM format | +| ↳ `endTime` | string | End time in HH:MM format | +| ↳ `overrides` | array | Date-specific availability overrides | +| ↳ `date` | string | Date in YYYY-MM-DD format | +| ↳ `startTime` | string | Start time in HH:MM format | +| ↳ `endTime` | string | End time in HH:MM format | + +### `calcom_update_schedule` + +Update an existing schedule in Cal.com + +#### Input + +| Parameter | Type | Required | Description | +| --------- | ---- | -------- | ----------- | +| `scheduleId` | string | Yes | ID of the schedule to update | +| `name` | string | No | New name for the schedule | +| `timeZone` | string | No | New timezone for the schedule \(e.g., America/New_York\) | +| `isDefault` | boolean | No | Whether this schedule should be the default | +| `availability` | array | No | New availability intervals for the schedule | +| `items` | object | No | Availability interval | +| `properties` | array | No | Days of the week \(Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday\) | +| `days` | array | No | Days of the week \(Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday\) | +| `startTime` | string | No | Start time in HH:MM format | +| `endTime` | string | No | End time in HH:MM format | + +#### Output + +| Parameter | Type | Description | +| --------- | ---- | ----------- | +| `status` | string | Response status | +| `data` | object | Updated schedule data | +| ↳ `id` | number | Schedule ID | +| ↳ `ownerId` | number | Owner user ID | +| ↳ `name` | string | Schedule name | +| ↳ `timeZone` | string | Timezone \(e.g., America/New_York\) | +| ↳ `isDefault` | boolean | Whether this is the default schedule | +| ↳ `availability` | array | Availability windows | +| ↳ `days` | array | Days of the week \(Monday, Tuesday, etc.\) | +| ↳ `startTime` | string | Start time in HH:MM format | +| ↳ `endTime` | string | End time in HH:MM format | +| ↳ `overrides` | array | Date-specific availability overrides | +| ↳ `date` | string | Date in YYYY-MM-DD format | +| ↳ `startTime` | string | Start time in HH:MM format | +| ↳ `endTime` | string | End time in HH:MM format | + +### `calcom_delete_schedule` + +Delete a schedule from Cal.com + +#### Input + +| Parameter | Type | Required | Description | +| --------- | ---- | -------- | ----------- | +| `scheduleId` | string | Yes | ID of the schedule to delete | + +#### Output + +| Parameter | Type | Description | +| --------- | ---- | ----------- | +| `status` | string | Response status \(success or error\) | + +### `calcom_get_default_schedule` + +Get the default availability schedule from Cal.com + +#### Input + +| Parameter | Type | Required | Description | +| --------- | ---- | -------- | ----------- | + +#### Output + +| Parameter | Type | Description | +| --------- | ---- | ----------- | +| `status` | string | Response status | +| `data` | object | Default schedule data | +| ↳ `id` | number | Schedule ID | +| ↳ `ownerId` | number | Owner user ID | +| ↳ `name` | string | Schedule name | +| ↳ `timeZone` | string | Timezone \(e.g., America/New_York\) | +| ↳ `isDefault` | boolean | Whether this is the default schedule | +| ↳ `availability` | array | Availability windows | +| ↳ `days` | array | Days of the week \(Monday, Tuesday, etc.\) | +| ↳ `startTime` | string | Start time in HH:MM format | +| ↳ `endTime` | string | End time in HH:MM format | +| ↳ `overrides` | array | Date-specific availability overrides | +| ↳ `date` | string | Date in YYYY-MM-DD format | +| ↳ `startTime` | string | Start time in HH:MM format | +| ↳ `endTime` | string | End time in HH:MM format | + +### `calcom_get_slots` + +Get available booking slots for a Cal.com event type within a time range + +#### Input + +| Parameter | Type | Required | Description | +| --------- | ---- | -------- | ----------- | +| `start` | string | Yes | Start of time range in UTC ISO 8601 format \(e.g., 2024-01-15T00:00:00Z\) | +| `end` | string | Yes | End of time range in UTC ISO 8601 format \(e.g., 2024-01-22T00:00:00Z\) | +| `eventTypeId` | number | No | Event type ID for direct lookup | +| `eventTypeSlug` | string | No | Event type slug \(requires username to be set\) | +| `username` | string | No | Username for personal event types \(required when using eventTypeSlug\) | +| `timeZone` | string | No | Timezone for returned slots \(defaults to UTC\) | +| `duration` | number | No | Slot length in minutes | + +#### Output + +| Parameter | Type | Description | +| --------- | ---- | ----------- | +| `status` | string | Response status | +| `data` | json | Available time slots grouped by date \(YYYY-MM-DD keys\). Each date maps to an array of slot objects with start time, optional end time, and seated event info. | + + diff --git a/apps/docs/content/docs/en/tools/calendly.mdx b/apps/docs/content/docs/en/tools/calendly.mdx index 5ab2f318a..05d209666 100644 --- a/apps/docs/content/docs/en/tools/calendly.mdx +++ b/apps/docs/content/docs/en/tools/calendly.mdx @@ -47,16 +47,16 @@ Get information about the currently authenticated Calendly user | Parameter | Type | Description | | --------- | ---- | ----------- | | `resource` | object | Current user information | -| ↳ `uri` | string | Canonical reference to the user | -| ↳ `name` | string | User full name | -| ↳ `slug` | string | Unique identifier for the user in URLs | -| ↳ `email` | string | User email address | -| ↳ `scheduling_url` | string | URL to the user | -| ↳ `timezone` | string | User timezone | -| ↳ `avatar_url` | string | URL to user avatar image | -| ↳ `created_at` | string | ISO timestamp when user was created | -| ↳ `updated_at` | string | ISO timestamp when user was last updated | -| ↳ `current_organization` | string | URI of current organization | +| ↳ `uri` | string | Canonical reference to the user | +| ↳ `name` | string | User full name | +| ↳ `slug` | string | Unique identifier for the user in URLs | +| ↳ `email` | string | User email address | +| ↳ `scheduling_url` | string | URL to the user's scheduling page | +| ↳ `timezone` | string | User timezone | +| ↳ `avatar_url` | string | URL to user avatar image | +| ↳ `created_at` | string | ISO timestamp when user was created | +| ↳ `updated_at` | string | ISO timestamp when user was last updated | +| ↳ `current_organization` | string | URI of current organization | ### `calendly_list_event_types` @@ -82,7 +82,7 @@ Retrieve a list of all event types for a user or organization | ↳ `uri` | string | Canonical reference to the event type | | ↳ `name` | string | Event type name | | ↳ `active` | boolean | Whether the event type is active | -| ↳ `booking_method` | string | Booking method \(e.g., | +| ↳ `booking_method` | string | Booking method \(e.g., "round_robin_or_collect", "collective"\) | | ↳ `color` | string | Hex color code | | ↳ `created_at` | string | ISO timestamp of creation | | ↳ `description_html` | string | HTML formatted description | @@ -93,11 +93,11 @@ Retrieve a list of all event types for a user or organization | ↳ `type` | string | Event type classification | | ↳ `updated_at` | string | ISO timestamp of last update | | `pagination` | object | Pagination information | -| ↳ `count` | number | Number of results in this page | -| ↳ `next_page` | string | URL to next page \(if available\) | -| ↳ `previous_page` | string | URL to previous page \(if available\) | -| ↳ `next_page_token` | string | Token for next page | -| ↳ `previous_page_token` | string | Token for previous page | +| ↳ `count` | number | Number of results in this page | +| ↳ `next_page` | string | URL to next page \(if available\) | +| ↳ `previous_page` | string | URL to previous page \(if available\) | +| ↳ `next_page_token` | string | Token for next page | +| ↳ `previous_page_token` | string | Token for previous page | ### `calendly_get_event_type` @@ -115,26 +115,26 @@ Get detailed information about a specific event type | Parameter | Type | Description | | --------- | ---- | ----------- | | `resource` | object | Event type details | -| ↳ `uri` | string | Canonical reference to the event type | -| ↳ `name` | string | Event type name | -| ↳ `active` | boolean | Whether the event type is active | -| ↳ `booking_method` | string | Booking method | -| ↳ `color` | string | Hex color code | -| ↳ `created_at` | string | ISO timestamp of creation | -| ↳ `custom_questions` | array | Custom questions for invitees | -| ↳ `name` | string | Question text | -| ↳ `type` | string | Question type \(text, single_select, multi_select, etc.\) | -| ↳ `position` | number | Question order | -| ↳ `enabled` | boolean | Whether question is enabled | -| ↳ `required` | boolean | Whether question is required | -| ↳ `answer_choices` | array | Available answer choices | -| ↳ `description_html` | string | HTML formatted description | -| ↳ `description_plain` | string | Plain text description | -| ↳ `duration` | number | Duration in minutes | -| ↳ `scheduling_url` | string | URL to scheduling page | -| ↳ `slug` | string | Unique identifier for URLs | -| ↳ `type` | string | Event type classification | -| ↳ `updated_at` | string | ISO timestamp of last update | +| ↳ `uri` | string | Canonical reference to the event type | +| ↳ `name` | string | Event type name | +| ↳ `active` | boolean | Whether the event type is active | +| ↳ `booking_method` | string | Booking method | +| ↳ `color` | string | Hex color code | +| ↳ `created_at` | string | ISO timestamp of creation | +| ↳ `custom_questions` | array | Custom questions for invitees | +| ↳ `name` | string | Question text | +| ↳ `type` | string | Question type \(text, single_select, multi_select, etc.\) | +| ↳ `position` | number | Question order | +| ↳ `enabled` | boolean | Whether question is enabled | +| ↳ `required` | boolean | Whether question is required | +| ↳ `answer_choices` | array | Available answer choices | +| ↳ `description_html` | string | HTML formatted description | +| ↳ `description_plain` | string | Plain text description | +| ↳ `duration` | number | Duration in minutes | +| ↳ `scheduling_url` | string | URL to scheduling page | +| ↳ `slug` | string | Unique identifier for URLs | +| ↳ `type` | string | Event type classification | +| ↳ `updated_at` | string | ISO timestamp of last update | ### `calendly_list_scheduled_events` @@ -167,21 +167,21 @@ Retrieve a list of scheduled events for a user or organization | ↳ `end_time` | string | ISO timestamp of event end | | ↳ `event_type` | string | URI of the event type | | ↳ `location` | object | Event location details | -| ↳ `type` | string | Location type \(e.g., | -| ↳ `location` | string | Location description | -| ↳ `join_url` | string | URL to join online meeting \(if applicable\) | +| ↳ `type` | string | Location type \(e.g., "zoom", "google_meet", "physical"\) | +| ↳ `location` | string | Location description | +| ↳ `join_url` | string | URL to join online meeting \(if applicable\) | | ↳ `invitees_counter` | object | Invitee count information | -| ↳ `total` | number | Total number of invitees | -| ↳ `active` | number | Number of active invitees | -| ↳ `limit` | number | Maximum number of invitees | +| ↳ `total` | number | Total number of invitees | +| ↳ `active` | number | Number of active invitees | +| ↳ `limit` | number | Maximum number of invitees | | ↳ `created_at` | string | ISO timestamp of event creation | | ↳ `updated_at` | string | ISO timestamp of last update | | `pagination` | object | Pagination information | -| ↳ `count` | number | Number of results in this page | -| ↳ `next_page` | string | URL to next page \(if available\) | -| ↳ `previous_page` | string | URL to previous page \(if available\) | -| ↳ `next_page_token` | string | Token for next page | -| ↳ `previous_page_token` | string | Token for previous page | +| ↳ `count` | number | Number of results in this page | +| ↳ `next_page` | string | URL to next page \(if available\) | +| ↳ `previous_page` | string | URL to previous page \(if available\) | +| ↳ `next_page_token` | string | Token for next page | +| ↳ `previous_page_token` | string | Token for previous page | ### `calendly_get_scheduled_event` @@ -199,30 +199,30 @@ Get detailed information about a specific scheduled event | Parameter | Type | Description | | --------- | ---- | ----------- | | `resource` | object | Scheduled event details | -| ↳ `uri` | string | Canonical reference to the event | -| ↳ `name` | string | Event name | -| ↳ `status` | string | Event status \(active or canceled\) | -| ↳ `start_time` | string | ISO timestamp of event start | -| ↳ `end_time` | string | ISO timestamp of event end | -| ↳ `event_type` | string | URI of the event type | -| ↳ `location` | object | Event location details | -| ↳ `type` | string | Location type | -| ↳ `location` | string | Location description | -| ↳ `join_url` | string | URL to join online meeting | -| ↳ `invitees_counter` | object | Invitee count information | -| ↳ `total` | number | Total number of invitees | -| ↳ `active` | number | Number of active invitees | -| ↳ `limit` | number | Maximum number of invitees | -| ↳ `event_memberships` | array | Event hosts/members | -| ↳ `user` | string | User URI | -| ↳ `user_email` | string | User email | -| ↳ `user_name` | string | User name | -| ↳ `event_guests` | array | Additional guests | -| ↳ `email` | string | Guest email | -| ↳ `created_at` | string | When guest was added | -| ↳ `updated_at` | string | When guest info was updated | -| ↳ `created_at` | string | ISO timestamp of event creation | -| ↳ `updated_at` | string | ISO timestamp of last update | +| ↳ `uri` | string | Canonical reference to the event | +| ↳ `name` | string | Event name | +| ↳ `status` | string | Event status \(active or canceled\) | +| ↳ `start_time` | string | ISO timestamp of event start | +| ↳ `end_time` | string | ISO timestamp of event end | +| ↳ `event_type` | string | URI of the event type | +| ↳ `location` | object | Event location details | +| ↳ `type` | string | Location type | +| ↳ `location` | string | Location description | +| ↳ `join_url` | string | URL to join online meeting | +| ↳ `invitees_counter` | object | Invitee count information | +| ↳ `total` | number | Total number of invitees | +| ↳ `active` | number | Number of active invitees | +| ↳ `limit` | number | Maximum number of invitees | +| ↳ `event_memberships` | array | Event hosts/members | +| ↳ `user` | string | User URI | +| ↳ `user_email` | string | User email | +| ↳ `user_name` | string | User name | +| ↳ `event_guests` | array | Additional guests | +| ↳ `email` | string | Guest email | +| ↳ `created_at` | string | When guest was added | +| ↳ `updated_at` | string | When guest info was updated | +| ↳ `created_at` | string | ISO timestamp of event creation | +| ↳ `updated_at` | string | ISO timestamp of last update | ### `calendly_list_event_invitees` @@ -252,9 +252,9 @@ Retrieve a list of invitees for a scheduled event | ↳ `last_name` | string | Invitee last name | | ↳ `status` | string | Invitee status \(active or canceled\) | | ↳ `questions_and_answers` | array | Responses to custom questions | -| ↳ `question` | string | Question text | -| ↳ `answer` | string | Invitee answer | -| ↳ `position` | number | Question order | +| ↳ `question` | string | Question text | +| ↳ `answer` | string | Invitee answer | +| ↳ `position` | number | Question order | | ↳ `timezone` | string | Invitee timezone | | ↳ `event` | string | URI of the scheduled event | | ↳ `created_at` | string | ISO timestamp when invitee was created | @@ -263,11 +263,11 @@ Retrieve a list of invitees for a scheduled event | ↳ `reschedule_url` | string | URL to reschedule the booking | | ↳ `rescheduled` | boolean | Whether invitee rescheduled | | `pagination` | object | Pagination information | -| ↳ `count` | number | Number of results in this page | -| ↳ `next_page` | string | URL to next page \(if available\) | -| ↳ `previous_page` | string | URL to previous page \(if available\) | -| ↳ `next_page_token` | string | Token for next page | -| ↳ `previous_page_token` | string | Token for previous page | +| ↳ `count` | number | Number of results in this page | +| ↳ `next_page` | string | URL to next page \(if available\) | +| ↳ `previous_page` | string | URL to previous page \(if available\) | +| ↳ `next_page_token` | string | Token for next page | +| ↳ `previous_page_token` | string | Token for previous page | ### `calendly_cancel_event` @@ -286,9 +286,9 @@ Cancel a scheduled event | Parameter | Type | Description | | --------- | ---- | ----------- | | `resource` | object | Cancellation details | -| ↳ `canceler_type` | string | Type of canceler \(host or invitee\) | -| ↳ `canceled_by` | string | Name of person who canceled | -| ↳ `reason` | string | Cancellation reason | -| ↳ `created_at` | string | ISO timestamp when event was canceled | +| ↳ `canceler_type` | string | Type of canceler \(host or invitee\) | +| ↳ `canceled_by` | string | Name of person who canceled | +| ↳ `reason` | string | Cancellation reason | +| ↳ `created_at` | string | ISO timestamp when event was canceled | diff --git a/apps/docs/content/docs/en/tools/clay.mdx b/apps/docs/content/docs/en/tools/clay.mdx index 64a5e9df8..8b0651317 100644 --- a/apps/docs/content/docs/en/tools/clay.mdx +++ b/apps/docs/content/docs/en/tools/clay.mdx @@ -51,10 +51,10 @@ Populate Clay with data from a JSON file. Enables direct communication and notif | --------- | ---- | ----------- | | `data` | json | Response data from Clay webhook | | `metadata` | object | Webhook response metadata | -| ↳ `status` | number | HTTP status code | -| ↳ `statusText` | string | HTTP status text | -| ↳ `headers` | object | Response headers from Clay | -| ↳ `timestamp` | string | ISO timestamp when webhook was received | -| ↳ `contentType` | string | Content type of the response | +| ↳ `status` | number | HTTP status code | +| ↳ `statusText` | string | HTTP status text | +| ↳ `headers` | object | Response headers from Clay | +| ↳ `timestamp` | string | ISO timestamp when webhook was received | +| ↳ `contentType` | string | Content type of the response | diff --git a/apps/docs/content/docs/en/tools/clerk.mdx b/apps/docs/content/docs/en/tools/clerk.mdx index 909ec9ba6..8584c8a7b 100644 --- a/apps/docs/content/docs/en/tools/clerk.mdx +++ b/apps/docs/content/docs/en/tools/clerk.mdx @@ -67,11 +67,11 @@ List all users in your Clerk application with optional filtering and pagination | ↳ `primaryEmailAddressId` | string | Primary email address ID | | ↳ `primaryPhoneNumberId` | string | Primary phone number ID | | ↳ `emailAddresses` | array | User email addresses | -| ↳ `id` | string | Email address ID | -| ↳ `emailAddress` | string | Email address | +| ↳ `id` | string | Email address ID | +| ↳ `emailAddress` | string | Email address | | ↳ `phoneNumbers` | array | User phone numbers | -| ↳ `id` | string | Phone number ID | -| ↳ `phoneNumber` | string | Phone number | +| ↳ `id` | string | Phone number ID | +| ↳ `phoneNumber` | string | Phone number | | ↳ `externalId` | string | External system ID | | ↳ `passwordEnabled` | boolean | Whether password is enabled | | ↳ `twoFactorEnabled` | boolean | Whether 2FA is enabled | diff --git a/apps/docs/content/docs/en/tools/confluence.mdx b/apps/docs/content/docs/en/tools/confluence.mdx index 9de626872..c0d5834fe 100644 --- a/apps/docs/content/docs/en/tools/confluence.mdx +++ b/apps/docs/content/docs/en/tools/confluence.mdx @@ -140,7 +140,20 @@ Search for content across Confluence pages, blog posts, and other content. | Parameter | Type | Description | | --------- | ---- | ----------- | | `ts` | string | Timestamp of search | -| `results` | array | Search results | +| `results` | array | Array of search results | +| ↳ `id` | string | Unique content identifier | +| ↳ `title` | string | Content title | +| ↳ `type` | string | Content type \(e.g., page, blogpost, attachment, comment\) | +| ↳ `status` | string | Content status \(e.g., current\) | +| ↳ `url` | string | URL to view the content in Confluence | +| ↳ `excerpt` | string | Text excerpt matching the search query | +| ↳ `spaceKey` | string | Key of the space containing the content | +| ↳ `space` | object | Space information for the content | +| ↳ `id` | string | Space identifier | +| ↳ `key` | string | Space key | +| ↳ `name` | string | Space name | +| ↳ `lastModified` | string | ISO 8601 timestamp of last modification | +| ↳ `entityType` | string | Entity type identifier \(e.g., content, space\) | ### `confluence_create_comment` @@ -180,8 +193,25 @@ List all comments on a Confluence page. | Parameter | Type | Description | | --------- | ---- | ----------- | -| `ts` | string | Timestamp of retrieval | -| `comments` | array | List of comments | +| `ts` | string | ISO 8601 timestamp of the operation | +| `comments` | array | Array of Confluence comments | +| ↳ `id` | string | Unique comment identifier | +| ↳ `status` | string | Comment status \(e.g., current\) | +| ↳ `title` | string | Comment title | +| ↳ `pageId` | string | ID of the page the comment belongs to | +| ↳ `blogPostId` | string | ID of the blog post the comment belongs to | +| ↳ `parentCommentId` | string | ID of the parent comment | +| ↳ `body` | object | Comment body content | +| ↳ `value` | string | Comment body content | +| ↳ `representation` | string | Content representation format \(e.g., storage, view\) | +| ↳ `createdAt` | string | ISO 8601 timestamp when the comment was created | +| ↳ `authorId` | string | Account ID of the comment author | +| ↳ `version` | object | Comment version information | +| ↳ `number` | number | Version number | +| ↳ `message` | string | Version message | +| ↳ `minorEdit` | boolean | Whether this is a minor edit | +| ↳ `authorId` | string | Account ID of the version author | +| ↳ `createdAt` | string | ISO 8601 timestamp of version creation | ### `confluence_update_comment` @@ -268,8 +298,24 @@ List all attachments on a Confluence page. | Parameter | Type | Description | | --------- | ---- | ----------- | -| `ts` | string | Timestamp of retrieval | -| `attachments` | array | List of attachments | +| `ts` | string | ISO 8601 timestamp of the operation | +| `attachments` | array | Array of Confluence attachments | +| ↳ `id` | string | Unique attachment identifier \(prefixed with "att"\) | +| ↳ `title` | string | Attachment file name | +| ↳ `status` | string | Attachment status \(e.g., current, archived, trashed\) | +| ↳ `mediaType` | string | MIME type of the attachment | +| ↳ `fileSize` | number | File size in bytes | +| ↳ `downloadUrl` | string | URL to download the attachment | +| ↳ `webuiUrl` | string | URL to view the attachment in Confluence UI | +| ↳ `pageId` | string | ID of the page the attachment belongs to | +| ↳ `blogPostId` | string | ID of the blog post the attachment belongs to | +| ↳ `comment` | string | Comment/description of the attachment | +| ↳ `version` | object | Attachment version information | +| ↳ `number` | number | Version number | +| ↳ `message` | string | Version message | +| ↳ `minorEdit` | boolean | Whether this is a minor edit | +| ↳ `authorId` | string | Account ID of the version author | +| ↳ `createdAt` | string | ISO 8601 timestamp of version creation | ### `confluence_delete_attachment` @@ -308,7 +354,10 @@ List all labels on a Confluence page. | Parameter | Type | Description | | --------- | ---- | ----------- | | `ts` | string | Timestamp of retrieval | -| `labels` | array | List of labels | +| `labels` | array | Array of labels on the page | +| ↳ `id` | string | Unique label identifier | +| ↳ `name` | string | Label name | +| ↳ `prefix` | string | Label prefix/type \(e.g., global, my, team\) | ### `confluence_get_space` @@ -350,7 +399,18 @@ List all Confluence spaces accessible to the user. | Parameter | Type | Description | | --------- | ---- | ----------- | -| `ts` | string | Timestamp of retrieval | -| `spaces` | array | List of spaces | +| `ts` | string | ISO 8601 timestamp of the operation | +| `spaces` | array | Array of Confluence spaces | +| ↳ `id` | string | Unique space identifier | +| ↳ `key` | string | Space key \(short identifier used in URLs\) | +| ↳ `name` | string | Space name | +| ↳ `type` | string | Space type \(e.g., global, personal\) | +| ↳ `status` | string | Space status \(e.g., current, archived\) | +| ↳ `authorId` | string | Account ID of the space creator | +| ↳ `createdAt` | string | ISO 8601 timestamp when the space was created | +| ↳ `homepageId` | string | ID of the space homepage | +| ↳ `description` | object | Space description | +| ↳ `value` | string | Description text content | +| ↳ `representation` | string | Content representation format \(e.g., plain, view, storage\) | diff --git a/apps/docs/content/docs/en/tools/datadog.mdx b/apps/docs/content/docs/en/tools/datadog.mdx index 15fd9838d..4ae3533c4 100644 --- a/apps/docs/content/docs/en/tools/datadog.mdx +++ b/apps/docs/content/docs/en/tools/datadog.mdx @@ -99,15 +99,15 @@ Post an event to the Datadog event stream. Use for deployment notifications, ale | Parameter | Type | Description | | --------- | ---- | ----------- | | `event` | object | The created event details | -| ↳ `id` | number | Event ID | -| ↳ `title` | string | Event title | -| ↳ `text` | string | Event text | -| ↳ `date_happened` | number | Unix timestamp when event occurred | -| ↳ `priority` | string | Event priority | -| ↳ `alert_type` | string | Alert type | -| ↳ `host` | string | Associated host | -| ↳ `tags` | array | Event tags | -| ↳ `url` | string | URL to view the event in Datadog | +| ↳ `id` | number | Event ID | +| ↳ `title` | string | Event title | +| ↳ `text` | string | Event text | +| ↳ `date_happened` | number | Unix timestamp when event occurred | +| ↳ `priority` | string | Event priority | +| ↳ `alert_type` | string | Alert type | +| ↳ `host` | string | Associated host | +| ↳ `tags` | array | Event tags | +| ↳ `url` | string | URL to view the event in Datadog | ### `datadog_create_monitor` @@ -133,16 +133,16 @@ Create a new monitor/alert in Datadog. Monitors can track metrics, service check | Parameter | Type | Description | | --------- | ---- | ----------- | | `monitor` | object | The created monitor details | -| ↳ `id` | number | Monitor ID | -| ↳ `name` | string | Monitor name | -| ↳ `type` | string | Monitor type | -| ↳ `query` | string | Monitor query | -| ↳ `message` | string | Notification message | -| ↳ `tags` | array | Monitor tags | -| ↳ `priority` | number | Monitor priority | -| ↳ `overall_state` | string | Current monitor state | -| ↳ `created` | string | Creation timestamp | -| ↳ `modified` | string | Last modification timestamp | +| ↳ `id` | number | Monitor ID | +| ↳ `name` | string | Monitor name | +| ↳ `type` | string | Monitor type | +| ↳ `query` | string | Monitor query | +| ↳ `message` | string | Notification message | +| ↳ `tags` | array | Monitor tags | +| ↳ `priority` | number | Monitor priority | +| ↳ `overall_state` | string | Current monitor state | +| ↳ `created` | string | Creation timestamp | +| ↳ `modified` | string | Last modification timestamp | ### `datadog_get_monitor` @@ -164,16 +164,16 @@ Retrieve details of a specific monitor by ID. | Parameter | Type | Description | | --------- | ---- | ----------- | | `monitor` | object | The monitor details | -| ↳ `id` | number | Monitor ID | -| ↳ `name` | string | Monitor name | -| ↳ `type` | string | Monitor type | -| ↳ `query` | string | Monitor query | -| ↳ `message` | string | Notification message | -| ↳ `tags` | array | Monitor tags | -| ↳ `priority` | number | Monitor priority | -| ↳ `overall_state` | string | Current monitor state | -| ↳ `created` | string | Creation timestamp | -| ↳ `modified` | string | Last modification timestamp | +| ↳ `id` | number | Monitor ID | +| ↳ `name` | string | Monitor name | +| ↳ `type` | string | Monitor type | +| ↳ `query` | string | Monitor query | +| ↳ `message` | string | Notification message | +| ↳ `tags` | array | Monitor tags | +| ↳ `priority` | number | Monitor priority | +| ↳ `overall_state` | string | Current monitor state | +| ↳ `created` | string | Creation timestamp | +| ↳ `modified` | string | Last modification timestamp | ### `datadog_list_monitors` @@ -252,11 +252,11 @@ Search and retrieve logs from Datadog. Use for troubleshooting, analysis, or mon | `logs` | array | List of log entries | | ↳ `id` | string | Log ID | | ↳ `content` | object | Log content | -| ↳ `timestamp` | string | Log timestamp | -| ↳ `host` | string | Host name | -| ↳ `service` | string | Service name | -| ↳ `message` | string | Log message | -| ↳ `status` | string | Log status/level | +| ↳ `timestamp` | string | Log timestamp | +| ↳ `host` | string | Host name | +| ↳ `service` | string | Service name | +| ↳ `message` | string | Log message | +| ↳ `status` | string | Log status/level | | `nextLogId` | string | Cursor for pagination | ### `datadog_send_logs` @@ -302,12 +302,12 @@ Schedule a downtime to suppress monitor notifications during maintenance windows | Parameter | Type | Description | | --------- | ---- | ----------- | | `downtime` | object | The created downtime details | -| ↳ `id` | number | Downtime ID | -| ↳ `scope` | array | Downtime scope | -| ↳ `message` | string | Downtime message | -| ↳ `start` | number | Start time \(Unix timestamp\) | -| ↳ `end` | number | End time \(Unix timestamp\) | -| ↳ `active` | boolean | Whether downtime is currently active | +| ↳ `id` | number | Downtime ID | +| ↳ `scope` | array | Downtime scope | +| ↳ `message` | string | Downtime message | +| ↳ `start` | number | Start time \(Unix timestamp\) | +| ↳ `end` | number | End time \(Unix timestamp\) | +| ↳ `active` | boolean | Whether downtime is currently active | ### `datadog_list_downtimes` diff --git a/apps/docs/content/docs/en/tools/discord.mdx b/apps/docs/content/docs/en/tools/discord.mdx index 47fde07ef..13f2610f2 100644 --- a/apps/docs/content/docs/en/tools/discord.mdx +++ b/apps/docs/content/docs/en/tools/discord.mdx @@ -64,21 +64,21 @@ Send a message to a Discord channel | --------- | ---- | ----------- | | `message` | string | Success or error message | | `data` | object | Discord message data | -| ↳ `id` | string | Message ID | -| ↳ `content` | string | Message content | -| ↳ `channel_id` | string | Channel ID where message was sent | -| ↳ `author` | object | Message author information | -| ↳ `id` | string | Author user ID | -| ↳ `username` | string | Author username | -| ↳ `avatar` | string | Author avatar hash | -| ↳ `bot` | boolean | Whether author is a bot | -| ↳ `timestamp` | string | Message timestamp | -| ↳ `edited_timestamp` | string | Message edited timestamp | -| ↳ `embeds` | array | Message embeds | -| ↳ `attachments` | array | Message attachments | -| ↳ `mentions` | array | User mentions in message | -| ↳ `mention_roles` | array | Role mentions in message | -| ↳ `mention_everyone` | boolean | Whether message mentions everyone | +| ↳ `id` | string | Message ID | +| ↳ `content` | string | Message content | +| ↳ `channel_id` | string | Channel ID where message was sent | +| ↳ `author` | object | Message author information | +| ↳ `id` | string | Author user ID | +| ↳ `username` | string | Author username | +| ↳ `avatar` | string | Author avatar hash | +| ↳ `bot` | boolean | Whether author is a bot | +| ↳ `timestamp` | string | Message timestamp | +| ↳ `edited_timestamp` | string | Message edited timestamp | +| ↳ `embeds` | array | Message embeds | +| ↳ `attachments` | array | Message attachments | +| ↳ `mentions` | array | User mentions in message | +| ↳ `mention_roles` | array | Role mentions in message | +| ↳ `mention_everyone` | boolean | Whether message mentions everyone | ### `discord_get_messages` @@ -98,23 +98,23 @@ Retrieve messages from a Discord channel | --------- | ---- | ----------- | | `message` | string | Success or error message | | `data` | object | Container for messages data | -| ↳ `messages` | array | Array of Discord messages with full metadata | -| ↳ `id` | string | Message ID | -| ↳ `content` | string | Message content | +| ↳ `messages` | array | Array of Discord messages with full metadata | +| ↳ `id` | string | Message ID | +| ↳ `content` | string | Message content | +| ↳ `channel_id` | string | Channel ID | +| ↳ `author` | object | Message author information | +| ↳ `id` | string | Author user ID | +| ↳ `username` | string | Author username | +| ↳ `avatar` | string | Author avatar hash | +| ↳ `bot` | boolean | Whether author is a bot | +| ↳ `timestamp` | string | Message timestamp | +| ↳ `edited_timestamp` | string | Message edited timestamp | +| ↳ `embeds` | array | Message embeds | +| ↳ `attachments` | array | Message attachments | +| ↳ `mentions` | array | User mentions in message | +| ↳ `mention_roles` | array | Role mentions in message | +| ↳ `mention_everyone` | boolean | Whether message mentions everyone | | ↳ `channel_id` | string | Channel ID | -| ↳ `author` | object | Message author information | -| ↳ `id` | string | Author user ID | -| ↳ `username` | string | Author username | -| ↳ `avatar` | string | Author avatar hash | -| ↳ `bot` | boolean | Whether author is a bot | -| ↳ `timestamp` | string | Message timestamp | -| ↳ `edited_timestamp` | string | Message edited timestamp | -| ↳ `embeds` | array | Message embeds | -| ↳ `attachments` | array | Message attachments | -| ↳ `mentions` | array | User mentions in message | -| ↳ `mention_roles` | array | Role mentions in message | -| ↳ `mention_everyone` | boolean | Whether message mentions everyone | -| ↳ `channel_id` | string | Channel ID | ### `discord_get_server` @@ -133,14 +133,14 @@ Retrieve information about a Discord server (guild) | --------- | ---- | ----------- | | `message` | string | Success or error message | | `data` | object | Discord server \(guild\) information | -| ↳ `id` | string | Server ID | -| ↳ `name` | string | Server name | -| ↳ `icon` | string | Server icon hash | -| ↳ `description` | string | Server description | -| ↳ `owner_id` | string | Server owner user ID | -| ↳ `roles` | array | Server roles | -| ↳ `channels` | array | Server channels | -| ↳ `member_count` | number | Number of members in server | +| ↳ `id` | string | Server ID | +| ↳ `name` | string | Server name | +| ↳ `icon` | string | Server icon hash | +| ↳ `description` | string | Server description | +| ↳ `owner_id` | string | Server owner user ID | +| ↳ `roles` | array | Server roles | +| ↳ `channels` | array | Server channels | +| ↳ `member_count` | number | Number of members in server | ### `discord_get_user` @@ -159,14 +159,14 @@ Retrieve information about a Discord user | --------- | ---- | ----------- | | `message` | string | Success or error message | | `data` | object | Discord user information | -| ↳ `id` | string | User ID | -| ↳ `username` | string | Username | -| ↳ `discriminator` | string | User discriminator \(4-digit number\) | -| ↳ `avatar` | string | User avatar hash | -| ↳ `bot` | boolean | Whether user is a bot | -| ↳ `system` | boolean | Whether user is a system user | -| ↳ `email` | string | User email \(if available\) | -| ↳ `verified` | boolean | Whether user email is verified | +| ↳ `id` | string | User ID | +| ↳ `username` | string | Username | +| ↳ `discriminator` | string | User discriminator \(4-digit number\) | +| ↳ `avatar` | string | User avatar hash | +| ↳ `bot` | boolean | Whether user is a bot | +| ↳ `system` | boolean | Whether user is a system user | +| ↳ `email` | string | User email \(if available\) | +| ↳ `verified` | boolean | Whether user email is verified | ### `discord_edit_message` @@ -188,10 +188,10 @@ Edit an existing message in a Discord channel | --------- | ---- | ----------- | | `message` | string | Success or error message | | `data` | object | Updated Discord message data | -| ↳ `id` | string | Message ID | -| ↳ `content` | string | Updated message content | -| ↳ `channel_id` | string | Channel ID | -| ↳ `edited_timestamp` | string | Message edited timestamp | +| ↳ `id` | string | Message ID | +| ↳ `content` | string | Updated message content | +| ↳ `channel_id` | string | Channel ID | +| ↳ `edited_timestamp` | string | Message edited timestamp | ### `discord_delete_message` @@ -312,11 +312,11 @@ Create a thread in a Discord channel | --------- | ---- | ----------- | | `message` | string | Success or error message | | `data` | object | Created thread data | -| ↳ `id` | string | Thread ID | -| ↳ `name` | string | Thread name | -| ↳ `type` | number | Thread channel type | -| ↳ `guild_id` | string | Server ID | -| ↳ `parent_id` | string | Parent channel ID | +| ↳ `id` | string | Thread ID | +| ↳ `name` | string | Thread name | +| ↳ `type` | number | Thread channel type | +| ↳ `guild_id` | string | Server ID | +| ↳ `parent_id` | string | Parent channel ID | ### `discord_join_thread` @@ -373,8 +373,8 @@ Archive or unarchive a thread in Discord | --------- | ---- | ----------- | | `message` | string | Success or error message | | `data` | object | Updated thread data | -| ↳ `id` | string | Thread ID | -| ↳ `archived` | boolean | Whether thread is archived | +| ↳ `id` | string | Thread ID | +| ↳ `archived` | boolean | Whether thread is archived | ### `discord_create_channel` @@ -397,10 +397,10 @@ Create a new channel in a Discord server | --------- | ---- | ----------- | | `message` | string | Success or error message | | `data` | object | Created channel data | -| ↳ `id` | string | Channel ID | -| ↳ `name` | string | Channel name | -| ↳ `type` | number | Channel type | -| ↳ `guild_id` | string | Server ID | +| ↳ `id` | string | Channel ID | +| ↳ `name` | string | Channel name | +| ↳ `type` | number | Channel type | +| ↳ `guild_id` | string | Server ID | ### `discord_update_channel` @@ -422,10 +422,10 @@ Update a Discord channel | --------- | ---- | ----------- | | `message` | string | Success or error message | | `data` | object | Updated channel data | -| ↳ `id` | string | Channel ID | -| ↳ `name` | string | Channel name | -| ↳ `type` | number | Channel type | -| ↳ `topic` | string | Channel topic | +| ↳ `id` | string | Channel ID | +| ↳ `name` | string | Channel name | +| ↳ `type` | number | Channel type | +| ↳ `topic` | string | Channel topic | ### `discord_delete_channel` @@ -463,11 +463,11 @@ Get information about a Discord channel | --------- | ---- | ----------- | | `message` | string | Success or error message | | `data` | object | Channel data | -| ↳ `id` | string | Channel ID | -| ↳ `name` | string | Channel name | -| ↳ `type` | number | Channel type | -| ↳ `topic` | string | Channel topic | -| ↳ `guild_id` | string | Server ID | +| ↳ `id` | string | Channel ID | +| ↳ `name` | string | Channel name | +| ↳ `type` | number | Channel type | +| ↳ `topic` | string | Channel topic | +| ↳ `guild_id` | string | Server ID | ### `discord_create_role` @@ -490,11 +490,11 @@ Create a new role in a Discord server | --------- | ---- | ----------- | | `message` | string | Success or error message | | `data` | object | Created role data | -| ↳ `id` | string | Role ID | -| ↳ `name` | string | Role name | -| ↳ `color` | number | Role color | -| ↳ `hoist` | boolean | Whether role is hoisted | -| ↳ `mentionable` | boolean | Whether role is mentionable | +| ↳ `id` | string | Role ID | +| ↳ `name` | string | Role name | +| ↳ `color` | number | Role color | +| ↳ `hoist` | boolean | Whether role is hoisted | +| ↳ `mentionable` | boolean | Whether role is mentionable | ### `discord_update_role` @@ -518,9 +518,9 @@ Update a role in a Discord server | --------- | ---- | ----------- | | `message` | string | Success or error message | | `data` | object | Updated role data | -| ↳ `id` | string | Role ID | -| ↳ `name` | string | Role name | -| ↳ `color` | number | Role color | +| ↳ `id` | string | Role ID | +| ↳ `name` | string | Role name | +| ↳ `color` | number | Role color | ### `discord_delete_role` @@ -654,13 +654,13 @@ Get information about a member in a Discord server | --------- | ---- | ----------- | | `message` | string | Success or error message | | `data` | object | Member data | -| ↳ `user` | object | User information | -| ↳ `id` | string | User ID | -| ↳ `username` | string | Username | -| ↳ `avatar` | string | Avatar hash | -| ↳ `nick` | string | Server nickname | -| ↳ `roles` | array | Array of role IDs | -| ↳ `joined_at` | string | When the member joined | +| ↳ `user` | object | User information | +| ↳ `id` | string | User ID | +| ↳ `username` | string | Username | +| ↳ `avatar` | string | Avatar hash | +| ↳ `nick` | string | Server nickname | +| ↳ `roles` | array | Array of role IDs | +| ↳ `joined_at` | string | When the member joined | ### `discord_update_member` @@ -683,9 +683,9 @@ Update a member in a Discord server (e.g., change nickname) | --------- | ---- | ----------- | | `message` | string | Success or error message | | `data` | object | Updated member data | -| ↳ `nick` | string | Server nickname | -| ↳ `mute` | boolean | Voice mute status | -| ↳ `deaf` | boolean | Voice deaf status | +| ↳ `nick` | string | Server nickname | +| ↳ `mute` | boolean | Voice mute status | +| ↳ `deaf` | boolean | Voice deaf status | ### `discord_create_invite` @@ -708,11 +708,11 @@ Create an invite link for a Discord channel | --------- | ---- | ----------- | | `message` | string | Success or error message | | `data` | object | Created invite data | -| ↳ `code` | string | Invite code | -| ↳ `url` | string | Full invite URL | -| ↳ `max_age` | number | Max age in seconds | -| ↳ `max_uses` | number | Max uses | -| ↳ `temporary` | boolean | Whether temporary | +| ↳ `code` | string | Invite code | +| ↳ `url` | string | Full invite URL | +| ↳ `max_age` | number | Max age in seconds | +| ↳ `max_uses` | number | Max uses | +| ↳ `temporary` | boolean | Whether temporary | ### `discord_get_invite` @@ -732,11 +732,11 @@ Get information about a Discord invite | --------- | ---- | ----------- | | `message` | string | Success or error message | | `data` | object | Invite data | -| ↳ `code` | string | Invite code | -| ↳ `guild` | object | Server information | -| ↳ `channel` | object | Channel information | -| ↳ `approximate_member_count` | number | Approximate member count | -| ↳ `approximate_presence_count` | number | Approximate online count | +| ↳ `code` | string | Invite code | +| ↳ `guild` | object | Server information | +| ↳ `channel` | object | Channel information | +| ↳ `approximate_member_count` | number | Approximate member count | +| ↳ `approximate_presence_count` | number | Approximate online count | ### `discord_delete_invite` @@ -775,11 +775,11 @@ Create a webhook in a Discord channel | --------- | ---- | ----------- | | `message` | string | Success or error message | | `data` | object | Created webhook data | -| ↳ `id` | string | Webhook ID | -| ↳ `name` | string | Webhook name | -| ↳ `token` | string | Webhook token | -| ↳ `url` | string | Webhook URL | -| ↳ `channel_id` | string | Channel ID | +| ↳ `id` | string | Webhook ID | +| ↳ `name` | string | Webhook name | +| ↳ `token` | string | Webhook token | +| ↳ `url` | string | Webhook URL | +| ↳ `channel_id` | string | Channel ID | ### `discord_execute_webhook` @@ -801,10 +801,10 @@ Execute a Discord webhook to send a message | --------- | ---- | ----------- | | `message` | string | Success or error message | | `data` | object | Message sent via webhook | -| ↳ `id` | string | Message ID | -| ↳ `content` | string | Message content | -| ↳ `channel_id` | string | Channel ID | -| ↳ `timestamp` | string | Message timestamp | +| ↳ `id` | string | Message ID | +| ↳ `content` | string | Message content | +| ↳ `channel_id` | string | Channel ID | +| ↳ `timestamp` | string | Message timestamp | ### `discord_get_webhook` @@ -824,11 +824,11 @@ Get information about a Discord webhook | --------- | ---- | ----------- | | `message` | string | Success or error message | | `data` | object | Webhook data | -| ↳ `id` | string | Webhook ID | -| ↳ `name` | string | Webhook name | -| ↳ `channel_id` | string | Channel ID | -| ↳ `guild_id` | string | Server ID | -| ↳ `token` | string | Webhook token | +| ↳ `id` | string | Webhook ID | +| ↳ `name` | string | Webhook name | +| ↳ `channel_id` | string | Channel ID | +| ↳ `guild_id` | string | Server ID | +| ↳ `token` | string | Webhook token | ### `discord_delete_webhook` diff --git a/apps/docs/content/docs/en/tools/dropbox.mdx b/apps/docs/content/docs/en/tools/dropbox.mdx index a8ebc653b..8b259068a 100644 --- a/apps/docs/content/docs/en/tools/dropbox.mdx +++ b/apps/docs/content/docs/en/tools/dropbox.mdx @@ -54,15 +54,15 @@ Upload a file to Dropbox | Parameter | Type | Description | | --------- | ---- | ----------- | | `file` | object | The uploaded file metadata | -| ↳ `id` | string | Unique identifier for the file | -| ↳ `name` | string | Name of the file | -| ↳ `path_display` | string | Display path of the file | -| ↳ `path_lower` | string | Lowercase path of the file | -| ↳ `size` | number | Size of the file in bytes | -| ↳ `client_modified` | string | Client modification time | -| ↳ `server_modified` | string | Server modification time | -| ↳ `rev` | string | Revision identifier | -| ↳ `content_hash` | string | Content hash for the file | +| ↳ `id` | string | Unique identifier for the file | +| ↳ `name` | string | Name of the file | +| ↳ `path_display` | string | Display path of the file | +| ↳ `path_lower` | string | Lowercase path of the file | +| ↳ `size` | number | Size of the file in bytes | +| ↳ `client_modified` | string | Client modification time | +| ↳ `server_modified` | string | Server modification time | +| ↳ `rev` | string | Revision identifier | +| ↳ `content_hash` | string | Content hash for the file | ### `dropbox_download` @@ -79,10 +79,10 @@ Download a file from Dropbox and get a temporary link | Parameter | Type | Description | | --------- | ---- | ----------- | | `file` | object | The file metadata | -| ↳ `id` | string | Unique identifier for the file | -| ↳ `name` | string | Name of the file | -| ↳ `path_display` | string | Display path of the file | -| ↳ `size` | number | Size of the file in bytes | +| ↳ `id` | string | Unique identifier for the file | +| ↳ `name` | string | Name of the file | +| ↳ `path_display` | string | Display path of the file | +| ↳ `size` | number | Size of the file in bytes | | `temporaryLink` | string | Temporary link to download the file \(valid for ~4 hours\) | | `content` | string | Base64 encoded file content \(if fetched\) | @@ -128,10 +128,10 @@ Create a new folder in Dropbox | Parameter | Type | Description | | --------- | ---- | ----------- | | `folder` | object | The created folder metadata | -| ↳ `id` | string | Unique identifier for the folder | -| ↳ `name` | string | Name of the folder | -| ↳ `path_display` | string | Display path of the folder | -| ↳ `path_lower` | string | Lowercase path of the folder | +| ↳ `id` | string | Unique identifier for the folder | +| ↳ `name` | string | Name of the folder | +| ↳ `path_display` | string | Display path of the folder | +| ↳ `path_lower` | string | Lowercase path of the folder | ### `dropbox_delete` @@ -148,8 +148,8 @@ Delete a file or folder in Dropbox (moves to trash) | Parameter | Type | Description | | --------- | ---- | ----------- | | `metadata` | object | Metadata of the deleted item | -| ↳ `name` | string | Name of the deleted item | -| ↳ `path_display` | string | Display path | +| ↳ `name` | string | Name of the deleted item | +| ↳ `path_display` | string | Display path | | `deleted` | boolean | Whether the deletion was successful | ### `dropbox_copy` @@ -169,10 +169,10 @@ Copy a file or folder in Dropbox | Parameter | Type | Description | | --------- | ---- | ----------- | | `metadata` | object | Metadata of the copied item | -| ↳ `id` | string | Unique identifier | -| ↳ `name` | string | Name of the copied item | -| ↳ `path_display` | string | Display path | -| ↳ `size` | number | Size in bytes \(files only\) | +| ↳ `id` | string | Unique identifier | +| ↳ `name` | string | Name of the copied item | +| ↳ `path_display` | string | Display path | +| ↳ `size` | number | Size in bytes \(files only\) | ### `dropbox_move` @@ -191,10 +191,10 @@ Move or rename a file or folder in Dropbox | Parameter | Type | Description | | --------- | ---- | ----------- | | `metadata` | object | Metadata of the moved item | -| ↳ `id` | string | Unique identifier | -| ↳ `name` | string | Name of the moved item | -| ↳ `path_display` | string | Display path | -| ↳ `size` | number | Size in bytes \(files only\) | +| ↳ `id` | string | Unique identifier | +| ↳ `name` | string | Name of the moved item | +| ↳ `path_display` | string | Display path | +| ↳ `size` | number | Size in bytes \(files only\) | ### `dropbox_get_metadata` @@ -213,15 +213,15 @@ Get metadata for a file or folder in Dropbox | Parameter | Type | Description | | --------- | ---- | ----------- | | `metadata` | object | Metadata for the file or folder | -| ↳ `id` | string | Unique identifier | -| ↳ `name` | string | Name of the item | -| ↳ `path_display` | string | Display path | -| ↳ `path_lower` | string | Lowercase path | -| ↳ `size` | number | Size in bytes \(files only\) | -| ↳ `client_modified` | string | Client modification time | -| ↳ `server_modified` | string | Server modification time | -| ↳ `rev` | string | Revision identifier | -| ↳ `content_hash` | string | Content hash | +| ↳ `id` | string | Unique identifier | +| ↳ `name` | string | Name of the item | +| ↳ `path_display` | string | Display path | +| ↳ `path_lower` | string | Lowercase path | +| ↳ `size` | number | Size in bytes \(files only\) | +| ↳ `client_modified` | string | Client modification time | +| ↳ `server_modified` | string | Server modification time | +| ↳ `rev` | string | Revision identifier | +| ↳ `content_hash` | string | Content hash | ### `dropbox_create_shared_link` @@ -241,11 +241,11 @@ Create a shareable link for a file or folder in Dropbox | Parameter | Type | Description | | --------- | ---- | ----------- | | `sharedLink` | object | The created shared link | -| ↳ `url` | string | The shared link URL | -| ↳ `name` | string | Name of the shared item | -| ↳ `path_lower` | string | Lowercase path of the shared item | -| ↳ `expires` | string | Expiration date if set | -| ↳ `link_permissions` | object | Permissions for the shared link | +| ↳ `url` | string | The shared link URL | +| ↳ `name` | string | Name of the shared item | +| ↳ `path_lower` | string | Lowercase path of the shared item | +| ↳ `expires` | string | Expiration date if set | +| ↳ `link_permissions` | object | Permissions for the shared link | ### `dropbox_search` diff --git a/apps/docs/content/docs/en/tools/exa.mdx b/apps/docs/content/docs/en/tools/exa.mdx index d1d4644df..3b585db42 100644 --- a/apps/docs/content/docs/en/tools/exa.mdx +++ b/apps/docs/content/docs/en/tools/exa.mdx @@ -66,7 +66,7 @@ Search the web using Exa AI. Returns relevant search results with titles, URLs, | ↳ `publishedDate` | string | Date when the content was published | | ↳ `author` | string | The author of the content | | ↳ `summary` | string | A brief summary of the content | -| ↳ `favicon` | string | URL of the site | +| ↳ `favicon` | string | URL of the site's favicon | | ↳ `image` | string | URL of a representative image from the page | | ↳ `text` | string | Text snippet or full content from the page | | ↳ `score` | number | Relevance score for the search result | diff --git a/apps/docs/content/docs/en/tools/firecrawl.mdx b/apps/docs/content/docs/en/tools/firecrawl.mdx index 282adce0b..e109e93a7 100644 --- a/apps/docs/content/docs/en/tools/firecrawl.mdx +++ b/apps/docs/content/docs/en/tools/firecrawl.mdx @@ -61,6 +61,20 @@ Extract structured content from web pages with comprehensive metadata support. C | `markdown` | string | Page content in markdown format | | `html` | string | Raw HTML content of the page | | `metadata` | object | Page metadata including SEO and Open Graph information | +| ↳ `title` | string | Page title | +| ↳ `description` | string | Page meta description | +| ↳ `language` | string | Page language code \(e.g., "en"\) | +| ↳ `sourceURL` | string | Original source URL that was scraped | +| ↳ `statusCode` | number | HTTP status code of the response | +| ↳ `keywords` | string | Page meta keywords | +| ↳ `robots` | string | Robots meta directive \(e.g., "follow, index"\) | +| ↳ `ogTitle` | string | Open Graph title | +| ↳ `ogDescription` | string | Open Graph description | +| ↳ `ogUrl` | string | Open Graph URL | +| ↳ `ogImage` | string | Open Graph image URL | +| ↳ `ogLocaleAlternate` | array | Alternate locale versions for Open Graph | +| ↳ `ogSiteName` | string | Open Graph site name | +| ↳ `error` | string | Error message if scrape failed | ### `firecrawl_search` @@ -77,7 +91,21 @@ Search for information on the web using Firecrawl | Parameter | Type | Description | | --------- | ---- | ----------- | -| `data` | array | Search results data | +| `data` | array | Search results data with scraped content and metadata | +| ↳ `title` | string | Search result title from search engine | +| ↳ `description` | string | Search result description/snippet from search engine | +| ↳ `url` | string | URL of the search result | +| ↳ `markdown` | string | Page content in markdown \(when scrapeOptions.formats includes "markdown"\) | +| ↳ `html` | string | Processed HTML content \(when scrapeOptions.formats includes "html"\) | +| ↳ `rawHtml` | string | Unprocessed raw HTML \(when scrapeOptions.formats includes "rawHtml"\) | +| ↳ `links` | array | Links found on the page \(when scrapeOptions.formats includes "links"\) | +| ↳ `screenshot` | string | Screenshot URL \(expires after 24 hours, when scrapeOptions.formats includes "screenshot"\) | +| ↳ `metadata` | object | Metadata about the search result page | +| ↳ `title` | string | Page title | +| ↳ `description` | string | Page meta description | +| ↳ `sourceURL` | string | Original source URL | +| ↳ `statusCode` | number | HTTP status code | +| ↳ `error` | string | Error message if scrape failed | ### `firecrawl_crawl` @@ -98,13 +126,17 @@ Crawl entire websites and extract structured content from all accessible pages | --------- | ---- | ----------- | | `pages` | array | Array of crawled pages with their content and metadata | | ↳ `markdown` | string | Page content in markdown format | -| ↳ `html` | string | Page HTML content | -| ↳ `metadata` | object | Page metadata | -| ↳ `title` | string | Page title | -| ↳ `description` | string | Page description | -| ↳ `language` | string | Page language | -| ↳ `sourceURL` | string | Source URL of the page | -| ↳ `statusCode` | number | HTTP status code | +| ↳ `html` | string | Processed HTML content of the page | +| ↳ `rawHtml` | string | Unprocessed raw HTML content | +| ↳ `links` | array | Array of links found on the page | +| ↳ `screenshot` | string | Screenshot URL \(expires after 24 hours\) | +| ↳ `metadata` | object | Page metadata from crawl operation | +| ↳ `title` | string | Page title | +| ↳ `description` | string | Page meta description | +| ↳ `language` | string | Page language code | +| ↳ `sourceURL` | string | Original source URL | +| ↳ `statusCode` | number | HTTP status code | +| ↳ `ogLocaleAlternate` | array | Alternate locale versions | | `total` | number | Total number of pages found during crawl | | `creditsUsed` | number | Number of credits consumed by the crawl operation | diff --git a/apps/docs/content/docs/en/tools/fireflies.mdx b/apps/docs/content/docs/en/tools/fireflies.mdx index 86d4f9ade..1b7172beb 100644 --- a/apps/docs/content/docs/en/tools/fireflies.mdx +++ b/apps/docs/content/docs/en/tools/fireflies.mdx @@ -75,18 +75,18 @@ Get a single transcript with full details including summary, action items, and a | Parameter | Type | Description | | --------- | ---- | ----------- | | `transcript` | object | The transcript with full details | -| ↳ `id` | string | Transcript ID | -| ↳ `title` | string | Meeting title | -| ↳ `date` | number | Meeting timestamp | -| ↳ `duration` | number | Meeting duration in seconds | -| ↳ `transcript_url` | string | URL to view transcript | -| ↳ `audio_url` | string | URL to audio recording | -| ↳ `host_email` | string | Host email address | -| ↳ `participants` | array | List of participant emails | -| ↳ `speakers` | array | List of speakers | -| ↳ `sentences` | array | Transcript sentences | -| ↳ `summary` | object | Meeting summary and action items | -| ↳ `analytics` | object | Meeting analytics and sentiment | +| ↳ `id` | string | Transcript ID | +| ↳ `title` | string | Meeting title | +| ↳ `date` | number | Meeting timestamp | +| ↳ `duration` | number | Meeting duration in seconds | +| ↳ `transcript_url` | string | URL to view transcript | +| ↳ `audio_url` | string | URL to audio recording | +| ↳ `host_email` | string | Host email address | +| ↳ `participants` | array | List of participant emails | +| ↳ `speakers` | array | List of speakers | +| ↳ `sentences` | array | Transcript sentences | +| ↳ `summary` | object | Meeting summary and action items | +| ↳ `analytics` | object | Meeting analytics and sentiment | ### `fireflies_get_user` @@ -104,15 +104,15 @@ Get user information from Fireflies.ai. Returns current user if no ID specified. | Parameter | Type | Description | | --------- | ---- | ----------- | | `user` | object | User information | -| ↳ `user_id` | string | User ID | -| ↳ `name` | string | User name | -| ↳ `email` | string | User email | -| ↳ `integrations` | array | Connected integrations | -| ↳ `is_admin` | boolean | Whether user is admin | -| ↳ `minutes_consumed` | number | Total minutes transcribed | -| ↳ `num_transcripts` | number | Number of transcripts | -| ↳ `recent_transcript` | string | Most recent transcript ID | -| ↳ `recent_meeting` | string | Most recent meeting date | +| ↳ `user_id` | string | User ID | +| ↳ `name` | string | User name | +| ↳ `email` | string | User email | +| ↳ `integrations` | array | Connected integrations | +| ↳ `is_admin` | boolean | Whether user is admin | +| ↳ `minutes_consumed` | number | Total minutes transcribed | +| ↳ `num_transcripts` | number | Number of transcripts | +| ↳ `recent_transcript` | string | Most recent transcript ID | +| ↳ `recent_meeting` | string | Most recent meeting date | ### `fireflies_list_users` @@ -214,9 +214,9 @@ Create a soundbite/highlight from a specific time range in a transcript | Parameter | Type | Description | | --------- | ---- | ----------- | | `bite` | object | Created bite details | -| ↳ `id` | string | Bite ID | -| ↳ `name` | string | Bite name | -| ↳ `status` | string | Processing status | +| ↳ `id` | string | Bite ID | +| ↳ `name` | string | Bite name | +| ↳ `status` | string | Processing status | ### `fireflies_list_bites` diff --git a/apps/docs/content/docs/en/tools/github.mdx b/apps/docs/content/docs/en/tools/github.mdx index 84cee4712..484c3c14a 100644 --- a/apps/docs/content/docs/en/tools/github.mdx +++ b/apps/docs/content/docs/en/tools/github.mdx @@ -35,6 +35,26 @@ Fetch PR details including diff and files changed | Parameter | Type | Description | | --------- | ---- | ----------- | +| `user` | object | GitHub user object | +| ↳ `login` | string | GitHub username | +| ↳ `id` | number | User ID | +| ↳ `avatar_url` | string | Avatar image URL | +| ↳ `html_url` | string | Profile URL | +| ↳ `type` | string | Account type \(User or Organization\) | +| `head` | object | Branch reference info | +| ↳ `label` | string | Branch label \(owner:branch\) | +| ↳ `ref` | string | Branch name | +| ↳ `sha` | string | Commit SHA | +| `base` | object | Branch reference info | +| ↳ `label` | string | Branch label \(owner:branch\) | +| ↳ `ref` | string | Branch name | +| ↳ `sha` | string | Commit SHA | +| `merged_by` | object | GitHub user object | +| ↳ `login` | string | GitHub username | +| ↳ `id` | number | User ID | +| ↳ `avatar_url` | string | Avatar image URL | +| ↳ `html_url` | string | Profile URL | +| ↳ `type` | string | Account type \(User or Organization\) | | `id` | number | Pull request ID | | `number` | number | Pull request number | | `title` | string | PR title | @@ -42,12 +62,8 @@ Fetch PR details including diff and files changed | `html_url` | string | GitHub web URL | | `diff_url` | string | Raw diff URL | | `body` | string | PR description | -| `user` | json | User who created the PR | -| `head` | json | Head branch info | -| `base` | json | Base branch info | | `merged` | boolean | Whether PR is merged | | `mergeable` | boolean | Whether PR is mergeable | -| `merged_by` | json | User who merged the PR | | `comments` | number | Number of comments | | `review_comments` | number | Number of review comments | | `commits` | number | Number of commits | @@ -59,6 +75,17 @@ Fetch PR details including diff and files changed | `closed_at` | string | Close timestamp | | `merged_at` | string | Merge timestamp | | `files` | array | Array of changed file objects | +| ↳ `sha` | string | Blob SHA | +| ↳ `filename` | string | File path | +| ↳ `status` | string | Change status \(added/removed/modified/renamed/copied/changed/unchanged\) | +| ↳ `additions` | number | Lines added | +| ↳ `deletions` | number | Lines deleted | +| ↳ `changes` | number | Total line changes | +| ↳ `blob_url` | string | Blob URL | +| ↳ `raw_url` | string | Raw file URL | +| ↳ `contents_url` | string | Contents API URL | +| ↳ `patch` | string | Diff patch | +| ↳ `previous_filename` | string | Previous filename \(for renames\) | ### `github_comment` @@ -84,14 +111,19 @@ Create comments on GitHub PRs | Parameter | Type | Description | | --------- | ---- | ----------- | +| `user` | object | GitHub user object | +| ↳ `login` | string | GitHub username | +| ↳ `id` | number | User ID | +| ↳ `avatar_url` | string | Avatar image URL | +| ↳ `html_url` | string | Profile URL | +| ↳ `type` | string | Account type \(User or Organization\) | | `id` | number | Comment ID | | `body` | string | Comment body | | `html_url` | string | GitHub web URL | -| `user` | json | User who created the comment | -| `path` | string | File path \(if file comment\) | -| `line` | number | Line number | -| `side` | string | Diff side | -| `commit_id` | string | Commit ID | +| `path` | string | File path \(for file comments\) | +| `line` | number | Line number \(for file comments\) | +| `side` | string | Side \(LEFT/RIGHT for diff comments\) | +| `commit_id` | string | Commit SHA | | `created_at` | string | Creation timestamp | | `updated_at` | string | Last update timestamp | @@ -132,8 +164,19 @@ Retrieve comprehensive GitHub repository metadata including stars, forks, issues | `created_at` | string | Creation timestamp | | `updated_at` | string | Last update timestamp | | `pushed_at` | string | Last push timestamp | -| `owner` | json | Repository owner object | -| `license` | json | License information | +| `owner` | object | GitHub user object | +| ↳ `login` | string | GitHub username | +| ↳ `id` | number | User ID | +| ↳ `node_id` | string | GraphQL node ID | +| ↳ `avatar_url` | string | Avatar image URL | +| ↳ `url` | string | API URL | +| ↳ `html_url` | string | Profile page URL | +| ↳ `type` | string | User or Organization | +| ↳ `site_admin` | boolean | GitHub staff indicator | +| `license` | object | License information | +| ↳ `key` | string | License key \(e.g., mit\) | +| ↳ `name` | string | License name | +| ↳ `spdx_id` | string | SPDX identifier | ### `github_latest_commit` @@ -152,11 +195,46 @@ Retrieve the latest commit from a GitHub repository | Parameter | Type | Description | | --------- | ---- | ----------- | +| `commit` | object | Core commit data | +| ↳ `url` | string | Commit API URL | +| ↳ `message` | string | Commit message | +| ↳ `comment_count` | number | Number of comments | +| ↳ `author` | object | Git actor \(author/committer\) | +| ↳ `name` | string | Name | +| ↳ `email` | string | Email address | +| ↳ `date` | string | Timestamp \(ISO 8601\) | +| ↳ `committer` | object | Git actor \(author/committer\) | +| ↳ `name` | string | Name | +| ↳ `email` | string | Email address | +| ↳ `date` | string | Timestamp \(ISO 8601\) | +| ↳ `tree` | object | Tree object | +| ↳ `sha` | string | Tree SHA | +| ↳ `url` | string | Tree API URL | +| ↳ `verification` | object | Signature verification | +| ↳ `verified` | boolean | Whether signature is verified | +| ↳ `reason` | string | Verification reason | +| ↳ `signature` | string | GPG signature | +| ↳ `payload` | string | Signed payload | +| `author` | object | GitHub user object | +| ↳ `login` | string | GitHub username | +| ↳ `id` | number | User ID | +| ↳ `node_id` | string | GraphQL node ID | +| ↳ `avatar_url` | string | Avatar image URL | +| ↳ `url` | string | API URL | +| ↳ `html_url` | string | Profile page URL | +| ↳ `type` | string | User or Organization | +| ↳ `site_admin` | boolean | GitHub staff indicator | +| `committer` | object | GitHub user object | +| ↳ `login` | string | GitHub username | +| ↳ `id` | number | User ID | +| ↳ `node_id` | string | GraphQL node ID | +| ↳ `avatar_url` | string | Avatar image URL | +| ↳ `url` | string | API URL | +| ↳ `html_url` | string | Profile page URL | +| ↳ `type` | string | User or Organization | +| ↳ `site_admin` | boolean | GitHub staff indicator | | `sha` | string | Commit SHA | | `html_url` | string | GitHub web URL | -| `commit` | json | Commit info with message, author, committer | -| `author` | json | Author user object | -| `committer` | json | Committer user object | ### `github_issue_comment` @@ -176,10 +254,19 @@ Create a comment on a GitHub issue | Parameter | Type | Description | | --------- | ---- | ----------- | +| `user` | object | GitHub user object | +| ↳ `login` | string | GitHub username | +| ↳ `id` | number | User ID | +| ↳ `avatar_url` | string | Avatar image URL | +| ↳ `html_url` | string | Profile URL | +| ↳ `type` | string | Account type \(User or Organization\) | | `id` | number | Comment ID | | `body` | string | Comment body | | `html_url` | string | GitHub web URL | -| `user` | json | User who created the comment | +| `path` | string | File path \(for file comments\) | +| `line` | number | Line number \(for file comments\) | +| `side` | string | Side \(LEFT/RIGHT for diff comments\) | +| `commit_id` | string | Commit SHA | | `created_at` | string | Creation timestamp | | `updated_at` | string | Last update timestamp | @@ -204,10 +291,19 @@ List all comments on a GitHub issue | Parameter | Type | Description | | --------- | ---- | ----------- | | `items` | array | Array of comment objects | +| ↳ `user` | object | GitHub user object | +| ↳ `login` | string | GitHub username | +| ↳ `id` | number | User ID | +| ↳ `avatar_url` | string | Avatar image URL | +| ↳ `html_url` | string | Profile URL | +| ↳ `type` | string | Account type \(User or Organization\) | | ↳ `id` | number | Comment ID | | ↳ `body` | string | Comment body | -| ↳ `user` | object | User who created the comment | | ↳ `html_url` | string | GitHub web URL | +| ↳ `path` | string | File path \(for file comments\) | +| ↳ `line` | number | Line number \(for file comments\) | +| ↳ `side` | string | Side \(LEFT/RIGHT for diff comments\) | +| ↳ `commit_id` | string | Commit SHA | | ↳ `created_at` | string | Creation timestamp | | ↳ `updated_at` | string | Last update timestamp | | `count` | number | Number of comments returned | @@ -230,10 +326,19 @@ Update an existing comment on a GitHub issue or pull request | Parameter | Type | Description | | --------- | ---- | ----------- | +| `user` | object | GitHub user object | +| ↳ `login` | string | GitHub username | +| ↳ `id` | number | User ID | +| ↳ `avatar_url` | string | Avatar image URL | +| ↳ `html_url` | string | Profile URL | +| ↳ `type` | string | Account type \(User or Organization\) | | `id` | number | Comment ID | | `body` | string | Comment body | | `html_url` | string | GitHub web URL | -| `user` | json | User who updated the comment | +| `path` | string | File path \(for file comments\) | +| `line` | number | Line number \(for file comments\) | +| `side` | string | Side \(LEFT/RIGHT for diff comments\) | +| `commit_id` | string | Commit SHA | | `created_at` | string | Creation timestamp | | `updated_at` | string | Last update timestamp | @@ -280,13 +385,23 @@ List all review comments on a GitHub pull request | Parameter | Type | Description | | --------- | ---- | ----------- | | `items` | array | Array of review comment objects | +| ↳ `user` | object | GitHub user object | +| ↳ `login` | string | GitHub username | +| ↳ `id` | number | User ID | +| ↳ `avatar_url` | string | Avatar image URL | +| ↳ `html_url` | string | Profile URL | +| ↳ `type` | string | Account type \(User or Organization\) | | ↳ `id` | number | Comment ID | +| ↳ `node_id` | string | GraphQL node ID | | ↳ `body` | string | Comment body | -| ↳ `path` | string | File path | -| ↳ `line` | number | Line number | -| ↳ `user` | object | User who created the comment | | ↳ `html_url` | string | GitHub web URL | -| ↳ `diff_hunk` | string | Diff context | +| ↳ `path` | string | File path | +| ↳ `position` | number | Position in diff | +| ↳ `line` | number | Line number | +| ↳ `side` | string | Side \(LEFT/RIGHT\) | +| ↳ `commit_id` | string | Commit SHA | +| ↳ `original_commit_id` | string | Original commit SHA | +| ↳ `diff_hunk` | string | Diff hunk context | | ↳ `created_at` | string | Creation timestamp | | ↳ `updated_at` | string | Last update timestamp | | `count` | number | Number of comments returned | @@ -410,16 +525,34 @@ List pull requests in a GitHub repository | Parameter | Type | Description | | --------- | ---- | ----------- | | `items` | array | Array of pull request objects | -| ↳ `id` | number | PR ID | -| ↳ `number` | number | PR number | +| ↳ `user` | object | GitHub user object | +| ↳ `login` | string | GitHub username | +| ↳ `id` | number | User ID | +| ↳ `avatar_url` | string | Avatar image URL | +| ↳ `html_url` | string | Profile URL | +| ↳ `type` | string | Account type \(User or Organization\) | +| ↳ `head` | object | Branch reference info | +| ↳ `label` | string | Branch label \(owner:branch\) | +| ↳ `ref` | string | Branch name | +| ↳ `sha` | string | Commit SHA | +| ↳ `base` | object | Branch reference info | +| ↳ `label` | string | Branch label \(owner:branch\) | +| ↳ `ref` | string | Branch name | +| ↳ `sha` | string | Commit SHA | +| ↳ `id` | number | Pull request ID | +| ↳ `node_id` | string | GraphQL node ID | +| ↳ `number` | number | Pull request number | | ↳ `title` | string | PR title | -| ↳ `state` | string | PR state | +| ↳ `state` | string | PR state \(open/closed\) | | ↳ `html_url` | string | GitHub web URL | -| ↳ `user` | object | Author object | -| ↳ `head` | object | Head branch info | -| ↳ `base` | object | Base branch info | +| ↳ `diff_url` | string | Diff URL | +| ↳ `body` | string | PR description | +| ↳ `locked` | boolean | Whether PR is locked | +| ↳ `draft` | boolean | Whether PR is a draft | | ↳ `created_at` | string | Creation timestamp | | ↳ `updated_at` | string | Last update timestamp | +| ↳ `closed_at` | string | Close timestamp | +| ↳ `merged_at` | string | Merge timestamp | | `count` | number | Number of PRs returned | ### `github_get_pr_files` @@ -442,16 +575,17 @@ Get the list of files changed in a pull request | Parameter | Type | Description | | --------- | ---- | ----------- | | `items` | array | Array of changed file objects | +| ↳ `sha` | string | Blob SHA | | ↳ `filename` | string | File path | -| ↳ `status` | string | Change status \(added/modified/deleted/renamed\) | +| ↳ `status` | string | Change status \(added/removed/modified/renamed/copied/changed/unchanged\) | | ↳ `additions` | number | Lines added | | ↳ `deletions` | number | Lines deleted | -| ↳ `changes` | number | Total changes | -| ↳ `patch` | string | File diff patch | -| ↳ `sha` | string | File SHA | -| ↳ `blob_url` | string | GitHub blob URL | +| ↳ `changes` | number | Total line changes | +| ↳ `blob_url` | string | Blob URL | | ↳ `raw_url` | string | Raw file URL | -| ↳ `previous_filename` | string | Previous filename \(for renamed files\) | +| ↳ `contents_url` | string | Contents API URL | +| ↳ `patch` | string | Diff patch | +| ↳ `previous_filename` | string | Previous filename \(for renames\) | | `count` | number | Total number of files | ### `github_close_pr` @@ -664,7 +798,9 @@ List all branches in a GitHub repository. Optionally filter by protected status | --------- | ---- | ----------- | | `items` | array | Array of branch objects | | ↳ `name` | string | Branch name | -| ↳ `commit` | object | Commit info with sha and url | +| ↳ `commit` | object | Commit reference info | +| ↳ `sha` | string | Commit SHA | +| ↳ `url` | string | Commit API URL | | ↳ `protected` | boolean | Whether branch is protected | | `count` | number | Number of branches returned | @@ -686,7 +822,9 @@ Get detailed information about a specific branch in a GitHub repository, includi | Parameter | Type | Description | | --------- | ---- | ----------- | | `name` | string | Branch name | -| `commit` | json | Commit object with sha, url, etc. | +| `commit` | object | Commit reference info | +| ↳ `sha` | string | Commit SHA | +| ↳ `url` | string | Commit API URL | | `protected` | boolean | Whether branch is protected | | `protection` | json | Protection settings object | | `protection_url` | string | URL to protection settings | @@ -784,7 +922,7 @@ Update branch protection rules for a specific branch, including status checks, r | Parameter | Type | Description | | --------- | ---- | ----------- | -| `url` | string | Protection URL | +| `url` | string | Protection settings URL | | `required_status_checks` | json | Status check requirements | | `enforce_admins` | json | Admin enforcement settings | | `required_pull_request_reviews` | json | PR review requirements | @@ -792,6 +930,9 @@ Update branch protection rules for a specific branch, including status checks, r | `required_linear_history` | json | Linear history requirement | | `allow_force_pushes` | json | Force push settings | | `allow_deletions` | json | Deletion settings | +| `block_creations` | json | Creation blocking settings | +| `required_conversation_resolution` | json | Conversation resolution requirement | +| `required_signatures` | json | Signature requirements | ### `github_create_issue` @@ -814,19 +955,52 @@ Create a new issue in a GitHub repository | Parameter | Type | Description | | --------- | ---- | ----------- | +| `user` | object | GitHub user object | +| ↳ `login` | string | GitHub username | +| ↳ `id` | number | User ID | +| ↳ `avatar_url` | string | Avatar image URL | +| ↳ `html_url` | string | Profile URL | +| ↳ `type` | string | Account type \(User or Organization\) | | `id` | number | Issue ID | | `number` | number | Issue number | | `title` | string | Issue title | | `state` | string | Issue state \(open/closed\) | | `html_url` | string | GitHub web URL | | `body` | string | Issue body/description | -| `user` | json | User who created the issue | -| `labels` | array | Array of label objects | -| `assignees` | array | Array of assignee objects | -| `milestone` | json | Milestone object | | `created_at` | string | Creation timestamp | | `updated_at` | string | Last update timestamp | | `closed_at` | string | Close timestamp | +| `state_reason` | string | State reason \(completed/not_planned\) | +| `labels` | array | Array of label objects | +| ↳ `id` | number | Label ID | +| ↳ `node_id` | string | GraphQL node ID | +| ↳ `url` | string | API URL | +| ↳ `name` | string | Label name | +| ↳ `description` | string | Label description | +| ↳ `color` | string | Hex color code \(without #\) | +| ↳ `default` | boolean | Whether this is a default label | +| `assignees` | array | Array of assignee objects | +| ↳ `login` | string | GitHub username | +| ↳ `id` | number | User ID | +| ↳ `avatar_url` | string | Avatar image URL | +| ↳ `html_url` | string | Profile URL | +| ↳ `type` | string | Account type \(User or Organization\) | +| `milestone` | object | GitHub milestone object | +| ↳ `id` | number | Milestone ID | +| ↳ `node_id` | string | GraphQL node ID | +| ↳ `number` | number | Milestone number | +| ↳ `title` | string | Milestone title | +| ↳ `description` | string | Milestone description | +| ↳ `state` | string | State \(open or closed\) | +| ↳ `url` | string | API URL | +| ↳ `html_url` | string | GitHub web URL | +| ↳ `labels_url` | string | Labels API URL | +| ↳ `due_on` | string | Due date \(ISO 8601\) | +| ↳ `open_issues` | number | Number of open issues | +| ↳ `closed_issues` | number | Number of closed issues | +| ↳ `created_at` | string | Creation timestamp | +| ↳ `updated_at` | string | Last update timestamp | +| ↳ `closed_at` | string | Close timestamp | ### `github_update_issue` @@ -850,19 +1024,52 @@ Update an existing issue in a GitHub repository | Parameter | Type | Description | | --------- | ---- | ----------- | +| `user` | object | GitHub user object | +| ↳ `login` | string | GitHub username | +| ↳ `id` | number | User ID | +| ↳ `avatar_url` | string | Avatar image URL | +| ↳ `html_url` | string | Profile URL | +| ↳ `type` | string | Account type \(User or Organization\) | | `id` | number | Issue ID | | `number` | number | Issue number | | `title` | string | Issue title | -| `state` | string | Issue state | +| `state` | string | Issue state \(open/closed\) | | `html_url` | string | GitHub web URL | -| `body` | string | Issue body | -| `user` | json | User who created the issue | -| `labels` | array | Array of label objects | -| `assignees` | array | Array of assignee objects | -| `milestone` | json | Milestone object | +| `body` | string | Issue body/description | | `created_at` | string | Creation timestamp | | `updated_at` | string | Last update timestamp | | `closed_at` | string | Close timestamp | +| `state_reason` | string | State reason \(completed/not_planned\) | +| `labels` | array | Array of label objects | +| ↳ `id` | number | Label ID | +| ↳ `node_id` | string | GraphQL node ID | +| ↳ `url` | string | API URL | +| ↳ `name` | string | Label name | +| ↳ `description` | string | Label description | +| ↳ `color` | string | Hex color code \(without #\) | +| ↳ `default` | boolean | Whether this is a default label | +| `assignees` | array | Array of assignee objects | +| ↳ `login` | string | GitHub username | +| ↳ `id` | number | User ID | +| ↳ `avatar_url` | string | Avatar image URL | +| ↳ `html_url` | string | Profile URL | +| ↳ `type` | string | Account type \(User or Organization\) | +| `milestone` | object | GitHub milestone object | +| ↳ `id` | number | Milestone ID | +| ↳ `node_id` | string | GraphQL node ID | +| ↳ `number` | number | Milestone number | +| ↳ `title` | string | Milestone title | +| ↳ `description` | string | Milestone description | +| ↳ `state` | string | State \(open or closed\) | +| ↳ `url` | string | API URL | +| ↳ `html_url` | string | GitHub web URL | +| ↳ `labels_url` | string | Labels API URL | +| ↳ `due_on` | string | Due date \(ISO 8601\) | +| ↳ `open_issues` | number | Number of open issues | +| ↳ `closed_issues` | number | Number of closed issues | +| ↳ `created_at` | string | Creation timestamp | +| ↳ `updated_at` | string | Last update timestamp | +| ↳ `closed_at` | string | Close timestamp | ### `github_list_issues` @@ -889,19 +1096,13 @@ List issues in a GitHub repository. Note: This includes pull requests as PRs are | Parameter | Type | Description | | --------- | ---- | ----------- | | `items` | array | Array of issue objects from GitHub API | -| ↳ `id` | number | Issue ID | -| ↳ `number` | number | Issue number | -| ↳ `title` | string | Issue title | -| ↳ `state` | string | Issue state \(open/closed\) | -| ↳ `html_url` | string | GitHub web URL | -| ↳ `body` | string | Issue body | -| ↳ `user` | object | User who created the issue | -| ↳ `labels` | array | Array of label objects | -| ↳ `assignees` | array | Array of assignee objects | -| ↳ `milestone` | object | Milestone object | -| ↳ `created_at` | string | Creation timestamp | -| ↳ `updated_at` | string | Last update timestamp | -| ↳ `closed_at` | string | Close timestamp | +| ↳ `id` | number | Label ID | +| ↳ `node_id` | string | GraphQL node ID | +| ↳ `url` | string | API URL | +| ↳ `name` | string | Label name | +| ↳ `description` | string | Label description | +| ↳ `color` | string | Hex color code \(without #\) | +| ↳ `default` | boolean | Whether this is a default label | | `count` | number | Number of issues returned | ### `github_get_issue` @@ -921,21 +1122,58 @@ Get detailed information about a specific issue in a GitHub repository | Parameter | Type | Description | | --------- | ---- | ----------- | +| `user` | object | GitHub user object | +| ↳ `login` | string | GitHub username | +| ↳ `id` | number | User ID | +| ↳ `avatar_url` | string | Avatar image URL | +| ↳ `html_url` | string | Profile URL | +| ↳ `type` | string | Account type \(User or Organization\) | | `id` | number | Issue ID | | `number` | number | Issue number | | `title` | string | Issue title | | `state` | string | Issue state \(open/closed\) | | `html_url` | string | GitHub web URL | | `body` | string | Issue body/description | -| `user` | json | User who created the issue | -| `labels` | array | Array of label objects | -| `assignees` | array | Array of assignee objects | -| `milestone` | json | Milestone object | -| `comments` | number | Number of comments | | `created_at` | string | Creation timestamp | | `updated_at` | string | Last update timestamp | | `closed_at` | string | Close timestamp | -| `closed_by` | json | User who closed the issue | +| `state_reason` | string | State reason \(completed/not_planned\) | +| `labels` | array | Array of label objects | +| ↳ `id` | number | Label ID | +| ↳ `node_id` | string | GraphQL node ID | +| ↳ `url` | string | API URL | +| ↳ `name` | string | Label name | +| ↳ `description` | string | Label description | +| ↳ `color` | string | Hex color code \(without #\) | +| ↳ `default` | boolean | Whether this is a default label | +| `assignees` | array | Array of assignee objects | +| ↳ `login` | string | GitHub username | +| ↳ `id` | number | User ID | +| ↳ `avatar_url` | string | Avatar image URL | +| ↳ `html_url` | string | Profile URL | +| ↳ `type` | string | Account type \(User or Organization\) | +| `milestone` | object | GitHub milestone object | +| ↳ `id` | number | Milestone ID | +| ↳ `node_id` | string | GraphQL node ID | +| ↳ `number` | number | Milestone number | +| ↳ `title` | string | Milestone title | +| ↳ `description` | string | Milestone description | +| ↳ `state` | string | State \(open or closed\) | +| ↳ `url` | string | API URL | +| ↳ `html_url` | string | GitHub web URL | +| ↳ `labels_url` | string | Labels API URL | +| ↳ `due_on` | string | Due date \(ISO 8601\) | +| ↳ `open_issues` | number | Number of open issues | +| ↳ `closed_issues` | number | Number of closed issues | +| ↳ `created_at` | string | Creation timestamp | +| ↳ `updated_at` | string | Last update timestamp | +| ↳ `closed_at` | string | Close timestamp | +| `closed_by` | object | User who closed the issue | +| ↳ `login` | string | GitHub username | +| ↳ `id` | number | User ID | +| ↳ `avatar_url` | string | Avatar image URL | +| ↳ `html_url` | string | Profile URL | +| ↳ `type` | string | Account type \(User or Organization\) | ### `github_close_issue` @@ -955,19 +1193,36 @@ Close an issue in a GitHub repository | Parameter | Type | Description | | --------- | ---- | ----------- | +| `user` | object | GitHub user object | +| ↳ `login` | string | GitHub username | +| ↳ `id` | number | User ID | +| ↳ `avatar_url` | string | Avatar image URL | +| ↳ `html_url` | string | Profile URL | +| ↳ `type` | string | Account type \(User or Organization\) | | `id` | number | Issue ID | | `number` | number | Issue number | | `title` | string | Issue title | -| `state` | string | Issue state \(closed\) | -| `state_reason` | string | Reason for closing | +| `state` | string | Issue state \(open/closed\) | | `html_url` | string | GitHub web URL | -| `body` | string | Issue body | -| `user` | json | User who created the issue | -| `labels` | array | Array of label objects | -| `assignees` | array | Array of assignee objects | -| `closed_at` | string | Close timestamp | +| `body` | string | Issue body/description | | `created_at` | string | Creation timestamp | | `updated_at` | string | Last update timestamp | +| `closed_at` | string | Close timestamp | +| `state_reason` | string | State reason \(completed/not_planned\) | +| `labels` | array | Array of label objects | +| ↳ `id` | number | Label ID | +| ↳ `node_id` | string | GraphQL node ID | +| ↳ `url` | string | API URL | +| ↳ `name` | string | Label name | +| ↳ `description` | string | Label description | +| ↳ `color` | string | Hex color code \(without #\) | +| ↳ `default` | boolean | Whether this is a default label | +| `assignees` | array | Array of assignee objects | +| ↳ `login` | string | GitHub username | +| ↳ `id` | number | User ID | +| ↳ `avatar_url` | string | Avatar image URL | +| ↳ `html_url` | string | Profile URL | +| ↳ `type` | string | Account type \(User or Organization\) | ### `github_add_labels` @@ -1071,19 +1326,43 @@ Create a new release for a GitHub repository. Specify tag name, target commit, t | Parameter | Type | Description | | --------- | ---- | ----------- | +| `author` | object | GitHub user object | +| ↳ `login` | string | GitHub username | +| ↳ `id` | number | User ID | +| ↳ `avatar_url` | string | Avatar image URL | +| ↳ `html_url` | string | Profile URL | +| ↳ `type` | string | Account type \(User or Organization\) | | `id` | number | Release ID | +| `node_id` | string | GraphQL node ID | | `tag_name` | string | Git tag name | | `name` | string | Release name | -| `body` | string | Release description | +| `body` | string | Release notes \(markdown\) | | `html_url` | string | GitHub web URL | -| `tarball_url` | string | Tarball download URL | -| `zipball_url` | string | Zipball download URL | -| `draft` | boolean | Whether this is a draft | +| `tarball_url` | string | Source tarball URL | +| `zipball_url` | string | Source zipball URL | +| `draft` | boolean | Whether this is a draft release | | `prerelease` | boolean | Whether this is a prerelease | -| `author` | json | Release author | -| `assets` | array | Release assets | +| `target_commitish` | string | Target branch or commit SHA | | `created_at` | string | Creation timestamp | | `published_at` | string | Publication timestamp | +| `assets` | array | Release assets | +| ↳ `uploader` | object | GitHub user object | +| ↳ `login` | string | GitHub username | +| ↳ `id` | number | User ID | +| ↳ `avatar_url` | string | Avatar image URL | +| ↳ `html_url` | string | Profile URL | +| ↳ `type` | string | Account type \(User or Organization\) | +| ↳ `id` | number | Asset ID | +| ↳ `node_id` | string | GraphQL node ID | +| ↳ `name` | string | Asset filename | +| ↳ `label` | string | Asset label | +| ↳ `state` | string | Asset state \(uploaded/open\) | +| ↳ `content_type` | string | MIME type | +| ↳ `size` | number | File size in bytes | +| ↳ `download_count` | number | Number of downloads | +| ↳ `browser_download_url` | string | Direct download URL | +| ↳ `created_at` | string | Upload timestamp | +| ↳ `updated_at` | string | Last update timestamp | ### `github_update_release` @@ -1108,17 +1387,43 @@ Update an existing GitHub release. Modify tag name, target commit, title, descri | Parameter | Type | Description | | --------- | ---- | ----------- | +| `author` | object | GitHub user object | +| ↳ `login` | string | GitHub username | +| ↳ `id` | number | User ID | +| ↳ `avatar_url` | string | Avatar image URL | +| ↳ `html_url` | string | Profile URL | +| ↳ `type` | string | Account type \(User or Organization\) | | `id` | number | Release ID | +| `node_id` | string | GraphQL node ID | | `tag_name` | string | Git tag name | | `name` | string | Release name | -| `body` | string | Release description | +| `body` | string | Release notes \(markdown\) | | `html_url` | string | GitHub web URL | -| `tarball_url` | string | Tarball download URL | -| `zipball_url` | string | Zipball download URL | -| `draft` | boolean | Whether this is a draft | +| `tarball_url` | string | Source tarball URL | +| `zipball_url` | string | Source zipball URL | +| `draft` | boolean | Whether this is a draft release | | `prerelease` | boolean | Whether this is a prerelease | +| `target_commitish` | string | Target branch or commit SHA | | `created_at` | string | Creation timestamp | | `published_at` | string | Publication timestamp | +| `assets` | array | Release assets | +| ↳ `uploader` | object | GitHub user object | +| ↳ `login` | string | GitHub username | +| ↳ `id` | number | User ID | +| ↳ `avatar_url` | string | Avatar image URL | +| ↳ `html_url` | string | Profile URL | +| ↳ `type` | string | Account type \(User or Organization\) | +| ↳ `id` | number | Asset ID | +| ↳ `node_id` | string | GraphQL node ID | +| ↳ `name` | string | Asset filename | +| ↳ `label` | string | Asset label | +| ↳ `state` | string | Asset state \(uploaded/open\) | +| ↳ `content_type` | string | MIME type | +| ↳ `size` | number | File size in bytes | +| ↳ `download_count` | number | Number of downloads | +| ↳ `browser_download_url` | string | Direct download URL | +| ↳ `created_at` | string | Upload timestamp | +| ↳ `updated_at` | string | Last update timestamp | ### `github_list_releases` @@ -1139,19 +1444,43 @@ List all releases for a GitHub repository. Returns release information including | Parameter | Type | Description | | --------- | ---- | ----------- | | `items` | array | Array of release objects | +| ↳ `author` | object | GitHub user object | +| ↳ `login` | string | GitHub username | +| ↳ `id` | number | User ID | +| ↳ `avatar_url` | string | Avatar image URL | +| ↳ `html_url` | string | Profile URL | +| ↳ `type` | string | Account type \(User or Organization\) | | ↳ `id` | number | Release ID | +| ↳ `node_id` | string | GraphQL node ID | | ↳ `tag_name` | string | Git tag name | | ↳ `name` | string | Release name | -| ↳ `body` | string | Release description | +| ↳ `body` | string | Release notes \(markdown\) | | ↳ `html_url` | string | GitHub web URL | -| ↳ `tarball_url` | string | Tarball download URL | -| ↳ `zipball_url` | string | Zipball download URL | -| ↳ `draft` | boolean | Whether this is a draft | +| ↳ `tarball_url` | string | Source tarball URL | +| ↳ `zipball_url` | string | Source zipball URL | +| ↳ `draft` | boolean | Whether this is a draft release | | ↳ `prerelease` | boolean | Whether this is a prerelease | -| ↳ `author` | object | Release author | -| ↳ `assets` | array | Release assets | +| ↳ `target_commitish` | string | Target branch or commit SHA | | ↳ `created_at` | string | Creation timestamp | | ↳ `published_at` | string | Publication timestamp | +| ↳ `assets` | array | Release assets | +| ↳ `uploader` | object | GitHub user object | +| ↳ `login` | string | GitHub username | +| ↳ `id` | number | User ID | +| ↳ `avatar_url` | string | Avatar image URL | +| ↳ `html_url` | string | Profile URL | +| ↳ `type` | string | Account type \(User or Organization\) | +| ↳ `id` | number | Asset ID | +| ↳ `node_id` | string | GraphQL node ID | +| ↳ `name` | string | Asset filename | +| ↳ `label` | string | Asset label | +| ↳ `state` | string | Asset state \(uploaded/open\) | +| ↳ `content_type` | string | MIME type | +| ↳ `size` | number | File size in bytes | +| ↳ `download_count` | number | Number of downloads | +| ↳ `browser_download_url` | string | Direct download URL | +| ↳ `created_at` | string | Upload timestamp | +| ↳ `updated_at` | string | Last update timestamp | | `count` | number | Number of releases returned | ### `github_get_release` @@ -1171,20 +1500,43 @@ Get detailed information about a specific GitHub release by ID. Returns release | Parameter | Type | Description | | --------- | ---- | ----------- | +| `author` | object | GitHub user object | +| ↳ `login` | string | GitHub username | +| ↳ `id` | number | User ID | +| ↳ `avatar_url` | string | Avatar image URL | +| ↳ `html_url` | string | Profile URL | +| ↳ `type` | string | Account type \(User or Organization\) | | `id` | number | Release ID | +| `node_id` | string | GraphQL node ID | | `tag_name` | string | Git tag name | | `name` | string | Release name | -| `body` | string | Release description | +| `body` | string | Release notes \(markdown\) | | `html_url` | string | GitHub web URL | -| `tarball_url` | string | Tarball download URL | -| `zipball_url` | string | Zipball download URL | -| `draft` | boolean | Whether this is a draft | +| `tarball_url` | string | Source tarball URL | +| `zipball_url` | string | Source zipball URL | +| `draft` | boolean | Whether this is a draft release | | `prerelease` | boolean | Whether this is a prerelease | -| `author` | json | Release author object | -| `assets` | array | Array of release asset objects | +| `target_commitish` | string | Target branch or commit SHA | | `created_at` | string | Creation timestamp | | `published_at` | string | Publication timestamp | -| `target_commitish` | string | Target commit/branch | +| `assets` | array | Release assets | +| ↳ `uploader` | object | GitHub user object | +| ↳ `login` | string | GitHub username | +| ↳ `id` | number | User ID | +| ↳ `avatar_url` | string | Avatar image URL | +| ↳ `html_url` | string | Profile URL | +| ↳ `type` | string | Account type \(User or Organization\) | +| ↳ `id` | number | Asset ID | +| ↳ `node_id` | string | GraphQL node ID | +| ↳ `name` | string | Asset filename | +| ↳ `label` | string | Asset label | +| ↳ `state` | string | Asset state \(uploaded/open\) | +| ↳ `content_type` | string | MIME type | +| ↳ `size` | number | File size in bytes | +| ↳ `download_count` | number | Number of downloads | +| ↳ `browser_download_url` | string | Direct download URL | +| ↳ `created_at` | string | Upload timestamp | +| ↳ `updated_at` | string | Last update timestamp | ### `github_delete_release` @@ -1227,12 +1579,13 @@ List all workflows in a GitHub repository. Returns workflow details including ID | `total_count` | number | Total number of workflows | | `items` | array | Array of workflow objects | | ↳ `id` | number | Workflow ID | -| ↳ `node_id` | string | Workflow node ID | +| ↳ `node_id` | string | GraphQL node ID | | ↳ `name` | string | Workflow name | | ↳ `path` | string | Path to workflow file | -| ↳ `state` | string | Workflow state | +| ↳ `state` | string | Workflow state \(active/disabled_manually/disabled_inactivity\) | | ↳ `html_url` | string | GitHub web URL | -| ↳ `badge_url` | string | Badge URL | +| ↳ `badge_url` | string | Status badge URL | +| ↳ `url` | string | API URL | | ↳ `created_at` | string | Creation timestamp | | ↳ `updated_at` | string | Last update timestamp | | ↳ `deleted_at` | string | Deletion timestamp | @@ -1255,12 +1608,12 @@ Get details of a specific GitHub Actions workflow by ID or filename. Returns wor | Parameter | Type | Description | | --------- | ---- | ----------- | | `id` | number | Workflow ID | -| `node_id` | string | Workflow node ID | +| `node_id` | string | GraphQL node ID | | `name` | string | Workflow name | | `path` | string | Path to workflow file | -| `state` | string | Workflow state \(active/disabled\) | +| `state` | string | Workflow state \(active/disabled_manually/disabled_inactivity\) | | `html_url` | string | GitHub web URL | -| `badge_url` | string | Badge URL | +| `badge_url` | string | Status badge URL | | `url` | string | API URL | | `created_at` | string | Creation timestamp | | `updated_at` | string | Last update timestamp | @@ -1313,22 +1666,9 @@ List workflow runs for a repository. Supports filtering by actor, branch, event, | --------- | ---- | ----------- | | `total_count` | number | Total number of workflow runs | | `items` | array | Array of workflow run objects | -| ↳ `id` | number | Workflow run ID | -| ↳ `name` | string | Workflow name | -| ↳ `head_branch` | string | Branch name | -| ↳ `head_sha` | string | Commit SHA | -| ↳ `run_number` | number | Run number | -| ↳ `event` | string | Trigger event | -| ↳ `status` | string | Run status | -| ↳ `conclusion` | string | Run conclusion | -| ↳ `html_url` | string | GitHub web URL | -| ↳ `created_at` | string | Creation timestamp | -| ↳ `updated_at` | string | Last update timestamp | -| ↳ `triggering_actor` | json | User who triggered the run | -| ↳ `pull_requests` | array | Associated pull requests | -| ↳ `referenced_workflows` | array | Referenced workflows | -| ↳ `head_commit` | json | Head commit information | -| ↳ `run_started_at` | string | Run start timestamp | +| ↳ `id` | number | Pull request ID | +| ↳ `number` | number | Pull request number | +| ↳ `url` | string | API URL | ### `github_get_workflow_run` @@ -1347,27 +1687,42 @@ Get detailed information about a specific workflow run by ID. Returns status, co | Parameter | Type | Description | | --------- | ---- | ----------- | +| `triggering_actor` | object | GitHub user object | +| ↳ `login` | string | GitHub username | +| ↳ `id` | number | User ID | +| ↳ `avatar_url` | string | Avatar image URL | +| ↳ `html_url` | string | Profile URL | +| ↳ `type` | string | Account type \(User or Organization\) | +| `head_commit` | object | Head commit information | +| ↳ `id` | string | Commit SHA | +| ↳ `tree_id` | string | Tree SHA | +| ↳ `message` | string | Commit message | +| ↳ `timestamp` | string | Commit timestamp | | `id` | number | Workflow run ID | | `name` | string | Workflow name | -| `head_branch` | string | Branch name | -| `head_sha` | string | Commit SHA | +| `head_branch` | string | Head branch name | +| `head_sha` | string | Head commit SHA | | `run_number` | number | Run number | | `run_attempt` | number | Run attempt number | -| `event` | string | Trigger event type | -| `status` | string | Run status | -| `conclusion` | string | Run conclusion | -| `workflow_id` | number | Workflow ID | +| `event` | string | Event that triggered the run | +| `status` | string | Run status \(queued/in_progress/completed\) | +| `conclusion` | string | Run conclusion \(success/failure/cancelled/etc\) | +| `workflow_id` | number | Associated workflow ID | | `html_url` | string | GitHub web URL | | `logs_url` | string | Logs download URL | | `jobs_url` | string | Jobs API URL | | `artifacts_url` | string | Artifacts API URL | -| `triggering_actor` | json | User who triggered the run | -| `pull_requests` | array | Associated pull requests | -| `referenced_workflows` | array | Referenced workflows | -| `head_commit` | json | Head commit information | | `run_started_at` | string | Run start timestamp | | `created_at` | string | Creation timestamp | | `updated_at` | string | Last update timestamp | +| `pull_requests` | array | Associated pull requests | +| ↳ `id` | number | Pull request ID | +| ↳ `number` | number | Pull request number | +| ↳ `url` | string | API URL | +| `referenced_workflows` | array | Referenced workflows | +| ↳ `path` | string | Path to referenced workflow | +| ↳ `sha` | string | Commit SHA of referenced workflow | +| ↳ `ref` | string | Git ref of referenced workflow | ### `github_cancel_workflow_run` @@ -1565,32 +1920,32 @@ Search for code across GitHub repositories. Use qualifiers like repo:owner/name, | ↳ `html_url` | string | GitHub web URL | | ↳ `score` | number | Search relevance score | | ↳ `repository` | object | Repository containing the code | -| ↳ `id` | number | Repository ID | -| ↳ `node_id` | string | GraphQL node ID | -| ↳ `name` | string | Repository name | -| ↳ `full_name` | string | Full name \(owner/repo\) | -| ↳ `private` | boolean | Whether repository is private | -| ↳ `html_url` | string | GitHub web URL | -| ↳ `description` | string | Repository description | -| ↳ `fork` | boolean | Whether this is a fork | -| ↳ `url` | string | API URL | -| ↳ `owner` | object | Repository owner | -| ↳ `login` | string | Username | -| ↳ `id` | number | User ID | -| ↳ `node_id` | string | GraphQL node ID | -| ↳ `avatar_url` | string | Avatar image URL | -| ↳ `url` | string | API URL | -| ↳ `html_url` | string | Profile page URL | -| ↳ `type` | string | User or Organization | -| ↳ `site_admin` | boolean | GitHub staff indicator | +| ↳ `id` | number | Repository ID | +| ↳ `node_id` | string | GraphQL node ID | +| ↳ `name` | string | Repository name | +| ↳ `full_name` | string | Full name \(owner/repo\) | +| ↳ `private` | boolean | Whether repository is private | +| ↳ `html_url` | string | GitHub web URL | +| ↳ `description` | string | Repository description | +| ↳ `fork` | boolean | Whether this is a fork | +| ↳ `url` | string | API URL | +| ↳ `owner` | object | Repository owner | +| ↳ `login` | string | Username | +| ↳ `id` | number | User ID | +| ↳ `node_id` | string | GraphQL node ID | +| ↳ `avatar_url` | string | Avatar image URL | +| ↳ `url` | string | API URL | +| ↳ `html_url` | string | Profile page URL | +| ↳ `type` | string | User or Organization | +| ↳ `site_admin` | boolean | GitHub staff indicator | | ↳ `text_matches` | array | Text matches showing context | -| ↳ `object_url` | string | Object URL | -| ↳ `object_type` | string | Object type | -| ↳ `property` | string | Property matched | -| ↳ `fragment` | string | Text fragment with match | -| ↳ `matches` | array | Match indices | -| ↳ `text` | string | Matched text | -| ↳ `indices` | array | Start and end indices | +| ↳ `object_url` | string | Object URL | +| ↳ `object_type` | string | Object type | +| ↳ `property` | string | Property matched | +| ↳ `fragment` | string | Text fragment with match | +| ↳ `matches` | array | Match indices | +| ↳ `text` | string | Matched text | +| ↳ `indices` | array | Start and end indices | ### `github_search_commits` @@ -1621,59 +1976,59 @@ Search for commits across GitHub. Use qualifiers like repo:owner/name, author:us | ↳ `comments_url` | string | Comments API URL | | ↳ `score` | number | Search relevance score | | ↳ `commit` | object | Core commit data | -| ↳ `url` | string | Commit API URL | -| ↳ `message` | string | Commit message | -| ↳ `comment_count` | number | Number of comments | -| ↳ `author` | object | Git author | -| ↳ `name` | string | Author name | -| ↳ `email` | string | Author email | -| ↳ `date` | string | Author date \(ISO 8601\) | -| ↳ `committer` | object | Git committer | -| ↳ `name` | string | Committer name | -| ↳ `email` | string | Committer email | -| ↳ `date` | string | Commit date \(ISO 8601\) | -| ↳ `tree` | object | Tree object | -| ↳ `sha` | string | Tree SHA | -| ↳ `url` | string | Tree API URL | +| ↳ `url` | string | Commit API URL | +| ↳ `message` | string | Commit message | +| ↳ `comment_count` | number | Number of comments | +| ↳ `author` | object | Git author | +| ↳ `name` | string | Author name | +| ↳ `email` | string | Author email | +| ↳ `date` | string | Author date \(ISO 8601\) | +| ↳ `committer` | object | Git committer | +| ↳ `name` | string | Committer name | +| ↳ `email` | string | Committer email | +| ↳ `date` | string | Commit date \(ISO 8601\) | +| ↳ `tree` | object | Tree object | +| ↳ `sha` | string | Tree SHA | +| ↳ `url` | string | Tree API URL | | ↳ `author` | object | GitHub user \(author\) | -| ↳ `login` | string | Username | -| ↳ `id` | number | User ID | -| ↳ `node_id` | string | GraphQL node ID | -| ↳ `avatar_url` | string | Avatar URL | -| ↳ `url` | string | API URL | -| ↳ `html_url` | string | Profile URL | -| ↳ `type` | string | User or Organization | -| ↳ `site_admin` | boolean | GitHub staff indicator | +| ↳ `login` | string | Username | +| ↳ `id` | number | User ID | +| ↳ `node_id` | string | GraphQL node ID | +| ↳ `avatar_url` | string | Avatar URL | +| ↳ `url` | string | API URL | +| ↳ `html_url` | string | Profile URL | +| ↳ `type` | string | User or Organization | +| ↳ `site_admin` | boolean | GitHub staff indicator | | ↳ `committer` | object | GitHub user \(committer\) | -| ↳ `login` | string | Username | -| ↳ `id` | number | User ID | -| ↳ `node_id` | string | GraphQL node ID | -| ↳ `avatar_url` | string | Avatar URL | -| ↳ `url` | string | API URL | -| ↳ `html_url` | string | Profile URL | -| ↳ `type` | string | User or Organization | -| ↳ `site_admin` | boolean | GitHub staff indicator | +| ↳ `login` | string | Username | +| ↳ `id` | number | User ID | +| ↳ `node_id` | string | GraphQL node ID | +| ↳ `avatar_url` | string | Avatar URL | +| ↳ `url` | string | API URL | +| ↳ `html_url` | string | Profile URL | +| ↳ `type` | string | User or Organization | +| ↳ `site_admin` | boolean | GitHub staff indicator | | ↳ `repository` | object | Repository containing the commit | -| ↳ `id` | number | Repository ID | -| ↳ `node_id` | string | GraphQL node ID | -| ↳ `name` | string | Repository name | -| ↳ `full_name` | string | Full name \(owner/repo\) | -| ↳ `private` | boolean | Whether repository is private | -| ↳ `html_url` | string | GitHub web URL | -| ↳ `description` | string | Repository description | -| ↳ `owner` | object | Repository owner | -| ↳ `login` | string | Username | -| ↳ `id` | number | User ID | -| ↳ `node_id` | string | GraphQL node ID | -| ↳ `avatar_url` | string | Avatar image URL | -| ↳ `url` | string | API URL | -| ↳ `html_url` | string | Profile page URL | -| ↳ `type` | string | User or Organization | -| ↳ `site_admin` | boolean | GitHub staff indicator | +| ↳ `id` | number | Repository ID | +| ↳ `node_id` | string | GraphQL node ID | +| ↳ `name` | string | Repository name | +| ↳ `full_name` | string | Full name \(owner/repo\) | +| ↳ `private` | boolean | Whether repository is private | +| ↳ `html_url` | string | GitHub web URL | +| ↳ `description` | string | Repository description | +| ↳ `owner` | object | Repository owner | +| ↳ `login` | string | Username | +| ↳ `id` | number | User ID | +| ↳ `node_id` | string | GraphQL node ID | +| ↳ `avatar_url` | string | Avatar image URL | +| ↳ `url` | string | API URL | +| ↳ `html_url` | string | Profile page URL | +| ↳ `type` | string | User or Organization | +| ↳ `site_admin` | boolean | GitHub staff indicator | | ↳ `parents` | array | Parent commits | -| ↳ `sha` | string | Parent SHA | -| ↳ `url` | string | Parent API URL | -| ↳ `html_url` | string | Parent web URL | +| ↳ `sha` | string | Parent SHA | +| ↳ `url` | string | Parent API URL | +| ↳ `html_url` | string | Parent web URL | ### `github_search_issues` @@ -1714,54 +2069,54 @@ Search for issues and pull requests across GitHub. Use qualifiers like repo:owne | ↳ `updated_at` | string | Last update timestamp | | ↳ `closed_at` | string | Close timestamp | | ↳ `user` | object | Issue author | -| ↳ `login` | string | Username | -| ↳ `id` | number | User ID | -| ↳ `node_id` | string | GraphQL node ID | -| ↳ `avatar_url` | string | Avatar image URL | -| ↳ `url` | string | API URL | -| ↳ `html_url` | string | Profile page URL | -| ↳ `type` | string | User or Organization | -| ↳ `site_admin` | boolean | GitHub staff indicator | +| ↳ `login` | string | Username | +| ↳ `id` | number | User ID | +| ↳ `node_id` | string | GraphQL node ID | +| ↳ `avatar_url` | string | Avatar image URL | +| ↳ `url` | string | API URL | +| ↳ `html_url` | string | Profile page URL | +| ↳ `type` | string | User or Organization | +| ↳ `site_admin` | boolean | GitHub staff indicator | | ↳ `labels` | array | Issue labels | -| ↳ `id` | number | Label ID | -| ↳ `node_id` | string | GraphQL node ID | -| ↳ `url` | string | API URL | -| ↳ `name` | string | Label name | -| ↳ `description` | string | Label description | -| ↳ `color` | string | Hex color code | -| ↳ `default` | boolean | Whether this is a default label | +| ↳ `id` | number | Label ID | +| ↳ `node_id` | string | GraphQL node ID | +| ↳ `url` | string | API URL | +| ↳ `name` | string | Label name | +| ↳ `description` | string | Label description | +| ↳ `color` | string | Hex color code | +| ↳ `default` | boolean | Whether this is a default label | | ↳ `assignee` | object | Primary assignee | -| ↳ `login` | string | Username | -| ↳ `id` | number | User ID | -| ↳ `node_id` | string | GraphQL node ID | -| ↳ `avatar_url` | string | Avatar image URL | -| ↳ `url` | string | API URL | -| ↳ `html_url` | string | Profile page URL | -| ↳ `type` | string | User or Organization | -| ↳ `site_admin` | boolean | GitHub staff indicator | +| ↳ `login` | string | Username | +| ↳ `id` | number | User ID | +| ↳ `node_id` | string | GraphQL node ID | +| ↳ `avatar_url` | string | Avatar image URL | +| ↳ `url` | string | API URL | +| ↳ `html_url` | string | Profile page URL | +| ↳ `type` | string | User or Organization | +| ↳ `site_admin` | boolean | GitHub staff indicator | | ↳ `assignees` | array | All assignees | -| ↳ `login` | string | Username | -| ↳ `id` | number | User ID | -| ↳ `node_id` | string | GraphQL node ID | -| ↳ `avatar_url` | string | Avatar image URL | -| ↳ `url` | string | API URL | -| ↳ `html_url` | string | Profile page URL | -| ↳ `type` | string | User or Organization | -| ↳ `site_admin` | boolean | GitHub staff indicator | +| ↳ `login` | string | Username | +| ↳ `id` | number | User ID | +| ↳ `node_id` | string | GraphQL node ID | +| ↳ `avatar_url` | string | Avatar image URL | +| ↳ `url` | string | API URL | +| ↳ `html_url` | string | Profile page URL | +| ↳ `type` | string | User or Organization | +| ↳ `site_admin` | boolean | GitHub staff indicator | | ↳ `milestone` | object | Associated milestone | -| ↳ `id` | number | Milestone ID | -| ↳ `node_id` | string | GraphQL node ID | -| ↳ `number` | number | Milestone number | -| ↳ `title` | string | Milestone title | -| ↳ `description` | string | Milestone description | -| ↳ `state` | string | State \(open or closed\) | -| ↳ `html_url` | string | Web URL | -| ↳ `due_on` | string | Due date | +| ↳ `id` | number | Milestone ID | +| ↳ `node_id` | string | GraphQL node ID | +| ↳ `number` | number | Milestone number | +| ↳ `title` | string | Milestone title | +| ↳ `description` | string | Milestone description | +| ↳ `state` | string | State \(open or closed\) | +| ↳ `html_url` | string | Web URL | +| ↳ `due_on` | string | Due date | | ↳ `pull_request` | object | Pull request details \(if this is a PR\) | -| ↳ `url` | string | API URL | -| ↳ `html_url` | string | Web URL | -| ↳ `diff_url` | string | Diff URL | -| ↳ `patch_url` | string | Patch URL | +| ↳ `url` | string | API URL | +| ↳ `html_url` | string | Web URL | +| ↳ `diff_url` | string | Diff URL | +| ↳ `patch_url` | string | Patch URL | ### `github_search_repos` @@ -1804,21 +2159,24 @@ Search for repositories across GitHub. Use qualifiers like language:python, star | ↳ `open_issues_count` | number | Number of open issues | | ↳ `language` | string | Primary programming language | | ↳ `default_branch` | string | Default branch name | +| ↳ `visibility` | string | Repository visibility | +| ↳ `archived` | boolean | Whether repository is archived | +| ↳ `disabled` | boolean | Whether repository is disabled | | ↳ `score` | number | Search relevance score | | ↳ `topics` | array | Repository topics | | ↳ `license` | object | License information | -| ↳ `key` | string | License key \(e.g., mit\) | -| ↳ `name` | string | License name | -| ↳ `spdx_id` | string | SPDX identifier | +| ↳ `key` | string | License key \(e.g., mit\) | +| ↳ `name` | string | License name | +| ↳ `spdx_id` | string | SPDX identifier | | ↳ `owner` | object | Repository owner | -| ↳ `login` | string | Username | -| ↳ `id` | number | User ID | -| ↳ `node_id` | string | GraphQL node ID | -| ↳ `avatar_url` | string | Avatar image URL | -| ↳ `url` | string | API URL | -| ↳ `html_url` | string | Profile page URL | -| ↳ `type` | string | User or Organization | -| ↳ `site_admin` | boolean | GitHub staff indicator | +| ↳ `login` | string | GitHub username | +| ↳ `id` | number | User ID | +| ↳ `node_id` | string | GraphQL node ID | +| ↳ `avatar_url` | string | Avatar image URL | +| ↳ `url` | string | API URL | +| ↳ `html_url` | string | Profile page URL | +| ↳ `type` | string | User or Organization | +| ↳ `site_admin` | boolean | GitHub staff indicator | ### `github_search_users` @@ -1884,53 +2242,53 @@ List commits in a repository with optional filtering by SHA, path, author, commi | Parameter | Type | Description | | --------- | ---- | ----------- | | `items` | array | Array of commit objects from GitHub API | +| ↳ `commit` | object | Core commit data | +| ↳ `url` | string | Commit API URL | +| ↳ `message` | string | Commit message | +| ↳ `comment_count` | number | Number of comments | +| ↳ `author` | object | Git actor \(author/committer\) | +| ↳ `name` | string | Name | +| ↳ `email` | string | Email address | +| ↳ `date` | string | Timestamp \(ISO 8601\) | +| ↳ `committer` | object | Git actor \(author/committer\) | +| ↳ `name` | string | Name | +| ↳ `email` | string | Email address | +| ↳ `date` | string | Timestamp \(ISO 8601\) | +| ↳ `tree` | object | Tree object | +| ↳ `sha` | string | Tree SHA | +| ↳ `url` | string | Tree API URL | +| ↳ `verification` | object | Signature verification | +| ↳ `verified` | boolean | Whether signature is verified | +| ↳ `reason` | string | Verification reason | +| ↳ `signature` | string | GPG signature | +| ↳ `payload` | string | Signed payload | +| ↳ `author` | object | GitHub user object | +| ↳ `login` | string | GitHub username | +| ↳ `id` | number | User ID | +| ↳ `node_id` | string | GraphQL node ID | +| ↳ `avatar_url` | string | Avatar image URL | +| ↳ `url` | string | API URL | +| ↳ `html_url` | string | Profile page URL | +| ↳ `type` | string | User or Organization | +| ↳ `site_admin` | boolean | GitHub staff indicator | +| ↳ `committer` | object | GitHub user object | +| ↳ `login` | string | GitHub username | +| ↳ `id` | number | User ID | +| ↳ `node_id` | string | GraphQL node ID | +| ↳ `avatar_url` | string | Avatar image URL | +| ↳ `url` | string | API URL | +| ↳ `html_url` | string | Profile page URL | +| ↳ `type` | string | User or Organization | +| ↳ `site_admin` | boolean | GitHub staff indicator | | ↳ `sha` | string | Commit SHA | | ↳ `node_id` | string | GraphQL node ID | -| ↳ `html_url` | string | Web URL | +| ↳ `html_url` | string | GitHub web URL | | ↳ `url` | string | API URL | | ↳ `comments_url` | string | Comments API URL | -| ↳ `commit` | object | Core commit data | -| ↳ `url` | string | Commit API URL | -| ↳ `message` | string | Commit message | -| ↳ `comment_count` | number | Number of comments | -| ↳ `author` | object | Git author | -| ↳ `name` | string | Author name | -| ↳ `email` | string | Author email | -| ↳ `date` | string | Author date \(ISO 8601\) | -| ↳ `committer` | object | Git committer | -| ↳ `name` | string | Committer name | -| ↳ `email` | string | Committer email | -| ↳ `date` | string | Commit date \(ISO 8601\) | -| ↳ `tree` | object | Tree object | -| ↳ `sha` | string | Tree SHA | -| ↳ `url` | string | Tree API URL | -| ↳ `verification` | object | Signature verification | -| ↳ `verified` | boolean | Whether signature is verified | -| ↳ `reason` | string | Verification reason | -| ↳ `signature` | string | GPG signature | -| ↳ `payload` | string | Signed payload | -| ↳ `author` | object | GitHub user \(author\) | -| ↳ `login` | string | Username | -| ↳ `id` | number | User ID | -| ↳ `node_id` | string | GraphQL node ID | -| ↳ `avatar_url` | string | Avatar URL | -| ↳ `url` | string | API URL | -| ↳ `html_url` | string | Profile URL | -| ↳ `type` | string | User or Organization | -| ↳ `site_admin` | boolean | GitHub staff indicator | -| ↳ `committer` | object | GitHub user \(committer\) | -| ↳ `login` | string | Username | -| ↳ `id` | number | User ID | -| ↳ `node_id` | string | GraphQL node ID | -| ↳ `avatar_url` | string | Avatar URL | -| ↳ `url` | string | API URL | -| ↳ `html_url` | string | Profile URL | -| ↳ `type` | string | User or Organization | -| ↳ `site_admin` | boolean | GitHub staff indicator | | ↳ `parents` | array | Parent commits | -| ↳ `sha` | string | Parent SHA | -| ↳ `url` | string | Parent API URL | -| ↳ `html_url` | string | Parent web URL | +| ↳ `sha` | string | Parent SHA | +| ↳ `url` | string | Parent API URL | +| ↳ `html_url` | string | Parent web URL | | `count` | number | Number of commits returned | ### `github_get_commit` @@ -1950,47 +2308,53 @@ Get detailed information about a specific commit including files changed and sta | Parameter | Type | Description | | --------- | ---- | ----------- | +| `commit` | object | Core commit data | +| ↳ `url` | string | Commit API URL | +| ↳ `message` | string | Commit message | +| ↳ `comment_count` | number | Number of comments | +| ↳ `author` | object | Git actor \(author/committer\) | +| ↳ `name` | string | Name | +| ↳ `email` | string | Email address | +| ↳ `date` | string | Timestamp \(ISO 8601\) | +| ↳ `committer` | object | Git actor \(author/committer\) | +| ↳ `name` | string | Name | +| ↳ `email` | string | Email address | +| ↳ `date` | string | Timestamp \(ISO 8601\) | +| ↳ `tree` | object | Tree object | +| ↳ `sha` | string | Tree SHA | +| ↳ `url` | string | Tree API URL | +| ↳ `verification` | object | Signature verification | +| ↳ `verified` | boolean | Whether signature is verified | +| ↳ `reason` | string | Verification reason | +| ↳ `signature` | string | GPG signature | +| ↳ `payload` | string | Signed payload | +| `author` | object | GitHub user object | +| ↳ `login` | string | GitHub username | +| ↳ `id` | number | User ID | +| ↳ `node_id` | string | GraphQL node ID | +| ↳ `avatar_url` | string | Avatar image URL | +| ↳ `url` | string | API URL | +| ↳ `html_url` | string | Profile page URL | +| ↳ `type` | string | User or Organization | +| ↳ `site_admin` | boolean | GitHub staff indicator | +| `committer` | object | GitHub user object | +| ↳ `login` | string | GitHub username | +| ↳ `id` | number | User ID | +| ↳ `node_id` | string | GraphQL node ID | +| ↳ `avatar_url` | string | Avatar image URL | +| ↳ `url` | string | API URL | +| ↳ `html_url` | string | Profile page URL | +| ↳ `type` | string | User or Organization | +| ↳ `site_admin` | boolean | GitHub staff indicator | +| `stats` | object | Change statistics | +| ↳ `additions` | number | Lines added | +| ↳ `deletions` | number | Lines deleted | +| ↳ `total` | number | Total changes | | `sha` | string | Commit SHA | | `node_id` | string | GraphQL node ID | | `html_url` | string | GitHub web URL | | `url` | string | API URL | | `comments_url` | string | Comments API URL | -| `commit` | object | Core commit data | -| ↳ `url` | string | Commit API URL | -| ↳ `message` | string | Commit message | -| ↳ `comment_count` | number | Number of comments | -| ↳ `author` | object | Git author | -| ↳ `name` | string | Author name | -| ↳ `email` | string | Author email | -| ↳ `date` | string | Author date \(ISO 8601\) | -| ↳ `committer` | object | Git committer | -| ↳ `name` | string | Committer name | -| ↳ `email` | string | Committer email | -| ↳ `date` | string | Commit date \(ISO 8601\) | -| ↳ `tree` | object | Tree object | -| ↳ `sha` | string | Tree SHA | -| ↳ `url` | string | Tree API URL | -| ↳ `verification` | object | Signature verification | -| ↳ `verified` | boolean | Whether signature is verified | -| ↳ `reason` | string | Verification reason | -| ↳ `signature` | string | GPG signature | -| ↳ `payload` | string | Signed payload | -| `author` | object | GitHub user \(author\) | -| ↳ `login` | string | Username | -| ↳ `id` | number | User ID | -| ↳ `avatar_url` | string | Avatar URL | -| ↳ `html_url` | string | Profile URL | -| ↳ `type` | string | User or Organization | -| `committer` | object | GitHub user \(committer\) | -| ↳ `login` | string | Username | -| ↳ `id` | number | User ID | -| ↳ `avatar_url` | string | Avatar URL | -| ↳ `html_url` | string | Profile URL | -| ↳ `type` | string | User or Organization | -| `stats` | object | Change statistics | -| ↳ `additions` | number | Lines added | -| ↳ `deletions` | number | Lines deleted | -| ↳ `total` | number | Total changes | | `files` | array | Changed files \(diff entries\) | | ↳ `sha` | string | Blob SHA | | ↳ `filename` | string | File path | @@ -2038,26 +2402,90 @@ Compare two commits or branches to see the diff, commits between them, and chang | `behind_by` | number | Commits head is behind base | | `total_commits` | number | Total commits in comparison | | `base_commit` | object | Base commit object | -| ↳ `sha` | string | Commit SHA | -| ↳ `html_url` | string | Web URL | -| ↳ `commit` | object | Commit data | -| ↳ `message` | string | Commit message | -| ↳ `author` | object | Git author \(name, email, date\) | -| ↳ `committer` | object | Git committer \(name, email, date\) | -| ↳ `author` | object | GitHub user \(author\) | -| ↳ `committer` | object | GitHub user \(committer\) | -| `merge_base_commit` | object | Merge base commit object | -| ↳ `sha` | string | Commit SHA | -| ↳ `html_url` | string | Web URL | -| `commits` | array | Commits between base and head | +| ↳ `commit` | object | Core commit data | +| ↳ `url` | string | Commit API URL | +| ↳ `message` | string | Commit message | +| ↳ `comment_count` | number | Number of comments | +| ↳ `author` | object | Git actor \(author/committer\) | +| ↳ `name` | string | Name | +| ↳ `email` | string | Email address | +| ↳ `date` | string | Timestamp \(ISO 8601\) | +| ↳ `committer` | object | Git actor \(author/committer\) | +| ↳ `name` | string | Name | +| ↳ `email` | string | Email address | +| ↳ `date` | string | Timestamp \(ISO 8601\) | +| ↳ `tree` | object | Tree object | +| ↳ `sha` | string | Tree SHA | +| ↳ `url` | string | Tree API URL | +| ↳ `verification` | object | Signature verification | +| ↳ `verified` | boolean | Whether signature is verified | +| ↳ `reason` | string | Verification reason | +| ↳ `signature` | string | GPG signature | +| ↳ `payload` | string | Signed payload | +| ↳ `author` | object | GitHub user object | +| ↳ `login` | string | GitHub username | +| ↳ `id` | number | User ID | +| ↳ `node_id` | string | GraphQL node ID | +| ↳ `avatar_url` | string | Avatar image URL | +| ↳ `url` | string | API URL | +| ↳ `html_url` | string | Profile page URL | +| ↳ `type` | string | User or Organization | +| ↳ `site_admin` | boolean | GitHub staff indicator | +| ↳ `committer` | object | GitHub user object | +| ↳ `login` | string | GitHub username | +| ↳ `id` | number | User ID | +| ↳ `node_id` | string | GraphQL node ID | +| ↳ `avatar_url` | string | Avatar image URL | +| ↳ `url` | string | API URL | +| ↳ `html_url` | string | Profile page URL | +| ↳ `type` | string | User or Organization | +| ↳ `site_admin` | boolean | GitHub staff indicator | +| ↳ `sha` | string | Commit SHA | +| ↳ `html_url` | string | Web URL | +| `merge_base_commit` | object | Merge base commit object | +| ↳ `sha` | string | Commit SHA | +| ↳ `html_url` | string | Web URL | +| `commits` | array | Commits between base and head | +| ↳ `commit` | object | Core commit data | +| ↳ `url` | string | Commit API URL | +| ↳ `message` | string | Commit message | +| ↳ `comment_count` | number | Number of comments | +| ↳ `author` | object | Git actor \(author/committer\) | +| ↳ `name` | string | Name | +| ↳ `email` | string | Email address | +| ↳ `date` | string | Timestamp \(ISO 8601\) | +| ↳ `committer` | object | Git actor \(author/committer\) | +| ↳ `name` | string | Name | +| ↳ `email` | string | Email address | +| ↳ `date` | string | Timestamp \(ISO 8601\) | +| ↳ `tree` | object | Tree object | +| ↳ `sha` | string | Tree SHA | +| ↳ `url` | string | Tree API URL | +| ↳ `verification` | object | Signature verification | +| ↳ `verified` | boolean | Whether signature is verified | +| ↳ `reason` | string | Verification reason | +| ↳ `signature` | string | GPG signature | +| ↳ `payload` | string | Signed payload | +| ↳ `author` | object | GitHub user object | +| ↳ `login` | string | GitHub username | +| ↳ `id` | number | User ID | +| ↳ `node_id` | string | GraphQL node ID | +| ↳ `avatar_url` | string | Avatar image URL | +| ↳ `url` | string | API URL | +| ↳ `html_url` | string | Profile page URL | +| ↳ `type` | string | User or Organization | +| ↳ `site_admin` | boolean | GitHub staff indicator | +| ↳ `committer` | object | GitHub user object | +| ↳ `login` | string | GitHub username | +| ↳ `id` | number | User ID | +| ↳ `node_id` | string | GraphQL node ID | +| ↳ `avatar_url` | string | Avatar image URL | +| ↳ `url` | string | API URL | +| ↳ `html_url` | string | Profile page URL | +| ↳ `type` | string | User or Organization | +| ↳ `site_admin` | boolean | GitHub staff indicator | | ↳ `sha` | string | Commit SHA | | ↳ `html_url` | string | Web URL | -| ↳ `commit` | object | Commit data | -| ↳ `message` | string | Commit message | -| ↳ `author` | object | Git author \(name, email, date\) | -| ↳ `committer` | object | Git committer \(name, email, date\) | -| ↳ `author` | object | GitHub user | -| ↳ `committer` | object | GitHub user | | `files` | array | Changed files \(diff entries\) | | ↳ `sha` | string | Blob SHA | | ↳ `filename` | string | File path | @@ -2106,14 +2534,14 @@ Create a new gist with one or more files | `updated_at` | string | Last update timestamp | | `files` | object | Files in the gist \(object with filenames as keys, each containing filename, type, language, raw_url, size, truncated, content\) | | `owner` | object | Gist owner | -| ↳ `login` | string | Username | -| ↳ `id` | number | User ID | -| ↳ `node_id` | string | GraphQL node ID | -| ↳ `avatar_url` | string | Avatar image URL | -| ↳ `url` | string | API URL | -| ↳ `html_url` | string | Profile page URL | -| ↳ `type` | string | User or Organization | -| ↳ `site_admin` | boolean | GitHub staff indicator | +| ↳ `login` | string | Username | +| ↳ `id` | number | User ID | +| ↳ `node_id` | string | GraphQL node ID | +| ↳ `avatar_url` | string | Avatar image URL | +| ↳ `url` | string | API URL | +| ↳ `html_url` | string | Profile page URL | +| ↳ `type` | string | User or Organization | +| ↳ `site_admin` | boolean | GitHub staff indicator | ### `github_get_gist` @@ -2130,31 +2558,38 @@ Get a gist by ID including its file contents | Parameter | Type | Description | | --------- | ---- | ----------- | +| `files` | object | Files in the gist \(keyed by filename\) | +| ↳ `filename` | string | File name | +| ↳ `type` | string | MIME type | +| ↳ `language` | string | Programming language | +| ↳ `raw_url` | string | Raw file URL | +| ↳ `size` | number | File size in bytes | +| ↳ `truncated` | boolean | Whether content is truncated | +| ↳ `content` | string | File content | +| `owner` | object | Gist owner | +| ↳ `login` | string | Username | +| ↳ `id` | number | User ID | +| ↳ `node_id` | string | GraphQL node ID | +| ↳ `avatar_url` | string | Avatar image URL | +| ↳ `url` | string | API URL | +| ↳ `html_url` | string | Profile page URL | +| ↳ `type` | string | User or Organization | +| ↳ `site_admin` | boolean | GitHub staff indicator | | `id` | string | Gist ID | | `node_id` | string | GraphQL node ID | -| `html_url` | string | GitHub web URL | | `url` | string | API URL | +| `html_url` | string | GitHub web URL | | `forks_url` | string | Forks API URL | | `commits_url` | string | Commits API URL | | `git_pull_url` | string | Git clone URL | | `git_push_url` | string | Git push URL | | `description` | string | Gist description | | `public` | boolean | Whether gist is public | -| `created_at` | string | Creation timestamp | -| `updated_at` | string | Last update timestamp | +| `truncated` | boolean | Whether content is truncated | | `comments` | number | Number of comments | | `comments_url` | string | Comments API URL | -| `truncated` | boolean | Whether content is truncated | -| `files` | object | Files in the gist \(keyed by filename\) | -| `owner` | object | Gist owner | -| ↳ `login` | string | Username | -| ↳ `id` | number | User ID | -| ↳ `node_id` | string | GraphQL node ID | -| ↳ `avatar_url` | string | Avatar image URL | -| ↳ `url` | string | API URL | -| ↳ `html_url` | string | Profile page URL | -| ↳ `type` | string | User or Organization | -| ↳ `site_admin` | boolean | GitHub staff indicator | +| `created_at` | string | Creation timestamp | +| `updated_at` | string | Last update timestamp | ### `github_list_gists` @@ -2175,31 +2610,38 @@ List gists for a user or the authenticated user | Parameter | Type | Description | | --------- | ---- | ----------- | | `items` | array | Array of gist objects from GitHub API | +| ↳ `files` | object | Files in the gist \(keyed by filename\) | +| ↳ `filename` | string | File name | +| ↳ `type` | string | MIME type | +| ↳ `language` | string | Programming language | +| ↳ `raw_url` | string | Raw file URL | +| ↳ `size` | number | File size in bytes | +| ↳ `truncated` | boolean | Whether content is truncated | +| ↳ `content` | string | File content | +| ↳ `owner` | object | Gist owner | +| ↳ `login` | string | Username | +| ↳ `id` | number | User ID | +| ↳ `node_id` | string | GraphQL node ID | +| ↳ `avatar_url` | string | Avatar image URL | +| ↳ `url` | string | API URL | +| ↳ `html_url` | string | Profile page URL | +| ↳ `type` | string | User or Organization | +| ↳ `site_admin` | boolean | GitHub staff indicator | | ↳ `id` | string | Gist ID | | ↳ `node_id` | string | GraphQL node ID | | ↳ `url` | string | API URL | -| ↳ `html_url` | string | Web URL | +| ↳ `html_url` | string | GitHub web URL | | ↳ `forks_url` | string | Forks API URL | | ↳ `commits_url` | string | Commits API URL | -| ↳ `git_pull_url` | string | Git pull URL | +| ↳ `git_pull_url` | string | Git clone URL | | ↳ `git_push_url` | string | Git push URL | | ↳ `description` | string | Gist description | | ↳ `public` | boolean | Whether gist is public | -| ↳ `truncated` | boolean | Whether files are truncated | +| ↳ `truncated` | boolean | Whether content is truncated | | ↳ `comments` | number | Number of comments | | ↳ `comments_url` | string | Comments API URL | | ↳ `created_at` | string | Creation timestamp | | ↳ `updated_at` | string | Last update timestamp | -| ↳ `files` | object | Files in the gist \(object with filenames as keys, each containing filename, type, language, raw_url, size\) | -| ↳ `owner` | object | Gist owner | -| ↳ `login` | string | Username | -| ↳ `id` | number | User ID | -| ↳ `node_id` | string | GraphQL node ID | -| ↳ `avatar_url` | string | Avatar image URL | -| ↳ `url` | string | API URL | -| ↳ `html_url` | string | Profile page URL | -| ↳ `type` | string | User or Organization | -| ↳ `site_admin` | boolean | GitHub staff indicator | | `count` | number | Number of gists returned | ### `github_update_gist` @@ -2236,14 +2678,14 @@ Update a gist description or files. To delete a file, set its value to null in f | `updated_at` | string | Last update timestamp | | `files` | object | Files in the gist \(object with filenames as keys, each containing filename, type, language, raw_url, size, truncated, content\) | | `owner` | object | Gist owner | -| ↳ `login` | string | Username | -| ↳ `id` | number | User ID | -| ↳ `node_id` | string | GraphQL node ID | -| ↳ `avatar_url` | string | Avatar image URL | -| ↳ `url` | string | API URL | -| ↳ `html_url` | string | Profile page URL | -| ↳ `type` | string | User or Organization | -| ↳ `site_admin` | boolean | GitHub staff indicator | +| ↳ `login` | string | Username | +| ↳ `id` | number | User ID | +| ↳ `node_id` | string | GraphQL node ID | +| ↳ `avatar_url` | string | Avatar image URL | +| ↳ `url` | string | API URL | +| ↳ `html_url` | string | Profile page URL | +| ↳ `type` | string | User or Organization | +| ↳ `site_admin` | boolean | GitHub staff indicator | ### `github_delete_gist` @@ -2358,26 +2800,21 @@ Fork a repository to your account or an organization | `updated_at` | string | Last update timestamp | | `pushed_at` | string | Last push timestamp | | `owner` | object | Fork owner | -| ↳ `login` | string | Username | -| ↳ `id` | number | User ID | -| ↳ `node_id` | string | GraphQL node ID | -| ↳ `avatar_url` | string | Avatar image URL | -| ↳ `url` | string | API URL | -| ↳ `html_url` | string | Profile page URL | -| ↳ `type` | string | User or Organization | -| ↳ `site_admin` | boolean | GitHub staff indicator | +| ↳ `login` | string | GitHub username | +| ↳ `id` | number | User ID | +| ↳ `node_id` | string | GraphQL node ID | +| ↳ `avatar_url` | string | Avatar image URL | +| ↳ `url` | string | API URL | +| ↳ `html_url` | string | Profile page URL | +| ↳ `type` | string | User or Organization | +| ↳ `site_admin` | boolean | GitHub staff indicator | | `parent` | object | Parent repository \(source of the fork\) | -| ↳ `id` | number | Repository ID | -| ↳ `full_name` | string | Full name | -| ↳ `html_url` | string | Web URL | -| ↳ `description` | string | Description | -| ↳ `owner` | object | Parent owner | | ↳ `login` | string | Username | | ↳ `id` | number | User ID | | `source` | object | Source repository \(ultimate origin\) | -| ↳ `id` | number | Repository ID | -| ↳ `full_name` | string | Full name | -| ↳ `html_url` | string | Web URL | +| ↳ `id` | number | Repository ID | +| ↳ `full_name` | string | Full name | +| ↳ `html_url` | string | Web URL | ### `github_list_forks` @@ -2422,14 +2859,14 @@ List forks of a repository | ↳ `archived` | boolean | Whether repository is archived | | ↳ `disabled` | boolean | Whether repository is disabled | | ↳ `owner` | object | Fork owner | -| ↳ `login` | string | Username | -| ↳ `id` | number | User ID | -| ↳ `node_id` | string | GraphQL node ID | -| ↳ `avatar_url` | string | Avatar image URL | -| ↳ `url` | string | API URL | -| ↳ `html_url` | string | Profile page URL | -| ↳ `type` | string | User or Organization | -| ↳ `site_admin` | boolean | GitHub staff indicator | +| ↳ `login` | string | GitHub username | +| ↳ `id` | number | User ID | +| ↳ `node_id` | string | GraphQL node ID | +| ↳ `avatar_url` | string | Avatar image URL | +| ↳ `url` | string | API URL | +| ↳ `html_url` | string | Profile page URL | +| ↳ `type` | string | User or Organization | +| ↳ `site_admin` | boolean | GitHub staff indicator | | `count` | number | Number of forks returned | ### `github_create_milestone` @@ -2452,15 +2889,30 @@ Create a milestone in a repository | Parameter | Type | Description | | --------- | ---- | ----------- | +| `creator` | object | Milestone creator | +| ↳ `login` | string | Username | +| ↳ `id` | number | User ID | +| ↳ `node_id` | string | GraphQL node ID | +| ↳ `avatar_url` | string | Avatar image URL | +| ↳ `url` | string | API URL | +| ↳ `html_url` | string | Profile page URL | +| ↳ `type` | string | User or Organization | +| ↳ `site_admin` | boolean | GitHub staff indicator | +| `id` | number | Milestone ID | +| `node_id` | string | GraphQL node ID | | `number` | number | Milestone number | -| `title` | string | Title | -| `description` | string | Description | -| `state` | string | State | -| `html_url` | string | Web URL | -| `due_on` | string | Due date | -| `open_issues` | number | Open issues | -| `closed_issues` | number | Closed issues | -| `creator` | object | Creator | +| `title` | string | Milestone title | +| `description` | string | Milestone description | +| `state` | string | State \(open or closed\) | +| `url` | string | API URL | +| `html_url` | string | GitHub web URL | +| `labels_url` | string | Labels API URL | +| `due_on` | string | Due date \(ISO 8601\) | +| `open_issues` | number | Number of open issues | +| `closed_issues` | number | Number of closed issues | +| `created_at` | string | Creation timestamp | +| `updated_at` | string | Last update timestamp | +| `closed_at` | string | Close timestamp | ### `github_get_milestone` @@ -2479,6 +2931,15 @@ Get a specific milestone by number | Parameter | Type | Description | | --------- | ---- | ----------- | +| `creator` | object | Milestone creator | +| ↳ `login` | string | Username | +| ↳ `id` | number | User ID | +| ↳ `node_id` | string | GraphQL node ID | +| ↳ `avatar_url` | string | Avatar image URL | +| ↳ `url` | string | API URL | +| ↳ `html_url` | string | Profile page URL | +| ↳ `type` | string | User or Organization | +| ↳ `site_admin` | boolean | GitHub staff indicator | | `id` | number | Milestone ID | | `node_id` | string | GraphQL node ID | | `number` | number | Milestone number | @@ -2494,15 +2955,6 @@ Get a specific milestone by number | `created_at` | string | Creation timestamp | | `updated_at` | string | Last update timestamp | | `closed_at` | string | Close timestamp | -| `creator` | object | Milestone creator | -| ↳ `login` | string | Username | -| ↳ `id` | number | User ID | -| ↳ `node_id` | string | GraphQL node ID | -| ↳ `avatar_url` | string | Avatar image URL | -| ↳ `url` | string | API URL | -| ↳ `html_url` | string | Profile page URL | -| ↳ `type` | string | User or Organization | -| ↳ `site_admin` | boolean | GitHub staff indicator | ### `github_list_milestones` @@ -2526,6 +2978,15 @@ List milestones in a repository | Parameter | Type | Description | | --------- | ---- | ----------- | | `items` | array | Array of milestone objects from GitHub API | +| ↳ `creator` | object | Milestone creator | +| ↳ `login` | string | Username | +| ↳ `id` | number | User ID | +| ↳ `node_id` | string | GraphQL node ID | +| ↳ `avatar_url` | string | Avatar image URL | +| ↳ `url` | string | API URL | +| ↳ `html_url` | string | Profile page URL | +| ↳ `type` | string | User or Organization | +| ↳ `site_admin` | boolean | GitHub staff indicator | | ↳ `id` | number | Milestone ID | | ↳ `node_id` | string | GraphQL node ID | | ↳ `number` | number | Milestone number | @@ -2541,15 +3002,6 @@ List milestones in a repository | ↳ `created_at` | string | Creation timestamp | | ↳ `updated_at` | string | Last update timestamp | | ↳ `closed_at` | string | Close timestamp | -| ↳ `creator` | object | Milestone creator | -| ↳ `login` | string | Username | -| ↳ `id` | number | User ID | -| ↳ `node_id` | string | GraphQL node ID | -| ↳ `avatar_url` | string | Avatar image URL | -| ↳ `url` | string | API URL | -| ↳ `html_url` | string | Profile page URL | -| ↳ `type` | string | User or Organization | -| ↳ `site_admin` | boolean | GitHub staff indicator | | `count` | number | Number of milestones returned | ### `github_update_milestone` @@ -2589,14 +3041,14 @@ Update a milestone in a repository | `updated_at` | string | Last update timestamp | | `closed_at` | string | Close timestamp | | `creator` | object | Milestone creator | -| ↳ `login` | string | Username | -| ↳ `id` | number | User ID | -| ↳ `node_id` | string | GraphQL node ID | -| ↳ `avatar_url` | string | Avatar image URL | -| ↳ `url` | string | API URL | -| ↳ `html_url` | string | Profile page URL | -| ↳ `type` | string | User or Organization | -| ↳ `site_admin` | boolean | GitHub staff indicator | +| ↳ `login` | string | Username | +| ↳ `id` | number | User ID | +| ↳ `node_id` | string | GraphQL node ID | +| ↳ `avatar_url` | string | Avatar image URL | +| ↳ `url` | string | API URL | +| ↳ `html_url` | string | Profile page URL | +| ↳ `type` | string | User or Organization | +| ↳ `site_admin` | boolean | GitHub staff indicator | ### `github_delete_milestone` @@ -2640,15 +3092,12 @@ Add a reaction to an issue | `node_id` | string | GraphQL node ID | | `content` | string | Reaction type \(+1, -1, laugh, confused, heart, hooray, rocket, eyes\) | | `created_at` | string | Creation timestamp | -| `user` | object | User who reacted | -| ↳ `login` | string | Username | -| ↳ `id` | number | User ID | -| ↳ `node_id` | string | GraphQL node ID | -| ↳ `avatar_url` | string | Avatar image URL | -| ↳ `url` | string | API URL | -| ↳ `html_url` | string | Profile page URL | -| ↳ `type` | string | User or Organization | -| ↳ `site_admin` | boolean | GitHub staff indicator | +| `user` | object | GitHub user object | +| ↳ `login` | string | GitHub username | +| ↳ `id` | number | User ID | +| ↳ `avatar_url` | string | Avatar image URL | +| ↳ `html_url` | string | Profile URL | +| ↳ `type` | string | Account type \(User or Organization\) | ### `github_delete_issue_reaction` @@ -2693,15 +3142,12 @@ Add a reaction to an issue comment | `node_id` | string | GraphQL node ID | | `content` | string | Reaction type \(+1, -1, laugh, confused, heart, hooray, rocket, eyes\) | | `created_at` | string | Creation timestamp | -| `user` | object | User who reacted | -| ↳ `login` | string | Username | -| ↳ `id` | number | User ID | -| ↳ `node_id` | string | GraphQL node ID | -| ↳ `avatar_url` | string | Avatar image URL | -| ↳ `url` | string | API URL | -| ↳ `html_url` | string | Profile page URL | -| ↳ `type` | string | User or Organization | -| ↳ `site_admin` | boolean | GitHub staff indicator | +| `user` | object | GitHub user object | +| ↳ `login` | string | GitHub username | +| ↳ `id` | number | User ID | +| ↳ `avatar_url` | string | Avatar image URL | +| ↳ `html_url` | string | Profile URL | +| ↳ `type` | string | Account type \(User or Organization\) | ### `github_delete_comment_reaction` @@ -2803,20 +3249,20 @@ List users who have starred a repository | Parameter | Type | Description | | --------- | ---- | ----------- | | `items` | array | Array of user objects from GitHub API | -| ↳ `login` | string | Username | +| ↳ `login` | string | GitHub username | | ↳ `id` | number | User ID | | ↳ `node_id` | string | GraphQL node ID | | ↳ `avatar_url` | string | Avatar image URL | -| ↳ `gravatar_id` | string | Gravatar ID | | ↳ `url` | string | API URL | | ↳ `html_url` | string | Profile page URL | +| ↳ `type` | string | User or Organization | +| ↳ `site_admin` | boolean | GitHub staff indicator | +| ↳ `gravatar_id` | string | Gravatar ID | | ↳ `followers_url` | string | Followers API URL | | ↳ `following_url` | string | Following API URL | | ↳ `gists_url` | string | Gists API URL | | ↳ `starred_url` | string | Starred API URL | | ↳ `repos_url` | string | Repos API URL | -| ↳ `type` | string | User or Organization | -| ↳ `site_admin` | boolean | GitHub staff indicator | | `count` | number | Number of stargazers returned | diff --git a/apps/docs/content/docs/en/tools/google_docs.mdx b/apps/docs/content/docs/en/tools/google_docs.mdx index 597d547db..5b2f55fac 100644 --- a/apps/docs/content/docs/en/tools/google_docs.mdx +++ b/apps/docs/content/docs/en/tools/google_docs.mdx @@ -87,10 +87,10 @@ Read content from a Google Docs document | --------- | ---- | ----------- | | `content` | string | Extracted document text content | | `metadata` | json | Document metadata including ID, title, and URL | -| ↳ `documentId` | string | Google Docs document ID | -| ↳ `title` | string | Document title | -| ↳ `mimeType` | string | Document MIME type | -| ↳ `url` | string | Document URL | +| ↳ `documentId` | string | Google Docs document ID | +| ↳ `title` | string | Document title | +| ↳ `mimeType` | string | Document MIME type | +| ↳ `url` | string | Document URL | ### `google_docs_write` @@ -109,10 +109,10 @@ Write or update content in a Google Docs document | --------- | ---- | ----------- | | `updatedContent` | boolean | Indicates if document content was updated successfully | | `metadata` | json | Updated document metadata including ID, title, and URL | -| ↳ `documentId` | string | Google Docs document ID | -| ↳ `title` | string | Document title | -| ↳ `mimeType` | string | Document MIME type | -| ↳ `url` | string | Document URL | +| ↳ `documentId` | string | Google Docs document ID | +| ↳ `title` | string | Document title | +| ↳ `mimeType` | string | Document MIME type | +| ↳ `url` | string | Document URL | ### `google_docs_create` @@ -132,9 +132,9 @@ Create a new Google Docs document | Parameter | Type | Description | | --------- | ---- | ----------- | | `metadata` | json | Created document metadata including ID, title, and URL | -| ↳ `documentId` | string | Google Docs document ID | -| ↳ `title` | string | Document title | -| ↳ `mimeType` | string | Document MIME type | -| ↳ `url` | string | Document URL | +| ↳ `documentId` | string | Google Docs document ID | +| ↳ `title` | string | Document title | +| ↳ `mimeType` | string | Document MIME type | +| ↳ `url` | string | Document URL | diff --git a/apps/docs/content/docs/en/tools/google_drive.mdx b/apps/docs/content/docs/en/tools/google_drive.mdx index 4a56b640e..39547b4f6 100644 --- a/apps/docs/content/docs/en/tools/google_drive.mdx +++ b/apps/docs/content/docs/en/tools/google_drive.mdx @@ -134,29 +134,29 @@ Get metadata for a specific file in Google Drive by its ID | Parameter | Type | Description | | --------- | ---- | ----------- | | `file` | json | The file metadata | -| ↳ `id` | string | Google Drive file ID | -| ↳ `kind` | string | Resource type identifier | -| ↳ `name` | string | File name | -| ↳ `mimeType` | string | MIME type | -| ↳ `description` | string | File description | -| ↳ `size` | string | File size in bytes | -| ↳ `starred` | boolean | Whether file is starred | -| ↳ `trashed` | boolean | Whether file is in trash | -| ↳ `webViewLink` | string | URL to view in browser | -| ↳ `webContentLink` | string | Direct download URL | -| ↳ `iconLink` | string | URL to file icon | -| ↳ `thumbnailLink` | string | URL to thumbnail | -| ↳ `parents` | json | Parent folder IDs | -| ↳ `owners` | json | List of file owners | -| ↳ `permissions` | json | File permissions | -| ↳ `createdTime` | string | File creation time | -| ↳ `modifiedTime` | string | Last modification time | -| ↳ `lastModifyingUser` | json | User who last modified the file | -| ↳ `shared` | boolean | Whether file is shared | -| ↳ `ownedByMe` | boolean | Whether owned by current user | -| ↳ `capabilities` | json | User capabilities on file | -| ↳ `md5Checksum` | string | MD5 hash | -| ↳ `version` | string | Version number | +| ↳ `id` | string | Google Drive file ID | +| ↳ `kind` | string | Resource type identifier | +| ↳ `name` | string | File name | +| ↳ `mimeType` | string | MIME type | +| ↳ `description` | string | File description | +| ↳ `size` | string | File size in bytes | +| ↳ `starred` | boolean | Whether file is starred | +| ↳ `trashed` | boolean | Whether file is in trash | +| ↳ `webViewLink` | string | URL to view in browser | +| ↳ `webContentLink` | string | Direct download URL | +| ↳ `iconLink` | string | URL to file icon | +| ↳ `thumbnailLink` | string | URL to thumbnail | +| ↳ `parents` | json | Parent folder IDs | +| ↳ `owners` | json | List of file owners | +| ↳ `permissions` | json | File permissions | +| ↳ `createdTime` | string | File creation time | +| ↳ `modifiedTime` | string | Last modification time | +| ↳ `lastModifyingUser` | json | User who last modified the file | +| ↳ `shared` | boolean | Whether file is shared | +| ↳ `ownedByMe` | boolean | Whether owned by current user | +| ↳ `capabilities` | json | User capabilities on file | +| ↳ `md5Checksum` | string | MD5 hash | +| ↳ `version` | string | Version number | ### `google_drive_create_folder` @@ -175,43 +175,43 @@ Create a new folder in Google Drive with complete metadata returned | Parameter | Type | Description | | --------- | ---- | ----------- | | `file` | object | Complete created folder metadata from Google Drive | -| ↳ `id` | string | Google Drive folder ID | -| ↳ `kind` | string | Resource type identifier | -| ↳ `name` | string | Folder name | -| ↳ `mimeType` | string | MIME type \(application/vnd.google-apps.folder\) | -| ↳ `description` | string | Folder description | -| ↳ `owners` | json | List of folder owners | -| ↳ `permissions` | json | Folder permissions | -| ↳ `permissionIds` | json | Permission IDs | -| ↳ `shared` | boolean | Whether folder is shared | -| ↳ `ownedByMe` | boolean | Whether owned by current user | -| ↳ `writersCanShare` | boolean | Whether writers can share | -| ↳ `viewersCanCopyContent` | boolean | Whether viewers can copy | -| ↳ `copyRequiresWriterPermission` | boolean | Whether copy requires writer permission | -| ↳ `sharingUser` | json | User who shared the folder | -| ↳ `starred` | boolean | Whether folder is starred | -| ↳ `trashed` | boolean | Whether folder is in trash | -| ↳ `explicitlyTrashed` | boolean | Whether explicitly trashed | -| ↳ `appProperties` | json | App-specific properties | -| ↳ `folderColorRgb` | string | Folder color | -| ↳ `createdTime` | string | Folder creation time | -| ↳ `modifiedTime` | string | Last modification time | -| ↳ `modifiedByMeTime` | string | When modified by current user | -| ↳ `viewedByMeTime` | string | When last viewed by current user | -| ↳ `sharedWithMeTime` | string | When shared with current user | -| ↳ `lastModifyingUser` | json | User who last modified the folder | -| ↳ `viewedByMe` | boolean | Whether viewed by current user | -| ↳ `modifiedByMe` | boolean | Whether modified by current user | -| ↳ `webViewLink` | string | URL to view in browser | -| ↳ `iconLink` | string | URL to folder icon | -| ↳ `parents` | json | Parent folder IDs | -| ↳ `spaces` | json | Spaces containing folder | -| ↳ `driveId` | string | Shared drive ID | -| ↳ `capabilities` | json | User capabilities on folder | -| ↳ `version` | string | Version number | -| ↳ `isAppAuthorized` | boolean | Whether created by requesting app | -| ↳ `contentRestrictions` | json | Content restrictions | -| ↳ `linkShareMetadata` | json | Link share metadata | +| ↳ `id` | string | Google Drive folder ID | +| ↳ `kind` | string | Resource type identifier | +| ↳ `name` | string | Folder name | +| ↳ `mimeType` | string | MIME type \(application/vnd.google-apps.folder\) | +| ↳ `description` | string | Folder description | +| ↳ `owners` | json | List of folder owners | +| ↳ `permissions` | json | Folder permissions | +| ↳ `permissionIds` | json | Permission IDs | +| ↳ `shared` | boolean | Whether folder is shared | +| ↳ `ownedByMe` | boolean | Whether owned by current user | +| ↳ `writersCanShare` | boolean | Whether writers can share | +| ↳ `viewersCanCopyContent` | boolean | Whether viewers can copy | +| ↳ `copyRequiresWriterPermission` | boolean | Whether copy requires writer permission | +| ↳ `sharingUser` | json | User who shared the folder | +| ↳ `starred` | boolean | Whether folder is starred | +| ↳ `trashed` | boolean | Whether folder is in trash | +| ↳ `explicitlyTrashed` | boolean | Whether explicitly trashed | +| ↳ `appProperties` | json | App-specific properties | +| ↳ `folderColorRgb` | string | Folder color | +| ↳ `createdTime` | string | Folder creation time | +| ↳ `modifiedTime` | string | Last modification time | +| ↳ `modifiedByMeTime` | string | When modified by current user | +| ↳ `viewedByMeTime` | string | When last viewed by current user | +| ↳ `sharedWithMeTime` | string | When shared with current user | +| ↳ `lastModifyingUser` | json | User who last modified the folder | +| ↳ `viewedByMe` | boolean | Whether viewed by current user | +| ↳ `modifiedByMe` | boolean | Whether modified by current user | +| ↳ `webViewLink` | string | URL to view in browser | +| ↳ `iconLink` | string | URL to folder icon | +| ↳ `parents` | json | Parent folder IDs | +| ↳ `spaces` | json | Spaces containing folder | +| ↳ `driveId` | string | Shared drive ID | +| ↳ `capabilities` | json | User capabilities on folder | +| ↳ `version` | string | Version number | +| ↳ `isAppAuthorized` | boolean | Whether created by requesting app | +| ↳ `contentRestrictions` | json | Content restrictions | +| ↳ `linkShareMetadata` | json | Link share metadata | ### `google_drive_upload` @@ -233,58 +233,58 @@ Upload a file to Google Drive with complete metadata returned | Parameter | Type | Description | | --------- | ---- | ----------- | | `file` | object | Complete uploaded file metadata from Google Drive | -| ↳ `id` | string | Google Drive file ID | -| ↳ `kind` | string | Resource type identifier | -| ↳ `name` | string | File name | -| ↳ `mimeType` | string | MIME type | -| ↳ `description` | string | File description | -| ↳ `originalFilename` | string | Original uploaded filename | -| ↳ `fullFileExtension` | string | Full file extension | -| ↳ `fileExtension` | string | File extension | -| ↳ `owners` | json | List of file owners | -| ↳ `permissions` | json | File permissions | -| ↳ `permissionIds` | json | Permission IDs | -| ↳ `shared` | boolean | Whether file is shared | -| ↳ `ownedByMe` | boolean | Whether owned by current user | -| ↳ `writersCanShare` | boolean | Whether writers can share | -| ↳ `viewersCanCopyContent` | boolean | Whether viewers can copy | -| ↳ `copyRequiresWriterPermission` | boolean | Whether copy requires writer permission | -| ↳ `sharingUser` | json | User who shared the file | -| ↳ `starred` | boolean | Whether file is starred | -| ↳ `trashed` | boolean | Whether file is in trash | -| ↳ `explicitlyTrashed` | boolean | Whether explicitly trashed | -| ↳ `appProperties` | json | App-specific properties | -| ↳ `createdTime` | string | File creation time | -| ↳ `modifiedTime` | string | Last modification time | -| ↳ `modifiedByMeTime` | string | When modified by current user | -| ↳ `viewedByMeTime` | string | When last viewed by current user | -| ↳ `sharedWithMeTime` | string | When shared with current user | -| ↳ `lastModifyingUser` | json | User who last modified the file | -| ↳ `viewedByMe` | boolean | Whether viewed by current user | -| ↳ `modifiedByMe` | boolean | Whether modified by current user | -| ↳ `webViewLink` | string | URL to view in browser | -| ↳ `webContentLink` | string | Direct download URL | -| ↳ `iconLink` | string | URL to file icon | -| ↳ `thumbnailLink` | string | URL to thumbnail | -| ↳ `exportLinks` | json | Export format links | -| ↳ `size` | string | File size in bytes | -| ↳ `quotaBytesUsed` | string | Storage quota used | -| ↳ `md5Checksum` | string | MD5 hash | -| ↳ `sha1Checksum` | string | SHA-1 hash | -| ↳ `sha256Checksum` | string | SHA-256 hash | -| ↳ `parents` | json | Parent folder IDs | -| ↳ `spaces` | json | Spaces containing file | -| ↳ `driveId` | string | Shared drive ID | -| ↳ `capabilities` | json | User capabilities on file | -| ↳ `version` | string | Version number | -| ↳ `headRevisionId` | string | Head revision ID | -| ↳ `hasThumbnail` | boolean | Whether has thumbnail | -| ↳ `thumbnailVersion` | string | Thumbnail version | -| ↳ `imageMediaMetadata` | json | Image-specific metadata | -| ↳ `videoMediaMetadata` | json | Video-specific metadata | -| ↳ `isAppAuthorized` | boolean | Whether created by requesting app | -| ↳ `contentRestrictions` | json | Content restrictions | -| ↳ `linkShareMetadata` | json | Link share metadata | +| ↳ `id` | string | Google Drive file ID | +| ↳ `kind` | string | Resource type identifier | +| ↳ `name` | string | File name | +| ↳ `mimeType` | string | MIME type | +| ↳ `description` | string | File description | +| ↳ `originalFilename` | string | Original uploaded filename | +| ↳ `fullFileExtension` | string | Full file extension | +| ↳ `fileExtension` | string | File extension | +| ↳ `owners` | json | List of file owners | +| ↳ `permissions` | json | File permissions | +| ↳ `permissionIds` | json | Permission IDs | +| ↳ `shared` | boolean | Whether file is shared | +| ↳ `ownedByMe` | boolean | Whether owned by current user | +| ↳ `writersCanShare` | boolean | Whether writers can share | +| ↳ `viewersCanCopyContent` | boolean | Whether viewers can copy | +| ↳ `copyRequiresWriterPermission` | boolean | Whether copy requires writer permission | +| ↳ `sharingUser` | json | User who shared the file | +| ↳ `starred` | boolean | Whether file is starred | +| ↳ `trashed` | boolean | Whether file is in trash | +| ↳ `explicitlyTrashed` | boolean | Whether explicitly trashed | +| ↳ `appProperties` | json | App-specific properties | +| ↳ `createdTime` | string | File creation time | +| ↳ `modifiedTime` | string | Last modification time | +| ↳ `modifiedByMeTime` | string | When modified by current user | +| ↳ `viewedByMeTime` | string | When last viewed by current user | +| ↳ `sharedWithMeTime` | string | When shared with current user | +| ↳ `lastModifyingUser` | json | User who last modified the file | +| ↳ `viewedByMe` | boolean | Whether viewed by current user | +| ↳ `modifiedByMe` | boolean | Whether modified by current user | +| ↳ `webViewLink` | string | URL to view in browser | +| ↳ `webContentLink` | string | Direct download URL | +| ↳ `iconLink` | string | URL to file icon | +| ↳ `thumbnailLink` | string | URL to thumbnail | +| ↳ `exportLinks` | json | Export format links | +| ↳ `size` | string | File size in bytes | +| ↳ `quotaBytesUsed` | string | Storage quota used | +| ↳ `md5Checksum` | string | MD5 hash | +| ↳ `sha1Checksum` | string | SHA-1 hash | +| ↳ `sha256Checksum` | string | SHA-256 hash | +| ↳ `parents` | json | Parent folder IDs | +| ↳ `spaces` | json | Spaces containing file | +| ↳ `driveId` | string | Shared drive ID | +| ↳ `capabilities` | json | User capabilities on file | +| ↳ `version` | string | Version number | +| ↳ `headRevisionId` | string | Head revision ID | +| ↳ `hasThumbnail` | boolean | Whether has thumbnail | +| ↳ `thumbnailVersion` | string | Thumbnail version | +| ↳ `imageMediaMetadata` | json | Image-specific metadata | +| ↳ `videoMediaMetadata` | json | Video-specific metadata | +| ↳ `isAppAuthorized` | boolean | Whether created by requesting app | +| ↳ `contentRestrictions` | json | Content restrictions | +| ↳ `linkShareMetadata` | json | Link share metadata | ### `google_drive_download` @@ -304,64 +304,64 @@ Download a file from Google Drive with complete metadata (exports Google Workspa | Parameter | Type | Description | | --------- | ---- | ----------- | | `file` | object | Downloaded file data | -| ↳ `name` | string | File name | -| ↳ `mimeType` | string | MIME type of the file | -| ↳ `data` | string | File content as base64-encoded string | -| ↳ `size` | number | File size in bytes | +| ↳ `name` | string | File name | +| ↳ `mimeType` | string | MIME type of the file | +| ↳ `data` | string | File content as base64-encoded string | +| ↳ `size` | number | File size in bytes | | `metadata` | object | Complete file metadata from Google Drive | -| ↳ `id` | string | Google Drive file ID | -| ↳ `kind` | string | Resource type identifier | -| ↳ `name` | string | File name | -| ↳ `mimeType` | string | MIME type | -| ↳ `description` | string | File description | -| ↳ `originalFilename` | string | Original uploaded filename | -| ↳ `fullFileExtension` | string | Full file extension | -| ↳ `fileExtension` | string | File extension | -| ↳ `owners` | json | List of file owners | -| ↳ `permissions` | json | File permissions | -| ↳ `permissionIds` | json | Permission IDs | -| ↳ `shared` | boolean | Whether file is shared | -| ↳ `ownedByMe` | boolean | Whether owned by current user | -| ↳ `writersCanShare` | boolean | Whether writers can share | -| ↳ `viewersCanCopyContent` | boolean | Whether viewers can copy | -| ↳ `copyRequiresWriterPermission` | boolean | Whether copy requires writer permission | -| ↳ `sharingUser` | json | User who shared the file | -| ↳ `starred` | boolean | Whether file is starred | -| ↳ `trashed` | boolean | Whether file is in trash | -| ↳ `explicitlyTrashed` | boolean | Whether explicitly trashed | -| ↳ `appProperties` | json | App-specific properties | -| ↳ `createdTime` | string | File creation time | -| ↳ `modifiedTime` | string | Last modification time | -| ↳ `modifiedByMeTime` | string | When modified by current user | -| ↳ `viewedByMeTime` | string | When last viewed by current user | -| ↳ `sharedWithMeTime` | string | When shared with current user | -| ↳ `lastModifyingUser` | json | User who last modified the file | -| ↳ `viewedByMe` | boolean | Whether viewed by current user | -| ↳ `modifiedByMe` | boolean | Whether modified by current user | -| ↳ `webViewLink` | string | URL to view in browser | -| ↳ `webContentLink` | string | Direct download URL | -| ↳ `iconLink` | string | URL to file icon | -| ↳ `thumbnailLink` | string | URL to thumbnail | -| ↳ `exportLinks` | json | Export format links | -| ↳ `size` | string | File size in bytes | -| ↳ `quotaBytesUsed` | string | Storage quota used | -| ↳ `md5Checksum` | string | MD5 hash | -| ↳ `sha1Checksum` | string | SHA-1 hash | -| ↳ `sha256Checksum` | string | SHA-256 hash | -| ↳ `parents` | json | Parent folder IDs | -| ↳ `spaces` | json | Spaces containing file | -| ↳ `driveId` | string | Shared drive ID | -| ↳ `capabilities` | json | User capabilities on file | -| ↳ `version` | string | Version number | -| ↳ `headRevisionId` | string | Head revision ID | -| ↳ `hasThumbnail` | boolean | Whether has thumbnail | -| ↳ `thumbnailVersion` | string | Thumbnail version | -| ↳ `imageMediaMetadata` | json | Image-specific metadata | -| ↳ `videoMediaMetadata` | json | Video-specific metadata | -| ↳ `isAppAuthorized` | boolean | Whether created by requesting app | -| ↳ `contentRestrictions` | json | Content restrictions | -| ↳ `linkShareMetadata` | json | Link share metadata | -| ↳ `revisions` | json | File revision history \(first 100 revisions only\) | +| ↳ `id` | string | Google Drive file ID | +| ↳ `kind` | string | Resource type identifier | +| ↳ `name` | string | File name | +| ↳ `mimeType` | string | MIME type | +| ↳ `description` | string | File description | +| ↳ `originalFilename` | string | Original uploaded filename | +| ↳ `fullFileExtension` | string | Full file extension | +| ↳ `fileExtension` | string | File extension | +| ↳ `owners` | json | List of file owners | +| ↳ `permissions` | json | File permissions | +| ↳ `permissionIds` | json | Permission IDs | +| ↳ `shared` | boolean | Whether file is shared | +| ↳ `ownedByMe` | boolean | Whether owned by current user | +| ↳ `writersCanShare` | boolean | Whether writers can share | +| ↳ `viewersCanCopyContent` | boolean | Whether viewers can copy | +| ↳ `copyRequiresWriterPermission` | boolean | Whether copy requires writer permission | +| ↳ `sharingUser` | json | User who shared the file | +| ↳ `starred` | boolean | Whether file is starred | +| ↳ `trashed` | boolean | Whether file is in trash | +| ↳ `explicitlyTrashed` | boolean | Whether explicitly trashed | +| ↳ `appProperties` | json | App-specific properties | +| ↳ `createdTime` | string | File creation time | +| ↳ `modifiedTime` | string | Last modification time | +| ↳ `modifiedByMeTime` | string | When modified by current user | +| ↳ `viewedByMeTime` | string | When last viewed by current user | +| ↳ `sharedWithMeTime` | string | When shared with current user | +| ↳ `lastModifyingUser` | json | User who last modified the file | +| ↳ `viewedByMe` | boolean | Whether viewed by current user | +| ↳ `modifiedByMe` | boolean | Whether modified by current user | +| ↳ `webViewLink` | string | URL to view in browser | +| ↳ `webContentLink` | string | Direct download URL | +| ↳ `iconLink` | string | URL to file icon | +| ↳ `thumbnailLink` | string | URL to thumbnail | +| ↳ `exportLinks` | json | Export format links | +| ↳ `size` | string | File size in bytes | +| ↳ `quotaBytesUsed` | string | Storage quota used | +| ↳ `md5Checksum` | string | MD5 hash | +| ↳ `sha1Checksum` | string | SHA-1 hash | +| ↳ `sha256Checksum` | string | SHA-256 hash | +| ↳ `parents` | json | Parent folder IDs | +| ↳ `spaces` | json | Spaces containing file | +| ↳ `driveId` | string | Shared drive ID | +| ↳ `capabilities` | json | User capabilities on file | +| ↳ `version` | string | Version number | +| ↳ `headRevisionId` | string | Head revision ID | +| ↳ `hasThumbnail` | boolean | Whether has thumbnail | +| ↳ `thumbnailVersion` | string | Thumbnail version | +| ↳ `imageMediaMetadata` | json | Image-specific metadata | +| ↳ `videoMediaMetadata` | json | Video-specific metadata | +| ↳ `isAppAuthorized` | boolean | Whether created by requesting app | +| ↳ `contentRestrictions` | json | Content restrictions | +| ↳ `linkShareMetadata` | json | Link share metadata | +| ↳ `revisions` | json | File revision history \(first 100 revisions only\) | ### `google_drive_copy` @@ -380,16 +380,16 @@ Create a copy of a file in Google Drive | Parameter | Type | Description | | --------- | ---- | ----------- | | `file` | json | The copied file metadata | -| ↳ `id` | string | Google Drive file ID of the copy | -| ↳ `kind` | string | Resource type identifier | -| ↳ `name` | string | File name | -| ↳ `mimeType` | string | MIME type | -| ↳ `webViewLink` | string | URL to view in browser | -| ↳ `parents` | json | Parent folder IDs | -| ↳ `createdTime` | string | File creation time | -| ↳ `modifiedTime` | string | Last modification time | -| ↳ `owners` | json | List of file owners | -| ↳ `size` | string | File size in bytes | +| ↳ `id` | string | Google Drive file ID of the copy | +| ↳ `kind` | string | Resource type identifier | +| ↳ `name` | string | File name | +| ↳ `mimeType` | string | MIME type | +| ↳ `webViewLink` | string | URL to view in browser | +| ↳ `parents` | json | Parent folder IDs | +| ↳ `createdTime` | string | File creation time | +| ↳ `modifiedTime` | string | Last modification time | +| ↳ `owners` | json | List of file owners | +| ↳ `size` | string | File size in bytes | ### `google_drive_update` @@ -411,15 +411,15 @@ Update file metadata in Google Drive (rename, move, star, add description) | Parameter | Type | Description | | --------- | ---- | ----------- | | `file` | json | The updated file metadata | -| ↳ `id` | string | Google Drive file ID | -| ↳ `kind` | string | Resource type identifier | -| ↳ `name` | string | File name | -| ↳ `mimeType` | string | MIME type | -| ↳ `description` | string | File description | -| ↳ `starred` | boolean | Whether file is starred | -| ↳ `webViewLink` | string | URL to view in browser | -| ↳ `parents` | json | Parent folder IDs | -| ↳ `modifiedTime` | string | Last modification time | +| ↳ `id` | string | Google Drive file ID | +| ↳ `kind` | string | Resource type identifier | +| ↳ `name` | string | File name | +| ↳ `mimeType` | string | MIME type | +| ↳ `description` | string | File description | +| ↳ `starred` | boolean | Whether file is starred | +| ↳ `webViewLink` | string | URL to view in browser | +| ↳ `parents` | json | Parent folder IDs | +| ↳ `modifiedTime` | string | Last modification time | ### `google_drive_trash` @@ -436,13 +436,13 @@ Move a file to the trash in Google Drive (can be restored later) | Parameter | Type | Description | | --------- | ---- | ----------- | | `file` | json | The trashed file metadata | -| ↳ `id` | string | Google Drive file ID | -| ↳ `kind` | string | Resource type identifier | -| ↳ `name` | string | File name | -| ↳ `mimeType` | string | MIME type | -| ↳ `trashed` | boolean | Whether file is in trash \(should be true\) | -| ↳ `trashedTime` | string | When file was trashed | -| ↳ `webViewLink` | string | URL to view in browser | +| ↳ `id` | string | Google Drive file ID | +| ↳ `kind` | string | Resource type identifier | +| ↳ `name` | string | File name | +| ↳ `mimeType` | string | MIME type | +| ↳ `trashed` | boolean | Whether file is in trash \(should be true\) | +| ↳ `trashedTime` | string | When file was trashed | +| ↳ `webViewLink` | string | URL to view in browser | ### `google_drive_delete` @@ -484,14 +484,14 @@ Share a file with a user, group, domain, or make it public | Parameter | Type | Description | | --------- | ---- | ----------- | | `permission` | json | The created permission details | -| ↳ `id` | string | Permission ID | -| ↳ `type` | string | Grantee type \(user, group, domain, anyone\) | -| ↳ `role` | string | Permission role | -| ↳ `emailAddress` | string | Email of the grantee | -| ↳ `displayName` | string | Display name of the grantee | -| ↳ `domain` | string | Domain of the grantee | -| ↳ `expirationTime` | string | Expiration time | -| ↳ `deleted` | boolean | Whether grantee is deleted | +| ↳ `id` | string | Permission ID | +| ↳ `type` | string | Grantee type \(user, group, domain, anyone\) | +| ↳ `role` | string | Permission role | +| ↳ `emailAddress` | string | Email of the grantee | +| ↳ `displayName` | string | Display name of the grantee | +| ↳ `domain` | string | Domain of the grantee | +| ↳ `expirationTime` | string | Expiration time | +| ↳ `deleted` | boolean | Whether grantee is deleted | ### `google_drive_unshare` @@ -555,16 +555,16 @@ Get information about the user and their Google Drive (storage quota, capabiliti | Parameter | Type | Description | | --------- | ---- | ----------- | | `user` | json | Information about the authenticated user | -| ↳ `displayName` | string | User display name | -| ↳ `emailAddress` | string | User email address | -| ↳ `photoLink` | string | URL to user profile photo | -| ↳ `permissionId` | string | User permission ID | -| ↳ `me` | boolean | Whether this is the authenticated user | +| ↳ `displayName` | string | User display name | +| ↳ `emailAddress` | string | User email address | +| ↳ `photoLink` | string | URL to user profile photo | +| ↳ `permissionId` | string | User permission ID | +| ↳ `me` | boolean | Whether this is the authenticated user | | `storageQuota` | json | Storage quota information in bytes | -| ↳ `limit` | string | Total storage limit in bytes \(null for unlimited\) | -| ↳ `usage` | string | Total storage used in bytes | -| ↳ `usageInDrive` | string | Storage used by Drive files in bytes | -| ↳ `usageInDriveTrash` | string | Storage used by trashed files in bytes | +| ↳ `limit` | string | Total storage limit in bytes \(null for unlimited\) | +| ↳ `usage` | string | Total storage used in bytes | +| ↳ `usageInDrive` | string | Storage used by Drive files in bytes | +| ↳ `usageInDriveTrash` | string | Storage used by trashed files in bytes | | `canCreateDrives` | boolean | Whether user can create shared drives | | `importFormats` | json | Map of MIME types that can be imported and their target formats | | `exportFormats` | json | Map of Google Workspace MIME types and their exportable formats | diff --git a/apps/docs/content/docs/en/tools/google_forms.mdx b/apps/docs/content/docs/en/tools/google_forms.mdx index f7f835321..8e73de385 100644 --- a/apps/docs/content/docs/en/tools/google_forms.mdx +++ b/apps/docs/content/docs/en/tools/google_forms.mdx @@ -57,10 +57,10 @@ Retrieve a single response or list responses from a Google Form | ↳ `lastSubmittedTime` | string | When the response was last submitted | | ↳ `answers` | json | Map of question IDs to answer values | | `response` | object | Single form response \(when responseId is provided\) | -| ↳ `responseId` | string | Unique response ID | -| ↳ `createTime` | string | When the response was created | -| ↳ `lastSubmittedTime` | string | When the response was last submitted | -| ↳ `answers` | json | Map of question IDs to answer values | +| ↳ `responseId` | string | Unique response ID | +| ↳ `createTime` | string | When the response was created | +| ↳ `lastSubmittedTime` | string | When the response was last submitted | +| ↳ `answers` | json | Map of question IDs to answer values | | `raw` | json | Raw API response data | ### `google_forms_get_form` @@ -131,25 +131,25 @@ Apply multiple updates to a form (add items, update info, change settings, etc.) | --------- | ---- | ----------- | | `replies` | array | The replies from each update request | | `writeControl` | object | Write control information with revision IDs | -| ↳ `requiredRevisionId` | string | Required revision ID for conflict detection | -| ↳ `targetRevisionId` | string | Target revision ID | +| ↳ `requiredRevisionId` | string | Required revision ID for conflict detection | +| ↳ `targetRevisionId` | string | Target revision ID | | `form` | object | The updated form \(if includeFormInResponse was true\) | -| ↳ `formId` | string | The form ID | -| ↳ `info` | object | Form info containing title and description | -| ↳ `title` | string | The form title visible to responders | -| ↳ `description` | string | The form description | -| ↳ `documentTitle` | string | The document title visible in Drive | -| ↳ `settings` | object | Form settings | -| ↳ `quizSettings` | object | Quiz settings | -| ↳ `isQuiz` | boolean | Whether the form is a quiz | -| ↳ `emailCollectionType` | string | Email collection type | -| ↳ `revisionId` | string | The revision ID of the form | -| ↳ `responderUri` | string | The URI to share with responders | -| ↳ `linkedSheetId` | string | The ID of the linked Google Sheet | -| ↳ `publishSettings` | object | Form publish settings | -| ↳ `publishState` | object | Current publish state | -| ↳ `isPublished` | boolean | Whether the form is published | -| ↳ `isAcceptingResponses` | boolean | Whether the form is accepting responses | +| ↳ `formId` | string | The form ID | +| ↳ `info` | object | Form info containing title and description | +| ↳ `title` | string | The form title visible to responders | +| ↳ `description` | string | The form description | +| ↳ `documentTitle` | string | The document title visible in Drive | +| ↳ `settings` | object | Form settings | +| ↳ `quizSettings` | object | Quiz settings | +| ↳ `isQuiz` | boolean | Whether the form is a quiz | +| ↳ `emailCollectionType` | string | Email collection type | +| ↳ `revisionId` | string | The revision ID of the form | +| ↳ `responderUri` | string | The URI to share with responders | +| ↳ `linkedSheetId` | string | The ID of the linked Google Sheet | +| ↳ `publishSettings` | object | Form publish settings | +| ↳ `publishState` | object | Current publish state | +| ↳ `isPublished` | boolean | Whether the form is published | +| ↳ `isAcceptingResponses` | boolean | Whether the form is accepting responses | ### `google_forms_set_publish_settings` @@ -169,9 +169,9 @@ Update the publish settings of a form (publish/unpublish, accept responses) | --------- | ---- | ----------- | | `formId` | string | The form ID | | `publishSettings` | json | The updated publish settings | -| ↳ `publishState` | object | The publish state | -| ↳ `isPublished` | boolean | Whether the form is published | -| ↳ `isAcceptingResponses` | boolean | Whether the form accepts responses | +| ↳ `publishState` | object | The publish state | +| ↳ `isPublished` | boolean | Whether the form is published | +| ↳ `isAcceptingResponses` | boolean | Whether the form accepts responses | ### `google_forms_create_watch` diff --git a/apps/docs/content/docs/en/tools/google_groups.mdx b/apps/docs/content/docs/en/tools/google_groups.mdx index f967ebf27..053dffc71 100644 --- a/apps/docs/content/docs/en/tools/google_groups.mdx +++ b/apps/docs/content/docs/en/tools/google_groups.mdx @@ -231,7 +231,7 @@ List all email aliases for a Google Group | --------- | ---- | ----------- | | `aliases` | array | List of email aliases for the group | | ↳ `id` | string | Unique group identifier | -| ↳ `primaryEmail` | string | Group | +| ↳ `primaryEmail` | string | Group's primary email address | | ↳ `alias` | string | Alias email address | | ↳ `kind` | string | API resource type | | ↳ `etag` | string | Resource version identifier | @@ -252,7 +252,7 @@ Add an email alias to a Google Group | Parameter | Type | Description | | --------- | ---- | ----------- | | `id` | string | Unique group identifier | -| `primaryEmail` | string | Group | +| `primaryEmail` | string | Group's primary email address | | `alias` | string | The alias that was added | | `kind` | string | API resource type | | `etag` | string | Resource version identifier | @@ -288,7 +288,7 @@ Get the settings for a Google Group including access permissions, moderation, an | Parameter | Type | Description | | --------- | ---- | ----------- | -| `email` | string | The group | +| `email` | string | The group's email address | | `name` | string | The group name \(max 75 characters\) | | `description` | string | The group description \(max 4096 characters\) | | `whoCanJoin` | string | Who can join the group \(ANYONE_CAN_JOIN, ALL_IN_DOMAIN_CAN_JOIN, INVITED_CAN_JOIN, CAN_REQUEST_TO_JOIN\) | @@ -297,7 +297,7 @@ Get the settings for a Google Group including access permissions, moderation, an | `whoCanPostMessage` | string | Who can post messages to the group | | `allowExternalMembers` | string | Whether external users can be members | | `allowWebPosting` | string | Whether web posting is allowed | -| `primaryLanguage` | string | The group | +| `primaryLanguage` | string | The group's primary language | | `isArchived` | string | Whether messages are archived | | `archiveOnly` | string | Whether the group is archive-only \(inactive\) | | `messageModerationLevel` | string | Message moderation level | @@ -368,7 +368,7 @@ Update the settings for a Google Group including access permissions, moderation, | Parameter | Type | Description | | --------- | ---- | ----------- | -| `email` | string | The group | +| `email` | string | The group's email address | | `name` | string | The group name | | `description` | string | The group description | | `whoCanJoin` | string | Who can join the group | @@ -377,7 +377,7 @@ Update the settings for a Google Group including access permissions, moderation, | `whoCanPostMessage` | string | Who can post messages to the group | | `allowExternalMembers` | string | Whether external users can be members | | `allowWebPosting` | string | Whether web posting is allowed | -| `primaryLanguage` | string | The group | +| `primaryLanguage` | string | The group's primary language | | `isArchived` | string | Whether messages are archived | | `archiveOnly` | string | Whether the group is archive-only | | `messageModerationLevel` | string | Message moderation level | diff --git a/apps/docs/content/docs/en/tools/google_search.mdx b/apps/docs/content/docs/en/tools/google_search.mdx index d051eef9f..4b7b535b9 100644 --- a/apps/docs/content/docs/en/tools/google_search.mdx +++ b/apps/docs/content/docs/en/tools/google_search.mdx @@ -66,12 +66,12 @@ Search the web with the Custom Search API | ↳ `title` | string | Title of the search result | | ↳ `link` | string | URL of the search result | | ↳ `snippet` | string | Snippet or description of the search result | -| ↳ `displayLink` | string | Display URL | -| ↳ `pagemap` | object | Additional page metadata | +| ↳ `displayLink` | string | Display URL \(abbreviated form\) | +| ↳ `pagemap` | object | PageMap information for the result \(structured data\) | | `searchInformation` | object | Information about the search query and results | -| ↳ `totalResults` | string | Total number of search results available | -| ↳ `searchTime` | number | Time taken to perform the search in seconds | -| ↳ `formattedSearchTime` | string | Formatted search time for display | -| ↳ `formattedTotalResults` | string | Formatted total results count for display | +| ↳ `totalResults` | string | Total number of search results available | +| ↳ `searchTime` | number | Time taken to perform the search in seconds | +| ↳ `formattedSearchTime` | string | Formatted search time for display | +| ↳ `formattedTotalResults` | string | Formatted total results count for display | diff --git a/apps/docs/content/docs/en/tools/google_sheets.mdx b/apps/docs/content/docs/en/tools/google_sheets.mdx index 73ae75fa0..0325f1d5e 100644 --- a/apps/docs/content/docs/en/tools/google_sheets.mdx +++ b/apps/docs/content/docs/en/tools/google_sheets.mdx @@ -53,8 +53,8 @@ Read data from a specific sheet in a Google Sheets spreadsheet | `range` | string | The range of cells that was read | | `values` | array | The cell values as a 2D array | | `metadata` | json | Spreadsheet metadata including ID and URL | -| ↳ `spreadsheetId` | string | Google Sheets spreadsheet ID | -| ↳ `spreadsheetUrl` | string | Spreadsheet URL | +| ↳ `spreadsheetId` | string | Google Sheets spreadsheet ID | +| ↳ `spreadsheetUrl` | string | Spreadsheet URL | ### `google_sheets_write` @@ -79,8 +79,8 @@ Write data to a specific sheet in a Google Sheets spreadsheet | `updatedColumns` | number | Number of columns updated | | `updatedCells` | number | Number of cells updated | | `metadata` | json | Spreadsheet metadata including ID and URL | -| ↳ `spreadsheetId` | string | Google Sheets spreadsheet ID | -| ↳ `spreadsheetUrl` | string | Spreadsheet URL | +| ↳ `spreadsheetId` | string | Google Sheets spreadsheet ID | +| ↳ `spreadsheetUrl` | string | Spreadsheet URL | ### `google_sheets_update` @@ -105,8 +105,8 @@ Update data in a specific sheet in a Google Sheets spreadsheet | `updatedColumns` | number | Number of columns updated | | `updatedCells` | number | Number of cells updated | | `metadata` | json | Spreadsheet metadata including ID and URL | -| ↳ `spreadsheetId` | string | Google Sheets spreadsheet ID | -| ↳ `spreadsheetUrl` | string | Spreadsheet URL | +| ↳ `spreadsheetId` | string | Google Sheets spreadsheet ID | +| ↳ `spreadsheetUrl` | string | Spreadsheet URL | ### `google_sheets_append` @@ -133,8 +133,8 @@ Append data to the end of a specific sheet in a Google Sheets spreadsheet | `updatedColumns` | number | Number of columns updated | | `updatedCells` | number | Number of cells updated | | `metadata` | json | Spreadsheet metadata including ID and URL | -| ↳ `spreadsheetId` | string | Google Sheets spreadsheet ID | -| ↳ `spreadsheetUrl` | string | Spreadsheet URL | +| ↳ `spreadsheetId` | string | Google Sheets spreadsheet ID | +| ↳ `spreadsheetUrl` | string | Spreadsheet URL | ### `google_sheets_clear` @@ -155,8 +155,8 @@ Clear values from a specific range in a Google Sheets spreadsheet | `clearedRange` | string | The range that was cleared | | `sheetName` | string | Name of the sheet that was cleared | | `metadata` | json | Spreadsheet metadata including ID and URL | -| ↳ `spreadsheetId` | string | Google Sheets spreadsheet ID | -| ↳ `spreadsheetUrl` | string | Spreadsheet URL | +| ↳ `spreadsheetId` | string | Google Sheets spreadsheet ID | +| ↳ `spreadsheetUrl` | string | Spreadsheet URL | ### `google_sheets_get_spreadsheet` @@ -234,8 +234,8 @@ Read multiple ranges from a Google Sheets spreadsheet in a single request | ↳ `majorDimension` | string | Major dimension \(ROWS or COLUMNS\) | | ↳ `values` | array | The cell values as a 2D array | | `metadata` | json | Spreadsheet metadata including ID and URL | -| ↳ `spreadsheetId` | string | Google Sheets spreadsheet ID | -| ↳ `spreadsheetUrl` | string | Spreadsheet URL | +| ↳ `spreadsheetId` | string | Google Sheets spreadsheet ID | +| ↳ `spreadsheetUrl` | string | Spreadsheet URL | ### `google_sheets_batch_update` @@ -265,8 +265,8 @@ Update multiple ranges in a Google Sheets spreadsheet in a single request | ↳ `updatedColumns` | number | Number of columns updated in this range | | ↳ `updatedCells` | number | Number of cells updated in this range | | `metadata` | json | Spreadsheet metadata including ID and URL | -| ↳ `spreadsheetId` | string | Google Sheets spreadsheet ID | -| ↳ `spreadsheetUrl` | string | Spreadsheet URL | +| ↳ `spreadsheetId` | string | Google Sheets spreadsheet ID | +| ↳ `spreadsheetUrl` | string | Spreadsheet URL | ### `google_sheets_batch_clear` @@ -286,8 +286,8 @@ Clear multiple ranges in a Google Sheets spreadsheet in a single request | `spreadsheetId` | string | The spreadsheet ID | | `clearedRanges` | array | Array of ranges that were cleared | | `metadata` | json | Spreadsheet metadata including ID and URL | -| ↳ `spreadsheetId` | string | Google Sheets spreadsheet ID | -| ↳ `spreadsheetUrl` | string | Spreadsheet URL | +| ↳ `spreadsheetId` | string | Google Sheets spreadsheet ID | +| ↳ `spreadsheetUrl` | string | Spreadsheet URL | ### `google_sheets_copy_sheet` diff --git a/apps/docs/content/docs/en/tools/google_slides.mdx b/apps/docs/content/docs/en/tools/google_slides.mdx index f512b4c4b..1c852b797 100644 --- a/apps/docs/content/docs/en/tools/google_slides.mdx +++ b/apps/docs/content/docs/en/tools/google_slides.mdx @@ -52,13 +52,13 @@ Read content from a Google Slides presentation | --------- | ---- | ----------- | | `slides` | json | Array of slides with their content | | `metadata` | json | Presentation metadata including ID, title, and URL | -| ↳ `presentationId` | string | The presentation ID | -| ↳ `title` | string | The presentation title | -| ↳ `pageSize` | object | Presentation page size | -| ↳ `width` | json | Page width as a Dimension object | -| ↳ `height` | json | Page height as a Dimension object | -| ↳ `mimeType` | string | The mime type of the presentation | -| ↳ `url` | string | URL to open the presentation | +| ↳ `presentationId` | string | The presentation ID | +| ↳ `title` | string | The presentation title | +| ↳ `pageSize` | object | Presentation page size | +| ↳ `width` | json | Page width as a Dimension object | +| ↳ `height` | json | Page height as a Dimension object | +| ↳ `mimeType` | string | The mime type of the presentation | +| ↳ `url` | string | URL to open the presentation | ### `google_slides_write` @@ -78,10 +78,10 @@ Write or update content in a Google Slides presentation | --------- | ---- | ----------- | | `updatedContent` | boolean | Indicates if presentation content was updated successfully | | `metadata` | json | Updated presentation metadata including ID, title, and URL | -| ↳ `presentationId` | string | The presentation ID | -| ↳ `title` | string | The presentation title | -| ↳ `mimeType` | string | The mime type of the presentation | -| ↳ `url` | string | URL to open the presentation | +| ↳ `presentationId` | string | The presentation ID | +| ↳ `title` | string | The presentation title | +| ↳ `mimeType` | string | The mime type of the presentation | +| ↳ `url` | string | URL to open the presentation | ### `google_slides_create` @@ -101,10 +101,10 @@ Create a new Google Slides presentation | Parameter | Type | Description | | --------- | ---- | ----------- | | `metadata` | json | Created presentation metadata including ID, title, and URL | -| ↳ `presentationId` | string | The presentation ID | -| ↳ `title` | string | The presentation title | -| ↳ `mimeType` | string | The mime type of the presentation | -| ↳ `url` | string | URL to open the presentation | +| ↳ `presentationId` | string | The presentation ID | +| ↳ `title` | string | The presentation title | +| ↳ `mimeType` | string | The mime type of the presentation | +| ↳ `url` | string | URL to open the presentation | ### `google_slides_replace_all_text` @@ -126,10 +126,10 @@ Find and replace all occurrences of text throughout a Google Slides presentation | --------- | ---- | ----------- | | `occurrencesChanged` | number | Number of text occurrences that were replaced | | `metadata` | json | Operation metadata including presentation ID and URL | -| ↳ `presentationId` | string | The presentation ID | -| ↳ `findText` | string | The text that was searched for | -| ↳ `replaceText` | string | The text that replaced the matches | -| ↳ `url` | string | URL to open the presentation | +| ↳ `presentationId` | string | The presentation ID | +| ↳ `findText` | string | The text that was searched for | +| ↳ `replaceText` | string | The text that replaced the matches | +| ↳ `url` | string | URL to open the presentation | ### `google_slides_add_slide` @@ -150,10 +150,10 @@ Add a new slide to a Google Slides presentation with a specified layout | --------- | ---- | ----------- | | `slideId` | string | The object ID of the newly created slide | | `metadata` | json | Operation metadata including presentation ID, layout, and URL | -| ↳ `presentationId` | string | The presentation ID | -| ↳ `layout` | string | The layout used for the new slide | -| ↳ `insertionIndex` | number | The zero-based index where the slide was inserted | -| ↳ `url` | string | URL to open the presentation | +| ↳ `presentationId` | string | The presentation ID | +| ↳ `layout` | string | The layout used for the new slide | +| ↳ `insertionIndex` | number | The zero-based index where the slide was inserted | +| ↳ `url` | string | URL to open the presentation | ### `google_slides_add_image` @@ -177,10 +177,10 @@ Insert an image into a specific slide in a Google Slides presentation | --------- | ---- | ----------- | | `imageId` | string | The object ID of the newly created image | | `metadata` | json | Operation metadata including presentation ID and image URL | -| ↳ `presentationId` | string | The presentation ID | -| ↳ `pageObjectId` | string | The page object ID where the image was inserted | -| ↳ `imageUrl` | string | The source image URL | -| ↳ `url` | string | URL to open the presentation | +| ↳ `presentationId` | string | The presentation ID | +| ↳ `pageObjectId` | string | The page object ID where the image was inserted | +| ↳ `imageUrl` | string | The source image URL | +| ↳ `url` | string | URL to open the presentation | ### `google_slides_get_thumbnail` @@ -203,10 +203,10 @@ Generate a thumbnail image of a specific slide in a Google Slides presentation | `width` | number | Width of the thumbnail in pixels | | `height` | number | Height of the thumbnail in pixels | | `metadata` | json | Operation metadata including presentation ID and page object ID | -| ↳ `presentationId` | string | The presentation ID | -| ↳ `pageObjectId` | string | The page object ID for the thumbnail | -| ↳ `thumbnailSize` | string | The requested thumbnail size | -| ↳ `mimeType` | string | The thumbnail MIME type | +| ↳ `presentationId` | string | The presentation ID | +| ↳ `pageObjectId` | string | The page object ID for the thumbnail | +| ↳ `thumbnailSize` | string | The requested thumbnail size | +| ↳ `mimeType` | string | The thumbnail MIME type | ### `google_slides_get_page` @@ -227,12 +227,12 @@ Get detailed information about a specific slide/page in a Google Slides presenta | `pageType` | string | The type of page \(SLIDE, MASTER, LAYOUT, NOTES, NOTES_MASTER\) | | `pageElements` | array | Array of page elements \(shapes, images, tables, etc.\) on this page | | `slideProperties` | object | Properties specific to slides \(layout, master, notes\) | -| ↳ `layoutObjectId` | string | Object ID of the layout this slide is based on | -| ↳ `masterObjectId` | string | Object ID of the master this slide is based on | -| ↳ `notesPage` | json | The notes page associated with the slide | +| ↳ `layoutObjectId` | string | Object ID of the layout this slide is based on | +| ↳ `masterObjectId` | string | Object ID of the master this slide is based on | +| ↳ `notesPage` | json | The notes page associated with the slide | | `metadata` | object | Operation metadata including presentation ID and URL | -| ↳ `presentationId` | string | The presentation ID | -| ↳ `url` | string | URL to the presentation | +| ↳ `presentationId` | string | The presentation ID | +| ↳ `url` | string | URL to the presentation | ### `google_slides_delete_object` @@ -252,8 +252,8 @@ Delete a page element (shape, image, table, etc.) or an entire slide from a Goog | `deleted` | boolean | Whether the object was successfully deleted | | `objectId` | string | The object ID that was deleted | | `metadata` | object | Operation metadata including presentation ID and URL | -| ↳ `presentationId` | string | The presentation ID | -| ↳ `url` | string | URL to the presentation | +| ↳ `presentationId` | string | The presentation ID | +| ↳ `url` | string | URL to the presentation | ### `google_slides_duplicate_object` @@ -274,9 +274,9 @@ Duplicate an object (slide, shape, image, table, etc.) in a Google Slides presen | --------- | ---- | ----------- | | `duplicatedObjectId` | string | The object ID of the newly created duplicate | | `metadata` | object | Operation metadata including presentation ID and source object ID | -| ↳ `presentationId` | string | The presentation ID | -| ↳ `sourceObjectId` | string | The original object ID that was duplicated | -| ↳ `url` | string | URL to the presentation | +| ↳ `presentationId` | string | The presentation ID | +| ↳ `sourceObjectId` | string | The original object ID that was duplicated | +| ↳ `url` | string | URL to the presentation | ### `google_slides_update_slides_position` @@ -298,8 +298,8 @@ Move one or more slides to a new position in a Google Slides presentation | `slideObjectIds` | array | The slide object IDs that were moved | | `insertionIndex` | number | The index where the slides were moved to | | `metadata` | object | Operation metadata including presentation ID and URL | -| ↳ `presentationId` | string | The presentation ID | -| ↳ `url` | string | URL to the presentation | +| ↳ `presentationId` | string | The presentation ID | +| ↳ `url` | string | URL to the presentation | ### `google_slides_create_table` @@ -326,9 +326,9 @@ Create a new table on a slide in a Google Slides presentation | `rows` | number | Number of rows in the table | | `columns` | number | Number of columns in the table | | `metadata` | object | Operation metadata including presentation ID and page object ID | -| ↳ `presentationId` | string | The presentation ID | -| ↳ `pageObjectId` | string | The page object ID where the table was created | -| ↳ `url` | string | URL to the presentation | +| ↳ `presentationId` | string | The presentation ID | +| ↳ `pageObjectId` | string | The page object ID where the table was created | +| ↳ `url` | string | URL to the presentation | ### `google_slides_create_shape` @@ -353,9 +353,9 @@ Create a shape (rectangle, ellipse, text box, arrow, etc.) on a slide in a Googl | `shapeId` | string | The object ID of the newly created shape | | `shapeType` | string | The type of shape that was created | | `metadata` | object | Operation metadata including presentation ID and page object ID | -| ↳ `presentationId` | string | The presentation ID | -| ↳ `pageObjectId` | string | The page object ID where the shape was created | -| ↳ `url` | string | URL to the presentation | +| ↳ `presentationId` | string | The presentation ID | +| ↳ `pageObjectId` | string | The page object ID where the shape was created | +| ↳ `url` | string | URL to the presentation | ### `google_slides_insert_text` @@ -378,7 +378,7 @@ Insert text into a shape or table cell in a Google Slides presentation. Use this | `objectId` | string | The object ID where text was inserted | | `text` | string | The text that was inserted | | `metadata` | object | Operation metadata including presentation ID and URL | -| ↳ `presentationId` | string | The presentation ID | -| ↳ `url` | string | URL to the presentation | +| ↳ `presentationId` | string | The presentation ID | +| ↳ `url` | string | URL to the presentation | diff --git a/apps/docs/content/docs/en/tools/hubspot.mdx b/apps/docs/content/docs/en/tools/hubspot.mdx index b7029b819..b0ec8df93 100644 --- a/apps/docs/content/docs/en/tools/hubspot.mdx +++ b/apps/docs/content/docs/en/tools/hubspot.mdx @@ -51,6 +51,12 @@ Retrieve all users from HubSpot account | Parameter | Type | Description | | --------- | ---- | ----------- | | `users` | array | Array of HubSpot user objects | +| ↳ `id` | string | User ID | +| ↳ `email` | string | User email address | +| ↳ `roleId` | string | User role ID | +| ↳ `primaryTeamId` | string | Primary team ID | +| ↳ `secondaryTeamIds` | array | Secondary team IDs | +| ↳ `superAdmin` | boolean | Whether user is a super admin | | `totalItems` | number | Total number of users returned | | `success` | boolean | Operation success status | @@ -71,9 +77,33 @@ Retrieve all contacts from HubSpot account with pagination support | Parameter | Type | Description | | --------- | ---- | ----------- | -| `contacts` | array | Array of HubSpot contact objects | -| `paging` | object | Pagination information | -| `metadata` | object | Metadata with totalReturned and hasMore | +| `contacts` | array | Array of HubSpot contact records | +| ↳ `email` | string | Contact email address | +| ↳ `firstname` | string | Contact first name | +| ↳ `lastname` | string | Contact last name | +| ↳ `phone` | string | Contact phone number | +| ↳ `mobilephone` | string | Contact mobile phone number | +| ↳ `company` | string | Associated company name | +| ↳ `website` | string | Contact website URL | +| ↳ `jobtitle` | string | Contact job title | +| ↳ `lifecyclestage` | string | Lifecycle stage \(subscriber, lead, marketingqualifiedlead, salesqualifiedlead, opportunity, customer\) | +| ↳ `hubspot_owner_id` | string | HubSpot owner ID | +| ↳ `hs_object_id` | string | HubSpot object ID \(same as record ID\) | +| ↳ `createdate` | string | Contact creation date \(ISO 8601\) | +| ↳ `lastmodifieddate` | string | Last modified date \(ISO 8601\) | +| ↳ `address` | string | Street address | +| ↳ `city` | string | City | +| ↳ `state` | string | State/Region | +| ↳ `zip` | string | Postal/ZIP code | +| ↳ `country` | string | Country | +| ↳ `fax` | string | Fax number | +| ↳ `hs_timezone` | string | Contact timezone | +| `paging` | object | Pagination information for fetching more results | +| ↳ `after` | string | Cursor for next page of results | +| ↳ `link` | string | Link to next page | +| `metadata` | object | Response metadata | +| ↳ `totalReturned` | number | Number of records returned in this response | +| ↳ `hasMore` | boolean | Whether more records are available | | `success` | boolean | Operation success status | ### `hubspot_get_contact` @@ -93,7 +123,27 @@ Retrieve a single contact by ID or email from HubSpot | Parameter | Type | Description | | --------- | ---- | ----------- | -| `contact` | object | HubSpot contact object with properties | +| `contact` | object | HubSpot contact record | +| ↳ `email` | string | Contact email address | +| ↳ `firstname` | string | Contact first name | +| ↳ `lastname` | string | Contact last name | +| ↳ `phone` | string | Contact phone number | +| ↳ `mobilephone` | string | Contact mobile phone number | +| ↳ `company` | string | Associated company name | +| ↳ `website` | string | Contact website URL | +| ↳ `jobtitle` | string | Contact job title | +| ↳ `lifecyclestage` | string | Lifecycle stage \(subscriber, lead, marketingqualifiedlead, salesqualifiedlead, opportunity, customer\) | +| ↳ `hubspot_owner_id` | string | HubSpot owner ID | +| ↳ `hs_object_id` | string | HubSpot object ID \(same as record ID\) | +| ↳ `createdate` | string | Contact creation date \(ISO 8601\) | +| ↳ `lastmodifieddate` | string | Last modified date \(ISO 8601\) | +| ↳ `address` | string | Street address | +| ↳ `city` | string | City | +| ↳ `state` | string | State/Region | +| ↳ `zip` | string | Postal/ZIP code | +| ↳ `country` | string | Country | +| ↳ `fax` | string | Fax number | +| ↳ `hs_timezone` | string | Contact timezone | | `contactId` | string | The retrieved contact ID | | `success` | boolean | Operation success status | @@ -112,7 +162,27 @@ Create a new contact in HubSpot. Requires at least one of: email, firstname, or | Parameter | Type | Description | | --------- | ---- | ----------- | -| `contact` | object | Created HubSpot contact object | +| `contact` | object | HubSpot contact record | +| ↳ `email` | string | Contact email address | +| ↳ `firstname` | string | Contact first name | +| ↳ `lastname` | string | Contact last name | +| ↳ `phone` | string | Contact phone number | +| ↳ `mobilephone` | string | Contact mobile phone number | +| ↳ `company` | string | Associated company name | +| ↳ `website` | string | Contact website URL | +| ↳ `jobtitle` | string | Contact job title | +| ↳ `lifecyclestage` | string | Lifecycle stage \(subscriber, lead, marketingqualifiedlead, salesqualifiedlead, opportunity, customer\) | +| ↳ `hubspot_owner_id` | string | HubSpot owner ID | +| ↳ `hs_object_id` | string | HubSpot object ID \(same as record ID\) | +| ↳ `createdate` | string | Contact creation date \(ISO 8601\) | +| ↳ `lastmodifieddate` | string | Last modified date \(ISO 8601\) | +| ↳ `address` | string | Street address | +| ↳ `city` | string | City | +| ↳ `state` | string | State/Region | +| ↳ `zip` | string | Postal/ZIP code | +| ↳ `country` | string | Country | +| ↳ `fax` | string | Fax number | +| ↳ `hs_timezone` | string | Contact timezone | | `contactId` | string | The created contact ID | | `success` | boolean | Operation success status | @@ -132,7 +202,27 @@ Update an existing contact in HubSpot by ID or email | Parameter | Type | Description | | --------- | ---- | ----------- | -| `contact` | object | Updated HubSpot contact object | +| `contact` | object | HubSpot contact record | +| ↳ `email` | string | Contact email address | +| ↳ `firstname` | string | Contact first name | +| ↳ `lastname` | string | Contact last name | +| ↳ `phone` | string | Contact phone number | +| ↳ `mobilephone` | string | Contact mobile phone number | +| ↳ `company` | string | Associated company name | +| ↳ `website` | string | Contact website URL | +| ↳ `jobtitle` | string | Contact job title | +| ↳ `lifecyclestage` | string | Lifecycle stage \(subscriber, lead, marketingqualifiedlead, salesqualifiedlead, opportunity, customer\) | +| ↳ `hubspot_owner_id` | string | HubSpot owner ID | +| ↳ `hs_object_id` | string | HubSpot object ID \(same as record ID\) | +| ↳ `createdate` | string | Contact creation date \(ISO 8601\) | +| ↳ `lastmodifieddate` | string | Last modified date \(ISO 8601\) | +| ↳ `address` | string | Street address | +| ↳ `city` | string | City | +| ↳ `state` | string | State/Region | +| ↳ `zip` | string | Postal/ZIP code | +| ↳ `country` | string | Country | +| ↳ `fax` | string | Fax number | +| ↳ `hs_timezone` | string | Contact timezone | | `contactId` | string | The updated contact ID | | `success` | boolean | Operation success status | @@ -155,10 +245,34 @@ Search for contacts in HubSpot using filters, sorting, and queries | Parameter | Type | Description | | --------- | ---- | ----------- | -| `contacts` | array | Array of matching HubSpot contact objects | +| `contacts` | array | Array of HubSpot contact records | +| ↳ `email` | string | Contact email address | +| ↳ `firstname` | string | Contact first name | +| ↳ `lastname` | string | Contact last name | +| ↳ `phone` | string | Contact phone number | +| ↳ `mobilephone` | string | Contact mobile phone number | +| ↳ `company` | string | Associated company name | +| ↳ `website` | string | Contact website URL | +| ↳ `jobtitle` | string | Contact job title | +| ↳ `lifecyclestage` | string | Lifecycle stage \(subscriber, lead, marketingqualifiedlead, salesqualifiedlead, opportunity, customer\) | +| ↳ `hubspot_owner_id` | string | HubSpot owner ID | +| ↳ `hs_object_id` | string | HubSpot object ID \(same as record ID\) | +| ↳ `createdate` | string | Contact creation date \(ISO 8601\) | +| ↳ `lastmodifieddate` | string | Last modified date \(ISO 8601\) | +| ↳ `address` | string | Street address | +| ↳ `city` | string | City | +| ↳ `state` | string | State/Region | +| ↳ `zip` | string | Postal/ZIP code | +| ↳ `country` | string | Country | +| ↳ `fax` | string | Fax number | +| ↳ `hs_timezone` | string | Contact timezone | +| `paging` | object | Pagination information for fetching more results | +| ↳ `after` | string | Cursor for next page of results | +| ↳ `link` | string | Link to next page | +| `metadata` | object | Response metadata | +| ↳ `totalReturned` | number | Number of records returned in this response | +| ↳ `hasMore` | boolean | Whether more records are available | | `total` | number | Total number of matching contacts | -| `paging` | object | Pagination information | -| `metadata` | object | Metadata with totalReturned and hasMore | | `success` | boolean | Operation success status | ### `hubspot_list_companies` @@ -178,9 +292,34 @@ Retrieve all companies from HubSpot account with pagination support | Parameter | Type | Description | | --------- | ---- | ----------- | -| `companies` | array | Array of HubSpot company objects | -| `paging` | object | Pagination information | -| `metadata` | object | Metadata with totalReturned and hasMore | +| `companies` | array | Array of HubSpot company records | +| ↳ `name` | string | Company name | +| ↳ `domain` | string | Company website domain \(unique identifier\) | +| ↳ `description` | string | Company description | +| ↳ `industry` | string | Industry type \(e.g., Airlines/Aviation\) | +| ↳ `phone` | string | Company phone number | +| ↳ `city` | string | City | +| ↳ `state` | string | State/Region | +| ↳ `zip` | string | Postal/ZIP code | +| ↳ `country` | string | Country | +| ↳ `address` | string | Street address | +| ↳ `numberofemployees` | string | Total number of employees | +| ↳ `annualrevenue` | string | Annual revenue estimate | +| ↳ `lifecyclestage` | string | Lifecycle stage | +| ↳ `hubspot_owner_id` | string | HubSpot owner ID | +| ↳ `hs_object_id` | string | HubSpot object ID \(same as record ID\) | +| ↳ `hs_createdate` | string | Company creation date \(ISO 8601\) | +| ↳ `hs_lastmodifieddate` | string | Last modified date \(ISO 8601\) | +| ↳ `hs_additional_domains` | string | Additional domains \(semicolon-separated\) | +| ↳ `num_associated_contacts` | string | Number of associated contacts \(auto-updated\) | +| ↳ `num_associated_deals` | string | Number of associated deals \(auto-updated\) | +| ↳ `website` | string | Company website URL | +| `paging` | object | Pagination information for fetching more results | +| ↳ `after` | string | Cursor for next page of results | +| ↳ `link` | string | Link to next page | +| `metadata` | object | Response metadata | +| ↳ `totalReturned` | number | Number of records returned in this response | +| ↳ `hasMore` | boolean | Whether more records are available | | `success` | boolean | Operation success status | ### `hubspot_get_company` @@ -200,7 +339,28 @@ Retrieve a single company by ID or domain from HubSpot | Parameter | Type | Description | | --------- | ---- | ----------- | -| `company` | object | HubSpot company object with properties | +| `company` | object | HubSpot company record | +| ↳ `name` | string | Company name | +| ↳ `domain` | string | Company website domain \(unique identifier\) | +| ↳ `description` | string | Company description | +| ↳ `industry` | string | Industry type \(e.g., Airlines/Aviation\) | +| ↳ `phone` | string | Company phone number | +| ↳ `city` | string | City | +| ↳ `state` | string | State/Region | +| ↳ `zip` | string | Postal/ZIP code | +| ↳ `country` | string | Country | +| ↳ `address` | string | Street address | +| ↳ `numberofemployees` | string | Total number of employees | +| ↳ `annualrevenue` | string | Annual revenue estimate | +| ↳ `lifecyclestage` | string | Lifecycle stage | +| ↳ `hubspot_owner_id` | string | HubSpot owner ID | +| ↳ `hs_object_id` | string | HubSpot object ID \(same as record ID\) | +| ↳ `hs_createdate` | string | Company creation date \(ISO 8601\) | +| ↳ `hs_lastmodifieddate` | string | Last modified date \(ISO 8601\) | +| ↳ `hs_additional_domains` | string | Additional domains \(semicolon-separated\) | +| ↳ `num_associated_contacts` | string | Number of associated contacts \(auto-updated\) | +| ↳ `num_associated_deals` | string | Number of associated deals \(auto-updated\) | +| ↳ `website` | string | Company website URL | | `companyId` | string | The retrieved company ID | | `success` | boolean | Operation success status | @@ -219,7 +379,28 @@ Create a new company in HubSpot | Parameter | Type | Description | | --------- | ---- | ----------- | -| `company` | object | Created HubSpot company object | +| `company` | object | HubSpot company record | +| ↳ `name` | string | Company name | +| ↳ `domain` | string | Company website domain \(unique identifier\) | +| ↳ `description` | string | Company description | +| ↳ `industry` | string | Industry type \(e.g., Airlines/Aviation\) | +| ↳ `phone` | string | Company phone number | +| ↳ `city` | string | City | +| ↳ `state` | string | State/Region | +| ↳ `zip` | string | Postal/ZIP code | +| ↳ `country` | string | Country | +| ↳ `address` | string | Street address | +| ↳ `numberofemployees` | string | Total number of employees | +| ↳ `annualrevenue` | string | Annual revenue estimate | +| ↳ `lifecyclestage` | string | Lifecycle stage | +| ↳ `hubspot_owner_id` | string | HubSpot owner ID | +| ↳ `hs_object_id` | string | HubSpot object ID \(same as record ID\) | +| ↳ `hs_createdate` | string | Company creation date \(ISO 8601\) | +| ↳ `hs_lastmodifieddate` | string | Last modified date \(ISO 8601\) | +| ↳ `hs_additional_domains` | string | Additional domains \(semicolon-separated\) | +| ↳ `num_associated_contacts` | string | Number of associated contacts \(auto-updated\) | +| ↳ `num_associated_deals` | string | Number of associated deals \(auto-updated\) | +| ↳ `website` | string | Company website URL | | `companyId` | string | The created company ID | | `success` | boolean | Operation success status | @@ -239,7 +420,28 @@ Update an existing company in HubSpot by ID or domain | Parameter | Type | Description | | --------- | ---- | ----------- | -| `company` | object | Updated HubSpot company object | +| `company` | object | HubSpot company record | +| ↳ `name` | string | Company name | +| ↳ `domain` | string | Company website domain \(unique identifier\) | +| ↳ `description` | string | Company description | +| ↳ `industry` | string | Industry type \(e.g., Airlines/Aviation\) | +| ↳ `phone` | string | Company phone number | +| ↳ `city` | string | City | +| ↳ `state` | string | State/Region | +| ↳ `zip` | string | Postal/ZIP code | +| ↳ `country` | string | Country | +| ↳ `address` | string | Street address | +| ↳ `numberofemployees` | string | Total number of employees | +| ↳ `annualrevenue` | string | Annual revenue estimate | +| ↳ `lifecyclestage` | string | Lifecycle stage | +| ↳ `hubspot_owner_id` | string | HubSpot owner ID | +| ↳ `hs_object_id` | string | HubSpot object ID \(same as record ID\) | +| ↳ `hs_createdate` | string | Company creation date \(ISO 8601\) | +| ↳ `hs_lastmodifieddate` | string | Last modified date \(ISO 8601\) | +| ↳ `hs_additional_domains` | string | Additional domains \(semicolon-separated\) | +| ↳ `num_associated_contacts` | string | Number of associated contacts \(auto-updated\) | +| ↳ `num_associated_deals` | string | Number of associated deals \(auto-updated\) | +| ↳ `website` | string | Company website URL | | `companyId` | string | The updated company ID | | `success` | boolean | Operation success status | @@ -262,10 +464,35 @@ Search for companies in HubSpot using filters, sorting, and queries | Parameter | Type | Description | | --------- | ---- | ----------- | -| `companies` | array | Array of matching HubSpot company objects | +| `companies` | array | Array of HubSpot company records | +| ↳ `name` | string | Company name | +| ↳ `domain` | string | Company website domain \(unique identifier\) | +| ↳ `description` | string | Company description | +| ↳ `industry` | string | Industry type \(e.g., Airlines/Aviation\) | +| ↳ `phone` | string | Company phone number | +| ↳ `city` | string | City | +| ↳ `state` | string | State/Region | +| ↳ `zip` | string | Postal/ZIP code | +| ↳ `country` | string | Country | +| ↳ `address` | string | Street address | +| ↳ `numberofemployees` | string | Total number of employees | +| ↳ `annualrevenue` | string | Annual revenue estimate | +| ↳ `lifecyclestage` | string | Lifecycle stage | +| ↳ `hubspot_owner_id` | string | HubSpot owner ID | +| ↳ `hs_object_id` | string | HubSpot object ID \(same as record ID\) | +| ↳ `hs_createdate` | string | Company creation date \(ISO 8601\) | +| ↳ `hs_lastmodifieddate` | string | Last modified date \(ISO 8601\) | +| ↳ `hs_additional_domains` | string | Additional domains \(semicolon-separated\) | +| ↳ `num_associated_contacts` | string | Number of associated contacts \(auto-updated\) | +| ↳ `num_associated_deals` | string | Number of associated deals \(auto-updated\) | +| ↳ `website` | string | Company website URL | +| `paging` | object | Pagination information for fetching more results | +| ↳ `after` | string | Cursor for next page of results | +| ↳ `link` | string | Link to next page | +| `metadata` | object | Response metadata | +| ↳ `totalReturned` | number | Number of records returned in this response | +| ↳ `hasMore` | boolean | Whether more records are available | | `total` | number | Total number of matching companies | -| `paging` | object | Pagination information | -| `metadata` | object | Metadata with totalReturned and hasMore | | `success` | boolean | Operation success status | ### `hubspot_list_deals` @@ -285,9 +512,25 @@ Retrieve all deals from HubSpot account with pagination support | Parameter | Type | Description | | --------- | ---- | ----------- | -| `deals` | array | Array of HubSpot deal objects | -| `paging` | object | Pagination information | -| `metadata` | object | Metadata with totalReturned and hasMore | +| `deals` | array | Array of HubSpot deal records | +| ↳ `dealname` | string | Deal name | +| ↳ `amount` | string | Deal amount | +| ↳ `dealstage` | string | Current deal stage | +| ↳ `pipeline` | string | Pipeline the deal is in | +| ↳ `closedate` | string | Expected close date \(ISO 8601\) | +| ↳ `dealtype` | string | Deal type \(New Business, Existing Business, etc.\) | +| ↳ `description` | string | Deal description | +| ↳ `hubspot_owner_id` | string | HubSpot owner ID | +| ↳ `hs_object_id` | string | HubSpot object ID \(same as record ID\) | +| ↳ `createdate` | string | Deal creation date \(ISO 8601\) | +| ↳ `hs_lastmodifieddate` | string | Last modified date \(ISO 8601\) | +| ↳ `num_associated_contacts` | string | Number of associated contacts | +| `paging` | object | Pagination information for fetching more results | +| ↳ `after` | string | Cursor for next page of results | +| ↳ `link` | string | Link to next page | +| `metadata` | object | Response metadata | +| ↳ `totalReturned` | number | Number of records returned in this response | +| ↳ `hasMore` | boolean | Whether more records are available | | `success` | boolean | Operation success status | diff --git a/apps/docs/content/docs/en/tools/huggingface.mdx b/apps/docs/content/docs/en/tools/huggingface.mdx index 7acd7e5fe..0b4c66a0d 100644 --- a/apps/docs/content/docs/en/tools/huggingface.mdx +++ b/apps/docs/content/docs/en/tools/huggingface.mdx @@ -54,11 +54,11 @@ Generate completions using Hugging Face Inference API | --------- | ---- | ----------- | | `success` | boolean | Operation success status | | `output` | object | Chat completion results | -| ↳ `content` | string | Generated text content | -| ↳ `model` | string | Model used for generation | -| ↳ `usage` | object | Token usage information | -| ↳ `prompt_tokens` | number | Number of tokens in the prompt | -| ↳ `completion_tokens` | number | Number of tokens in the completion | -| ↳ `total_tokens` | number | Total number of tokens used | +| ↳ `content` | string | Generated text content | +| ↳ `model` | string | Model used for generation | +| ↳ `usage` | object | Token usage information | +| ↳ `prompt_tokens` | number | Number of tokens in the prompt | +| ↳ `completion_tokens` | number | Number of tokens in the completion | +| ↳ `total_tokens` | number | Total number of tokens used | diff --git a/apps/docs/content/docs/en/tools/hunter.mdx b/apps/docs/content/docs/en/tools/hunter.mdx index 6b837329b..b4ac5e4cf 100644 --- a/apps/docs/content/docs/en/tools/hunter.mdx +++ b/apps/docs/content/docs/en/tools/hunter.mdx @@ -52,7 +52,12 @@ Returns companies matching a set of criteria using Hunter.io AI-powered search. | Parameter | Type | Description | | --------- | ---- | ----------- | -| `results` | array | Array of companies matching the search criteria, each containing domain, name, headcount, technologies, and email_count | +| `results` | array | List of companies matching the search criteria | +| ↳ `domain` | string | Company domain | +| ↳ `name` | string | Company/organization name | +| ↳ `headcount` | number | Company size/headcount | +| ↳ `technologies` | array | Technologies used by the company | +| ↳ `email_count` | number | Total number of email addresses found | ### `hunter_domain_search` @@ -74,26 +79,46 @@ Returns all the email addresses found using one given domain name, with sources. | Parameter | Type | Description | | --------- | ---- | ----------- | +| `emails` | array | List of email addresses found for the domain \(up to 100 per request\) | +| ↳ `value` | string | The email address | +| ↳ `type` | string | Email type: personal or generic \(role-based\) | +| ↳ `confidence` | number | Probability score \(0-100\) that the email is correct | +| ↳ `first_name` | string | Person's first name | +| ↳ `last_name` | string | Person's last name | +| ↳ `position` | string | Job title/position | +| ↳ `seniority` | string | Seniority level \(junior, senior, executive\) | +| ↳ `department` | string | Department \(executive, it, finance, management, sales, legal, support, hr, marketing, communication\) | +| ↳ `linkedin` | string | LinkedIn profile URL | +| ↳ `twitter` | string | Twitter handle | +| ↳ `phone_number` | string | Phone number | +| ↳ `sources` | array | List of sources where the email was found \(limited to 20\) | +| ↳ `domain` | string | Domain where the email was found | +| ↳ `uri` | string | Full URL of the source page | +| ↳ `extracted_on` | string | Date when the email was first extracted \(YYYY-MM-DD\) | +| ↳ `last_seen_on` | string | Date when the email was last seen \(YYYY-MM-DD\) | +| ↳ `still_on_page` | boolean | Whether the email is still present on the source page | +| ↳ `verification` | object | Email verification information | +| ↳ `date` | string | Date when the email was verified \(YYYY-MM-DD\) | +| ↳ `status` | string | Verification status \(valid, invalid, accept_all, webmail, disposable, unknown\) | | `domain` | string | The searched domain name | -| `disposable` | boolean | Whether the domain accepts disposable email addresses | -| `webmail` | boolean | Whether the domain is a webmail provider | -| `accept_all` | boolean | Whether the domain accepts all email addresses | -| `pattern` | string | The email pattern used by the organization | -| `organization` | string | The organization name | +| `disposable` | boolean | Whether the domain is a disposable email service | +| `webmail` | boolean | Whether the domain is a webmail provider \(e.g., Gmail\) | +| `accept_all` | boolean | Whether the server accepts all email addresses \(may cause false positives\) | +| `pattern` | string | The email pattern used by the organization \(e.g., \{first\}, \{first\}.\{last\}\) | +| `organization` | string | The organization/company name | | `description` | string | Description of the organization | -| `industry` | string | Industry of the organization | -| `twitter` | string | Twitter profile of the organization | -| `facebook` | string | Facebook profile of the organization | -| `linkedin` | string | LinkedIn profile of the organization | +| `industry` | string | Industry classification of the organization | +| `twitter` | string | Twitter handle of the organization | +| `facebook` | string | Facebook page URL of the organization | +| `linkedin` | string | LinkedIn company page URL | | `instagram` | string | Instagram profile of the organization | | `youtube` | string | YouTube channel of the organization | -| `technologies` | array | Array of technologies used by the organization | -| `country` | string | Country where the organization is located | -| `state` | string | State where the organization is located | +| `technologies` | array | Technologies used by the organization | +| `country` | string | Country where the organization is headquartered | +| `state` | string | State/province where the organization is located | | `city` | string | City where the organization is located | | `postal_code` | string | Postal code of the organization | | `street` | string | Street address of the organization | -| `emails` | array | Array of email addresses found for the domain, each containing value, type, confidence, sources, and person details | ### `hunter_email_finder` @@ -113,10 +138,17 @@ Finds the most likely email address for a person given their name and company do | Parameter | Type | Description | | --------- | ---- | ----------- | +| `sources` | array | List of sources where the email was found \(limited to 20\) | +| ↳ `domain` | string | Domain where the email was found | +| ↳ `uri` | string | Full URL of the source page | +| ↳ `extracted_on` | string | Date when the email was first extracted \(YYYY-MM-DD\) | +| ↳ `last_seen_on` | string | Date when the email was last seen \(YYYY-MM-DD\) | +| ↳ `still_on_page` | boolean | Whether the email is still present on the source page | +| `verification` | object | Email verification information | +| ↳ `date` | string | Date when the email was verified \(YYYY-MM-DD\) | +| ↳ `status` | string | Verification status \(valid, invalid, accept_all, webmail, disposable, unknown\) | | `email` | string | The found email address | -| `score` | number | Confidence score for the found email address | -| `sources` | array | Array of sources where the email was found, each containing domain, uri, extracted_on, last_seen_on, and still_on_page | -| `verification` | object | Verification information containing date and status | +| `score` | number | Confidence score \(0-100\) for the found email address | ### `hunter_email_verifier` @@ -133,20 +165,25 @@ Verifies the deliverability of an email address and provides detailed verificati | Parameter | Type | Description | | --------- | ---- | ----------- | +| `sources` | array | List of sources where the email was found \(limited to 20\) | +| ↳ `domain` | string | Domain where the email was found | +| ↳ `uri` | string | Full URL of the source page | +| ↳ `extracted_on` | string | Date when the email was first extracted \(YYYY-MM-DD\) | +| ↳ `last_seen_on` | string | Date when the email was last seen \(YYYY-MM-DD\) | +| ↳ `still_on_page` | boolean | Whether the email is still present on the source page | | `result` | string | Deliverability result: deliverable, undeliverable, or risky | -| `score` | number | Confidence score for the verification result | +| `score` | number | Deliverability score \(0-100\). Webmail and disposable emails receive an arbitrary score of 50. | | `email` | string | The verified email address | -| `regexp` | boolean | Whether the email follows a valid regex pattern | -| `gibberish` | boolean | Whether the email appears to be gibberish | -| `disposable` | boolean | Whether the email is from a disposable email provider | -| `webmail` | boolean | Whether the email is from a webmail provider | +| `regexp` | boolean | Whether the email passes regular expression validation | +| `gibberish` | boolean | Whether the email appears to be auto-generated \(e.g., e65rc109q@company.com\) | +| `disposable` | boolean | Whether the email is from a disposable email service | +| `webmail` | boolean | Whether the email is from a webmail provider \(e.g., Gmail\) | | `mx_records` | boolean | Whether MX records exist for the domain | -| `smtp_server` | boolean | Whether the SMTP server is reachable | -| `smtp_check` | boolean | Whether the SMTP check was successful | -| `accept_all` | boolean | Whether the domain accepts all email addresses | -| `block` | boolean | Whether the email is blocked | -| `status` | string | Verification status: valid, invalid, accept_all, webmail, disposable, or unknown | -| `sources` | array | Array of sources where the email was found | +| `smtp_server` | boolean | Whether connection to the SMTP server was successful | +| `smtp_check` | boolean | Whether the email address doesn't bounce | +| `accept_all` | boolean | Whether the server accepts all email addresses \(may cause false positives\) | +| `block` | boolean | Whether the domain is blocking verification \(validity could not be determined\) | +| `status` | string | Verification status: valid, invalid, accept_all, webmail, disposable, unknown, or blocked | ### `hunter_companies_find` @@ -163,8 +200,15 @@ Enriches company data using domain name. | Parameter | Type | Description | | --------- | ---- | ----------- | +| `company` | object | Company information | +| ↳ `name` | string | Company name | +| ↳ `domain` | string | Company domain | +| ↳ `industry` | string | Industry classification | +| ↳ `size` | string | Company size/headcount range | +| ↳ `country` | string | Country where the company is located | +| ↳ `linkedin` | string | LinkedIn company page URL | +| ↳ `twitter` | string | Twitter handle | | `person` | object | Person information \(undefined for companies_find tool\) | -| `company` | object | Company information including name, domain, industry, size, country, linkedin, and twitter | ### `hunter_email_count` @@ -183,10 +227,27 @@ Returns the total number of email addresses found for a domain or company. | Parameter | Type | Description | | --------- | ---- | ----------- | +| `department` | object | Email count breakdown by department | +| ↳ `executive` | number | Number of executive department emails | +| ↳ `it` | number | Number of IT department emails | +| ↳ `finance` | number | Number of finance department emails | +| ↳ `management` | number | Number of management department emails | +| ↳ `sales` | number | Number of sales department emails | +| ↳ `legal` | number | Number of legal department emails | +| ↳ `support` | number | Number of support department emails | +| ↳ `hr` | number | Number of HR department emails | +| ↳ `marketing` | number | Number of marketing department emails | +| ↳ `communication` | number | Number of communication department emails | +| ↳ `education` | number | Number of education department emails | +| ↳ `design` | number | Number of design department emails | +| ↳ `health` | number | Number of health department emails | +| ↳ `operations` | number | Number of operations department emails | +| `seniority` | object | Email count breakdown by seniority level | +| ↳ `junior` | number | Number of junior-level emails | +| ↳ `senior` | number | Number of senior-level emails | +| ↳ `executive` | number | Number of executive-level emails | | `total` | number | Total number of email addresses found | -| `personal_emails` | number | Number of personal email addresses found | -| `generic_emails` | number | Number of generic email addresses found | -| `department` | object | Breakdown of email addresses by department \(executive, it, finance, management, sales, legal, support, hr, marketing, communication\) | -| `seniority` | object | Breakdown of email addresses by seniority level \(junior, senior, executive\) | +| `personal_emails` | number | Number of personal email addresses \(individual employees\) | +| `generic_emails` | number | Number of generic/role-based email addresses \(e.g., contact@, info@\) | diff --git a/apps/docs/content/docs/en/tools/image_generator.mdx b/apps/docs/content/docs/en/tools/image_generator.mdx index 00d079257..36979e8dd 100644 --- a/apps/docs/content/docs/en/tools/image_generator.mdx +++ b/apps/docs/content/docs/en/tools/image_generator.mdx @@ -58,9 +58,9 @@ Generate images using OpenAI | --------- | ---- | ----------- | | `success` | boolean | Operation success status | | `output` | object | Generated image data | -| ↳ `content` | string | Image URL or identifier | -| ↳ `image` | string | Base64 encoded image data | -| ↳ `metadata` | object | Image generation metadata | -| ↳ `model` | string | Model used for image generation | +| ↳ `content` | string | Image URL or identifier | +| ↳ `image` | string | Base64 encoded image data | +| ↳ `metadata` | object | Image generation metadata | +| ↳ `model` | string | Model used for image generation | diff --git a/apps/docs/content/docs/en/tools/incidentio.mdx b/apps/docs/content/docs/en/tools/incidentio.mdx index a12a226d3..d4bc9baf2 100644 --- a/apps/docs/content/docs/en/tools/incidentio.mdx +++ b/apps/docs/content/docs/en/tools/incidentio.mdx @@ -58,32 +58,36 @@ List incidents from incident.io. Returns a list of incidents with their details | --------- | ---- | ----------- | | `incidents` | array | List of incidents | | ↳ `id` | string | Incident ID | -| ↳ `name` | string | Incident name | -| ↳ `summary` | string | Brief summary of the incident | -| ↳ `description` | string | Detailed description of the incident | -| ↳ `mode` | string | Incident mode \(e.g., standard, retrospective\) | -| ↳ `call_url` | string | URL for the incident call/bridge | -| ↳ `severity` | object | Severity of the incident | -| ↳ `id` | string | Severity ID | -| ↳ `name` | string | Severity name | -| ↳ `rank` | number | Severity rank | -| ↳ `status` | object | Current status of the incident | -| ↳ `id` | string | Status ID | -| ↳ `name` | string | Status name | -| ↳ `category` | string | Status category | -| ↳ `incident_type` | object | Type of the incident | -| ↳ `id` | string | Type ID | -| ↳ `name` | string | Type name | -| ↳ `created_at` | string | Creation timestamp | -| ↳ `updated_at` | string | Last update timestamp | -| ↳ `incident_url` | string | URL to the incident | -| ↳ `slack_channel_id` | string | Associated Slack channel ID | -| ↳ `slack_channel_name` | string | Associated Slack channel name | -| ↳ `visibility` | string | Incident visibility | +| ↳ `name` | string | Incident name/title | +| ↳ `summary` | string | Incident summary | +| ↳ `description` | string | Incident description | +| ↳ `mode` | string | Incident mode \(standard, retrospective, test\) | +| ↳ `call_url` | string | Video call URL | +| ↳ `severity` | object | Incident severity | +| ↳ `id` | string | Severity ID | +| ↳ `name` | string | Severity name \(e.g., Critical, Major, Minor\) | +| ↳ `description` | string | Severity description | +| ↳ `rank` | number | Severity rank \(lower = more severe\) | +| ↳ `status` | object | Current incident status | +| ↳ `id` | string | Status ID | +| ↳ `name` | string | Status name | +| ↳ `description` | string | Status description | +| ↳ `category` | string | Status category \(triage, active, post-incident, closed\) | +| ↳ `incident_type` | object | Incident type | +| ↳ `id` | string | Incident type ID | +| ↳ `name` | string | Incident type name | +| ↳ `description` | string | Incident type description | +| ↳ `is_default` | boolean | Whether this is the default incident type | +| ↳ `created_at` | string | When the incident was created \(ISO 8601\) | +| ↳ `updated_at` | string | When the incident was last updated \(ISO 8601\) | +| ↳ `incident_url` | string | URL to the incident page | +| ↳ `slack_channel_id` | string | Slack channel ID | +| ↳ `slack_channel_name` | string | Slack channel name | +| ↳ `visibility` | string | Incident visibility \(public, private\) | | `pagination_meta` | object | Pagination metadata | -| ↳ `after` | string | Cursor for the next page | -| ↳ `page_size` | number | Number of items per page | -| ↳ `total_record_count` | number | Total number of records available | +| ↳ `after` | string | Cursor for next page | +| ↳ `page_size` | number | Number of items per page | +| ↳ `total_record_count` | number | Total number of records | ### `incidentio_incidents_create` @@ -107,29 +111,29 @@ Create a new incident in incident.io. Requires idempotency_key, severity_id, and | Parameter | Type | Description | | --------- | ---- | ----------- | | `incident` | object | The created incident object | -| ↳ `id` | string | Incident ID | -| ↳ `name` | string | Incident name | -| ↳ `summary` | string | Brief summary of the incident | -| ↳ `description` | string | Detailed description of the incident | -| ↳ `mode` | string | Incident mode \(e.g., standard, retrospective\) | -| ↳ `call_url` | string | URL for the incident call/bridge | -| ↳ `severity` | object | Severity of the incident | -| ↳ `id` | string | Severity ID | -| ↳ `name` | string | Severity name | -| ↳ `rank` | number | Severity rank | -| ↳ `status` | object | Current status of the incident | -| ↳ `id` | string | Status ID | -| ↳ `name` | string | Status name | -| ↳ `category` | string | Status category | -| ↳ `incident_type` | object | Type of the incident | -| ↳ `id` | string | Type ID | -| ↳ `name` | string | Type name | -| ↳ `created_at` | string | Creation timestamp | -| ↳ `updated_at` | string | Last update timestamp | -| ↳ `incident_url` | string | URL to the incident | -| ↳ `slack_channel_id` | string | Associated Slack channel ID | -| ↳ `slack_channel_name` | string | Associated Slack channel name | -| ↳ `visibility` | string | Incident visibility | +| ↳ `id` | string | Incident ID | +| ↳ `name` | string | Incident name | +| ↳ `summary` | string | Brief summary of the incident | +| ↳ `description` | string | Detailed description of the incident | +| ↳ `mode` | string | Incident mode \(e.g., standard, retrospective\) | +| ↳ `call_url` | string | URL for the incident call/bridge | +| ↳ `severity` | object | Severity of the incident | +| ↳ `id` | string | Severity ID | +| ↳ `name` | string | Severity name | +| ↳ `rank` | number | Severity rank | +| ↳ `status` | object | Current status of the incident | +| ↳ `id` | string | Status ID | +| ↳ `name` | string | Status name | +| ↳ `category` | string | Status category | +| ↳ `incident_type` | object | Type of the incident | +| ↳ `id` | string | Type ID | +| ↳ `name` | string | Type name | +| ↳ `created_at` | string | Creation timestamp | +| ↳ `updated_at` | string | Last update timestamp | +| ↳ `incident_url` | string | URL to the incident | +| ↳ `slack_channel_id` | string | Associated Slack channel ID | +| ↳ `slack_channel_name` | string | Associated Slack channel name | +| ↳ `visibility` | string | Incident visibility | ### `incidentio_incidents_show` @@ -147,32 +151,32 @@ Retrieve detailed information about a specific incident from incident.io by its | Parameter | Type | Description | | --------- | ---- | ----------- | | `incident` | object | Detailed incident information | -| ↳ `id` | string | Incident ID | -| ↳ `name` | string | Incident name | -| ↳ `summary` | string | Brief summary of the incident | -| ↳ `description` | string | Detailed description of the incident | -| ↳ `mode` | string | Incident mode \(e.g., standard, retrospective\) | -| ↳ `call_url` | string | URL for the incident call/bridge | -| ↳ `permalink` | string | Permanent link to the incident | -| ↳ `severity` | object | Severity of the incident | -| ↳ `id` | string | Severity ID | -| ↳ `name` | string | Severity name | -| ↳ `rank` | number | Severity rank | -| ↳ `status` | object | Current status of the incident | -| ↳ `id` | string | Status ID | -| ↳ `name` | string | Status name | -| ↳ `category` | string | Status category | -| ↳ `incident_type` | object | Type of the incident | -| ↳ `id` | string | Type ID | -| ↳ `name` | string | Type name | -| ↳ `created_at` | string | Creation timestamp | -| ↳ `updated_at` | string | Last update timestamp | -| ↳ `incident_url` | string | URL to the incident | -| ↳ `slack_channel_id` | string | Associated Slack channel ID | -| ↳ `slack_channel_name` | string | Associated Slack channel name | -| ↳ `visibility` | string | Incident visibility | -| ↳ `custom_field_entries` | array | Custom field values for the incident | -| ↳ `incident_role_assignments` | array | Role assignments for the incident | +| ↳ `id` | string | Incident ID | +| ↳ `name` | string | Incident name | +| ↳ `summary` | string | Brief summary of the incident | +| ↳ `description` | string | Detailed description of the incident | +| ↳ `mode` | string | Incident mode \(e.g., standard, retrospective\) | +| ↳ `call_url` | string | URL for the incident call/bridge | +| ↳ `permalink` | string | Permanent link to the incident | +| ↳ `severity` | object | Severity of the incident | +| ↳ `id` | string | Severity ID | +| ↳ `name` | string | Severity name | +| ↳ `rank` | number | Severity rank | +| ↳ `status` | object | Current status of the incident | +| ↳ `id` | string | Status ID | +| ↳ `name` | string | Status name | +| ↳ `category` | string | Status category | +| ↳ `incident_type` | object | Type of the incident | +| ↳ `id` | string | Type ID | +| ↳ `name` | string | Type name | +| ↳ `created_at` | string | Creation timestamp | +| ↳ `updated_at` | string | Last update timestamp | +| ↳ `incident_url` | string | URL to the incident | +| ↳ `slack_channel_id` | string | Associated Slack channel ID | +| ↳ `slack_channel_name` | string | Associated Slack channel name | +| ↳ `visibility` | string | Incident visibility | +| ↳ `custom_field_entries` | array | Custom field values for the incident | +| ↳ `incident_role_assignments` | array | Role assignments for the incident | ### `incidentio_incidents_update` @@ -196,29 +200,29 @@ Update an existing incident in incident.io. Can update name, summary, severity, | Parameter | Type | Description | | --------- | ---- | ----------- | | `incident` | object | The updated incident object | -| ↳ `id` | string | Incident ID | -| ↳ `name` | string | Incident name | -| ↳ `summary` | string | Brief summary of the incident | -| ↳ `description` | string | Detailed description of the incident | -| ↳ `mode` | string | Incident mode \(e.g., standard, retrospective\) | -| ↳ `call_url` | string | URL for the incident call/bridge | -| ↳ `severity` | object | Severity of the incident | -| ↳ `id` | string | Severity ID | -| ↳ `name` | string | Severity name | -| ↳ `rank` | number | Severity rank | -| ↳ `status` | object | Current status of the incident | -| ↳ `id` | string | Status ID | -| ↳ `name` | string | Status name | -| ↳ `category` | string | Status category | -| ↳ `incident_type` | object | Type of the incident | -| ↳ `id` | string | Type ID | -| ↳ `name` | string | Type name | -| ↳ `created_at` | string | Creation timestamp | -| ↳ `updated_at` | string | Last update timestamp | -| ↳ `incident_url` | string | URL to the incident | -| ↳ `slack_channel_id` | string | Associated Slack channel ID | -| ↳ `slack_channel_name` | string | Associated Slack channel name | -| ↳ `visibility` | string | Incident visibility | +| ↳ `id` | string | Incident ID | +| ↳ `name` | string | Incident name | +| ↳ `summary` | string | Brief summary of the incident | +| ↳ `description` | string | Detailed description of the incident | +| ↳ `mode` | string | Incident mode \(e.g., standard, retrospective\) | +| ↳ `call_url` | string | URL for the incident call/bridge | +| ↳ `severity` | object | Severity of the incident | +| ↳ `id` | string | Severity ID | +| ↳ `name` | string | Severity name | +| ↳ `rank` | number | Severity rank | +| ↳ `status` | object | Current status of the incident | +| ↳ `id` | string | Status ID | +| ↳ `name` | string | Status name | +| ↳ `category` | string | Status category | +| ↳ `incident_type` | object | Type of the incident | +| ↳ `id` | string | Type ID | +| ↳ `name` | string | Type name | +| ↳ `created_at` | string | Creation timestamp | +| ↳ `updated_at` | string | Last update timestamp | +| ↳ `incident_url` | string | URL to the incident | +| ↳ `slack_channel_id` | string | Associated Slack channel ID | +| ↳ `slack_channel_name` | string | Associated Slack channel name | +| ↳ `visibility` | string | Incident visibility | ### `incidentio_actions_list` @@ -240,23 +244,23 @@ List actions from incident.io. Optionally filter by incident ID. | ↳ `id` | string | Action ID | | ↳ `description` | string | Action description | | ↳ `assignee` | object | Assigned user | -| ↳ `id` | string | User ID | -| ↳ `name` | string | User name | -| ↳ `email` | string | User email | +| ↳ `id` | string | User ID | +| ↳ `name` | string | User name | +| ↳ `email` | string | User email | | ↳ `status` | string | Action status | | ↳ `due_at` | string | Due date/time | | ↳ `created_at` | string | Creation timestamp | | ↳ `updated_at` | string | Last update timestamp | | ↳ `incident_id` | string | Associated incident ID | | ↳ `creator` | object | User who created the action | -| ↳ `id` | string | User ID | -| ↳ `name` | string | User name | -| ↳ `email` | string | User email | +| ↳ `id` | string | User ID | +| ↳ `name` | string | User name | +| ↳ `email` | string | User email | | ↳ `completed_at` | string | Completion timestamp | | ↳ `external_issue_reference` | object | External issue tracking reference | -| ↳ `provider` | string | Issue tracking provider \(e.g., Jira, Linear\) | -| ↳ `issue_name` | string | Issue identifier | -| ↳ `issue_permalink` | string | URL to the external issue | +| ↳ `provider` | string | Issue tracking provider \(e.g., Jira, Linear\) | +| ↳ `issue_name` | string | Issue identifier | +| ↳ `issue_permalink` | string | URL to the external issue | ### `incidentio_actions_show` @@ -274,26 +278,26 @@ Get detailed information about a specific action from incident.io. | Parameter | Type | Description | | --------- | ---- | ----------- | | `action` | object | Action details | -| ↳ `id` | string | Action ID | -| ↳ `description` | string | Action description | -| ↳ `assignee` | object | Assigned user | -| ↳ `id` | string | User ID | -| ↳ `name` | string | User name | -| ↳ `email` | string | User email | -| ↳ `status` | string | Action status | -| ↳ `due_at` | string | Due date/time | -| ↳ `created_at` | string | Creation timestamp | -| ↳ `updated_at` | string | Last update timestamp | -| ↳ `incident_id` | string | Associated incident ID | -| ↳ `creator` | object | User who created the action | -| ↳ `id` | string | User ID | -| ↳ `name` | string | User name | -| ↳ `email` | string | User email | -| ↳ `completed_at` | string | Completion timestamp | -| ↳ `external_issue_reference` | object | External issue tracking reference | -| ↳ `provider` | string | Issue tracking provider \(e.g., Jira, Linear\) | -| ↳ `issue_name` | string | Issue identifier | -| ↳ `issue_permalink` | string | URL to the external issue | +| ↳ `id` | string | Action ID | +| ↳ `description` | string | Action description | +| ↳ `assignee` | object | Assigned user | +| ↳ `id` | string | User ID | +| ↳ `name` | string | User name | +| ↳ `email` | string | User email | +| ↳ `status` | string | Action status | +| ↳ `due_at` | string | Due date/time | +| ↳ `created_at` | string | Creation timestamp | +| ↳ `updated_at` | string | Last update timestamp | +| ↳ `incident_id` | string | Associated incident ID | +| ↳ `creator` | object | User who created the action | +| ↳ `id` | string | User ID | +| ↳ `name` | string | User name | +| ↳ `email` | string | User email | +| ↳ `completed_at` | string | Completion timestamp | +| ↳ `external_issue_reference` | object | External issue tracking reference | +| ↳ `provider` | string | Issue tracking provider \(e.g., Jira, Linear\) | +| ↳ `issue_name` | string | Issue identifier | +| ↳ `issue_permalink` | string | URL to the external issue | ### `incidentio_follow_ups_list` @@ -316,28 +320,28 @@ List follow-ups from incident.io. Optionally filter by incident ID. | ↳ `title` | string | Follow-up title | | ↳ `description` | string | Follow-up description | | ↳ `assignee` | object | Assigned user | -| ↳ `id` | string | User ID | -| ↳ `name` | string | User name | -| ↳ `email` | string | User email | +| ↳ `id` | string | User ID | +| ↳ `name` | string | User name | +| ↳ `email` | string | User email | | ↳ `status` | string | Follow-up status | | ↳ `priority` | object | Follow-up priority | -| ↳ `id` | string | Priority ID | -| ↳ `name` | string | Priority name | -| ↳ `description` | string | Priority description | -| ↳ `rank` | number | Priority rank | +| ↳ `id` | string | Priority ID | +| ↳ `name` | string | Priority name | +| ↳ `description` | string | Priority description | +| ↳ `rank` | number | Priority rank | | ↳ `created_at` | string | Creation timestamp | | ↳ `updated_at` | string | Last update timestamp | | ↳ `incident_id` | string | Associated incident ID | | ↳ `creator` | object | User who created the follow-up | -| ↳ `id` | string | User ID | -| ↳ `name` | string | User name | -| ↳ `email` | string | User email | +| ↳ `id` | string | User ID | +| ↳ `name` | string | User name | +| ↳ `email` | string | User email | | ↳ `completed_at` | string | Completion timestamp | | ↳ `labels` | array | Labels associated with the follow-up | | ↳ `external_issue_reference` | object | External issue tracking reference | -| ↳ `provider` | string | External provider name | -| ↳ `issue_name` | string | External issue name or ID | -| ↳ `issue_permalink` | string | Permalink to external issue | +| ↳ `provider` | string | External provider name | +| ↳ `issue_name` | string | External issue name or ID | +| ↳ `issue_permalink` | string | Permalink to external issue | ### `incidentio_follow_ups_show` @@ -355,32 +359,32 @@ Get detailed information about a specific follow-up from incident.io. | Parameter | Type | Description | | --------- | ---- | ----------- | | `follow_up` | object | Follow-up details | -| ↳ `id` | string | Follow-up ID | -| ↳ `title` | string | Follow-up title | -| ↳ `description` | string | Follow-up description | -| ↳ `assignee` | object | Assigned user | -| ↳ `id` | string | User ID | -| ↳ `name` | string | User name | -| ↳ `email` | string | User email | -| ↳ `status` | string | Follow-up status | -| ↳ `priority` | object | Follow-up priority | -| ↳ `id` | string | Priority ID | -| ↳ `name` | string | Priority name | -| ↳ `description` | string | Priority description | -| ↳ `rank` | number | Priority rank | -| ↳ `created_at` | string | Creation timestamp | -| ↳ `updated_at` | string | Last update timestamp | -| ↳ `incident_id` | string | Associated incident ID | -| ↳ `creator` | object | User who created the follow-up | -| ↳ `id` | string | User ID | -| ↳ `name` | string | User name | -| ↳ `email` | string | User email | -| ↳ `completed_at` | string | Completion timestamp | -| ↳ `labels` | array | Labels associated with the follow-up | -| ↳ `external_issue_reference` | object | External issue tracking reference | -| ↳ `provider` | string | External provider name | -| ↳ `issue_name` | string | External issue name or ID | -| ↳ `issue_permalink` | string | Permalink to external issue | +| ↳ `id` | string | Follow-up ID | +| ↳ `title` | string | Follow-up title | +| ↳ `description` | string | Follow-up description | +| ↳ `assignee` | object | Assigned user | +| ↳ `id` | string | User ID | +| ↳ `name` | string | User name | +| ↳ `email` | string | User email | +| ↳ `status` | string | Follow-up status | +| ↳ `priority` | object | Follow-up priority | +| ↳ `id` | string | Priority ID | +| ↳ `name` | string | Priority name | +| ↳ `description` | string | Priority description | +| ↳ `rank` | number | Priority rank | +| ↳ `created_at` | string | Creation timestamp | +| ↳ `updated_at` | string | Last update timestamp | +| ↳ `incident_id` | string | Associated incident ID | +| ↳ `creator` | object | User who created the follow-up | +| ↳ `id` | string | User ID | +| ↳ `name` | string | User name | +| ↳ `email` | string | User email | +| ↳ `completed_at` | string | Completion timestamp | +| ↳ `labels` | array | Labels associated with the follow-up | +| ↳ `external_issue_reference` | object | External issue tracking reference | +| ↳ `provider` | string | External provider name | +| ↳ `issue_name` | string | External issue name or ID | +| ↳ `issue_permalink` | string | Permalink to external issue | ### `incidentio_users_list` @@ -419,10 +423,10 @@ Get detailed information about a specific user in your Incident.io workspace by | Parameter | Type | Description | | --------- | ---- | ----------- | | `user` | object | Details of the requested user | -| ↳ `id` | string | Unique identifier for the user | -| ↳ `name` | string | Full name of the user | -| ↳ `email` | string | Email address of the user | -| ↳ `role` | string | Role of the user in the workspace | +| ↳ `id` | string | Unique identifier for the user | +| ↳ `name` | string | Full name of the user | +| ↳ `email` | string | Email address of the user | +| ↳ `role` | string | Role of the user in the workspace | ### `incidentio_workflows_list` @@ -448,8 +452,8 @@ List all workflows in your incident.io workspace. | ↳ `created_at` | string | When the workflow was created | | ↳ `updated_at` | string | When the workflow was last updated | | `pagination_meta` | object | Pagination metadata | -| ↳ `after` | string | Cursor for next page | -| ↳ `page_size` | number | Number of results per page | +| ↳ `after` | string | Cursor for next page | +| ↳ `page_size` | number | Number of results per page | ### `incidentio_workflows_show` @@ -467,12 +471,12 @@ Get details of a specific workflow in incident.io. | Parameter | Type | Description | | --------- | ---- | ----------- | | `workflow` | object | The workflow details | -| ↳ `id` | string | Unique identifier for the workflow | -| ↳ `name` | string | Name of the workflow | -| ↳ `state` | string | State of the workflow \(active, draft, or disabled\) | -| ↳ `folder` | string | Folder the workflow belongs to | -| ↳ `created_at` | string | When the workflow was created | -| ↳ `updated_at` | string | When the workflow was last updated | +| ↳ `id` | string | Unique identifier for the workflow | +| ↳ `name` | string | Name of the workflow | +| ↳ `state` | string | State of the workflow \(active, draft, or disabled\) | +| ↳ `folder` | string | Folder the workflow belongs to | +| ↳ `created_at` | string | When the workflow was created | +| ↳ `updated_at` | string | When the workflow was last updated | ### `incidentio_workflows_update` @@ -493,12 +497,12 @@ Update an existing workflow in incident.io. | Parameter | Type | Description | | --------- | ---- | ----------- | | `workflow` | object | The updated workflow | -| ↳ `id` | string | Unique identifier for the workflow | -| ↳ `name` | string | Name of the workflow | -| ↳ `state` | string | State of the workflow \(active, draft, or disabled\) | -| ↳ `folder` | string | Folder the workflow belongs to | -| ↳ `created_at` | string | When the workflow was created | -| ↳ `updated_at` | string | When the workflow was last updated | +| ↳ `id` | string | Unique identifier for the workflow | +| ↳ `name` | string | Name of the workflow | +| ↳ `state` | string | State of the workflow \(active, draft, or disabled\) | +| ↳ `folder` | string | Folder the workflow belongs to | +| ↳ `created_at` | string | When the workflow was created | +| ↳ `updated_at` | string | When the workflow was last updated | ### `incidentio_workflows_delete` @@ -540,8 +544,8 @@ List all schedules in incident.io | ↳ `created_at` | string | When the schedule was created | | ↳ `updated_at` | string | When the schedule was last updated | | `pagination_meta` | object | Pagination metadata | -| ↳ `after` | string | Cursor for next page | -| ↳ `page_size` | number | Number of results per page | +| ↳ `after` | string | Cursor for next page | +| ↳ `page_size` | number | Number of results per page | ### `incidentio_schedules_create` @@ -562,11 +566,11 @@ Create a new schedule in incident.io | Parameter | Type | Description | | --------- | ---- | ----------- | | `schedule` | object | The created schedule | -| ↳ `id` | string | The schedule ID | -| ↳ `name` | string | The schedule name | -| ↳ `timezone` | string | The schedule timezone | -| ↳ `created_at` | string | When the schedule was created | -| ↳ `updated_at` | string | When the schedule was last updated | +| ↳ `id` | string | The schedule ID | +| ↳ `name` | string | The schedule name | +| ↳ `timezone` | string | The schedule timezone | +| ↳ `created_at` | string | When the schedule was created | +| ↳ `updated_at` | string | When the schedule was last updated | ### `incidentio_schedules_show` @@ -584,11 +588,11 @@ Get details of a specific schedule in incident.io | Parameter | Type | Description | | --------- | ---- | ----------- | | `schedule` | object | The schedule details | -| ↳ `id` | string | The schedule ID | -| ↳ `name` | string | The schedule name | -| ↳ `timezone` | string | The schedule timezone | -| ↳ `created_at` | string | When the schedule was created | -| ↳ `updated_at` | string | When the schedule was last updated | +| ↳ `id` | string | The schedule ID | +| ↳ `name` | string | The schedule name | +| ↳ `timezone` | string | The schedule timezone | +| ↳ `created_at` | string | When the schedule was created | +| ↳ `updated_at` | string | When the schedule was last updated | ### `incidentio_schedules_update` @@ -610,11 +614,11 @@ Update an existing schedule in incident.io | Parameter | Type | Description | | --------- | ---- | ----------- | | `schedule` | object | The updated schedule | -| ↳ `id` | string | The schedule ID | -| ↳ `name` | string | The schedule name | -| ↳ `timezone` | string | The schedule timezone | -| ↳ `created_at` | string | When the schedule was created | -| ↳ `updated_at` | string | When the schedule was last updated | +| ↳ `id` | string | The schedule ID | +| ↳ `name` | string | The schedule name | +| ↳ `timezone` | string | The schedule timezone | +| ↳ `created_at` | string | When the schedule was created | +| ↳ `updated_at` | string | When the schedule was last updated | ### `incidentio_schedules_delete` @@ -673,10 +677,10 @@ Create a new escalation policy in incident.io | Parameter | Type | Description | | --------- | ---- | ----------- | | `escalation` | object | The created escalation policy | -| ↳ `id` | string | The escalation policy ID | -| ↳ `name` | string | The escalation policy name | -| ↳ `created_at` | string | When the escalation policy was created | -| ↳ `updated_at` | string | When the escalation policy was last updated | +| ↳ `id` | string | The escalation policy ID | +| ↳ `name` | string | The escalation policy name | +| ↳ `created_at` | string | When the escalation policy was created | +| ↳ `updated_at` | string | When the escalation policy was last updated | ### `incidentio_escalations_show` @@ -694,10 +698,10 @@ Get details of a specific escalation policy in incident.io | Parameter | Type | Description | | --------- | ---- | ----------- | | `escalation` | object | The escalation policy details | -| ↳ `id` | string | The escalation policy ID | -| ↳ `name` | string | The escalation policy name | -| ↳ `created_at` | string | When the escalation policy was created | -| ↳ `updated_at` | string | When the escalation policy was last updated | +| ↳ `id` | string | The escalation policy ID | +| ↳ `name` | string | The escalation policy name | +| ↳ `created_at` | string | When the escalation policy was created | +| ↳ `updated_at` | string | When the escalation policy was last updated | ### `incidentio_custom_fields_list` @@ -739,12 +743,12 @@ Create a new custom field in incident.io. | Parameter | Type | Description | | --------- | ---- | ----------- | | `custom_field` | object | Created custom field | -| ↳ `id` | string | Custom field ID | -| ↳ `name` | string | Custom field name | -| ↳ `description` | string | Custom field description | -| ↳ `field_type` | string | Custom field type | -| ↳ `created_at` | string | Creation timestamp | -| ↳ `updated_at` | string | Last update timestamp | +| ↳ `id` | string | Custom field ID | +| ↳ `name` | string | Custom field name | +| ↳ `description` | string | Custom field description | +| ↳ `field_type` | string | Custom field type | +| ↳ `created_at` | string | Creation timestamp | +| ↳ `updated_at` | string | Last update timestamp | ### `incidentio_custom_fields_show` @@ -762,12 +766,12 @@ Get detailed information about a specific custom field from incident.io. | Parameter | Type | Description | | --------- | ---- | ----------- | | `custom_field` | object | Custom field details | -| ↳ `id` | string | Custom field ID | -| ↳ `name` | string | Custom field name | -| ↳ `description` | string | Custom field description | -| ↳ `field_type` | string | Custom field type | -| ↳ `created_at` | string | Creation timestamp | -| ↳ `updated_at` | string | Last update timestamp | +| ↳ `id` | string | Custom field ID | +| ↳ `name` | string | Custom field name | +| ↳ `description` | string | Custom field description | +| ↳ `field_type` | string | Custom field type | +| ↳ `created_at` | string | Creation timestamp | +| ↳ `updated_at` | string | Last update timestamp | ### `incidentio_custom_fields_update` @@ -787,12 +791,12 @@ Update an existing custom field in incident.io. | Parameter | Type | Description | | --------- | ---- | ----------- | | `custom_field` | object | Updated custom field | -| ↳ `id` | string | Custom field ID | -| ↳ `name` | string | Custom field name | -| ↳ `description` | string | Custom field description | -| ↳ `field_type` | string | Custom field type | -| ↳ `created_at` | string | Creation timestamp | -| ↳ `updated_at` | string | Last update timestamp | +| ↳ `id` | string | Custom field ID | +| ↳ `name` | string | Custom field name | +| ↳ `description` | string | Custom field description | +| ↳ `field_type` | string | Custom field type | +| ↳ `created_at` | string | Creation timestamp | +| ↳ `updated_at` | string | Last update timestamp | ### `incidentio_custom_fields_delete` @@ -915,15 +919,15 @@ Create a new incident role in incident.io | Parameter | Type | Description | | --------- | ---- | ----------- | | `incident_role` | object | The created incident role | -| ↳ `id` | string | The incident role ID | -| ↳ `name` | string | The incident role name | -| ↳ `description` | string | The incident role description | -| ↳ `instructions` | string | Instructions for the role | -| ↳ `shortform` | string | Short form abbreviation of the role | -| ↳ `role_type` | string | The type of role | -| ↳ `required` | boolean | Whether the role is required | -| ↳ `created_at` | string | When the role was created | -| ↳ `updated_at` | string | When the role was last updated | +| ↳ `id` | string | The incident role ID | +| ↳ `name` | string | The incident role name | +| ↳ `description` | string | The incident role description | +| ↳ `instructions` | string | Instructions for the role | +| ↳ `shortform` | string | Short form abbreviation of the role | +| ↳ `role_type` | string | The type of role | +| ↳ `required` | boolean | Whether the role is required | +| ↳ `created_at` | string | When the role was created | +| ↳ `updated_at` | string | When the role was last updated | ### `incidentio_incident_roles_show` @@ -941,15 +945,15 @@ Get details of a specific incident role in incident.io | Parameter | Type | Description | | --------- | ---- | ----------- | | `incident_role` | object | The incident role details | -| ↳ `id` | string | The incident role ID | -| ↳ `name` | string | The incident role name | -| ↳ `description` | string | The incident role description | -| ↳ `instructions` | string | Instructions for the role | -| ↳ `shortform` | string | Short form abbreviation of the role | -| ↳ `role_type` | string | The type of role | -| ↳ `required` | boolean | Whether the role is required | -| ↳ `created_at` | string | When the role was created | -| ↳ `updated_at` | string | When the role was last updated | +| ↳ `id` | string | The incident role ID | +| ↳ `name` | string | The incident role name | +| ↳ `description` | string | The incident role description | +| ↳ `instructions` | string | Instructions for the role | +| ↳ `shortform` | string | Short form abbreviation of the role | +| ↳ `role_type` | string | The type of role | +| ↳ `required` | boolean | Whether the role is required | +| ↳ `created_at` | string | When the role was created | +| ↳ `updated_at` | string | When the role was last updated | ### `incidentio_incident_roles_update` @@ -971,15 +975,15 @@ Update an existing incident role in incident.io | Parameter | Type | Description | | --------- | ---- | ----------- | | `incident_role` | object | The updated incident role | -| ↳ `id` | string | The incident role ID | -| ↳ `name` | string | The incident role name | -| ↳ `description` | string | The incident role description | -| ↳ `instructions` | string | Instructions for the role | -| ↳ `shortform` | string | Short form abbreviation of the role | -| ↳ `role_type` | string | The type of role | -| ↳ `required` | boolean | Whether the role is required | -| ↳ `created_at` | string | When the role was created | -| ↳ `updated_at` | string | When the role was last updated | +| ↳ `id` | string | The incident role ID | +| ↳ `name` | string | The incident role name | +| ↳ `description` | string | The incident role description | +| ↳ `instructions` | string | Instructions for the role | +| ↳ `shortform` | string | Short form abbreviation of the role | +| ↳ `role_type` | string | The type of role | +| ↳ `required` | boolean | Whether the role is required | +| ↳ `created_at` | string | When the role was created | +| ↳ `updated_at` | string | When the role was last updated | ### `incidentio_incident_roles_delete` @@ -1035,11 +1039,11 @@ Get details of a specific incident timestamp definition in incident.io | Parameter | Type | Description | | --------- | ---- | ----------- | | `incident_timestamp` | object | The incident timestamp details | -| ↳ `id` | string | The timestamp ID | -| ↳ `name` | string | The timestamp name | -| ↳ `rank` | number | The rank/order of the timestamp | -| ↳ `created_at` | string | When the timestamp was created | -| ↳ `updated_at` | string | When the timestamp was last updated | +| ↳ `id` | string | The timestamp ID | +| ↳ `name` | string | The timestamp name | +| ↳ `rank` | number | The rank/order of the timestamp | +| ↳ `created_at` | string | When the timestamp was created | +| ↳ `updated_at` | string | When the timestamp was last updated | ### `incidentio_incident_updates_list` @@ -1063,22 +1067,22 @@ List all updates for a specific incident in incident.io | ↳ `incident_id` | string | The incident ID | | ↳ `message` | string | The update message | | ↳ `new_severity` | object | New severity if changed | -| ↳ `id` | string | Severity ID | -| ↳ `name` | string | Severity name | -| ↳ `rank` | number | Severity rank | +| ↳ `id` | string | Severity ID | +| ↳ `name` | string | Severity name | +| ↳ `rank` | number | Severity rank | | ↳ `new_status` | object | New status if changed | -| ↳ `id` | string | Status ID | -| ↳ `name` | string | Status name | -| ↳ `category` | string | Status category | +| ↳ `id` | string | Status ID | +| ↳ `name` | string | Status name | +| ↳ `category` | string | Status category | | ↳ `updater` | object | User who created the update | -| ↳ `id` | string | User ID | -| ↳ `name` | string | User name | -| ↳ `email` | string | User email | +| ↳ `id` | string | User ID | +| ↳ `name` | string | User name | +| ↳ `email` | string | User email | | ↳ `created_at` | string | When the update was created | | ↳ `updated_at` | string | When the update was last modified | | `pagination_meta` | object | Pagination information | -| ↳ `after` | string | Cursor for next page | -| ↳ `page_size` | number | Number of results per page | +| ↳ `after` | string | Cursor for next page | +| ↳ `page_size` | number | Number of results per page | ### `incidentio_schedule_entries_list` @@ -1103,18 +1107,18 @@ List all entries for a specific schedule in incident.io | ↳ `id` | string | The entry ID | | ↳ `schedule_id` | string | The schedule ID | | ↳ `user` | object | User assigned to this entry | -| ↳ `id` | string | User ID | -| ↳ `name` | string | User name | -| ↳ `email` | string | User email | +| ↳ `id` | string | User ID | +| ↳ `name` | string | User name | +| ↳ `email` | string | User email | | ↳ `start_at` | string | When the entry starts | | ↳ `end_at` | string | When the entry ends | | ↳ `layer_id` | string | The schedule layer ID | | ↳ `created_at` | string | When the entry was created | | ↳ `updated_at` | string | When the entry was last updated | | `pagination_meta` | object | Pagination information | -| ↳ `after` | string | Cursor for next page | -| ↳ `after_url` | string | URL for next page | -| ↳ `page_size` | number | Number of results per page | +| ↳ `after` | string | Cursor for next page | +| ↳ `after_url` | string | URL for next page | +| ↳ `page_size` | number | Number of results per page | ### `incidentio_schedule_overrides_create` @@ -1138,17 +1142,17 @@ Create a new schedule override in incident.io | Parameter | Type | Description | | --------- | ---- | ----------- | | `override` | object | The created schedule override | -| ↳ `id` | string | The override ID | -| ↳ `rotation_id` | string | The rotation ID | -| ↳ `schedule_id` | string | The schedule ID | -| ↳ `user` | object | User assigned to this override | -| ↳ `id` | string | User ID | -| ↳ `name` | string | User name | -| ↳ `email` | string | User email | -| ↳ `start_at` | string | When the override starts | -| ↳ `end_at` | string | When the override ends | -| ↳ `created_at` | string | When the override was created | -| ↳ `updated_at` | string | When the override was last updated | +| ↳ `id` | string | The override ID | +| ↳ `rotation_id` | string | The rotation ID | +| ↳ `schedule_id` | string | The schedule ID | +| ↳ `user` | object | User assigned to this override | +| ↳ `id` | string | User ID | +| ↳ `name` | string | User name | +| ↳ `email` | string | User email | +| ↳ `start_at` | string | When the override starts | +| ↳ `end_at` | string | When the override ends | +| ↳ `created_at` | string | When the override was created | +| ↳ `updated_at` | string | When the override was last updated | ### `incidentio_escalation_paths_create` @@ -1168,22 +1172,22 @@ Create a new escalation path in incident.io | Parameter | Type | Description | | --------- | ---- | ----------- | | `escalation_path` | object | The created escalation path | -| ↳ `id` | string | The escalation path ID | -| ↳ `name` | string | The escalation path name | -| ↳ `path` | array | Array of escalation levels | -| ↳ `targets` | array | Targets for this level | -| ↳ `id` | string | Target ID | -| ↳ `type` | string | Target type | -| ↳ `schedule_id` | string | Schedule ID if type is schedule | -| ↳ `user_id` | string | User ID if type is user | -| ↳ `urgency` | string | Urgency level | -| ↳ `time_to_ack_seconds` | number | Time to acknowledge in seconds | -| ↳ `working_hours` | array | Working hours configuration | -| ↳ `weekday` | string | Day of week | -| ↳ `start_time` | string | Start time | -| ↳ `end_time` | string | End time | -| ↳ `created_at` | string | When the path was created | -| ↳ `updated_at` | string | When the path was last updated | +| ↳ `id` | string | The escalation path ID | +| ↳ `name` | string | The escalation path name | +| ↳ `path` | array | Array of escalation levels | +| ↳ `targets` | array | Targets for this level | +| ↳ `id` | string | Target ID | +| ↳ `type` | string | Target type | +| ↳ `schedule_id` | string | Schedule ID if type is schedule | +| ↳ `user_id` | string | User ID if type is user | +| ↳ `urgency` | string | Urgency level | +| ↳ `time_to_ack_seconds` | number | Time to acknowledge in seconds | +| ↳ `working_hours` | array | Working hours configuration | +| ↳ `weekday` | string | Day of week | +| ↳ `start_time` | string | Start time | +| ↳ `end_time` | string | End time | +| ↳ `created_at` | string | When the path was created | +| ↳ `updated_at` | string | When the path was last updated | ### `incidentio_escalation_paths_show` @@ -1201,22 +1205,22 @@ Get details of a specific escalation path in incident.io | Parameter | Type | Description | | --------- | ---- | ----------- | | `escalation_path` | object | The escalation path details | -| ↳ `id` | string | The escalation path ID | -| ↳ `name` | string | The escalation path name | -| ↳ `path` | array | Array of escalation levels | -| ↳ `targets` | array | Targets for this level | -| ↳ `id` | string | Target ID | -| ↳ `type` | string | Target type | -| ↳ `schedule_id` | string | Schedule ID if type is schedule | -| ↳ `user_id` | string | User ID if type is user | -| ↳ `urgency` | string | Urgency level | -| ↳ `time_to_ack_seconds` | number | Time to acknowledge in seconds | -| ↳ `working_hours` | array | Working hours configuration | -| ↳ `weekday` | string | Day of week | -| ↳ `start_time` | string | Start time | -| ↳ `end_time` | string | End time | -| ↳ `created_at` | string | When the path was created | -| ↳ `updated_at` | string | When the path was last updated | +| ↳ `id` | string | The escalation path ID | +| ↳ `name` | string | The escalation path name | +| ↳ `path` | array | Array of escalation levels | +| ↳ `targets` | array | Targets for this level | +| ↳ `id` | string | Target ID | +| ↳ `type` | string | Target type | +| ↳ `schedule_id` | string | Schedule ID if type is schedule | +| ↳ `user_id` | string | User ID if type is user | +| ↳ `urgency` | string | Urgency level | +| ↳ `time_to_ack_seconds` | number | Time to acknowledge in seconds | +| ↳ `working_hours` | array | Working hours configuration | +| ↳ `weekday` | string | Day of week | +| ↳ `start_time` | string | Start time | +| ↳ `end_time` | string | End time | +| ↳ `created_at` | string | When the path was created | +| ↳ `updated_at` | string | When the path was last updated | ### `incidentio_escalation_paths_update` @@ -1237,22 +1241,22 @@ Update an existing escalation path in incident.io | Parameter | Type | Description | | --------- | ---- | ----------- | | `escalation_path` | object | The updated escalation path | -| ↳ `id` | string | The escalation path ID | -| ↳ `name` | string | The escalation path name | -| ↳ `path` | array | Array of escalation levels | -| ↳ `targets` | array | Targets for this level | -| ↳ `id` | string | Target ID | -| ↳ `type` | string | Target type | -| ↳ `schedule_id` | string | Schedule ID if type is schedule | -| ↳ `user_id` | string | User ID if type is user | -| ↳ `urgency` | string | Urgency level | -| ↳ `time_to_ack_seconds` | number | Time to acknowledge in seconds | -| ↳ `working_hours` | array | Working hours configuration | -| ↳ `weekday` | string | Day of week | -| ↳ `start_time` | string | Start time | -| ↳ `end_time` | string | End time | -| ↳ `created_at` | string | When the path was created | -| ↳ `updated_at` | string | When the path was last updated | +| ↳ `id` | string | The escalation path ID | +| ↳ `name` | string | The escalation path name | +| ↳ `path` | array | Array of escalation levels | +| ↳ `targets` | array | Targets for this level | +| ↳ `id` | string | Target ID | +| ↳ `type` | string | Target type | +| ↳ `schedule_id` | string | Schedule ID if type is schedule | +| ↳ `user_id` | string | User ID if type is user | +| ↳ `urgency` | string | Urgency level | +| ↳ `time_to_ack_seconds` | number | Time to acknowledge in seconds | +| ↳ `working_hours` | array | Working hours configuration | +| ↳ `weekday` | string | Day of week | +| ↳ `start_time` | string | Start time | +| ↳ `end_time` | string | End time | +| ↳ `created_at` | string | When the path was created | +| ↳ `updated_at` | string | When the path was last updated | ### `incidentio_escalation_paths_delete` diff --git a/apps/docs/content/docs/en/tools/intercom.mdx b/apps/docs/content/docs/en/tools/intercom.mdx index 0c21ffa18..6330cb036 100644 --- a/apps/docs/content/docs/en/tools/intercom.mdx +++ b/apps/docs/content/docs/en/tools/intercom.mdx @@ -61,50 +61,50 @@ Create a new contact in Intercom with email, external_id, or role. Returns API-a | Parameter | Type | Description | | --------- | ---- | ----------- | | `contact` | object | Created contact object | -| ↳ `id` | string | Unique identifier for the contact | -| ↳ `type` | string | Object type \(contact\) | -| ↳ `role` | string | Role of the contact \(user or lead\) | -| ↳ `email` | string | Email address of the contact | -| ↳ `phone` | string | Phone number of the contact | -| ↳ `name` | string | Name of the contact | -| ↳ `avatar` | string | Avatar URL of the contact | -| ↳ `owner_id` | string | ID of the admin assigned to this contact | -| ↳ `external_id` | string | External identifier for the contact | -| ↳ `created_at` | number | Unix timestamp when contact was created | -| ↳ `updated_at` | number | Unix timestamp when contact was last updated | -| ↳ `signed_up_at` | number | Unix timestamp when user signed up | -| ↳ `last_seen_at` | number | Unix timestamp when user was last seen | -| ↳ `workspace_id` | string | Workspace ID the contact belongs to | -| ↳ `custom_attributes` | object | Custom attributes set on the contact | -| ↳ `tags` | object | Tags associated with the contact | -| ↳ `type` | string | List type | -| ↳ `url` | string | URL to fetch tags | -| ↳ `data` | array | Array of tag objects | -| ↳ `has_more` | boolean | Whether there are more tags | -| ↳ `total_count` | number | Total number of tags | -| ↳ `notes` | object | Notes associated with the contact | -| ↳ `type` | string | List type | -| ↳ `url` | string | URL to fetch notes | -| ↳ `data` | array | Array of note objects | -| ↳ `has_more` | boolean | Whether there are more notes | -| ↳ `total_count` | number | Total number of notes | -| ↳ `companies` | object | Companies associated with the contact | -| ↳ `type` | string | List type | -| ↳ `url` | string | URL to fetch companies | -| ↳ `data` | array | Array of company objects | -| ↳ `has_more` | boolean | Whether there are more companies | -| ↳ `total_count` | number | Total number of companies | -| ↳ `location` | object | Location information for the contact | -| ↳ `type` | string | Location type | -| ↳ `city` | string | City | -| ↳ `region` | string | Region/State | -| ↳ `country` | string | Country | -| ↳ `country_code` | string | Country code | -| ↳ `continent_code` | string | Continent code | -| ↳ `social_profiles` | object | Social profiles of the contact | -| ↳ `type` | string | List type | -| ↳ `data` | array | Array of social profile objects | -| ↳ `unsubscribed_from_emails` | boolean | Whether contact is unsubscribed from emails | +| ↳ `id` | string | Unique identifier for the contact | +| ↳ `type` | string | Object type \(contact\) | +| ↳ `role` | string | Role of the contact \(user or lead\) | +| ↳ `email` | string | Email address of the contact | +| ↳ `phone` | string | Phone number of the contact | +| ↳ `name` | string | Name of the contact | +| ↳ `avatar` | string | Avatar URL of the contact | +| ↳ `owner_id` | string | ID of the admin assigned to this contact | +| ↳ `external_id` | string | External identifier for the contact | +| ↳ `created_at` | number | Unix timestamp when contact was created | +| ↳ `updated_at` | number | Unix timestamp when contact was last updated | +| ↳ `signed_up_at` | number | Unix timestamp when user signed up | +| ↳ `last_seen_at` | number | Unix timestamp when user was last seen | +| ↳ `workspace_id` | string | Workspace ID the contact belongs to | +| ↳ `custom_attributes` | object | Custom attributes set on the contact | +| ↳ `tags` | object | Tags associated with the contact | +| ↳ `type` | string | List type | +| ↳ `url` | string | URL to fetch tags | +| ↳ `data` | array | Array of tag objects | +| ↳ `has_more` | boolean | Whether there are more tags | +| ↳ `total_count` | number | Total number of tags | +| ↳ `notes` | object | Notes associated with the contact | +| ↳ `type` | string | List type | +| ↳ `url` | string | URL to fetch notes | +| ↳ `data` | array | Array of note objects | +| ↳ `has_more` | boolean | Whether there are more notes | +| ↳ `total_count` | number | Total number of notes | +| ↳ `companies` | object | Companies associated with the contact | +| ↳ `type` | string | List type | +| ↳ `url` | string | URL to fetch companies | +| ↳ `data` | array | Array of company objects | +| ↳ `has_more` | boolean | Whether there are more companies | +| ↳ `total_count` | number | Total number of companies | +| ↳ `location` | object | Location information for the contact | +| ↳ `type` | string | Location type | +| ↳ `city` | string | City | +| ↳ `region` | string | Region/State | +| ↳ `country` | string | Country | +| ↳ `country_code` | string | Country code | +| ↳ `continent_code` | string | Continent code | +| ↳ `social_profiles` | object | Social profiles of the contact | +| ↳ `type` | string | List type | +| ↳ `data` | array | Array of social profile objects | +| ↳ `unsubscribed_from_emails` | boolean | Whether contact is unsubscribed from emails | | `contactId` | string | ID of the created contact | ### `intercom_get_contact` @@ -122,25 +122,65 @@ Get a single contact by ID from Intercom. Returns API-aligned fields only. | Parameter | Type | Description | | --------- | ---- | ----------- | | `contact` | object | Contact object | -| ↳ `id` | string | Unique identifier for the contact | -| ↳ `type` | string | Object type \(contact\) | -| ↳ `role` | string | Role of the contact \(user or lead\) | -| ↳ `email` | string | Email address of the contact | -| ↳ `phone` | string | Phone number of the contact | -| ↳ `name` | string | Name of the contact | -| ↳ `avatar` | string | Avatar URL of the contact | -| ↳ `owner_id` | string | ID of the admin assigned to this contact | -| ↳ `external_id` | string | External identifier for the contact | -| ↳ `created_at` | number | Unix timestamp when contact was created | -| ↳ `updated_at` | number | Unix timestamp when contact was last updated | -| ↳ `workspace_id` | string | Workspace ID the contact belongs to | -| ↳ `custom_attributes` | object | Custom attributes set on the contact | -| ↳ `tags` | object | Tags associated with the contact | -| ↳ `notes` | object | Notes associated with the contact | -| ↳ `companies` | object | Companies associated with the contact | -| ↳ `location` | object | Location information for the contact | -| ↳ `social_profiles` | object | Social profiles of the contact | -| ↳ `unsubscribed_from_emails` | boolean | Whether contact is unsubscribed from emails | +| ↳ `id` | string | Unique identifier for the contact | +| ↳ `type` | string | Object type \(contact\) | +| ↳ `role` | string | Role of the contact \(user or lead\) | +| ↳ `email` | string | Email address of the contact | +| ↳ `email_domain` | string | Email domain of the contact | +| ↳ `phone` | string | Phone number of the contact | +| ↳ `name` | string | Name of the contact | +| ↳ `avatar` | string | Avatar URL of the contact | +| ↳ `owner_id` | string | ID of the admin assigned account ownership | +| ↳ `external_id` | string | External identifier provided by the client | +| ↳ `workspace_id` | string | Workspace ID the contact belongs to | +| ↳ `created_at` | number | Unix timestamp when contact was created | +| ↳ `updated_at` | number | Unix timestamp when contact was last updated | +| ↳ `signed_up_at` | number | Unix timestamp when user signed up | +| ↳ `last_seen_at` | number | Unix timestamp when user was last seen | +| ↳ `last_contacted_at` | number | Unix timestamp when contact was last contacted | +| ↳ `last_replied_at` | number | Unix timestamp when contact last replied | +| ↳ `last_email_opened_at` | number | Unix timestamp when contact last opened an email | +| ↳ `last_email_clicked_at` | number | Unix timestamp when contact last clicked an email link | +| ↳ `has_hard_bounced` | boolean | Whether email to this contact has hard bounced | +| ↳ `marked_email_as_spam` | boolean | Whether contact marked email as spam | +| ↳ `unsubscribed_from_emails` | boolean | Whether contact is unsubscribed from emails | +| ↳ `browser` | string | Browser used by contact | +| ↳ `browser_version` | string | Browser version | +| ↳ `browser_language` | string | Browser language setting | +| ↳ `os` | string | Operating system | +| ↳ `language_override` | string | Language override setting | +| ↳ `custom_attributes` | object | Custom attributes set on the contact | +| ↳ `tags` | object | Tags associated with the contact \(up to 10 displayed\) | +| ↳ `type` | string | List type identifier | +| ↳ `url` | string | URL to fetch full list | +| ↳ `data` | array | Array of objects \(up to 10\) | +| ↳ `has_more` | boolean | Whether there are more items beyond this list | +| ↳ `total_count` | number | Total number of items | +| ↳ `notes` | object | Notes associated with the contact \(up to 10 displayed\) | +| ↳ `type` | string | List type identifier | +| ↳ `url` | string | URL to fetch full list | +| ↳ `data` | array | Array of objects \(up to 10\) | +| ↳ `has_more` | boolean | Whether there are more items beyond this list | +| ↳ `total_count` | number | Total number of items | +| ↳ `companies` | object | Companies associated with the contact \(up to 10 displayed\) | +| ↳ `type` | string | List type identifier | +| ↳ `url` | string | URL to fetch full list | +| ↳ `data` | array | Array of objects \(up to 10\) | +| ↳ `has_more` | boolean | Whether there are more items beyond this list | +| ↳ `total_count` | number | Total number of items | +| ↳ `location` | object | Location information for the contact | +| ↳ `type` | string | Object type \(location\) | +| ↳ `city` | string | City name | +| ↳ `region` | string | Region or state name | +| ↳ `country` | string | Country name | +| ↳ `country_code` | string | ISO country code | +| ↳ `continent_code` | string | Continent code | +| ↳ `social_profiles` | object | Social profiles of the contact | +| ↳ `type` | string | Social network type \(e.g., twitter, facebook\) | +| ↳ `name` | string | Social network name | +| ↳ `url` | string | Profile URL | +| ↳ `username` | string | Username on the social network | +| ↳ `id` | string | User ID on the social network | ### `intercom_update_contact` @@ -169,25 +209,25 @@ Update an existing contact in Intercom. Returns API-aligned fields only. | Parameter | Type | Description | | --------- | ---- | ----------- | | `contact` | object | Updated contact object | -| ↳ `id` | string | Unique identifier for the contact | -| ↳ `type` | string | Object type \(contact\) | -| ↳ `role` | string | Role of the contact \(user or lead\) | -| ↳ `email` | string | Email address of the contact | -| ↳ `phone` | string | Phone number of the contact | -| ↳ `name` | string | Name of the contact | -| ↳ `avatar` | string | Avatar URL of the contact | -| ↳ `owner_id` | string | ID of the admin assigned to this contact | -| ↳ `external_id` | string | External identifier for the contact | -| ↳ `created_at` | number | Unix timestamp when contact was created | -| ↳ `updated_at` | number | Unix timestamp when contact was last updated | -| ↳ `workspace_id` | string | Workspace ID the contact belongs to | -| ↳ `custom_attributes` | object | Custom attributes set on the contact | -| ↳ `tags` | object | Tags associated with the contact | -| ↳ `notes` | object | Notes associated with the contact | -| ↳ `companies` | object | Companies associated with the contact | -| ↳ `location` | object | Location information for the contact | -| ↳ `social_profiles` | object | Social profiles of the contact | -| ↳ `unsubscribed_from_emails` | boolean | Whether contact is unsubscribed from emails | +| ↳ `id` | string | Unique identifier for the contact | +| ↳ `type` | string | Object type \(contact\) | +| ↳ `role` | string | Role of the contact \(user or lead\) | +| ↳ `email` | string | Email address of the contact | +| ↳ `phone` | string | Phone number of the contact | +| ↳ `name` | string | Name of the contact | +| ↳ `avatar` | string | Avatar URL of the contact | +| ↳ `owner_id` | string | ID of the admin assigned to this contact | +| ↳ `external_id` | string | External identifier for the contact | +| ↳ `created_at` | number | Unix timestamp when contact was created | +| ↳ `updated_at` | number | Unix timestamp when contact was last updated | +| ↳ `workspace_id` | string | Workspace ID the contact belongs to | +| ↳ `custom_attributes` | object | Custom attributes set on the contact | +| ↳ `tags` | object | Tags associated with the contact | +| ↳ `notes` | object | Notes associated with the contact | +| ↳ `companies` | object | Companies associated with the contact | +| ↳ `location` | object | Location information for the contact | +| ↳ `social_profiles` | object | Social profiles of the contact | +| ↳ `unsubscribed_from_emails` | boolean | Whether contact is unsubscribed from emails | | `contactId` | string | ID of the updated contact | ### `intercom_list_contacts` @@ -220,10 +260,10 @@ List all contacts from Intercom with pagination support | ↳ `tags` | object | Tags associated with the contact | | ↳ `companies` | object | Companies associated with the contact | | `pages` | object | Pagination information | -| ↳ `type` | string | Pages type identifier | -| ↳ `page` | number | Current page number | -| ↳ `per_page` | number | Number of results per page | -| ↳ `total_pages` | number | Total number of pages | +| ↳ `type` | string | Pages type identifier | +| ↳ `page` | number | Current page number | +| ↳ `per_page` | number | Number of results per page | +| ↳ `total_pages` | number | Total number of pages | | `total_count` | number | Total number of contacts | ### `intercom_search_contacts` @@ -267,10 +307,10 @@ Search for contacts in Intercom using a query | ↳ `social_profiles` | object | Social profiles of the contact | | ↳ `unsubscribed_from_emails` | boolean | Whether contact is unsubscribed from emails | | `pages` | object | Pagination information | -| ↳ `type` | string | Pages type identifier | -| ↳ `page` | number | Current page number | -| ↳ `per_page` | number | Number of results per page | -| ↳ `total_pages` | number | Total number of pages | +| ↳ `type` | string | Pages type identifier | +| ↳ `page` | number | Current page number | +| ↳ `per_page` | number | Number of results per page | +| ↳ `total_pages` | number | Total number of pages | | `total_count` | number | Total number of matching contacts | ### `intercom_delete_contact` @@ -313,28 +353,28 @@ Create or update a company in Intercom | Parameter | Type | Description | | --------- | ---- | ----------- | | `company` | object | Created or updated company object | -| ↳ `id` | string | Unique identifier for the company | -| ↳ `type` | string | Object type \(company\) | -| ↳ `app_id` | string | Intercom app ID | -| ↳ `company_id` | string | Your unique identifier for the company | -| ↳ `name` | string | Name of the company | -| ↳ `website` | string | Company website URL | -| ↳ `plan` | object | Company plan information | -| ↳ `size` | number | Number of employees | -| ↳ `industry` | string | Industry the company operates in | -| ↳ `monthly_spend` | number | Monthly revenue from this company | -| ↳ `session_count` | number | Number of sessions | -| ↳ `user_count` | number | Number of users in the company | -| ↳ `created_at` | number | Unix timestamp when company was created | -| ↳ `updated_at` | number | Unix timestamp when company was last updated | -| ↳ `remote_created_at` | number | Unix timestamp when company was created by you | -| ↳ `custom_attributes` | object | Custom attributes set on the company | -| ↳ `tags` | object | Tags associated with the company | -| ↳ `type` | string | Tag list type | -| ↳ `tags` | array | Array of tag objects | -| ↳ `segments` | object | Segments the company belongs to | -| ↳ `type` | string | Segment list type | -| ↳ `segments` | array | Array of segment objects | +| ↳ `id` | string | Unique identifier for the company | +| ↳ `type` | string | Object type \(company\) | +| ↳ `app_id` | string | Intercom app ID | +| ↳ `company_id` | string | Your unique identifier for the company | +| ↳ `name` | string | Name of the company | +| ↳ `website` | string | Company website URL | +| ↳ `plan` | object | Company plan information | +| ↳ `size` | number | Number of employees | +| ↳ `industry` | string | Industry the company operates in | +| ↳ `monthly_spend` | number | Monthly revenue from this company | +| ↳ `session_count` | number | Number of sessions | +| ↳ `user_count` | number | Number of users in the company | +| ↳ `created_at` | number | Unix timestamp when company was created | +| ↳ `updated_at` | number | Unix timestamp when company was last updated | +| ↳ `remote_created_at` | number | Unix timestamp when company was created by you | +| ↳ `custom_attributes` | object | Custom attributes set on the company | +| ↳ `tags` | object | Tags associated with the company | +| ↳ `type` | string | Tag list type | +| ↳ `tags` | array | Array of tag objects | +| ↳ `segments` | object | Segments the company belongs to | +| ↳ `type` | string | Segment list type | +| ↳ `segments` | array | Array of segment objects | | `companyId` | string | ID of the created/updated company | ### `intercom_get_company` @@ -352,23 +392,23 @@ Retrieve a single company by ID from Intercom | Parameter | Type | Description | | --------- | ---- | ----------- | | `company` | object | Company object | -| ↳ `id` | string | Unique identifier for the company | -| ↳ `type` | string | Object type \(company\) | -| ↳ `app_id` | string | Intercom app ID | -| ↳ `company_id` | string | Your unique identifier for the company | -| ↳ `name` | string | Name of the company | -| ↳ `website` | string | Company website URL | -| ↳ `plan` | object | Company plan information | -| ↳ `size` | number | Number of employees | -| ↳ `industry` | string | Industry the company operates in | -| ↳ `monthly_spend` | number | Monthly revenue from this company | -| ↳ `session_count` | number | Number of sessions | -| ↳ `user_count` | number | Number of users in the company | -| ↳ `created_at` | number | Unix timestamp when company was created | -| ↳ `updated_at` | number | Unix timestamp when company was last updated | -| ↳ `custom_attributes` | object | Custom attributes set on the company | -| ↳ `tags` | object | Tags associated with the company | -| ↳ `segments` | object | Segments the company belongs to | +| ↳ `id` | string | Unique identifier for the company | +| ↳ `type` | string | Object type \(company\) | +| ↳ `app_id` | string | Intercom app ID | +| ↳ `company_id` | string | Your unique identifier for the company | +| ↳ `name` | string | Name of the company | +| ↳ `website` | string | Company website URL | +| ↳ `plan` | object | Company plan information | +| ↳ `size` | number | Number of employees | +| ↳ `industry` | string | Industry the company operates in | +| ↳ `monthly_spend` | number | Monthly revenue from this company | +| ↳ `session_count` | number | Number of sessions | +| ↳ `user_count` | number | Number of users in the company | +| ↳ `created_at` | number | Unix timestamp when company was created | +| ↳ `updated_at` | number | Unix timestamp when company was last updated | +| ↳ `custom_attributes` | object | Custom attributes set on the company | +| ↳ `tags` | object | Tags associated with the company | +| ↳ `segments` | object | Segments the company belongs to | ### `intercom_list_companies` @@ -403,10 +443,10 @@ List all companies from Intercom with pagination support. Note: This endpoint ha | ↳ `tags` | object | Tags associated with the company | | ↳ `segments` | object | Segments the company belongs to | | `pages` | object | Pagination information | -| ↳ `type` | string | Pages type identifier | -| ↳ `page` | number | Current page number | -| ↳ `per_page` | number | Number of results per page | -| ↳ `total_pages` | number | Total number of pages | +| ↳ `type` | string | Pages type identifier | +| ↳ `page` | number | Current page number | +| ↳ `per_page` | number | Number of results per page | +| ↳ `total_pages` | number | Total number of pages | | `total_count` | number | Total number of companies | | `success` | boolean | Operation success status | @@ -427,25 +467,25 @@ Retrieve a single conversation by ID from Intercom | Parameter | Type | Description | | --------- | ---- | ----------- | | `conversation` | object | Conversation object | -| ↳ `id` | string | Unique identifier for the conversation | -| ↳ `type` | string | Object type \(conversation\) | -| ↳ `title` | string | Title of the conversation | -| ↳ `created_at` | number | Unix timestamp when conversation was created | -| ↳ `updated_at` | number | Unix timestamp when conversation was last updated | -| ↳ `waiting_since` | number | Unix timestamp when waiting for reply | -| ↳ `snoozed_until` | number | Unix timestamp when snooze ends | -| ↳ `open` | boolean | Whether the conversation is open | -| ↳ `state` | string | State of the conversation | -| ↳ `read` | boolean | Whether the conversation has been read | -| ↳ `priority` | string | Priority of the conversation | -| ↳ `admin_assignee_id` | number | ID of assigned admin | -| ↳ `team_assignee_id` | string | ID of assigned team | -| ↳ `tags` | object | Tags on the conversation | -| ↳ `source` | object | Source of the conversation | -| ↳ `contacts` | object | Contacts in the conversation | -| ↳ `teammates` | object | Teammates in the conversation | -| ↳ `conversation_parts` | object | Parts of the conversation | -| ↳ `statistics` | object | Conversation statistics | +| ↳ `id` | string | Unique identifier for the conversation | +| ↳ `type` | string | Object type \(conversation\) | +| ↳ `title` | string | Title of the conversation | +| ↳ `created_at` | number | Unix timestamp when conversation was created | +| ↳ `updated_at` | number | Unix timestamp when conversation was last updated | +| ↳ `waiting_since` | number | Unix timestamp when waiting for reply | +| ↳ `snoozed_until` | number | Unix timestamp when snooze ends | +| ↳ `open` | boolean | Whether the conversation is open | +| ↳ `state` | string | State of the conversation | +| ↳ `read` | boolean | Whether the conversation has been read | +| ↳ `priority` | string | Priority of the conversation | +| ↳ `admin_assignee_id` | number | ID of assigned admin | +| ↳ `team_assignee_id` | string | ID of assigned team | +| ↳ `tags` | object | Tags on the conversation | +| ↳ `source` | object | Source of the conversation | +| ↳ `contacts` | object | Contacts in the conversation | +| ↳ `teammates` | object | Teammates in the conversation | +| ↳ `conversation_parts` | object | Parts of the conversation | +| ↳ `statistics` | object | Conversation statistics | | `success` | boolean | Operation success status | ### `intercom_list_conversations` @@ -482,10 +522,10 @@ List all conversations from Intercom with pagination support | ↳ `source` | object | Source of the conversation | | ↳ `contacts` | object | Contacts in the conversation | | `pages` | object | Pagination information | -| ↳ `type` | string | Pages type identifier | -| ↳ `page` | number | Current page number | -| ↳ `per_page` | number | Number of results per page | -| ↳ `total_pages` | number | Total number of pages | +| ↳ `type` | string | Pages type identifier | +| ↳ `page` | number | Current page number | +| ↳ `per_page` | number | Number of results per page | +| ↳ `total_pages` | number | Total number of pages | | `total_count` | number | Total number of conversations | | `success` | boolean | Operation success status | @@ -509,22 +549,22 @@ Reply to a conversation as an admin in Intercom | Parameter | Type | Description | | --------- | ---- | ----------- | | `conversation` | object | Updated conversation object | -| ↳ `id` | string | Unique identifier for the conversation | -| ↳ `type` | string | Object type \(conversation\) | -| ↳ `title` | string | Title of the conversation | -| ↳ `created_at` | number | Unix timestamp when conversation was created | -| ↳ `updated_at` | number | Unix timestamp when conversation was last updated | -| ↳ `waiting_since` | number | Unix timestamp when waiting for reply | -| ↳ `open` | boolean | Whether the conversation is open | -| ↳ `state` | string | State of the conversation | -| ↳ `read` | boolean | Whether the conversation has been read | -| ↳ `priority` | string | Priority of the conversation | -| ↳ `admin_assignee_id` | number | ID of assigned admin | -| ↳ `team_assignee_id` | string | ID of assigned team | -| ↳ `tags` | object | Tags on the conversation | -| ↳ `source` | object | Source of the conversation | -| ↳ `contacts` | object | Contacts in the conversation | -| ↳ `conversation_parts` | object | Parts of the conversation | +| ↳ `id` | string | Unique identifier for the conversation | +| ↳ `type` | string | Object type \(conversation\) | +| ↳ `title` | string | Title of the conversation | +| ↳ `created_at` | number | Unix timestamp when conversation was created | +| ↳ `updated_at` | number | Unix timestamp when conversation was last updated | +| ↳ `waiting_since` | number | Unix timestamp when waiting for reply | +| ↳ `open` | boolean | Whether the conversation is open | +| ↳ `state` | string | State of the conversation | +| ↳ `read` | boolean | Whether the conversation has been read | +| ↳ `priority` | string | Priority of the conversation | +| ↳ `admin_assignee_id` | number | ID of assigned admin | +| ↳ `team_assignee_id` | string | ID of assigned team | +| ↳ `tags` | object | Tags on the conversation | +| ↳ `source` | object | Source of the conversation | +| ↳ `contacts` | object | Contacts in the conversation | +| ↳ `conversation_parts` | object | Parts of the conversation | | `conversationId` | string | ID of the conversation | | `success` | boolean | Operation success status | @@ -563,10 +603,10 @@ Search for conversations in Intercom using a query. Returns API-aligned fields o | ↳ `source` | object | Source of the conversation | | ↳ `contacts` | object | Contacts in the conversation | | `pages` | object | Pagination information | -| ↳ `type` | string | Pages type identifier | -| ↳ `page` | number | Current page number | -| ↳ `per_page` | number | Number of results per page | -| ↳ `total_pages` | number | Total number of pages | +| ↳ `type` | string | Pages type identifier | +| ↳ `page` | number | Current page number | +| ↳ `per_page` | number | Number of results per page | +| ↳ `total_pages` | number | Total number of pages | | `total_count` | number | Total number of matching conversations | | `success` | boolean | Operation success status | @@ -591,21 +631,21 @@ Create a new ticket in Intercom. Returns API-aligned fields only. | Parameter | Type | Description | | --------- | ---- | ----------- | | `ticket` | object | Created ticket object | -| ↳ `id` | string | Unique identifier for the ticket | -| ↳ `type` | string | Object type \(ticket\) | -| ↳ `ticket_id` | string | Ticket ID | -| ↳ `ticket_type` | object | Type of the ticket | -| ↳ `ticket_attributes` | object | Attributes of the ticket | -| ↳ `ticket_state` | string | State of the ticket | -| ↳ `ticket_state_internal_label` | string | Internal label for ticket state | -| ↳ `ticket_state_external_label` | string | External label for ticket state | -| ↳ `created_at` | number | Unix timestamp when ticket was created | -| ↳ `updated_at` | number | Unix timestamp when ticket was last updated | -| ↳ `contacts` | object | Contacts associated with the ticket | -| ↳ `admin_assignee_id` | string | ID of assigned admin | -| ↳ `team_assignee_id` | string | ID of assigned team | -| ↳ `is_shared` | boolean | Whether the ticket is shared | -| ↳ `open` | boolean | Whether the ticket is open | +| ↳ `id` | string | Unique identifier for the ticket | +| ↳ `type` | string | Object type \(ticket\) | +| ↳ `ticket_id` | string | Ticket ID | +| ↳ `ticket_type` | object | Type of the ticket | +| ↳ `ticket_attributes` | object | Attributes of the ticket | +| ↳ `ticket_state` | string | State of the ticket | +| ↳ `ticket_state_internal_label` | string | Internal label for ticket state | +| ↳ `ticket_state_external_label` | string | External label for ticket state | +| ↳ `created_at` | number | Unix timestamp when ticket was created | +| ↳ `updated_at` | number | Unix timestamp when ticket was last updated | +| ↳ `contacts` | object | Contacts associated with the ticket | +| ↳ `admin_assignee_id` | string | ID of assigned admin | +| ↳ `team_assignee_id` | string | ID of assigned team | +| ↳ `is_shared` | boolean | Whether the ticket is shared | +| ↳ `open` | boolean | Whether the ticket is open | | `ticketId` | string | ID of the created ticket | | `success` | boolean | Operation success status | @@ -624,21 +664,21 @@ Retrieve a single ticket by ID from Intercom. Returns API-aligned fields only. | Parameter | Type | Description | | --------- | ---- | ----------- | | `ticket` | object | Ticket object | -| ↳ `id` | string | Unique identifier for the ticket | -| ↳ `type` | string | Object type \(ticket\) | -| ↳ `ticket_id` | string | Ticket ID | -| ↳ `ticket_type` | object | Type of the ticket | -| ↳ `ticket_attributes` | object | Attributes of the ticket | -| ↳ `ticket_state` | string | State of the ticket | -| ↳ `ticket_state_internal_label` | string | Internal label for ticket state | -| ↳ `ticket_state_external_label` | string | External label for ticket state | -| ↳ `created_at` | number | Unix timestamp when ticket was created | -| ↳ `updated_at` | number | Unix timestamp when ticket was last updated | -| ↳ `contacts` | object | Contacts associated with the ticket | -| ↳ `admin_assignee_id` | string | ID of assigned admin | -| ↳ `team_assignee_id` | string | ID of assigned team | -| ↳ `is_shared` | boolean | Whether the ticket is shared | -| ↳ `open` | boolean | Whether the ticket is open | +| ↳ `id` | string | Unique identifier for the ticket | +| ↳ `type` | string | Object type \(ticket\) | +| ↳ `ticket_id` | string | Ticket ID | +| ↳ `ticket_type` | object | Type of the ticket | +| ↳ `ticket_attributes` | object | Attributes of the ticket | +| ↳ `ticket_state` | string | State of the ticket | +| ↳ `ticket_state_internal_label` | string | Internal label for ticket state | +| ↳ `ticket_state_external_label` | string | External label for ticket state | +| ↳ `created_at` | number | Unix timestamp when ticket was created | +| ↳ `updated_at` | number | Unix timestamp when ticket was last updated | +| ↳ `contacts` | object | Contacts associated with the ticket | +| ↳ `admin_assignee_id` | string | ID of assigned admin | +| ↳ `team_assignee_id` | string | ID of assigned team | +| ↳ `is_shared` | boolean | Whether the ticket is shared | +| ↳ `open` | boolean | Whether the ticket is open | | `ticketId` | string | ID of the retrieved ticket | | `success` | boolean | Operation success status | @@ -663,18 +703,18 @@ Update a ticket in Intercom (change state, assignment, attributes) | Parameter | Type | Description | | --------- | ---- | ----------- | | `ticket` | object | The updated ticket object | -| ↳ `id` | string | Unique identifier for the ticket | -| ↳ `type` | string | Object type \(ticket\) | -| ↳ `ticket_id` | string | Ticket ID shown in Intercom UI | -| ↳ `ticket_state` | string | State of the ticket | -| ↳ `ticket_attributes` | object | Attributes of the ticket | -| ↳ `open` | boolean | Whether the ticket is open | -| ↳ `is_shared` | boolean | Whether the ticket is visible to users | -| ↳ `snoozed_until` | number | Unix timestamp when ticket will reopen | -| ↳ `admin_assignee_id` | string | ID of assigned admin | -| ↳ `team_assignee_id` | string | ID of assigned team | -| ↳ `created_at` | number | Unix timestamp when ticket was created | -| ↳ `updated_at` | number | Unix timestamp when ticket was last updated | +| ↳ `id` | string | Unique identifier for the ticket | +| ↳ `type` | string | Object type \(ticket\) | +| ↳ `ticket_id` | string | Ticket ID shown in Intercom UI | +| ↳ `ticket_state` | string | State of the ticket | +| ↳ `ticket_attributes` | object | Attributes of the ticket | +| ↳ `open` | boolean | Whether the ticket is open | +| ↳ `is_shared` | boolean | Whether the ticket is visible to users | +| ↳ `snoozed_until` | number | Unix timestamp when ticket will reopen | +| ↳ `admin_assignee_id` | string | ID of assigned admin | +| ↳ `team_assignee_id` | string | ID of assigned team | +| ↳ `created_at` | number | Unix timestamp when ticket was created | +| ↳ `updated_at` | number | Unix timestamp when ticket was last updated | | `ticketId` | string | ID of the updated ticket | | `ticket_state` | string | Current state of the ticket | @@ -701,13 +741,13 @@ Create and send a new admin-initiated message in Intercom. Returns API-aligned f | Parameter | Type | Description | | --------- | ---- | ----------- | | `message` | object | Created message object | -| ↳ `id` | string | Unique identifier for the message | -| ↳ `type` | string | Object type \(message\) | -| ↳ `created_at` | number | Unix timestamp when message was created | -| ↳ `body` | string | Body of the message | -| ↳ `message_type` | string | Type of the message \(in_app or email\) | -| ↳ `conversation_id` | string | ID of the conversation created | -| ↳ `owner` | object | Owner of the message | +| ↳ `id` | string | Unique identifier for the message | +| ↳ `type` | string | Object type \(message\) | +| ↳ `created_at` | number | Unix timestamp when message was created | +| ↳ `body` | string | Body of the message | +| ↳ `message_type` | string | Type of the message \(in_app or email\) | +| ↳ `conversation_id` | string | ID of the conversation created | +| ↳ `owner` | object | Owner of the message | | `messageId` | string | ID of the created message | | `success` | boolean | Operation success status | @@ -755,13 +795,13 @@ Close a conversation in Intercom | Parameter | Type | Description | | --------- | ---- | ----------- | | `conversation` | object | The closed conversation object | -| ↳ `id` | string | Unique identifier for the conversation | -| ↳ `type` | string | Object type \(conversation\) | -| ↳ `state` | string | State of the conversation \(closed\) | -| ↳ `open` | boolean | Whether the conversation is open \(false\) | -| ↳ `read` | boolean | Whether the conversation has been read | -| ↳ `created_at` | number | Unix timestamp when conversation was created | -| ↳ `updated_at` | number | Unix timestamp when conversation was last updated | +| ↳ `id` | string | Unique identifier for the conversation | +| ↳ `type` | string | Object type \(conversation\) | +| ↳ `state` | string | State of the conversation \(closed\) | +| ↳ `open` | boolean | Whether the conversation is open \(false\) | +| ↳ `read` | boolean | Whether the conversation has been read | +| ↳ `created_at` | number | Unix timestamp when conversation was created | +| ↳ `updated_at` | number | Unix timestamp when conversation was last updated | | `conversationId` | string | ID of the closed conversation | | `state` | string | State of the conversation \(closed\) | @@ -781,13 +821,13 @@ Open a closed or snoozed conversation in Intercom | Parameter | Type | Description | | --------- | ---- | ----------- | | `conversation` | object | The opened conversation object | -| ↳ `id` | string | Unique identifier for the conversation | -| ↳ `type` | string | Object type \(conversation\) | -| ↳ `state` | string | State of the conversation \(open\) | -| ↳ `open` | boolean | Whether the conversation is open \(true\) | -| ↳ `read` | boolean | Whether the conversation has been read | -| ↳ `created_at` | number | Unix timestamp when conversation was created | -| ↳ `updated_at` | number | Unix timestamp when conversation was last updated | +| ↳ `id` | string | Unique identifier for the conversation | +| ↳ `type` | string | Object type \(conversation\) | +| ↳ `state` | string | State of the conversation \(open\) | +| ↳ `open` | boolean | Whether the conversation is open \(true\) | +| ↳ `read` | boolean | Whether the conversation has been read | +| ↳ `created_at` | number | Unix timestamp when conversation was created | +| ↳ `updated_at` | number | Unix timestamp when conversation was last updated | | `conversationId` | string | ID of the opened conversation | | `state` | string | State of the conversation \(open\) | @@ -808,13 +848,13 @@ Snooze a conversation to reopen at a future time | Parameter | Type | Description | | --------- | ---- | ----------- | | `conversation` | object | The snoozed conversation object | -| ↳ `id` | string | Unique identifier for the conversation | -| ↳ `type` | string | Object type \(conversation\) | -| ↳ `state` | string | State of the conversation \(snoozed\) | -| ↳ `open` | boolean | Whether the conversation is open | -| ↳ `snoozed_until` | number | Unix timestamp when conversation will reopen | -| ↳ `created_at` | number | Unix timestamp when conversation was created | -| ↳ `updated_at` | number | Unix timestamp when conversation was last updated | +| ↳ `id` | string | Unique identifier for the conversation | +| ↳ `type` | string | Object type \(conversation\) | +| ↳ `state` | string | State of the conversation \(snoozed\) | +| ↳ `open` | boolean | Whether the conversation is open | +| ↳ `snoozed_until` | number | Unix timestamp when conversation will reopen | +| ↳ `created_at` | number | Unix timestamp when conversation was created | +| ↳ `updated_at` | number | Unix timestamp when conversation was last updated | | `conversationId` | string | ID of the snoozed conversation | | `state` | string | State of the conversation \(snoozed\) | | `snoozed_until` | number | Unix timestamp when conversation will reopen | @@ -837,14 +877,14 @@ Assign a conversation to an admin or team in Intercom | Parameter | Type | Description | | --------- | ---- | ----------- | | `conversation` | object | The assigned conversation object | -| ↳ `id` | string | Unique identifier for the conversation | -| ↳ `type` | string | Object type \(conversation\) | -| ↳ `state` | string | State of the conversation | -| ↳ `open` | boolean | Whether the conversation is open | -| ↳ `admin_assignee_id` | number | ID of the assigned admin | -| ↳ `team_assignee_id` | string | ID of the assigned team | -| ↳ `created_at` | number | Unix timestamp when conversation was created | -| ↳ `updated_at` | number | Unix timestamp when conversation was last updated | +| ↳ `id` | string | Unique identifier for the conversation | +| ↳ `type` | string | Object type \(conversation\) | +| ↳ `state` | string | State of the conversation | +| ↳ `open` | boolean | Whether the conversation is open | +| ↳ `admin_assignee_id` | number | ID of the assigned admin | +| ↳ `team_assignee_id` | string | ID of the assigned team | +| ↳ `created_at` | number | Unix timestamp when conversation was created | +| ↳ `updated_at` | number | Unix timestamp when conversation was last updated | | `conversationId` | string | ID of the assigned conversation | | `admin_assignee_id` | number | ID of the assigned admin | | `team_assignee_id` | string | ID of the assigned team | @@ -966,13 +1006,13 @@ Add a note to a specific contact | `created_at` | number | Unix timestamp when the note was created | | `type` | string | Object type \(note\) | | `author` | object | The admin who created the note | -| ↳ `type` | string | Author type \(admin\) | -| ↳ `id` | string | Author ID | -| ↳ `name` | string | Author name | -| ↳ `email` | string | Author email | +| ↳ `type` | string | Author type \(admin\) | +| ↳ `id` | string | Author ID | +| ↳ `name` | string | Author name | +| ↳ `email` | string | Author email | | `contact` | object | The contact the note was created for | -| ↳ `type` | string | Contact type | -| ↳ `id` | string | Contact ID | +| ↳ `type` | string | Contact type | +| ↳ `id` | string | Contact ID | ### `intercom_create_event` @@ -1011,16 +1051,16 @@ Attach a contact to a company in Intercom | Parameter | Type | Description | | --------- | ---- | ----------- | | `company` | object | The company object the contact was attached to | -| ↳ `id` | string | Unique identifier for the company | -| ↳ `type` | string | Object type \(company\) | -| ↳ `company_id` | string | The company_id you defined | -| ↳ `name` | string | Name of the company | -| ↳ `created_at` | number | Unix timestamp when company was created | -| ↳ `updated_at` | number | Unix timestamp when company was updated | -| ↳ `user_count` | number | Number of users in the company | -| ↳ `session_count` | number | Number of sessions | -| ↳ `monthly_spend` | number | Monthly spend amount | -| ↳ `plan` | object | Company plan details | +| ↳ `id` | string | Unique identifier for the company | +| ↳ `type` | string | Object type \(company\) | +| ↳ `company_id` | string | The company_id you defined | +| ↳ `name` | string | Name of the company | +| ↳ `created_at` | number | Unix timestamp when company was created | +| ↳ `updated_at` | number | Unix timestamp when company was updated | +| ↳ `user_count` | number | Number of users in the company | +| ↳ `session_count` | number | Number of sessions | +| ↳ `monthly_spend` | number | Monthly spend amount | +| ↳ `plan` | object | Company plan details | | `companyId` | string | ID of the company | | `name` | string | Name of the company | @@ -1040,10 +1080,10 @@ Remove a contact from a company in Intercom | Parameter | Type | Description | | --------- | ---- | ----------- | | `company` | object | The company object the contact was detached from | -| ↳ `id` | string | Unique identifier for the company | -| ↳ `type` | string | Object type \(company\) | -| ↳ `company_id` | string | The company_id you defined | -| ↳ `name` | string | Name of the company | +| ↳ `id` | string | Unique identifier for the company | +| ↳ `type` | string | Object type \(company\) | +| ↳ `company_id` | string | The company_id you defined | +| ↳ `name` | string | Name of the company | | `companyId` | string | ID of the company | | `name` | string | Name of the company | diff --git a/apps/docs/content/docs/en/tools/jina.mdx b/apps/docs/content/docs/en/tools/jina.mdx index c037d0081..9b2dc70e9 100644 --- a/apps/docs/content/docs/en/tools/jina.mdx +++ b/apps/docs/content/docs/en/tools/jina.mdx @@ -91,5 +91,11 @@ Search the web and return top 5 results with LLM-friendly content. Each result i | Parameter | Type | Description | | --------- | ---- | ----------- | | `results` | array | Array of search results, each containing title, description, url, and LLM-friendly content | +| ↳ `title` | string | Page title | +| ↳ `description` | string | Page description or meta description | +| ↳ `url` | string | Page URL | +| ↳ `content` | string | LLM-friendly extracted content | +| ↳ `usage` | object | Token usage information | +| ↳ `tokens` | number | Number of tokens consumed by this request | diff --git a/apps/docs/content/docs/en/tools/kalshi.mdx b/apps/docs/content/docs/en/tools/kalshi.mdx index bae619d79..abdfaeca1 100644 --- a/apps/docs/content/docs/en/tools/kalshi.mdx +++ b/apps/docs/content/docs/en/tools/kalshi.mdx @@ -53,6 +53,33 @@ Retrieve a list of prediction markets from Kalshi with all filtering options (V2 | Parameter | Type | Description | | --------- | ---- | ----------- | | `markets` | array | Array of market objects with all API fields | +| ↳ `ticker` | string | Unique market ticker identifier | +| ↳ `event_ticker` | string | Parent event ticker | +| ↳ `market_type` | string | Market type \(binary, etc.\) | +| ↳ `title` | string | Market title/question | +| ↳ `subtitle` | string | Market subtitle | +| ↳ `yes_sub_title` | string | Yes outcome subtitle | +| ↳ `no_sub_title` | string | No outcome subtitle | +| ↳ `open_time` | string | Market open time \(ISO 8601\) | +| ↳ `close_time` | string | Market close time \(ISO 8601\) | +| ↳ `expiration_time` | string | Contract expiration time | +| ↳ `status` | string | Market status \(open, closed, settled, etc.\) | +| ↳ `yes_bid` | number | Current best yes bid price in cents | +| ↳ `yes_ask` | number | Current best yes ask price in cents | +| ↳ `no_bid` | number | Current best no bid price in cents | +| ↳ `no_ask` | number | Current best no ask price in cents | +| ↳ `last_price` | number | Last trade price in cents | +| ↳ `previous_yes_bid` | number | Previous yes bid | +| ↳ `previous_yes_ask` | number | Previous yes ask | +| ↳ `previous_price` | number | Previous last price | +| ↳ `volume` | number | Total volume \(contracts traded\) | +| ↳ `volume_24h` | number | 24-hour trading volume | +| ↳ `liquidity` | number | Market liquidity measure | +| ↳ `open_interest` | number | Open interest \(outstanding contracts\) | +| ↳ `result` | string | Settlement result \(yes, no, null\) | +| ↳ `cap_strike` | number | Cap strike for ranged markets | +| ↳ `floor_strike` | number | Floor strike for ranged markets | +| ↳ `category` | string | Market category | | `cursor` | string | Pagination cursor for fetching more results | ### `kalshi_get_market` @@ -70,57 +97,57 @@ Retrieve details of a specific prediction market by ticker (V2 - full API respon | Parameter | Type | Description | | --------- | ---- | ----------- | | `market` | object | Market object with all API fields | -| ↳ `ticker` | string | Market ticker | -| ↳ `event_ticker` | string | Event ticker | -| ↳ `market_type` | string | Market type | -| ↳ `title` | string | Market title | -| ↳ `subtitle` | string | Market subtitle | -| ↳ `yes_sub_title` | string | Yes outcome subtitle | -| ↳ `no_sub_title` | string | No outcome subtitle | -| ↳ `open_time` | string | Market open time | -| ↳ `close_time` | string | Market close time | -| ↳ `expected_expiration_time` | string | Expected expiration time | -| ↳ `expiration_time` | string | Expiration time | -| ↳ `latest_expiration_time` | string | Latest expiration time | -| ↳ `settlement_timer_seconds` | number | Settlement timer in seconds | -| ↳ `status` | string | Market status | -| ↳ `response_price_units` | string | Response price units | -| ↳ `notional_value` | number | Notional value | -| ↳ `tick_size` | number | Tick size | -| ↳ `yes_bid` | number | Current yes bid price | -| ↳ `yes_ask` | number | Current yes ask price | -| ↳ `no_bid` | number | Current no bid price | -| ↳ `no_ask` | number | Current no ask price | -| ↳ `last_price` | number | Last trade price | -| ↳ `previous_yes_bid` | number | Previous yes bid | -| ↳ `previous_yes_ask` | number | Previous yes ask | -| ↳ `previous_price` | number | Previous price | -| ↳ `volume` | number | Total volume | -| ↳ `volume_24h` | number | 24-hour volume | -| ↳ `liquidity` | number | Market liquidity | -| ↳ `open_interest` | number | Open interest | -| ↳ `result` | string | Market result | -| ↳ `cap_strike` | number | Cap strike | -| ↳ `floor_strike` | number | Floor strike | -| ↳ `can_close_early` | boolean | Can close early | -| ↳ `expiration_value` | string | Expiration value | -| ↳ `category` | string | Market category | -| ↳ `risk_limit_cents` | number | Risk limit in cents | -| ↳ `strike_type` | string | Strike type | -| ↳ `rules_primary` | string | Primary rules | -| ↳ `rules_secondary` | string | Secondary rules | -| ↳ `settlement_source_url` | string | Settlement source URL | -| ↳ `custom_strike` | object | Custom strike object | -| ↳ `underlying` | string | Underlying asset | -| ↳ `settlement_value` | number | Settlement value | -| ↳ `cfd_contract_size` | number | CFD contract size | -| ↳ `yes_fee_fp` | number | Yes fee \(fixed-point\) | -| ↳ `no_fee_fp` | number | No fee \(fixed-point\) | -| ↳ `last_price_fp` | number | Last price \(fixed-point\) | -| ↳ `yes_bid_fp` | number | Yes bid \(fixed-point\) | -| ↳ `yes_ask_fp` | number | Yes ask \(fixed-point\) | -| ↳ `no_bid_fp` | number | No bid \(fixed-point\) | -| ↳ `no_ask_fp` | number | No ask \(fixed-point\) | +| ↳ `ticker` | string | Market ticker | +| ↳ `event_ticker` | string | Event ticker | +| ↳ `market_type` | string | Market type | +| ↳ `title` | string | Market title | +| ↳ `subtitle` | string | Market subtitle | +| ↳ `yes_sub_title` | string | Yes outcome subtitle | +| ↳ `no_sub_title` | string | No outcome subtitle | +| ↳ `open_time` | string | Market open time | +| ↳ `close_time` | string | Market close time | +| ↳ `expected_expiration_time` | string | Expected expiration time | +| ↳ `expiration_time` | string | Expiration time | +| ↳ `latest_expiration_time` | string | Latest expiration time | +| ↳ `settlement_timer_seconds` | number | Settlement timer in seconds | +| ↳ `status` | string | Market status | +| ↳ `response_price_units` | string | Response price units | +| ↳ `notional_value` | number | Notional value | +| ↳ `tick_size` | number | Tick size | +| ↳ `yes_bid` | number | Current yes bid price | +| ↳ `yes_ask` | number | Current yes ask price | +| ↳ `no_bid` | number | Current no bid price | +| ↳ `no_ask` | number | Current no ask price | +| ↳ `last_price` | number | Last trade price | +| ↳ `previous_yes_bid` | number | Previous yes bid | +| ↳ `previous_yes_ask` | number | Previous yes ask | +| ↳ `previous_price` | number | Previous price | +| ↳ `volume` | number | Total volume | +| ↳ `volume_24h` | number | 24-hour volume | +| ↳ `liquidity` | number | Market liquidity | +| ↳ `open_interest` | number | Open interest | +| ↳ `result` | string | Market result | +| ↳ `cap_strike` | number | Cap strike | +| ↳ `floor_strike` | number | Floor strike | +| ↳ `can_close_early` | boolean | Can close early | +| ↳ `expiration_value` | string | Expiration value | +| ↳ `category` | string | Market category | +| ↳ `risk_limit_cents` | number | Risk limit in cents | +| ↳ `strike_type` | string | Strike type | +| ↳ `rules_primary` | string | Primary rules | +| ↳ `rules_secondary` | string | Secondary rules | +| ↳ `settlement_source_url` | string | Settlement source URL | +| ↳ `custom_strike` | object | Custom strike object | +| ↳ `underlying` | string | Underlying asset | +| ↳ `settlement_value` | number | Settlement value | +| ↳ `cfd_contract_size` | number | CFD contract size | +| ↳ `yes_fee_fp` | number | Yes fee \(fixed-point\) | +| ↳ `no_fee_fp` | number | No fee \(fixed-point\) | +| ↳ `last_price_fp` | number | Last price \(fixed-point\) | +| ↳ `yes_bid_fp` | number | Yes bid \(fixed-point\) | +| ↳ `yes_ask_fp` | number | Yes ask \(fixed-point\) | +| ↳ `no_bid_fp` | number | No bid \(fixed-point\) | +| ↳ `no_ask_fp` | number | No ask \(fixed-point\) | ### `kalshi_get_events` @@ -141,7 +168,19 @@ Retrieve a list of events from Kalshi with optional filtering (V2 - exact API re | Parameter | Type | Description | | --------- | ---- | ----------- | | `events` | array | Array of event objects | +| ↳ `event_ticker` | string | Unique event ticker identifier | +| ↳ `series_ticker` | string | Parent series ticker | +| ↳ `title` | string | Event title | +| ↳ `sub_title` | string | Event subtitle | +| ↳ `mutually_exclusive` | boolean | Whether markets are mutually exclusive | +| ↳ `category` | string | Event category | +| ↳ `strike_date` | string | Strike/settlement date | +| ↳ `status` | string | Event status | | `milestones` | array | Array of milestone objects \(if requested\) | +| ↳ `event_ticker` | string | Event ticker | +| ↳ `milestone_type` | string | Milestone type | +| ↳ `milestone_date` | string | Milestone date | +| ↳ `milestone_title` | string | Milestone title | | `cursor` | string | Pagination cursor for fetching more results | ### `kalshi_get_event` @@ -160,18 +199,18 @@ Retrieve details of a specific event by ticker (V2 - exact API response) | Parameter | Type | Description | | --------- | ---- | ----------- | | `event` | object | Event object with full details matching Kalshi API response | -| ↳ `event_ticker` | string | Event ticker | -| ↳ `series_ticker` | string | Series ticker | -| ↳ `title` | string | Event title | -| ↳ `sub_title` | string | Event subtitle | -| ↳ `mutually_exclusive` | boolean | Mutually exclusive markets | -| ↳ `category` | string | Event category | -| ↳ `collateral_return_type` | string | Collateral return type | -| ↳ `strike_date` | string | Strike date | -| ↳ `strike_period` | string | Strike period | -| ↳ `available_on_brokers` | boolean | Available on brokers | -| ↳ `product_metadata` | object | Product metadata | -| ↳ `markets` | array | Nested markets \(if requested\) | +| ↳ `event_ticker` | string | Event ticker | +| ↳ `series_ticker` | string | Series ticker | +| ↳ `title` | string | Event title | +| ↳ `sub_title` | string | Event subtitle | +| ↳ `mutually_exclusive` | boolean | Mutually exclusive markets | +| ↳ `category` | string | Event category | +| ↳ `collateral_return_type` | string | Collateral return type | +| ↳ `strike_date` | string | Strike date | +| ↳ `strike_period` | string | Strike period | +| ↳ `available_on_brokers` | boolean | Available on brokers | +| ↳ `product_metadata` | object | Product metadata | +| ↳ `markets` | array | Nested markets \(if requested\) | ### `kalshi_get_balance` @@ -213,7 +252,21 @@ Retrieve your open positions from Kalshi (V2 - exact API response) | Parameter | Type | Description | | --------- | ---- | ----------- | | `market_positions` | array | Array of market position objects | +| ↳ `ticker` | string | Market ticker | +| ↳ `event_ticker` | string | Event ticker | +| ↳ `event_title` | string | Event title | +| ↳ `market_title` | string | Market title | +| ↳ `position` | number | Net position \(positive=yes, negative=no\) | +| ↳ `market_exposure` | number | Maximum potential loss in cents | +| ↳ `realized_pnl` | number | Realized profit/loss in cents | +| ↳ `total_traded` | number | Total contracts traded | +| ↳ `resting_orders_count` | number | Number of resting orders | +| ↳ `fees_paid` | number | Total fees paid in cents | | `event_positions` | array | Array of event position objects | +| ↳ `event_ticker` | string | Event ticker | +| ↳ `event_exposure` | number | Event-level exposure in cents | +| ↳ `realized_pnl` | number | Realized P&L in cents | +| ↳ `total_cost` | number | Total cost basis in cents | | `cursor` | string | Pagination cursor for fetching more results | ### `kalshi_get_orders` @@ -237,6 +290,24 @@ Retrieve your orders from Kalshi with optional filtering (V2 with full API respo | Parameter | Type | Description | | --------- | ---- | ----------- | | `orders` | array | Array of order objects with full API response fields | +| ↳ `order_id` | string | Unique order identifier | +| ↳ `user_id` | string | User ID | +| ↳ `client_order_id` | string | Client-provided order ID | +| ↳ `ticker` | string | Market ticker | +| ↳ `side` | string | Order side \(yes/no\) | +| ↳ `action` | string | Order action \(buy/sell\) | +| ↳ `type` | string | Order type \(limit/market\) | +| ↳ `status` | string | Order status \(resting, canceled, executed\) | +| ↳ `yes_price` | number | Yes price in cents | +| ↳ `no_price` | number | No price in cents | +| ↳ `fill_count` | number | Number of contracts filled | +| ↳ `remaining_count` | number | Remaining contracts to fill | +| ↳ `initial_count` | number | Initial order size | +| ↳ `taker_fees` | number | Taker fees paid in cents | +| ↳ `maker_fees` | number | Maker fees paid in cents | +| ↳ `created_time` | string | Order creation time \(ISO 8601\) | +| ↳ `expiration_time` | string | Order expiration time | +| ↳ `last_update_time` | string | Last order update time | | `cursor` | string | Pagination cursor for fetching more results | ### `kalshi_get_order` @@ -256,39 +327,39 @@ Retrieve details of a specific order by ID from Kalshi (V2 with full API respons | Parameter | Type | Description | | --------- | ---- | ----------- | | `order` | object | Order object with full API response fields | -| ↳ `order_id` | string | Order ID | -| ↳ `user_id` | string | User ID | -| ↳ `client_order_id` | string | Client order ID | -| ↳ `ticker` | string | Market ticker | -| ↳ `side` | string | Order side \(yes/no\) | -| ↳ `action` | string | Action \(buy/sell\) | -| ↳ `type` | string | Order type \(limit/market\) | -| ↳ `status` | string | Order status \(resting/canceled/executed\) | -| ↳ `yes_price` | number | Yes price in cents | -| ↳ `no_price` | number | No price in cents | -| ↳ `yes_price_dollars` | string | Yes price in dollars | -| ↳ `no_price_dollars` | string | No price in dollars | -| ↳ `fill_count` | number | Filled contract count | -| ↳ `fill_count_fp` | string | Filled count \(fixed-point\) | -| ↳ `remaining_count` | number | Remaining contracts | -| ↳ `remaining_count_fp` | string | Remaining count \(fixed-point\) | -| ↳ `initial_count` | number | Initial contract count | -| ↳ `initial_count_fp` | string | Initial count \(fixed-point\) | -| ↳ `taker_fees` | number | Taker fees in cents | -| ↳ `maker_fees` | number | Maker fees in cents | -| ↳ `taker_fees_dollars` | string | Taker fees in dollars | -| ↳ `maker_fees_dollars` | string | Maker fees in dollars | -| ↳ `taker_fill_cost` | number | Taker fill cost in cents | -| ↳ `maker_fill_cost` | number | Maker fill cost in cents | -| ↳ `taker_fill_cost_dollars` | string | Taker fill cost in dollars | -| ↳ `maker_fill_cost_dollars` | string | Maker fill cost in dollars | -| ↳ `queue_position` | number | Queue position \(deprecated\) | -| ↳ `expiration_time` | string | Order expiration time | -| ↳ `created_time` | string | Order creation time | -| ↳ `last_update_time` | string | Last update time | -| ↳ `self_trade_prevention_type` | string | Self-trade prevention type | -| ↳ `order_group_id` | string | Order group ID | -| ↳ `cancel_order_on_pause` | boolean | Cancel on market pause | +| ↳ `order_id` | string | Order ID | +| ↳ `user_id` | string | User ID | +| ↳ `client_order_id` | string | Client order ID | +| ↳ `ticker` | string | Market ticker | +| ↳ `side` | string | Order side \(yes/no\) | +| ↳ `action` | string | Action \(buy/sell\) | +| ↳ `type` | string | Order type \(limit/market\) | +| ↳ `status` | string | Order status \(resting/canceled/executed\) | +| ↳ `yes_price` | number | Yes price in cents | +| ↳ `no_price` | number | No price in cents | +| ↳ `yes_price_dollars` | string | Yes price in dollars | +| ↳ `no_price_dollars` | string | No price in dollars | +| ↳ `fill_count` | number | Filled contract count | +| ↳ `fill_count_fp` | string | Filled count \(fixed-point\) | +| ↳ `remaining_count` | number | Remaining contracts | +| ↳ `remaining_count_fp` | string | Remaining count \(fixed-point\) | +| ↳ `initial_count` | number | Initial contract count | +| ↳ `initial_count_fp` | string | Initial count \(fixed-point\) | +| ↳ `taker_fees` | number | Taker fees in cents | +| ↳ `maker_fees` | number | Maker fees in cents | +| ↳ `taker_fees_dollars` | string | Taker fees in dollars | +| ↳ `maker_fees_dollars` | string | Maker fees in dollars | +| ↳ `taker_fill_cost` | number | Taker fill cost in cents | +| ↳ `maker_fill_cost` | number | Maker fill cost in cents | +| ↳ `taker_fill_cost_dollars` | string | Taker fill cost in dollars | +| ↳ `maker_fill_cost_dollars` | string | Maker fill cost in dollars | +| ↳ `queue_position` | number | Queue position \(deprecated\) | +| ↳ `expiration_time` | string | Order expiration time | +| ↳ `created_time` | string | Order creation time | +| ↳ `last_update_time` | string | Last update time | +| ↳ `self_trade_prevention_type` | string | Self-trade prevention type | +| ↳ `order_group_id` | string | Order group ID | +| ↳ `cancel_order_on_pause` | boolean | Cancel on market pause | ### `kalshi_get_orderbook` @@ -305,13 +376,13 @@ Retrieve the orderbook (yes and no bids) for a specific market (V2 - includes de | Parameter | Type | Description | | --------- | ---- | ----------- | | `orderbook` | object | Orderbook with yes/no bids \(legacy integer counts\) | -| ↳ `yes` | array | Yes side bids as tuples \[price_cents, count\] | -| ↳ `no` | array | No side bids as tuples \[price_cents, count\] | -| ↳ `yes_dollars` | array | Yes side bids as tuples \[dollars_string, count\] | -| ↳ `no_dollars` | array | No side bids as tuples \[dollars_string, count\] | +| ↳ `yes` | array | Yes side bids as tuples \[price_cents, count\] | +| ↳ `no` | array | No side bids as tuples \[price_cents, count\] | +| ↳ `yes_dollars` | array | Yes side bids as tuples \[dollars_string, count\] | +| ↳ `no_dollars` | array | No side bids as tuples \[dollars_string, count\] | | `orderbook_fp` | object | Orderbook with fixed-point counts \(preferred\) | -| ↳ `yes_dollars` | array | Yes side bids as tuples \[dollars_string, fp_count_string\] | -| ↳ `no_dollars` | array | No side bids as tuples \[dollars_string, fp_count_string\] | +| ↳ `yes_dollars` | array | Yes side bids as tuples \[dollars_string, fp_count_string\] | +| ↳ `no_dollars` | array | No side bids as tuples \[dollars_string, fp_count_string\] | ### `kalshi_get_trades` @@ -329,6 +400,12 @@ Retrieve recent trades with additional filtering options (V2 - includes trade_id | Parameter | Type | Description | | --------- | ---- | ----------- | | `trades` | array | Array of trade objects with trade_id and count_fp | +| ↳ `ticker` | string | Market ticker | +| ↳ `yes_price` | number | Trade price for yes in cents | +| ↳ `no_price` | number | Trade price for no in cents | +| ↳ `count` | number | Number of contracts traded | +| ↳ `taker_side` | string | Taker side \(yes/no\) | +| ↳ `created_time` | string | Trade time \(ISO 8601\) | | `cursor` | string | Pagination cursor for fetching more results | ### `kalshi_get_candlesticks` @@ -374,6 +451,16 @@ Retrieve your portfolio | Parameter | Type | Description | | --------- | ---- | ----------- | | `fills` | array | Array of fill/trade objects with all API fields | +| ↳ `trade_id` | string | Unique trade identifier | +| ↳ `order_id` | string | Associated order ID | +| ↳ `ticker` | string | Market ticker | +| ↳ `side` | string | Trade side \(yes/no\) | +| ↳ `action` | string | Trade action \(buy/sell\) | +| ↳ `count` | number | Number of contracts | +| ↳ `yes_price` | number | Yes price in cents | +| ↳ `no_price` | number | No price in cents | +| ↳ `is_taker` | boolean | Whether this was a taker trade | +| ↳ `created_time` | string | Trade execution time \(ISO 8601\) | | `cursor` | string | Pagination cursor for fetching more results | ### `kalshi_get_series_by_ticker` @@ -391,20 +478,20 @@ Retrieve details of a specific market series by ticker (V2 - exact API response) | Parameter | Type | Description | | --------- | ---- | ----------- | | `series` | object | Series object with full details matching Kalshi API response | -| ↳ `ticker` | string | Series ticker | -| ↳ `title` | string | Series title | -| ↳ `frequency` | string | Event frequency | -| ↳ `category` | string | Series category | -| ↳ `tags` | array | Series tags | -| ↳ `settlement_sources` | array | Settlement sources | -| ↳ `contract_url` | string | Contract URL | -| ↳ `contract_terms_url` | string | Contract terms URL | -| ↳ `fee_type` | string | Fee type | -| ↳ `fee_multiplier` | number | Fee multiplier | -| ↳ `additional_prohibitions` | array | Additional prohibitions | -| ↳ `product_metadata` | object | Product metadata | -| ↳ `volume` | number | Series volume | -| ↳ `volume_fp` | number | Volume \(fixed-point\) | +| ↳ `ticker` | string | Series ticker | +| ↳ `title` | string | Series title | +| ↳ `frequency` | string | Event frequency | +| ↳ `category` | string | Series category | +| ↳ `tags` | array | Series tags | +| ↳ `settlement_sources` | array | Settlement sources | +| ↳ `contract_url` | string | Contract URL | +| ↳ `contract_terms_url` | string | Contract terms URL | +| ↳ `fee_type` | string | Fee type | +| ↳ `fee_multiplier` | number | Fee multiplier | +| ↳ `additional_prohibitions` | array | Additional prohibitions | +| ↳ `product_metadata` | object | Product metadata | +| ↳ `volume` | number | Series volume | +| ↳ `volume_fp` | number | Volume \(fixed-point\) | ### `kalshi_get_exchange_status` @@ -456,39 +543,39 @@ Create a new order on a Kalshi prediction market (V2 with full API response) | Parameter | Type | Description | | --------- | ---- | ----------- | | `order` | object | The created order object with full API response fields | -| ↳ `order_id` | string | Order ID | -| ↳ `user_id` | string | User ID | -| ↳ `client_order_id` | string | Client order ID | -| ↳ `ticker` | string | Market ticker | -| ↳ `side` | string | Order side \(yes/no\) | -| ↳ `action` | string | Action \(buy/sell\) | -| ↳ `type` | string | Order type \(limit/market\) | -| ↳ `status` | string | Order status \(resting/canceled/executed\) | -| ↳ `yes_price` | number | Yes price in cents | -| ↳ `no_price` | number | No price in cents | -| ↳ `yes_price_dollars` | string | Yes price in dollars | -| ↳ `no_price_dollars` | string | No price in dollars | -| ↳ `fill_count` | number | Filled contract count | -| ↳ `fill_count_fp` | string | Filled count \(fixed-point\) | -| ↳ `remaining_count` | number | Remaining contracts | -| ↳ `remaining_count_fp` | string | Remaining count \(fixed-point\) | -| ↳ `initial_count` | number | Initial contract count | -| ↳ `initial_count_fp` | string | Initial count \(fixed-point\) | -| ↳ `taker_fees` | number | Taker fees in cents | -| ↳ `maker_fees` | number | Maker fees in cents | -| ↳ `taker_fees_dollars` | string | Taker fees in dollars | -| ↳ `maker_fees_dollars` | string | Maker fees in dollars | -| ↳ `taker_fill_cost` | number | Taker fill cost in cents | -| ↳ `maker_fill_cost` | number | Maker fill cost in cents | -| ↳ `taker_fill_cost_dollars` | string | Taker fill cost in dollars | -| ↳ `maker_fill_cost_dollars` | string | Maker fill cost in dollars | -| ↳ `queue_position` | number | Queue position \(deprecated\) | -| ↳ `expiration_time` | string | Order expiration time | -| ↳ `created_time` | string | Order creation time | -| ↳ `last_update_time` | string | Last update time | -| ↳ `self_trade_prevention_type` | string | Self-trade prevention type | -| ↳ `order_group_id` | string | Order group ID | -| ↳ `cancel_order_on_pause` | boolean | Cancel on market pause | +| ↳ `order_id` | string | Order ID | +| ↳ `user_id` | string | User ID | +| ↳ `client_order_id` | string | Client order ID | +| ↳ `ticker` | string | Market ticker | +| ↳ `side` | string | Order side \(yes/no\) | +| ↳ `action` | string | Action \(buy/sell\) | +| ↳ `type` | string | Order type \(limit/market\) | +| ↳ `status` | string | Order status \(resting/canceled/executed\) | +| ↳ `yes_price` | number | Yes price in cents | +| ↳ `no_price` | number | No price in cents | +| ↳ `yes_price_dollars` | string | Yes price in dollars | +| ↳ `no_price_dollars` | string | No price in dollars | +| ↳ `fill_count` | number | Filled contract count | +| ↳ `fill_count_fp` | string | Filled count \(fixed-point\) | +| ↳ `remaining_count` | number | Remaining contracts | +| ↳ `remaining_count_fp` | string | Remaining count \(fixed-point\) | +| ↳ `initial_count` | number | Initial contract count | +| ↳ `initial_count_fp` | string | Initial count \(fixed-point\) | +| ↳ `taker_fees` | number | Taker fees in cents | +| ↳ `maker_fees` | number | Maker fees in cents | +| ↳ `taker_fees_dollars` | string | Taker fees in dollars | +| ↳ `maker_fees_dollars` | string | Maker fees in dollars | +| ↳ `taker_fill_cost` | number | Taker fill cost in cents | +| ↳ `maker_fill_cost` | number | Maker fill cost in cents | +| ↳ `taker_fill_cost_dollars` | string | Taker fill cost in dollars | +| ↳ `maker_fill_cost_dollars` | string | Maker fill cost in dollars | +| ↳ `queue_position` | number | Queue position \(deprecated\) | +| ↳ `expiration_time` | string | Order expiration time | +| ↳ `created_time` | string | Order creation time | +| ↳ `last_update_time` | string | Last update time | +| ↳ `self_trade_prevention_type` | string | Self-trade prevention type | +| ↳ `order_group_id` | string | Order group ID | +| ↳ `cancel_order_on_pause` | boolean | Cancel on market pause | ### `kalshi_cancel_order` @@ -507,39 +594,39 @@ Cancel an existing order on Kalshi (V2 with full API response) | Parameter | Type | Description | | --------- | ---- | ----------- | | `order` | object | The canceled order object with full API response fields | -| ↳ `order_id` | string | Order ID | -| ↳ `user_id` | string | User ID | -| ↳ `client_order_id` | string | Client order ID | -| ↳ `ticker` | string | Market ticker | -| ↳ `side` | string | Order side \(yes/no\) | -| ↳ `action` | string | Action \(buy/sell\) | -| ↳ `type` | string | Order type \(limit/market\) | -| ↳ `status` | string | Order status \(resting/canceled/executed\) | -| ↳ `yes_price` | number | Yes price in cents | -| ↳ `no_price` | number | No price in cents | -| ↳ `yes_price_dollars` | string | Yes price in dollars | -| ↳ `no_price_dollars` | string | No price in dollars | -| ↳ `fill_count` | number | Filled contract count | -| ↳ `fill_count_fp` | string | Filled count \(fixed-point\) | -| ↳ `remaining_count` | number | Remaining contracts | -| ↳ `remaining_count_fp` | string | Remaining count \(fixed-point\) | -| ↳ `initial_count` | number | Initial contract count | -| ↳ `initial_count_fp` | string | Initial count \(fixed-point\) | -| ↳ `taker_fees` | number | Taker fees in cents | -| ↳ `maker_fees` | number | Maker fees in cents | -| ↳ `taker_fees_dollars` | string | Taker fees in dollars | -| ↳ `maker_fees_dollars` | string | Maker fees in dollars | -| ↳ `taker_fill_cost` | number | Taker fill cost in cents | -| ↳ `maker_fill_cost` | number | Maker fill cost in cents | -| ↳ `taker_fill_cost_dollars` | string | Taker fill cost in dollars | -| ↳ `maker_fill_cost_dollars` | string | Maker fill cost in dollars | -| ↳ `queue_position` | number | Queue position \(deprecated\) | -| ↳ `expiration_time` | string | Order expiration time | -| ↳ `created_time` | string | Order creation time | -| ↳ `last_update_time` | string | Last update time | -| ↳ `self_trade_prevention_type` | string | Self-trade prevention type | -| ↳ `order_group_id` | string | Order group ID | -| ↳ `cancel_order_on_pause` | boolean | Cancel on market pause | +| ↳ `order_id` | string | Order ID | +| ↳ `user_id` | string | User ID | +| ↳ `client_order_id` | string | Client order ID | +| ↳ `ticker` | string | Market ticker | +| ↳ `side` | string | Order side \(yes/no\) | +| ↳ `action` | string | Action \(buy/sell\) | +| ↳ `type` | string | Order type \(limit/market\) | +| ↳ `status` | string | Order status \(resting/canceled/executed\) | +| ↳ `yes_price` | number | Yes price in cents | +| ↳ `no_price` | number | No price in cents | +| ↳ `yes_price_dollars` | string | Yes price in dollars | +| ↳ `no_price_dollars` | string | No price in dollars | +| ↳ `fill_count` | number | Filled contract count | +| ↳ `fill_count_fp` | string | Filled count \(fixed-point\) | +| ↳ `remaining_count` | number | Remaining contracts | +| ↳ `remaining_count_fp` | string | Remaining count \(fixed-point\) | +| ↳ `initial_count` | number | Initial contract count | +| ↳ `initial_count_fp` | string | Initial count \(fixed-point\) | +| ↳ `taker_fees` | number | Taker fees in cents | +| ↳ `maker_fees` | number | Maker fees in cents | +| ↳ `taker_fees_dollars` | string | Taker fees in dollars | +| ↳ `maker_fees_dollars` | string | Maker fees in dollars | +| ↳ `taker_fill_cost` | number | Taker fill cost in cents | +| ↳ `maker_fill_cost` | number | Maker fill cost in cents | +| ↳ `taker_fill_cost_dollars` | string | Taker fill cost in dollars | +| ↳ `maker_fill_cost_dollars` | string | Maker fill cost in dollars | +| ↳ `queue_position` | number | Queue position \(deprecated\) | +| ↳ `expiration_time` | string | Order expiration time | +| ↳ `created_time` | string | Order creation time | +| ↳ `last_update_time` | string | Last update time | +| ↳ `self_trade_prevention_type` | string | Self-trade prevention type | +| ↳ `order_group_id` | string | Order group ID | +| ↳ `cancel_order_on_pause` | boolean | Cancel on market pause | | `reduced_by` | number | Number of contracts canceled | | `reduced_by_fp` | string | Number of contracts canceled in fixed-point format | @@ -570,62 +657,62 @@ Modify the price or quantity of an existing order on Kalshi (V2 with full API re | Parameter | Type | Description | | --------- | ---- | ----------- | | `old_order` | object | The original order object before amendment | -| ↳ `order_id` | string | Order ID | -| ↳ `user_id` | string | User ID | -| ↳ `ticker` | string | Market ticker | -| ↳ `event_ticker` | string | Event ticker | -| ↳ `status` | string | Order status | -| ↳ `side` | string | Order side \(yes/no\) | -| ↳ `type` | string | Order type \(limit/market\) | -| ↳ `yes_price` | number | Yes price in cents | -| ↳ `no_price` | number | No price in cents | -| ↳ `action` | string | Action \(buy/sell\) | -| ↳ `count` | number | Number of contracts | -| ↳ `remaining_count` | number | Remaining contracts | -| ↳ `created_time` | string | Order creation time | -| ↳ `expiration_time` | string | Order expiration time | -| ↳ `order_group_id` | string | Order group ID | -| ↳ `client_order_id` | string | Client order ID | -| ↳ `place_count` | number | Place count | -| ↳ `decrease_count` | number | Decrease count | -| ↳ `queue_position` | number | Queue position | -| ↳ `maker_fill_count` | number | Maker fill count | -| ↳ `taker_fill_count` | number | Taker fill count | -| ↳ `maker_fees` | number | Maker fees | -| ↳ `taker_fees` | number | Taker fees | -| ↳ `last_update_time` | string | Last update time | -| ↳ `take_profit_order_id` | string | Take profit order ID | -| ↳ `stop_loss_order_id` | string | Stop loss order ID | -| ↳ `amend_count` | number | Amend count | -| ↳ `amend_taker_fill_count` | number | Amend taker fill count | +| ↳ `order_id` | string | Order ID | +| ↳ `user_id` | string | User ID | +| ↳ `ticker` | string | Market ticker | +| ↳ `event_ticker` | string | Event ticker | +| ↳ `status` | string | Order status | +| ↳ `side` | string | Order side \(yes/no\) | +| ↳ `type` | string | Order type \(limit/market\) | +| ↳ `yes_price` | number | Yes price in cents | +| ↳ `no_price` | number | No price in cents | +| ↳ `action` | string | Action \(buy/sell\) | +| ↳ `count` | number | Number of contracts | +| ↳ `remaining_count` | number | Remaining contracts | +| ↳ `created_time` | string | Order creation time | +| ↳ `expiration_time` | string | Order expiration time | +| ↳ `order_group_id` | string | Order group ID | +| ↳ `client_order_id` | string | Client order ID | +| ↳ `place_count` | number | Place count | +| ↳ `decrease_count` | number | Decrease count | +| ↳ `queue_position` | number | Queue position | +| ↳ `maker_fill_count` | number | Maker fill count | +| ↳ `taker_fill_count` | number | Taker fill count | +| ↳ `maker_fees` | number | Maker fees | +| ↳ `taker_fees` | number | Taker fees | +| ↳ `last_update_time` | string | Last update time | +| ↳ `take_profit_order_id` | string | Take profit order ID | +| ↳ `stop_loss_order_id` | string | Stop loss order ID | +| ↳ `amend_count` | number | Amend count | +| ↳ `amend_taker_fill_count` | number | Amend taker fill count | | `order` | object | The amended order object with full API response fields | -| ↳ `order_id` | string | Order ID | -| ↳ `user_id` | string | User ID | -| ↳ `ticker` | string | Market ticker | -| ↳ `event_ticker` | string | Event ticker | -| ↳ `status` | string | Order status | -| ↳ `side` | string | Order side \(yes/no\) | -| ↳ `type` | string | Order type \(limit/market\) | -| ↳ `yes_price` | number | Yes price in cents | -| ↳ `no_price` | number | No price in cents | -| ↳ `action` | string | Action \(buy/sell\) | -| ↳ `count` | number | Number of contracts | -| ↳ `remaining_count` | number | Remaining contracts | -| ↳ `created_time` | string | Order creation time | -| ↳ `expiration_time` | string | Order expiration time | -| ↳ `order_group_id` | string | Order group ID | -| ↳ `client_order_id` | string | Client order ID | -| ↳ `place_count` | number | Place count | -| ↳ `decrease_count` | number | Decrease count | -| ↳ `queue_position` | number | Queue position | -| ↳ `maker_fill_count` | number | Maker fill count | -| ↳ `taker_fill_count` | number | Taker fill count | -| ↳ `maker_fees` | number | Maker fees | -| ↳ `taker_fees` | number | Taker fees | -| ↳ `last_update_time` | string | Last update time | -| ↳ `take_profit_order_id` | string | Take profit order ID | -| ↳ `stop_loss_order_id` | string | Stop loss order ID | -| ↳ `amend_count` | number | Amend count | -| ↳ `amend_taker_fill_count` | number | Amend taker fill count | +| ↳ `order_id` | string | Order ID | +| ↳ `user_id` | string | User ID | +| ↳ `ticker` | string | Market ticker | +| ↳ `event_ticker` | string | Event ticker | +| ↳ `status` | string | Order status | +| ↳ `side` | string | Order side \(yes/no\) | +| ↳ `type` | string | Order type \(limit/market\) | +| ↳ `yes_price` | number | Yes price in cents | +| ↳ `no_price` | number | No price in cents | +| ↳ `action` | string | Action \(buy/sell\) | +| ↳ `count` | number | Number of contracts | +| ↳ `remaining_count` | number | Remaining contracts | +| ↳ `created_time` | string | Order creation time | +| ↳ `expiration_time` | string | Order expiration time | +| ↳ `order_group_id` | string | Order group ID | +| ↳ `client_order_id` | string | Client order ID | +| ↳ `place_count` | number | Place count | +| ↳ `decrease_count` | number | Decrease count | +| ↳ `queue_position` | number | Queue position | +| ↳ `maker_fill_count` | number | Maker fill count | +| ↳ `taker_fill_count` | number | Taker fill count | +| ↳ `maker_fees` | number | Maker fees | +| ↳ `taker_fees` | number | Taker fees | +| ↳ `last_update_time` | string | Last update time | +| ↳ `take_profit_order_id` | string | Take profit order ID | +| ↳ `stop_loss_order_id` | string | Stop loss order ID | +| ↳ `amend_count` | number | Amend count | +| ↳ `amend_taker_fill_count` | number | Amend taker fill count | diff --git a/apps/docs/content/docs/en/tools/knowledge.mdx b/apps/docs/content/docs/en/tools/knowledge.mdx index 44f5db36a..bc3b93e5c 100644 --- a/apps/docs/content/docs/en/tools/knowledge.mdx +++ b/apps/docs/content/docs/en/tools/knowledge.mdx @@ -85,14 +85,14 @@ Upload a new chunk to a document in a knowledge base | Parameter | Type | Description | | --------- | ---- | ----------- | | `data` | object | Information about the uploaded chunk | -| ↳ `chunkId` | string | Chunk ID | -| ↳ `chunkIndex` | number | Index of the chunk within the document | -| ↳ `content` | string | Content of the chunk | -| ↳ `contentLength` | number | Length of the content in characters | -| ↳ `tokenCount` | number | Number of tokens in the chunk | -| ↳ `enabled` | boolean | Whether the chunk is enabled | -| ↳ `createdAt` | string | Creation timestamp | -| ↳ `updatedAt` | string | Last update timestamp | +| ↳ `chunkId` | string | Chunk ID | +| ↳ `chunkIndex` | number | Index of the chunk within the document | +| ↳ `content` | string | Content of the chunk | +| ↳ `contentLength` | number | Length of the content in characters | +| ↳ `tokenCount` | number | Number of tokens in the chunk | +| ↳ `enabled` | boolean | Whether the chunk is enabled | +| ↳ `createdAt` | string | Creation timestamp | +| ↳ `updatedAt` | string | Last update timestamp | | `message` | string | Success or error message describing the operation result | | `documentId` | string | ID of the document the chunk was added to | | `documentName` | string | Name of the document the chunk was added to | @@ -117,12 +117,12 @@ Create a new document in a knowledge base | Parameter | Type | Description | | --------- | ---- | ----------- | | `data` | object | Information about the created document | -| ↳ `documentId` | string | Document ID | -| ↳ `documentName` | string | Document name | -| ↳ `type` | string | Document type | -| ↳ `enabled` | boolean | Whether the document is enabled | -| ↳ `createdAt` | string | Creation timestamp | -| ↳ `updatedAt` | string | Last update timestamp | +| ↳ `documentId` | string | Document ID | +| ↳ `documentName` | string | Document name | +| ↳ `type` | string | Document type | +| ↳ `enabled` | boolean | Whether the document is enabled | +| ↳ `createdAt` | string | Creation timestamp | +| ↳ `updatedAt` | string | Last update timestamp | | `message` | string | Success or error message describing the operation result | | `documentId` | string | ID of the created document | diff --git a/apps/docs/content/docs/en/tools/linear.mdx b/apps/docs/content/docs/en/tools/linear.mdx index 70299a131..d6f61417b 100644 --- a/apps/docs/content/docs/en/tools/linear.mdx +++ b/apps/docs/content/docs/en/tools/linear.mdx @@ -59,18 +59,27 @@ Fetch and filter issues from Linear | Parameter | Type | Description | | --------- | ---- | ----------- | +| `hasNextPage` | boolean | Whether there are more results | +| `endCursor` | string | Cursor for the next page | | `issues` | array | Array of filtered issues from Linear | | ↳ `id` | string | Issue ID | | ↳ `title` | string | Issue title | | ↳ `description` | string | Issue description | -| ↳ `priority` | number | Issue priority | -| ↳ `estimate` | number | Issue estimate | +| ↳ `priority` | number | Priority \(0=No priority, 1=Urgent, 2=High, 3=Normal, 4=Low\) | +| ↳ `estimate` | number | Estimate in points | | ↳ `url` | string | Issue URL | | ↳ `dueDate` | string | Due date \(YYYY-MM-DD\) | -| ↳ `createdAt` | string | Creation timestamp | -| ↳ `updatedAt` | string | Last update timestamp | -| ↳ `state` | object | Issue state | -| ↳ `assignee` | object | Assigned user | +| ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) | +| ↳ `updatedAt` | string | Last update timestamp \(ISO 8601\) | +| ↳ `archivedAt` | string | Archive timestamp \(ISO 8601\) | +| ↳ `state` | object | Workflow state/status | +| ↳ `id` | string | State ID | +| ↳ `name` | string | State name \(e.g., "Todo", "In Progress"\) | +| ↳ `type` | string | State type \(unstarted, started, completed, canceled\) | +| ↳ `assignee` | object | User object | +| ↳ `id` | string | User ID | +| ↳ `name` | string | User name | +| ↳ `email` | string | User email | | ↳ `teamId` | string | Team ID | | ↳ `teamName` | string | Team name | | ↳ `projectId` | string | Project ID | @@ -79,8 +88,9 @@ Fetch and filter issues from Linear | ↳ `cycleNumber` | number | Cycle number | | ↳ `cycleName` | string | Cycle name | | ↳ `labels` | array | Issue labels | -| `hasNextPage` | boolean | Whether there are more results available | -| `endCursor` | string | Cursor for fetching the next page \(use as | +| ↳ `id` | string | Label ID | +| ↳ `name` | string | Label name | +| ↳ `color` | string | Label color \(hex\) | ### `linear_get_issue` @@ -97,17 +107,32 @@ Get a single issue by ID from Linear with full details | Parameter | Type | Description | | --------- | ---- | ----------- | | `issue` | object | The issue with full details | -| ↳ `id` | string | Issue ID | -| ↳ `title` | string | Issue title | -| ↳ `description` | string | Issue description | -| ↳ `priority` | number | Issue priority \(0-4\) | -| ↳ `estimate` | number | Issue estimate in points | -| ↳ `url` | string | Issue URL | -| ↳ `state` | object | Issue state/status | -| ↳ `assignee` | object | Assigned user | -| ↳ `labels` | array | Issue labels | -| ↳ `createdAt` | string | Creation timestamp | -| ↳ `updatedAt` | string | Last update timestamp | +| ↳ `id` | string | Issue ID | +| ↳ `title` | string | Issue title | +| ↳ `description` | string | Issue description | +| ↳ `priority` | number | Priority \(0=No priority, 1=Urgent, 2=High, 3=Normal, 4=Low\) | +| ↳ `estimate` | number | Estimate in points | +| ↳ `url` | string | Issue URL | +| ↳ `dueDate` | string | Due date \(YYYY-MM-DD\) | +| ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) | +| ↳ `updatedAt` | string | Last update timestamp \(ISO 8601\) | +| ↳ `completedAt` | string | Completion timestamp \(ISO 8601\) | +| ↳ `canceledAt` | string | Cancellation timestamp \(ISO 8601\) | +| ↳ `archivedAt` | string | Archive timestamp \(ISO 8601\) | +| ↳ `state` | object | Workflow state/status | +| ↳ `id` | string | State ID | +| ↳ `name` | string | State name \(e.g., "Todo", "In Progress"\) | +| ↳ `type` | string | State type \(unstarted, started, completed, canceled\) | +| ↳ `assignee` | object | User object | +| ↳ `id` | string | User ID | +| ↳ `name` | string | User name | +| ↳ `email` | string | User email | +| ↳ `teamId` | string | Team ID | +| ↳ `projectId` | string | Project ID | +| ↳ `labels` | array | Issue labels | +| ↳ `id` | string | Label ID | +| ↳ `name` | string | Label name | +| ↳ `color` | string | Label color \(hex\) | ### `linear_create_issue` @@ -137,25 +162,39 @@ Create a new issue in Linear | Parameter | Type | Description | | --------- | ---- | ----------- | | `issue` | object | The created issue with all its properties | -| ↳ `id` | string | Issue ID | -| ↳ `title` | string | Issue title | -| ↳ `description` | string | Issue description | -| ↳ `priority` | number | Issue priority | -| ↳ `estimate` | number | Issue estimate | -| ↳ `url` | string | Issue URL | -| ↳ `dueDate` | string | Due date \(YYYY-MM-DD\) | -| ↳ `state` | object | Issue state | -| ↳ `assignee` | object | Assigned user | -| ↳ `teamId` | string | Team ID | -| ↳ `projectId` | string | Project ID | -| ↳ `cycleId` | string | Cycle ID | -| ↳ `cycleNumber` | number | Cycle number | -| ↳ `cycleName` | string | Cycle name | -| ↳ `parentId` | string | Parent issue ID | -| ↳ `parentTitle` | string | Parent issue title | -| ↳ `projectMilestoneId` | string | Project milestone ID | -| ↳ `projectMilestoneName` | string | Project milestone name | -| ↳ `labels` | array | Issue labels | +| ↳ `id` | string | Issue ID | +| ↳ `title` | string | Issue title | +| ↳ `description` | string | Issue description | +| ↳ `priority` | number | Priority \(0=No priority, 1=Urgent, 2=High, 3=Normal, 4=Low\) | +| ↳ `estimate` | number | Estimate in points | +| ↳ `url` | string | Issue URL | +| ↳ `dueDate` | string | Due date \(YYYY-MM-DD\) | +| ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) | +| ↳ `updatedAt` | string | Last update timestamp \(ISO 8601\) | +| ↳ `completedAt` | string | Completion timestamp \(ISO 8601\) | +| ↳ `canceledAt` | string | Cancellation timestamp \(ISO 8601\) | +| ↳ `archivedAt` | string | Archive timestamp \(ISO 8601\) | +| ↳ `state` | object | Workflow state/status | +| ↳ `id` | string | State ID | +| ↳ `name` | string | State name \(e.g., "Todo", "In Progress"\) | +| ↳ `type` | string | State type \(unstarted, started, completed, canceled\) | +| ↳ `assignee` | object | User object | +| ↳ `id` | string | User ID | +| ↳ `name` | string | User name | +| ↳ `email` | string | User email | +| ↳ `teamId` | string | Team ID | +| ↳ `projectId` | string | Project ID | +| ↳ `labels` | array | Issue labels | +| ↳ `id` | string | Label ID | +| ↳ `name` | string | Label name | +| ↳ `color` | string | Label color \(hex\) | +| ↳ `cycleId` | string | Cycle ID | +| ↳ `cycleNumber` | number | Cycle number | +| ↳ `cycleName` | string | Cycle name | +| ↳ `parentId` | string | Parent issue ID | +| ↳ `parentTitle` | string | Parent issue title | +| ↳ `projectMilestoneId` | string | Project milestone ID | +| ↳ `projectMilestoneName` | string | Project milestone name | ### `linear_update_issue` @@ -185,22 +224,39 @@ Update an existing issue in Linear | Parameter | Type | Description | | --------- | ---- | ----------- | | `issue` | object | The updated issue | -| ↳ `id` | string | Issue ID | -| ↳ `title` | string | Issue title | -| ↳ `description` | string | Issue description | -| ↳ `priority` | number | Issue priority | -| ↳ `estimate` | number | Issue estimate | -| ↳ `state` | object | Issue state | -| ↳ `assignee` | object | Assigned user | -| ↳ `labels` | array | Issue labels | -| ↳ `updatedAt` | string | Last update timestamp | -| ↳ `dueDate` | string | Due date \(YYYY-MM-DD\) | -| ↳ `projectId` | string | Project ID | -| ↳ `cycleId` | string | Cycle ID | -| ↳ `cycleNumber` | number | Cycle number | -| ↳ `cycleName` | string | Cycle name | -| ↳ `parentId` | string | Parent issue ID | -| ↳ `parentTitle` | string | Parent issue title | +| ↳ `id` | string | Issue ID | +| ↳ `title` | string | Issue title | +| ↳ `description` | string | Issue description | +| ↳ `priority` | number | Priority \(0=No priority, 1=Urgent, 2=High, 3=Normal, 4=Low\) | +| ↳ `estimate` | number | Estimate in points | +| ↳ `url` | string | Issue URL | +| ↳ `dueDate` | string | Due date \(YYYY-MM-DD\) | +| ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) | +| ↳ `updatedAt` | string | Last update timestamp \(ISO 8601\) | +| ↳ `completedAt` | string | Completion timestamp \(ISO 8601\) | +| ↳ `canceledAt` | string | Cancellation timestamp \(ISO 8601\) | +| ↳ `archivedAt` | string | Archive timestamp \(ISO 8601\) | +| ↳ `state` | object | Workflow state/status | +| ↳ `id` | string | State ID | +| ↳ `name` | string | State name \(e.g., "Todo", "In Progress"\) | +| ↳ `type` | string | State type \(unstarted, started, completed, canceled\) | +| ↳ `assignee` | object | User object | +| ↳ `id` | string | User ID | +| ↳ `name` | string | User name | +| ↳ `email` | string | User email | +| ↳ `teamId` | string | Team ID | +| ↳ `projectId` | string | Project ID | +| ↳ `labels` | array | Issue labels | +| ↳ `id` | string | Label ID | +| ↳ `name` | string | Label name | +| ↳ `color` | string | Label color \(hex\) | +| ↳ `cycleId` | string | Cycle ID | +| ↳ `cycleNumber` | number | Cycle number | +| ↳ `cycleName` | string | Cycle name | +| ↳ `parentId` | string | Parent issue ID | +| ↳ `parentTitle` | string | Parent issue title | +| ↳ `projectMilestoneId` | string | Project milestone ID | +| ↳ `projectMilestoneName` | string | Project milestone name | ### `linear_archive_issue` @@ -269,17 +325,36 @@ Search for issues in Linear using full-text search | Parameter | Type | Description | | --------- | ---- | ----------- | +| `pageInfo` | object | Pagination information | +| ↳ `hasNextPage` | boolean | Whether there are more results | +| ↳ `endCursor` | string | Cursor for the next page | | `issues` | array | Array of matching issues | | ↳ `id` | string | Issue ID | | ↳ `title` | string | Issue title | | ↳ `description` | string | Issue description | -| ↳ `priority` | number | Issue priority | -| ↳ `state` | object | Issue state | -| ↳ `assignee` | object | Assigned user | +| ↳ `priority` | number | Priority \(0=No priority, 1=Urgent, 2=High, 3=Normal, 4=Low\) | +| ↳ `estimate` | number | Estimate in points | +| ↳ `url` | string | Issue URL | +| ↳ `dueDate` | string | Due date \(YYYY-MM-DD\) | +| ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) | +| ↳ `updatedAt` | string | Last update timestamp \(ISO 8601\) | +| ↳ `completedAt` | string | Completion timestamp \(ISO 8601\) | +| ↳ `canceledAt` | string | Cancellation timestamp \(ISO 8601\) | +| ↳ `archivedAt` | string | Archive timestamp \(ISO 8601\) | +| ↳ `state` | object | Workflow state/status | +| ↳ `id` | string | State ID | +| ↳ `name` | string | State name \(e.g., "Todo", "In Progress"\) | +| ↳ `type` | string | State type \(unstarted, started, completed, canceled\) | +| ↳ `assignee` | object | User object | +| ↳ `id` | string | User ID | +| ↳ `name` | string | User name | +| ↳ `email` | string | User email | +| ↳ `teamId` | string | Team ID | +| ↳ `projectId` | string | Project ID | | ↳ `labels` | array | Issue labels | -| `pageInfo` | object | Pagination information | -| ↳ `hasNextPage` | boolean | Whether there are more results | -| ↳ `endCursor` | string | Cursor for next page | +| ↳ `id` | string | Label ID | +| ↳ `name` | string | Label name | +| ↳ `color` | string | Label color \(hex\) | ### `linear_add_label_to_issue` @@ -333,11 +408,17 @@ Add a comment to an issue in Linear | Parameter | Type | Description | | --------- | ---- | ----------- | | `comment` | object | The created comment | -| ↳ `id` | string | Comment ID | -| ↳ `body` | string | Comment text | -| ↳ `createdAt` | string | Creation timestamp | -| ↳ `user` | object | User who created the comment | -| ↳ `issue` | object | Associated issue | +| ↳ `id` | string | Comment ID | +| ↳ `body` | string | Comment text \(Markdown\) | +| ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) | +| ↳ `updatedAt` | string | Last update timestamp \(ISO 8601\) | +| ↳ `user` | object | User object | +| ↳ `id` | string | User ID | +| ↳ `name` | string | User name | +| ↳ `email` | string | User email | +| ↳ `issue` | object | Issue object | +| ↳ `id` | string | Issue ID | +| ↳ `title` | string | Issue title | ### `linear_update_comment` @@ -355,10 +436,17 @@ Edit a comment in Linear | Parameter | Type | Description | | --------- | ---- | ----------- | | `comment` | object | The updated comment | -| ↳ `id` | string | Comment ID | -| ↳ `body` | string | Comment text | -| ↳ `updatedAt` | string | Last update timestamp | -| ↳ `user` | object | User who created the comment | +| ↳ `id` | string | Comment ID | +| ↳ `body` | string | Comment text \(Markdown\) | +| ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) | +| ↳ `updatedAt` | string | Last update timestamp \(ISO 8601\) | +| ↳ `user` | object | User object | +| ↳ `id` | string | User ID | +| ↳ `name` | string | User name | +| ↳ `email` | string | User email | +| ↳ `issue` | object | Issue object | +| ↳ `id` | string | Issue ID | +| ↳ `title` | string | Issue title | ### `linear_delete_comment` @@ -392,15 +480,21 @@ List all comments on an issue in Linear | Parameter | Type | Description | | --------- | ---- | ----------- | +| `pageInfo` | object | Pagination information | +| ↳ `hasNextPage` | boolean | Whether there are more results | +| ↳ `endCursor` | string | Cursor for the next page | | `comments` | array | Array of comments on the issue | | ↳ `id` | string | Comment ID | -| ↳ `body` | string | Comment text | -| ↳ `createdAt` | string | Creation timestamp | -| ↳ `updatedAt` | string | Last update timestamp | -| ↳ `user` | object | User who created the comment | -| `pageInfo` | object | Pagination information | -| ↳ `hasNextPage` | boolean | Whether there are more results | -| ↳ `endCursor` | string | Cursor for next page | +| ↳ `body` | string | Comment text \(Markdown\) | +| ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) | +| ↳ `updatedAt` | string | Last update timestamp \(ISO 8601\) | +| ↳ `user` | object | User object | +| ↳ `id` | string | User ID | +| ↳ `name` | string | User name | +| ↳ `email` | string | User email | +| ↳ `issue` | object | Issue object | +| ↳ `id` | string | Issue ID | +| ↳ `title` | string | Issue title | ### `linear_list_projects` @@ -419,15 +513,25 @@ List projects in Linear with optional filtering | Parameter | Type | Description | | --------- | ---- | ----------- | +| `pageInfo` | object | Pagination information | +| ↳ `hasNextPage` | boolean | Whether there are more results | +| ↳ `endCursor` | string | Cursor for the next page | | `projects` | array | Array of projects | | ↳ `id` | string | Project ID | | ↳ `name` | string | Project name | | ↳ `description` | string | Project description | -| ↳ `state` | string | Project state | -| ↳ `priority` | number | Project priority | -| ↳ `lead` | object | Project lead | -| ↳ `teams` | array | Teams associated with project | -| `pageInfo` | object | Pagination information | +| ↳ `state` | string | Project state \(planned, started, paused, completed, canceled\) | +| ↳ `priority` | number | Project priority \(0-4\) | +| ↳ `startDate` | string | Start date \(YYYY-MM-DD\) | +| ↳ `targetDate` | string | Target date \(YYYY-MM-DD\) | +| ↳ `url` | string | Project URL | +| ↳ `lead` | object | User object | +| ↳ `id` | string | User ID | +| ↳ `name` | string | User name | +| ↳ `email` | string | User email | +| ↳ `teams` | array | Associated teams | +| ↳ `id` | string | Team ID | +| ↳ `name` | string | Team name | ### `linear_get_project` @@ -444,15 +548,21 @@ Get a single project by ID from Linear | Parameter | Type | Description | | --------- | ---- | ----------- | | `project` | object | The project with full details | -| ↳ `id` | string | Project ID | -| ↳ `name` | string | Project name | -| ↳ `description` | string | Project description | -| ↳ `state` | string | Project state | -| ↳ `priority` | number | Project priority | -| ↳ `startDate` | string | Start date | -| ↳ `targetDate` | string | Target completion date | -| ↳ `lead` | object | Project lead | -| ↳ `teams` | array | Associated teams | +| ↳ `id` | string | Project ID | +| ↳ `name` | string | Project name | +| ↳ `description` | string | Project description | +| ↳ `state` | string | Project state \(planned, started, paused, completed, canceled\) | +| ↳ `priority` | number | Project priority \(0-4\) | +| ↳ `startDate` | string | Start date \(YYYY-MM-DD\) | +| ↳ `targetDate` | string | Target date \(YYYY-MM-DD\) | +| ↳ `url` | string | Project URL | +| ↳ `lead` | object | User object | +| ↳ `id` | string | User ID | +| ↳ `name` | string | User name | +| ↳ `email` | string | User email | +| ↳ `teams` | array | Associated teams | +| ↳ `id` | string | Team ID | +| ↳ `name` | string | Team name | ### `linear_create_project` @@ -475,13 +585,21 @@ Create a new project in Linear | Parameter | Type | Description | | --------- | ---- | ----------- | | `project` | object | The created project | -| ↳ `id` | string | Project ID | -| ↳ `name` | string | Project name | -| ↳ `description` | string | Project description | -| ↳ `state` | string | Project state | -| ↳ `priority` | number | Project priority | -| ↳ `lead` | object | Project lead | -| ↳ `teams` | array | Associated teams | +| ↳ `id` | string | Project ID | +| ↳ `name` | string | Project name | +| ↳ `description` | string | Project description | +| ↳ `state` | string | Project state \(planned, started, paused, completed, canceled\) | +| ↳ `priority` | number | Project priority \(0-4\) | +| ↳ `startDate` | string | Start date \(YYYY-MM-DD\) | +| ↳ `targetDate` | string | Target date \(YYYY-MM-DD\) | +| ↳ `url` | string | Project URL | +| ↳ `lead` | object | User object | +| ↳ `id` | string | User ID | +| ↳ `name` | string | User name | +| ↳ `email` | string | User email | +| ↳ `teams` | array | Associated teams | +| ↳ `id` | string | Team ID | +| ↳ `name` | string | Team name | ### `linear_update_project` @@ -505,15 +623,21 @@ Update an existing project in Linear | Parameter | Type | Description | | --------- | ---- | ----------- | | `project` | object | The updated project | -| ↳ `id` | string | Project ID | -| ↳ `name` | string | Project name | -| ↳ `description` | string | Project description | -| ↳ `state` | string | Project state | -| ↳ `priority` | number | Project priority | -| ↳ `startDate` | string | Project start date | -| ↳ `targetDate` | string | Project target date | -| ↳ `lead` | object | Project lead | -| ↳ `teams` | array | Associated teams | +| ↳ `id` | string | Project ID | +| ↳ `name` | string | Project name | +| ↳ `description` | string | Project description | +| ↳ `state` | string | Project state \(planned, started, paused, completed, canceled\) | +| ↳ `priority` | number | Project priority \(0-4\) | +| ↳ `startDate` | string | Start date \(YYYY-MM-DD\) | +| ↳ `targetDate` | string | Target date \(YYYY-MM-DD\) | +| ↳ `url` | string | Project URL | +| ↳ `lead` | object | User object | +| ↳ `id` | string | User ID | +| ↳ `name` | string | User name | +| ↳ `email` | string | User email | +| ↳ `teams` | array | Associated teams | +| ↳ `id` | string | Team ID | +| ↳ `name` | string | Team name | ### `linear_archive_project` @@ -548,6 +672,9 @@ List all users in the Linear workspace | Parameter | Type | Description | | --------- | ---- | ----------- | +| `pageInfo` | object | Pagination information | +| ↳ `hasNextPage` | boolean | Whether there are more results | +| ↳ `endCursor` | string | Cursor for the next page | | `users` | array | Array of workspace users | | ↳ `id` | string | User ID | | ↳ `name` | string | User name | @@ -556,7 +683,6 @@ List all users in the Linear workspace | ↳ `active` | boolean | Whether user is active | | ↳ `admin` | boolean | Whether user is admin | | ↳ `avatarUrl` | string | Avatar URL | -| `pageInfo` | object | Pagination information | ### `linear_list_teams` @@ -573,12 +699,14 @@ List all teams in the Linear workspace | Parameter | Type | Description | | --------- | ---- | ----------- | +| `pageInfo` | object | Pagination information | +| ↳ `hasNextPage` | boolean | Whether there are more results | +| ↳ `endCursor` | string | Cursor for the next page | | `teams` | array | Array of teams | | ↳ `id` | string | Team ID | | ↳ `name` | string | Team name | | ↳ `key` | string | Team key \(used in issue identifiers\) | | ↳ `description` | string | Team description | -| `pageInfo` | object | Pagination information | ### `linear_get_viewer` @@ -594,13 +722,13 @@ Get the currently authenticated user (viewer) information | Parameter | Type | Description | | --------- | ---- | ----------- | | `user` | object | The currently authenticated user | -| ↳ `id` | string | User ID | -| ↳ `name` | string | User name | -| ↳ `email` | string | User email | -| ↳ `displayName` | string | Display name | -| ↳ `active` | boolean | Whether user is active | -| ↳ `admin` | boolean | Whether user is admin | -| ↳ `avatarUrl` | string | Avatar URL | +| ↳ `id` | string | User ID | +| ↳ `name` | string | User name | +| ↳ `email` | string | User email | +| ↳ `displayName` | string | Display name | +| ↳ `active` | boolean | Whether user is active | +| ↳ `admin` | boolean | Whether user is admin | +| ↳ `avatarUrl` | string | Avatar URL | ### `linear_list_labels` @@ -618,13 +746,17 @@ List all labels in Linear workspace or team | Parameter | Type | Description | | --------- | ---- | ----------- | +| `pageInfo` | object | Pagination information | +| ↳ `hasNextPage` | boolean | Whether there are more results | +| ↳ `endCursor` | string | Cursor for the next page | | `labels` | array | Array of labels | | ↳ `id` | string | Label ID | | ↳ `name` | string | Label name | | ↳ `color` | string | Label color \(hex\) | | ↳ `description` | string | Label description | -| ↳ `team` | object | Team this label belongs to | -| `pageInfo` | object | Pagination information | +| ↳ `team` | object | Team object | +| ↳ `id` | string | Team ID | +| ↳ `name` | string | Team name | ### `linear_create_label` @@ -644,11 +776,13 @@ Create a new label in Linear | Parameter | Type | Description | | --------- | ---- | ----------- | | `label` | object | The created label | -| ↳ `id` | string | Label ID | -| ↳ `name` | string | Label name | -| ↳ `color` | string | Label color | -| ↳ `description` | string | Label description | -| ↳ `team` | object | Team this label belongs to | +| ↳ `id` | string | Label ID | +| ↳ `name` | string | Label name | +| ↳ `color` | string | Label color \(hex\) | +| ↳ `description` | string | Label description | +| ↳ `team` | object | Team object | +| ↳ `id` | string | Team ID | +| ↳ `name` | string | Team name | ### `linear_update_label` @@ -668,10 +802,13 @@ Update an existing label in Linear | Parameter | Type | Description | | --------- | ---- | ----------- | | `label` | object | The updated label | -| ↳ `id` | string | Label ID | -| ↳ `name` | string | Label name | -| ↳ `color` | string | Label color | -| ↳ `description` | string | Label description | +| ↳ `id` | string | Label ID | +| ↳ `name` | string | Label name | +| ↳ `color` | string | Label color \(hex\) | +| ↳ `description` | string | Label description | +| ↳ `team` | object | Team object | +| ↳ `id` | string | Team ID | +| ↳ `name` | string | Team name | ### `linear_archive_label` @@ -706,14 +843,18 @@ List all workflow states (statuses) in Linear | Parameter | Type | Description | | --------- | ---- | ----------- | +| `pageInfo` | object | Pagination information | +| ↳ `hasNextPage` | boolean | Whether there are more results | +| ↳ `endCursor` | string | Cursor for the next page | | `states` | array | Array of workflow states | | ↳ `id` | string | State ID | -| ↳ `name` | string | State name \(e.g., | -| ↳ `type` | string | State type \(e.g., | -| ↳ `color` | string | State color | +| ↳ `name` | string | State name \(e.g., "Todo", "In Progress"\) | +| ↳ `type` | string | State type \(unstarted, started, completed, canceled\) | +| ↳ `color` | string | State color \(hex\) | | ↳ `position` | number | State position in workflow | -| ↳ `team` | object | Team this state belongs to | -| `pageInfo` | object | Pagination information | +| ↳ `team` | object | Team object | +| ↳ `id` | string | Team ID | +| ↳ `name` | string | Team name | ### `linear_create_workflow_state` @@ -735,12 +876,12 @@ Create a new workflow state (status) in Linear | Parameter | Type | Description | | --------- | ---- | ----------- | | `state` | object | The created workflow state | -| ↳ `id` | string | State ID | -| ↳ `name` | string | State name | -| ↳ `type` | string | State type | -| ↳ `color` | string | State color | -| ↳ `position` | number | State position | -| ↳ `team` | object | Team this state belongs to | +| ↳ `id` | string | State ID | +| ↳ `name` | string | State name | +| ↳ `type` | string | State type | +| ↳ `color` | string | State color | +| ↳ `position` | number | State position | +| ↳ `team` | object | Team this state belongs to | ### `linear_update_workflow_state` @@ -761,11 +902,11 @@ Update an existing workflow state in Linear | Parameter | Type | Description | | --------- | ---- | ----------- | | `state` | object | The updated workflow state | -| ↳ `id` | string | State ID | -| ↳ `name` | string | State name | -| ↳ `type` | string | State type | -| ↳ `color` | string | State color | -| ↳ `position` | number | State position | +| ↳ `id` | string | State ID | +| ↳ `name` | string | State name | +| ↳ `type` | string | State type | +| ↳ `color` | string | State color | +| ↳ `position` | number | State position | ### `linear_list_cycles` @@ -783,16 +924,20 @@ List cycles (sprints/iterations) in Linear | Parameter | Type | Description | | --------- | ---- | ----------- | +| `pageInfo` | object | Pagination information | +| ↳ `hasNextPage` | boolean | Whether there are more results | +| ↳ `endCursor` | string | Cursor for the next page | | `cycles` | array | Array of cycles | | ↳ `id` | string | Cycle ID | | ↳ `number` | number | Cycle number | | ↳ `name` | string | Cycle name | -| ↳ `startsAt` | string | Start date | -| ↳ `endsAt` | string | End date | -| ↳ `completedAt` | string | Completion date | +| ↳ `startsAt` | string | Start date \(ISO 8601\) | +| ↳ `endsAt` | string | End date \(ISO 8601\) | +| ↳ `completedAt` | string | Completion date \(ISO 8601\) | | ↳ `progress` | number | Progress percentage \(0-1\) | -| ↳ `team` | object | Team this cycle belongs to | -| `pageInfo` | object | Pagination information | +| ↳ `team` | object | Team object | +| ↳ `id` | string | Team ID | +| ↳ `name` | string | Team name | ### `linear_get_cycle` @@ -809,13 +954,16 @@ Get a single cycle by ID from Linear | Parameter | Type | Description | | --------- | ---- | ----------- | | `cycle` | object | The cycle with full details | -| ↳ `id` | string | Cycle ID | -| ↳ `number` | number | Cycle number | -| ↳ `name` | string | Cycle name | -| ↳ `startsAt` | string | Start date | -| ↳ `endsAt` | string | End date | -| ↳ `progress` | number | Progress percentage | -| ↳ `team` | object | Team this cycle belongs to | +| ↳ `id` | string | Cycle ID | +| ↳ `number` | number | Cycle number | +| ↳ `name` | string | Cycle name | +| ↳ `startsAt` | string | Start date \(ISO 8601\) | +| ↳ `endsAt` | string | End date \(ISO 8601\) | +| ↳ `completedAt` | string | Completion date \(ISO 8601\) | +| ↳ `progress` | number | Progress percentage \(0-1\) | +| ↳ `team` | object | Team object | +| ↳ `id` | string | Team ID | +| ↳ `name` | string | Team name | ### `linear_create_cycle` @@ -835,12 +983,12 @@ Create a new cycle (sprint/iteration) in Linear | Parameter | Type | Description | | --------- | ---- | ----------- | | `cycle` | object | The created cycle | -| ↳ `id` | string | Cycle ID | -| ↳ `number` | number | Cycle number | -| ↳ `name` | string | Cycle name | -| ↳ `startsAt` | string | Start date | -| ↳ `endsAt` | string | End date | -| ↳ `team` | object | Team this cycle belongs to | +| ↳ `id` | string | Cycle ID | +| ↳ `number` | number | Cycle number | +| ↳ `name` | string | Cycle name | +| ↳ `startsAt` | string | Start date | +| ↳ `endsAt` | string | End date | +| ↳ `team` | object | Team this cycle belongs to | ### `linear_get_active_cycle` @@ -857,13 +1005,13 @@ Get the currently active cycle for a team | Parameter | Type | Description | | --------- | ---- | ----------- | | `cycle` | object | The active cycle \(null if no active cycle\) | -| ↳ `id` | string | Cycle ID | -| ↳ `number` | number | Cycle number | -| ↳ `name` | string | Cycle name | -| ↳ `startsAt` | string | Start date | -| ↳ `endsAt` | string | End date | -| ↳ `progress` | number | Progress percentage | -| ↳ `team` | object | Team this cycle belongs to | +| ↳ `id` | string | Cycle ID | +| ↳ `number` | number | Cycle number | +| ↳ `name` | string | Cycle name | +| ↳ `startsAt` | string | Start date | +| ↳ `endsAt` | string | End date | +| ↳ `progress` | number | Progress percentage | +| ↳ `team` | object | Team this cycle belongs to | ### `linear_create_attachment` @@ -883,11 +1031,12 @@ Add an attachment to an issue in Linear | Parameter | Type | Description | | --------- | ---- | ----------- | | `attachment` | object | The created attachment | -| ↳ `id` | string | Attachment ID | -| ↳ `title` | string | Attachment title | -| ↳ `subtitle` | string | Attachment subtitle | -| ↳ `url` | string | Attachment URL | -| ↳ `createdAt` | string | Creation timestamp | +| ↳ `id` | string | Attachment ID | +| ↳ `title` | string | Attachment title | +| ↳ `subtitle` | string | Attachment subtitle | +| ↳ `url` | string | Attachment URL | +| ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) | +| ↳ `updatedAt` | string | Last update timestamp \(ISO 8601\) | ### `linear_list_attachments` @@ -905,13 +1054,16 @@ List all attachments on an issue in Linear | Parameter | Type | Description | | --------- | ---- | ----------- | +| `pageInfo` | object | Pagination information | +| ↳ `hasNextPage` | boolean | Whether there are more results | +| ↳ `endCursor` | string | Cursor for the next page | | `attachments` | array | Array of attachments | | ↳ `id` | string | Attachment ID | | ↳ `title` | string | Attachment title | | ↳ `subtitle` | string | Attachment subtitle | | ↳ `url` | string | Attachment URL | -| ↳ `createdAt` | string | Creation timestamp | -| `pageInfo` | object | Pagination information | +| ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) | +| ↳ `updatedAt` | string | Last update timestamp \(ISO 8601\) | ### `linear_update_attachment` @@ -930,11 +1082,12 @@ Update an attachment metadata in Linear | Parameter | Type | Description | | --------- | ---- | ----------- | | `attachment` | object | The updated attachment | -| ↳ `id` | string | Attachment ID | -| ↳ `title` | string | Attachment title | -| ↳ `subtitle` | string | Attachment subtitle | -| ↳ `url` | string | Attachment URL | -| ↳ `updatedAt` | string | Last update timestamp | +| ↳ `id` | string | Attachment ID | +| ↳ `title` | string | Attachment title | +| ↳ `subtitle` | string | Attachment subtitle | +| ↳ `url` | string | Attachment URL | +| ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) | +| ↳ `updatedAt` | string | Last update timestamp \(ISO 8601\) | ### `linear_delete_attachment` @@ -969,10 +1122,10 @@ Link two issues together in Linear (blocks, relates to, duplicates) | Parameter | Type | Description | | --------- | ---- | ----------- | | `relation` | object | The created issue relation | -| ↳ `id` | string | Relation ID | -| ↳ `type` | string | Relation type | -| ↳ `issue` | object | Source issue | -| ↳ `relatedIssue` | object | Target issue | +| ↳ `id` | string | Relation ID | +| ↳ `type` | string | Relation type | +| ↳ `issue` | object | Source issue | +| ↳ `relatedIssue` | object | Target issue | ### `linear_list_issue_relations` @@ -1031,11 +1184,11 @@ Bookmark an issue, project, cycle, or label in Linear | Parameter | Type | Description | | --------- | ---- | ----------- | | `favorite` | object | The created favorite | -| ↳ `id` | string | Favorite ID | -| ↳ `type` | string | Favorite type | -| ↳ `issue` | object | Favorited issue \(if applicable\) | -| ↳ `project` | object | Favorited project \(if applicable\) | -| ↳ `cycle` | object | Favorited cycle \(if applicable\) | +| ↳ `id` | string | Favorite ID | +| ↳ `type` | string | Favorite type | +| ↳ `issue` | object | Favorited issue \(if applicable\) | +| ↳ `project` | object | Favorited project \(if applicable\) | +| ↳ `cycle` | object | Favorited cycle \(if applicable\) | ### `linear_list_favorites` @@ -1077,11 +1230,11 @@ Post a status update for a project in Linear | Parameter | Type | Description | | --------- | ---- | ----------- | | `update` | object | The created project update | -| ↳ `id` | string | Update ID | -| ↳ `body` | string | Update message | -| ↳ `health` | string | Project health status | -| ↳ `createdAt` | string | Creation timestamp | -| ↳ `user` | object | User who created the update | +| ↳ `id` | string | Update ID | +| ↳ `body` | string | Update message | +| ↳ `health` | string | Project health status | +| ↳ `createdAt` | string | Creation timestamp | +| ↳ `user` | object | User who created the update | ### `linear_list_project_updates` @@ -1146,11 +1299,11 @@ Mark a notification as read or unread in Linear | Parameter | Type | Description | | --------- | ---- | ----------- | | `notification` | object | The updated notification | -| ↳ `id` | string | Notification ID | -| ↳ `type` | string | Notification type | -| ↳ `createdAt` | string | Creation timestamp | -| ↳ `readAt` | string | Read timestamp | -| ↳ `issue` | object | Related issue | +| ↳ `id` | string | Notification ID | +| ↳ `type` | string | Notification type | +| ↳ `createdAt` | string | Creation timestamp | +| ↳ `readAt` | string | Read timestamp | +| ↳ `issue` | object | Related issue | ### `linear_create_customer` @@ -1175,14 +1328,14 @@ Create a new customer in Linear | Parameter | Type | Description | | --------- | ---- | ----------- | | `customer` | object | The created customer | -| ↳ `id` | string | Customer ID | -| ↳ `name` | string | Customer name | -| ↳ `domains` | array | Associated domains | -| ↳ `externalIds` | array | External IDs | -| ↳ `logoUrl` | string | Logo URL | -| ↳ `approximateNeedCount` | number | Number of customer needs | -| ↳ `createdAt` | string | Creation timestamp | -| ↳ `archivedAt` | string | Archive timestamp \(null if not archived\) | +| ↳ `id` | string | Customer ID | +| ↳ `name` | string | Customer name | +| ↳ `domains` | array | Associated domains | +| ↳ `externalIds` | array | External IDs from other systems | +| ↳ `logoUrl` | string | Logo URL | +| ↳ `approximateNeedCount` | number | Number of customer needs | +| ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) | +| ↳ `archivedAt` | string | Archive timestamp \(ISO 8601\) | ### `linear_list_customers` @@ -1200,16 +1353,18 @@ List all customers in Linear | Parameter | Type | Description | | --------- | ---- | ----------- | +| `pageInfo` | object | Pagination information | +| ↳ `hasNextPage` | boolean | Whether there are more results | +| ↳ `endCursor` | string | Cursor for the next page | | `customers` | array | Array of customers | | ↳ `id` | string | Customer ID | | ↳ `name` | string | Customer name | | ↳ `domains` | array | Associated domains | -| ↳ `externalIds` | array | External IDs | +| ↳ `externalIds` | array | External IDs from other systems | | ↳ `logoUrl` | string | Logo URL | | ↳ `approximateNeedCount` | number | Number of customer needs | -| ↳ `createdAt` | string | Creation timestamp | -| ↳ `archivedAt` | string | Archive timestamp \(null if not archived\) | -| `pageInfo` | object | Pagination information | +| ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) | +| ↳ `archivedAt` | string | Archive timestamp \(ISO 8601\) | ### `linear_create_customer_request` @@ -1230,17 +1385,17 @@ Create a customer request (need) in Linear. Assign to customer, set urgency (pri | Parameter | Type | Description | | --------- | ---- | ----------- | | `customerNeed` | object | The created customer request | -| ↳ `id` | string | Customer request ID | -| ↳ `body` | string | Request description | -| ↳ `priority` | number | Urgency level \(0 = Not important, 1 = Important\) | -| ↳ `createdAt` | string | Creation timestamp | -| ↳ `updatedAt` | string | Last update timestamp | -| ↳ `archivedAt` | string | Archive timestamp \(null if not archived\) | -| ↳ `customer` | object | Assigned customer | -| ↳ `issue` | object | Linked issue \(null if not linked\) | -| ↳ `project` | object | Linked project \(null if not linked\) | -| ↳ `creator` | object | User who created the request | -| ↳ `url` | string | URL to the customer request | +| ↳ `id` | string | Customer request ID | +| ↳ `body` | string | Request description | +| ↳ `priority` | number | Urgency level \(0 = Not important, 1 = Important\) | +| ↳ `createdAt` | string | Creation timestamp | +| ↳ `updatedAt` | string | Last update timestamp | +| ↳ `archivedAt` | string | Archive timestamp \(null if not archived\) | +| ↳ `customer` | object | Assigned customer | +| ↳ `issue` | object | Linked issue \(null if not linked\) | +| ↳ `project` | object | Linked project \(null if not linked\) | +| ↳ `creator` | object | User who created the request | +| ↳ `url` | string | URL to the customer request | ### `linear_update_customer_request` @@ -1262,17 +1417,17 @@ Update a customer request (need) in Linear. Can change urgency, description, cus | Parameter | Type | Description | | --------- | ---- | ----------- | | `customerNeed` | object | The updated customer request | -| ↳ `id` | string | Customer request ID | -| ↳ `body` | string | Request description | -| ↳ `priority` | number | Urgency level \(0 = Not important, 1 = Important\) | -| ↳ `createdAt` | string | Creation timestamp | -| ↳ `updatedAt` | string | Last update timestamp | -| ↳ `archivedAt` | string | Archive timestamp \(null if not archived\) | -| ↳ `customer` | object | Assigned customer | -| ↳ `issue` | object | Linked issue \(null if not linked\) | -| ↳ `project` | object | Linked project \(null if not linked\) | -| ↳ `creator` | object | User who created the request | -| ↳ `url` | string | URL to the customer request | +| ↳ `id` | string | Customer request ID | +| ↳ `body` | string | Request description | +| ↳ `priority` | number | Urgency level \(0 = Not important, 1 = Important\) | +| ↳ `createdAt` | string | Creation timestamp | +| ↳ `updatedAt` | string | Last update timestamp | +| ↳ `archivedAt` | string | Archive timestamp \(null if not archived\) | +| ↳ `customer` | object | Assigned customer | +| ↳ `issue` | object | Linked issue \(null if not linked\) | +| ↳ `project` | object | Linked project \(null if not linked\) | +| ↳ `creator` | object | User who created the request | +| ↳ `url` | string | URL to the customer request | ### `linear_list_customer_requests` @@ -1319,14 +1474,14 @@ Get a single customer by ID in Linear | Parameter | Type | Description | | --------- | ---- | ----------- | | `customer` | object | The customer data | -| ↳ `id` | string | Customer ID | -| ↳ `name` | string | Customer name | -| ↳ `domains` | array | Associated domains | -| ↳ `externalIds` | array | External IDs | -| ↳ `logoUrl` | string | Logo URL | -| ↳ `approximateNeedCount` | number | Number of customer needs | -| ↳ `createdAt` | string | Creation timestamp | -| ↳ `archivedAt` | string | Archive timestamp \(null if not archived\) | +| ↳ `id` | string | Customer ID | +| ↳ `name` | string | Customer name | +| ↳ `domains` | array | Associated domains | +| ↳ `externalIds` | array | External IDs from other systems | +| ↳ `logoUrl` | string | Logo URL | +| ↳ `approximateNeedCount` | number | Number of customer needs | +| ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) | +| ↳ `archivedAt` | string | Archive timestamp \(ISO 8601\) | ### `linear_update_customer` @@ -1352,6 +1507,14 @@ Update a customer in Linear | Parameter | Type | Description | | --------- | ---- | ----------- | | `customer` | object | The updated customer | +| ↳ `id` | string | Customer ID | +| ↳ `name` | string | Customer name | +| ↳ `domains` | array | Associated domains | +| ↳ `externalIds` | array | External IDs from other systems | +| ↳ `logoUrl` | string | Logo URL | +| ↳ `approximateNeedCount` | number | Number of customer needs | +| ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) | +| ↳ `archivedAt` | string | Archive timestamp \(ISO 8601\) | ### `linear_delete_customer` @@ -1405,6 +1568,14 @@ Create a new customer status in Linear | Parameter | Type | Description | | --------- | ---- | ----------- | | `customerStatus` | object | The created customer status | +| ↳ `id` | string | Customer status ID | +| ↳ `name` | string | Status name | +| ↳ `displayName` | string | Display name | +| ↳ `description` | string | Status description | +| ↳ `color` | string | Status color \(hex\) | +| ↳ `position` | number | Position in list | +| ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) | +| ↳ `archivedAt` | string | Archive timestamp \(ISO 8601\) | ### `linear_update_customer_status` @@ -1457,6 +1628,14 @@ List all customer statuses in Linear | Parameter | Type | Description | | --------- | ---- | ----------- | | `customerStatuses` | array | List of customer statuses | +| ↳ `id` | string | Customer status ID | +| ↳ `name` | string | Status name | +| ↳ `displayName` | string | Display name | +| ↳ `description` | string | Status description | +| ↳ `color` | string | Status color \(hex\) | +| ↳ `position` | number | Position in list | +| ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) | +| ↳ `archivedAt` | string | Archive timestamp \(ISO 8601\) | ### `linear_create_customer_tier` @@ -1477,6 +1656,14 @@ Create a new customer tier in Linear | Parameter | Type | Description | | --------- | ---- | ----------- | | `customerTier` | object | The created customer tier | +| ↳ `id` | string | Customer tier ID | +| ↳ `name` | string | Tier name | +| ↳ `displayName` | string | Display name | +| ↳ `description` | string | Tier description | +| ↳ `color` | string | Tier color \(hex\) | +| ↳ `position` | number | Position in list | +| ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) | +| ↳ `archivedAt` | string | Archive timestamp \(ISO 8601\) | ### `linear_update_customer_tier` @@ -1529,6 +1716,14 @@ List all customer tiers in Linear | Parameter | Type | Description | | --------- | ---- | ----------- | | `customerTiers` | array | List of customer tiers | +| ↳ `id` | string | Customer tier ID | +| ↳ `name` | string | Tier name | +| ↳ `displayName` | string | Display name | +| ↳ `description` | string | Tier description | +| ↳ `color` | string | Tier color \(hex\) | +| ↳ `position` | number | Position in list | +| ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) | +| ↳ `archivedAt` | string | Archive timestamp \(ISO 8601\) | ### `linear_delete_project` diff --git a/apps/docs/content/docs/en/tools/mailchimp.mdx b/apps/docs/content/docs/en/tools/mailchimp.mdx index ded3b76ae..7d5341973 100644 --- a/apps/docs/content/docs/en/tools/mailchimp.mdx +++ b/apps/docs/content/docs/en/tools/mailchimp.mdx @@ -72,9 +72,9 @@ Retrieve a list of audiences (lists) from Mailchimp | --------- | ---- | ----------- | | `success` | boolean | Whether the audiences were successfully retrieved | | `output` | object | Audiences data | -| ↳ `lists` | json | Array of audience/list objects | -| ↳ `total_items` | number | Total number of lists | -| ↳ `total_returned` | number | Number of lists returned in this response | +| ↳ `lists` | json | Array of audience/list objects | +| ↳ `total_items` | number | Total number of lists | +| ↳ `total_returned` | number | Number of lists returned in this response | ### `mailchimp_get_audience` @@ -93,8 +93,8 @@ Retrieve details of a specific audience (list) from Mailchimp | --------- | ---- | ----------- | | `success` | boolean | Whether the audience was successfully retrieved | | `output` | object | Audience data | -| ↳ `list` | json | Audience/list object | -| ↳ `list_id` | string | The unique ID of the audience | +| ↳ `list` | json | Audience/list object | +| ↳ `list_id` | string | The unique ID of the audience | ### `mailchimp_create_audience` @@ -117,9 +117,9 @@ Create a new audience (list) in Mailchimp | --------- | ---- | ----------- | | `success` | boolean | Operation success status | | `output` | object | Created audience data | -| ↳ `list` | json | Created audience/list object | -| ↳ `list_id` | string | Created audience/list ID | -| ↳ `success` | boolean | Operation success | +| ↳ `list` | json | Created audience/list object | +| ↳ `list_id` | string | Created audience/list ID | +| ↳ `success` | boolean | Operation success | ### `mailchimp_update_audience` @@ -142,9 +142,9 @@ Update an existing audience (list) in Mailchimp | --------- | ---- | ----------- | | `success` | boolean | Operation success status | | `output` | object | Updated audience data | -| ↳ `list` | object | Updated audience/list object | -| ↳ `list_id` | string | List ID | -| ↳ `success` | boolean | Operation success | +| ↳ `list` | object | Updated audience/list object | +| ↳ `list_id` | string | List ID | +| ↳ `success` | boolean | Operation success | ### `mailchimp_delete_audience` @@ -183,9 +183,9 @@ Retrieve a list of members from a Mailchimp audience | --------- | ---- | ----------- | | `success` | boolean | Whether the members were successfully retrieved | | `output` | object | Members data | -| ↳ `members` | json | Array of member objects | -| ↳ `total_items` | number | Total number of members | -| ↳ `total_returned` | number | Number of members returned in this response | +| ↳ `members` | json | Array of member objects | +| ↳ `total_items` | number | Total number of members | +| ↳ `total_returned` | number | Number of members returned in this response | ### `mailchimp_get_member` @@ -205,8 +205,8 @@ Retrieve details of a specific member from a Mailchimp audience | --------- | ---- | ----------- | | `success` | boolean | Whether the member was successfully retrieved | | `output` | object | Member data | -| ↳ `member` | json | Member object | -| ↳ `subscriber_hash` | string | The MD5 hash of the member email address | +| ↳ `member` | json | Member object | +| ↳ `subscriber_hash` | string | The MD5 hash of the member email address | ### `mailchimp_add_member` @@ -229,9 +229,9 @@ Add a new member to a Mailchimp audience | --------- | ---- | ----------- | | `success` | boolean | Operation success status | | `output` | object | Added member data | -| ↳ `member` | json | Added member object | -| ↳ `subscriber_hash` | string | Subscriber hash ID | -| ↳ `success` | boolean | Operation success | +| ↳ `member` | json | Added member object | +| ↳ `subscriber_hash` | string | Subscriber hash ID | +| ↳ `success` | boolean | Operation success | ### `mailchimp_add_or_update_member` @@ -255,9 +255,9 @@ Add a new member or update an existing member in a Mailchimp audience (upsert) | --------- | ---- | ----------- | | `success` | boolean | Operation success status | | `output` | object | Member data | -| ↳ `member` | json | Member object | -| ↳ `subscriber_hash` | string | Subscriber hash ID | -| ↳ `success` | boolean | Operation success | +| ↳ `member` | json | Member object | +| ↳ `subscriber_hash` | string | Subscriber hash ID | +| ↳ `success` | boolean | Operation success | ### `mailchimp_update_member` @@ -281,9 +281,9 @@ Update an existing member in a Mailchimp audience | --------- | ---- | ----------- | | `success` | boolean | Operation success status | | `output` | object | Updated member data | -| ↳ `member` | object | Updated member object | -| ↳ `subscriber_hash` | string | Subscriber hash | -| ↳ `success` | boolean | Operation success | +| ↳ `member` | object | Updated member object | +| ↳ `subscriber_hash` | string | Subscriber hash | +| ↳ `success` | boolean | Operation success | ### `mailchimp_delete_member` @@ -321,7 +321,7 @@ Permanently archive (delete) a member from a Mailchimp audience | --------- | ---- | ----------- | | `success` | boolean | Operation success status | | `output` | object | Archive confirmation | -| ↳ `success` | boolean | Operation success | +| ↳ `success` | boolean | Operation success | ### `mailchimp_unarchive_member` @@ -343,9 +343,9 @@ Restore an archived member to a Mailchimp audience | --------- | ---- | ----------- | | `success` | boolean | Operation success status | | `output` | object | Unarchived member data | -| ↳ `member` | object | Unarchived member object | -| ↳ `subscriber_hash` | string | Subscriber hash | -| ↳ `success` | boolean | Operation success | +| ↳ `member` | object | Unarchived member object | +| ↳ `subscriber_hash` | string | Subscriber hash | +| ↳ `success` | boolean | Operation success | ### `mailchimp_get_campaigns` @@ -367,9 +367,9 @@ Retrieve a list of campaigns from Mailchimp | --------- | ---- | ----------- | | `success` | boolean | Whether the campaigns were successfully retrieved | | `output` | object | Campaigns data | -| ↳ `campaigns` | json | Array of campaign objects | -| ↳ `total_items` | number | Total number of campaigns | -| ↳ `total_returned` | number | Number of campaigns returned in this response | +| ↳ `campaigns` | json | Array of campaign objects | +| ↳ `total_items` | number | Total number of campaigns | +| ↳ `total_returned` | number | Number of campaigns returned in this response | ### `mailchimp_get_campaign` @@ -388,8 +388,8 @@ Retrieve details of a specific campaign from Mailchimp | --------- | ---- | ----------- | | `success` | boolean | Whether the campaign was successfully retrieved | | `output` | object | Campaign data | -| ↳ `campaign` | json | Campaign object | -| ↳ `campaign_id` | string | The unique ID of the campaign | +| ↳ `campaign` | json | Campaign object | +| ↳ `campaign_id` | string | The unique ID of the campaign | ### `mailchimp_create_campaign` @@ -410,9 +410,9 @@ Create a new campaign in Mailchimp | --------- | ---- | ----------- | | `success` | boolean | Operation success status | | `output` | object | Created campaign data | -| ↳ `campaign` | json | Created campaign object | -| ↳ `campaign_id` | string | Created campaign ID | -| ↳ `success` | boolean | Operation success | +| ↳ `campaign` | json | Created campaign object | +| ↳ `campaign_id` | string | Created campaign ID | +| ↳ `success` | boolean | Operation success | ### `mailchimp_update_campaign` @@ -433,9 +433,9 @@ Update an existing campaign in Mailchimp | --------- | ---- | ----------- | | `success` | boolean | Operation success status | | `output` | object | Updated campaign data | -| ↳ `campaign` | object | Updated campaign object | -| ↳ `campaign_id` | string | Campaign ID | -| ↳ `success` | boolean | Operation success | +| ↳ `campaign` | object | Updated campaign object | +| ↳ `campaign_id` | string | Campaign ID | +| ↳ `success` | boolean | Operation success | ### `mailchimp_delete_campaign` @@ -471,7 +471,7 @@ Send a Mailchimp campaign | --------- | ---- | ----------- | | `success` | boolean | Operation success status | | `output` | object | Send confirmation | -| ↳ `success` | boolean | Operation success | +| ↳ `success` | boolean | Operation success | ### `mailchimp_schedule_campaign` @@ -508,7 +508,7 @@ Unschedule a previously scheduled Mailchimp campaign | --------- | ---- | ----------- | | `success` | boolean | Operation success status | | `output` | object | Unschedule confirmation | -| ↳ `success` | boolean | Operation success | +| ↳ `success` | boolean | Operation success | ### `mailchimp_replicate_campaign` @@ -527,9 +527,9 @@ Create a copy of an existing Mailchimp campaign | --------- | ---- | ----------- | | `success` | boolean | Operation success status | | `output` | object | Replicated campaign data | -| ↳ `campaign` | object | Replicated campaign object | -| ↳ `campaign_id` | string | Campaign ID | -| ↳ `success` | boolean | Operation success | +| ↳ `campaign` | object | Replicated campaign object | +| ↳ `campaign_id` | string | Campaign ID | +| ↳ `success` | boolean | Operation success | ### `mailchimp_get_campaign_content` @@ -548,7 +548,7 @@ Retrieve the HTML and plain-text content for a Mailchimp campaign | --------- | ---- | ----------- | | `success` | boolean | Whether the campaign content was successfully retrieved | | `output` | object | Campaign content data | -| ↳ `content` | json | Campaign content object | +| ↳ `content` | json | Campaign content object | ### `mailchimp_set_campaign_content` @@ -570,8 +570,8 @@ Set the content for a Mailchimp campaign | --------- | ---- | ----------- | | `success` | boolean | Operation success status | | `output` | object | Campaign content data | -| ↳ `content` | object | Campaign content object | -| ↳ `success` | boolean | Operation success | +| ↳ `content` | object | Campaign content object | +| ↳ `success` | boolean | Operation success | ### `mailchimp_get_automations` @@ -591,9 +591,9 @@ Retrieve a list of automations from Mailchimp | --------- | ---- | ----------- | | `success` | boolean | Whether the automations were successfully retrieved | | `output` | object | Automations data | -| ↳ `automations` | json | Array of automation objects | -| ↳ `total_items` | number | Total number of automations | -| ↳ `total_returned` | number | Number of automations returned in this response | +| ↳ `automations` | json | Array of automation objects | +| ↳ `total_items` | number | Total number of automations | +| ↳ `total_returned` | number | Number of automations returned in this response | ### `mailchimp_get_automation` @@ -612,8 +612,8 @@ Retrieve details of a specific automation from Mailchimp | --------- | ---- | ----------- | | `success` | boolean | Whether the automation was successfully retrieved | | `output` | object | Automation data | -| ↳ `automation` | json | Automation object | -| ↳ `workflow_id` | string | The unique ID of the automation workflow | +| ↳ `automation` | json | Automation object | +| ↳ `workflow_id` | string | The unique ID of the automation workflow | ### `mailchimp_start_automation` @@ -632,7 +632,7 @@ Start all emails in a Mailchimp automation workflow | --------- | ---- | ----------- | | `success` | boolean | Operation success status | | `output` | object | Start confirmation | -| ↳ `success` | boolean | Operation success | +| ↳ `success` | boolean | Operation success | ### `mailchimp_pause_automation` @@ -651,7 +651,7 @@ Pause all emails in a Mailchimp automation workflow | --------- | ---- | ----------- | | `success` | boolean | Operation success status | | `output` | object | Pause confirmation | -| ↳ `success` | boolean | Operation success | +| ↳ `success` | boolean | Operation success | ### `mailchimp_add_subscriber_to_automation` @@ -672,8 +672,8 @@ Manually add a subscriber to a workflow email queue | --------- | ---- | ----------- | | `success` | boolean | Operation success status | | `output` | object | Subscriber queue data | -| ↳ `subscriber` | json | Subscriber object | -| ↳ `success` | boolean | Operation success | +| ↳ `subscriber` | json | Subscriber object | +| ↳ `success` | boolean | Operation success | ### `mailchimp_get_templates` @@ -693,9 +693,9 @@ Retrieve a list of templates from Mailchimp | --------- | ---- | ----------- | | `success` | boolean | Whether the templates were successfully retrieved | | `output` | object | Templates data | -| ↳ `templates` | json | Array of template objects | -| ↳ `total_items` | number | Total number of templates | -| ↳ `total_returned` | number | Number of templates returned in this response | +| ↳ `templates` | json | Array of template objects | +| ↳ `total_items` | number | Total number of templates | +| ↳ `total_returned` | number | Number of templates returned in this response | ### `mailchimp_get_template` @@ -714,8 +714,8 @@ Retrieve details of a specific template from Mailchimp | --------- | ---- | ----------- | | `success` | boolean | Whether the template was successfully retrieved | | `output` | object | Template data | -| ↳ `template` | json | Template object | -| ↳ `template_id` | string | The unique ID of the template | +| ↳ `template` | json | Template object | +| ↳ `template_id` | string | The unique ID of the template | ### `mailchimp_create_template` @@ -735,9 +735,9 @@ Create a new template in Mailchimp | --------- | ---- | ----------- | | `success` | boolean | Operation success status | | `output` | object | Created template data | -| ↳ `template` | json | Created template object | -| ↳ `template_id` | string | Created template ID | -| ↳ `success` | boolean | Operation success | +| ↳ `template` | json | Created template object | +| ↳ `template_id` | string | Created template ID | +| ↳ `success` | boolean | Operation success | ### `mailchimp_update_template` @@ -758,9 +758,9 @@ Update an existing template in Mailchimp | --------- | ---- | ----------- | | `success` | boolean | Operation success status | | `output` | object | Updated template data | -| ↳ `template` | object | Updated template object | -| ↳ `template_id` | string | Template ID | -| ↳ `success` | boolean | Operation success | +| ↳ `template` | object | Updated template object | +| ↳ `template_id` | string | Template ID | +| ↳ `success` | boolean | Operation success | ### `mailchimp_delete_template` @@ -797,9 +797,9 @@ Retrieve a list of campaign reports from Mailchimp | --------- | ---- | ----------- | | `success` | boolean | Whether the campaign reports were successfully retrieved | | `output` | object | Campaign reports data | -| ↳ `reports` | json | Array of campaign report objects | -| ↳ `total_items` | number | Total number of reports | -| ↳ `total_returned` | number | Number of reports returned in this response | +| ↳ `reports` | json | Array of campaign report objects | +| ↳ `total_items` | number | Total number of reports | +| ↳ `total_returned` | number | Number of reports returned in this response | ### `mailchimp_get_campaign_report` @@ -818,8 +818,8 @@ Retrieve the report for a specific campaign from Mailchimp | --------- | ---- | ----------- | | `success` | boolean | Whether the campaign report was successfully retrieved | | `output` | object | Campaign report data | -| ↳ `report` | json | Campaign report object | -| ↳ `campaign_id` | string | The unique ID of the campaign | +| ↳ `report` | json | Campaign report object | +| ↳ `campaign_id` | string | The unique ID of the campaign | ### `mailchimp_get_segments` @@ -840,9 +840,9 @@ Retrieve a list of segments from a Mailchimp audience | --------- | ---- | ----------- | | `success` | boolean | Whether the segments were successfully retrieved | | `output` | object | Segments data | -| ↳ `segments` | json | Array of segment objects | -| ↳ `total_items` | number | Total number of segments | -| ↳ `total_returned` | number | Number of segments returned in this response | +| ↳ `segments` | json | Array of segment objects | +| ↳ `total_items` | number | Total number of segments | +| ↳ `total_returned` | number | Number of segments returned in this response | ### `mailchimp_get_segment` @@ -862,8 +862,8 @@ Retrieve details of a specific segment from a Mailchimp audience | --------- | ---- | ----------- | | `success` | boolean | Whether the segment was successfully retrieved | | `output` | object | Segment data | -| ↳ `segment` | json | Segment object | -| ↳ `segment_id` | string | The unique ID of the segment | +| ↳ `segment` | json | Segment object | +| ↳ `segment_id` | string | The unique ID of the segment | ### `mailchimp_create_segment` @@ -884,9 +884,9 @@ Create a new segment in a Mailchimp audience | --------- | ---- | ----------- | | `success` | boolean | Operation success status | | `output` | object | Created segment data | -| ↳ `segment` | json | Created segment object | -| ↳ `segment_id` | string | Created segment ID | -| ↳ `success` | boolean | Operation success | +| ↳ `segment` | json | Created segment object | +| ↳ `segment_id` | string | Created segment ID | +| ↳ `success` | boolean | Operation success | ### `mailchimp_update_segment` @@ -908,9 +908,9 @@ Update an existing segment in a Mailchimp audience | --------- | ---- | ----------- | | `success` | boolean | Operation success status | | `output` | object | Updated segment data | -| ↳ `segment` | object | Updated segment object | -| ↳ `segment_id` | string | Segment ID | -| ↳ `success` | boolean | Operation success | +| ↳ `segment` | object | Updated segment object | +| ↳ `segment_id` | string | Segment ID | +| ↳ `success` | boolean | Operation success | ### `mailchimp_delete_segment` @@ -950,9 +950,9 @@ Retrieve members of a specific segment from a Mailchimp audience | --------- | ---- | ----------- | | `success` | boolean | Whether the segment members were successfully retrieved | | `output` | object | Segment members data | -| ↳ `members` | json | Array of member objects | -| ↳ `total_items` | number | Total number of members | -| ↳ `total_returned` | number | Number of members returned in this response | +| ↳ `members` | json | Array of member objects | +| ↳ `total_items` | number | Total number of members | +| ↳ `total_returned` | number | Number of members returned in this response | ### `mailchimp_add_segment_member` @@ -973,8 +973,8 @@ Add a member to a specific segment in a Mailchimp audience | --------- | ---- | ----------- | | `success` | boolean | Operation success status | | `output` | object | Added member data | -| ↳ `member` | json | Added member object | -| ↳ `success` | boolean | Operation success | +| ↳ `member` | json | Added member object | +| ↳ `success` | boolean | Operation success | ### `mailchimp_remove_segment_member` @@ -995,7 +995,7 @@ Remove a member from a specific segment in a Mailchimp audience | --------- | ---- | ----------- | | `success` | boolean | Operation success status | | `output` | object | Removal confirmation | -| ↳ `success` | boolean | Operation success | +| ↳ `success` | boolean | Operation success | ### `mailchimp_get_member_tags` @@ -1015,9 +1015,9 @@ Retrieve tags associated with a member in a Mailchimp audience | --------- | ---- | ----------- | | `success` | boolean | Whether the member tags were successfully retrieved | | `output` | object | Member tags data | -| ↳ `tags` | json | Array of tag objects | -| ↳ `total_items` | number | Total number of tags | -| ↳ `total_returned` | number | Number of tags returned in this response | +| ↳ `tags` | json | Array of tag objects | +| ↳ `total_items` | number | Total number of tags | +| ↳ `total_returned` | number | Number of tags returned in this response | ### `mailchimp_add_member_tags` @@ -1038,7 +1038,7 @@ Add tags to a member in a Mailchimp audience | --------- | ---- | ----------- | | `success` | boolean | Operation success status | | `output` | object | Tag addition confirmation | -| ↳ `success` | boolean | Operation success | +| ↳ `success` | boolean | Operation success | ### `mailchimp_remove_member_tags` @@ -1059,7 +1059,7 @@ Remove tags from a member in a Mailchimp audience | --------- | ---- | ----------- | | `success` | boolean | Operation success status | | `output` | object | Tag removal confirmation | -| ↳ `success` | boolean | Operation success | +| ↳ `success` | boolean | Operation success | ### `mailchimp_get_merge_fields` @@ -1080,9 +1080,9 @@ Retrieve a list of merge fields from a Mailchimp audience | --------- | ---- | ----------- | | `success` | boolean | Whether the merge fields were successfully retrieved | | `output` | object | Merge fields data | -| ↳ `mergeFields` | json | Array of merge field objects | -| ↳ `total_items` | number | Total number of merge fields | -| ↳ `total_returned` | number | Number of merge fields returned in this response | +| ↳ `mergeFields` | json | Array of merge field objects | +| ↳ `total_items` | number | Total number of merge fields | +| ↳ `total_returned` | number | Number of merge fields returned in this response | ### `mailchimp_get_merge_field` @@ -1102,8 +1102,8 @@ Retrieve details of a specific merge field from a Mailchimp audience | --------- | ---- | ----------- | | `success` | boolean | Whether the merge field was successfully retrieved | | `output` | object | Merge field data | -| ↳ `mergeField` | json | Merge field object | -| ↳ `merge_id` | string | The unique ID of the merge field | +| ↳ `mergeField` | json | Merge field object | +| ↳ `merge_id` | string | The unique ID of the merge field | ### `mailchimp_create_merge_field` @@ -1124,9 +1124,9 @@ Create a new merge field in a Mailchimp audience | --------- | ---- | ----------- | | `success` | boolean | Operation success status | | `output` | object | Created merge field data | -| ↳ `mergeField` | json | Created merge field object | -| ↳ `merge_id` | string | Created merge field ID | -| ↳ `success` | boolean | Operation success | +| ↳ `mergeField` | json | Created merge field object | +| ↳ `merge_id` | string | Created merge field ID | +| ↳ `success` | boolean | Operation success | ### `mailchimp_update_merge_field` @@ -1147,9 +1147,9 @@ Update an existing merge field in a Mailchimp audience | --------- | ---- | ----------- | | `success` | boolean | Operation success status | | `output` | object | Updated merge field data | -| ↳ `mergeField` | object | Updated merge field object | -| ↳ `merge_id` | string | Merge field ID | -| ↳ `success` | boolean | Operation success | +| ↳ `mergeField` | object | Updated merge field object | +| ↳ `merge_id` | string | Merge field ID | +| ↳ `success` | boolean | Operation success | ### `mailchimp_delete_merge_field` @@ -1188,9 +1188,9 @@ Retrieve a list of interest categories from a Mailchimp audience | --------- | ---- | ----------- | | `success` | boolean | Whether the interest categories were successfully retrieved | | `output` | object | Interest categories data | -| ↳ `categories` | json | Array of interest category objects | -| ↳ `total_items` | number | Total number of categories | -| ↳ `total_returned` | number | Number of categories returned in this response | +| ↳ `categories` | json | Array of interest category objects | +| ↳ `total_items` | number | Total number of categories | +| ↳ `total_returned` | number | Number of categories returned in this response | ### `mailchimp_get_interest_category` @@ -1210,8 +1210,8 @@ Retrieve details of a specific interest category from a Mailchimp audience | --------- | ---- | ----------- | | `success` | boolean | Whether the interest category was successfully retrieved | | `output` | object | Interest category data | -| ↳ `category` | json | Interest category object | -| ↳ `interest_category_id` | string | The unique ID of the interest category | +| ↳ `category` | json | Interest category object | +| ↳ `interest_category_id` | string | The unique ID of the interest category | ### `mailchimp_create_interest_category` @@ -1232,9 +1232,9 @@ Create a new interest category in a Mailchimp audience | --------- | ---- | ----------- | | `success` | boolean | Operation success status | | `output` | object | Created interest category data | -| ↳ `category` | json | Created interest category object | -| ↳ `interest_category_id` | string | Created interest category ID | -| ↳ `success` | boolean | Operation success | +| ↳ `category` | json | Created interest category object | +| ↳ `interest_category_id` | string | Created interest category ID | +| ↳ `success` | boolean | Operation success | ### `mailchimp_update_interest_category` @@ -1255,9 +1255,9 @@ Update an existing interest category in a Mailchimp audience | --------- | ---- | ----------- | | `success` | boolean | Operation success status | | `output` | object | Updated interest category data | -| ↳ `category` | object | Updated interest category object | -| ↳ `interest_category_id` | string | Interest category ID | -| ↳ `success` | boolean | Operation success | +| ↳ `category` | object | Updated interest category object | +| ↳ `interest_category_id` | string | Interest category ID | +| ↳ `success` | boolean | Operation success | ### `mailchimp_delete_interest_category` @@ -1297,9 +1297,9 @@ Retrieve a list of interests from an interest category in a Mailchimp audience | --------- | ---- | ----------- | | `success` | boolean | Whether the interests were successfully retrieved | | `output` | object | Interests data | -| ↳ `interests` | json | Array of interest objects | -| ↳ `total_items` | number | Total number of interests | -| ↳ `total_returned` | number | Number of interests returned in this response | +| ↳ `interests` | json | Array of interest objects | +| ↳ `total_items` | number | Total number of interests | +| ↳ `total_returned` | number | Number of interests returned in this response | ### `mailchimp_get_interest` @@ -1320,8 +1320,8 @@ Retrieve details of a specific interest from an interest category in a Mailchimp | --------- | ---- | ----------- | | `success` | boolean | Whether the interest was successfully retrieved | | `output` | object | Interest data | -| ↳ `interest` | json | Interest object | -| ↳ `interest_id` | string | The unique ID of the interest | +| ↳ `interest` | json | Interest object | +| ↳ `interest_id` | string | The unique ID of the interest | ### `mailchimp_create_interest` @@ -1342,9 +1342,9 @@ Create a new interest in an interest category in a Mailchimp audience | --------- | ---- | ----------- | | `success` | boolean | Operation success status | | `output` | object | Created interest data | -| ↳ `interest` | json | Created interest object | -| ↳ `interest_id` | string | Created interest ID | -| ↳ `success` | boolean | Operation success | +| ↳ `interest` | json | Created interest object | +| ↳ `interest_id` | string | Created interest ID | +| ↳ `success` | boolean | Operation success | ### `mailchimp_update_interest` @@ -1366,9 +1366,9 @@ Update an existing interest in an interest category in a Mailchimp audience | --------- | ---- | ----------- | | `success` | boolean | Operation success status | | `output` | object | Updated interest data | -| ↳ `interest` | object | Updated interest object | -| ↳ `interest_id` | string | Interest ID | -| ↳ `success` | boolean | Operation success | +| ↳ `interest` | object | Updated interest object | +| ↳ `interest_id` | string | Interest ID | +| ↳ `success` | boolean | Operation success | ### `mailchimp_delete_interest` @@ -1407,9 +1407,9 @@ Retrieve a list of landing pages from Mailchimp | --------- | ---- | ----------- | | `success` | boolean | Whether the landing pages were successfully retrieved | | `output` | object | Landing pages data | -| ↳ `landingPages` | json | Array of landing page objects | -| ↳ `total_items` | number | Total number of landing pages | -| ↳ `total_returned` | number | Number of landing pages returned in this response | +| ↳ `landingPages` | json | Array of landing page objects | +| ↳ `total_items` | number | Total number of landing pages | +| ↳ `total_returned` | number | Number of landing pages returned in this response | ### `mailchimp_get_landing_page` @@ -1428,8 +1428,8 @@ Retrieve details of a specific landing page from Mailchimp | --------- | ---- | ----------- | | `success` | boolean | Whether the landing page was successfully retrieved | | `output` | object | Landing page data | -| ↳ `landingPage` | json | Landing page object | -| ↳ `page_id` | string | The unique ID of the landing page | +| ↳ `landingPage` | json | Landing page object | +| ↳ `page_id` | string | The unique ID of the landing page | ### `mailchimp_create_landing_page` @@ -1449,9 +1449,9 @@ Create a new landing page in Mailchimp | --------- | ---- | ----------- | | `success` | boolean | Operation success status | | `output` | object | Created landing page data | -| ↳ `landingPage` | json | Created landing page object | -| ↳ `page_id` | string | Created landing page ID | -| ↳ `success` | boolean | Operation success | +| ↳ `landingPage` | json | Created landing page object | +| ↳ `page_id` | string | Created landing page ID | +| ↳ `success` | boolean | Operation success | ### `mailchimp_update_landing_page` @@ -1471,9 +1471,9 @@ Update an existing landing page in Mailchimp | --------- | ---- | ----------- | | `success` | boolean | Operation success status | | `output` | object | Updated landing page data | -| ↳ `landingPage` | object | Updated landing page object | -| ↳ `page_id` | string | Landing page ID | -| ↳ `success` | boolean | Operation success | +| ↳ `landingPage` | object | Updated landing page object | +| ↳ `page_id` | string | Landing page ID | +| ↳ `success` | boolean | Operation success | ### `mailchimp_delete_landing_page` @@ -1509,7 +1509,7 @@ Publish a landing page in Mailchimp | --------- | ---- | ----------- | | `success` | boolean | Operation success status | | `output` | object | Publish confirmation | -| ↳ `success` | boolean | Operation success | +| ↳ `success` | boolean | Operation success | ### `mailchimp_unpublish_landing_page` @@ -1528,7 +1528,7 @@ Unpublish a landing page in Mailchimp | --------- | ---- | ----------- | | `success` | boolean | Operation success status | | `output` | object | Unpublish confirmation | -| ↳ `success` | boolean | Operation success | +| ↳ `success` | boolean | Operation success | ### `mailchimp_get_batch_operations` @@ -1548,9 +1548,9 @@ Retrieve a list of batch operations from Mailchimp | --------- | ---- | ----------- | | `success` | boolean | Whether the batch operations were successfully retrieved | | `output` | object | Batch operations data | -| ↳ `batches` | json | Array of batch operation objects | -| ↳ `total_items` | number | Total number of batch operations | -| ↳ `total_returned` | number | Number of batch operations returned in this response | +| ↳ `batches` | json | Array of batch operation objects | +| ↳ `total_items` | number | Total number of batch operations | +| ↳ `total_returned` | number | Number of batch operations returned in this response | ### `mailchimp_get_batch_operation` @@ -1569,8 +1569,8 @@ Retrieve details of a specific batch operation from Mailchimp | --------- | ---- | ----------- | | `success` | boolean | Whether the batch operation was successfully retrieved | | `output` | object | Batch operation data | -| ↳ `batch` | json | Batch operation object | -| ↳ `batch_id` | string | The unique ID of the batch operation | +| ↳ `batch` | json | Batch operation object | +| ↳ `batch_id` | string | The unique ID of the batch operation | ### `mailchimp_create_batch_operation` @@ -1589,9 +1589,9 @@ Create a new batch operation in Mailchimp | --------- | ---- | ----------- | | `success` | boolean | Operation success status | | `output` | object | Created batch operation data | -| ↳ `batch` | json | Created batch operation object | -| ↳ `batch_id` | string | Created batch operation ID | -| ↳ `success` | boolean | Operation success | +| ↳ `batch` | json | Created batch operation object | +| ↳ `batch_id` | string | Created batch operation ID | +| ↳ `success` | boolean | Operation success | ### `mailchimp_delete_batch_operation` diff --git a/apps/docs/content/docs/en/tools/mem0.mdx b/apps/docs/content/docs/en/tools/mem0.mdx index 680c13077..120f825cb 100644 --- a/apps/docs/content/docs/en/tools/mem0.mdx +++ b/apps/docs/content/docs/en/tools/mem0.mdx @@ -52,6 +52,10 @@ Add memories to Mem0 for persistent storage and retrieval | --------- | ---- | ----------- | | `ids` | array | Array of memory IDs that were created | | `memories` | array | Array of memory objects that were created | +| ↳ `id` | string | Unique identifier for the memory | +| ↳ `memory` | string | The content of the memory | +| ↳ `event` | string | Event type indicating operation performed \(ADD, UPDATE, DELETE, NOOP\) | +| ↳ `metadata` | json | Custom metadata associated with the memory | ### `mem0_search_memories` @@ -70,7 +74,19 @@ Search for memories in Mem0 using semantic search | Parameter | Type | Description | | --------- | ---- | ----------- | -| `searchResults` | array | Array of search results with memory data, each containing id, data, and score | +| `searchResults` | array | Array of search results with memory data and similarity scores | +| ↳ `id` | string | Unique identifier for the memory | +| ↳ `memory` | string | The content of the memory | +| ↳ `user_id` | string | User ID associated with this memory | +| ↳ `agent_id` | string | Agent ID associated with this memory | +| ↳ `app_id` | string | App ID associated with this memory | +| ↳ `run_id` | string | Run/session ID associated with this memory | +| ↳ `hash` | string | Hash of the memory content | +| ↳ `metadata` | json | Custom metadata associated with the memory | +| ↳ `categories` | json | Auto-assigned categories for the memory | +| ↳ `created_at` | string | ISO 8601 timestamp when the memory was created | +| ↳ `updated_at` | string | ISO 8601 timestamp when the memory was last updated | +| ↳ `score` | number | Similarity score from vector search | | `ids` | array | Array of memory IDs found in the search results | ### `mem0_get_memories` @@ -93,6 +109,21 @@ Retrieve memories from Mem0 by ID or filter criteria | Parameter | Type | Description | | --------- | ---- | ----------- | | `memories` | array | Array of retrieved memory objects | +| ↳ `id` | string | Unique identifier for the memory | +| ↳ `memory` | string | The content of the memory | +| ↳ `user_id` | string | User ID associated with this memory | +| ↳ `agent_id` | string | Agent ID associated with this memory | +| ↳ `app_id` | string | App ID associated with this memory | +| ↳ `run_id` | string | Run/session ID associated with this memory | +| ↳ `hash` | string | Hash of the memory content | +| ↳ `metadata` | json | Custom metadata associated with the memory | +| ↳ `categories` | json | Auto-assigned categories for the memory | +| ↳ `created_at` | string | ISO 8601 timestamp when the memory was created | +| ↳ `updated_at` | string | ISO 8601 timestamp when the memory was last updated | +| ↳ `owner` | string | Owner of the memory | +| ↳ `organization` | string | Organization associated with the memory | +| ↳ `immutable` | boolean | Whether the memory can be modified | +| ↳ `expiration_date` | string | Expiration date after which memory is not retrieved | | `ids` | array | Array of memory IDs that were retrieved | diff --git a/apps/docs/content/docs/en/tools/meta.json b/apps/docs/content/docs/en/tools/meta.json index 0c5635a23..d71daf186 100644 --- a/apps/docs/content/docs/en/tools/meta.json +++ b/apps/docs/content/docs/en/tools/meta.json @@ -9,6 +9,7 @@ "arxiv", "asana", "browser_use", + "calcom", "calendly", "circleback", "clay", diff --git a/apps/docs/content/docs/en/tools/microsoft_excel.mdx b/apps/docs/content/docs/en/tools/microsoft_excel.mdx index 65a8eaa5d..c93efc9ea 100644 --- a/apps/docs/content/docs/en/tools/microsoft_excel.mdx +++ b/apps/docs/content/docs/en/tools/microsoft_excel.mdx @@ -55,8 +55,8 @@ Read data from a specific sheet in a Microsoft Excel spreadsheet | `range` | string | The range that was read | | `values` | array | Array of rows containing cell values | | `metadata` | json | Spreadsheet metadata including ID and URL | -| ↳ `spreadsheetId` | string | Microsoft Excel spreadsheet ID | -| ↳ `spreadsheetUrl` | string | Spreadsheet URL | +| ↳ `spreadsheetId` | string | Microsoft Excel spreadsheet ID | +| ↳ `spreadsheetUrl` | string | Spreadsheet URL | ### `microsoft_excel_write` @@ -81,7 +81,7 @@ Write data to a specific sheet in a Microsoft Excel spreadsheet | `updatedColumns` | number | Number of columns updated | | `updatedCells` | number | Number of cells updated | | `metadata` | json | Spreadsheet metadata including ID and URL | -| ↳ `spreadsheetId` | string | Microsoft Excel spreadsheet ID | -| ↳ `spreadsheetUrl` | string | Spreadsheet URL | +| ↳ `spreadsheetId` | string | Microsoft Excel spreadsheet ID | +| ↳ `spreadsheetUrl` | string | Spreadsheet URL | diff --git a/apps/docs/content/docs/en/tools/microsoft_planner.mdx b/apps/docs/content/docs/en/tools/microsoft_planner.mdx index 1041e9fd5..6067e8199 100644 --- a/apps/docs/content/docs/en/tools/microsoft_planner.mdx +++ b/apps/docs/content/docs/en/tools/microsoft_planner.mdx @@ -50,9 +50,9 @@ Read tasks from Microsoft Planner - get all user tasks or all tasks from a speci | `success` | boolean | Whether tasks were retrieved successfully | | `tasks` | array | Array of task objects with filtered properties | | `metadata` | object | Metadata including planId, userId, and planUrl | -| ↳ `planId` | string | Plan ID | -| ↳ `userId` | string | User ID | -| ↳ `planUrl` | string | Microsoft Graph API URL for the plan | +| ↳ `planId` | string | Plan ID | +| ↳ `userId` | string | User ID | +| ↳ `planUrl` | string | Microsoft Graph API URL for the plan | ### `microsoft_planner_create_task` @@ -76,9 +76,9 @@ Create a new task in Microsoft Planner | `success` | boolean | Whether the task was created successfully | | `task` | object | The created task object with all properties | | `metadata` | object | Metadata including planId, taskId, and taskUrl | -| ↳ `planId` | string | Parent plan ID | -| ↳ `taskId` | string | Created task ID | -| ↳ `taskUrl` | string | Microsoft Graph API URL for the task | +| ↳ `planId` | string | Parent plan ID | +| ↳ `taskId` | string | Created task ID | +| ↳ `taskUrl` | string | Microsoft Graph API URL for the task | ### `microsoft_planner_update_task` @@ -108,9 +108,9 @@ Update a task in Microsoft Planner | `taskId` | string | ID of the updated task | | `etag` | string | New ETag after update - use this for subsequent operations | | `metadata` | object | Metadata including taskId, planId, and taskUrl | -| ↳ `taskId` | string | Updated task ID | -| ↳ `planId` | string | Parent plan ID | -| ↳ `taskUrl` | string | Microsoft Graph API URL for the task | +| ↳ `taskId` | string | Updated task ID | +| ↳ `planId` | string | Parent plan ID | +| ↳ `taskUrl` | string | Microsoft Graph API URL for the task | ### `microsoft_planner_delete_task` @@ -147,8 +147,8 @@ List all plans shared with the current user | `success` | boolean | Whether plans were retrieved successfully | | `plans` | array | Array of plan objects shared with the current user | | `metadata` | object | Metadata including userId and count | -| ↳ `count` | number | Number of plans returned | -| ↳ `userId` | string | User ID | +| ↳ `count` | number | Number of plans returned | +| ↳ `userId` | string | User ID | ### `microsoft_planner_read_plan` @@ -167,8 +167,8 @@ Get details of a specific Microsoft Planner plan | `success` | boolean | Whether the plan was retrieved successfully | | `plan` | object | The plan object with all properties | | `metadata` | object | Metadata including planId and planUrl | -| ↳ `planId` | string | Plan ID | -| ↳ `planUrl` | string | Microsoft Graph API URL for the plan | +| ↳ `planId` | string | Plan ID | +| ↳ `planUrl` | string | Microsoft Graph API URL for the plan | ### `microsoft_planner_list_buckets` @@ -187,8 +187,8 @@ List all buckets in a Microsoft Planner plan | `success` | boolean | Whether buckets were retrieved successfully | | `buckets` | array | Array of bucket objects | | `metadata` | object | Metadata including planId and count | -| ↳ `planId` | string | Plan ID | -| ↳ `count` | number | Number of buckets returned | +| ↳ `planId` | string | Plan ID | +| ↳ `count` | number | Number of buckets returned | ### `microsoft_planner_read_bucket` @@ -207,8 +207,8 @@ Get details of a specific bucket | `success` | boolean | Whether the bucket was retrieved successfully | | `bucket` | object | The bucket object with all properties | | `metadata` | object | Metadata including bucketId and planId | -| ↳ `bucketId` | string | Bucket ID | -| ↳ `planId` | string | Parent plan ID | +| ↳ `bucketId` | string | Bucket ID | +| ↳ `planId` | string | Parent plan ID | ### `microsoft_planner_create_bucket` @@ -228,8 +228,8 @@ Create a new bucket in a Microsoft Planner plan | `success` | boolean | Whether the bucket was created successfully | | `bucket` | object | The created bucket object with all properties | | `metadata` | object | Metadata including bucketId and planId | -| ↳ `bucketId` | string | Created bucket ID | -| ↳ `planId` | string | Parent plan ID | +| ↳ `bucketId` | string | Created bucket ID | +| ↳ `planId` | string | Parent plan ID | ### `microsoft_planner_update_bucket` @@ -250,8 +250,8 @@ Update a bucket in Microsoft Planner | `success` | boolean | Whether the bucket was updated successfully | | `bucket` | object | The updated bucket object with all properties | | `metadata` | object | Metadata including bucketId and planId | -| ↳ `bucketId` | string | Updated bucket ID | -| ↳ `planId` | string | Parent plan ID | +| ↳ `bucketId` | string | Updated bucket ID | +| ↳ `planId` | string | Parent plan ID | ### `microsoft_planner_delete_bucket` @@ -290,7 +290,7 @@ Get detailed information about a task including checklist and references | `taskDetails` | object | The task details including description, checklist, and references | | `etag` | string | The ETag value for this task details - use this for update operations | | `metadata` | object | Metadata including taskId | -| ↳ `taskId` | string | Task ID | +| ↳ `taskId` | string | Task ID | ### `microsoft_planner_update_task_details` @@ -314,6 +314,6 @@ Update task details including description, checklist items, and references in Mi | `success` | boolean | Whether the task details were updated successfully | | `taskDetails` | object | The updated task details object with all properties | | `metadata` | object | Metadata including taskId | -| ↳ `taskId` | string | Task ID | +| ↳ `taskId` | string | Task ID | diff --git a/apps/docs/content/docs/en/tools/microsoft_teams.mdx b/apps/docs/content/docs/en/tools/microsoft_teams.mdx index 44fd26e2e..7603f76fc 100644 --- a/apps/docs/content/docs/en/tools/microsoft_teams.mdx +++ b/apps/docs/content/docs/en/tools/microsoft_teams.mdx @@ -254,15 +254,15 @@ Get a specific message from a Microsoft Teams chat or channel | `success` | boolean | Whether the retrieval was successful | | `content` | string | The message content | | `metadata` | object | Message metadata including sender, timestamp, etc. | -| ↳ `messageId` | string | Message ID | -| ↳ `content` | string | Message content | -| ↳ `createdTime` | string | Message creation timestamp | -| ↳ `url` | string | Web URL to the message | -| ↳ `teamId` | string | Team ID | -| ↳ `channelId` | string | Channel ID | -| ↳ `chatId` | string | Chat ID | -| ↳ `messages` | array | Array of message details | -| ↳ `messageCount` | number | Number of messages | +| ↳ `messageId` | string | Message ID | +| ↳ `content` | string | Message content | +| ↳ `createdTime` | string | Message creation timestamp | +| ↳ `url` | string | Web URL to the message | +| ↳ `teamId` | string | Team ID | +| ↳ `channelId` | string | Channel ID | +| ↳ `chatId` | string | Chat ID | +| ↳ `messages` | array | Array of message details | +| ↳ `messageCount` | number | Number of messages | ### `microsoft_teams_set_reaction` diff --git a/apps/docs/content/docs/en/tools/mistral_parse.mdx b/apps/docs/content/docs/en/tools/mistral_parse.mdx index 1e2e9311a..711f74391 100644 --- a/apps/docs/content/docs/en/tools/mistral_parse.mdx +++ b/apps/docs/content/docs/en/tools/mistral_parse.mdx @@ -58,24 +58,24 @@ Parse PDF documents using Mistral OCR API | ↳ `index` | number | Page index \(zero-based\) | | ↳ `markdown` | string | Extracted markdown content | | ↳ `images` | array | Images extracted from this page with bounding boxes | -| ↳ `id` | string | Image identifier \(e.g., img-0.jpeg\) | -| ↳ `top_left_x` | number | Top-left X coordinate in pixels | -| ↳ `top_left_y` | number | Top-left Y coordinate in pixels | -| ↳ `bottom_right_x` | number | Bottom-right X coordinate in pixels | -| ↳ `bottom_right_y` | number | Bottom-right Y coordinate in pixels | -| ↳ `image_base64` | string | Base64-encoded image data \(when include_image_base64=true\) | +| ↳ `id` | string | Image identifier \(e.g., img-0.jpeg\) | +| ↳ `top_left_x` | number | Top-left X coordinate in pixels | +| ↳ `top_left_y` | number | Top-left Y coordinate in pixels | +| ↳ `bottom_right_x` | number | Bottom-right X coordinate in pixels | +| ↳ `bottom_right_y` | number | Bottom-right Y coordinate in pixels | +| ↳ `image_base64` | string | Base64-encoded image data \(when include_image_base64=true\) | | ↳ `dimensions` | object | Page dimensions | -| ↳ `dpi` | number | Dots per inch | -| ↳ `height` | number | Page height in pixels | -| ↳ `width` | number | Page width in pixels | +| ↳ `dpi` | number | Dots per inch | +| ↳ `height` | number | Page height in pixels | +| ↳ `width` | number | Page width in pixels | | ↳ `tables` | array | Extracted tables as HTML/markdown \(when table_format is set\). Referenced via placeholders like \[tbl-0.html\] | -| ↳ `hyperlinks` | array | Array of URL strings detected in the page \(e.g., \[ | +| ↳ `hyperlinks` | array | Array of URL strings detected in the page \(e.g., \["https://...", "mailto:..."\]\) | | ↳ `header` | string | Page header content \(when extract_header=true\) | | ↳ `footer` | string | Page footer content \(when extract_footer=true\) | | `model` | string | Mistral OCR model identifier \(e.g., mistral-ocr-latest\) | | `usage_info` | object | Usage and processing statistics | -| ↳ `pages_processed` | number | Total number of pages processed | -| ↳ `doc_size_bytes` | number | Document file size in bytes | +| ↳ `pages_processed` | number | Total number of pages processed | +| ↳ `doc_size_bytes` | number | Document file size in bytes | | `document_annotation` | string | Structured annotation data as JSON string \(when applicable\) | diff --git a/apps/docs/content/docs/en/tools/notion.mdx b/apps/docs/content/docs/en/tools/notion.mdx index 31eeac027..a64ef1744 100644 --- a/apps/docs/content/docs/en/tools/notion.mdx +++ b/apps/docs/content/docs/en/tools/notion.mdx @@ -32,11 +32,11 @@ Read content from a Notion page | Parameter | Type | Description | | --------- | ---- | ----------- | +| `url` | string | Notion page URL | +| `created_time` | string | ISO 8601 creation timestamp | +| `last_edited_time` | string | ISO 8601 last edit timestamp | | `content` | string | Page content in markdown format | | `title` | string | Page title | -| `url` | string | Page URL | -| `created_time` | string | Creation timestamp | -| `last_edited_time` | string | Last edit timestamp | ### `notion_read_database` @@ -52,12 +52,12 @@ Read database information and structure from Notion | Parameter | Type | Description | | --------- | ---- | ----------- | -| `id` | string | Database ID | -| `title` | string | Database title | -| `url` | string | Database URL | -| `created_time` | string | Creation timestamp | -| `last_edited_time` | string | Last edit timestamp | +| `id` | string | Database UUID | +| `url` | string | Notion database URL | +| `created_time` | string | ISO 8601 creation timestamp | +| `last_edited_time` | string | ISO 8601 last edit timestamp | | `properties` | object | Database properties schema | +| `title` | string | Database title | ### `notion_write` @@ -92,11 +92,11 @@ Create a new page in Notion | Parameter | Type | Description | | --------- | ---- | ----------- | -| `id` | string | Page ID | +| `id` | string | Page UUID | +| `url` | string | Notion page URL | +| `created_time` | string | ISO 8601 creation timestamp | +| `last_edited_time` | string | ISO 8601 last edit timestamp | | `title` | string | Page title | -| `url` | string | Page URL | -| `created_time` | string | Creation timestamp | -| `last_edited_time` | string | Last edit timestamp | ### `notion_query_database` @@ -115,13 +115,43 @@ Query and filter Notion database entries with advanced filtering | Parameter | Type | Description | | --------- | ---- | ----------- | -| `results` | array | Array of Notion page objects from the database | -| ↳ `id` | string | Page ID | -| ↳ `created_time` | string | Creation timestamp | -| ↳ `last_edited_time` | string | Last edit timestamp | -| ↳ `url` | string | Page URL | +| `results` | array | Array of page objects from the database | +| ↳ `object` | string | Always "page" | +| ↳ `id` | string | Page UUID | +| ↳ `created_time` | string | ISO 8601 creation timestamp | +| ↳ `last_edited_time` | string | ISO 8601 last edit timestamp | +| ↳ `created_by` | object | Partial user object | +| ↳ `object` | string | Always "user" | +| ↳ `id` | string | User UUID | +| ↳ `last_edited_by` | object | Partial user object | +| ↳ `object` | string | Always "user" | +| ↳ `id` | string | User UUID | +| ↳ `archived` | boolean | Whether the page is archived | +| ↳ `in_trash` | boolean | Whether the page is in trash | +| ↳ `url` | string | Notion page URL | +| ↳ `public_url` | string | Public web URL if shared, null otherwise | +| ↳ `parent` | object | Parent object specifying hierarchical relationship | +| ↳ `type` | string | Parent type: "database_id", "data_source_id", "page_id", "workspace", or "block_id" | +| ↳ `database_id` | string | Parent database UUID \(if type is database_id\) | +| ↳ `data_source_id` | string | Parent data source UUID \(if type is data_source_id\) | +| ↳ `page_id` | string | Parent page UUID \(if type is page_id\) | +| ↳ `workspace` | boolean | True if parent is workspace \(if type is workspace\) | +| ↳ `block_id` | string | Parent block UUID \(if type is block_id\) | +| ↳ `icon` | object | Page/database icon \(emoji, custom_emoji, or file\) | +| ↳ `url` | string | Authenticated URL valid for one hour | +| ↳ `expiry_time` | string | ISO 8601 timestamp when URL expires | +| ↳ `cover` | object | Page/database cover image | +| ↳ `type` | string | File type: "file", "file_upload", or "external" | +| ↳ `file` | object | Notion-hosted file object \(when type is "file"\) | +| ↳ `url` | string | Authenticated URL valid for one hour | +| ↳ `expiry_time` | string | ISO 8601 timestamp when URL expires | +| ↳ `file_upload` | object | API-uploaded file object \(when type is "file_upload"\) | +| ↳ `id` | string | File upload UUID | +| ↳ `external` | object | External file object \(when type is "external"\) | +| ↳ `url` | string | External file URL \(never expires\) | +| ↳ `properties` | object | Page property values \(structure depends on parent type - database properties or title only\) | | `has_more` | boolean | Whether more results are available | -| `next_cursor` | string | Cursor for pagination | +| `next_cursor` | string | Cursor for next page of results | | `total_results` | number | Number of results returned | ### `notion_search` @@ -140,14 +170,31 @@ Search across all pages and databases in Notion workspace | Parameter | Type | Description | | --------- | ---- | ----------- | -| `results` | array | Array of search results \(pages and databases\) | -| ↳ `id` | string | Object ID | -| ↳ `object` | string | Object type \(page or database\) | +| `results` | array | Array of search results \(pages and/or databases\) | +| ↳ `object` | string | Object type: "page" or "database" | +| ↳ `id` | string | Object UUID | +| ↳ `created_time` | string | ISO 8601 creation timestamp | +| ↳ `last_edited_time` | string | ISO 8601 last edit timestamp | +| ↳ `created_by` | object | Partial user object | +| ↳ `object` | string | Always "user" | +| ↳ `id` | string | User UUID | +| ↳ `last_edited_by` | object | Partial user object | +| ↳ `object` | string | Always "user" | +| ↳ `id` | string | User UUID | +| ↳ `archived` | boolean | Whether the object is archived | +| ↳ `in_trash` | boolean | Whether the object is in trash | | ↳ `url` | string | Object URL | -| ↳ `created_time` | string | Creation timestamp | -| ↳ `last_edited_time` | string | Last edit timestamp | +| ↳ `public_url` | string | Public web URL if shared | +| ↳ `parent` | object | Parent object specifying hierarchical relationship | +| ↳ `type` | string | Parent type: "database_id", "data_source_id", "page_id", "workspace", or "block_id" | +| ↳ `database_id` | string | Parent database UUID \(if type is database_id\) | +| ↳ `data_source_id` | string | Parent data source UUID \(if type is data_source_id\) | +| ↳ `page_id` | string | Parent page UUID \(if type is page_id\) | +| ↳ `workspace` | boolean | True if parent is workspace \(if type is workspace\) | +| ↳ `block_id` | string | Parent block UUID \(if type is block_id\) | +| ↳ `properties` | object | Object properties | | `has_more` | boolean | Whether more results are available | -| `next_cursor` | string | Cursor for pagination | +| `next_cursor` | string | Cursor for next page of results | | `total_results` | number | Number of results returned | ### `notion_create_database` @@ -166,11 +213,11 @@ Create a new database in Notion with custom properties | Parameter | Type | Description | | --------- | ---- | ----------- | -| `id` | string | Database ID | -| `title` | string | Database title | -| `url` | string | Database URL | -| `created_time` | string | Creation timestamp | +| `id` | string | Database UUID | +| `url` | string | Notion database URL | +| `created_time` | string | ISO 8601 creation timestamp | | `properties` | object | Database properties schema | +| `title` | string | Database title | ### `notion_add_database_row` @@ -187,10 +234,10 @@ Add a new row to a Notion database with specified properties | Parameter | Type | Description | | --------- | ---- | ----------- | -| `id` | string | Page/row ID | -| `url` | string | Page/row URL | +| `id` | string | Page UUID | +| `url` | string | Notion page URL | +| `created_time` | string | ISO 8601 creation timestamp | +| `last_edited_time` | string | ISO 8601 last edit timestamp | | `title` | string | Row title | -| `created_time` | string | Creation timestamp | -| `last_edited_time` | string | Last edit timestamp | diff --git a/apps/docs/content/docs/en/tools/openai.mdx b/apps/docs/content/docs/en/tools/openai.mdx index ca8b5ccd4..e83dd7472 100644 --- a/apps/docs/content/docs/en/tools/openai.mdx +++ b/apps/docs/content/docs/en/tools/openai.mdx @@ -54,10 +54,10 @@ Generate embeddings from text using OpenAI | --------- | ---- | ----------- | | `success` | boolean | Operation success status | | `output` | object | Embeddings generation results | -| ↳ `embeddings` | array | Array of embedding vectors | -| ↳ `model` | string | Model used for generating embeddings | -| ↳ `usage` | object | Token usage information | -| ↳ `prompt_tokens` | number | Number of tokens in the prompt | -| ↳ `total_tokens` | number | Total number of tokens used | +| ↳ `embeddings` | array | Array of embedding vectors | +| ↳ `model` | string | Model used for generating embeddings | +| ↳ `usage` | object | Token usage information | +| ↳ `prompt_tokens` | number | Number of tokens in the prompt | +| ↳ `total_tokens` | number | Total number of tokens used | diff --git a/apps/docs/content/docs/en/tools/outlook.mdx b/apps/docs/content/docs/en/tools/outlook.mdx index c37de8033..df2326693 100644 --- a/apps/docs/content/docs/en/tools/outlook.mdx +++ b/apps/docs/content/docs/en/tools/outlook.mdx @@ -115,6 +115,29 @@ Read emails from Outlook | --------- | ---- | ----------- | | `message` | string | Success or status message | | `results` | array | Array of email message objects | +| ↳ `id` | string | Unique message identifier | +| ↳ `subject` | string | Email subject | +| ↳ `bodyPreview` | string | Preview of the message body | +| ↳ `body` | object | Message body | +| ↳ `contentType` | string | Body content type \(text or html\) | +| ↳ `content` | string | Body content | +| ↳ `sender` | object | Sender information | +| ↳ `name` | string | Display name of the person or entity | +| ↳ `address` | string | Email address | +| ↳ `from` | object | From address information | +| ↳ `name` | string | Display name of the person or entity | +| ↳ `address` | string | Email address | +| ↳ `toRecipients` | array | To recipients | +| ↳ `name` | string | Display name of the person or entity | +| ↳ `address` | string | Email address | +| ↳ `ccRecipients` | array | CC recipients | +| ↳ `name` | string | Display name of the person or entity | +| ↳ `address` | string | Email address | +| ↳ `receivedDateTime` | string | When the message was received \(ISO 8601\) | +| ↳ `sentDateTime` | string | When the message was sent \(ISO 8601\) | +| ↳ `hasAttachments` | boolean | Whether the message has attachments | +| ↳ `isRead` | boolean | Whether the message has been read | +| ↳ `importance` | string | Message importance \(low, normal, high\) | | `attachments` | file[] | All email attachments flattened from all emails | ### `outlook_forward` @@ -135,12 +158,12 @@ Forward an existing Outlook message to specified recipients | --------- | ---- | ----------- | | `message` | string | Success or error message | | `results` | object | Delivery result details | -| ↳ `status` | string | Delivery status of the email | -| ↳ `timestamp` | string | Timestamp when email was forwarded | -| ↳ `httpStatus` | number | HTTP status code returned by the API | -| ↳ `requestId` | string | Microsoft Graph request-id header for tracing | -| ↳ `messageId` | string | Forwarded message ID if provided by API | -| ↳ `internetMessageId` | string | RFC 822 Message-ID if provided | +| ↳ `status` | string | Delivery status of the email | +| ↳ `timestamp` | string | Timestamp when email was forwarded | +| ↳ `httpStatus` | number | HTTP status code returned by the API | +| ↳ `requestId` | string | Microsoft Graph request-id header for tracing | +| ↳ `messageId` | string | Forwarded message ID if provided by API | +| ↳ `internetMessageId` | string | RFC 822 Message-ID if provided | ### `outlook_move` diff --git a/apps/docs/content/docs/en/tools/parallel_ai.mdx b/apps/docs/content/docs/en/tools/parallel_ai.mdx index cf4ba42ba..733b9bc23 100644 --- a/apps/docs/content/docs/en/tools/parallel_ai.mdx +++ b/apps/docs/content/docs/en/tools/parallel_ai.mdx @@ -109,9 +109,9 @@ Conduct comprehensive deep research across the web using Parallel AI. Synthesize | ↳ `field` | string | Output field name | | ↳ `reasoning` | string | Explanation for the result | | ↳ `citations` | array | Array of sources | -| ↳ `url` | string | Source URL | -| ↳ `title` | string | Source title | -| ↳ `excerpts` | array | Relevant excerpts from the source | +| ↳ `url` | string | Source URL | +| ↳ `title` | string | Source title | +| ↳ `excerpts` | array | Relevant excerpts from the source | | ↳ `confidence` | string | Confidence level indicator | diff --git a/apps/docs/content/docs/en/tools/perplexity.mdx b/apps/docs/content/docs/en/tools/perplexity.mdx index 5f3177c00..10311c030 100644 --- a/apps/docs/content/docs/en/tools/perplexity.mdx +++ b/apps/docs/content/docs/en/tools/perplexity.mdx @@ -57,9 +57,9 @@ Generate completions using Perplexity AI chat models | `content` | string | Generated text content | | `model` | string | Model used for generation | | `usage` | object | Token usage information | -| ↳ `prompt_tokens` | number | Number of tokens in the prompt | -| ↳ `completion_tokens` | number | Number of tokens in the completion | -| ↳ `total_tokens` | number | Total number of tokens used | +| ↳ `prompt_tokens` | number | Number of tokens in the prompt | +| ↳ `completion_tokens` | number | Number of tokens in the completion | +| ↳ `total_tokens` | number | Total number of tokens used | ### `perplexity_search` @@ -87,7 +87,7 @@ Get ranked search results from Perplexity | ↳ `title` | string | Title of the search result | | ↳ `url` | string | URL of the search result | | ↳ `snippet` | string | Brief excerpt or summary of the content | -| ↳ `date` | string | Date the page was crawled and added to Perplexity | -| ↳ `last_updated` | string | Date the page was last updated in Perplexity | +| ↳ `date` | string | Date the page was crawled and added to Perplexity's index | +| ↳ `last_updated` | string | Date the page was last updated in Perplexity's index | diff --git a/apps/docs/content/docs/en/tools/pinecone.mdx b/apps/docs/content/docs/en/tools/pinecone.mdx index 25c5751c4..bb6b35b4e 100644 --- a/apps/docs/content/docs/en/tools/pinecone.mdx +++ b/apps/docs/content/docs/en/tools/pinecone.mdx @@ -101,9 +101,9 @@ Search for similar text in a Pinecone index | ↳ `score` | number | Similarity score | | ↳ `metadata` | object | Associated metadata | | `usage` | object | Usage statistics including tokens, read units, and rerank units | -| ↳ `total_tokens` | number | Total tokens used for embedding | -| ↳ `read_units` | number | Read units consumed | -| ↳ `rerank_units` | number | Rerank units used | +| ↳ `total_tokens` | number | Total tokens used for embedding | +| ↳ `read_units` | number | Read units consumed | +| ↳ `rerank_units` | number | Rerank units used | ### `pinecone_search_vector` @@ -155,6 +155,6 @@ Fetch vectors by ID from a Pinecone index | ↳ `values` | array | Vector values | | ↳ `vector_type` | string | Vector type \(dense/sparse\) | | `usage` | object | Usage statistics including total read units | -| ↳ `total_tokens` | number | Read units consumed | +| ↳ `total_tokens` | number | Read units consumed | diff --git a/apps/docs/content/docs/en/tools/pipedrive.mdx b/apps/docs/content/docs/en/tools/pipedrive.mdx index d561b8075..16db1bc99 100644 --- a/apps/docs/content/docs/en/tools/pipedrive.mdx +++ b/apps/docs/content/docs/en/tools/pipedrive.mdx @@ -55,7 +55,25 @@ Retrieve all deals from Pipedrive with optional filters | Parameter | Type | Description | | --------- | ---- | ----------- | | `deals` | array | Array of deal objects from Pipedrive | +| ↳ `id` | number | Deal ID | +| ↳ `title` | string | Deal title | +| ↳ `value` | number | Deal value | +| ↳ `currency` | string | Currency code | +| ↳ `status` | string | Deal status \(open, won, lost, deleted\) | +| ↳ `stage_id` | number | Pipeline stage ID | +| ↳ `pipeline_id` | number | Pipeline ID | +| ↳ `person_id` | number | Associated person ID | +| ↳ `org_id` | number | Associated organization ID | +| ↳ `owner_id` | number | Deal owner user ID | +| ↳ `add_time` | string | When the deal was created \(ISO 8601\) | +| ↳ `update_time` | string | When the deal was last updated \(ISO 8601\) | +| ↳ `won_time` | string | When the deal was won | +| ↳ `lost_time` | string | When the deal was lost | +| ↳ `close_time` | string | When the deal was closed | +| ↳ `expected_close_date` | string | Expected close date | | `metadata` | object | Pagination metadata for the response | +| ↳ `total_items` | number | Total number of items | +| ↳ `has_more` | boolean | Whether more items are available | | `success` | boolean | Operation success status | ### `pipedrive_get_deal` @@ -140,6 +158,16 @@ Retrieve files from Pipedrive with optional filters | Parameter | Type | Description | | --------- | ---- | ----------- | | `files` | array | Array of file objects from Pipedrive | +| ↳ `id` | number | File ID | +| ↳ `name` | string | File name | +| ↳ `file_type` | string | File type/extension | +| ↳ `file_size` | number | File size in bytes | +| ↳ `add_time` | string | When the file was uploaded | +| ↳ `update_time` | string | When the file was last updated | +| ↳ `deal_id` | number | Associated deal ID | +| ↳ `person_id` | number | Associated person ID | +| ↳ `org_id` | number | Associated organization ID | +| ↳ `url` | string | File download URL | | `total_items` | number | Total number of files returned | | `success` | boolean | Operation success status | @@ -198,6 +226,14 @@ Retrieve all pipelines from Pipedrive | Parameter | Type | Description | | --------- | ---- | ----------- | | `pipelines` | array | Array of pipeline objects from Pipedrive | +| ↳ `id` | number | Pipeline ID | +| ↳ `name` | string | Pipeline name | +| ↳ `url_title` | string | URL-friendly title | +| ↳ `order_nr` | number | Pipeline order number | +| ↳ `active` | boolean | Whether the pipeline is active | +| ↳ `deal_probability` | boolean | Whether deal probability is enabled | +| ↳ `add_time` | string | When the pipeline was created | +| ↳ `update_time` | string | When the pipeline was last updated | | `total_items` | number | Total number of pipelines returned | | `success` | boolean | Operation success status | @@ -283,6 +319,19 @@ Retrieve activities (tasks) from Pipedrive with optional filters | Parameter | Type | Description | | --------- | ---- | ----------- | | `activities` | array | Array of activity objects from Pipedrive | +| ↳ `id` | number | Activity ID | +| ↳ `subject` | string | Activity subject | +| ↳ `type` | string | Activity type \(call, meeting, task, etc.\) | +| ↳ `due_date` | string | Due date \(YYYY-MM-DD\) | +| ↳ `due_time` | string | Due time \(HH:MM\) | +| ↳ `duration` | string | Duration \(HH:MM\) | +| ↳ `deal_id` | number | Associated deal ID | +| ↳ `person_id` | number | Associated person ID | +| ↳ `org_id` | number | Associated organization ID | +| ↳ `done` | boolean | Whether the activity is done | +| ↳ `note` | string | Activity note | +| ↳ `add_time` | string | When the activity was created | +| ↳ `update_time` | string | When the activity was last updated | | `total_items` | number | Total number of activities returned | | `success` | boolean | Operation success status | @@ -354,7 +403,33 @@ Retrieve all leads or a specific lead from Pipedrive | Parameter | Type | Description | | --------- | ---- | ----------- | | `leads` | array | Array of lead objects \(when listing all\) | +| ↳ `id` | string | Lead ID \(UUID\) | +| ↳ `title` | string | Lead title | +| ↳ `person_id` | number | ID of the associated person | +| ↳ `organization_id` | number | ID of the associated organization | +| ↳ `owner_id` | number | ID of the lead owner | +| ↳ `value` | object | Lead value | +| ↳ `amount` | number | Value amount | +| ↳ `currency` | string | Currency code \(e.g., USD, EUR\) | +| ↳ `expected_close_date` | string | Expected close date \(YYYY-MM-DD\) | +| ↳ `is_archived` | boolean | Whether the lead is archived | +| ↳ `was_seen` | boolean | Whether the lead was seen | +| ↳ `add_time` | string | When the lead was created \(ISO 8601\) | +| ↳ `update_time` | string | When the lead was last updated \(ISO 8601\) | | `lead` | object | Single lead object \(when lead_id is provided\) | +| ↳ `id` | string | Lead ID \(UUID\) | +| ↳ `title` | string | Lead title | +| ↳ `person_id` | number | ID of the associated person | +| ↳ `organization_id` | number | ID of the associated organization | +| ↳ `owner_id` | number | ID of the lead owner | +| ↳ `value` | object | Lead value | +| ↳ `amount` | number | Value amount | +| ↳ `currency` | string | Currency code \(e.g., USD, EUR\) | +| ↳ `expected_close_date` | string | Expected close date \(YYYY-MM-DD\) | +| ↳ `is_archived` | boolean | Whether the lead is archived | +| ↳ `was_seen` | boolean | Whether the lead was seen | +| ↳ `add_time` | string | When the lead was created \(ISO 8601\) | +| ↳ `update_time` | string | When the lead was last updated \(ISO 8601\) | | `total_items` | number | Total number of leads returned | | `success` | boolean | Operation success status | diff --git a/apps/docs/content/docs/en/tools/polymarket.mdx b/apps/docs/content/docs/en/tools/polymarket.mdx index a1c1315fe..0e9296b87 100644 --- a/apps/docs/content/docs/en/tools/polymarket.mdx +++ b/apps/docs/content/docs/en/tools/polymarket.mdx @@ -87,28 +87,28 @@ Retrieve details of a specific prediction market by ID or slug | Parameter | Type | Description | | --------- | ---- | ----------- | | `market` | object | Market object with details | -| ↳ `id` | string | Market ID | -| ↳ `question` | string | Market question | -| ↳ `conditionId` | string | Condition ID | -| ↳ `slug` | string | Market slug | -| ↳ `resolutionSource` | string | Resolution source | -| ↳ `endDate` | string | End date | -| ↳ `startDate` | string | Start date | -| ↳ `image` | string | Market image URL | -| ↳ `icon` | string | Market icon URL | -| ↳ `description` | string | Market description | -| ↳ `outcomes` | string | Outcomes JSON string | -| ↳ `outcomePrices` | string | Outcome prices JSON string | -| ↳ `volume` | string | Total volume | -| ↳ `liquidity` | string | Total liquidity | -| ↳ `active` | boolean | Whether market is active | -| ↳ `closed` | boolean | Whether market is closed | -| ↳ `archived` | boolean | Whether market is archived | -| ↳ `volumeNum` | number | Volume as number | -| ↳ `liquidityNum` | number | Liquidity as number | -| ↳ `clobTokenIds` | array | CLOB token IDs | -| ↳ `acceptingOrders` | boolean | Whether accepting orders | -| ↳ `negRisk` | boolean | Whether negative risk | +| ↳ `id` | string | Market ID | +| ↳ `question` | string | Market question | +| ↳ `conditionId` | string | Condition ID | +| ↳ `slug` | string | Market slug | +| ↳ `resolutionSource` | string | Resolution source | +| ↳ `endDate` | string | End date | +| ↳ `startDate` | string | Start date | +| ↳ `image` | string | Market image URL | +| ↳ `icon` | string | Market icon URL | +| ↳ `description` | string | Market description | +| ↳ `outcomes` | string | Outcomes JSON string | +| ↳ `outcomePrices` | string | Outcome prices JSON string | +| ↳ `volume` | string | Total volume | +| ↳ `liquidity` | string | Total liquidity | +| ↳ `active` | boolean | Whether market is active | +| ↳ `closed` | boolean | Whether market is closed | +| ↳ `archived` | boolean | Whether market is archived | +| ↳ `volumeNum` | number | Volume as number | +| ↳ `liquidityNum` | number | Liquidity as number | +| ↳ `clobTokenIds` | array | CLOB token IDs | +| ↳ `acceptingOrders` | boolean | Whether accepting orders | +| ↳ `negRisk` | boolean | Whether negative risk | ### `polymarket_get_events` @@ -162,24 +162,24 @@ Retrieve details of a specific event by ID or slug | Parameter | Type | Description | | --------- | ---- | ----------- | | `event` | object | Event object with details | -| ↳ `id` | string | Event ID | -| ↳ `ticker` | string | Event ticker | -| ↳ `slug` | string | Event slug | -| ↳ `title` | string | Event title | -| ↳ `description` | string | Event description | -| ↳ `startDate` | string | Start date | -| ↳ `creationDate` | string | Creation date | -| ↳ `endDate` | string | End date | -| ↳ `image` | string | Event image URL | -| ↳ `icon` | string | Event icon URL | -| ↳ `active` | boolean | Whether event is active | -| ↳ `closed` | boolean | Whether event is closed | -| ↳ `archived` | boolean | Whether event is archived | -| ↳ `liquidity` | number | Total liquidity | -| ↳ `volume` | number | Total volume | -| ↳ `openInterest` | number | Open interest | -| ↳ `commentCount` | number | Comment count | -| ↳ `markets` | array | Array of markets in this event | +| ↳ `id` | string | Event ID | +| ↳ `ticker` | string | Event ticker | +| ↳ `slug` | string | Event slug | +| ↳ `title` | string | Event title | +| ↳ `description` | string | Event description | +| ↳ `startDate` | string | Start date | +| ↳ `creationDate` | string | Creation date | +| ↳ `endDate` | string | End date | +| ↳ `image` | string | Event image URL | +| ↳ `icon` | string | Event icon URL | +| ↳ `active` | boolean | Whether event is active | +| ↳ `closed` | boolean | Whether event is closed | +| ↳ `archived` | boolean | Whether event is archived | +| ↳ `liquidity` | number | Total liquidity | +| ↳ `volume` | number | Total volume | +| ↳ `openInterest` | number | Open interest | +| ↳ `commentCount` | number | Comment count | +| ↳ `markets` | array | Array of markets in this event | ### `polymarket_get_tags` @@ -231,10 +231,10 @@ Search for markets, events, and profiles on Polymarket | Parameter | Type | Description | | --------- | ---- | ----------- | | `results` | object | Search results containing markets, events, tags, and profiles arrays | -| ↳ `markets` | array | Array of matching market objects | -| ↳ `events` | array | Array of matching event objects | -| ↳ `tags` | array | Array of matching tag objects | -| ↳ `profiles` | array | Array of matching profile objects | +| ↳ `markets` | array | Array of matching market objects | +| ↳ `events` | array | Array of matching event objects | +| ↳ `tags` | array | Array of matching tag objects | +| ↳ `profiles` | array | Array of matching profile objects | ### `polymarket_get_series` @@ -283,23 +283,23 @@ Retrieve a specific series (related market group) by ID from Polymarket | Parameter | Type | Description | | --------- | ---- | ----------- | | `series` | object | Series object with details | -| ↳ `id` | string | Series ID | -| ↳ `ticker` | string | Series ticker | -| ↳ `slug` | string | Series slug | -| ↳ `title` | string | Series title | -| ↳ `seriesType` | string | Series type | -| ↳ `recurrence` | string | Recurrence pattern | -| ↳ `image` | string | Series image URL | -| ↳ `icon` | string | Series icon URL | -| ↳ `active` | boolean | Whether series is active | -| ↳ `closed` | boolean | Whether series is closed | -| ↳ `archived` | boolean | Whether series is archived | -| ↳ `featured` | boolean | Whether series is featured | -| ↳ `volume` | number | Total volume | -| ↳ `liquidity` | number | Total liquidity | -| ↳ `commentCount` | number | Comment count | -| ↳ `eventCount` | number | Number of events in series | -| ↳ `events` | array | Array of events in this series | +| ↳ `id` | string | Series ID | +| ↳ `ticker` | string | Series ticker | +| ↳ `slug` | string | Series slug | +| ↳ `title` | string | Series title | +| ↳ `seriesType` | string | Series type | +| ↳ `recurrence` | string | Recurrence pattern | +| ↳ `image` | string | Series image URL | +| ↳ `icon` | string | Series icon URL | +| ↳ `active` | boolean | Whether series is active | +| ↳ `closed` | boolean | Whether series is closed | +| ↳ `archived` | boolean | Whether series is archived | +| ↳ `featured` | boolean | Whether series is featured | +| ↳ `volume` | number | Total volume | +| ↳ `liquidity` | number | Total liquidity | +| ↳ `commentCount` | number | Comment count | +| ↳ `eventCount` | number | Number of events in series | +| ↳ `events` | array | Array of events in this series | ### `polymarket_get_orderbook` @@ -316,19 +316,19 @@ Retrieve the order book summary for a specific token | Parameter | Type | Description | | --------- | ---- | ----------- | | `orderbook` | object | Order book with bids and asks arrays | -| ↳ `market` | string | Market identifier | -| ↳ `asset_id` | string | Asset token ID | -| ↳ `hash` | string | Order book hash | -| ↳ `timestamp` | string | Timestamp | -| ↳ `bids` | array | Bid orders | -| ↳ `price` | string | Bid price | -| ↳ `size` | string | Bid size | -| ↳ `asks` | array | Ask orders | -| ↳ `price` | string | Ask price | -| ↳ `size` | string | Ask size | -| ↳ `min_order_size` | string | Minimum order size | -| ↳ `tick_size` | string | Tick size | -| ↳ `neg_risk` | boolean | Whether negative risk | +| ↳ `market` | string | Market identifier | +| ↳ `asset_id` | string | Asset token ID | +| ↳ `hash` | string | Order book hash | +| ↳ `timestamp` | string | Timestamp | +| ↳ `bids` | array | Bid orders | +| ↳ `price` | string | Bid price | +| ↳ `size` | string | Bid size | +| ↳ `asks` | array | Ask orders | +| ↳ `price` | string | Ask price | +| ↳ `size` | string | Ask size | +| ↳ `min_order_size` | string | Minimum order size | +| ↳ `tick_size` | string | Tick size | +| ↳ `neg_risk` | boolean | Whether negative risk | ### `polymarket_get_price` @@ -417,7 +417,7 @@ Retrieve the bid-ask spread for a specific token | Parameter | Type | Description | | --------- | ---- | ----------- | | `spread` | object | Spread value between bid and ask | -| ↳ `spread` | string | The spread value | +| ↳ `spread` | string | The spread value | ### `polymarket_get_tick_size` @@ -625,15 +625,15 @@ Retrieve top holders of a specific market token | `holders` | array | Array of market holder groups by token | | ↳ `token` | string | Token/asset ID | | ↳ `holders` | array | Array of holders for this token | -| ↳ `proxyWallet` | string | Holder wallet address | -| ↳ `bio` | string | Holder bio | -| ↳ `asset` | string | Asset ID | -| ↳ `pseudonym` | string | Holder pseudonym | -| ↳ `amount` | number | Amount held | -| ↳ `displayUsernamePublic` | boolean | Whether username is publicly displayed | -| ↳ `outcomeIndex` | number | Outcome index | -| ↳ `name` | string | Holder display name | -| ↳ `profileImage` | string | Profile image URL | -| ↳ `profileImageOptimized` | string | Optimized profile image URL | +| ↳ `proxyWallet` | string | Holder wallet address | +| ↳ `bio` | string | Holder bio | +| ↳ `asset` | string | Asset ID | +| ↳ `pseudonym` | string | Holder pseudonym | +| ↳ `amount` | number | Amount held | +| ↳ `displayUsernamePublic` | boolean | Whether username is publicly displayed | +| ↳ `outcomeIndex` | number | Outcome index | +| ↳ `name` | string | Holder display name | +| ↳ `profileImage` | string | Profile image URL | +| ↳ `profileImageOptimized` | string | Optimized profile image URL | diff --git a/apps/docs/content/docs/en/tools/postgresql.mdx b/apps/docs/content/docs/en/tools/postgresql.mdx index 143a77a20..ee4a76783 100644 --- a/apps/docs/content/docs/en/tools/postgresql.mdx +++ b/apps/docs/content/docs/en/tools/postgresql.mdx @@ -179,6 +179,27 @@ Introspect PostgreSQL database schema to retrieve table structures, columns, and | --------- | ---- | ----------- | | `message` | string | Operation status message | | `tables` | array | Array of table schemas with columns, keys, and indexes | +| ↳ `name` | string | Table name | +| ↳ `schema` | string | Schema name \(e.g., public\) | +| ↳ `columns` | array | Table columns | +| ↳ `name` | string | Column name | +| ↳ `type` | string | Data type \(e.g., integer, varchar, timestamp\) | +| ↳ `nullable` | boolean | Whether the column allows NULL values | +| ↳ `default` | string | Default value expression | +| ↳ `isPrimaryKey` | boolean | Whether the column is part of the primary key | +| ↳ `isForeignKey` | boolean | Whether the column is a foreign key | +| ↳ `references` | object | Foreign key reference information | +| ↳ `table` | string | Referenced table name | +| ↳ `column` | string | Referenced column name | +| ↳ `primaryKey` | array | Primary key column names | +| ↳ `foreignKeys` | array | Foreign key constraints | +| ↳ `column` | string | Local column name | +| ↳ `referencesTable` | string | Referenced table name | +| ↳ `referencesColumn` | string | Referenced column name | +| ↳ `indexes` | array | Table indexes | +| ↳ `name` | string | Index name | +| ↳ `columns` | array | Columns included in the index | +| ↳ `unique` | boolean | Whether the index enforces uniqueness | | `schemas` | array | List of available schemas in the database | diff --git a/apps/docs/content/docs/en/tools/posthog.mdx b/apps/docs/content/docs/en/tools/posthog.mdx index 6a4e6387e..394a8eb90 100644 --- a/apps/docs/content/docs/en/tools/posthog.mdx +++ b/apps/docs/content/docs/en/tools/posthog.mdx @@ -125,11 +125,11 @@ Get detailed information about a specific person in PostHog by their ID or UUID. | Parameter | Type | Description | | --------- | ---- | ----------- | | `person` | object | Person details including properties and identifiers | -| ↳ `id` | string | Person ID | -| ↳ `name` | string | Person name | -| ↳ `distinct_ids` | array | All distinct IDs associated with this person | -| ↳ `created_at` | string | When the person was first seen | -| ↳ `uuid` | string | Person UUID | +| ↳ `id` | string | Person ID | +| ↳ `name` | string | Person name | +| ↳ `distinct_ids` | array | All distinct IDs associated with this person | +| ↳ `created_at` | string | When the person was first seen | +| ↳ `uuid` | string | Person UUID | ### `posthog_delete_person` @@ -599,19 +599,19 @@ Get details of a specific feature flag | Parameter | Type | Description | | --------- | ---- | ----------- | | `flag` | object | Feature flag details | -| ↳ `id` | number | Feature flag ID | -| ↳ `name` | string | Feature flag name | -| ↳ `key` | string | Feature flag key | -| ↳ `filters` | object | Feature flag filters | -| ↳ `deleted` | boolean | Whether the flag is deleted | -| ↳ `active` | boolean | Whether the flag is active | -| ↳ `created_at` | string | Creation timestamp | -| ↳ `created_by` | object | Creator information | -| ↳ `is_simple_flag` | boolean | Whether this is a simple flag | -| ↳ `rollout_percentage` | number | Rollout percentage \(if applicable\) | -| ↳ `ensure_experience_continuity` | boolean | Whether to ensure experience continuity | -| ↳ `usage_dashboard` | number | Usage dashboard ID | -| ↳ `has_enriched_analytics` | boolean | Whether enriched analytics are enabled | +| ↳ `id` | number | Feature flag ID | +| ↳ `name` | string | Feature flag name | +| ↳ `key` | string | Feature flag key | +| ↳ `filters` | object | Feature flag filters | +| ↳ `deleted` | boolean | Whether the flag is deleted | +| ↳ `active` | boolean | Whether the flag is active | +| ↳ `created_at` | string | Creation timestamp | +| ↳ `created_by` | object | Creator information | +| ↳ `is_simple_flag` | boolean | Whether this is a simple flag | +| ↳ `rollout_percentage` | number | Rollout percentage \(if applicable\) | +| ↳ `ensure_experience_continuity` | boolean | Whether to ensure experience continuity | +| ↳ `usage_dashboard` | number | Usage dashboard ID | +| ↳ `has_enriched_analytics` | boolean | Whether enriched analytics are enabled | ### `posthog_create_feature_flag` @@ -636,17 +636,17 @@ Create a new feature flag in PostHog | Parameter | Type | Description | | --------- | ---- | ----------- | | `flag` | object | Created feature flag | -| ↳ `id` | number | Feature flag ID | -| ↳ `name` | string | Feature flag name | -| ↳ `key` | string | Feature flag key | -| ↳ `filters` | object | Feature flag filters | -| ↳ `deleted` | boolean | Whether the flag is deleted | -| ↳ `active` | boolean | Whether the flag is active | -| ↳ `created_at` | string | Creation timestamp | -| ↳ `created_by` | object | Creator information | -| ↳ `is_simple_flag` | boolean | Whether this is a simple flag | -| ↳ `rollout_percentage` | number | Rollout percentage \(if applicable\) | -| ↳ `ensure_experience_continuity` | boolean | Whether to ensure experience continuity | +| ↳ `id` | number | Feature flag ID | +| ↳ `name` | string | Feature flag name | +| ↳ `key` | string | Feature flag key | +| ↳ `filters` | object | Feature flag filters | +| ↳ `deleted` | boolean | Whether the flag is deleted | +| ↳ `active` | boolean | Whether the flag is active | +| ↳ `created_at` | string | Creation timestamp | +| ↳ `created_by` | object | Creator information | +| ↳ `is_simple_flag` | boolean | Whether this is a simple flag | +| ↳ `rollout_percentage` | number | Rollout percentage \(if applicable\) | +| ↳ `ensure_experience_continuity` | boolean | Whether to ensure experience continuity | ### `posthog_update_feature_flag` @@ -672,17 +672,17 @@ Update an existing feature flag in PostHog | Parameter | Type | Description | | --------- | ---- | ----------- | | `flag` | object | Updated feature flag | -| ↳ `id` | number | Feature flag ID | -| ↳ `name` | string | Feature flag name | -| ↳ `key` | string | Feature flag key | -| ↳ `filters` | object | Feature flag filters | -| ↳ `deleted` | boolean | Whether the flag is deleted | -| ↳ `active` | boolean | Whether the flag is active | -| ↳ `created_at` | string | Creation timestamp | -| ↳ `created_by` | object | Creator information | -| ↳ `is_simple_flag` | boolean | Whether this is a simple flag | -| ↳ `rollout_percentage` | number | Rollout percentage \(if applicable\) | -| ↳ `ensure_experience_continuity` | boolean | Whether to ensure experience continuity | +| ↳ `id` | number | Feature flag ID | +| ↳ `name` | string | Feature flag name | +| ↳ `key` | string | Feature flag key | +| ↳ `filters` | object | Feature flag filters | +| ↳ `deleted` | boolean | Whether the flag is deleted | +| ↳ `active` | boolean | Whether the flag is active | +| ↳ `created_at` | string | Creation timestamp | +| ↳ `created_by` | object | Creator information | +| ↳ `is_simple_flag` | boolean | Whether this is a simple flag | +| ↳ `rollout_percentage` | number | Rollout percentage \(if applicable\) | +| ↳ `ensure_experience_continuity` | boolean | Whether to ensure experience continuity | ### `posthog_delete_feature_flag` @@ -781,21 +781,21 @@ Get details of a specific experiment | Parameter | Type | Description | | --------- | ---- | ----------- | | `experiment` | object | Experiment details | -| ↳ `id` | number | Experiment ID | -| ↳ `name` | string | Experiment name | -| ↳ `description` | string | Experiment description | -| ↳ `feature_flag_key` | string | Associated feature flag key | -| ↳ `feature_flag` | object | Feature flag details | -| ↳ `parameters` | object | Experiment parameters | -| ↳ `filters` | object | Experiment filters | -| ↳ `variants` | object | Experiment variants | -| ↳ `start_date` | string | Start date | -| ↳ `end_date` | string | End date | -| ↳ `created_at` | string | Creation timestamp | -| ↳ `created_by` | object | Creator information | -| ↳ `archived` | boolean | Whether the experiment is archived | -| ↳ `metrics` | array | Primary metrics | -| ↳ `metrics_secondary` | array | Secondary metrics | +| ↳ `id` | number | Experiment ID | +| ↳ `name` | string | Experiment name | +| ↳ `description` | string | Experiment description | +| ↳ `feature_flag_key` | string | Associated feature flag key | +| ↳ `feature_flag` | object | Feature flag details | +| ↳ `parameters` | object | Experiment parameters | +| ↳ `filters` | object | Experiment filters | +| ↳ `variants` | object | Experiment variants | +| ↳ `start_date` | string | Start date | +| ↳ `end_date` | string | End date | +| ↳ `created_at` | string | Creation timestamp | +| ↳ `created_by` | object | Creator information | +| ↳ `archived` | boolean | Whether the experiment is archived | +| ↳ `metrics` | array | Primary metrics | +| ↳ `metrics_secondary` | array | Secondary metrics | ### `posthog_create_experiment` @@ -822,19 +822,19 @@ Create a new experiment in PostHog | Parameter | Type | Description | | --------- | ---- | ----------- | | `experiment` | object | Created experiment | -| ↳ `id` | number | Experiment ID | -| ↳ `name` | string | Experiment name | -| ↳ `description` | string | Experiment description | -| ↳ `feature_flag_key` | string | Associated feature flag key | -| ↳ `feature_flag` | object | Feature flag details | -| ↳ `parameters` | object | Experiment parameters | -| ↳ `filters` | object | Experiment filters | -| ↳ `variants` | object | Experiment variants | -| ↳ `start_date` | string | Start date | -| ↳ `end_date` | string | End date | -| ↳ `created_at` | string | Creation timestamp | -| ↳ `created_by` | object | Creator information | -| ↳ `archived` | boolean | Whether the experiment is archived | +| ↳ `id` | number | Experiment ID | +| ↳ `name` | string | Experiment name | +| ↳ `description` | string | Experiment description | +| ↳ `feature_flag_key` | string | Associated feature flag key | +| ↳ `feature_flag` | object | Feature flag details | +| ↳ `parameters` | object | Experiment parameters | +| ↳ `filters` | object | Experiment filters | +| ↳ `variants` | object | Experiment variants | +| ↳ `start_date` | string | Start date | +| ↳ `end_date` | string | End date | +| ↳ `created_at` | string | Creation timestamp | +| ↳ `created_by` | object | Creator information | +| ↳ `archived` | boolean | Whether the experiment is archived | ### `posthog_list_surveys` @@ -886,19 +886,19 @@ Get details of a specific survey in PostHog by ID. | Parameter | Type | Description | | --------- | ---- | ----------- | | `survey` | object | Survey details | -| ↳ `id` | string | Survey ID | -| ↳ `name` | string | Survey name | -| ↳ `description` | string | Survey description | -| ↳ `type` | string | Survey type \(popover or api\) | -| ↳ `questions` | array | Survey questions | -| ↳ `appearance` | object | Survey appearance configuration | -| ↳ `conditions` | object | Survey display conditions | -| ↳ `created_at` | string | Creation timestamp | -| ↳ `created_by` | object | Creator information | -| ↳ `start_date` | string | Survey start date | -| ↳ `end_date` | string | Survey end date | -| ↳ `archived` | boolean | Whether survey is archived | -| ↳ `responses_limit` | number | Maximum number of responses | +| ↳ `id` | string | Survey ID | +| ↳ `name` | string | Survey name | +| ↳ `description` | string | Survey description | +| ↳ `type` | string | Survey type \(popover or api\) | +| ↳ `questions` | array | Survey questions | +| ↳ `appearance` | object | Survey appearance configuration | +| ↳ `conditions` | object | Survey display conditions | +| ↳ `created_at` | string | Creation timestamp | +| ↳ `created_by` | object | Creator information | +| ↳ `start_date` | string | Survey start date | +| ↳ `end_date` | string | Survey end date | +| ↳ `archived` | boolean | Whether survey is archived | +| ↳ `responses_limit` | number | Maximum number of responses | ### `posthog_create_survey` @@ -928,14 +928,14 @@ Create a new survey in PostHog. Supports question types: Basic (open), Link, Rat | Parameter | Type | Description | | --------- | ---- | ----------- | | `survey` | object | Created survey details | -| ↳ `id` | string | Survey ID | -| ↳ `name` | string | Survey name | -| ↳ `description` | string | Survey description | -| ↳ `type` | string | Survey type \(popover or api\) | -| ↳ `questions` | array | Survey questions | -| ↳ `created_at` | string | Creation timestamp | -| ↳ `start_date` | string | Survey start date | -| ↳ `end_date` | string | Survey end date | +| ↳ `id` | string | Survey ID | +| ↳ `name` | string | Survey name | +| ↳ `description` | string | Survey description | +| ↳ `type` | string | Survey type \(popover or api\) | +| ↳ `questions` | array | Survey questions | +| ↳ `created_at` | string | Creation timestamp | +| ↳ `start_date` | string | Survey start date | +| ↳ `end_date` | string | Survey end date | ### `posthog_update_survey` @@ -967,15 +967,15 @@ Update an existing survey in PostHog. Can modify questions, appearance, conditio | Parameter | Type | Description | | --------- | ---- | ----------- | | `survey` | object | Updated survey details | -| ↳ `id` | string | Survey ID | -| ↳ `name` | string | Survey name | -| ↳ `description` | string | Survey description | -| ↳ `type` | string | Survey type \(popover or api\) | -| ↳ `questions` | array | Survey questions | -| ↳ `created_at` | string | Creation timestamp | -| ↳ `start_date` | string | Survey start date | -| ↳ `end_date` | string | Survey end date | -| ↳ `archived` | boolean | Whether survey is archived | +| ↳ `id` | string | Survey ID | +| ↳ `name` | string | Survey name | +| ↳ `description` | string | Survey description | +| ↳ `type` | string | Survey type \(popover or api\) | +| ↳ `questions` | array | Survey questions | +| ↳ `created_at` | string | Creation timestamp | +| ↳ `start_date` | string | Survey start date | +| ↳ `end_date` | string | Survey end date | +| ↳ `archived` | boolean | Whether survey is archived | ### `posthog_list_session_recordings` @@ -1032,22 +1032,22 @@ Get details of a specific session recording in PostHog by ID. | Parameter | Type | Description | | --------- | ---- | ----------- | | `recording` | object | Session recording details | -| ↳ `id` | string | Recording ID | -| ↳ `distinct_id` | string | User distinct ID | -| ↳ `viewed` | boolean | Whether recording has been viewed | -| ↳ `recording_duration` | number | Recording duration in seconds | -| ↳ `active_seconds` | number | Active time in seconds | -| ↳ `inactive_seconds` | number | Inactive time in seconds | -| ↳ `start_time` | string | Recording start timestamp | -| ↳ `end_time` | string | Recording end timestamp | -| ↳ `click_count` | number | Number of clicks | -| ↳ `keypress_count` | number | Number of keypresses | -| ↳ `console_log_count` | number | Number of console logs | -| ↳ `console_warn_count` | number | Number of console warnings | -| ↳ `console_error_count` | number | Number of console errors | -| ↳ `start_url` | string | Starting URL of the recording | -| ↳ `person` | object | Person information | -| ↳ `matching_events` | array | Events that occurred during recording | +| ↳ `id` | string | Recording ID | +| ↳ `distinct_id` | string | User distinct ID | +| ↳ `viewed` | boolean | Whether recording has been viewed | +| ↳ `recording_duration` | number | Recording duration in seconds | +| ↳ `active_seconds` | number | Active time in seconds | +| ↳ `inactive_seconds` | number | Inactive time in seconds | +| ↳ `start_time` | string | Recording start timestamp | +| ↳ `end_time` | string | Recording end timestamp | +| ↳ `click_count` | number | Number of clicks | +| ↳ `keypress_count` | number | Number of keypresses | +| ↳ `console_log_count` | number | Number of console logs | +| ↳ `console_warn_count` | number | Number of console warnings | +| ↳ `console_error_count` | number | Number of console errors | +| ↳ `start_url` | string | Starting URL of the recording | +| ↳ `person` | object | Person information | +| ↳ `matching_events` | array | Events that occurred during recording | ### `posthog_list_recording_playlists` @@ -1344,29 +1344,29 @@ Get detailed information about a specific project by ID. Returns comprehensive p | Parameter | Type | Description | | --------- | ---- | ----------- | | `project` | object | Detailed project information with all configuration settings | -| ↳ `id` | number | Project ID | -| ↳ `uuid` | string | Project UUID | -| ↳ `organization` | string | Organization UUID | -| ↳ `api_token` | string | Project API token for ingestion | -| ↳ `app_urls` | array | Allowed app URLs | -| ↳ `name` | string | Project name | -| ↳ `slack_incoming_webhook` | string | Slack webhook URL for notifications | -| ↳ `created_at` | string | Project creation timestamp | -| ↳ `updated_at` | string | Last update timestamp | -| ↳ `anonymize_ips` | boolean | Whether IP anonymization is enabled | -| ↳ `completed_snippet_onboarding` | boolean | Whether snippet onboarding is completed | -| ↳ `ingested_event` | boolean | Whether any event has been ingested | -| ↳ `test_account_filters` | array | Filters for test accounts | -| ↳ `is_demo` | boolean | Whether this is a demo project | -| ↳ `timezone` | string | Project timezone | -| ↳ `data_attributes` | array | Custom data attributes | -| ↳ `person_display_name_properties` | array | Properties used for person display names | -| ↳ `correlation_config` | object | Configuration for correlation analysis | -| ↳ `autocapture_opt_out` | boolean | Whether autocapture is disabled | -| ↳ `autocapture_exceptions_opt_in` | boolean | Whether exception autocapture is enabled | -| ↳ `session_recording_opt_in` | boolean | Whether session recording is enabled | -| ↳ `capture_console_log_opt_in` | boolean | Whether console log capture is enabled | -| ↳ `capture_performance_opt_in` | boolean | Whether performance capture is enabled | +| ↳ `id` | number | Project ID | +| ↳ `uuid` | string | Project UUID | +| ↳ `organization` | string | Organization UUID | +| ↳ `api_token` | string | Project API token for ingestion | +| ↳ `app_urls` | array | Allowed app URLs | +| ↳ `name` | string | Project name | +| ↳ `slack_incoming_webhook` | string | Slack webhook URL for notifications | +| ↳ `created_at` | string | Project creation timestamp | +| ↳ `updated_at` | string | Last update timestamp | +| ↳ `anonymize_ips` | boolean | Whether IP anonymization is enabled | +| ↳ `completed_snippet_onboarding` | boolean | Whether snippet onboarding is completed | +| ↳ `ingested_event` | boolean | Whether any event has been ingested | +| ↳ `test_account_filters` | array | Filters for test accounts | +| ↳ `is_demo` | boolean | Whether this is a demo project | +| ↳ `timezone` | string | Project timezone | +| ↳ `data_attributes` | array | Custom data attributes | +| ↳ `person_display_name_properties` | array | Properties used for person display names | +| ↳ `correlation_config` | object | Configuration for correlation analysis | +| ↳ `autocapture_opt_out` | boolean | Whether autocapture is disabled | +| ↳ `autocapture_exceptions_opt_in` | boolean | Whether exception autocapture is enabled | +| ↳ `session_recording_opt_in` | boolean | Whether session recording is enabled | +| ↳ `capture_console_log_opt_in` | boolean | Whether console log capture is enabled | +| ↳ `capture_performance_opt_in` | boolean | Whether performance capture is enabled | ### `posthog_list_organizations` @@ -1411,20 +1411,20 @@ Get detailed information about a specific organization by ID. Returns comprehens | Parameter | Type | Description | | --------- | ---- | ----------- | | `organization` | object | Detailed organization information with settings and features | -| ↳ `id` | string | Organization ID \(UUID\) | -| ↳ `name` | string | Organization name | -| ↳ `slug` | string | Organization slug | -| ↳ `created_at` | string | Organization creation timestamp | -| ↳ `updated_at` | string | Last update timestamp | -| ↳ `membership_level` | number | User membership level in organization | -| ↳ `plugins_access_level` | number | Access level for plugins/apps | -| ↳ `teams` | array | List of team IDs in this organization | -| ↳ `available_product_features` | array | Available product features with their limits and descriptions | -| ↳ `domain_whitelist` | array | Whitelisted domains for organization | -| ↳ `is_member_join_email_enabled` | boolean | Whether member join emails are enabled | -| ↳ `metadata` | object | Organization metadata | -| ↳ `customer_id` | string | Customer ID for billing | -| ↳ `available_features` | array | List of available feature flags for organization | -| ↳ `usage` | object | Organization usage statistics | +| ↳ `id` | string | Organization ID \(UUID\) | +| ↳ `name` | string | Organization name | +| ↳ `slug` | string | Organization slug | +| ↳ `created_at` | string | Organization creation timestamp | +| ↳ `updated_at` | string | Last update timestamp | +| ↳ `membership_level` | number | User membership level in organization | +| ↳ `plugins_access_level` | number | Access level for plugins/apps | +| ↳ `teams` | array | List of team IDs in this organization | +| ↳ `available_product_features` | array | Available product features with their limits and descriptions | +| ↳ `domain_whitelist` | array | Whitelisted domains for organization | +| ↳ `is_member_join_email_enabled` | boolean | Whether member join emails are enabled | +| ↳ `metadata` | object | Organization metadata | +| ↳ `customer_id` | string | Customer ID for billing | +| ↳ `available_features` | array | List of available feature flags for organization | +| ↳ `usage` | object | Organization usage statistics | diff --git a/apps/docs/content/docs/en/tools/qdrant.mdx b/apps/docs/content/docs/en/tools/qdrant.mdx index 4e3271363..a0a0c00e0 100644 --- a/apps/docs/content/docs/en/tools/qdrant.mdx +++ b/apps/docs/content/docs/en/tools/qdrant.mdx @@ -56,8 +56,10 @@ Insert or update points in a Qdrant collection | Parameter | Type | Description | | --------- | ---- | ----------- | -| `status` | string | Status of the upsert operation | +| `status` | string | Operation status \(ok, error\) | | `data` | object | Result data from the upsert operation | +| ↳ `operation_id` | number | Operation ID for async tracking | +| ↳ `status` | string | Operation status \(acknowledged, completed\) | ### `qdrant_search_vector` @@ -81,8 +83,15 @@ Search for similar vectors in a Qdrant collection | Parameter | Type | Description | | --------- | ---- | ----------- | +| `status` | string | Operation status \(ok, error\) | | `data` | array | Vector search results with ID, score, payload, and optional vector data | -| `status` | string | Status of the search operation | +| ↳ `id` | string | Point ID \(integer or UUID string\) | +| ↳ `version` | number | Point version number | +| ↳ `score` | number | Similarity score | +| ↳ `payload` | json | Point payload data \(key-value pairs\) | +| ↳ `vector` | json | Point vector\(s\) - single array or named vectors object | +| ↳ `shard_key` | string | Shard key for routing | +| ↳ `order_value` | number | Order value for sorting | ### `qdrant_fetch_points` @@ -104,7 +113,12 @@ Fetch points by ID from a Qdrant collection | Parameter | Type | Description | | --------- | ---- | ----------- | +| `status` | string | Operation status \(ok, error\) | | `data` | array | Fetched points with ID, payload, and optional vector data | -| `status` | string | Status of the fetch operation | +| ↳ `id` | string | Point ID \(integer or UUID string\) | +| ↳ `payload` | json | Point payload data \(key-value pairs\) | +| ↳ `vector` | json | Point vector\(s\) - single array or named vectors object | +| ↳ `shard_key` | string | Shard key for routing | +| ↳ `order_value` | number | Order value for sorting | diff --git a/apps/docs/content/docs/en/tools/reddit.mdx b/apps/docs/content/docs/en/tools/reddit.mdx index 65cb1aed4..a0f139af8 100644 --- a/apps/docs/content/docs/en/tools/reddit.mdx +++ b/apps/docs/content/docs/en/tools/reddit.mdx @@ -95,13 +95,13 @@ Fetch comments from a specific Reddit post | Parameter | Type | Description | | --------- | ---- | ----------- | | `post` | object | Post information including ID, title, author, content, and metadata | -| ↳ `id` | string | Post ID | -| ↳ `title` | string | Post title | -| ↳ `author` | string | Post author | -| ↳ `selftext` | string | Post text content | -| ↳ `score` | number | Post score | -| ↳ `created_utc` | number | Creation timestamp | -| ↳ `permalink` | string | Reddit permalink | +| ↳ `id` | string | Post ID | +| ↳ `title` | string | Post title | +| ↳ `author` | string | Post author | +| ↳ `selftext` | string | Post text content | +| ↳ `score` | number | Post score | +| ↳ `created_utc` | number | Creation timestamp | +| ↳ `permalink` | string | Reddit permalink | | `comments` | array | Nested comments with author, body, score, timestamps, and replies | | ↳ `id` | string | Comment ID | | ↳ `author` | string | Comment author | @@ -208,6 +208,10 @@ Submit a new post to a subreddit (text or link) | `success` | boolean | Whether the post was submitted successfully | | `message` | string | Success or error message | | `data` | object | Post data including ID, name, URL, and permalink | +| ↳ `id` | string | New post ID | +| ↳ `name` | string | Thing fullname \(t3_xxxxx\) | +| ↳ `url` | string | Post URL from API response | +| ↳ `permalink` | string | Full Reddit permalink | ### `reddit_vote` @@ -279,6 +283,10 @@ Add a comment reply to a Reddit post or comment | `success` | boolean | Whether the reply was posted successfully | | `message` | string | Success or error message | | `data` | object | Comment data including ID, name, permalink, and body | +| ↳ `id` | string | New comment ID | +| ↳ `name` | string | Thing fullname \(t1_xxxxx\) | +| ↳ `permalink` | string | Comment permalink | +| ↳ `body` | string | Comment body text | ### `reddit_edit` @@ -298,6 +306,9 @@ Edit the text of your own Reddit post or comment | `success` | boolean | Whether the edit was successful | | `message` | string | Success or error message | | `data` | object | Updated content data | +| ↳ `id` | string | Edited thing ID | +| ↳ `body` | string | Updated comment body \(for comments\) | +| ↳ `selftext` | string | Updated post text \(for self posts\) | ### `reddit_delete` diff --git a/apps/docs/content/docs/en/tools/salesforce.mdx b/apps/docs/content/docs/en/tools/salesforce.mdx index a8884db3e..ed8548f88 100644 --- a/apps/docs/content/docs/en/tools/salesforce.mdx +++ b/apps/docs/content/docs/en/tools/salesforce.mdx @@ -53,15 +53,15 @@ Retrieve accounts from Salesforce CRM | --------- | ---- | ----------- | | `success` | boolean | Operation success status | | `output` | object | Accounts data | -| ↳ `accounts` | array | Array of account objects | -| ↳ `paging` | object | Pagination information | -| ↳ `nextRecordsUrl` | string | URL for next page of results | -| ↳ `totalSize` | number | Total number of records | -| ↳ `done` | boolean | Whether all records returned | -| ↳ `metadata` | object | Response metadata | -| ↳ `totalReturned` | number | Number of accounts returned | -| ↳ `hasMore` | boolean | Whether more records exist | -| ↳ `success` | boolean | Salesforce operation success | +| ↳ `paging` | object | Pagination information from Salesforce API | +| ↳ `nextRecordsUrl` | string | URL to fetch the next batch of records \(present when done is false\) | +| ↳ `totalSize` | number | Total number of records matching the query \(may exceed records returned\) | +| ↳ `done` | boolean | Whether all records have been returned \(false if more batches exist\) | +| ↳ `metadata` | object | Response metadata | +| ↳ `totalReturned` | number | Number of records returned in this response | +| ↳ `hasMore` | boolean | Whether more records exist \(inverse of done\) | +| ↳ `accounts` | array | Array of account objects | +| ↳ `success` | boolean | Salesforce operation success | ### `salesforce_create_account` @@ -93,9 +93,9 @@ Create a new account in Salesforce CRM | --------- | ---- | ----------- | | `success` | boolean | Operation success status | | `output` | object | Created account data | -| ↳ `id` | string | Created account ID | -| ↳ `success` | boolean | Salesforce operation success | -| ↳ `created` | boolean | Whether account was created | +| ↳ `id` | string | The Salesforce ID of the newly created record | +| ↳ `success` | boolean | Whether the create operation was successful | +| ↳ `created` | boolean | Whether the record was created \(always true on success\) | ### `salesforce_update_account` @@ -128,8 +128,8 @@ Update an existing account in Salesforce CRM | --------- | ---- | ----------- | | `success` | boolean | Operation success status | | `output` | object | Updated account data | -| ↳ `id` | string | Updated account ID | -| ↳ `updated` | boolean | Whether account was updated | +| ↳ `id` | string | The Salesforce ID of the updated record | +| ↳ `updated` | boolean | Whether the record was updated \(always true on success\) | ### `salesforce_delete_account` @@ -149,8 +149,8 @@ Delete an account from Salesforce CRM | --------- | ---- | ----------- | | `success` | boolean | Operation success status | | `output` | object | Deleted account data | -| ↳ `id` | string | Deleted account ID | -| ↳ `deleted` | boolean | Whether account was deleted | +| ↳ `id` | string | The Salesforce ID of the deleted record | +| ↳ `deleted` | boolean | Whether the record was deleted \(always true on success\) | ### `salesforce_get_contacts` @@ -173,17 +173,17 @@ Get contact(s) from Salesforce - single contact if ID provided, or list if not | --------- | ---- | ----------- | | `success` | boolean | Operation success status | | `output` | object | Contact\(s\) data | -| ↳ `contacts` | array | Array of contacts \(list query\) | -| ↳ `contact` | object | Single contact \(by ID\) | -| ↳ `paging` | object | Pagination information | -| ↳ `nextRecordsUrl` | string | URL for next page of results | -| ↳ `totalSize` | number | Total number of records | -| ↳ `done` | boolean | Whether all records returned | -| ↳ `metadata` | object | Response metadata | -| ↳ `totalReturned` | number | Number of contacts returned | -| ↳ `hasMore` | boolean | Whether more records exist | -| ↳ `singleContact` | boolean | Whether single contact was returned | -| ↳ `success` | boolean | Salesforce operation success | +| ↳ `paging` | object | Pagination information from Salesforce API | +| ↳ `nextRecordsUrl` | string | URL to fetch the next batch of records \(present when done is false\) | +| ↳ `totalSize` | number | Total number of records matching the query \(may exceed records returned\) | +| ↳ `done` | boolean | Whether all records have been returned \(false if more batches exist\) | +| ↳ `metadata` | object | Response metadata | +| ↳ `totalReturned` | number | Number of records returned in this response | +| ↳ `hasMore` | boolean | Whether more records exist \(inverse of done\) | +| ↳ `contacts` | array | Array of contacts \(list query\) | +| ↳ `contact` | object | Single contact \(by ID\) | +| ↳ `singleContact` | boolean | Whether single contact was returned | +| ↳ `success` | boolean | Salesforce operation success | ### `salesforce_create_contact` @@ -215,9 +215,9 @@ Create a new contact in Salesforce CRM | --------- | ---- | ----------- | | `success` | boolean | Operation success status | | `output` | object | Created contact data | -| ↳ `id` | string | Created contact ID | -| ↳ `success` | boolean | Salesforce operation success | -| ↳ `created` | boolean | Whether contact was created | +| ↳ `id` | string | The Salesforce ID of the newly created record | +| ↳ `success` | boolean | Whether the create operation was successful | +| ↳ `created` | boolean | Whether the record was created \(always true on success\) | ### `salesforce_update_contact` @@ -250,8 +250,8 @@ Update an existing contact in Salesforce CRM | --------- | ---- | ----------- | | `success` | boolean | Operation success status | | `output` | object | Updated contact data | -| ↳ `id` | string | Updated contact ID | -| ↳ `updated` | boolean | Whether contact was updated | +| ↳ `id` | string | The Salesforce ID of the updated record | +| ↳ `updated` | boolean | Whether the record was updated \(always true on success\) | ### `salesforce_delete_contact` @@ -271,8 +271,8 @@ Delete a contact from Salesforce CRM | --------- | ---- | ----------- | | `success` | boolean | Operation success status | | `output` | object | Deleted contact data | -| ↳ `id` | string | Deleted contact ID | -| ↳ `deleted` | boolean | Whether contact was deleted | +| ↳ `id` | string | The Salesforce ID of the deleted record | +| ↳ `deleted` | boolean | Whether the record was deleted \(always true on success\) | ### `salesforce_get_leads` @@ -295,17 +295,17 @@ Get lead(s) from Salesforce | --------- | ---- | ----------- | | `success` | boolean | Operation success status | | `output` | object | Lead data | -| ↳ `lead` | object | Single lead object \(when leadId provided\) | -| ↳ `leads` | array | Array of lead objects \(when listing\) | -| ↳ `paging` | object | Pagination information | -| ↳ `nextRecordsUrl` | string | URL for next page of results | -| ↳ `totalSize` | number | Total number of records | -| ↳ `done` | boolean | Whether all records returned | -| ↳ `metadata` | object | Response metadata | -| ↳ `totalReturned` | number | Number of leads returned | -| ↳ `hasMore` | boolean | Whether more records exist | -| ↳ `singleLead` | boolean | Whether single lead was returned | -| ↳ `success` | boolean | Operation success status | +| ↳ `paging` | object | Pagination information from Salesforce API | +| ↳ `nextRecordsUrl` | string | URL to fetch the next batch of records \(present when done is false\) | +| ↳ `totalSize` | number | Total number of records matching the query \(may exceed records returned\) | +| ↳ `done` | boolean | Whether all records have been returned \(false if more batches exist\) | +| ↳ `metadata` | object | Response metadata | +| ↳ `totalReturned` | number | Number of records returned in this response | +| ↳ `hasMore` | boolean | Whether more records exist \(inverse of done\) | +| ↳ `lead` | object | Single lead object \(when leadId provided\) | +| ↳ `leads` | array | Array of lead objects \(when listing\) | +| ↳ `singleLead` | boolean | Whether single lead was returned | +| ↳ `success` | boolean | Operation success status | ### `salesforce_create_lead` @@ -333,9 +333,9 @@ Create a new lead | --------- | ---- | ----------- | | `success` | boolean | Operation success status | | `output` | object | Created lead data | -| ↳ `id` | string | Created lead ID | -| ↳ `success` | boolean | Salesforce operation success | -| ↳ `created` | boolean | Whether lead was created | +| ↳ `id` | string | The Salesforce ID of the newly created record | +| ↳ `success` | boolean | Whether the create operation was successful | +| ↳ `created` | boolean | Whether the record was created \(always true on success\) | ### `salesforce_update_lead` @@ -364,8 +364,8 @@ Update an existing lead | --------- | ---- | ----------- | | `success` | boolean | Operation success status | | `output` | object | Updated lead data | -| ↳ `id` | string | Updated lead ID | -| ↳ `updated` | boolean | Whether lead was updated | +| ↳ `id` | string | The Salesforce ID of the updated record | +| ↳ `updated` | boolean | Whether the record was updated \(always true on success\) | ### `salesforce_delete_lead` @@ -385,8 +385,8 @@ Delete a lead | --------- | ---- | ----------- | | `success` | boolean | Operation success status | | `output` | object | Deleted lead data | -| ↳ `id` | string | Deleted lead ID | -| ↳ `deleted` | boolean | Whether lead was deleted | +| ↳ `id` | string | The Salesforce ID of the deleted record | +| ↳ `deleted` | boolean | Whether the record was deleted \(always true on success\) | ### `salesforce_get_opportunities` @@ -409,16 +409,16 @@ Get opportunity(ies) from Salesforce | --------- | ---- | ----------- | | `success` | boolean | Operation success status | | `output` | object | Opportunity data | -| ↳ `opportunity` | object | Single opportunity object \(when opportunityId provided\) | -| ↳ `opportunities` | array | Array of opportunity objects \(when listing\) | -| ↳ `paging` | object | Pagination information | -| ↳ `nextRecordsUrl` | string | URL for next page of results | -| ↳ `totalSize` | number | Total number of records | -| ↳ `done` | boolean | Whether all records returned | -| ↳ `metadata` | object | Response metadata | -| ↳ `totalReturned` | number | Number of opportunities returned | -| ↳ `hasMore` | boolean | Whether more records exist | -| ↳ `success` | boolean | Operation success status | +| ↳ `paging` | object | Pagination information from Salesforce API | +| ↳ `nextRecordsUrl` | string | URL to fetch the next batch of records \(present when done is false\) | +| ↳ `totalSize` | number | Total number of records matching the query \(may exceed records returned\) | +| ↳ `done` | boolean | Whether all records have been returned \(false if more batches exist\) | +| ↳ `metadata` | object | Response metadata | +| ↳ `totalReturned` | number | Number of records returned in this response | +| ↳ `hasMore` | boolean | Whether more records exist \(inverse of done\) | +| ↳ `opportunity` | object | Single opportunity object \(when opportunityId provided\) | +| ↳ `opportunities` | array | Array of opportunity objects \(when listing\) | +| ↳ `success` | boolean | Operation success status | ### `salesforce_create_opportunity` @@ -444,9 +444,9 @@ Create a new opportunity | --------- | ---- | ----------- | | `success` | boolean | Operation success status | | `output` | object | Created opportunity data | -| ↳ `id` | string | Created opportunity ID | -| ↳ `success` | boolean | Salesforce operation success | -| ↳ `created` | boolean | Whether opportunity was created | +| ↳ `id` | string | The Salesforce ID of the newly created record | +| ↳ `success` | boolean | Whether the create operation was successful | +| ↳ `created` | boolean | Whether the record was created \(always true on success\) | ### `salesforce_update_opportunity` @@ -473,8 +473,8 @@ Update an existing opportunity | --------- | ---- | ----------- | | `success` | boolean | Operation success status | | `output` | object | Updated opportunity data | -| ↳ `id` | string | Updated opportunity ID | -| ↳ `updated` | boolean | Whether opportunity was updated | +| ↳ `id` | string | The Salesforce ID of the updated record | +| ↳ `updated` | boolean | Whether the record was updated \(always true on success\) | ### `salesforce_delete_opportunity` @@ -494,8 +494,8 @@ Delete an opportunity | --------- | ---- | ----------- | | `success` | boolean | Operation success status | | `output` | object | Deleted opportunity data | -| ↳ `id` | string | Deleted opportunity ID | -| ↳ `deleted` | boolean | Whether opportunity was deleted | +| ↳ `id` | string | The Salesforce ID of the deleted record | +| ↳ `deleted` | boolean | Whether the record was deleted \(always true on success\) | ### `salesforce_get_cases` @@ -518,16 +518,16 @@ Get case(s) from Salesforce | --------- | ---- | ----------- | | `success` | boolean | Operation success status | | `output` | object | Case data | -| ↳ `case` | object | Single case object \(when caseId provided\) | -| ↳ `cases` | array | Array of case objects \(when listing\) | -| ↳ `paging` | object | Pagination information | -| ↳ `nextRecordsUrl` | string | URL for next page of results | -| ↳ `totalSize` | number | Total number of records | -| ↳ `done` | boolean | Whether all records returned | -| ↳ `metadata` | object | Response metadata | -| ↳ `totalReturned` | number | Number of cases returned | -| ↳ `hasMore` | boolean | Whether more records exist | -| ↳ `success` | boolean | Operation success status | +| ↳ `paging` | object | Pagination information from Salesforce API | +| ↳ `nextRecordsUrl` | string | URL to fetch the next batch of records \(present when done is false\) | +| ↳ `totalSize` | number | Total number of records matching the query \(may exceed records returned\) | +| ↳ `done` | boolean | Whether all records have been returned \(false if more batches exist\) | +| ↳ `metadata` | object | Response metadata | +| ↳ `totalReturned` | number | Number of records returned in this response | +| ↳ `hasMore` | boolean | Whether more records exist \(inverse of done\) | +| ↳ `case` | object | Single case object \(when caseId provided\) | +| ↳ `cases` | array | Array of case objects \(when listing\) | +| ↳ `success` | boolean | Operation success status | ### `salesforce_create_case` @@ -553,9 +553,9 @@ Create a new case | --------- | ---- | ----------- | | `success` | boolean | Operation success status | | `output` | object | Created case data | -| ↳ `id` | string | Created case ID | -| ↳ `success` | boolean | Salesforce operation success | -| ↳ `created` | boolean | Whether case was created | +| ↳ `id` | string | The Salesforce ID of the newly created record | +| ↳ `success` | boolean | Whether the create operation was successful | +| ↳ `created` | boolean | Whether the record was created \(always true on success\) | ### `salesforce_update_case` @@ -579,8 +579,8 @@ Update an existing case | --------- | ---- | ----------- | | `success` | boolean | Operation success status | | `output` | object | Updated case data | -| ↳ `id` | string | Updated case ID | -| ↳ `updated` | boolean | Whether case was updated | +| ↳ `id` | string | The Salesforce ID of the updated record | +| ↳ `updated` | boolean | Whether the record was updated \(always true on success\) | ### `salesforce_delete_case` @@ -600,8 +600,8 @@ Delete a case | --------- | ---- | ----------- | | `success` | boolean | Operation success status | | `output` | object | Deleted case data | -| ↳ `id` | string | Deleted case ID | -| ↳ `deleted` | boolean | Whether case was deleted | +| ↳ `id` | string | The Salesforce ID of the deleted record | +| ↳ `deleted` | boolean | Whether the record was deleted \(always true on success\) | ### `salesforce_get_tasks` @@ -624,16 +624,16 @@ Get task(s) from Salesforce | --------- | ---- | ----------- | | `success` | boolean | Operation success status | | `output` | object | Task data | -| ↳ `task` | object | Single task object \(when taskId provided\) | -| ↳ `tasks` | array | Array of task objects \(when listing\) | -| ↳ `paging` | object | Pagination information | -| ↳ `nextRecordsUrl` | string | URL for next page of results | -| ↳ `totalSize` | number | Total number of records | -| ↳ `done` | boolean | Whether all records returned | -| ↳ `metadata` | object | Response metadata | -| ↳ `totalReturned` | number | Number of tasks returned | -| ↳ `hasMore` | boolean | Whether more records exist | -| ↳ `success` | boolean | Operation success status | +| ↳ `paging` | object | Pagination information from Salesforce API | +| ↳ `nextRecordsUrl` | string | URL to fetch the next batch of records \(present when done is false\) | +| ↳ `totalSize` | number | Total number of records matching the query \(may exceed records returned\) | +| ↳ `done` | boolean | Whether all records have been returned \(false if more batches exist\) | +| ↳ `metadata` | object | Response metadata | +| ↳ `totalReturned` | number | Number of records returned in this response | +| ↳ `hasMore` | boolean | Whether more records exist \(inverse of done\) | +| ↳ `task` | object | Single task object \(when taskId provided\) | +| ↳ `tasks` | array | Array of task objects \(when listing\) | +| ↳ `success` | boolean | Operation success status | ### `salesforce_create_task` @@ -659,9 +659,9 @@ Create a new task | --------- | ---- | ----------- | | `success` | boolean | Operation success status | | `output` | object | Created task data | -| ↳ `id` | string | Created task ID | -| ↳ `success` | boolean | Salesforce operation success | -| ↳ `created` | boolean | Whether task was created | +| ↳ `id` | string | The Salesforce ID of the newly created record | +| ↳ `success` | boolean | Whether the create operation was successful | +| ↳ `created` | boolean | Whether the record was created \(always true on success\) | ### `salesforce_update_task` @@ -686,8 +686,8 @@ Update an existing task | --------- | ---- | ----------- | | `success` | boolean | Operation success status | | `output` | object | Updated task data | -| ↳ `id` | string | Updated task ID | -| ↳ `updated` | boolean | Whether task was updated | +| ↳ `id` | string | The Salesforce ID of the updated record | +| ↳ `updated` | boolean | Whether the record was updated \(always true on success\) | ### `salesforce_delete_task` @@ -707,8 +707,8 @@ Delete a task | --------- | ---- | ----------- | | `success` | boolean | Operation success status | | `output` | object | Deleted task data | -| ↳ `id` | string | Deleted task ID | -| ↳ `deleted` | boolean | Whether task was deleted | +| ↳ `id` | string | The Salesforce ID of the deleted record | +| ↳ `deleted` | boolean | Whether the record was deleted \(always true on success\) | ### `salesforce_list_reports` @@ -729,9 +729,9 @@ Get a list of reports accessible by the current user | --------- | ---- | ----------- | | `success` | boolean | Operation success status | | `output` | object | Reports data | -| ↳ `reports` | array | Array of report objects | -| ↳ `totalReturned` | number | Number of reports returned | -| ↳ `success` | boolean | Salesforce operation success | +| ↳ `totalReturned` | number | Number of items returned | +| ↳ `success` | boolean | Salesforce operation success | +| ↳ `reports` | array | Array of report objects | ### `salesforce_get_report` @@ -751,9 +751,9 @@ Get metadata and describe information for a specific report | --------- | ---- | ----------- | | `success` | boolean | Operation success status | | `output` | object | Report metadata | -| ↳ `report` | object | Report metadata object | -| ↳ `reportId` | string | Report ID | -| ↳ `success` | boolean | Salesforce operation success | +| ↳ `report` | object | Report metadata object | +| ↳ `reportId` | string | Report ID | +| ↳ `success` | boolean | Salesforce operation success | ### `salesforce_run_report` @@ -775,17 +775,17 @@ Execute a report and retrieve the results | --------- | ---- | ----------- | | `success` | boolean | Operation success status | | `output` | object | Report results | -| ↳ `reportId` | string | Report ID | -| ↳ `reportMetadata` | object | Report metadata | -| ↳ `reportExtendedMetadata` | object | Extended metadata | -| ↳ `factMap` | object | Report data organized by groupings | -| ↳ `groupingsDown` | object | Row groupings | -| ↳ `groupingsAcross` | object | Column groupings | -| ↳ `hasDetailRows` | boolean | Whether report has detail rows | -| ↳ `allData` | boolean | Whether all data is returned | -| ↳ `reportName` | string | Report name | -| ↳ `reportFormat` | string | Report format type | -| ↳ `success` | boolean | Salesforce operation success | +| ↳ `reportId` | string | Report ID | +| ↳ `reportMetadata` | object | Report metadata including name, format, and filter definitions | +| ↳ `reportExtendedMetadata` | object | Extended metadata for aggregate columns and groupings | +| ↳ `factMap` | object | Report data organized by groupings with aggregates and row data | +| ↳ `groupingsDown` | object | Row grouping hierarchy and values | +| ↳ `groupingsAcross` | object | Column grouping hierarchy and values | +| ↳ `hasDetailRows` | boolean | Whether the report includes detail-level row data | +| ↳ `allData` | boolean | Whether all data is returned \(false if truncated due to size limits\) | +| ↳ `reportName` | string | Display name of the report | +| ↳ `reportFormat` | string | Report format type \(TABULAR, SUMMARY, MATRIX, JOINED\) | +| ↳ `success` | boolean | Salesforce operation success | ### `salesforce_list_report_types` @@ -804,9 +804,9 @@ Get a list of available report types | --------- | ---- | ----------- | | `success` | boolean | Operation success status | | `output` | object | Report types data | -| ↳ `reportTypes` | array | Array of report type objects | -| ↳ `totalReturned` | number | Number of report types returned | -| ↳ `success` | boolean | Salesforce operation success | +| ↳ `totalReturned` | number | Number of items returned | +| ↳ `success` | boolean | Salesforce operation success | +| ↳ `reportTypes` | array | Array of report type objects | ### `salesforce_list_dashboards` @@ -826,9 +826,9 @@ Get a list of dashboards accessible by the current user | --------- | ---- | ----------- | | `success` | boolean | Operation success status | | `output` | object | Dashboards data | -| ↳ `dashboards` | array | Array of dashboard objects | -| ↳ `totalReturned` | number | Number of dashboards returned | -| ↳ `success` | boolean | Salesforce operation success | +| ↳ `totalReturned` | number | Number of items returned | +| ↳ `success` | boolean | Salesforce operation success | +| ↳ `dashboards` | array | Array of dashboard objects | ### `salesforce_get_dashboard` @@ -848,13 +848,13 @@ Get details and results for a specific dashboard | --------- | ---- | ----------- | | `success` | boolean | Operation success status | | `output` | object | Dashboard data | -| ↳ `dashboard` | object | Dashboard details | -| ↳ `dashboardId` | string | Dashboard ID | -| ↳ `components` | array | Dashboard component data | -| ↳ `dashboardName` | string | Dashboard name | -| ↳ `folderId` | string | Folder ID containing the dashboard | -| ↳ `runningUser` | object | Running user information | -| ↳ `success` | boolean | Salesforce operation success | +| ↳ `dashboard` | object | Full dashboard details object | +| ↳ `dashboardId` | string | Dashboard ID | +| ↳ `components` | array | Array of dashboard component data with visualizations and filters | +| ↳ `dashboardName` | string | Display name of the dashboard | +| ↳ `folderId` | string | ID of the folder containing the dashboard | +| ↳ `runningUser` | object | User context under which the dashboard data was retrieved | +| ↳ `success` | boolean | Salesforce operation success | ### `salesforce_refresh_dashboard` @@ -874,13 +874,13 @@ Refresh a dashboard to get the latest data | --------- | ---- | ----------- | | `success` | boolean | Operation success status | | `output` | object | Refreshed dashboard data | -| ↳ `dashboard` | object | Dashboard details | -| ↳ `dashboardId` | string | Dashboard ID | -| ↳ `components` | array | Dashboard component data | -| ↳ `status` | object | Dashboard status | -| ↳ `dashboardName` | string | Dashboard name | -| ↳ `refreshDate` | string | Date when dashboard was refreshed | -| ↳ `success` | boolean | Salesforce operation success | +| ↳ `dashboard` | object | Full dashboard details object | +| ↳ `dashboardId` | string | Dashboard ID | +| ↳ `components` | array | Array of dashboard component data with fresh visualizations | +| ↳ `status` | object | Dashboard refresh status information | +| ↳ `dashboardName` | string | Display name of the dashboard | +| ↳ `refreshDate` | string | ISO 8601 timestamp when the dashboard was last refreshed | +| ↳ `success` | boolean | Salesforce operation success | ### `salesforce_query` @@ -900,15 +900,12 @@ Execute a custom SOQL query to retrieve data from Salesforce | --------- | ---- | ----------- | | `success` | boolean | Operation success status | | `output` | object | Query results | -| ↳ `records` | array | Array of record objects | -| ↳ `totalSize` | number | Total number of records matching query | -| ↳ `done` | boolean | Whether all records have been returned | -| ↳ `nextRecordsUrl` | string | URL to fetch next batch of records | -| ↳ `query` | string | The executed SOQL query | -| ↳ `metadata` | object | Response metadata | -| ↳ `totalReturned` | number | Number of records returned in this response | -| ↳ `hasMore` | boolean | Whether more records exist | -| ↳ `success` | boolean | Salesforce operation success | +| ↳ `records` | array | Array of sObject records matching the query | +| ↳ `query` | string | The executed SOQL query | +| ↳ `metadata` | object | Response metadata | +| ↳ `totalReturned` | number | Number of records returned in this response | +| ↳ `hasMore` | boolean | Whether more records exist \(inverse of done\) | +| ↳ `success` | boolean | Salesforce operation success | ### `salesforce_query_more` @@ -928,14 +925,11 @@ Retrieve additional query results using the nextRecordsUrl from a previous query | --------- | ---- | ----------- | | `success` | boolean | Operation success status | | `output` | object | Query results | -| ↳ `records` | array | Array of record objects | -| ↳ `totalSize` | number | Total number of records matching query | -| ↳ `done` | boolean | Whether all records have been returned | -| ↳ `nextRecordsUrl` | string | URL to fetch next batch of records | -| ↳ `metadata` | object | Response metadata | -| ↳ `totalReturned` | number | Number of records returned in this response | -| ↳ `hasMore` | boolean | Whether more records exist | -| ↳ `success` | boolean | Salesforce operation success | +| ↳ `records` | array | Array of sObject records matching the query | +| ↳ `metadata` | object | Response metadata | +| ↳ `totalReturned` | number | Number of records returned in this response | +| ↳ `hasMore` | boolean | Whether more records exist \(inverse of done\) | +| ↳ `success` | boolean | Salesforce operation success | ### `salesforce_describe_object` @@ -955,19 +949,42 @@ Get metadata and field information for a Salesforce object | --------- | ---- | ----------- | | `success` | boolean | Operation success status | | `output` | object | Object metadata | -| ↳ `objectName` | string | API name of the object | -| ↳ `label` | string | Display label | -| ↳ `labelPlural` | string | Plural display label | -| ↳ `fields` | array | Array of field definitions | -| ↳ `keyPrefix` | string | ID prefix for this object type | -| ↳ `queryable` | boolean | Whether object can be queried | -| ↳ `createable` | boolean | Whether records can be created | -| ↳ `updateable` | boolean | Whether records can be updated | -| ↳ `deletable` | boolean | Whether records can be deleted | -| ↳ `childRelationships` | array | Child relationship definitions | -| ↳ `recordTypeInfos` | array | Record type information | -| ↳ `fieldCount` | number | Number of fields in the object | -| ↳ `success` | boolean | Salesforce operation success | +| ↳ `objectName` | string | API name of the object \(e.g., Account, Contact\) | +| ↳ `label` | string | Human-readable singular label for the object | +| ↳ `labelPlural` | string | Human-readable plural label for the object | +| ↳ `fields` | array | Array of field metadata objects | +| ↳ `name` | string | API name of the field | +| ↳ `label` | string | Display label of the field | +| ↳ `type` | string | Field data type \(string, boolean, int, double, date, etc.\) | +| ↳ `length` | number | Maximum length for text fields | +| ↳ `precision` | number | Precision for numeric fields | +| ↳ `scale` | number | Scale for numeric fields | +| ↳ `nillable` | boolean | Whether the field can be null | +| ↳ `unique` | boolean | Whether values must be unique | +| ↳ `createable` | boolean | Whether field can be set on create | +| ↳ `updateable` | boolean | Whether field can be updated | +| ↳ `defaultedOnCreate` | boolean | Whether field has default value on create | +| ↳ `calculated` | boolean | Whether field is a formula field | +| ↳ `autoNumber` | boolean | Whether field is auto-number | +| ↳ `externalId` | boolean | Whether field is an external ID | +| ↳ `idLookup` | boolean | Whether field can be used in ID lookup | +| ↳ `inlineHelpText` | string | Help text for the field | +| ↳ `picklistValues` | array | Available picklist values for picklist fields | +| ↳ `referenceTo` | array | Objects this field can reference \(for lookup fields\) | +| ↳ `relationshipName` | string | Relationship name for lookup fields | +| ↳ `custom` | boolean | Whether this is a custom field | +| ↳ `filterable` | boolean | Whether field can be used in SOQL filter | +| ↳ `groupable` | boolean | Whether field can be used in GROUP BY | +| ↳ `sortable` | boolean | Whether field can be used in ORDER BY | +| ↳ `keyPrefix` | string | Three-character prefix used in record IDs \(e.g., "001" for Account\) | +| ↳ `queryable` | boolean | Whether the object can be queried via SOQL | +| ↳ `createable` | boolean | Whether records can be created for this object | +| ↳ `updateable` | boolean | Whether records can be updated for this object | +| ↳ `deletable` | boolean | Whether records can be deleted for this object | +| ↳ `childRelationships` | array | Array of child relationship metadata for related objects | +| ↳ `recordTypeInfos` | array | Array of record type information for the object | +| ↳ `fieldCount` | number | Total number of fields on the object | +| ↳ `success` | boolean | Salesforce operation success | ### `salesforce_list_objects` @@ -986,10 +1003,26 @@ Get a list of all available Salesforce objects | --------- | ---- | ----------- | | `success` | boolean | Operation success status | | `output` | object | Objects list | -| ↳ `objects` | array | Array of available Salesforce objects | -| ↳ `encoding` | string | Encoding used | -| ↳ `maxBatchSize` | number | Maximum batch size | -| ↳ `totalReturned` | number | Number of objects returned | -| ↳ `success` | boolean | Salesforce operation success | +| ↳ `objects` | array | Array of sObject metadata | +| ↳ `name` | string | API name of the object | +| ↳ `label` | string | Display label of the object | +| ↳ `labelPlural` | string | Plural display label | +| ↳ `keyPrefix` | string | Three-character ID prefix | +| ↳ `custom` | boolean | Whether this is a custom object | +| ↳ `queryable` | boolean | Whether object can be queried | +| ↳ `createable` | boolean | Whether records can be created | +| ↳ `updateable` | boolean | Whether records can be updated | +| ↳ `deletable` | boolean | Whether records can be deleted | +| ↳ `searchable` | boolean | Whether object is searchable | +| ↳ `triggerable` | boolean | Whether triggers are supported | +| ↳ `layoutable` | boolean | Whether page layouts are supported | +| ↳ `replicateable` | boolean | Whether object can be replicated | +| ↳ `retrieveable` | boolean | Whether records can be retrieved | +| ↳ `undeletable` | boolean | Whether records can be undeleted | +| ↳ `urls` | object | URLs for accessing object resources | +| ↳ `encoding` | string | Character encoding for the organization \(e.g., UTF-8\) | +| ↳ `maxBatchSize` | number | Maximum number of records that can be returned in a single query batch \(typically 200\) | +| ↳ `totalReturned` | number | Number of objects returned | +| ↳ `success` | boolean | Salesforce operation success | diff --git a/apps/docs/content/docs/en/tools/sentry.mdx b/apps/docs/content/docs/en/tools/sentry.mdx index daf136c4c..a2e6f020a 100644 --- a/apps/docs/content/docs/en/tools/sentry.mdx +++ b/apps/docs/content/docs/en/tools/sentry.mdx @@ -80,20 +80,20 @@ List issues from Sentry for a specific organization and optionally a specific pr | ↳ `isPublic` | boolean | Whether the issue is publicly visible | | ↳ `platform` | string | Platform where the issue occurred | | ↳ `project` | object | Project information | -| ↳ `id` | string | Project ID | -| ↳ `name` | string | Project name | -| ↳ `slug` | string | Project slug | -| ↳ `platform` | string | Project platform | +| ↳ `id` | string | Project ID | +| ↳ `name` | string | Project name | +| ↳ `slug` | string | Project slug | +| ↳ `platform` | string | Project platform | | ↳ `type` | string | Issue type | | ↳ `metadata` | object | Error metadata | -| ↳ `type` | string | Type of error \(e.g., TypeError\) | -| ↳ `value` | string | Error message or value | -| ↳ `function` | string | Function where the error occurred | +| ↳ `type` | string | Type of error \(e.g., TypeError\) | +| ↳ `value` | string | Error message or value | +| ↳ `function` | string | Function where the error occurred | | ↳ `numComments` | number | Number of comments on the issue | | ↳ `assignedTo` | object | User assigned to the issue | -| ↳ `id` | string | User ID | -| ↳ `name` | string | User name | -| ↳ `email` | string | User email | +| ↳ `id` | string | User ID | +| ↳ `name` | string | User name | +| ↳ `email` | string | User email | | ↳ `isBookmarked` | boolean | Whether the issue is bookmarked | | ↳ `isSubscribed` | boolean | Whether subscribed to updates | | ↳ `hasSeen` | boolean | Whether the user has seen this issue | @@ -105,8 +105,8 @@ List issues from Sentry for a specific organization and optionally a specific pr | ↳ `lastSeen` | string | When the issue was last seen \(ISO timestamp\) | | ↳ `stats` | object | Statistical information about the issue | | `metadata` | object | Pagination metadata | -| ↳ `nextCursor` | string | Cursor for the next page of results \(if available\) | -| ↳ `hasMore` | boolean | Whether there are more results available | +| ↳ `nextCursor` | string | Cursor for the next page of results \(if available\) | +| ↳ `hasMore` | boolean | Whether there are more results available | ### `sentry_issues_get` @@ -125,42 +125,42 @@ Retrieve detailed information about a specific Sentry issue by its ID. Returns c | Parameter | Type | Description | | --------- | ---- | ----------- | | `issue` | object | Detailed information about the Sentry issue | -| ↳ `id` | string | Unique issue ID | -| ↳ `shortId` | string | Short issue identifier | -| ↳ `title` | string | Issue title | -| ↳ `culprit` | string | Function or location that caused the issue | -| ↳ `permalink` | string | Direct link to the issue in Sentry | -| ↳ `logger` | string | Logger name that reported the issue | -| ↳ `level` | string | Severity level \(error, warning, info, etc.\) | -| ↳ `status` | string | Current issue status | -| ↳ `statusDetails` | object | Additional details about the status | -| ↳ `isPublic` | boolean | Whether the issue is publicly visible | -| ↳ `platform` | string | Platform where the issue occurred | -| ↳ `project` | object | Project information | -| ↳ `id` | string | Project ID | -| ↳ `name` | string | Project name | -| ↳ `slug` | string | Project slug | -| ↳ `platform` | string | Project platform | -| ↳ `type` | string | Issue type | -| ↳ `metadata` | object | Error metadata | -| ↳ `type` | string | Type of error \(e.g., TypeError, ValueError\) | -| ↳ `value` | string | Error message or value | -| ↳ `function` | string | Function where the error occurred | -| ↳ `numComments` | number | Number of comments on the issue | -| ↳ `assignedTo` | object | User assigned to the issue \(if any\) | -| ↳ `id` | string | User ID | -| ↳ `name` | string | User name | -| ↳ `email` | string | User email | -| ↳ `isBookmarked` | boolean | Whether the issue is bookmarked | -| ↳ `isSubscribed` | boolean | Whether the user is subscribed to updates | -| ↳ `hasSeen` | boolean | Whether the user has seen this issue | -| ↳ `annotations` | array | Issue annotations | -| ↳ `isUnhandled` | boolean | Whether the issue is unhandled | -| ↳ `count` | string | Total number of occurrences | -| ↳ `userCount` | number | Number of unique users affected | -| ↳ `firstSeen` | string | When the issue was first seen \(ISO timestamp\) | -| ↳ `lastSeen` | string | When the issue was last seen \(ISO timestamp\) | -| ↳ `stats` | object | Statistical information about the issue | +| ↳ `id` | string | Unique issue ID | +| ↳ `shortId` | string | Short issue identifier | +| ↳ `title` | string | Issue title | +| ↳ `culprit` | string | Function or location that caused the issue | +| ↳ `permalink` | string | Direct link to the issue in Sentry | +| ↳ `logger` | string | Logger name that reported the issue | +| ↳ `level` | string | Severity level \(error, warning, info, etc.\) | +| ↳ `status` | string | Current issue status | +| ↳ `statusDetails` | object | Additional details about the status | +| ↳ `isPublic` | boolean | Whether the issue is publicly visible | +| ↳ `platform` | string | Platform where the issue occurred | +| ↳ `project` | object | Project information | +| ↳ `id` | string | Project ID | +| ↳ `name` | string | Project name | +| ↳ `slug` | string | Project slug | +| ↳ `platform` | string | Project platform | +| ↳ `type` | string | Issue type | +| ↳ `metadata` | object | Error metadata | +| ↳ `type` | string | Type of error \(e.g., TypeError, ValueError\) | +| ↳ `value` | string | Error message or value | +| ↳ `function` | string | Function where the error occurred | +| ↳ `numComments` | number | Number of comments on the issue | +| ↳ `assignedTo` | object | User assigned to the issue \(if any\) | +| ↳ `id` | string | User ID | +| ↳ `name` | string | User name | +| ↳ `email` | string | User email | +| ↳ `isBookmarked` | boolean | Whether the issue is bookmarked | +| ↳ `isSubscribed` | boolean | Whether the user is subscribed to updates | +| ↳ `hasSeen` | boolean | Whether the user has seen this issue | +| ↳ `annotations` | array | Issue annotations | +| ↳ `isUnhandled` | boolean | Whether the issue is unhandled | +| ↳ `count` | string | Total number of occurrences | +| ↳ `userCount` | number | Number of unique users affected | +| ↳ `firstSeen` | string | When the issue was first seen \(ISO timestamp\) | +| ↳ `lastSeen` | string | When the issue was last seen \(ISO timestamp\) | +| ↳ `stats` | object | Statistical information about the issue | ### `sentry_issues_update` @@ -184,18 +184,18 @@ Update a Sentry issue by changing its status, assignment, bookmark state, or oth | Parameter | Type | Description | | --------- | ---- | ----------- | | `issue` | object | The updated Sentry issue | -| ↳ `id` | string | Unique issue ID | -| ↳ `shortId` | string | Short issue identifier | -| ↳ `title` | string | Issue title | -| ↳ `status` | string | Updated issue status | -| ↳ `assignedTo` | object | User assigned to the issue \(if any\) | -| ↳ `id` | string | User ID | -| ↳ `name` | string | User name | -| ↳ `email` | string | User email | -| ↳ `isBookmarked` | boolean | Whether the issue is bookmarked | -| ↳ `isSubscribed` | boolean | Whether the user is subscribed to updates | -| ↳ `isPublic` | boolean | Whether the issue is publicly visible | -| ↳ `permalink` | string | Direct link to the issue in Sentry | +| ↳ `id` | string | Unique issue ID | +| ↳ `shortId` | string | Short issue identifier | +| ↳ `title` | string | Issue title | +| ↳ `status` | string | Updated issue status | +| ↳ `assignedTo` | object | User assigned to the issue \(if any\) | +| ↳ `id` | string | User ID | +| ↳ `name` | string | User name | +| ↳ `email` | string | User email | +| ↳ `isBookmarked` | boolean | Whether the issue is bookmarked | +| ↳ `isSubscribed` | boolean | Whether the user is subscribed to updates | +| ↳ `isPublic` | boolean | Whether the issue is publicly visible | +| ↳ `permalink` | string | Direct link to the issue in Sentry | ### `sentry_projects_list` @@ -224,18 +224,18 @@ List all projects in a Sentry organization. Returns project details including na | ↳ `isMember` | boolean | Whether the user is a member of the project | | ↳ `features` | array | Enabled features for the project | | ↳ `organization` | object | Organization information | -| ↳ `id` | string | Organization ID | -| ↳ `slug` | string | Organization slug | -| ↳ `name` | string | Organization name | +| ↳ `id` | string | Organization ID | +| ↳ `slug` | string | Organization slug | +| ↳ `name` | string | Organization name | | ↳ `teams` | array | Teams associated with the project | -| ↳ `id` | string | Team ID | -| ↳ `name` | string | Team name | -| ↳ `slug` | string | Team slug | +| ↳ `id` | string | Team ID | +| ↳ `name` | string | Team name | +| ↳ `slug` | string | Team slug | | ↳ `status` | string | Project status | | ↳ `isPublic` | boolean | Whether the project is publicly visible | | `metadata` | object | Pagination metadata | -| ↳ `nextCursor` | string | Cursor for the next page of results \(if available\) | -| ↳ `hasMore` | boolean | Whether there are more results available | +| ↳ `nextCursor` | string | Cursor for the next page of results \(if available\) | +| ↳ `hasMore` | boolean | Whether there are more results available | ### `sentry_projects_get` @@ -254,39 +254,39 @@ Retrieve detailed information about a specific Sentry project by its slug. Retur | Parameter | Type | Description | | --------- | ---- | ----------- | | `project` | object | Detailed information about the Sentry project | -| ↳ `id` | string | Unique project ID | -| ↳ `slug` | string | URL-friendly project identifier | -| ↳ `name` | string | Project name | -| ↳ `platform` | string | Platform/language \(e.g., javascript, python\) | -| ↳ `dateCreated` | string | When the project was created \(ISO timestamp\) | -| ↳ `isBookmarked` | boolean | Whether the project is bookmarked | -| ↳ `isMember` | boolean | Whether the user is a member of the project | -| ↳ `features` | array | Enabled features for the project | -| ↳ `firstEvent` | string | When the first event was received \(ISO timestamp\) | -| ↳ `firstTransactionEvent` | string | When the first transaction event was received | -| ↳ `access` | array | Access permissions | -| ↳ `organization` | object | Organization information | -| ↳ `id` | string | Organization ID | -| ↳ `slug` | string | Organization slug | -| ↳ `name` | string | Organization name | -| ↳ `team` | object | Primary team for the project | -| ↳ `id` | string | Team ID | -| ↳ `name` | string | Team name | -| ↳ `slug` | string | Team slug | -| ↳ `teams` | array | Teams associated with the project | -| ↳ `id` | string | Team ID | -| ↳ `name` | string | Team name | -| ↳ `slug` | string | Team slug | -| ↳ `status` | string | Project status | -| ↳ `color` | string | Project color code | -| ↳ `isPublic` | boolean | Whether the project is publicly visible | -| ↳ `isInternal` | boolean | Whether the project is internal | -| ↳ `hasAccess` | boolean | Whether the user has access to this project | -| ↳ `hasMinifiedStackTrace` | boolean | Whether minified stack traces are available | -| ↳ `hasMonitors` | boolean | Whether the project has monitors configured | -| ↳ `hasProfiles` | boolean | Whether the project has profiling enabled | -| ↳ `hasReplays` | boolean | Whether the project has session replays enabled | -| ↳ `hasSessions` | boolean | Whether the project has sessions enabled | +| ↳ `id` | string | Unique project ID | +| ↳ `slug` | string | URL-friendly project identifier | +| ↳ `name` | string | Project name | +| ↳ `platform` | string | Platform/language \(e.g., javascript, python\) | +| ↳ `dateCreated` | string | When the project was created \(ISO timestamp\) | +| ↳ `isBookmarked` | boolean | Whether the project is bookmarked | +| ↳ `isMember` | boolean | Whether the user is a member of the project | +| ↳ `features` | array | Enabled features for the project | +| ↳ `firstEvent` | string | When the first event was received \(ISO timestamp\) | +| ↳ `firstTransactionEvent` | string | When the first transaction event was received | +| ↳ `access` | array | Access permissions | +| ↳ `organization` | object | Organization information | +| ↳ `id` | string | Organization ID | +| ↳ `slug` | string | Organization slug | +| ↳ `name` | string | Organization name | +| ↳ `team` | object | Primary team for the project | +| ↳ `id` | string | Team ID | +| ↳ `name` | string | Team name | +| ↳ `slug` | string | Team slug | +| ↳ `teams` | array | Teams associated with the project | +| ↳ `id` | string | Team ID | +| ↳ `name` | string | Team name | +| ↳ `slug` | string | Team slug | +| ↳ `status` | string | Project status | +| ↳ `color` | string | Project color code | +| ↳ `isPublic` | boolean | Whether the project is publicly visible | +| ↳ `isInternal` | boolean | Whether the project is internal | +| ↳ `hasAccess` | boolean | Whether the user has access to this project | +| ↳ `hasMinifiedStackTrace` | boolean | Whether minified stack traces are available | +| ↳ `hasMonitors` | boolean | Whether the project has monitors configured | +| ↳ `hasProfiles` | boolean | Whether the project has profiling enabled | +| ↳ `hasReplays` | boolean | Whether the project has session replays enabled | +| ↳ `hasSessions` | boolean | Whether the project has sessions enabled | ### `sentry_projects_create` @@ -309,31 +309,31 @@ Create a new Sentry project in an organization. Requires a team to associate the | Parameter | Type | Description | | --------- | ---- | ----------- | | `project` | object | The newly created Sentry project | -| ↳ `id` | string | Unique project ID | -| ↳ `slug` | string | URL-friendly project identifier | -| ↳ `name` | string | Project name | -| ↳ `platform` | string | Platform/language | -| ↳ `dateCreated` | string | When the project was created \(ISO timestamp\) | -| ↳ `isBookmarked` | boolean | Whether the project is bookmarked | -| ↳ `isMember` | boolean | Whether the user is a member | -| ↳ `hasAccess` | boolean | Whether the user has access | -| ↳ `features` | array | Enabled features | -| ↳ `firstEvent` | string | First event timestamp | -| ↳ `organization` | object | Organization information | -| ↳ `id` | string | Organization ID | -| ↳ `slug` | string | Organization slug | -| ↳ `name` | string | Organization name | -| ↳ `team` | object | Primary team for the project | -| ↳ `id` | string | Team ID | -| ↳ `name` | string | Team name | -| ↳ `slug` | string | Team slug | -| ↳ `teams` | array | Teams associated with the project | -| ↳ `id` | string | Team ID | -| ↳ `name` | string | Team name | -| ↳ `slug` | string | Team slug | -| ↳ `status` | string | Project status | -| ↳ `color` | string | Project color code | -| ↳ `isPublic` | boolean | Whether the project is public | +| ↳ `id` | string | Unique project ID | +| ↳ `slug` | string | URL-friendly project identifier | +| ↳ `name` | string | Project name | +| ↳ `platform` | string | Platform/language | +| ↳ `dateCreated` | string | When the project was created \(ISO timestamp\) | +| ↳ `isBookmarked` | boolean | Whether the project is bookmarked | +| ↳ `isMember` | boolean | Whether the user is a member | +| ↳ `hasAccess` | boolean | Whether the user has access | +| ↳ `features` | array | Enabled features | +| ↳ `firstEvent` | string | First event timestamp | +| ↳ `organization` | object | Organization information | +| ↳ `id` | string | Organization ID | +| ↳ `slug` | string | Organization slug | +| ↳ `name` | string | Organization name | +| ↳ `team` | object | Primary team for the project | +| ↳ `id` | string | Team ID | +| ↳ `name` | string | Team name | +| ↳ `slug` | string | Team slug | +| ↳ `teams` | array | Teams associated with the project | +| ↳ `id` | string | Team ID | +| ↳ `name` | string | Team name | +| ↳ `slug` | string | Team slug | +| ↳ `status` | string | Project status | +| ↳ `color` | string | Project color code | +| ↳ `isPublic` | boolean | Whether the project is public | ### `sentry_projects_update` @@ -358,19 +358,19 @@ Update a Sentry project by changing its name, slug, platform, or other settings. | Parameter | Type | Description | | --------- | ---- | ----------- | | `project` | object | The updated Sentry project | -| ↳ `id` | string | Unique project ID | -| ↳ `slug` | string | URL-friendly project identifier | -| ↳ `name` | string | Project name | -| ↳ `platform` | string | Platform/language | -| ↳ `isBookmarked` | boolean | Whether the project is bookmarked | -| ↳ `organization` | object | Organization information | -| ↳ `id` | string | Organization ID | -| ↳ `slug` | string | Organization slug | -| ↳ `name` | string | Organization name | -| ↳ `teams` | array | Teams associated with the project | -| ↳ `id` | string | Team ID | -| ↳ `name` | string | Team name | -| ↳ `slug` | string | Team slug | +| ↳ `id` | string | Unique project ID | +| ↳ `slug` | string | URL-friendly project identifier | +| ↳ `name` | string | Project name | +| ↳ `platform` | string | Platform/language | +| ↳ `isBookmarked` | boolean | Whether the project is bookmarked | +| ↳ `organization` | object | Organization information | +| ↳ `id` | string | Organization ID | +| ↳ `slug` | string | Organization slug | +| ↳ `name` | string | Organization name | +| ↳ `teams` | array | Teams associated with the project | +| ↳ `id` | string | Team ID | +| ↳ `name` | string | Team name | +| ↳ `slug` | string | Team slug | ### `sentry_events_list` @@ -405,31 +405,31 @@ List events from a Sentry project. Can be filtered by issue ID, query, or time p | ↳ `dateCreated` | string | When the event was created \(ISO timestamp\) | | ↳ `dateReceived` | string | When Sentry received the event \(ISO timestamp\) | | ↳ `user` | object | User information associated with the event | -| ↳ `id` | string | User ID | -| ↳ `email` | string | User email | -| ↳ `username` | string | Username | -| ↳ `ipAddress` | string | IP address | -| ↳ `name` | string | User display name | +| ↳ `id` | string | User ID | +| ↳ `email` | string | User email | +| ↳ `username` | string | Username | +| ↳ `ipAddress` | string | IP address | +| ↳ `name` | string | User display name | | ↳ `tags` | array | Tags associated with the event | -| ↳ `key` | string | Tag key | -| ↳ `value` | string | Tag value | +| ↳ `key` | string | Tag key | +| ↳ `value` | string | Tag value | | ↳ `contexts` | object | Additional context data \(device, OS, etc.\) | | ↳ `platform` | string | Platform where the event occurred | | ↳ `type` | string | Event type | | ↳ `metadata` | object | Error metadata | -| ↳ `type` | string | Type of error \(e.g., TypeError\) | -| ↳ `value` | string | Error message or value | -| ↳ `function` | string | Function where the error occurred | +| ↳ `type` | string | Type of error \(e.g., TypeError\) | +| ↳ `value` | string | Error message or value | +| ↳ `function` | string | Function where the error occurred | | ↳ `entries` | array | Event entries \(exception, breadcrumbs, etc.\) | | ↳ `errors` | array | Processing errors | | ↳ `dist` | string | Distribution identifier | | ↳ `fingerprints` | array | Fingerprints for grouping | | ↳ `sdk` | object | SDK information | -| ↳ `name` | string | SDK name | -| ↳ `version` | string | SDK version | +| ↳ `name` | string | SDK name | +| ↳ `version` | string | SDK version | | `metadata` | object | Pagination metadata | -| ↳ `nextCursor` | string | Cursor for the next page of results \(if available\) | -| ↳ `hasMore` | boolean | Whether there are more results available | +| ↳ `nextCursor` | string | Cursor for the next page of results \(if available\) | +| ↳ `hasMore` | boolean | Whether there are more results available | ### `sentry_events_get` @@ -449,39 +449,39 @@ Retrieve detailed information about a specific Sentry event by its ID. Returns c | Parameter | Type | Description | | --------- | ---- | ----------- | | `event` | object | Detailed information about the Sentry event | -| ↳ `id` | string | Unique event ID | -| ↳ `eventID` | string | Event identifier | -| ↳ `projectID` | string | Project ID | -| ↳ `groupID` | string | Issue group ID this event belongs to | -| ↳ `message` | string | Event message | -| ↳ `title` | string | Event title | -| ↳ `location` | string | Location information | -| ↳ `culprit` | string | Function or location that caused the event | -| ↳ `dateCreated` | string | When the event was created \(ISO timestamp\) | -| ↳ `dateReceived` | string | When Sentry received the event \(ISO timestamp\) | -| ↳ `user` | object | User information associated with the event | -| ↳ `id` | string | User ID | -| ↳ `email` | string | User email | -| ↳ `username` | string | Username | -| ↳ `ipAddress` | string | IP address | -| ↳ `name` | string | User display name | -| ↳ `tags` | array | Tags associated with the event | -| ↳ `key` | string | Tag key | -| ↳ `value` | string | Tag value | -| ↳ `contexts` | object | Additional context data \(device, OS, browser, etc.\) | -| ↳ `platform` | string | Platform where the event occurred | -| ↳ `type` | string | Event type \(error, transaction, etc.\) | -| ↳ `metadata` | object | Error metadata | -| ↳ `type` | string | Type of error \(e.g., TypeError, ValueError\) | -| ↳ `value` | string | Error message or value | -| ↳ `function` | string | Function where the error occurred | -| ↳ `entries` | array | Event entries including exception, breadcrumbs, and request data | -| ↳ `errors` | array | Processing errors that occurred | -| ↳ `dist` | string | Distribution identifier | -| ↳ `fingerprints` | array | Fingerprints used for grouping events | -| ↳ `sdk` | object | SDK information | -| ↳ `name` | string | SDK name | -| ↳ `version` | string | SDK version | +| ↳ `id` | string | Unique event ID | +| ↳ `eventID` | string | Event identifier | +| ↳ `projectID` | string | Project ID | +| ↳ `groupID` | string | Issue group ID this event belongs to | +| ↳ `message` | string | Event message | +| ↳ `title` | string | Event title | +| ↳ `location` | string | Location information | +| ↳ `culprit` | string | Function or location that caused the event | +| ↳ `dateCreated` | string | When the event was created \(ISO timestamp\) | +| ↳ `dateReceived` | string | When Sentry received the event \(ISO timestamp\) | +| ↳ `user` | object | User information associated with the event | +| ↳ `id` | string | User ID | +| ↳ `email` | string | User email | +| ↳ `username` | string | Username | +| ↳ `ipAddress` | string | IP address | +| ↳ `name` | string | User display name | +| ↳ `tags` | array | Tags associated with the event | +| ↳ `key` | string | Tag key | +| ↳ `value` | string | Tag value | +| ↳ `contexts` | object | Additional context data \(device, OS, browser, etc.\) | +| ↳ `platform` | string | Platform where the event occurred | +| ↳ `type` | string | Event type \(error, transaction, etc.\) | +| ↳ `metadata` | object | Error metadata | +| ↳ `type` | string | Type of error \(e.g., TypeError, ValueError\) | +| ↳ `value` | string | Error message or value | +| ↳ `function` | string | Function where the error occurred | +| ↳ `entries` | array | Event entries including exception, breadcrumbs, and request data | +| ↳ `errors` | array | Processing errors that occurred | +| ↳ `dist` | string | Distribution identifier | +| ↳ `fingerprints` | array | Fingerprints used for grouping events | +| ↳ `sdk` | object | SDK information | +| ↳ `name` | string | SDK name | +| ↳ `version` | string | SDK version | ### `sentry_releases_list` @@ -513,39 +513,39 @@ List releases for a Sentry organization or project. Returns release details incl | ↳ `dateStarted` | string | When the release started \(ISO timestamp\) | | ↳ `newGroups` | number | Number of new issues introduced in this release | | ↳ `owner` | object | Owner of the release | -| ↳ `id` | string | User ID | -| ↳ `name` | string | User name | -| ↳ `email` | string | User email | +| ↳ `id` | string | User ID | +| ↳ `name` | string | User name | +| ↳ `email` | string | User email | | ↳ `commitCount` | number | Number of commits in this release | | ↳ `deployCount` | number | Number of deploys for this release | | ↳ `lastCommit` | object | Last commit in the release | -| ↳ `id` | string | Commit SHA | -| ↳ `message` | string | Commit message | -| ↳ `dateCreated` | string | Commit timestamp | +| ↳ `id` | string | Commit SHA | +| ↳ `message` | string | Commit message | +| ↳ `dateCreated` | string | Commit timestamp | | ↳ `lastDeploy` | object | Last deploy of the release | -| ↳ `id` | string | Deploy ID | -| ↳ `environment` | string | Deploy environment | -| ↳ `dateStarted` | string | Deploy start timestamp | -| ↳ `dateFinished` | string | Deploy finish timestamp | +| ↳ `id` | string | Deploy ID | +| ↳ `environment` | string | Deploy environment | +| ↳ `dateStarted` | string | Deploy start timestamp | +| ↳ `dateFinished` | string | Deploy finish timestamp | | ↳ `authors` | array | Authors of commits in the release | -| ↳ `id` | string | Author ID | -| ↳ `name` | string | Author name | -| ↳ `email` | string | Author email | +| ↳ `id` | string | Author ID | +| ↳ `name` | string | Author name | +| ↳ `email` | string | Author email | | ↳ `projects` | array | Projects associated with this release | -| ↳ `id` | string | Project ID | -| ↳ `name` | string | Project name | -| ↳ `slug` | string | Project slug | -| ↳ `platform` | string | Project platform | +| ↳ `id` | string | Project ID | +| ↳ `name` | string | Project name | +| ↳ `slug` | string | Project slug | +| ↳ `platform` | string | Project platform | | ↳ `firstEvent` | string | First event timestamp | | ↳ `lastEvent` | string | Last event timestamp | | ↳ `versionInfo` | object | Version metadata | -| ↳ `buildHash` | string | Build hash | -| ↳ `version` | object | Version details | -| ↳ `raw` | string | Raw version string | -| ↳ `package` | string | Package name | +| ↳ `buildHash` | string | Build hash | +| ↳ `version` | object | Version details | +| ↳ `raw` | string | Raw version string | +| ↳ `package` | string | Package name | | `metadata` | object | Pagination metadata | -| ↳ `nextCursor` | string | Cursor for the next page of results \(if available\) | -| ↳ `hasMore` | boolean | Whether there are more results available | +| ↳ `nextCursor` | string | Cursor for the next page of results \(if available\) | +| ↳ `hasMore` | boolean | Whether there are more results available | ### `sentry_releases_create` @@ -569,46 +569,46 @@ Create a new release in Sentry. A release is a version of your code deployed to | Parameter | Type | Description | | --------- | ---- | ----------- | | `release` | object | The newly created Sentry release | -| ↳ `id` | string | Unique release ID | -| ↳ `version` | string | Release version identifier | -| ↳ `shortVersion` | string | Shortened version identifier | -| ↳ `ref` | string | Git reference \(commit SHA, tag, or branch\) | -| ↳ `url` | string | URL to the release | -| ↳ `dateReleased` | string | When the release was deployed \(ISO timestamp\) | -| ↳ `dateCreated` | string | When the release was created \(ISO timestamp\) | -| ↳ `dateStarted` | string | When the release started \(ISO timestamp\) | -| ↳ `newGroups` | number | Number of new issues introduced | -| ↳ `commitCount` | number | Number of commits in this release | -| ↳ `deployCount` | number | Number of deploys for this release | -| ↳ `owner` | object | Release owner | -| ↳ `id` | string | Owner ID | -| ↳ `name` | string | Owner name | -| ↳ `email` | string | Owner email | -| ↳ `lastCommit` | object | Last commit in the release | -| ↳ `id` | string | Commit SHA | -| ↳ `message` | string | Commit message | -| ↳ `dateCreated` | string | Commit timestamp | -| ↳ `lastDeploy` | object | Last deploy of the release | -| ↳ `id` | string | Deploy ID | -| ↳ `environment` | string | Deploy environment | -| ↳ `dateStarted` | string | Deploy start timestamp | -| ↳ `dateFinished` | string | Deploy finish timestamp | -| ↳ `authors` | array | Authors of commits in the release | -| ↳ `id` | string | Author ID | -| ↳ `name` | string | Author name | -| ↳ `email` | string | Author email | -| ↳ `projects` | array | Projects associated with this release | -| ↳ `id` | string | Project ID | -| ↳ `name` | string | Project name | -| ↳ `slug` | string | Project slug | -| ↳ `platform` | string | Project platform | -| ↳ `firstEvent` | string | First event timestamp | -| ↳ `lastEvent` | string | Last event timestamp | -| ↳ `versionInfo` | object | Version metadata | -| ↳ `buildHash` | string | Build hash | -| ↳ `version` | object | Version details | -| ↳ `raw` | string | Raw version string | -| ↳ `package` | string | Package name | +| ↳ `id` | string | Unique release ID | +| ↳ `version` | string | Release version identifier | +| ↳ `shortVersion` | string | Shortened version identifier | +| ↳ `ref` | string | Git reference \(commit SHA, tag, or branch\) | +| ↳ `url` | string | URL to the release | +| ↳ `dateReleased` | string | When the release was deployed \(ISO timestamp\) | +| ↳ `dateCreated` | string | When the release was created \(ISO timestamp\) | +| ↳ `dateStarted` | string | When the release started \(ISO timestamp\) | +| ↳ `newGroups` | number | Number of new issues introduced | +| ↳ `commitCount` | number | Number of commits in this release | +| ↳ `deployCount` | number | Number of deploys for this release | +| ↳ `owner` | object | Release owner | +| ↳ `id` | string | Owner ID | +| ↳ `name` | string | Owner name | +| ↳ `email` | string | Owner email | +| ↳ `lastCommit` | object | Last commit in the release | +| ↳ `id` | string | Commit SHA | +| ↳ `message` | string | Commit message | +| ↳ `dateCreated` | string | Commit timestamp | +| ↳ `lastDeploy` | object | Last deploy of the release | +| ↳ `id` | string | Deploy ID | +| ↳ `environment` | string | Deploy environment | +| ↳ `dateStarted` | string | Deploy start timestamp | +| ↳ `dateFinished` | string | Deploy finish timestamp | +| ↳ `authors` | array | Authors of commits in the release | +| ↳ `id` | string | Author ID | +| ↳ `name` | string | Author name | +| ↳ `email` | string | Author email | +| ↳ `projects` | array | Projects associated with this release | +| ↳ `id` | string | Project ID | +| ↳ `name` | string | Project name | +| ↳ `slug` | string | Project slug | +| ↳ `platform` | string | Project platform | +| ↳ `firstEvent` | string | First event timestamp | +| ↳ `lastEvent` | string | Last event timestamp | +| ↳ `versionInfo` | object | Version metadata | +| ↳ `buildHash` | string | Build hash | +| ↳ `version` | object | Version details | +| ↳ `raw` | string | Raw version string | +| ↳ `package` | string | Package name | ### `sentry_releases_deploy` @@ -632,11 +632,11 @@ Create a deploy record for a Sentry release in a specific environment. Deploys t | Parameter | Type | Description | | --------- | ---- | ----------- | | `deploy` | object | The newly created deploy record | -| ↳ `id` | string | Unique deploy ID | -| ↳ `environment` | string | Environment name where the release was deployed | -| ↳ `name` | string | Name of the deploy | -| ↳ `url` | string | URL pointing to the deploy | -| ↳ `dateStarted` | string | When the deploy started \(ISO timestamp\) | -| ↳ `dateFinished` | string | When the deploy finished \(ISO timestamp\) | +| ↳ `id` | string | Unique deploy ID | +| ↳ `environment` | string | Environment name where the release was deployed | +| ↳ `name` | string | Name of the deploy | +| ↳ `url` | string | URL pointing to the deploy | +| ↳ `dateStarted` | string | When the deploy started \(ISO timestamp\) | +| ↳ `dateFinished` | string | When the deploy finished \(ISO timestamp\) | diff --git a/apps/docs/content/docs/en/tools/serper.mdx b/apps/docs/content/docs/en/tools/serper.mdx index 44496283f..33706b662 100644 --- a/apps/docs/content/docs/en/tools/serper.mdx +++ b/apps/docs/content/docs/en/tools/serper.mdx @@ -35,7 +35,7 @@ Integrate Serper into the workflow. Can search the web. ### `serper_search` -A powerful web search tool that provides access to Google search results through Serper.dev API. Supports different types of searches including regular web search, news, places, and images, with each result containing relevant metadata like titles, URLs, snippets, and type-specific information. +A powerful web search tool that provides access to Google search results through Serper.dev API. Supports different types of searches including regular web search, news, places, images, videos, and shopping. Returns comprehensive results including organic results, knowledge graph, answer box, people also ask, related searches, and top stories. #### Input @@ -53,5 +53,17 @@ A powerful web search tool that provides access to Google search results through | Parameter | Type | Description | | --------- | ---- | ----------- | | `searchResults` | array | Search results with titles, links, snippets, and type-specific metadata \(date for news, rating for places, imageUrl for images\) | +| ↳ `title` | string | Result title | +| ↳ `link` | string | Result URL | +| ↳ `snippet` | string | Result description/snippet | +| ↳ `position` | number | Position in search results | +| ↳ `date` | string | Publication date \(news/videos\) | +| ↳ `imageUrl` | string | Image URL \(images/news/shopping\) | +| ↳ `source` | string | Source name \(news/videos/shopping\) | +| ↳ `rating` | number | Rating \(places\) | +| ↳ `ratingCount` | number | Number of reviews \(places\) | +| ↳ `address` | string | Address \(places\) | +| ↳ `price` | string | Price \(shopping\) | +| ↳ `duration` | string | Duration \(videos\) | diff --git a/apps/docs/content/docs/en/tools/sharepoint.mdx b/apps/docs/content/docs/en/tools/sharepoint.mdx index 2ee96c666..397fc2fb9 100644 --- a/apps/docs/content/docs/en/tools/sharepoint.mdx +++ b/apps/docs/content/docs/en/tools/sharepoint.mdx @@ -52,13 +52,13 @@ Create a new page in a SharePoint site | Parameter | Type | Description | | --------- | ---- | ----------- | | `page` | object | Created SharePoint page information | -| ↳ `id` | string | The unique ID of the created page | -| ↳ `name` | string | The name of the created page | -| ↳ `title` | string | The title of the created page | -| ↳ `webUrl` | string | The URL to access the page | -| ↳ `pageLayout` | string | The layout type of the page | -| ↳ `createdDateTime` | string | When the page was created | -| ↳ `lastModifiedDateTime` | string | When the page was last modified | +| ↳ `id` | string | The unique ID of the created page | +| ↳ `name` | string | The name of the created page | +| ↳ `title` | string | The title of the created page | +| ↳ `webUrl` | string | The URL to access the page | +| ↳ `pageLayout` | string | The layout type of the page | +| ↳ `createdDateTime` | string | When the page was created | +| ↳ `lastModifiedDateTime` | string | When the page was last modified | ### `sharepoint_read_page` @@ -79,15 +79,6 @@ Read a specific page from a SharePoint site | Parameter | Type | Description | | --------- | ---- | ----------- | | `page` | object | Information about the SharePoint page | -| ↳ `id` | string | The unique ID of the page | -| ↳ `name` | string | The name of the page | -| ↳ `title` | string | The title of the page | -| ↳ `webUrl` | string | The URL to access the page | -| ↳ `pageLayout` | string | The layout type of the page | -| ↳ `createdDateTime` | string | When the page was created | -| ↳ `lastModifiedDateTime` | string | When the page was last modified | -| `pages` | array | List of SharePoint pages | -| ↳ `page` | object | The unique ID of the page | | ↳ `id` | string | The unique ID of the page | | ↳ `name` | string | The name of the page | | ↳ `title` | string | The title of the page | @@ -95,12 +86,21 @@ Read a specific page from a SharePoint site | ↳ `pageLayout` | string | The layout type of the page | | ↳ `createdDateTime` | string | When the page was created | | ↳ `lastModifiedDateTime` | string | When the page was last modified | +| `pages` | array | List of SharePoint pages | +| ↳ `page` | object | The unique ID of the page | +| ↳ `id` | string | The unique ID of the page | +| ↳ `name` | string | The name of the page | +| ↳ `title` | string | The title of the page | +| ↳ `webUrl` | string | The URL to access the page | +| ↳ `pageLayout` | string | The layout type of the page | +| ↳ `createdDateTime` | string | When the page was created | +| ↳ `lastModifiedDateTime` | string | When the page was last modified | | ↳ `content` | object | Extracted text content from the page | +| ↳ `content` | string | Extracted text content from the page | +| ↳ `canvasLayout` | object | Raw SharePoint canvas layout structure | +| `content` | object | Content of the SharePoint page | | ↳ `content` | string | Extracted text content from the page | | ↳ `canvasLayout` | object | Raw SharePoint canvas layout structure | -| `content` | object | Content of the SharePoint page | -| ↳ `content` | string | Extracted text content from the page | -| ↳ `canvasLayout` | object | Raw SharePoint canvas layout structure | | `totalPages` | number | Total number of pages found | ### `sharepoint_list_sites` @@ -119,18 +119,18 @@ List details of all SharePoint sites | Parameter | Type | Description | | --------- | ---- | ----------- | | `site` | object | Information about the current SharePoint site | -| ↳ `id` | string | The unique ID of the site | -| ↳ `name` | string | The name of the site | -| ↳ `displayName` | string | The display name of the site | -| ↳ `webUrl` | string | The URL to access the site | -| ↳ `description` | string | The description of the site | -| ↳ `createdDateTime` | string | When the site was created | -| ↳ `lastModifiedDateTime` | string | When the site was last modified | -| ↳ `isPersonalSite` | boolean | Whether this is a personal site | -| ↳ `root` | object | Server relative URL | -| ↳ `serverRelativeUrl` | string | Server relative URL | -| ↳ `siteCollection` | object | Site collection hostname | -| ↳ `hostname` | string | Site collection hostname | +| ↳ `id` | string | The unique ID of the site | +| ↳ `name` | string | The name of the site | +| ↳ `displayName` | string | The display name of the site | +| ↳ `webUrl` | string | The URL to access the site | +| ↳ `description` | string | The description of the site | +| ↳ `createdDateTime` | string | When the site was created | +| ↳ `lastModifiedDateTime` | string | When the site was last modified | +| ↳ `isPersonalSite` | boolean | Whether this is a personal site | +| ↳ `root` | object | Server relative URL | +| ↳ `serverRelativeUrl` | string | Server relative URL | +| ↳ `siteCollection` | object | Site collection hostname | +| ↳ `hostname` | string | Site collection hostname | | `sites` | array | List of all accessible SharePoint sites | | ↳ `id` | string | The unique ID of the site | | ↳ `name` | string | The name of the site | @@ -160,13 +160,13 @@ Create a new list in a SharePoint site | Parameter | Type | Description | | --------- | ---- | ----------- | | `list` | object | Created SharePoint list information | -| ↳ `id` | string | The unique ID of the list | -| ↳ `displayName` | string | The display name of the list | -| ↳ `name` | string | The internal name of the list | -| ↳ `webUrl` | string | The web URL of the list | -| ↳ `createdDateTime` | string | When the list was created | -| ↳ `lastModifiedDateTime` | string | When the list was last modified | -| ↳ `list` | object | List properties \(e.g., template\) | +| ↳ `id` | string | The unique ID of the list | +| ↳ `displayName` | string | The display name of the list | +| ↳ `name` | string | The internal name of the list | +| ↳ `webUrl` | string | The web URL of the list | +| ↳ `createdDateTime` | string | When the list was created | +| ↳ `lastModifiedDateTime` | string | When the list was last modified | +| ↳ `list` | object | List properties \(e.g., template\) | ### `sharepoint_get_list` @@ -185,14 +185,14 @@ Get metadata (and optionally columns/items) for a SharePoint list | Parameter | Type | Description | | --------- | ---- | ----------- | | `list` | object | Information about the SharePoint list | -| ↳ `id` | string | The unique ID of the list | -| ↳ `displayName` | string | The display name of the list | -| ↳ `name` | string | The internal name of the list | -| ↳ `webUrl` | string | The web URL of the list | -| ↳ `createdDateTime` | string | When the list was created | -| ↳ `lastModifiedDateTime` | string | When the list was last modified | -| ↳ `list` | object | List properties \(e.g., template\) | -| ↳ `columns` | array | List column definitions | +| ↳ `id` | string | The unique ID of the list | +| ↳ `displayName` | string | The display name of the list | +| ↳ `name` | string | The internal name of the list | +| ↳ `webUrl` | string | The web URL of the list | +| ↳ `createdDateTime` | string | When the list was created | +| ↳ `lastModifiedDateTime` | string | When the list was last modified | +| ↳ `list` | object | List properties \(e.g., template\) | +| ↳ `columns` | array | List column definitions | | `lists` | array | All lists in the site when no listId/title provided | ### `sharepoint_update_list` @@ -214,8 +214,8 @@ Update the properties (fields) on a SharePoint list item | Parameter | Type | Description | | --------- | ---- | ----------- | | `item` | object | Updated SharePoint list item | -| ↳ `id` | string | Item ID | -| ↳ `fields` | object | Updated field values | +| ↳ `id` | string | Item ID | +| ↳ `fields` | object | Updated field values | ### `sharepoint_add_list_items` @@ -235,8 +235,8 @@ Add a new item to a SharePoint list | Parameter | Type | Description | | --------- | ---- | ----------- | | `item` | object | Created SharePoint list item | -| ↳ `id` | string | Item ID | -| ↳ `fields` | object | Field values for the new item | +| ↳ `id` | string | Item ID | +| ↳ `fields` | object | Field values for the new item | ### `sharepoint_upload_file` diff --git a/apps/docs/content/docs/en/tools/shopify.mdx b/apps/docs/content/docs/en/tools/shopify.mdx index 2247af0e1..bbc0ea8cb 100644 --- a/apps/docs/content/docs/en/tools/shopify.mdx +++ b/apps/docs/content/docs/en/tools/shopify.mdx @@ -53,6 +53,18 @@ Create a new product in your Shopify store | Parameter | Type | Description | | --------- | ---- | ----------- | | `product` | object | The created product | +| ↳ `id` | string | Unique product identifier \(GID\) | +| ↳ `title` | string | Product title | +| ↳ `handle` | string | URL-friendly product identifier | +| ↳ `descriptionHtml` | string | Product description in HTML format | +| ↳ `vendor` | string | Product vendor or manufacturer | +| ↳ `productType` | string | Product type classification | +| ↳ `tags` | array | Product tags for categorization | +| ↳ `status` | string | Product status \(ACTIVE, DRAFT, ARCHIVED\) | +| ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) | +| ↳ `updatedAt` | string | Last modification timestamp \(ISO 8601\) | +| ↳ `variants` | object | Product variants with edges/nodes structure | +| ↳ `images` | object | Product images with edges/nodes structure | ### `shopify_get_product` @@ -70,6 +82,18 @@ Get a single product by ID from your Shopify store | Parameter | Type | Description | | --------- | ---- | ----------- | | `product` | object | The product details | +| ↳ `id` | string | Unique product identifier \(GID\) | +| ↳ `title` | string | Product title | +| ↳ `handle` | string | URL-friendly product identifier | +| ↳ `descriptionHtml` | string | Product description in HTML format | +| ↳ `vendor` | string | Product vendor or manufacturer | +| ↳ `productType` | string | Product type classification | +| ↳ `tags` | array | Product tags for categorization | +| ↳ `status` | string | Product status \(ACTIVE, DRAFT, ARCHIVED\) | +| ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) | +| ↳ `updatedAt` | string | Last modification timestamp \(ISO 8601\) | +| ↳ `variants` | object | Product variants with edges/nodes structure | +| ↳ `images` | object | Product images with edges/nodes structure | ### `shopify_list_products` @@ -88,7 +112,21 @@ List products from your Shopify store with optional filtering | Parameter | Type | Description | | --------- | ---- | ----------- | | `products` | array | List of products | +| ↳ `id` | string | Unique product identifier \(GID\) | +| ↳ `title` | string | Product title | +| ↳ `handle` | string | URL-friendly product identifier | +| ↳ `descriptionHtml` | string | Product description in HTML format | +| ↳ `vendor` | string | Product vendor or manufacturer | +| ↳ `productType` | string | Product type classification | +| ↳ `tags` | array | Product tags for categorization | +| ↳ `status` | string | Product status \(ACTIVE, DRAFT, ARCHIVED\) | +| ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) | +| ↳ `updatedAt` | string | Last modification timestamp \(ISO 8601\) | +| ↳ `variants` | object | Product variants with edges/nodes structure | +| ↳ `images` | object | Product images with edges/nodes structure | | `pageInfo` | object | Pagination information | +| ↳ `hasNextPage` | boolean | Whether there are more results after this page | +| ↳ `hasPreviousPage` | boolean | Whether there are results before this page | ### `shopify_update_product` @@ -112,6 +150,18 @@ Update an existing product in your Shopify store | Parameter | Type | Description | | --------- | ---- | ----------- | | `product` | object | The updated product | +| ↳ `id` | string | Unique product identifier \(GID\) | +| ↳ `title` | string | Product title | +| ↳ `handle` | string | URL-friendly product identifier | +| ↳ `descriptionHtml` | string | Product description in HTML format | +| ↳ `vendor` | string | Product vendor or manufacturer | +| ↳ `productType` | string | Product type classification | +| ↳ `tags` | array | Product tags for categorization | +| ↳ `status` | string | Product status \(ACTIVE, DRAFT, ARCHIVED\) | +| ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) | +| ↳ `updatedAt` | string | Last modification timestamp \(ISO 8601\) | +| ↳ `variants` | object | Product variants with edges/nodes structure | +| ↳ `images` | object | Product images with edges/nodes structure | ### `shopify_delete_product` @@ -146,6 +196,27 @@ Get a single order by ID from your Shopify store | Parameter | Type | Description | | --------- | ---- | ----------- | | `order` | object | The order details | +| ↳ `id` | string | Unique order identifier \(GID\) | +| ↳ `name` | string | Order name \(e.g., #1001\) | +| ↳ `email` | string | Customer email for the order | +| ↳ `phone` | string | Customer phone for the order | +| ↳ `createdAt` | string | Order creation timestamp \(ISO 8601\) | +| ↳ `updatedAt` | string | Last modification timestamp \(ISO 8601\) | +| ↳ `cancelledAt` | string | Cancellation timestamp \(ISO 8601\) | +| ↳ `closedAt` | string | Closure timestamp \(ISO 8601\) | +| ↳ `displayFinancialStatus` | string | Financial status \(PENDING, AUTHORIZED, PARTIALLY_PAID, PAID, PARTIALLY_REFUNDED, REFUNDED, VOIDED\) | +| ↳ `displayFulfillmentStatus` | string | Fulfillment status \(UNFULFILLED, PARTIALLY_FULFILLED, FULFILLED, RESTOCKED, PENDING_FULFILLMENT, OPEN, IN_PROGRESS, ON_HOLD, SCHEDULED\) | +| ↳ `totalPriceSet` | object | Total order price | +| ↳ `subtotalPriceSet` | object | Order subtotal \(before shipping and taxes\) | +| ↳ `totalTaxSet` | object | Total tax amount | +| ↳ `totalShippingPriceSet` | object | Total shipping price | +| ↳ `note` | string | Order note | +| ↳ `tags` | array | Order tags | +| ↳ `customer` | object | Customer who placed the order | +| ↳ `lineItems` | object | Order line items with edges/nodes structure | +| ↳ `shippingAddress` | object | Shipping address | +| ↳ `billingAddress` | object | Billing address | +| ↳ `fulfillments` | array | Order fulfillments | ### `shopify_list_orders` @@ -165,7 +236,30 @@ List orders from your Shopify store with optional filtering | Parameter | Type | Description | | --------- | ---- | ----------- | | `orders` | array | List of orders | +| ↳ `id` | string | Unique order identifier \(GID\) | +| ↳ `name` | string | Order name \(e.g., #1001\) | +| ↳ `email` | string | Customer email for the order | +| ↳ `phone` | string | Customer phone for the order | +| ↳ `createdAt` | string | Order creation timestamp \(ISO 8601\) | +| ↳ `updatedAt` | string | Last modification timestamp \(ISO 8601\) | +| ↳ `cancelledAt` | string | Cancellation timestamp \(ISO 8601\) | +| ↳ `closedAt` | string | Closure timestamp \(ISO 8601\) | +| ↳ `displayFinancialStatus` | string | Financial status \(PENDING, AUTHORIZED, PARTIALLY_PAID, PAID, PARTIALLY_REFUNDED, REFUNDED, VOIDED\) | +| ↳ `displayFulfillmentStatus` | string | Fulfillment status \(UNFULFILLED, PARTIALLY_FULFILLED, FULFILLED, RESTOCKED, PENDING_FULFILLMENT, OPEN, IN_PROGRESS, ON_HOLD, SCHEDULED\) | +| ↳ `totalPriceSet` | object | Total order price | +| ↳ `subtotalPriceSet` | object | Order subtotal \(before shipping and taxes\) | +| ↳ `totalTaxSet` | object | Total tax amount | +| ↳ `totalShippingPriceSet` | object | Total shipping price | +| ↳ `note` | string | Order note | +| ↳ `tags` | array | Order tags | +| ↳ `customer` | object | Customer who placed the order | +| ↳ `lineItems` | object | Order line items with edges/nodes structure | +| ↳ `shippingAddress` | object | Shipping address | +| ↳ `billingAddress` | object | Billing address | +| ↳ `fulfillments` | array | Order fulfillments | | `pageInfo` | object | Pagination information | +| ↳ `hasNextPage` | boolean | Whether there are more results after this page | +| ↳ `hasPreviousPage` | boolean | Whether there are results before this page | ### `shopify_update_order` @@ -186,6 +280,27 @@ Update an existing order in your Shopify store (note, tags, email) | Parameter | Type | Description | | --------- | ---- | ----------- | | `order` | object | The updated order | +| ↳ `id` | string | Unique order identifier \(GID\) | +| ↳ `name` | string | Order name \(e.g., #1001\) | +| ↳ `email` | string | Customer email for the order | +| ↳ `phone` | string | Customer phone for the order | +| ↳ `createdAt` | string | Order creation timestamp \(ISO 8601\) | +| ↳ `updatedAt` | string | Last modification timestamp \(ISO 8601\) | +| ↳ `cancelledAt` | string | Cancellation timestamp \(ISO 8601\) | +| ↳ `closedAt` | string | Closure timestamp \(ISO 8601\) | +| ↳ `displayFinancialStatus` | string | Financial status \(PENDING, AUTHORIZED, PARTIALLY_PAID, PAID, PARTIALLY_REFUNDED, REFUNDED, VOIDED\) | +| ↳ `displayFulfillmentStatus` | string | Fulfillment status \(UNFULFILLED, PARTIALLY_FULFILLED, FULFILLED, RESTOCKED, PENDING_FULFILLMENT, OPEN, IN_PROGRESS, ON_HOLD, SCHEDULED\) | +| ↳ `totalPriceSet` | object | Total order price | +| ↳ `subtotalPriceSet` | object | Order subtotal \(before shipping and taxes\) | +| ↳ `totalTaxSet` | object | Total tax amount | +| ↳ `totalShippingPriceSet` | object | Total shipping price | +| ↳ `note` | string | Order note | +| ↳ `tags` | array | Order tags | +| ↳ `customer` | object | Customer who placed the order | +| ↳ `lineItems` | object | Order line items with edges/nodes structure | +| ↳ `shippingAddress` | object | Shipping address | +| ↳ `billingAddress` | object | Billing address | +| ↳ `fulfillments` | array | Order fulfillments | ### `shopify_cancel_order` @@ -208,6 +323,9 @@ Cancel an order in your Shopify store | Parameter | Type | Description | | --------- | ---- | ----------- | | `order` | object | The cancellation result | +| ↳ `id` | string | Job identifier for the cancellation | +| ↳ `cancelled` | boolean | Whether the cancellation completed | +| ↳ `message` | string | Status message | ### `shopify_create_customer` @@ -231,6 +349,18 @@ Create a new customer in your Shopify store | Parameter | Type | Description | | --------- | ---- | ----------- | | `customer` | object | The created customer | +| ↳ `id` | string | Unique customer identifier \(GID\) | +| ↳ `email` | string | Customer email address | +| ↳ `firstName` | string | Customer first name | +| ↳ `lastName` | string | Customer last name | +| ↳ `phone` | string | Customer phone number | +| ↳ `createdAt` | string | Account creation timestamp \(ISO 8601\) | +| ↳ `updatedAt` | string | Last modification timestamp \(ISO 8601\) | +| ↳ `note` | string | Internal notes about the customer | +| ↳ `tags` | array | Customer tags for categorization | +| ↳ `amountSpent` | object | Total amount spent by customer | +| ↳ `addresses` | array | Customer addresses | +| ↳ `defaultAddress` | object | Customer default address | ### `shopify_get_customer` @@ -248,6 +378,18 @@ Get a single customer by ID from your Shopify store | Parameter | Type | Description | | --------- | ---- | ----------- | | `customer` | object | The customer details | +| ↳ `id` | string | Unique customer identifier \(GID\) | +| ↳ `email` | string | Customer email address | +| ↳ `firstName` | string | Customer first name | +| ↳ `lastName` | string | Customer last name | +| ↳ `phone` | string | Customer phone number | +| ↳ `createdAt` | string | Account creation timestamp \(ISO 8601\) | +| ↳ `updatedAt` | string | Last modification timestamp \(ISO 8601\) | +| ↳ `note` | string | Internal notes about the customer | +| ↳ `tags` | array | Customer tags for categorization | +| ↳ `amountSpent` | object | Total amount spent by customer | +| ↳ `addresses` | array | Customer addresses | +| ↳ `defaultAddress` | object | Customer default address | ### `shopify_list_customers` @@ -266,7 +408,21 @@ List customers from your Shopify store with optional filtering | Parameter | Type | Description | | --------- | ---- | ----------- | | `customers` | array | List of customers | +| ↳ `id` | string | Unique customer identifier \(GID\) | +| ↳ `email` | string | Customer email address | +| ↳ `firstName` | string | Customer first name | +| ↳ `lastName` | string | Customer last name | +| ↳ `phone` | string | Customer phone number | +| ↳ `createdAt` | string | Account creation timestamp \(ISO 8601\) | +| ↳ `updatedAt` | string | Last modification timestamp \(ISO 8601\) | +| ↳ `note` | string | Internal notes about the customer | +| ↳ `tags` | array | Customer tags for categorization | +| ↳ `amountSpent` | object | Total amount spent by customer | +| ↳ `addresses` | array | Customer addresses | +| ↳ `defaultAddress` | object | Customer default address | | `pageInfo` | object | Pagination information | +| ↳ `hasNextPage` | boolean | Whether there are more results after this page | +| ↳ `hasPreviousPage` | boolean | Whether there are results before this page | ### `shopify_update_customer` @@ -290,6 +446,18 @@ Update an existing customer in your Shopify store | Parameter | Type | Description | | --------- | ---- | ----------- | | `customer` | object | The updated customer | +| ↳ `id` | string | Unique customer identifier \(GID\) | +| ↳ `email` | string | Customer email address | +| ↳ `firstName` | string | Customer first name | +| ↳ `lastName` | string | Customer last name | +| ↳ `phone` | string | Customer phone number | +| ↳ `createdAt` | string | Account creation timestamp \(ISO 8601\) | +| ↳ `updatedAt` | string | Last modification timestamp \(ISO 8601\) | +| ↳ `note` | string | Internal notes about the customer | +| ↳ `tags` | array | Customer tags for categorization | +| ↳ `amountSpent` | object | Total amount spent by customer | +| ↳ `addresses` | array | Customer addresses | +| ↳ `defaultAddress` | object | Customer default address | ### `shopify_delete_customer` @@ -325,7 +493,26 @@ List inventory items from your Shopify store. Use this to find inventory item ID | Parameter | Type | Description | | --------- | ---- | ----------- | | `inventoryItems` | array | List of inventory items with their IDs, SKUs, and stock levels | +| ↳ `id` | string | Unique inventory item identifier \(GID\) | +| ↳ `sku` | string | Stock keeping unit | +| ↳ `tracked` | boolean | Whether inventory is tracked | +| ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) | +| ↳ `updatedAt` | string | Last modification timestamp \(ISO 8601\) | +| ↳ `variant` | object | Associated product variant | +| ↳ `id` | string | Variant identifier \(GID\) | +| ↳ `title` | string | Variant title | +| ↳ `product` | object | Associated product | +| ↳ `id` | string | Product identifier \(GID\) | +| ↳ `title` | string | Product title | +| ↳ `inventoryLevels` | array | Inventory levels at different locations | +| ↳ `id` | string | Inventory level identifier \(GID\) | +| ↳ `available` | number | Available quantity | +| ↳ `location` | object | Location for this inventory level | +| ↳ `id` | string | Location identifier \(GID\) | +| ↳ `name` | string | Location name | | `pageInfo` | object | Pagination information | +| ↳ `hasNextPage` | boolean | Whether there are more results after this page | +| ↳ `hasPreviousPage` | boolean | Whether there are results before this page | ### `shopify_get_inventory_level` @@ -344,6 +531,19 @@ Get inventory level for a product variant at a specific location | Parameter | Type | Description | | --------- | ---- | ----------- | | `inventoryLevel` | object | The inventory level details | +| ↳ `id` | string | Inventory item identifier \(GID\) | +| ↳ `sku` | string | Stock keeping unit | +| ↳ `tracked` | boolean | Whether inventory is tracked | +| ↳ `levels` | array | Inventory levels at different locations | +| ↳ `id` | string | Inventory level identifier \(GID\) | +| ↳ `available` | number | Available quantity | +| ↳ `onHand` | number | On-hand quantity | +| ↳ `committed` | number | Committed quantity | +| ↳ `incoming` | number | Incoming quantity | +| ↳ `reserved` | number | Reserved quantity | +| ↳ `location` | object | Location for this inventory level | +| ↳ `id` | string | Location identifier \(GID\) | +| ↳ `name` | string | Location name | ### `shopify_adjust_inventory` @@ -363,6 +563,19 @@ Adjust inventory quantity for a product variant at a specific location | Parameter | Type | Description | | --------- | ---- | ----------- | | `inventoryLevel` | object | The inventory adjustment result | +| ↳ `adjustmentGroup` | object | Inventory adjustment group details | +| ↳ `createdAt` | string | Adjustment timestamp \(ISO 8601\) | +| ↳ `reason` | string | Adjustment reason | +| ↳ `changes` | array | Inventory changes applied | +| ↳ `name` | string | Quantity name \(e.g., available\) | +| ↳ `delta` | number | Quantity change amount | +| ↳ `quantityAfterChange` | number | Quantity after adjustment | +| ↳ `item` | object | Inventory item | +| ↳ `id` | string | Inventory item identifier \(GID\) | +| ↳ `sku` | string | Stock keeping unit | +| ↳ `location` | object | Location of the adjustment | +| ↳ `id` | string | Location identifier \(GID\) | +| ↳ `name` | string | Location name | ### `shopify_list_locations` @@ -381,7 +594,14 @@ List inventory locations from your Shopify store. Use this to find location IDs | Parameter | Type | Description | | --------- | ---- | ----------- | | `locations` | array | List of locations with their IDs, names, and addresses | +| ↳ `id` | string | Unique location identifier \(GID\) | +| ↳ `name` | string | Location name | +| ↳ `isActive` | boolean | Whether the location is active | +| ↳ `fulfillsOnlineOrders` | boolean | Whether the location fulfills online orders | +| ↳ `address` | object | Location address | | `pageInfo` | object | Pagination information | +| ↳ `hasNextPage` | boolean | Whether there are more results after this page | +| ↳ `hasPreviousPage` | boolean | Whether there are results before this page | ### `shopify_create_fulfillment` @@ -403,6 +623,16 @@ Create a fulfillment to mark order items as shipped. Requires a fulfillment orde | Parameter | Type | Description | | --------- | ---- | ----------- | | `fulfillment` | object | The created fulfillment with tracking info and fulfilled items | +| ↳ `id` | string | Unique fulfillment identifier \(GID\) | +| ↳ `status` | string | Fulfillment status \(pending, open, success, cancelled, error, failure\) | +| ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) | +| ↳ `updatedAt` | string | Last modification timestamp \(ISO 8601\) | +| ↳ `trackingInfo` | array | Tracking information for shipments | +| ↳ `fulfillmentLineItems` | array | Fulfilled line items | +| ↳ `id` | string | Fulfillment line item identifier \(GID\) | +| ↳ `quantity` | number | Quantity fulfilled | +| ↳ `lineItem` | object | Associated order line item | +| ↳ `title` | string | Product title | ### `shopify_list_collections` @@ -421,7 +651,18 @@ List product collections from your Shopify store. Filter by title, type (custom/ | Parameter | Type | Description | | --------- | ---- | ----------- | | `collections` | array | List of collections with their IDs, titles, and product counts | +| ↳ `id` | string | Unique collection identifier \(GID\) | +| ↳ `title` | string | Collection title | +| ↳ `handle` | string | URL-friendly collection identifier | +| ↳ `description` | string | Plain text description | +| ↳ `descriptionHtml` | string | HTML-formatted description | +| ↳ `productsCount` | number | Number of products in the collection | +| ↳ `sortOrder` | string | Product sort order in the collection | +| ↳ `updatedAt` | string | Last modification timestamp \(ISO 8601\) | +| ↳ `image` | object | Collection image | | `pageInfo` | object | Pagination information | +| ↳ `hasNextPage` | boolean | Whether there are more results after this page | +| ↳ `hasPreviousPage` | boolean | Whether there are results before this page | ### `shopify_get_collection` @@ -440,5 +681,15 @@ Get a specific collection by ID, including its products. Use this to retrieve pr | Parameter | Type | Description | | --------- | ---- | ----------- | | `collection` | object | The collection details including its products | +| ↳ `id` | string | Unique collection identifier \(GID\) | +| ↳ `title` | string | Collection title | +| ↳ `handle` | string | URL-friendly collection identifier | +| ↳ `description` | string | Plain text description | +| ↳ `descriptionHtml` | string | HTML-formatted description | +| ↳ `productsCount` | number | Number of products in the collection | +| ↳ `sortOrder` | string | Product sort order in the collection | +| ↳ `updatedAt` | string | Last modification timestamp \(ISO 8601\) | +| ↳ `image` | object | Collection image | +| ↳ `products` | array | Products in the collection | diff --git a/apps/docs/content/docs/en/tools/slack.mdx b/apps/docs/content/docs/en/tools/slack.mdx index 45c337c27..9bef68c1f 100644 --- a/apps/docs/content/docs/en/tools/slack.mdx +++ b/apps/docs/content/docs/en/tools/slack.mdx @@ -97,6 +97,60 @@ Send messages to Slack channels or direct messages. Supports Slack mrkdwn format | Parameter | Type | Description | | --------- | ---- | ----------- | | `message` | object | Complete message object with all properties returned by Slack | +| ↳ `type` | string | Message type \(usually "message"\) | +| ↳ `ts` | string | Message timestamp \(unique identifier\) | +| ↳ `text` | string | Message text content | +| ↳ `user` | string | User ID who sent the message | +| ↳ `bot_id` | string | Bot ID if sent by a bot | +| ↳ `username` | string | Display username | +| ↳ `channel` | string | Channel ID | +| ↳ `team` | string | Team/workspace ID | +| ↳ `thread_ts` | string | Parent message timestamp \(for threaded replies\) | +| ↳ `parent_user_id` | string | User ID of thread parent message author | +| ↳ `reply_count` | number | Total number of replies in thread | +| ↳ `reply_users_count` | number | Number of unique users who replied | +| ↳ `latest_reply` | string | Timestamp of most recent reply | +| ↳ `subscribed` | boolean | Whether user is subscribed to thread | +| ↳ `last_read` | string | Timestamp of last read message | +| ↳ `unread_count` | number | Number of unread messages in thread | +| ↳ `subtype` | string | Message subtype \(bot_message, file_share, etc.\) | +| ↳ `is_starred` | boolean | Whether message is starred by user | +| ↳ `pinned_to` | array | Channel IDs where message is pinned | +| ↳ `permalink` | string | Permanent URL to the message | +| ↳ `reactions` | array | Reactions on this message | +| ↳ `name` | string | Emoji name \(without colons\) | +| ↳ `count` | number | Number of times this reaction was added | +| ↳ `users` | array | Array of user IDs who reacted | +| ↳ `files` | array | Files attached to the message | +| ↳ `id` | string | Unique file identifier | +| ↳ `name` | string | File name | +| ↳ `mimetype` | string | MIME type of the file | +| ↳ `size` | number | File size in bytes | +| ↳ `url_private` | string | Private download URL \(requires auth\) | +| ↳ `permalink` | string | Permanent link to the file | +| ↳ `mode` | string | File mode \(hosted, external, etc.\) | +| ↳ `attachments` | array | Legacy attachments on the message | +| ↳ `id` | number | Attachment ID | +| ↳ `fallback` | string | Plain text summary | +| ↳ `text` | string | Main attachment text | +| ↳ `pretext` | string | Text shown before attachment | +| ↳ `color` | string | Color bar hex code or preset | +| ↳ `author_name` | string | Author display name | +| ↳ `author_link` | string | Author link URL | +| ↳ `author_icon` | string | Author icon URL | +| ↳ `title` | string | Attachment title | +| ↳ `title_link` | string | Title link URL | +| ↳ `image_url` | string | Image URL | +| ↳ `thumb_url` | string | Thumbnail URL | +| ↳ `footer` | string | Footer text | +| ↳ `footer_icon` | string | Footer icon URL | +| ↳ `ts` | string | Timestamp shown in footer | +| ↳ `blocks` | array | Block Kit blocks in the message | +| ↳ `type` | string | Block type \(section, divider, image, actions, etc.\) | +| ↳ `block_id` | string | Unique block identifier | +| ↳ `edited` | object | Edit information if message was edited | +| ↳ `user` | string | User ID who edited the message | +| ↳ `ts` | string | Timestamp of the edit | | `ts` | string | Message timestamp | | `channel` | string | Channel ID where message was sent | | `fileCount` | number | Number of files uploaded \(when files are attached\) | @@ -120,9 +174,9 @@ Create and share Slack canvases in channels. Canvases are collaborative document | Parameter | Type | Description | | --------- | ---- | ----------- | -| `canvas_id` | string | ID of the created canvas | +| `canvas_id` | string | Unique canvas identifier | | `channel` | string | Channel where canvas was created | -| `title` | string | Title of the canvas | +| `title` | string | Canvas title | ### `slack_message_reader` @@ -146,43 +200,60 @@ Read the latest messages from Slack channels. Retrieve conversation history with | Parameter | Type | Description | | --------- | ---- | ----------- | | `messages` | array | Array of message objects from the channel | -| ↳ `type` | string | Message type | -| ↳ `ts` | string | Message timestamp | +| ↳ `type` | string | Message type \(usually "message"\) | +| ↳ `ts` | string | Message timestamp \(unique identifier\) | | ↳ `text` | string | Message text content | | ↳ `user` | string | User ID who sent the message | | ↳ `bot_id` | string | Bot ID if sent by a bot | | ↳ `username` | string | Display username | | ↳ `channel` | string | Channel ID | -| ↳ `team` | string | Team ID | -| ↳ `thread_ts` | string | Thread parent message timestamp | -| ↳ `parent_user_id` | string | User ID of thread parent | -| ↳ `reply_count` | number | Number of thread replies | -| ↳ `reply_users_count` | number | Number of users who replied | -| ↳ `latest_reply` | string | Timestamp of latest reply | +| ↳ `team` | string | Team/workspace ID | +| ↳ `thread_ts` | string | Parent message timestamp \(for threaded replies\) | +| ↳ `parent_user_id` | string | User ID of thread parent message author | +| ↳ `reply_count` | number | Total number of replies in thread | +| ↳ `reply_users_count` | number | Number of unique users who replied | +| ↳ `latest_reply` | string | Timestamp of most recent reply | | ↳ `subscribed` | boolean | Whether user is subscribed to thread | -| ↳ `last_read` | string | Last read timestamp | -| ↳ `unread_count` | number | Number of unread messages | -| ↳ `subtype` | string | Message subtype | -| ↳ `reactions` | array | Array of reactions on this message | -| ↳ `name` | string | Emoji name | -| ↳ `count` | number | Number of reactions | -| ↳ `users` | array | Array of user IDs who reacted | -| ↳ `is_starred` | boolean | Whether message is starred | -| ↳ `pinned_to` | array | Array of channel IDs where message is pinned | -| ↳ `files` | array | Array of files attached to message | -| ↳ `id` | string | File ID | -| ↳ `name` | string | File name | -| ↳ `mimetype` | string | MIME type | -| ↳ `size` | number | File size in bytes | -| ↳ `url_private` | string | Private download URL | -| ↳ `permalink` | string | Permanent link to file | -| ↳ `mode` | string | File mode | -| ↳ `attachments` | array | Array of legacy attachments | -| ↳ `blocks` | array | Array of Block Kit blocks | +| ↳ `last_read` | string | Timestamp of last read message | +| ↳ `unread_count` | number | Number of unread messages in thread | +| ↳ `subtype` | string | Message subtype \(bot_message, file_share, etc.\) | +| ↳ `is_starred` | boolean | Whether message is starred by user | +| ↳ `pinned_to` | array | Channel IDs where message is pinned | +| ↳ `permalink` | string | Permanent URL to the message | +| ↳ `reactions` | array | Reactions on this message | +| ↳ `name` | string | Emoji name \(without colons\) | +| ↳ `count` | number | Number of times this reaction was added | +| ↳ `users` | array | Array of user IDs who reacted | +| ↳ `files` | array | Files attached to the message | +| ↳ `id` | string | Unique file identifier | +| ↳ `name` | string | File name | +| ↳ `mimetype` | string | MIME type of the file | +| ↳ `size` | number | File size in bytes | +| ↳ `url_private` | string | Private download URL \(requires auth\) | +| ↳ `permalink` | string | Permanent link to the file | +| ↳ `mode` | string | File mode \(hosted, external, etc.\) | +| ↳ `attachments` | array | Legacy attachments on the message | +| ↳ `id` | number | Attachment ID | +| ↳ `fallback` | string | Plain text summary | +| ↳ `text` | string | Main attachment text | +| ↳ `pretext` | string | Text shown before attachment | +| ↳ `color` | string | Color bar hex code or preset | +| ↳ `author_name` | string | Author display name | +| ↳ `author_link` | string | Author link URL | +| ↳ `author_icon` | string | Author icon URL | +| ↳ `title` | string | Attachment title | +| ↳ `title_link` | string | Title link URL | +| ↳ `image_url` | string | Image URL | +| ↳ `thumb_url` | string | Thumbnail URL | +| ↳ `footer` | string | Footer text | +| ↳ `footer_icon` | string | Footer icon URL | +| ↳ `ts` | string | Timestamp shown in footer | +| ↳ `blocks` | array | Block Kit blocks in the message | +| ↳ `type` | string | Block type \(section, divider, image, actions, etc.\) | +| ↳ `block_id` | string | Unique block identifier | | ↳ `edited` | object | Edit information if message was edited | -| ↳ `user` | string | User ID who edited | -| ↳ `ts` | string | Edit timestamp | -| ↳ `permalink` | string | Permanent link to message | +| ↳ `user` | string | User ID who edited the message | +| ↳ `ts` | string | Timestamp of the edit | ### `slack_get_message` @@ -202,39 +273,60 @@ Retrieve a specific message by its timestamp. Useful for getting a thread parent | Parameter | Type | Description | | --------- | ---- | ----------- | | `message` | object | The retrieved message object | -| ↳ `type` | string | Message type | -| ↳ `ts` | string | Message timestamp | -| ↳ `text` | string | Message text content | -| ↳ `user` | string | User ID who sent the message | -| ↳ `bot_id` | string | Bot ID if sent by a bot | -| ↳ `username` | string | Display username | -| ↳ `channel` | string | Channel ID | -| ↳ `team` | string | Team ID | -| ↳ `thread_ts` | string | Thread parent timestamp | -| ↳ `parent_user_id` | string | User ID of thread parent | -| ↳ `reply_count` | number | Number of thread replies | -| ↳ `reply_users_count` | number | Number of users who replied | -| ↳ `latest_reply` | string | Timestamp of latest reply | -| ↳ `subtype` | string | Message subtype | -| ↳ `reactions` | array | Array of reactions on this message | -| ↳ `name` | string | Emoji name | -| ↳ `count` | number | Number of reactions | -| ↳ `users` | array | User IDs who reacted | -| ↳ `is_starred` | boolean | Whether message is starred | -| ↳ `pinned_to` | array | Channel IDs where message is pinned | -| ↳ `files` | array | Files attached to message | -| ↳ `id` | string | File ID | -| ↳ `name` | string | File name | -| ↳ `mimetype` | string | MIME type | -| ↳ `size` | number | File size in bytes | -| ↳ `url_private` | string | Private download URL | -| ↳ `permalink` | string | Permanent link to file | -| ↳ `attachments` | array | Legacy attachments | -| ↳ `blocks` | array | Block Kit blocks | -| ↳ `edited` | object | Edit information if message was edited | -| ↳ `user` | string | User ID who edited | -| ↳ `ts` | string | Edit timestamp | -| ↳ `permalink` | string | Permanent link to message | +| ↳ `type` | string | Message type \(usually "message"\) | +| ↳ `ts` | string | Message timestamp \(unique identifier\) | +| ↳ `text` | string | Message text content | +| ↳ `user` | string | User ID who sent the message | +| ↳ `bot_id` | string | Bot ID if sent by a bot | +| ↳ `username` | string | Display username | +| ↳ `channel` | string | Channel ID | +| ↳ `team` | string | Team/workspace ID | +| ↳ `thread_ts` | string | Parent message timestamp \(for threaded replies\) | +| ↳ `parent_user_id` | string | User ID of thread parent message author | +| ↳ `reply_count` | number | Total number of replies in thread | +| ↳ `reply_users_count` | number | Number of unique users who replied | +| ↳ `latest_reply` | string | Timestamp of most recent reply | +| ↳ `subscribed` | boolean | Whether user is subscribed to thread | +| ↳ `last_read` | string | Timestamp of last read message | +| ↳ `unread_count` | number | Number of unread messages in thread | +| ↳ `subtype` | string | Message subtype \(bot_message, file_share, etc.\) | +| ↳ `is_starred` | boolean | Whether message is starred by user | +| ↳ `pinned_to` | array | Channel IDs where message is pinned | +| ↳ `permalink` | string | Permanent URL to the message | +| ↳ `reactions` | array | Reactions on this message | +| ↳ `name` | string | Emoji name \(without colons\) | +| ↳ `count` | number | Number of times this reaction was added | +| ↳ `users` | array | Array of user IDs who reacted | +| ↳ `files` | array | Files attached to the message | +| ↳ `id` | string | Unique file identifier | +| ↳ `name` | string | File name | +| ↳ `mimetype` | string | MIME type of the file | +| ↳ `size` | number | File size in bytes | +| ↳ `url_private` | string | Private download URL \(requires auth\) | +| ↳ `permalink` | string | Permanent link to the file | +| ↳ `mode` | string | File mode \(hosted, external, etc.\) | +| ↳ `attachments` | array | Legacy attachments on the message | +| ↳ `id` | number | Attachment ID | +| ↳ `fallback` | string | Plain text summary | +| ↳ `text` | string | Main attachment text | +| ↳ `pretext` | string | Text shown before attachment | +| ↳ `color` | string | Color bar hex code or preset | +| ↳ `author_name` | string | Author display name | +| ↳ `author_link` | string | Author link URL | +| ↳ `author_icon` | string | Author icon URL | +| ↳ `title` | string | Attachment title | +| ↳ `title_link` | string | Title link URL | +| ↳ `image_url` | string | Image URL | +| ↳ `thumb_url` | string | Thumbnail URL | +| ↳ `footer` | string | Footer text | +| ↳ `footer_icon` | string | Footer icon URL | +| ↳ `ts` | string | Timestamp shown in footer | +| ↳ `blocks` | array | Block Kit blocks in the message | +| ↳ `type` | string | Block type \(section, divider, image, actions, etc.\) | +| ↳ `block_id` | string | Unique block identifier | +| ↳ `edited` | object | Edit information if message was edited | +| ↳ `user` | string | User ID who edited the message | +| ↳ `ts` | string | Timestamp of the edit | ### `slack_get_thread` @@ -255,31 +347,170 @@ Retrieve an entire thread including the parent message and all replies. Useful f | Parameter | Type | Description | | --------- | ---- | ----------- | | `parentMessage` | object | The thread parent message | -| ↳ `type` | string | Message type | -| ↳ `ts` | string | Message timestamp | -| ↳ `text` | string | Message text content | -| ↳ `user` | string | User ID who sent the message | -| ↳ `bot_id` | string | Bot ID if sent by a bot | -| ↳ `username` | string | Display username | -| ↳ `reply_count` | number | Total number of thread replies | -| ↳ `reply_users_count` | number | Number of users who replied | -| ↳ `latest_reply` | string | Timestamp of latest reply | -| ↳ `reactions` | array | Array of reactions on the parent message | -| ↳ `name` | string | Emoji name | -| ↳ `count` | number | Number of reactions | -| ↳ `users` | array | User IDs who reacted | -| ↳ `files` | array | Files attached to the parent message | -| ↳ `id` | string | File ID | -| ↳ `name` | string | File name | -| ↳ `mimetype` | string | MIME type | -| ↳ `size` | number | File size in bytes | -| `replies` | array | Array of reply messages in the thread \(excluding the parent\) | -| ↳ `ts` | string | Message timestamp | +| ↳ `type` | string | Message type \(usually "message"\) | +| ↳ `ts` | string | Message timestamp \(unique identifier\) | | ↳ `text` | string | Message text content | -| ↳ `user` | string | User ID who sent the reply | -| ↳ `reactions` | array | Reactions on the reply | -| ↳ `files` | array | Files attached to the reply | +| ↳ `user` | string | User ID who sent the message | +| ↳ `bot_id` | string | Bot ID if sent by a bot | +| ↳ `username` | string | Display username | +| ↳ `channel` | string | Channel ID | +| ↳ `team` | string | Team/workspace ID | +| ↳ `thread_ts` | string | Parent message timestamp \(for threaded replies\) | +| ↳ `parent_user_id` | string | User ID of thread parent message author | +| ↳ `reply_count` | number | Total number of replies in thread | +| ↳ `reply_users_count` | number | Number of unique users who replied | +| ↳ `latest_reply` | string | Timestamp of most recent reply | +| ↳ `subscribed` | boolean | Whether user is subscribed to thread | +| ↳ `last_read` | string | Timestamp of last read message | +| ↳ `unread_count` | number | Number of unread messages in thread | +| ↳ `subtype` | string | Message subtype \(bot_message, file_share, etc.\) | +| ↳ `is_starred` | boolean | Whether message is starred by user | +| ↳ `pinned_to` | array | Channel IDs where message is pinned | +| ↳ `permalink` | string | Permanent URL to the message | +| ↳ `reactions` | array | Reactions on this message | +| ↳ `name` | string | Emoji name \(without colons\) | +| ↳ `count` | number | Number of times this reaction was added | +| ↳ `users` | array | Array of user IDs who reacted | +| ↳ `files` | array | Files attached to the message | +| ↳ `id` | string | Unique file identifier | +| ↳ `name` | string | File name | +| ↳ `mimetype` | string | MIME type of the file | +| ↳ `size` | number | File size in bytes | +| ↳ `url_private` | string | Private download URL \(requires auth\) | +| ↳ `permalink` | string | Permanent link to the file | +| ↳ `mode` | string | File mode \(hosted, external, etc.\) | +| ↳ `attachments` | array | Legacy attachments on the message | +| ↳ `id` | number | Attachment ID | +| ↳ `fallback` | string | Plain text summary | +| ↳ `text` | string | Main attachment text | +| ↳ `pretext` | string | Text shown before attachment | +| ↳ `color` | string | Color bar hex code or preset | +| ↳ `author_name` | string | Author display name | +| ↳ `author_link` | string | Author link URL | +| ↳ `author_icon` | string | Author icon URL | +| ↳ `title` | string | Attachment title | +| ↳ `title_link` | string | Title link URL | +| ↳ `image_url` | string | Image URL | +| ↳ `thumb_url` | string | Thumbnail URL | +| ↳ `footer` | string | Footer text | +| ↳ `footer_icon` | string | Footer icon URL | +| ↳ `ts` | string | Timestamp shown in footer | +| ↳ `blocks` | array | Block Kit blocks in the message | +| ↳ `type` | string | Block type \(section, divider, image, actions, etc.\) | +| ↳ `block_id` | string | Unique block identifier | +| ↳ `edited` | object | Edit information if message was edited | +| ↳ `user` | string | User ID who edited the message | +| ↳ `ts` | string | Timestamp of the edit | +| `replies` | array | Array of reply messages in the thread \(excluding the parent\) | +| ↳ `type` | string | Message type \(usually "message"\) | +| ↳ `ts` | string | Message timestamp \(unique identifier\) | +| ↳ `text` | string | Message text content | +| ↳ `user` | string | User ID who sent the message | +| ↳ `bot_id` | string | Bot ID if sent by a bot | +| ↳ `username` | string | Display username | +| ↳ `channel` | string | Channel ID | +| ↳ `team` | string | Team/workspace ID | +| ↳ `thread_ts` | string | Parent message timestamp \(for threaded replies\) | +| ↳ `parent_user_id` | string | User ID of thread parent message author | +| ↳ `reply_count` | number | Total number of replies in thread | +| ↳ `reply_users_count` | number | Number of unique users who replied | +| ↳ `latest_reply` | string | Timestamp of most recent reply | +| ↳ `subscribed` | boolean | Whether user is subscribed to thread | +| ↳ `last_read` | string | Timestamp of last read message | +| ↳ `unread_count` | number | Number of unread messages in thread | +| ↳ `subtype` | string | Message subtype \(bot_message, file_share, etc.\) | +| ↳ `is_starred` | boolean | Whether message is starred by user | +| ↳ `pinned_to` | array | Channel IDs where message is pinned | +| ↳ `permalink` | string | Permanent URL to the message | +| ↳ `reactions` | array | Reactions on this message | +| ↳ `name` | string | Emoji name \(without colons\) | +| ↳ `count` | number | Number of times this reaction was added | +| ↳ `users` | array | Array of user IDs who reacted | +| ↳ `files` | array | Files attached to the message | +| ↳ `id` | string | Unique file identifier | +| ↳ `name` | string | File name | +| ↳ `mimetype` | string | MIME type of the file | +| ↳ `size` | number | File size in bytes | +| ↳ `url_private` | string | Private download URL \(requires auth\) | +| ↳ `permalink` | string | Permanent link to the file | +| ↳ `mode` | string | File mode \(hosted, external, etc.\) | +| ↳ `attachments` | array | Legacy attachments on the message | +| ↳ `id` | number | Attachment ID | +| ↳ `fallback` | string | Plain text summary | +| ↳ `text` | string | Main attachment text | +| ↳ `pretext` | string | Text shown before attachment | +| ↳ `color` | string | Color bar hex code or preset | +| ↳ `author_name` | string | Author display name | +| ↳ `author_link` | string | Author link URL | +| ↳ `author_icon` | string | Author icon URL | +| ↳ `title` | string | Attachment title | +| ↳ `title_link` | string | Title link URL | +| ↳ `image_url` | string | Image URL | +| ↳ `thumb_url` | string | Thumbnail URL | +| ↳ `footer` | string | Footer text | +| ↳ `footer_icon` | string | Footer icon URL | +| ↳ `ts` | string | Timestamp shown in footer | +| ↳ `blocks` | array | Block Kit blocks in the message | +| ↳ `type` | string | Block type \(section, divider, image, actions, etc.\) | +| ↳ `block_id` | string | Unique block identifier | +| ↳ `edited` | object | Edit information if message was edited | +| ↳ `user` | string | User ID who edited the message | +| ↳ `ts` | string | Timestamp of the edit | | `messages` | array | All messages in the thread \(parent + replies\) in chronological order | +| ↳ `type` | string | Message type \(usually "message"\) | +| ↳ `ts` | string | Message timestamp \(unique identifier\) | +| ↳ `text` | string | Message text content | +| ↳ `user` | string | User ID who sent the message | +| ↳ `bot_id` | string | Bot ID if sent by a bot | +| ↳ `username` | string | Display username | +| ↳ `channel` | string | Channel ID | +| ↳ `team` | string | Team/workspace ID | +| ↳ `thread_ts` | string | Parent message timestamp \(for threaded replies\) | +| ↳ `parent_user_id` | string | User ID of thread parent message author | +| ↳ `reply_count` | number | Total number of replies in thread | +| ↳ `reply_users_count` | number | Number of unique users who replied | +| ↳ `latest_reply` | string | Timestamp of most recent reply | +| ↳ `subscribed` | boolean | Whether user is subscribed to thread | +| ↳ `last_read` | string | Timestamp of last read message | +| ↳ `unread_count` | number | Number of unread messages in thread | +| ↳ `subtype` | string | Message subtype \(bot_message, file_share, etc.\) | +| ↳ `is_starred` | boolean | Whether message is starred by user | +| ↳ `pinned_to` | array | Channel IDs where message is pinned | +| ↳ `permalink` | string | Permanent URL to the message | +| ↳ `reactions` | array | Reactions on this message | +| ↳ `name` | string | Emoji name \(without colons\) | +| ↳ `count` | number | Number of times this reaction was added | +| ↳ `users` | array | Array of user IDs who reacted | +| ↳ `files` | array | Files attached to the message | +| ↳ `id` | string | Unique file identifier | +| ↳ `name` | string | File name | +| ↳ `mimetype` | string | MIME type of the file | +| ↳ `size` | number | File size in bytes | +| ↳ `url_private` | string | Private download URL \(requires auth\) | +| ↳ `permalink` | string | Permanent link to the file | +| ↳ `mode` | string | File mode \(hosted, external, etc.\) | +| ↳ `attachments` | array | Legacy attachments on the message | +| ↳ `id` | number | Attachment ID | +| ↳ `fallback` | string | Plain text summary | +| ↳ `text` | string | Main attachment text | +| ↳ `pretext` | string | Text shown before attachment | +| ↳ `color` | string | Color bar hex code or preset | +| ↳ `author_name` | string | Author display name | +| ↳ `author_link` | string | Author link URL | +| ↳ `author_icon` | string | Author icon URL | +| ↳ `title` | string | Attachment title | +| ↳ `title_link` | string | Title link URL | +| ↳ `image_url` | string | Image URL | +| ↳ `thumb_url` | string | Thumbnail URL | +| ↳ `footer` | string | Footer text | +| ↳ `footer_icon` | string | Footer icon URL | +| ↳ `ts` | string | Timestamp shown in footer | +| ↳ `blocks` | array | Block Kit blocks in the message | +| ↳ `type` | string | Block type \(section, divider, image, actions, etc.\) | +| ↳ `block_id` | string | Unique block identifier | +| ↳ `edited` | object | Edit information if message was edited | +| ↳ `user` | string | User ID who edited the message | +| ↳ `ts` | string | Timestamp of the edit | | `replyCount` | number | Number of replies returned in this response | | `hasMore` | boolean | Whether there are more messages in the thread \(pagination needed\) | @@ -304,14 +535,20 @@ List all channels in a Slack workspace. Returns public and private channels the | `channels` | array | Array of channel objects from the workspace | | ↳ `id` | string | Channel ID \(e.g., C1234567890\) | | ↳ `name` | string | Channel name without # prefix | -| ↳ `is_private` | boolean | Whether the channel is private | -| ↳ `is_archived` | boolean | Whether the channel is archived | -| ↳ `is_member` | boolean | Whether the bot is a member of the channel | +| ↳ `is_channel` | boolean | Whether this is a channel | +| ↳ `is_private` | boolean | Whether channel is private | +| ↳ `is_archived` | boolean | Whether channel is archived | +| ↳ `is_general` | boolean | Whether this is the general channel | +| ↳ `is_member` | boolean | Whether the bot/user is a member | +| ↳ `is_shared` | boolean | Whether channel is shared across workspaces | +| ↳ `is_ext_shared` | boolean | Whether channel is externally shared | +| ↳ `is_org_shared` | boolean | Whether channel is org-wide shared | | ↳ `num_members` | number | Number of members in the channel | | ↳ `topic` | string | Channel topic | | ↳ `purpose` | string | Channel purpose/description | | ↳ `created` | number | Unix timestamp when channel was created | | ↳ `creator` | string | User ID of channel creator | +| ↳ `updated` | number | Unix timestamp of last update | | `ids` | array | Array of channel IDs for easy access | | `names` | array | Array of channel names for easy access | | `count` | number | Total number of channels returned | @@ -387,34 +624,40 @@ Get detailed information about a specific Slack user by their user ID. | Parameter | Type | Description | | --------- | ---- | ----------- | | `user` | object | Detailed user information | -| ↳ `id` | string | User ID | -| ↳ `name` | string | Username \(handle\) | -| ↳ `real_name` | string | Full real name | -| ↳ `display_name` | string | Display name shown in Slack | -| ↳ `first_name` | string | First name | -| ↳ `last_name` | string | Last name | -| ↳ `title` | string | Job title | -| ↳ `phone` | string | Phone number | -| ↳ `skype` | string | Skype handle | -| ↳ `is_bot` | boolean | Whether the user is a bot | -| ↳ `is_admin` | boolean | Whether the user is a workspace admin | -| ↳ `is_owner` | boolean | Whether the user is the workspace owner | -| ↳ `is_primary_owner` | boolean | Whether the user is the primary owner | -| ↳ `is_restricted` | boolean | Whether the user is a guest \(restricted\) | -| ↳ `is_ultra_restricted` | boolean | Whether the user is a single-channel guest | -| ↳ `deleted` | boolean | Whether the user is deactivated | -| ↳ `timezone` | string | Timezone identifier \(e.g., America/Los_Angeles\) | -| ↳ `timezone_label` | string | Human-readable timezone label | -| ↳ `timezone_offset` | number | Timezone offset in seconds from UTC | -| ↳ `avatar_24` | string | URL to 24px avatar | -| ↳ `avatar_48` | string | URL to 48px avatar | -| ↳ `avatar_72` | string | URL to 72px avatar | -| ↳ `avatar_192` | string | URL to 192px avatar | -| ↳ `avatar_512` | string | URL to 512px avatar | -| ↳ `status_text` | string | Custom status text | -| ↳ `status_emoji` | string | Custom status emoji | -| ↳ `status_expiration` | number | Unix timestamp when status expires | -| ↳ `updated` | number | Unix timestamp of last profile update | +| ↳ `id` | string | User ID \(e.g., U1234567890\) | +| ↳ `team_id` | string | Workspace/team ID | +| ↳ `name` | string | Username \(handle\) | +| ↳ `real_name` | string | Full real name | +| ↳ `display_name` | string | Display name shown in Slack | +| ↳ `first_name` | string | First name | +| ↳ `last_name` | string | Last name | +| ↳ `title` | string | Job title | +| ↳ `phone` | string | Phone number | +| ↳ `skype` | string | Skype handle | +| ↳ `is_bot` | boolean | Whether the user is a bot | +| ↳ `is_admin` | boolean | Whether the user is a workspace admin | +| ↳ `is_owner` | boolean | Whether the user is the workspace owner | +| ↳ `is_primary_owner` | boolean | Whether the user is the primary owner | +| ↳ `is_restricted` | boolean | Whether the user is a guest \(restricted\) | +| ↳ `is_ultra_restricted` | boolean | Whether the user is a single-channel guest | +| ↳ `is_app_user` | boolean | Whether user is an app user | +| ↳ `is_stranger` | boolean | Whether user is from different workspace | +| ↳ `deleted` | boolean | Whether the user is deactivated | +| ↳ `color` | string | User color for display | +| ↳ `timezone` | string | Timezone identifier \(e.g., America/Los_Angeles\) | +| ↳ `timezone_label` | string | Human-readable timezone label | +| ↳ `timezone_offset` | number | Timezone offset in seconds from UTC | +| ↳ `avatar` | string | URL to user avatar image | +| ↳ `avatar_24` | string | URL to 24px avatar | +| ↳ `avatar_48` | string | URL to 48px avatar | +| ↳ `avatar_72` | string | URL to 72px avatar | +| ↳ `avatar_192` | string | URL to 192px avatar | +| ↳ `avatar_512` | string | URL to 512px avatar | +| ↳ `status_text` | string | Custom status text | +| ↳ `status_emoji` | string | Custom status emoji | +| ↳ `status_expiration` | number | Unix timestamp when status expires | +| ↳ `updated` | number | Unix timestamp of last profile update | +| ↳ `has_2fa` | boolean | Whether two-factor auth is enabled | ### `slack_download` @@ -454,11 +697,65 @@ Update a message previously sent by the bot in Slack | Parameter | Type | Description | | --------- | ---- | ----------- | | `message` | object | Complete updated message object with all properties returned by Slack | +| ↳ `type` | string | Message type \(usually "message"\) | +| ↳ `ts` | string | Message timestamp \(unique identifier\) | +| ↳ `text` | string | Message text content | +| ↳ `user` | string | User ID who sent the message | +| ↳ `bot_id` | string | Bot ID if sent by a bot | +| ↳ `username` | string | Display username | +| ↳ `channel` | string | Channel ID | +| ↳ `team` | string | Team/workspace ID | +| ↳ `thread_ts` | string | Parent message timestamp \(for threaded replies\) | +| ↳ `parent_user_id` | string | User ID of thread parent message author | +| ↳ `reply_count` | number | Total number of replies in thread | +| ↳ `reply_users_count` | number | Number of unique users who replied | +| ↳ `latest_reply` | string | Timestamp of most recent reply | +| ↳ `subscribed` | boolean | Whether user is subscribed to thread | +| ↳ `last_read` | string | Timestamp of last read message | +| ↳ `unread_count` | number | Number of unread messages in thread | +| ↳ `subtype` | string | Message subtype \(bot_message, file_share, etc.\) | +| ↳ `is_starred` | boolean | Whether message is starred by user | +| ↳ `pinned_to` | array | Channel IDs where message is pinned | +| ↳ `permalink` | string | Permanent URL to the message | +| ↳ `reactions` | array | Reactions on this message | +| ↳ `name` | string | Emoji name \(without colons\) | +| ↳ `count` | number | Number of times this reaction was added | +| ↳ `users` | array | Array of user IDs who reacted | +| ↳ `files` | array | Files attached to the message | +| ↳ `id` | string | Unique file identifier | +| ↳ `name` | string | File name | +| ↳ `mimetype` | string | MIME type of the file | +| ↳ `size` | number | File size in bytes | +| ↳ `url_private` | string | Private download URL \(requires auth\) | +| ↳ `permalink` | string | Permanent link to the file | +| ↳ `mode` | string | File mode \(hosted, external, etc.\) | +| ↳ `attachments` | array | Legacy attachments on the message | +| ↳ `id` | number | Attachment ID | +| ↳ `fallback` | string | Plain text summary | +| ↳ `text` | string | Main attachment text | +| ↳ `pretext` | string | Text shown before attachment | +| ↳ `color` | string | Color bar hex code or preset | +| ↳ `author_name` | string | Author display name | +| ↳ `author_link` | string | Author link URL | +| ↳ `author_icon` | string | Author icon URL | +| ↳ `title` | string | Attachment title | +| ↳ `title_link` | string | Title link URL | +| ↳ `image_url` | string | Image URL | +| ↳ `thumb_url` | string | Thumbnail URL | +| ↳ `footer` | string | Footer text | +| ↳ `footer_icon` | string | Footer icon URL | +| ↳ `ts` | string | Timestamp shown in footer | +| ↳ `blocks` | array | Block Kit blocks in the message | +| ↳ `type` | string | Block type \(section, divider, image, actions, etc.\) | +| ↳ `block_id` | string | Unique block identifier | +| ↳ `edited` | object | Edit information if message was edited | +| ↳ `user` | string | User ID who edited the message | +| ↳ `ts` | string | Timestamp of the edit | | `content` | string | Success message | | `metadata` | object | Updated message metadata | -| ↳ `channel` | string | Channel ID | -| ↳ `timestamp` | string | Message timestamp | -| ↳ `text` | string | Updated message text | +| ↳ `channel` | string | Channel ID | +| ↳ `timestamp` | string | Message timestamp | +| ↳ `text` | string | Updated message text | ### `slack_delete_message` @@ -479,8 +776,8 @@ Delete a message previously sent by the bot in Slack | --------- | ---- | ----------- | | `content` | string | Success message | | `metadata` | object | Deleted message metadata | -| ↳ `channel` | string | Channel ID | -| ↳ `timestamp` | string | Message timestamp | +| ↳ `channel` | string | Channel ID | +| ↳ `timestamp` | string | Message timestamp | ### `slack_add_reaction` @@ -502,8 +799,8 @@ Add an emoji reaction to a Slack message | --------- | ---- | ----------- | | `content` | string | Success message | | `metadata` | object | Reaction metadata | -| ↳ `channel` | string | Channel ID | -| ↳ `timestamp` | string | Message timestamp | -| ↳ `reaction` | string | Emoji reaction name | +| ↳ `channel` | string | Channel ID | +| ↳ `timestamp` | string | Message timestamp | +| ↳ `reaction` | string | Emoji reaction name | diff --git a/apps/docs/content/docs/en/tools/stagehand.mdx b/apps/docs/content/docs/en/tools/stagehand.mdx index d531ed357..6862859a5 100644 --- a/apps/docs/content/docs/en/tools/stagehand.mdx +++ b/apps/docs/content/docs/en/tools/stagehand.mdx @@ -79,13 +79,19 @@ Run an autonomous web agent to complete tasks and extract structured data | Parameter | Type | Description | | --------- | ---- | ----------- | | `agentResult` | object | Result from the Stagehand agent execution | -| ↳ `success` | boolean | Whether the agent task completed successfully | -| ↳ `completed` | boolean | Whether the task was fully completed | -| ↳ `message` | string | Status message or final result | -| ↳ `actions` | array | Type of action performed | -| ↳ `type` | string | Type of action performed | -| ↳ `params` | object | Parameters used for the action | -| ↳ `result` | object | Result of the action | +| ↳ `success` | boolean | Whether the agent task completed successfully without errors | +| ↳ `completed` | boolean | Whether the agent finished executing \(may be false if max steps reached\) | +| ↳ `message` | string | Final status message or result summary from the agent | +| ↳ `actions` | array | List of all actions performed by the agent during task execution | +| ↳ `type` | string | Type of action performed \(e.g., "act", "observe", "ariaTree", "close", "wait", "navigate"\) | +| ↳ `reasoning` | string | AI reasoning for why this action was taken | +| ↳ `taskCompleted` | boolean | Whether the task was completed after this action | +| ↳ `action` | string | Description of the action taken \(e.g., "click the submit button"\) | +| ↳ `instruction` | string | Instruction that triggered this action | +| ↳ `pageUrl` | string | URL of the page when this action was performed | +| ↳ `pageText` | string | Page text content \(for ariaTree actions\) | +| ↳ `timestamp` | number | Unix timestamp when the action was performed | +| ↳ `timeMs` | number | Time in milliseconds \(for wait actions\) | | `structuredOutput` | object | Extracted data matching the provided output schema | diff --git a/apps/docs/content/docs/en/tools/stripe.mdx b/apps/docs/content/docs/en/tools/stripe.mdx index 9211c281f..f3667b1bc 100644 --- a/apps/docs/content/docs/en/tools/stripe.mdx +++ b/apps/docs/content/docs/en/tools/stripe.mdx @@ -59,12 +59,58 @@ Create a new Payment Intent to process a payment | Parameter | Type | Description | | --------- | ---- | ----------- | -| `payment_intent` | json | The created Payment Intent object | +| `payment_intent` | object | The created Payment Intent object | +| ↳ `id` | string | Unique identifier for the Payment Intent | +| ↳ `object` | string | String representing the object type \(payment_intent\) | +| ↳ `amount` | number | Amount intended to be collected in smallest currency unit | +| ↳ `amount_capturable` | number | Amount that can be captured | +| ↳ `amount_received` | number | Amount that was collected | +| ↳ `application` | string | ID of the Connect application that created the PaymentIntent | +| ↳ `application_fee_amount` | number | Application fee amount \(if any\) | +| ↳ `automatic_payment_methods` | json | Settings for automatic payment methods | +| ↳ `canceled_at` | number | Unix timestamp of cancellation | +| ↳ `cancellation_reason` | string | Reason for cancellation | +| ↳ `capture_method` | string | Controls when funds will be captured \(automatic or manual\) | +| ↳ `client_secret` | string | Client secret for confirming the PaymentIntent | +| ↳ `confirmation_method` | string | How the PaymentIntent can be confirmed \(automatic or manual\) | +| ↳ `created` | number | Unix timestamp when the PaymentIntent was created | +| ↳ `currency` | string | Three-letter ISO currency code \(lowercase\) | +| ↳ `customer` | string | ID of the Customer this PaymentIntent belongs to | +| ↳ `description` | string | Description of the payment | +| ↳ `invoice` | string | ID of the invoice that created this PaymentIntent | +| ↳ `last_payment_error` | json | The payment error encountered in the previous PaymentIntent confirmation | +| ↳ `latest_charge` | string | ID of the latest charge created by this PaymentIntent | +| ↳ `livemode` | boolean | Whether object exists in live mode or test mode | +| ↳ `metadata` | json | Set of key-value pairs for storing additional information | +| ↳ `next_action` | json | Actions required before the PaymentIntent can be confirmed | +| ↳ `on_behalf_of` | string | The account on behalf of which to charge | +| ↳ `payment_method` | string | ID of the payment method used | +| ↳ `payment_method_options` | json | Payment-method-specific configuration | +| ↳ `payment_method_types` | array | Payment method types that can be used | +| ↳ `processing` | json | Processing status if payment is being processed asynchronously | +| ↳ `receipt_email` | string | Email address to send the receipt to | +| ↳ `review` | string | ID of the review associated with this PaymentIntent | +| ↳ `setup_future_usage` | string | Indicates intent to make future payments | +| ↳ `shipping` | object | Shipping information | +| ↳ `name` | string | Recipient name | +| ↳ `phone` | string | Recipient phone number | +| ↳ `address` | object | Address object | +| ↳ `line1` | string | Address line 1 \(street address\) | +| ↳ `line2` | string | Address line 2 \(apartment, suite, etc.\) | +| ↳ `city` | string | City name | +| ↳ `state` | string | State, county, province, or region | +| ↳ `postal_code` | string | ZIP or postal code | +| ↳ `country` | string | Two-letter country code \(ISO 3166-1 alpha-2\) | +| ↳ `statement_descriptor` | string | Statement descriptor for charges | +| ↳ `statement_descriptor_suffix` | string | Statement descriptor suffix | +| ↳ `status` | string | Status of the PaymentIntent \(requires_payment_method, requires_confirmation, requires_action, processing, requires_capture, canceled, succeeded\) | +| ↳ `transfer_data` | json | The data for creating a transfer after the payment succeeds | +| ↳ `transfer_group` | string | Transfer group for transfers associated with the payment | | `metadata` | json | Payment Intent metadata including ID, status, amount, and currency | -| ↳ `id` | string | Stripe unique identifier | -| ↳ `status` | string | Current state of the resource | -| ↳ `amount` | number | Amount in smallest currency unit \(e.g., cents\) | -| ↳ `currency` | string | Three-letter ISO currency code \(lowercase\) | +| ↳ `id` | string | Stripe unique identifier | +| ↳ `status` | string | Current state of the resource | +| ↳ `amount` | number | Amount in smallest currency unit \(e.g., cents\) | +| ↳ `currency` | string | Three-letter ISO currency code \(lowercase\) | ### `stripe_retrieve_payment_intent` @@ -81,12 +127,58 @@ Retrieve an existing Payment Intent by ID | Parameter | Type | Description | | --------- | ---- | ----------- | -| `payment_intent` | json | The retrieved Payment Intent object | +| `payment_intent` | object | The retrieved Payment Intent object | +| ↳ `id` | string | Unique identifier for the Payment Intent | +| ↳ `object` | string | String representing the object type \(payment_intent\) | +| ↳ `amount` | number | Amount intended to be collected in smallest currency unit | +| ↳ `amount_capturable` | number | Amount that can be captured | +| ↳ `amount_received` | number | Amount that was collected | +| ↳ `application` | string | ID of the Connect application that created the PaymentIntent | +| ↳ `application_fee_amount` | number | Application fee amount \(if any\) | +| ↳ `automatic_payment_methods` | json | Settings for automatic payment methods | +| ↳ `canceled_at` | number | Unix timestamp of cancellation | +| ↳ `cancellation_reason` | string | Reason for cancellation | +| ↳ `capture_method` | string | Controls when funds will be captured \(automatic or manual\) | +| ↳ `client_secret` | string | Client secret for confirming the PaymentIntent | +| ↳ `confirmation_method` | string | How the PaymentIntent can be confirmed \(automatic or manual\) | +| ↳ `created` | number | Unix timestamp when the PaymentIntent was created | +| ↳ `currency` | string | Three-letter ISO currency code \(lowercase\) | +| ↳ `customer` | string | ID of the Customer this PaymentIntent belongs to | +| ↳ `description` | string | Description of the payment | +| ↳ `invoice` | string | ID of the invoice that created this PaymentIntent | +| ↳ `last_payment_error` | json | The payment error encountered in the previous PaymentIntent confirmation | +| ↳ `latest_charge` | string | ID of the latest charge created by this PaymentIntent | +| ↳ `livemode` | boolean | Whether object exists in live mode or test mode | +| ↳ `metadata` | json | Set of key-value pairs for storing additional information | +| ↳ `next_action` | json | Actions required before the PaymentIntent can be confirmed | +| ↳ `on_behalf_of` | string | The account on behalf of which to charge | +| ↳ `payment_method` | string | ID of the payment method used | +| ↳ `payment_method_options` | json | Payment-method-specific configuration | +| ↳ `payment_method_types` | array | Payment method types that can be used | +| ↳ `processing` | json | Processing status if payment is being processed asynchronously | +| ↳ `receipt_email` | string | Email address to send the receipt to | +| ↳ `review` | string | ID of the review associated with this PaymentIntent | +| ↳ `setup_future_usage` | string | Indicates intent to make future payments | +| ↳ `shipping` | object | Shipping information | +| ↳ `name` | string | Recipient name | +| ↳ `phone` | string | Recipient phone number | +| ↳ `address` | object | Address object | +| ↳ `line1` | string | Address line 1 \(street address\) | +| ↳ `line2` | string | Address line 2 \(apartment, suite, etc.\) | +| ↳ `city` | string | City name | +| ↳ `state` | string | State, county, province, or region | +| ↳ `postal_code` | string | ZIP or postal code | +| ↳ `country` | string | Two-letter country code \(ISO 3166-1 alpha-2\) | +| ↳ `statement_descriptor` | string | Statement descriptor for charges | +| ↳ `statement_descriptor_suffix` | string | Statement descriptor suffix | +| ↳ `status` | string | Status of the PaymentIntent \(requires_payment_method, requires_confirmation, requires_action, processing, requires_capture, canceled, succeeded\) | +| ↳ `transfer_data` | json | The data for creating a transfer after the payment succeeds | +| ↳ `transfer_group` | string | Transfer group for transfers associated with the payment | | `metadata` | json | Payment Intent metadata including ID, status, amount, and currency | -| ↳ `id` | string | Stripe unique identifier | -| ↳ `status` | string | Current state of the resource | -| ↳ `amount` | number | Amount in smallest currency unit \(e.g., cents\) | -| ↳ `currency` | string | Three-letter ISO currency code \(lowercase\) | +| ↳ `id` | string | Stripe unique identifier | +| ↳ `status` | string | Current state of the resource | +| ↳ `amount` | number | Amount in smallest currency unit \(e.g., cents\) | +| ↳ `currency` | string | Three-letter ISO currency code \(lowercase\) | ### `stripe_update_payment_intent` @@ -108,12 +200,58 @@ Update an existing Payment Intent | Parameter | Type | Description | | --------- | ---- | ----------- | -| `payment_intent` | json | The updated Payment Intent object | +| `payment_intent` | object | The updated Payment Intent object | +| ↳ `id` | string | Unique identifier for the Payment Intent | +| ↳ `object` | string | String representing the object type \(payment_intent\) | +| ↳ `amount` | number | Amount intended to be collected in smallest currency unit | +| ↳ `amount_capturable` | number | Amount that can be captured | +| ↳ `amount_received` | number | Amount that was collected | +| ↳ `application` | string | ID of the Connect application that created the PaymentIntent | +| ↳ `application_fee_amount` | number | Application fee amount \(if any\) | +| ↳ `automatic_payment_methods` | json | Settings for automatic payment methods | +| ↳ `canceled_at` | number | Unix timestamp of cancellation | +| ↳ `cancellation_reason` | string | Reason for cancellation | +| ↳ `capture_method` | string | Controls when funds will be captured \(automatic or manual\) | +| ↳ `client_secret` | string | Client secret for confirming the PaymentIntent | +| ↳ `confirmation_method` | string | How the PaymentIntent can be confirmed \(automatic or manual\) | +| ↳ `created` | number | Unix timestamp when the PaymentIntent was created | +| ↳ `currency` | string | Three-letter ISO currency code \(lowercase\) | +| ↳ `customer` | string | ID of the Customer this PaymentIntent belongs to | +| ↳ `description` | string | Description of the payment | +| ↳ `invoice` | string | ID of the invoice that created this PaymentIntent | +| ↳ `last_payment_error` | json | The payment error encountered in the previous PaymentIntent confirmation | +| ↳ `latest_charge` | string | ID of the latest charge created by this PaymentIntent | +| ↳ `livemode` | boolean | Whether object exists in live mode or test mode | +| ↳ `metadata` | json | Set of key-value pairs for storing additional information | +| ↳ `next_action` | json | Actions required before the PaymentIntent can be confirmed | +| ↳ `on_behalf_of` | string | The account on behalf of which to charge | +| ↳ `payment_method` | string | ID of the payment method used | +| ↳ `payment_method_options` | json | Payment-method-specific configuration | +| ↳ `payment_method_types` | array | Payment method types that can be used | +| ↳ `processing` | json | Processing status if payment is being processed asynchronously | +| ↳ `receipt_email` | string | Email address to send the receipt to | +| ↳ `review` | string | ID of the review associated with this PaymentIntent | +| ↳ `setup_future_usage` | string | Indicates intent to make future payments | +| ↳ `shipping` | object | Shipping information | +| ↳ `name` | string | Recipient name | +| ↳ `phone` | string | Recipient phone number | +| ↳ `address` | object | Address object | +| ↳ `line1` | string | Address line 1 \(street address\) | +| ↳ `line2` | string | Address line 2 \(apartment, suite, etc.\) | +| ↳ `city` | string | City name | +| ↳ `state` | string | State, county, province, or region | +| ↳ `postal_code` | string | ZIP or postal code | +| ↳ `country` | string | Two-letter country code \(ISO 3166-1 alpha-2\) | +| ↳ `statement_descriptor` | string | Statement descriptor for charges | +| ↳ `statement_descriptor_suffix` | string | Statement descriptor suffix | +| ↳ `status` | string | Status of the PaymentIntent \(requires_payment_method, requires_confirmation, requires_action, processing, requires_capture, canceled, succeeded\) | +| ↳ `transfer_data` | json | The data for creating a transfer after the payment succeeds | +| ↳ `transfer_group` | string | Transfer group for transfers associated with the payment | | `metadata` | json | Payment Intent metadata including ID, status, amount, and currency | -| ↳ `id` | string | Stripe unique identifier | -| ↳ `status` | string | Current state of the resource | -| ↳ `amount` | number | Amount in smallest currency unit \(e.g., cents\) | -| ↳ `currency` | string | Three-letter ISO currency code \(lowercase\) | +| ↳ `id` | string | Stripe unique identifier | +| ↳ `status` | string | Current state of the resource | +| ↳ `amount` | number | Amount in smallest currency unit \(e.g., cents\) | +| ↳ `currency` | string | Three-letter ISO currency code \(lowercase\) | ### `stripe_confirm_payment_intent` @@ -131,12 +269,58 @@ Confirm a Payment Intent to complete the payment | Parameter | Type | Description | | --------- | ---- | ----------- | -| `payment_intent` | json | The confirmed Payment Intent object | +| `payment_intent` | object | The confirmed Payment Intent object | +| ↳ `id` | string | Unique identifier for the Payment Intent | +| ↳ `object` | string | String representing the object type \(payment_intent\) | +| ↳ `amount` | number | Amount intended to be collected in smallest currency unit | +| ↳ `amount_capturable` | number | Amount that can be captured | +| ↳ `amount_received` | number | Amount that was collected | +| ↳ `application` | string | ID of the Connect application that created the PaymentIntent | +| ↳ `application_fee_amount` | number | Application fee amount \(if any\) | +| ↳ `automatic_payment_methods` | json | Settings for automatic payment methods | +| ↳ `canceled_at` | number | Unix timestamp of cancellation | +| ↳ `cancellation_reason` | string | Reason for cancellation | +| ↳ `capture_method` | string | Controls when funds will be captured \(automatic or manual\) | +| ↳ `client_secret` | string | Client secret for confirming the PaymentIntent | +| ↳ `confirmation_method` | string | How the PaymentIntent can be confirmed \(automatic or manual\) | +| ↳ `created` | number | Unix timestamp when the PaymentIntent was created | +| ↳ `currency` | string | Three-letter ISO currency code \(lowercase\) | +| ↳ `customer` | string | ID of the Customer this PaymentIntent belongs to | +| ↳ `description` | string | Description of the payment | +| ↳ `invoice` | string | ID of the invoice that created this PaymentIntent | +| ↳ `last_payment_error` | json | The payment error encountered in the previous PaymentIntent confirmation | +| ↳ `latest_charge` | string | ID of the latest charge created by this PaymentIntent | +| ↳ `livemode` | boolean | Whether object exists in live mode or test mode | +| ↳ `metadata` | json | Set of key-value pairs for storing additional information | +| ↳ `next_action` | json | Actions required before the PaymentIntent can be confirmed | +| ↳ `on_behalf_of` | string | The account on behalf of which to charge | +| ↳ `payment_method` | string | ID of the payment method used | +| ↳ `payment_method_options` | json | Payment-method-specific configuration | +| ↳ `payment_method_types` | array | Payment method types that can be used | +| ↳ `processing` | json | Processing status if payment is being processed asynchronously | +| ↳ `receipt_email` | string | Email address to send the receipt to | +| ↳ `review` | string | ID of the review associated with this PaymentIntent | +| ↳ `setup_future_usage` | string | Indicates intent to make future payments | +| ↳ `shipping` | object | Shipping information | +| ↳ `name` | string | Recipient name | +| ↳ `phone` | string | Recipient phone number | +| ↳ `address` | object | Address object | +| ↳ `line1` | string | Address line 1 \(street address\) | +| ↳ `line2` | string | Address line 2 \(apartment, suite, etc.\) | +| ↳ `city` | string | City name | +| ↳ `state` | string | State, county, province, or region | +| ↳ `postal_code` | string | ZIP or postal code | +| ↳ `country` | string | Two-letter country code \(ISO 3166-1 alpha-2\) | +| ↳ `statement_descriptor` | string | Statement descriptor for charges | +| ↳ `statement_descriptor_suffix` | string | Statement descriptor suffix | +| ↳ `status` | string | Status of the PaymentIntent \(requires_payment_method, requires_confirmation, requires_action, processing, requires_capture, canceled, succeeded\) | +| ↳ `transfer_data` | json | The data for creating a transfer after the payment succeeds | +| ↳ `transfer_group` | string | Transfer group for transfers associated with the payment | | `metadata` | json | Payment Intent metadata including ID, status, amount, and currency | -| ↳ `id` | string | Stripe unique identifier | -| ↳ `status` | string | Current state of the resource | -| ↳ `amount` | number | Amount in smallest currency unit \(e.g., cents\) | -| ↳ `currency` | string | Three-letter ISO currency code \(lowercase\) | +| ↳ `id` | string | Stripe unique identifier | +| ↳ `status` | string | Current state of the resource | +| ↳ `amount` | number | Amount in smallest currency unit \(e.g., cents\) | +| ↳ `currency` | string | Three-letter ISO currency code \(lowercase\) | ### `stripe_capture_payment_intent` @@ -154,12 +338,58 @@ Capture an authorized Payment Intent | Parameter | Type | Description | | --------- | ---- | ----------- | -| `payment_intent` | json | The captured Payment Intent object | +| `payment_intent` | object | The captured Payment Intent object | +| ↳ `id` | string | Unique identifier for the Payment Intent | +| ↳ `object` | string | String representing the object type \(payment_intent\) | +| ↳ `amount` | number | Amount intended to be collected in smallest currency unit | +| ↳ `amount_capturable` | number | Amount that can be captured | +| ↳ `amount_received` | number | Amount that was collected | +| ↳ `application` | string | ID of the Connect application that created the PaymentIntent | +| ↳ `application_fee_amount` | number | Application fee amount \(if any\) | +| ↳ `automatic_payment_methods` | json | Settings for automatic payment methods | +| ↳ `canceled_at` | number | Unix timestamp of cancellation | +| ↳ `cancellation_reason` | string | Reason for cancellation | +| ↳ `capture_method` | string | Controls when funds will be captured \(automatic or manual\) | +| ↳ `client_secret` | string | Client secret for confirming the PaymentIntent | +| ↳ `confirmation_method` | string | How the PaymentIntent can be confirmed \(automatic or manual\) | +| ↳ `created` | number | Unix timestamp when the PaymentIntent was created | +| ↳ `currency` | string | Three-letter ISO currency code \(lowercase\) | +| ↳ `customer` | string | ID of the Customer this PaymentIntent belongs to | +| ↳ `description` | string | Description of the payment | +| ↳ `invoice` | string | ID of the invoice that created this PaymentIntent | +| ↳ `last_payment_error` | json | The payment error encountered in the previous PaymentIntent confirmation | +| ↳ `latest_charge` | string | ID of the latest charge created by this PaymentIntent | +| ↳ `livemode` | boolean | Whether object exists in live mode or test mode | +| ↳ `metadata` | json | Set of key-value pairs for storing additional information | +| ↳ `next_action` | json | Actions required before the PaymentIntent can be confirmed | +| ↳ `on_behalf_of` | string | The account on behalf of which to charge | +| ↳ `payment_method` | string | ID of the payment method used | +| ↳ `payment_method_options` | json | Payment-method-specific configuration | +| ↳ `payment_method_types` | array | Payment method types that can be used | +| ↳ `processing` | json | Processing status if payment is being processed asynchronously | +| ↳ `receipt_email` | string | Email address to send the receipt to | +| ↳ `review` | string | ID of the review associated with this PaymentIntent | +| ↳ `setup_future_usage` | string | Indicates intent to make future payments | +| ↳ `shipping` | object | Shipping information | +| ↳ `name` | string | Recipient name | +| ↳ `phone` | string | Recipient phone number | +| ↳ `address` | object | Address object | +| ↳ `line1` | string | Address line 1 \(street address\) | +| ↳ `line2` | string | Address line 2 \(apartment, suite, etc.\) | +| ↳ `city` | string | City name | +| ↳ `state` | string | State, county, province, or region | +| ↳ `postal_code` | string | ZIP or postal code | +| ↳ `country` | string | Two-letter country code \(ISO 3166-1 alpha-2\) | +| ↳ `statement_descriptor` | string | Statement descriptor for charges | +| ↳ `statement_descriptor_suffix` | string | Statement descriptor suffix | +| ↳ `status` | string | Status of the PaymentIntent \(requires_payment_method, requires_confirmation, requires_action, processing, requires_capture, canceled, succeeded\) | +| ↳ `transfer_data` | json | The data for creating a transfer after the payment succeeds | +| ↳ `transfer_group` | string | Transfer group for transfers associated with the payment | | `metadata` | json | Payment Intent metadata including ID, status, amount, and currency | -| ↳ `id` | string | Stripe unique identifier | -| ↳ `status` | string | Current state of the resource | -| ↳ `amount` | number | Amount in smallest currency unit \(e.g., cents\) | -| ↳ `currency` | string | Three-letter ISO currency code \(lowercase\) | +| ↳ `id` | string | Stripe unique identifier | +| ↳ `status` | string | Current state of the resource | +| ↳ `amount` | number | Amount in smallest currency unit \(e.g., cents\) | +| ↳ `currency` | string | Three-letter ISO currency code \(lowercase\) | ### `stripe_cancel_payment_intent` @@ -177,12 +407,58 @@ Cancel a Payment Intent | Parameter | Type | Description | | --------- | ---- | ----------- | -| `payment_intent` | json | The canceled Payment Intent object | +| `payment_intent` | object | The canceled Payment Intent object | +| ↳ `id` | string | Unique identifier for the Payment Intent | +| ↳ `object` | string | String representing the object type \(payment_intent\) | +| ↳ `amount` | number | Amount intended to be collected in smallest currency unit | +| ↳ `amount_capturable` | number | Amount that can be captured | +| ↳ `amount_received` | number | Amount that was collected | +| ↳ `application` | string | ID of the Connect application that created the PaymentIntent | +| ↳ `application_fee_amount` | number | Application fee amount \(if any\) | +| ↳ `automatic_payment_methods` | json | Settings for automatic payment methods | +| ↳ `canceled_at` | number | Unix timestamp of cancellation | +| ↳ `cancellation_reason` | string | Reason for cancellation | +| ↳ `capture_method` | string | Controls when funds will be captured \(automatic or manual\) | +| ↳ `client_secret` | string | Client secret for confirming the PaymentIntent | +| ↳ `confirmation_method` | string | How the PaymentIntent can be confirmed \(automatic or manual\) | +| ↳ `created` | number | Unix timestamp when the PaymentIntent was created | +| ↳ `currency` | string | Three-letter ISO currency code \(lowercase\) | +| ↳ `customer` | string | ID of the Customer this PaymentIntent belongs to | +| ↳ `description` | string | Description of the payment | +| ↳ `invoice` | string | ID of the invoice that created this PaymentIntent | +| ↳ `last_payment_error` | json | The payment error encountered in the previous PaymentIntent confirmation | +| ↳ `latest_charge` | string | ID of the latest charge created by this PaymentIntent | +| ↳ `livemode` | boolean | Whether object exists in live mode or test mode | +| ↳ `metadata` | json | Set of key-value pairs for storing additional information | +| ↳ `next_action` | json | Actions required before the PaymentIntent can be confirmed | +| ↳ `on_behalf_of` | string | The account on behalf of which to charge | +| ↳ `payment_method` | string | ID of the payment method used | +| ↳ `payment_method_options` | json | Payment-method-specific configuration | +| ↳ `payment_method_types` | array | Payment method types that can be used | +| ↳ `processing` | json | Processing status if payment is being processed asynchronously | +| ↳ `receipt_email` | string | Email address to send the receipt to | +| ↳ `review` | string | ID of the review associated with this PaymentIntent | +| ↳ `setup_future_usage` | string | Indicates intent to make future payments | +| ↳ `shipping` | object | Shipping information | +| ↳ `name` | string | Recipient name | +| ↳ `phone` | string | Recipient phone number | +| ↳ `address` | object | Address object | +| ↳ `line1` | string | Address line 1 \(street address\) | +| ↳ `line2` | string | Address line 2 \(apartment, suite, etc.\) | +| ↳ `city` | string | City name | +| ↳ `state` | string | State, county, province, or region | +| ↳ `postal_code` | string | ZIP or postal code | +| ↳ `country` | string | Two-letter country code \(ISO 3166-1 alpha-2\) | +| ↳ `statement_descriptor` | string | Statement descriptor for charges | +| ↳ `statement_descriptor_suffix` | string | Statement descriptor suffix | +| ↳ `status` | string | Status of the PaymentIntent \(requires_payment_method, requires_confirmation, requires_action, processing, requires_capture, canceled, succeeded\) | +| ↳ `transfer_data` | json | The data for creating a transfer after the payment succeeds | +| ↳ `transfer_group` | string | Transfer group for transfers associated with the payment | | `metadata` | json | Payment Intent metadata including ID, status, amount, and currency | -| ↳ `id` | string | Stripe unique identifier | -| ↳ `status` | string | Current state of the resource | -| ↳ `amount` | number | Amount in smallest currency unit \(e.g., cents\) | -| ↳ `currency` | string | Three-letter ISO currency code \(lowercase\) | +| ↳ `id` | string | Stripe unique identifier | +| ↳ `status` | string | Current state of the resource | +| ↳ `amount` | number | Amount in smallest currency unit \(e.g., cents\) | +| ↳ `currency` | string | Three-letter ISO currency code \(lowercase\) | ### `stripe_list_payment_intents` @@ -201,10 +477,56 @@ List all Payment Intents | Parameter | Type | Description | | --------- | ---- | ----------- | -| `payment_intents` | json | Array of Payment Intent objects | +| `payment_intents` | array | Array of Payment Intent objects | +| ↳ `id` | string | Unique identifier for the Payment Intent | +| ↳ `object` | string | String representing the object type \(payment_intent\) | +| ↳ `amount` | number | Amount intended to be collected in smallest currency unit | +| ↳ `amount_capturable` | number | Amount that can be captured | +| ↳ `amount_received` | number | Amount that was collected | +| ↳ `application` | string | ID of the Connect application that created the PaymentIntent | +| ↳ `application_fee_amount` | number | Application fee amount \(if any\) | +| ↳ `automatic_payment_methods` | json | Settings for automatic payment methods | +| ↳ `canceled_at` | number | Unix timestamp of cancellation | +| ↳ `cancellation_reason` | string | Reason for cancellation | +| ↳ `capture_method` | string | Controls when funds will be captured \(automatic or manual\) | +| ↳ `client_secret` | string | Client secret for confirming the PaymentIntent | +| ↳ `confirmation_method` | string | How the PaymentIntent can be confirmed \(automatic or manual\) | +| ↳ `created` | number | Unix timestamp when the PaymentIntent was created | +| ↳ `currency` | string | Three-letter ISO currency code \(lowercase\) | +| ↳ `customer` | string | ID of the Customer this PaymentIntent belongs to | +| ↳ `description` | string | Description of the payment | +| ↳ `invoice` | string | ID of the invoice that created this PaymentIntent | +| ↳ `last_payment_error` | json | The payment error encountered in the previous PaymentIntent confirmation | +| ↳ `latest_charge` | string | ID of the latest charge created by this PaymentIntent | +| ↳ `livemode` | boolean | Whether object exists in live mode or test mode | +| ↳ `metadata` | json | Set of key-value pairs for storing additional information | +| ↳ `next_action` | json | Actions required before the PaymentIntent can be confirmed | +| ↳ `on_behalf_of` | string | The account on behalf of which to charge | +| ↳ `payment_method` | string | ID of the payment method used | +| ↳ `payment_method_options` | json | Payment-method-specific configuration | +| ↳ `payment_method_types` | array | Payment method types that can be used | +| ↳ `processing` | json | Processing status if payment is being processed asynchronously | +| ↳ `receipt_email` | string | Email address to send the receipt to | +| ↳ `review` | string | ID of the review associated with this PaymentIntent | +| ↳ `setup_future_usage` | string | Indicates intent to make future payments | +| ↳ `shipping` | object | Shipping information | +| ↳ `name` | string | Recipient name | +| ↳ `phone` | string | Recipient phone number | +| ↳ `address` | object | Address object | +| ↳ `line1` | string | Address line 1 \(street address\) | +| ↳ `line2` | string | Address line 2 \(apartment, suite, etc.\) | +| ↳ `city` | string | City name | +| ↳ `state` | string | State, county, province, or region | +| ↳ `postal_code` | string | ZIP or postal code | +| ↳ `country` | string | Two-letter country code \(ISO 3166-1 alpha-2\) | +| ↳ `statement_descriptor` | string | Statement descriptor for charges | +| ↳ `statement_descriptor_suffix` | string | Statement descriptor suffix | +| ↳ `status` | string | Status of the PaymentIntent \(requires_payment_method, requires_confirmation, requires_action, processing, requires_capture, canceled, succeeded\) | +| ↳ `transfer_data` | json | The data for creating a transfer after the payment succeeds | +| ↳ `transfer_group` | string | Transfer group for transfers associated with the payment | | `metadata` | json | List metadata including count and has_more | -| ↳ `count` | number | Number of items returned | -| ↳ `has_more` | boolean | Whether more items exist beyond this page | +| ↳ `count` | number | Number of items returned | +| ↳ `has_more` | boolean | Whether more items exist beyond this page | ### `stripe_search_payment_intents` @@ -222,10 +544,56 @@ Search for Payment Intents using query syntax | Parameter | Type | Description | | --------- | ---- | ----------- | -| `payment_intents` | json | Array of matching Payment Intent objects | +| `payment_intents` | array | Array of matching Payment Intent objects | +| ↳ `id` | string | Unique identifier for the Payment Intent | +| ↳ `object` | string | String representing the object type \(payment_intent\) | +| ↳ `amount` | number | Amount intended to be collected in smallest currency unit | +| ↳ `amount_capturable` | number | Amount that can be captured | +| ↳ `amount_received` | number | Amount that was collected | +| ↳ `application` | string | ID of the Connect application that created the PaymentIntent | +| ↳ `application_fee_amount` | number | Application fee amount \(if any\) | +| ↳ `automatic_payment_methods` | json | Settings for automatic payment methods | +| ↳ `canceled_at` | number | Unix timestamp of cancellation | +| ↳ `cancellation_reason` | string | Reason for cancellation | +| ↳ `capture_method` | string | Controls when funds will be captured \(automatic or manual\) | +| ↳ `client_secret` | string | Client secret for confirming the PaymentIntent | +| ↳ `confirmation_method` | string | How the PaymentIntent can be confirmed \(automatic or manual\) | +| ↳ `created` | number | Unix timestamp when the PaymentIntent was created | +| ↳ `currency` | string | Three-letter ISO currency code \(lowercase\) | +| ↳ `customer` | string | ID of the Customer this PaymentIntent belongs to | +| ↳ `description` | string | Description of the payment | +| ↳ `invoice` | string | ID of the invoice that created this PaymentIntent | +| ↳ `last_payment_error` | json | The payment error encountered in the previous PaymentIntent confirmation | +| ↳ `latest_charge` | string | ID of the latest charge created by this PaymentIntent | +| ↳ `livemode` | boolean | Whether object exists in live mode or test mode | +| ↳ `metadata` | json | Set of key-value pairs for storing additional information | +| ↳ `next_action` | json | Actions required before the PaymentIntent can be confirmed | +| ↳ `on_behalf_of` | string | The account on behalf of which to charge | +| ↳ `payment_method` | string | ID of the payment method used | +| ↳ `payment_method_options` | json | Payment-method-specific configuration | +| ↳ `payment_method_types` | array | Payment method types that can be used | +| ↳ `processing` | json | Processing status if payment is being processed asynchronously | +| ↳ `receipt_email` | string | Email address to send the receipt to | +| ↳ `review` | string | ID of the review associated with this PaymentIntent | +| ↳ `setup_future_usage` | string | Indicates intent to make future payments | +| ↳ `shipping` | object | Shipping information | +| ↳ `name` | string | Recipient name | +| ↳ `phone` | string | Recipient phone number | +| ↳ `address` | object | Address object | +| ↳ `line1` | string | Address line 1 \(street address\) | +| ↳ `line2` | string | Address line 2 \(apartment, suite, etc.\) | +| ↳ `city` | string | City name | +| ↳ `state` | string | State, county, province, or region | +| ↳ `postal_code` | string | ZIP or postal code | +| ↳ `country` | string | Two-letter country code \(ISO 3166-1 alpha-2\) | +| ↳ `statement_descriptor` | string | Statement descriptor for charges | +| ↳ `statement_descriptor_suffix` | string | Statement descriptor suffix | +| ↳ `status` | string | Status of the PaymentIntent \(requires_payment_method, requires_confirmation, requires_action, processing, requires_capture, canceled, succeeded\) | +| ↳ `transfer_data` | json | The data for creating a transfer after the payment succeeds | +| ↳ `transfer_group` | string | Transfer group for transfers associated with the payment | | `metadata` | json | Search metadata including count and has_more | -| ↳ `count` | number | Number of items returned | -| ↳ `has_more` | boolean | Whether more items exist beyond this page | +| ↳ `count` | number | Number of items returned | +| ↳ `has_more` | boolean | Whether more items exist beyond this page | ### `stripe_create_customer` @@ -248,11 +616,48 @@ Create a new customer object | Parameter | Type | Description | | --------- | ---- | ----------- | -| `customer` | json | The created customer object | +| `customer` | object | The created customer object | +| ↳ `id` | string | Unique identifier for the customer | +| ↳ `object` | string | String representing the object type \(customer\) | +| ↳ `address` | object | Address object | +| ↳ `line1` | string | Address line 1 \(street address\) | +| ↳ `line2` | string | Address line 2 \(apartment, suite, etc.\) | +| ↳ `city` | string | City name | +| ↳ `state` | string | State, county, province, or region | +| ↳ `postal_code` | string | ZIP or postal code | +| ↳ `country` | string | Two-letter country code \(ISO 3166-1 alpha-2\) | +| ↳ `balance` | number | Current balance in smallest currency unit | +| ↳ `created` | number | Unix timestamp when the customer was created | +| ↳ `currency` | string | Three-letter ISO currency code \(lowercase\) | +| ↳ `default_source` | string | ID of the default payment source | +| ↳ `delinquent` | boolean | Whether the customer has unpaid invoices | +| ↳ `description` | string | Description of the customer | +| ↳ `discount` | json | Discount that applies to all recurring charges | +| ↳ `email` | string | Customer email address \(max 512 characters\) | +| ↳ `invoice_prefix` | string | Prefix for generating unique invoice numbers | +| ↳ `invoice_settings` | json | Default invoice settings | +| ↳ `livemode` | boolean | Whether object exists in live mode or test mode | +| ↳ `metadata` | json | Set of key-value pairs for storing additional information | +| ↳ `name` | string | Customer full name or business name \(max 256 characters\) | +| ↳ `next_invoice_sequence` | number | Next invoice sequence number | +| ↳ `phone` | string | Customer phone number \(max 20 characters\) | +| ↳ `preferred_locales` | array | Customer preferred locales | +| ↳ `shipping` | object | Shipping information | +| ↳ `name` | string | Recipient name | +| ↳ `phone` | string | Recipient phone number | +| ↳ `address` | object | Address object | +| ↳ `line1` | string | Address line 1 \(street address\) | +| ↳ `line2` | string | Address line 2 \(apartment, suite, etc.\) | +| ↳ `city` | string | City name | +| ↳ `state` | string | State, county, province, or region | +| ↳ `postal_code` | string | ZIP or postal code | +| ↳ `country` | string | Two-letter country code \(ISO 3166-1 alpha-2\) | +| ↳ `tax_exempt` | string | Tax exemption status \(none, exempt, reverse\) | +| ↳ `test_clock` | string | ID of the test clock | | `metadata` | json | Customer metadata | -| ↳ `id` | string | Stripe unique identifier | -| ↳ `email` | string | Customer email address | -| ↳ `name` | string | Display name | +| ↳ `id` | string | Stripe unique identifier | +| ↳ `email` | string | Customer email address | +| ↳ `name` | string | Display name | ### `stripe_retrieve_customer` @@ -269,11 +674,48 @@ Retrieve an existing customer by ID | Parameter | Type | Description | | --------- | ---- | ----------- | -| `customer` | json | The retrieved customer object | +| `customer` | object | The retrieved customer object | +| ↳ `id` | string | Unique identifier for the customer | +| ↳ `object` | string | String representing the object type \(customer\) | +| ↳ `address` | object | Address object | +| ↳ `line1` | string | Address line 1 \(street address\) | +| ↳ `line2` | string | Address line 2 \(apartment, suite, etc.\) | +| ↳ `city` | string | City name | +| ↳ `state` | string | State, county, province, or region | +| ↳ `postal_code` | string | ZIP or postal code | +| ↳ `country` | string | Two-letter country code \(ISO 3166-1 alpha-2\) | +| ↳ `balance` | number | Current balance in smallest currency unit | +| ↳ `created` | number | Unix timestamp when the customer was created | +| ↳ `currency` | string | Three-letter ISO currency code \(lowercase\) | +| ↳ `default_source` | string | ID of the default payment source | +| ↳ `delinquent` | boolean | Whether the customer has unpaid invoices | +| ↳ `description` | string | Description of the customer | +| ↳ `discount` | json | Discount that applies to all recurring charges | +| ↳ `email` | string | Customer email address \(max 512 characters\) | +| ↳ `invoice_prefix` | string | Prefix for generating unique invoice numbers | +| ↳ `invoice_settings` | json | Default invoice settings | +| ↳ `livemode` | boolean | Whether object exists in live mode or test mode | +| ↳ `metadata` | json | Set of key-value pairs for storing additional information | +| ↳ `name` | string | Customer full name or business name \(max 256 characters\) | +| ↳ `next_invoice_sequence` | number | Next invoice sequence number | +| ↳ `phone` | string | Customer phone number \(max 20 characters\) | +| ↳ `preferred_locales` | array | Customer preferred locales | +| ↳ `shipping` | object | Shipping information | +| ↳ `name` | string | Recipient name | +| ↳ `phone` | string | Recipient phone number | +| ↳ `address` | object | Address object | +| ↳ `line1` | string | Address line 1 \(street address\) | +| ↳ `line2` | string | Address line 2 \(apartment, suite, etc.\) | +| ↳ `city` | string | City name | +| ↳ `state` | string | State, county, province, or region | +| ↳ `postal_code` | string | ZIP or postal code | +| ↳ `country` | string | Two-letter country code \(ISO 3166-1 alpha-2\) | +| ↳ `tax_exempt` | string | Tax exemption status \(none, exempt, reverse\) | +| ↳ `test_clock` | string | ID of the test clock | | `metadata` | json | Customer metadata | -| ↳ `id` | string | Stripe unique identifier | -| ↳ `email` | string | Customer email address | -| ↳ `name` | string | Display name | +| ↳ `id` | string | Stripe unique identifier | +| ↳ `email` | string | Customer email address | +| ↳ `name` | string | Display name | ### `stripe_update_customer` @@ -296,11 +738,48 @@ Update an existing customer | Parameter | Type | Description | | --------- | ---- | ----------- | -| `customer` | json | The updated customer object | +| `customer` | object | The updated customer object | +| ↳ `id` | string | Unique identifier for the customer | +| ↳ `object` | string | String representing the object type \(customer\) | +| ↳ `address` | object | Address object | +| ↳ `line1` | string | Address line 1 \(street address\) | +| ↳ `line2` | string | Address line 2 \(apartment, suite, etc.\) | +| ↳ `city` | string | City name | +| ↳ `state` | string | State, county, province, or region | +| ↳ `postal_code` | string | ZIP or postal code | +| ↳ `country` | string | Two-letter country code \(ISO 3166-1 alpha-2\) | +| ↳ `balance` | number | Current balance in smallest currency unit | +| ↳ `created` | number | Unix timestamp when the customer was created | +| ↳ `currency` | string | Three-letter ISO currency code \(lowercase\) | +| ↳ `default_source` | string | ID of the default payment source | +| ↳ `delinquent` | boolean | Whether the customer has unpaid invoices | +| ↳ `description` | string | Description of the customer | +| ↳ `discount` | json | Discount that applies to all recurring charges | +| ↳ `email` | string | Customer email address \(max 512 characters\) | +| ↳ `invoice_prefix` | string | Prefix for generating unique invoice numbers | +| ↳ `invoice_settings` | json | Default invoice settings | +| ↳ `livemode` | boolean | Whether object exists in live mode or test mode | +| ↳ `metadata` | json | Set of key-value pairs for storing additional information | +| ↳ `name` | string | Customer full name or business name \(max 256 characters\) | +| ↳ `next_invoice_sequence` | number | Next invoice sequence number | +| ↳ `phone` | string | Customer phone number \(max 20 characters\) | +| ↳ `preferred_locales` | array | Customer preferred locales | +| ↳ `shipping` | object | Shipping information | +| ↳ `name` | string | Recipient name | +| ↳ `phone` | string | Recipient phone number | +| ↳ `address` | object | Address object | +| ↳ `line1` | string | Address line 1 \(street address\) | +| ↳ `line2` | string | Address line 2 \(apartment, suite, etc.\) | +| ↳ `city` | string | City name | +| ↳ `state` | string | State, county, province, or region | +| ↳ `postal_code` | string | ZIP or postal code | +| ↳ `country` | string | Two-letter country code \(ISO 3166-1 alpha-2\) | +| ↳ `tax_exempt` | string | Tax exemption status \(none, exempt, reverse\) | +| ↳ `test_clock` | string | ID of the test clock | | `metadata` | json | Customer metadata | -| ↳ `id` | string | Stripe unique identifier | -| ↳ `email` | string | Customer email address | -| ↳ `name` | string | Display name | +| ↳ `id` | string | Stripe unique identifier | +| ↳ `email` | string | Customer email address | +| ↳ `name` | string | Display name | ### `stripe_delete_customer` @@ -317,8 +796,8 @@ Permanently delete a customer | Parameter | Type | Description | | --------- | ---- | ----------- | -| `deleted` | boolean | Whether the customer was deleted | -| `id` | string | The ID of the deleted customer | +| `deleted` | boolean | Whether the resource was deleted | +| `id` | string | ID of the deleted resource | ### `stripe_list_customers` @@ -337,10 +816,47 @@ List all customers | Parameter | Type | Description | | --------- | ---- | ----------- | -| `customers` | json | Array of customer objects | +| `customers` | array | Array of customer objects | +| ↳ `id` | string | Unique identifier for the customer | +| ↳ `object` | string | String representing the object type \(customer\) | +| ↳ `address` | object | Address object | +| ↳ `line1` | string | Address line 1 \(street address\) | +| ↳ `line2` | string | Address line 2 \(apartment, suite, etc.\) | +| ↳ `city` | string | City name | +| ↳ `state` | string | State, county, province, or region | +| ↳ `postal_code` | string | ZIP or postal code | +| ↳ `country` | string | Two-letter country code \(ISO 3166-1 alpha-2\) | +| ↳ `balance` | number | Current balance in smallest currency unit | +| ↳ `created` | number | Unix timestamp when the customer was created | +| ↳ `currency` | string | Three-letter ISO currency code \(lowercase\) | +| ↳ `default_source` | string | ID of the default payment source | +| ↳ `delinquent` | boolean | Whether the customer has unpaid invoices | +| ↳ `description` | string | Description of the customer | +| ↳ `discount` | json | Discount that applies to all recurring charges | +| ↳ `email` | string | Customer email address \(max 512 characters\) | +| ↳ `invoice_prefix` | string | Prefix for generating unique invoice numbers | +| ↳ `invoice_settings` | json | Default invoice settings | +| ↳ `livemode` | boolean | Whether object exists in live mode or test mode | +| ↳ `metadata` | json | Set of key-value pairs for storing additional information | +| ↳ `name` | string | Customer full name or business name \(max 256 characters\) | +| ↳ `next_invoice_sequence` | number | Next invoice sequence number | +| ↳ `phone` | string | Customer phone number \(max 20 characters\) | +| ↳ `preferred_locales` | array | Customer preferred locales | +| ↳ `shipping` | object | Shipping information | +| ↳ `name` | string | Recipient name | +| ↳ `phone` | string | Recipient phone number | +| ↳ `address` | object | Address object | +| ↳ `line1` | string | Address line 1 \(street address\) | +| ↳ `line2` | string | Address line 2 \(apartment, suite, etc.\) | +| ↳ `city` | string | City name | +| ↳ `state` | string | State, county, province, or region | +| ↳ `postal_code` | string | ZIP or postal code | +| ↳ `country` | string | Two-letter country code \(ISO 3166-1 alpha-2\) | +| ↳ `tax_exempt` | string | Tax exemption status \(none, exempt, reverse\) | +| ↳ `test_clock` | string | ID of the test clock | | `metadata` | json | List metadata | -| ↳ `count` | number | Number of items returned | -| ↳ `has_more` | boolean | Whether more items exist beyond this page | +| ↳ `count` | number | Number of items returned | +| ↳ `has_more` | boolean | Whether more items exist beyond this page | ### `stripe_search_customers` @@ -358,10 +874,47 @@ Search for customers using query syntax | Parameter | Type | Description | | --------- | ---- | ----------- | -| `customers` | json | Array of matching customer objects | +| `customers` | array | Array of matching customer objects | +| ↳ `id` | string | Unique identifier for the customer | +| ↳ `object` | string | String representing the object type \(customer\) | +| ↳ `address` | object | Address object | +| ↳ `line1` | string | Address line 1 \(street address\) | +| ↳ `line2` | string | Address line 2 \(apartment, suite, etc.\) | +| ↳ `city` | string | City name | +| ↳ `state` | string | State, county, province, or region | +| ↳ `postal_code` | string | ZIP or postal code | +| ↳ `country` | string | Two-letter country code \(ISO 3166-1 alpha-2\) | +| ↳ `balance` | number | Current balance in smallest currency unit | +| ↳ `created` | number | Unix timestamp when the customer was created | +| ↳ `currency` | string | Three-letter ISO currency code \(lowercase\) | +| ↳ `default_source` | string | ID of the default payment source | +| ↳ `delinquent` | boolean | Whether the customer has unpaid invoices | +| ↳ `description` | string | Description of the customer | +| ↳ `discount` | json | Discount that applies to all recurring charges | +| ↳ `email` | string | Customer email address \(max 512 characters\) | +| ↳ `invoice_prefix` | string | Prefix for generating unique invoice numbers | +| ↳ `invoice_settings` | json | Default invoice settings | +| ↳ `livemode` | boolean | Whether object exists in live mode or test mode | +| ↳ `metadata` | json | Set of key-value pairs for storing additional information | +| ↳ `name` | string | Customer full name or business name \(max 256 characters\) | +| ↳ `next_invoice_sequence` | number | Next invoice sequence number | +| ↳ `phone` | string | Customer phone number \(max 20 characters\) | +| ↳ `preferred_locales` | array | Customer preferred locales | +| ↳ `shipping` | object | Shipping information | +| ↳ `name` | string | Recipient name | +| ↳ `phone` | string | Recipient phone number | +| ↳ `address` | object | Address object | +| ↳ `line1` | string | Address line 1 \(street address\) | +| ↳ `line2` | string | Address line 2 \(apartment, suite, etc.\) | +| ↳ `city` | string | City name | +| ↳ `state` | string | State, county, province, or region | +| ↳ `postal_code` | string | ZIP or postal code | +| ↳ `country` | string | Two-letter country code \(ISO 3166-1 alpha-2\) | +| ↳ `tax_exempt` | string | Tax exemption status \(none, exempt, reverse\) | +| ↳ `test_clock` | string | ID of the test clock | | `metadata` | json | Search metadata | -| ↳ `count` | number | Number of items returned | -| ↳ `has_more` | boolean | Whether more items exist beyond this page | +| ↳ `count` | number | Number of items returned | +| ↳ `has_more` | boolean | Whether more items exist beyond this page | ### `stripe_create_subscription` @@ -383,11 +936,53 @@ Create a new subscription for a customer | Parameter | Type | Description | | --------- | ---- | ----------- | -| `subscription` | json | The created subscription object | +| `subscription` | object | The created subscription object | +| ↳ `id` | string | Unique identifier for the subscription | +| ↳ `object` | string | String representing the object type \(subscription\) | +| ↳ `application` | string | ID of the Connect application that created the subscription | +| ↳ `application_fee_percent` | number | Application fee percent \(if any\) | +| ↳ `automatic_tax` | json | Automatic tax settings | +| ↳ `billing_cycle_anchor` | number | Unix timestamp determining when billing cycle starts | +| ↳ `billing_thresholds` | json | Billing thresholds for the subscription | +| ↳ `cancel_at` | number | Unix timestamp when the subscription will be canceled | +| ↳ `cancel_at_period_end` | boolean | Whether the subscription will be canceled at period end | +| ↳ `canceled_at` | number | Unix timestamp when the subscription was canceled | +| ↳ `cancellation_details` | json | Details about cancellation | +| ↳ `collection_method` | string | Collection method \(charge_automatically or send_invoice\) | +| ↳ `created` | number | Unix timestamp when the subscription was created | +| ↳ `currency` | string | Three-letter ISO currency code \(lowercase\) | +| ↳ `current_period_end` | number | Unix timestamp when the current period ends | +| ↳ `current_period_start` | number | Unix timestamp when the current period started | +| ↳ `customer` | string | ID of the customer who owns the subscription | +| ↳ `days_until_due` | number | Number of days a customer has to pay invoices | +| ↳ `default_payment_method` | string | ID of the default payment method | +| ↳ `default_source` | string | ID of the default source | +| ↳ `default_tax_rates` | array | Default tax rates | +| ↳ `description` | string | Subscription description \(max 500 characters\) | +| ↳ `discount` | json | Discount that applies to the subscription | +| ↳ `ended_at` | number | Unix timestamp when the subscription ended | +| ↳ `latest_invoice` | string | ID of the most recent invoice | +| ↳ `livemode` | boolean | Whether object exists in live mode or test mode | +| ↳ `metadata` | json | Set of key-value pairs for storing additional information | +| ↳ `next_pending_invoice_item_invoice` | number | Unix timestamp of next pending invoice item invoice | +| ↳ `on_behalf_of` | string | Account the subscription is made on behalf of | +| ↳ `pause_collection` | json | If paused, when collection is paused until | +| ↳ `payment_settings` | json | Payment settings for the subscription | +| ↳ `pending_invoice_item_interval` | json | Pending invoice item interval | +| ↳ `pending_setup_intent` | string | ID of the pending SetupIntent | +| ↳ `pending_update` | json | Pending subscription update | +| ↳ `schedule` | string | ID of the subscription schedule | +| ↳ `start_date` | number | Unix timestamp when the subscription started | +| ↳ `status` | string | Status of the subscription \(incomplete, incomplete_expired, trialing, active, past_due, canceled, unpaid, paused\) | +| ↳ `test_clock` | string | ID of the test clock | +| ↳ `transfer_data` | json | Data for creating transfers after payments succeed | +| ↳ `trial_end` | number | Unix timestamp when the trial ends | +| ↳ `trial_settings` | json | Settings related to subscription trials | +| ↳ `trial_start` | number | Unix timestamp when the trial started | | `metadata` | json | Subscription metadata including ID, status, and customer | -| ↳ `id` | string | Stripe unique identifier | -| ↳ `status` | string | Current state of the resource | -| ↳ `customer` | string | Associated customer ID | +| ↳ `id` | string | Stripe unique identifier | +| ↳ `status` | string | Current state of the resource | +| ↳ `customer` | string | Associated customer ID | ### `stripe_retrieve_subscription` @@ -404,11 +999,53 @@ Retrieve an existing subscription by ID | Parameter | Type | Description | | --------- | ---- | ----------- | -| `subscription` | json | The retrieved subscription object | +| `subscription` | object | The retrieved subscription object | +| ↳ `id` | string | Unique identifier for the subscription | +| ↳ `object` | string | String representing the object type \(subscription\) | +| ↳ `application` | string | ID of the Connect application that created the subscription | +| ↳ `application_fee_percent` | number | Application fee percent \(if any\) | +| ↳ `automatic_tax` | json | Automatic tax settings | +| ↳ `billing_cycle_anchor` | number | Unix timestamp determining when billing cycle starts | +| ↳ `billing_thresholds` | json | Billing thresholds for the subscription | +| ↳ `cancel_at` | number | Unix timestamp when the subscription will be canceled | +| ↳ `cancel_at_period_end` | boolean | Whether the subscription will be canceled at period end | +| ↳ `canceled_at` | number | Unix timestamp when the subscription was canceled | +| ↳ `cancellation_details` | json | Details about cancellation | +| ↳ `collection_method` | string | Collection method \(charge_automatically or send_invoice\) | +| ↳ `created` | number | Unix timestamp when the subscription was created | +| ↳ `currency` | string | Three-letter ISO currency code \(lowercase\) | +| ↳ `current_period_end` | number | Unix timestamp when the current period ends | +| ↳ `current_period_start` | number | Unix timestamp when the current period started | +| ↳ `customer` | string | ID of the customer who owns the subscription | +| ↳ `days_until_due` | number | Number of days a customer has to pay invoices | +| ↳ `default_payment_method` | string | ID of the default payment method | +| ↳ `default_source` | string | ID of the default source | +| ↳ `default_tax_rates` | array | Default tax rates | +| ↳ `description` | string | Subscription description \(max 500 characters\) | +| ↳ `discount` | json | Discount that applies to the subscription | +| ↳ `ended_at` | number | Unix timestamp when the subscription ended | +| ↳ `latest_invoice` | string | ID of the most recent invoice | +| ↳ `livemode` | boolean | Whether object exists in live mode or test mode | +| ↳ `metadata` | json | Set of key-value pairs for storing additional information | +| ↳ `next_pending_invoice_item_invoice` | number | Unix timestamp of next pending invoice item invoice | +| ↳ `on_behalf_of` | string | Account the subscription is made on behalf of | +| ↳ `pause_collection` | json | If paused, when collection is paused until | +| ↳ `payment_settings` | json | Payment settings for the subscription | +| ↳ `pending_invoice_item_interval` | json | Pending invoice item interval | +| ↳ `pending_setup_intent` | string | ID of the pending SetupIntent | +| ↳ `pending_update` | json | Pending subscription update | +| ↳ `schedule` | string | ID of the subscription schedule | +| ↳ `start_date` | number | Unix timestamp when the subscription started | +| ↳ `status` | string | Status of the subscription \(incomplete, incomplete_expired, trialing, active, past_due, canceled, unpaid, paused\) | +| ↳ `test_clock` | string | ID of the test clock | +| ↳ `transfer_data` | json | Data for creating transfers after payments succeed | +| ↳ `trial_end` | number | Unix timestamp when the trial ends | +| ↳ `trial_settings` | json | Settings related to subscription trials | +| ↳ `trial_start` | number | Unix timestamp when the trial started | | `metadata` | json | Subscription metadata including ID, status, and customer | -| ↳ `id` | string | Stripe unique identifier | -| ↳ `status` | string | Current state of the resource | -| ↳ `customer` | string | Associated customer ID | +| ↳ `id` | string | Stripe unique identifier | +| ↳ `status` | string | Current state of the resource | +| ↳ `customer` | string | Associated customer ID | ### `stripe_update_subscription` @@ -428,11 +1065,53 @@ Update an existing subscription | Parameter | Type | Description | | --------- | ---- | ----------- | -| `subscription` | json | The updated subscription object | +| `subscription` | object | The updated subscription object | +| ↳ `id` | string | Unique identifier for the subscription | +| ↳ `object` | string | String representing the object type \(subscription\) | +| ↳ `application` | string | ID of the Connect application that created the subscription | +| ↳ `application_fee_percent` | number | Application fee percent \(if any\) | +| ↳ `automatic_tax` | json | Automatic tax settings | +| ↳ `billing_cycle_anchor` | number | Unix timestamp determining when billing cycle starts | +| ↳ `billing_thresholds` | json | Billing thresholds for the subscription | +| ↳ `cancel_at` | number | Unix timestamp when the subscription will be canceled | +| ↳ `cancel_at_period_end` | boolean | Whether the subscription will be canceled at period end | +| ↳ `canceled_at` | number | Unix timestamp when the subscription was canceled | +| ↳ `cancellation_details` | json | Details about cancellation | +| ↳ `collection_method` | string | Collection method \(charge_automatically or send_invoice\) | +| ↳ `created` | number | Unix timestamp when the subscription was created | +| ↳ `currency` | string | Three-letter ISO currency code \(lowercase\) | +| ↳ `current_period_end` | number | Unix timestamp when the current period ends | +| ↳ `current_period_start` | number | Unix timestamp when the current period started | +| ↳ `customer` | string | ID of the customer who owns the subscription | +| ↳ `days_until_due` | number | Number of days a customer has to pay invoices | +| ↳ `default_payment_method` | string | ID of the default payment method | +| ↳ `default_source` | string | ID of the default source | +| ↳ `default_tax_rates` | array | Default tax rates | +| ↳ `description` | string | Subscription description \(max 500 characters\) | +| ↳ `discount` | json | Discount that applies to the subscription | +| ↳ `ended_at` | number | Unix timestamp when the subscription ended | +| ↳ `latest_invoice` | string | ID of the most recent invoice | +| ↳ `livemode` | boolean | Whether object exists in live mode or test mode | +| ↳ `metadata` | json | Set of key-value pairs for storing additional information | +| ↳ `next_pending_invoice_item_invoice` | number | Unix timestamp of next pending invoice item invoice | +| ↳ `on_behalf_of` | string | Account the subscription is made on behalf of | +| ↳ `pause_collection` | json | If paused, when collection is paused until | +| ↳ `payment_settings` | json | Payment settings for the subscription | +| ↳ `pending_invoice_item_interval` | json | Pending invoice item interval | +| ↳ `pending_setup_intent` | string | ID of the pending SetupIntent | +| ↳ `pending_update` | json | Pending subscription update | +| ↳ `schedule` | string | ID of the subscription schedule | +| ↳ `start_date` | number | Unix timestamp when the subscription started | +| ↳ `status` | string | Status of the subscription \(incomplete, incomplete_expired, trialing, active, past_due, canceled, unpaid, paused\) | +| ↳ `test_clock` | string | ID of the test clock | +| ↳ `transfer_data` | json | Data for creating transfers after payments succeed | +| ↳ `trial_end` | number | Unix timestamp when the trial ends | +| ↳ `trial_settings` | json | Settings related to subscription trials | +| ↳ `trial_start` | number | Unix timestamp when the trial started | | `metadata` | json | Subscription metadata including ID, status, and customer | -| ↳ `id` | string | Stripe unique identifier | -| ↳ `status` | string | Current state of the resource | -| ↳ `customer` | string | Associated customer ID | +| ↳ `id` | string | Stripe unique identifier | +| ↳ `status` | string | Current state of the resource | +| ↳ `customer` | string | Associated customer ID | ### `stripe_cancel_subscription` @@ -451,11 +1130,53 @@ Cancel a subscription | Parameter | Type | Description | | --------- | ---- | ----------- | -| `subscription` | json | The canceled subscription object | +| `subscription` | object | The canceled subscription object | +| ↳ `id` | string | Unique identifier for the subscription | +| ↳ `object` | string | String representing the object type \(subscription\) | +| ↳ `application` | string | ID of the Connect application that created the subscription | +| ↳ `application_fee_percent` | number | Application fee percent \(if any\) | +| ↳ `automatic_tax` | json | Automatic tax settings | +| ↳ `billing_cycle_anchor` | number | Unix timestamp determining when billing cycle starts | +| ↳ `billing_thresholds` | json | Billing thresholds for the subscription | +| ↳ `cancel_at` | number | Unix timestamp when the subscription will be canceled | +| ↳ `cancel_at_period_end` | boolean | Whether the subscription will be canceled at period end | +| ↳ `canceled_at` | number | Unix timestamp when the subscription was canceled | +| ↳ `cancellation_details` | json | Details about cancellation | +| ↳ `collection_method` | string | Collection method \(charge_automatically or send_invoice\) | +| ↳ `created` | number | Unix timestamp when the subscription was created | +| ↳ `currency` | string | Three-letter ISO currency code \(lowercase\) | +| ↳ `current_period_end` | number | Unix timestamp when the current period ends | +| ↳ `current_period_start` | number | Unix timestamp when the current period started | +| ↳ `customer` | string | ID of the customer who owns the subscription | +| ↳ `days_until_due` | number | Number of days a customer has to pay invoices | +| ↳ `default_payment_method` | string | ID of the default payment method | +| ↳ `default_source` | string | ID of the default source | +| ↳ `default_tax_rates` | array | Default tax rates | +| ↳ `description` | string | Subscription description \(max 500 characters\) | +| ↳ `discount` | json | Discount that applies to the subscription | +| ↳ `ended_at` | number | Unix timestamp when the subscription ended | +| ↳ `latest_invoice` | string | ID of the most recent invoice | +| ↳ `livemode` | boolean | Whether object exists in live mode or test mode | +| ↳ `metadata` | json | Set of key-value pairs for storing additional information | +| ↳ `next_pending_invoice_item_invoice` | number | Unix timestamp of next pending invoice item invoice | +| ↳ `on_behalf_of` | string | Account the subscription is made on behalf of | +| ↳ `pause_collection` | json | If paused, when collection is paused until | +| ↳ `payment_settings` | json | Payment settings for the subscription | +| ↳ `pending_invoice_item_interval` | json | Pending invoice item interval | +| ↳ `pending_setup_intent` | string | ID of the pending SetupIntent | +| ↳ `pending_update` | json | Pending subscription update | +| ↳ `schedule` | string | ID of the subscription schedule | +| ↳ `start_date` | number | Unix timestamp when the subscription started | +| ↳ `status` | string | Status of the subscription \(incomplete, incomplete_expired, trialing, active, past_due, canceled, unpaid, paused\) | +| ↳ `test_clock` | string | ID of the test clock | +| ↳ `transfer_data` | json | Data for creating transfers after payments succeed | +| ↳ `trial_end` | number | Unix timestamp when the trial ends | +| ↳ `trial_settings` | json | Settings related to subscription trials | +| ↳ `trial_start` | number | Unix timestamp when the trial started | | `metadata` | json | Subscription metadata including ID, status, and customer | -| ↳ `id` | string | Stripe unique identifier | -| ↳ `status` | string | Current state of the resource | -| ↳ `customer` | string | Associated customer ID | +| ↳ `id` | string | Stripe unique identifier | +| ↳ `status` | string | Current state of the resource | +| ↳ `customer` | string | Associated customer ID | ### `stripe_resume_subscription` @@ -472,11 +1193,53 @@ Resume a subscription that was scheduled for cancellation | Parameter | Type | Description | | --------- | ---- | ----------- | -| `subscription` | json | The resumed subscription object | +| `subscription` | object | The resumed subscription object | +| ↳ `id` | string | Unique identifier for the subscription | +| ↳ `object` | string | String representing the object type \(subscription\) | +| ↳ `application` | string | ID of the Connect application that created the subscription | +| ↳ `application_fee_percent` | number | Application fee percent \(if any\) | +| ↳ `automatic_tax` | json | Automatic tax settings | +| ↳ `billing_cycle_anchor` | number | Unix timestamp determining when billing cycle starts | +| ↳ `billing_thresholds` | json | Billing thresholds for the subscription | +| ↳ `cancel_at` | number | Unix timestamp when the subscription will be canceled | +| ↳ `cancel_at_period_end` | boolean | Whether the subscription will be canceled at period end | +| ↳ `canceled_at` | number | Unix timestamp when the subscription was canceled | +| ↳ `cancellation_details` | json | Details about cancellation | +| ↳ `collection_method` | string | Collection method \(charge_automatically or send_invoice\) | +| ↳ `created` | number | Unix timestamp when the subscription was created | +| ↳ `currency` | string | Three-letter ISO currency code \(lowercase\) | +| ↳ `current_period_end` | number | Unix timestamp when the current period ends | +| ↳ `current_period_start` | number | Unix timestamp when the current period started | +| ↳ `customer` | string | ID of the customer who owns the subscription | +| ↳ `days_until_due` | number | Number of days a customer has to pay invoices | +| ↳ `default_payment_method` | string | ID of the default payment method | +| ↳ `default_source` | string | ID of the default source | +| ↳ `default_tax_rates` | array | Default tax rates | +| ↳ `description` | string | Subscription description \(max 500 characters\) | +| ↳ `discount` | json | Discount that applies to the subscription | +| ↳ `ended_at` | number | Unix timestamp when the subscription ended | +| ↳ `latest_invoice` | string | ID of the most recent invoice | +| ↳ `livemode` | boolean | Whether object exists in live mode or test mode | +| ↳ `metadata` | json | Set of key-value pairs for storing additional information | +| ↳ `next_pending_invoice_item_invoice` | number | Unix timestamp of next pending invoice item invoice | +| ↳ `on_behalf_of` | string | Account the subscription is made on behalf of | +| ↳ `pause_collection` | json | If paused, when collection is paused until | +| ↳ `payment_settings` | json | Payment settings for the subscription | +| ↳ `pending_invoice_item_interval` | json | Pending invoice item interval | +| ↳ `pending_setup_intent` | string | ID of the pending SetupIntent | +| ↳ `pending_update` | json | Pending subscription update | +| ↳ `schedule` | string | ID of the subscription schedule | +| ↳ `start_date` | number | Unix timestamp when the subscription started | +| ↳ `status` | string | Status of the subscription \(incomplete, incomplete_expired, trialing, active, past_due, canceled, unpaid, paused\) | +| ↳ `test_clock` | string | ID of the test clock | +| ↳ `transfer_data` | json | Data for creating transfers after payments succeed | +| ↳ `trial_end` | number | Unix timestamp when the trial ends | +| ↳ `trial_settings` | json | Settings related to subscription trials | +| ↳ `trial_start` | number | Unix timestamp when the trial started | | `metadata` | json | Subscription metadata including ID, status, and customer | -| ↳ `id` | string | Stripe unique identifier | -| ↳ `status` | string | Current state of the resource | -| ↳ `customer` | string | Associated customer ID | +| ↳ `id` | string | Stripe unique identifier | +| ↳ `status` | string | Current state of the resource | +| ↳ `customer` | string | Associated customer ID | ### `stripe_list_subscriptions` @@ -496,10 +1259,52 @@ List all subscriptions | Parameter | Type | Description | | --------- | ---- | ----------- | -| `subscriptions` | json | Array of subscription objects | +| `subscriptions` | array | Array of subscription objects | +| ↳ `id` | string | Unique identifier for the subscription | +| ↳ `object` | string | String representing the object type \(subscription\) | +| ↳ `application` | string | ID of the Connect application that created the subscription | +| ↳ `application_fee_percent` | number | Application fee percent \(if any\) | +| ↳ `automatic_tax` | json | Automatic tax settings | +| ↳ `billing_cycle_anchor` | number | Unix timestamp determining when billing cycle starts | +| ↳ `billing_thresholds` | json | Billing thresholds for the subscription | +| ↳ `cancel_at` | number | Unix timestamp when the subscription will be canceled | +| ↳ `cancel_at_period_end` | boolean | Whether the subscription will be canceled at period end | +| ↳ `canceled_at` | number | Unix timestamp when the subscription was canceled | +| ↳ `cancellation_details` | json | Details about cancellation | +| ↳ `collection_method` | string | Collection method \(charge_automatically or send_invoice\) | +| ↳ `created` | number | Unix timestamp when the subscription was created | +| ↳ `currency` | string | Three-letter ISO currency code \(lowercase\) | +| ↳ `current_period_end` | number | Unix timestamp when the current period ends | +| ↳ `current_period_start` | number | Unix timestamp when the current period started | +| ↳ `customer` | string | ID of the customer who owns the subscription | +| ↳ `days_until_due` | number | Number of days a customer has to pay invoices | +| ↳ `default_payment_method` | string | ID of the default payment method | +| ↳ `default_source` | string | ID of the default source | +| ↳ `default_tax_rates` | array | Default tax rates | +| ↳ `description` | string | Subscription description \(max 500 characters\) | +| ↳ `discount` | json | Discount that applies to the subscription | +| ↳ `ended_at` | number | Unix timestamp when the subscription ended | +| ↳ `latest_invoice` | string | ID of the most recent invoice | +| ↳ `livemode` | boolean | Whether object exists in live mode or test mode | +| ↳ `metadata` | json | Set of key-value pairs for storing additional information | +| ↳ `next_pending_invoice_item_invoice` | number | Unix timestamp of next pending invoice item invoice | +| ↳ `on_behalf_of` | string | Account the subscription is made on behalf of | +| ↳ `pause_collection` | json | If paused, when collection is paused until | +| ↳ `payment_settings` | json | Payment settings for the subscription | +| ↳ `pending_invoice_item_interval` | json | Pending invoice item interval | +| ↳ `pending_setup_intent` | string | ID of the pending SetupIntent | +| ↳ `pending_update` | json | Pending subscription update | +| ↳ `schedule` | string | ID of the subscription schedule | +| ↳ `start_date` | number | Unix timestamp when the subscription started | +| ↳ `status` | string | Status of the subscription \(incomplete, incomplete_expired, trialing, active, past_due, canceled, unpaid, paused\) | +| ↳ `test_clock` | string | ID of the test clock | +| ↳ `transfer_data` | json | Data for creating transfers after payments succeed | +| ↳ `trial_end` | number | Unix timestamp when the trial ends | +| ↳ `trial_settings` | json | Settings related to subscription trials | +| ↳ `trial_start` | number | Unix timestamp when the trial started | | `metadata` | json | List metadata | -| ↳ `count` | number | Number of items returned | -| ↳ `has_more` | boolean | Whether more items exist beyond this page | +| ↳ `count` | number | Number of items returned | +| ↳ `has_more` | boolean | Whether more items exist beyond this page | ### `stripe_search_subscriptions` @@ -517,10 +1322,52 @@ Search for subscriptions using query syntax | Parameter | Type | Description | | --------- | ---- | ----------- | -| `subscriptions` | json | Array of matching subscription objects | +| `subscriptions` | array | Array of matching subscription objects | +| ↳ `id` | string | Unique identifier for the subscription | +| ↳ `object` | string | String representing the object type \(subscription\) | +| ↳ `application` | string | ID of the Connect application that created the subscription | +| ↳ `application_fee_percent` | number | Application fee percent \(if any\) | +| ↳ `automatic_tax` | json | Automatic tax settings | +| ↳ `billing_cycle_anchor` | number | Unix timestamp determining when billing cycle starts | +| ↳ `billing_thresholds` | json | Billing thresholds for the subscription | +| ↳ `cancel_at` | number | Unix timestamp when the subscription will be canceled | +| ↳ `cancel_at_period_end` | boolean | Whether the subscription will be canceled at period end | +| ↳ `canceled_at` | number | Unix timestamp when the subscription was canceled | +| ↳ `cancellation_details` | json | Details about cancellation | +| ↳ `collection_method` | string | Collection method \(charge_automatically or send_invoice\) | +| ↳ `created` | number | Unix timestamp when the subscription was created | +| ↳ `currency` | string | Three-letter ISO currency code \(lowercase\) | +| ↳ `current_period_end` | number | Unix timestamp when the current period ends | +| ↳ `current_period_start` | number | Unix timestamp when the current period started | +| ↳ `customer` | string | ID of the customer who owns the subscription | +| ↳ `days_until_due` | number | Number of days a customer has to pay invoices | +| ↳ `default_payment_method` | string | ID of the default payment method | +| ↳ `default_source` | string | ID of the default source | +| ↳ `default_tax_rates` | array | Default tax rates | +| ↳ `description` | string | Subscription description \(max 500 characters\) | +| ↳ `discount` | json | Discount that applies to the subscription | +| ↳ `ended_at` | number | Unix timestamp when the subscription ended | +| ↳ `latest_invoice` | string | ID of the most recent invoice | +| ↳ `livemode` | boolean | Whether object exists in live mode or test mode | +| ↳ `metadata` | json | Set of key-value pairs for storing additional information | +| ↳ `next_pending_invoice_item_invoice` | number | Unix timestamp of next pending invoice item invoice | +| ↳ `on_behalf_of` | string | Account the subscription is made on behalf of | +| ↳ `pause_collection` | json | If paused, when collection is paused until | +| ↳ `payment_settings` | json | Payment settings for the subscription | +| ↳ `pending_invoice_item_interval` | json | Pending invoice item interval | +| ↳ `pending_setup_intent` | string | ID of the pending SetupIntent | +| ↳ `pending_update` | json | Pending subscription update | +| ↳ `schedule` | string | ID of the subscription schedule | +| ↳ `start_date` | number | Unix timestamp when the subscription started | +| ↳ `status` | string | Status of the subscription \(incomplete, incomplete_expired, trialing, active, past_due, canceled, unpaid, paused\) | +| ↳ `test_clock` | string | ID of the test clock | +| ↳ `transfer_data` | json | Data for creating transfers after payments succeed | +| ↳ `trial_end` | number | Unix timestamp when the trial ends | +| ↳ `trial_settings` | json | Settings related to subscription trials | +| ↳ `trial_start` | number | Unix timestamp when the trial started | | `metadata` | json | Search metadata | -| ↳ `count` | number | Number of items returned | -| ↳ `has_more` | boolean | Whether more items exist beyond this page | +| ↳ `count` | number | Number of items returned | +| ↳ `has_more` | boolean | Whether more items exist beyond this page | ### `stripe_create_invoice` @@ -541,12 +1388,142 @@ Create a new invoice | Parameter | Type | Description | | --------- | ---- | ----------- | -| `invoice` | json | The created invoice object | +| `invoice` | object | The created invoice object | +| ↳ `id` | string | Unique identifier for the invoice | +| ↳ `object` | string | String representing the object type \(invoice\) | +| ↳ `account_country` | string | Country of the business associated with this invoice | +| ↳ `account_name` | string | Name of the account associated with this invoice | +| ↳ `account_tax_ids` | array | Account tax IDs | +| ↳ `amount_due` | number | Final amount due in smallest currency unit | +| ↳ `amount_paid` | number | Amount paid in smallest currency unit | +| ↳ `amount_remaining` | number | Amount remaining in smallest currency unit | +| ↳ `amount_shipping` | number | Shipping amount in smallest currency unit | +| ↳ `application` | string | ID of the Connect application that created the invoice | +| ↳ `application_fee_amount` | number | Application fee amount | +| ↳ `attempt_count` | number | Number of payment attempts made | +| ↳ `attempted` | boolean | Whether an attempt has been made to pay the invoice | +| ↳ `auto_advance` | boolean | Controls whether Stripe performs automatic collection | +| ↳ `automatic_tax` | json | Settings and results for automatic tax lookup | +| ↳ `billing_reason` | string | Reason the invoice was created | +| ↳ `charge` | string | ID of the latest charge for this invoice | +| ↳ `collection_method` | string | Collection method \(charge_automatically or send_invoice\) | +| ↳ `created` | number | Unix timestamp when the invoice was created | +| ↳ `currency` | string | Three-letter ISO currency code \(lowercase\) | +| ↳ `custom_fields` | array | Custom fields displayed on the invoice | +| ↳ `customer` | string | ID of the customer who will be billed | +| ↳ `customer_address` | object | Address object | +| ↳ `line1` | string | Address line 1 \(street address\) | +| ↳ `line2` | string | Address line 2 \(apartment, suite, etc.\) | +| ↳ `city` | string | City name | +| ↳ `state` | string | State, county, province, or region | +| ↳ `postal_code` | string | ZIP or postal code | +| ↳ `country` | string | Two-letter country code \(ISO 3166-1 alpha-2\) | +| ↳ `customer_email` | string | Email of the customer | +| ↳ `customer_name` | string | Name of the customer | +| ↳ `customer_phone` | string | Phone number of the customer | +| ↳ `customer_shipping` | object | Shipping information | +| ↳ `name` | string | Recipient name | +| ↳ `phone` | string | Recipient phone number | +| ↳ `address` | object | Address object | +| ↳ `line1` | string | Address line 1 \(street address\) | +| ↳ `line2` | string | Address line 2 \(apartment, suite, etc.\) | +| ↳ `city` | string | City name | +| ↳ `state` | string | State, county, province, or region | +| ↳ `postal_code` | string | ZIP or postal code | +| ↳ `country` | string | Two-letter country code \(ISO 3166-1 alpha-2\) | +| ↳ `customer_tax_exempt` | string | Tax exemption status of the customer | +| ↳ `customer_tax_ids` | array | Customer tax IDs | +| ↳ `default_payment_method` | string | ID of the default payment method | +| ↳ `default_source` | string | ID of the default source | +| ↳ `default_tax_rates` | array | Default tax rates | +| ↳ `description` | string | Description displayed in Dashboard \(memo\) | +| ↳ `discount` | json | Discount applied to the invoice | +| ↳ `discounts` | array | Discounts applied to the invoice | +| ↳ `due_date` | number | Unix timestamp when payment is due | +| ↳ `effective_at` | number | When the invoice was effective | +| ↳ `ending_balance` | number | Ending customer balance after invoice is finalized | +| ↳ `footer` | string | Footer displayed on the invoice | +| ↳ `from_invoice` | json | Details of the invoice that this invoice was created from | +| ↳ `hosted_invoice_url` | string | URL for the hosted invoice page | +| ↳ `invoice_pdf` | string | URL for the invoice PDF | +| ↳ `issuer` | json | The connected account that issues the invoice | +| ↳ `last_finalization_error` | json | Error encountered during finalization | +| ↳ `latest_revision` | string | ID of the most recent revision | +| ↳ `lines` | object | Invoice line items | +| ↳ `id` | string | Unique identifier for the line item | +| ↳ `object` | string | String representing the object type \(line_item\) | +| ↳ `amount` | number | Amount in smallest currency unit | +| ↳ `amount_excluding_tax` | number | Amount excluding tax | +| ↳ `currency` | string | Three-letter ISO currency code \(lowercase\) | +| ↳ `description` | string | Description of the line item | +| ↳ `discount_amounts` | array | Discount amounts applied | +| ↳ `discountable` | boolean | Whether the line item is discountable | +| ↳ `discounts` | array | Discounts applied to the line item | +| ↳ `invoice` | string | ID of the invoice that contains this line item | +| ↳ `livemode` | boolean | Whether object exists in live mode or test mode | +| ↳ `metadata` | json | Set of key-value pairs for storing additional information | +| ↳ `period` | json | Period this line item covers | +| ↳ `price` | json | Price object for this line item | +| ↳ `proration` | boolean | Whether this is a proration | +| ↳ `proration_details` | json | Additional details for proration line items | +| ↳ `quantity` | number | Quantity of the item | +| ↳ `subscription` | string | ID of the subscription | +| ↳ `subscription_item` | string | ID of the subscription item | +| ↳ `tax_amounts` | array | Tax amounts for this line item | +| ↳ `tax_rates` | array | Tax rates applied | +| ↳ `type` | string | Type of line item \(invoiceitem or subscription\) | +| ↳ `unit_amount_excluding_tax` | string | Unit amount excluding tax | +| ↳ `livemode` | boolean | Whether object exists in live mode or test mode | +| ↳ `metadata` | json | Set of key-value pairs for storing additional information | +| ↳ `next_payment_attempt` | number | Unix timestamp of next payment attempt | +| ↳ `number` | string | Human-readable invoice number | +| ↳ `on_behalf_of` | string | Account on behalf of which the invoice was issued | +| ↳ `paid` | boolean | Whether payment was successfully collected | +| ↳ `paid_out_of_band` | boolean | Whether the invoice was paid out of band | +| ↳ `payment_intent` | string | ID of the PaymentIntent associated with the invoice | +| ↳ `payment_settings` | json | Configuration settings for payment collection | +| ↳ `period_end` | number | End of the usage period | +| ↳ `period_start` | number | Start of the usage period | +| ↳ `post_payment_credit_notes_amount` | number | Total of all post-payment credit notes | +| ↳ `pre_payment_credit_notes_amount` | number | Total of all pre-payment credit notes | +| ↳ `quote` | string | ID of the quote this invoice was generated from | +| ↳ `receipt_number` | string | Receipt number for the invoice | +| ↳ `rendering` | json | Invoice rendering options | +| ↳ `rendering_options` | json | Invoice rendering options \(deprecated\) | +| ↳ `shipping_cost` | json | Shipping cost information | +| ↳ `shipping_details` | object | Shipping information | +| ↳ `name` | string | Recipient name | +| ↳ `phone` | string | Recipient phone number | +| ↳ `address` | object | Address object | +| ↳ `line1` | string | Address line 1 \(street address\) | +| ↳ `line2` | string | Address line 2 \(apartment, suite, etc.\) | +| ↳ `city` | string | City name | +| ↳ `state` | string | State, county, province, or region | +| ↳ `postal_code` | string | ZIP or postal code | +| ↳ `country` | string | Two-letter country code \(ISO 3166-1 alpha-2\) | +| ↳ `starting_balance` | number | Starting customer balance before invoice | +| ↳ `statement_descriptor` | string | Statement descriptor | +| ↳ `status` | string | Status of the invoice \(draft, open, paid, uncollectible, void\) | +| ↳ `status_transitions` | json | Timestamps at which the invoice status was updated | +| ↳ `subscription` | string | ID of the subscription for this invoice | +| ↳ `subscription_details` | json | Details about the subscription | +| ↳ `subscription_proration_date` | number | Only set for upcoming invoices with proration | +| ↳ `subtotal` | number | Total before discounts and taxes | +| ↳ `subtotal_excluding_tax` | number | Subtotal excluding tax | +| ↳ `tax` | number | Total tax amount | +| ↳ `test_clock` | string | ID of the test clock | +| ↳ `threshold_reason` | json | Details about why the invoice was created | +| ↳ `total` | number | Total after discounts and taxes | +| ↳ `total_discount_amounts` | array | Total discount amounts | +| ↳ `total_excluding_tax` | number | Total excluding tax | +| ↳ `total_tax_amounts` | array | Total tax amounts | +| ↳ `transfer_data` | json | Data for creating transfers | +| ↳ `webhooks_delivered_at` | number | Unix timestamp of webhooks delivery | | `metadata` | json | Invoice metadata | -| ↳ `id` | string | Stripe unique identifier | -| ↳ `status` | string | Current state of the resource | -| ↳ `amount_due` | number | Amount remaining to be paid in smallest currency unit | -| ↳ `currency` | string | Three-letter ISO currency code \(lowercase\) | +| ↳ `id` | string | Stripe unique identifier | +| ↳ `status` | string | Current state of the resource | +| ↳ `amount_due` | number | Amount remaining to be paid in smallest currency unit | +| ↳ `currency` | string | Three-letter ISO currency code \(lowercase\) | ### `stripe_retrieve_invoice` @@ -563,12 +1540,142 @@ Retrieve an existing invoice by ID | Parameter | Type | Description | | --------- | ---- | ----------- | -| `invoice` | json | The retrieved invoice object | +| `invoice` | object | The retrieved invoice object | +| ↳ `id` | string | Unique identifier for the invoice | +| ↳ `object` | string | String representing the object type \(invoice\) | +| ↳ `account_country` | string | Country of the business associated with this invoice | +| ↳ `account_name` | string | Name of the account associated with this invoice | +| ↳ `account_tax_ids` | array | Account tax IDs | +| ↳ `amount_due` | number | Final amount due in smallest currency unit | +| ↳ `amount_paid` | number | Amount paid in smallest currency unit | +| ↳ `amount_remaining` | number | Amount remaining in smallest currency unit | +| ↳ `amount_shipping` | number | Shipping amount in smallest currency unit | +| ↳ `application` | string | ID of the Connect application that created the invoice | +| ↳ `application_fee_amount` | number | Application fee amount | +| ↳ `attempt_count` | number | Number of payment attempts made | +| ↳ `attempted` | boolean | Whether an attempt has been made to pay the invoice | +| ↳ `auto_advance` | boolean | Controls whether Stripe performs automatic collection | +| ↳ `automatic_tax` | json | Settings and results for automatic tax lookup | +| ↳ `billing_reason` | string | Reason the invoice was created | +| ↳ `charge` | string | ID of the latest charge for this invoice | +| ↳ `collection_method` | string | Collection method \(charge_automatically or send_invoice\) | +| ↳ `created` | number | Unix timestamp when the invoice was created | +| ↳ `currency` | string | Three-letter ISO currency code \(lowercase\) | +| ↳ `custom_fields` | array | Custom fields displayed on the invoice | +| ↳ `customer` | string | ID of the customer who will be billed | +| ↳ `customer_address` | object | Address object | +| ↳ `line1` | string | Address line 1 \(street address\) | +| ↳ `line2` | string | Address line 2 \(apartment, suite, etc.\) | +| ↳ `city` | string | City name | +| ↳ `state` | string | State, county, province, or region | +| ↳ `postal_code` | string | ZIP or postal code | +| ↳ `country` | string | Two-letter country code \(ISO 3166-1 alpha-2\) | +| ↳ `customer_email` | string | Email of the customer | +| ↳ `customer_name` | string | Name of the customer | +| ↳ `customer_phone` | string | Phone number of the customer | +| ↳ `customer_shipping` | object | Shipping information | +| ↳ `name` | string | Recipient name | +| ↳ `phone` | string | Recipient phone number | +| ↳ `address` | object | Address object | +| ↳ `line1` | string | Address line 1 \(street address\) | +| ↳ `line2` | string | Address line 2 \(apartment, suite, etc.\) | +| ↳ `city` | string | City name | +| ↳ `state` | string | State, county, province, or region | +| ↳ `postal_code` | string | ZIP or postal code | +| ↳ `country` | string | Two-letter country code \(ISO 3166-1 alpha-2\) | +| ↳ `customer_tax_exempt` | string | Tax exemption status of the customer | +| ↳ `customer_tax_ids` | array | Customer tax IDs | +| ↳ `default_payment_method` | string | ID of the default payment method | +| ↳ `default_source` | string | ID of the default source | +| ↳ `default_tax_rates` | array | Default tax rates | +| ↳ `description` | string | Description displayed in Dashboard \(memo\) | +| ↳ `discount` | json | Discount applied to the invoice | +| ↳ `discounts` | array | Discounts applied to the invoice | +| ↳ `due_date` | number | Unix timestamp when payment is due | +| ↳ `effective_at` | number | When the invoice was effective | +| ↳ `ending_balance` | number | Ending customer balance after invoice is finalized | +| ↳ `footer` | string | Footer displayed on the invoice | +| ↳ `from_invoice` | json | Details of the invoice that this invoice was created from | +| ↳ `hosted_invoice_url` | string | URL for the hosted invoice page | +| ↳ `invoice_pdf` | string | URL for the invoice PDF | +| ↳ `issuer` | json | The connected account that issues the invoice | +| ↳ `last_finalization_error` | json | Error encountered during finalization | +| ↳ `latest_revision` | string | ID of the most recent revision | +| ↳ `lines` | object | Invoice line items | +| ↳ `id` | string | Unique identifier for the line item | +| ↳ `object` | string | String representing the object type \(line_item\) | +| ↳ `amount` | number | Amount in smallest currency unit | +| ↳ `amount_excluding_tax` | number | Amount excluding tax | +| ↳ `currency` | string | Three-letter ISO currency code \(lowercase\) | +| ↳ `description` | string | Description of the line item | +| ↳ `discount_amounts` | array | Discount amounts applied | +| ↳ `discountable` | boolean | Whether the line item is discountable | +| ↳ `discounts` | array | Discounts applied to the line item | +| ↳ `invoice` | string | ID of the invoice that contains this line item | +| ↳ `livemode` | boolean | Whether object exists in live mode or test mode | +| ↳ `metadata` | json | Set of key-value pairs for storing additional information | +| ↳ `period` | json | Period this line item covers | +| ↳ `price` | json | Price object for this line item | +| ↳ `proration` | boolean | Whether this is a proration | +| ↳ `proration_details` | json | Additional details for proration line items | +| ↳ `quantity` | number | Quantity of the item | +| ↳ `subscription` | string | ID of the subscription | +| ↳ `subscription_item` | string | ID of the subscription item | +| ↳ `tax_amounts` | array | Tax amounts for this line item | +| ↳ `tax_rates` | array | Tax rates applied | +| ↳ `type` | string | Type of line item \(invoiceitem or subscription\) | +| ↳ `unit_amount_excluding_tax` | string | Unit amount excluding tax | +| ↳ `livemode` | boolean | Whether object exists in live mode or test mode | +| ↳ `metadata` | json | Set of key-value pairs for storing additional information | +| ↳ `next_payment_attempt` | number | Unix timestamp of next payment attempt | +| ↳ `number` | string | Human-readable invoice number | +| ↳ `on_behalf_of` | string | Account on behalf of which the invoice was issued | +| ↳ `paid` | boolean | Whether payment was successfully collected | +| ↳ `paid_out_of_band` | boolean | Whether the invoice was paid out of band | +| ↳ `payment_intent` | string | ID of the PaymentIntent associated with the invoice | +| ↳ `payment_settings` | json | Configuration settings for payment collection | +| ↳ `period_end` | number | End of the usage period | +| ↳ `period_start` | number | Start of the usage period | +| ↳ `post_payment_credit_notes_amount` | number | Total of all post-payment credit notes | +| ↳ `pre_payment_credit_notes_amount` | number | Total of all pre-payment credit notes | +| ↳ `quote` | string | ID of the quote this invoice was generated from | +| ↳ `receipt_number` | string | Receipt number for the invoice | +| ↳ `rendering` | json | Invoice rendering options | +| ↳ `rendering_options` | json | Invoice rendering options \(deprecated\) | +| ↳ `shipping_cost` | json | Shipping cost information | +| ↳ `shipping_details` | object | Shipping information | +| ↳ `name` | string | Recipient name | +| ↳ `phone` | string | Recipient phone number | +| ↳ `address` | object | Address object | +| ↳ `line1` | string | Address line 1 \(street address\) | +| ↳ `line2` | string | Address line 2 \(apartment, suite, etc.\) | +| ↳ `city` | string | City name | +| ↳ `state` | string | State, county, province, or region | +| ↳ `postal_code` | string | ZIP or postal code | +| ↳ `country` | string | Two-letter country code \(ISO 3166-1 alpha-2\) | +| ↳ `starting_balance` | number | Starting customer balance before invoice | +| ↳ `statement_descriptor` | string | Statement descriptor | +| ↳ `status` | string | Status of the invoice \(draft, open, paid, uncollectible, void\) | +| ↳ `status_transitions` | json | Timestamps at which the invoice status was updated | +| ↳ `subscription` | string | ID of the subscription for this invoice | +| ↳ `subscription_details` | json | Details about the subscription | +| ↳ `subscription_proration_date` | number | Only set for upcoming invoices with proration | +| ↳ `subtotal` | number | Total before discounts and taxes | +| ↳ `subtotal_excluding_tax` | number | Subtotal excluding tax | +| ↳ `tax` | number | Total tax amount | +| ↳ `test_clock` | string | ID of the test clock | +| ↳ `threshold_reason` | json | Details about why the invoice was created | +| ↳ `total` | number | Total after discounts and taxes | +| ↳ `total_discount_amounts` | array | Total discount amounts | +| ↳ `total_excluding_tax` | number | Total excluding tax | +| ↳ `total_tax_amounts` | array | Total tax amounts | +| ↳ `transfer_data` | json | Data for creating transfers | +| ↳ `webhooks_delivered_at` | number | Unix timestamp of webhooks delivery | | `metadata` | json | Invoice metadata | -| ↳ `id` | string | Stripe unique identifier | -| ↳ `status` | string | Current state of the resource | -| ↳ `amount_due` | number | Amount remaining to be paid in smallest currency unit | -| ↳ `currency` | string | Three-letter ISO currency code \(lowercase\) | +| ↳ `id` | string | Stripe unique identifier | +| ↳ `status` | string | Current state of the resource | +| ↳ `amount_due` | number | Amount remaining to be paid in smallest currency unit | +| ↳ `currency` | string | Three-letter ISO currency code \(lowercase\) | ### `stripe_update_invoice` @@ -588,12 +1695,142 @@ Update an existing invoice | Parameter | Type | Description | | --------- | ---- | ----------- | -| `invoice` | json | The updated invoice object | +| `invoice` | object | The updated invoice object | +| ↳ `id` | string | Unique identifier for the invoice | +| ↳ `object` | string | String representing the object type \(invoice\) | +| ↳ `account_country` | string | Country of the business associated with this invoice | +| ↳ `account_name` | string | Name of the account associated with this invoice | +| ↳ `account_tax_ids` | array | Account tax IDs | +| ↳ `amount_due` | number | Final amount due in smallest currency unit | +| ↳ `amount_paid` | number | Amount paid in smallest currency unit | +| ↳ `amount_remaining` | number | Amount remaining in smallest currency unit | +| ↳ `amount_shipping` | number | Shipping amount in smallest currency unit | +| ↳ `application` | string | ID of the Connect application that created the invoice | +| ↳ `application_fee_amount` | number | Application fee amount | +| ↳ `attempt_count` | number | Number of payment attempts made | +| ↳ `attempted` | boolean | Whether an attempt has been made to pay the invoice | +| ↳ `auto_advance` | boolean | Controls whether Stripe performs automatic collection | +| ↳ `automatic_tax` | json | Settings and results for automatic tax lookup | +| ↳ `billing_reason` | string | Reason the invoice was created | +| ↳ `charge` | string | ID of the latest charge for this invoice | +| ↳ `collection_method` | string | Collection method \(charge_automatically or send_invoice\) | +| ↳ `created` | number | Unix timestamp when the invoice was created | +| ↳ `currency` | string | Three-letter ISO currency code \(lowercase\) | +| ↳ `custom_fields` | array | Custom fields displayed on the invoice | +| ↳ `customer` | string | ID of the customer who will be billed | +| ↳ `customer_address` | object | Address object | +| ↳ `line1` | string | Address line 1 \(street address\) | +| ↳ `line2` | string | Address line 2 \(apartment, suite, etc.\) | +| ↳ `city` | string | City name | +| ↳ `state` | string | State, county, province, or region | +| ↳ `postal_code` | string | ZIP or postal code | +| ↳ `country` | string | Two-letter country code \(ISO 3166-1 alpha-2\) | +| ↳ `customer_email` | string | Email of the customer | +| ↳ `customer_name` | string | Name of the customer | +| ↳ `customer_phone` | string | Phone number of the customer | +| ↳ `customer_shipping` | object | Shipping information | +| ↳ `name` | string | Recipient name | +| ↳ `phone` | string | Recipient phone number | +| ↳ `address` | object | Address object | +| ↳ `line1` | string | Address line 1 \(street address\) | +| ↳ `line2` | string | Address line 2 \(apartment, suite, etc.\) | +| ↳ `city` | string | City name | +| ↳ `state` | string | State, county, province, or region | +| ↳ `postal_code` | string | ZIP or postal code | +| ↳ `country` | string | Two-letter country code \(ISO 3166-1 alpha-2\) | +| ↳ `customer_tax_exempt` | string | Tax exemption status of the customer | +| ↳ `customer_tax_ids` | array | Customer tax IDs | +| ↳ `default_payment_method` | string | ID of the default payment method | +| ↳ `default_source` | string | ID of the default source | +| ↳ `default_tax_rates` | array | Default tax rates | +| ↳ `description` | string | Description displayed in Dashboard \(memo\) | +| ↳ `discount` | json | Discount applied to the invoice | +| ↳ `discounts` | array | Discounts applied to the invoice | +| ↳ `due_date` | number | Unix timestamp when payment is due | +| ↳ `effective_at` | number | When the invoice was effective | +| ↳ `ending_balance` | number | Ending customer balance after invoice is finalized | +| ↳ `footer` | string | Footer displayed on the invoice | +| ↳ `from_invoice` | json | Details of the invoice that this invoice was created from | +| ↳ `hosted_invoice_url` | string | URL for the hosted invoice page | +| ↳ `invoice_pdf` | string | URL for the invoice PDF | +| ↳ `issuer` | json | The connected account that issues the invoice | +| ↳ `last_finalization_error` | json | Error encountered during finalization | +| ↳ `latest_revision` | string | ID of the most recent revision | +| ↳ `lines` | object | Invoice line items | +| ↳ `id` | string | Unique identifier for the line item | +| ↳ `object` | string | String representing the object type \(line_item\) | +| ↳ `amount` | number | Amount in smallest currency unit | +| ↳ `amount_excluding_tax` | number | Amount excluding tax | +| ↳ `currency` | string | Three-letter ISO currency code \(lowercase\) | +| ↳ `description` | string | Description of the line item | +| ↳ `discount_amounts` | array | Discount amounts applied | +| ↳ `discountable` | boolean | Whether the line item is discountable | +| ↳ `discounts` | array | Discounts applied to the line item | +| ↳ `invoice` | string | ID of the invoice that contains this line item | +| ↳ `livemode` | boolean | Whether object exists in live mode or test mode | +| ↳ `metadata` | json | Set of key-value pairs for storing additional information | +| ↳ `period` | json | Period this line item covers | +| ↳ `price` | json | Price object for this line item | +| ↳ `proration` | boolean | Whether this is a proration | +| ↳ `proration_details` | json | Additional details for proration line items | +| ↳ `quantity` | number | Quantity of the item | +| ↳ `subscription` | string | ID of the subscription | +| ↳ `subscription_item` | string | ID of the subscription item | +| ↳ `tax_amounts` | array | Tax amounts for this line item | +| ↳ `tax_rates` | array | Tax rates applied | +| ↳ `type` | string | Type of line item \(invoiceitem or subscription\) | +| ↳ `unit_amount_excluding_tax` | string | Unit amount excluding tax | +| ↳ `livemode` | boolean | Whether object exists in live mode or test mode | +| ↳ `metadata` | json | Set of key-value pairs for storing additional information | +| ↳ `next_payment_attempt` | number | Unix timestamp of next payment attempt | +| ↳ `number` | string | Human-readable invoice number | +| ↳ `on_behalf_of` | string | Account on behalf of which the invoice was issued | +| ↳ `paid` | boolean | Whether payment was successfully collected | +| ↳ `paid_out_of_band` | boolean | Whether the invoice was paid out of band | +| ↳ `payment_intent` | string | ID of the PaymentIntent associated with the invoice | +| ↳ `payment_settings` | json | Configuration settings for payment collection | +| ↳ `period_end` | number | End of the usage period | +| ↳ `period_start` | number | Start of the usage period | +| ↳ `post_payment_credit_notes_amount` | number | Total of all post-payment credit notes | +| ↳ `pre_payment_credit_notes_amount` | number | Total of all pre-payment credit notes | +| ↳ `quote` | string | ID of the quote this invoice was generated from | +| ↳ `receipt_number` | string | Receipt number for the invoice | +| ↳ `rendering` | json | Invoice rendering options | +| ↳ `rendering_options` | json | Invoice rendering options \(deprecated\) | +| ↳ `shipping_cost` | json | Shipping cost information | +| ↳ `shipping_details` | object | Shipping information | +| ↳ `name` | string | Recipient name | +| ↳ `phone` | string | Recipient phone number | +| ↳ `address` | object | Address object | +| ↳ `line1` | string | Address line 1 \(street address\) | +| ↳ `line2` | string | Address line 2 \(apartment, suite, etc.\) | +| ↳ `city` | string | City name | +| ↳ `state` | string | State, county, province, or region | +| ↳ `postal_code` | string | ZIP or postal code | +| ↳ `country` | string | Two-letter country code \(ISO 3166-1 alpha-2\) | +| ↳ `starting_balance` | number | Starting customer balance before invoice | +| ↳ `statement_descriptor` | string | Statement descriptor | +| ↳ `status` | string | Status of the invoice \(draft, open, paid, uncollectible, void\) | +| ↳ `status_transitions` | json | Timestamps at which the invoice status was updated | +| ↳ `subscription` | string | ID of the subscription for this invoice | +| ↳ `subscription_details` | json | Details about the subscription | +| ↳ `subscription_proration_date` | number | Only set for upcoming invoices with proration | +| ↳ `subtotal` | number | Total before discounts and taxes | +| ↳ `subtotal_excluding_tax` | number | Subtotal excluding tax | +| ↳ `tax` | number | Total tax amount | +| ↳ `test_clock` | string | ID of the test clock | +| ↳ `threshold_reason` | json | Details about why the invoice was created | +| ↳ `total` | number | Total after discounts and taxes | +| ↳ `total_discount_amounts` | array | Total discount amounts | +| ↳ `total_excluding_tax` | number | Total excluding tax | +| ↳ `total_tax_amounts` | array | Total tax amounts | +| ↳ `transfer_data` | json | Data for creating transfers | +| ↳ `webhooks_delivered_at` | number | Unix timestamp of webhooks delivery | | `metadata` | json | Invoice metadata | -| ↳ `id` | string | Stripe unique identifier | -| ↳ `status` | string | Current state of the resource | -| ↳ `amount_due` | number | Amount remaining to be paid in smallest currency unit | -| ↳ `currency` | string | Three-letter ISO currency code \(lowercase\) | +| ↳ `id` | string | Stripe unique identifier | +| ↳ `status` | string | Current state of the resource | +| ↳ `amount_due` | number | Amount remaining to be paid in smallest currency unit | +| ↳ `currency` | string | Three-letter ISO currency code \(lowercase\) | ### `stripe_delete_invoice` @@ -629,12 +1866,142 @@ Finalize a draft invoice | Parameter | Type | Description | | --------- | ---- | ----------- | -| `invoice` | json | The finalized invoice object | +| `invoice` | object | The finalized invoice object | +| ↳ `id` | string | Unique identifier for the invoice | +| ↳ `object` | string | String representing the object type \(invoice\) | +| ↳ `account_country` | string | Country of the business associated with this invoice | +| ↳ `account_name` | string | Name of the account associated with this invoice | +| ↳ `account_tax_ids` | array | Account tax IDs | +| ↳ `amount_due` | number | Final amount due in smallest currency unit | +| ↳ `amount_paid` | number | Amount paid in smallest currency unit | +| ↳ `amount_remaining` | number | Amount remaining in smallest currency unit | +| ↳ `amount_shipping` | number | Shipping amount in smallest currency unit | +| ↳ `application` | string | ID of the Connect application that created the invoice | +| ↳ `application_fee_amount` | number | Application fee amount | +| ↳ `attempt_count` | number | Number of payment attempts made | +| ↳ `attempted` | boolean | Whether an attempt has been made to pay the invoice | +| ↳ `auto_advance` | boolean | Controls whether Stripe performs automatic collection | +| ↳ `automatic_tax` | json | Settings and results for automatic tax lookup | +| ↳ `billing_reason` | string | Reason the invoice was created | +| ↳ `charge` | string | ID of the latest charge for this invoice | +| ↳ `collection_method` | string | Collection method \(charge_automatically or send_invoice\) | +| ↳ `created` | number | Unix timestamp when the invoice was created | +| ↳ `currency` | string | Three-letter ISO currency code \(lowercase\) | +| ↳ `custom_fields` | array | Custom fields displayed on the invoice | +| ↳ `customer` | string | ID of the customer who will be billed | +| ↳ `customer_address` | object | Address object | +| ↳ `line1` | string | Address line 1 \(street address\) | +| ↳ `line2` | string | Address line 2 \(apartment, suite, etc.\) | +| ↳ `city` | string | City name | +| ↳ `state` | string | State, county, province, or region | +| ↳ `postal_code` | string | ZIP or postal code | +| ↳ `country` | string | Two-letter country code \(ISO 3166-1 alpha-2\) | +| ↳ `customer_email` | string | Email of the customer | +| ↳ `customer_name` | string | Name of the customer | +| ↳ `customer_phone` | string | Phone number of the customer | +| ↳ `customer_shipping` | object | Shipping information | +| ↳ `name` | string | Recipient name | +| ↳ `phone` | string | Recipient phone number | +| ↳ `address` | object | Address object | +| ↳ `line1` | string | Address line 1 \(street address\) | +| ↳ `line2` | string | Address line 2 \(apartment, suite, etc.\) | +| ↳ `city` | string | City name | +| ↳ `state` | string | State, county, province, or region | +| ↳ `postal_code` | string | ZIP or postal code | +| ↳ `country` | string | Two-letter country code \(ISO 3166-1 alpha-2\) | +| ↳ `customer_tax_exempt` | string | Tax exemption status of the customer | +| ↳ `customer_tax_ids` | array | Customer tax IDs | +| ↳ `default_payment_method` | string | ID of the default payment method | +| ↳ `default_source` | string | ID of the default source | +| ↳ `default_tax_rates` | array | Default tax rates | +| ↳ `description` | string | Description displayed in Dashboard \(memo\) | +| ↳ `discount` | json | Discount applied to the invoice | +| ↳ `discounts` | array | Discounts applied to the invoice | +| ↳ `due_date` | number | Unix timestamp when payment is due | +| ↳ `effective_at` | number | When the invoice was effective | +| ↳ `ending_balance` | number | Ending customer balance after invoice is finalized | +| ↳ `footer` | string | Footer displayed on the invoice | +| ↳ `from_invoice` | json | Details of the invoice that this invoice was created from | +| ↳ `hosted_invoice_url` | string | URL for the hosted invoice page | +| ↳ `invoice_pdf` | string | URL for the invoice PDF | +| ↳ `issuer` | json | The connected account that issues the invoice | +| ↳ `last_finalization_error` | json | Error encountered during finalization | +| ↳ `latest_revision` | string | ID of the most recent revision | +| ↳ `lines` | object | Invoice line items | +| ↳ `id` | string | Unique identifier for the line item | +| ↳ `object` | string | String representing the object type \(line_item\) | +| ↳ `amount` | number | Amount in smallest currency unit | +| ↳ `amount_excluding_tax` | number | Amount excluding tax | +| ↳ `currency` | string | Three-letter ISO currency code \(lowercase\) | +| ↳ `description` | string | Description of the line item | +| ↳ `discount_amounts` | array | Discount amounts applied | +| ↳ `discountable` | boolean | Whether the line item is discountable | +| ↳ `discounts` | array | Discounts applied to the line item | +| ↳ `invoice` | string | ID of the invoice that contains this line item | +| ↳ `livemode` | boolean | Whether object exists in live mode or test mode | +| ↳ `metadata` | json | Set of key-value pairs for storing additional information | +| ↳ `period` | json | Period this line item covers | +| ↳ `price` | json | Price object for this line item | +| ↳ `proration` | boolean | Whether this is a proration | +| ↳ `proration_details` | json | Additional details for proration line items | +| ↳ `quantity` | number | Quantity of the item | +| ↳ `subscription` | string | ID of the subscription | +| ↳ `subscription_item` | string | ID of the subscription item | +| ↳ `tax_amounts` | array | Tax amounts for this line item | +| ↳ `tax_rates` | array | Tax rates applied | +| ↳ `type` | string | Type of line item \(invoiceitem or subscription\) | +| ↳ `unit_amount_excluding_tax` | string | Unit amount excluding tax | +| ↳ `livemode` | boolean | Whether object exists in live mode or test mode | +| ↳ `metadata` | json | Set of key-value pairs for storing additional information | +| ↳ `next_payment_attempt` | number | Unix timestamp of next payment attempt | +| ↳ `number` | string | Human-readable invoice number | +| ↳ `on_behalf_of` | string | Account on behalf of which the invoice was issued | +| ↳ `paid` | boolean | Whether payment was successfully collected | +| ↳ `paid_out_of_band` | boolean | Whether the invoice was paid out of band | +| ↳ `payment_intent` | string | ID of the PaymentIntent associated with the invoice | +| ↳ `payment_settings` | json | Configuration settings for payment collection | +| ↳ `period_end` | number | End of the usage period | +| ↳ `period_start` | number | Start of the usage period | +| ↳ `post_payment_credit_notes_amount` | number | Total of all post-payment credit notes | +| ↳ `pre_payment_credit_notes_amount` | number | Total of all pre-payment credit notes | +| ↳ `quote` | string | ID of the quote this invoice was generated from | +| ↳ `receipt_number` | string | Receipt number for the invoice | +| ↳ `rendering` | json | Invoice rendering options | +| ↳ `rendering_options` | json | Invoice rendering options \(deprecated\) | +| ↳ `shipping_cost` | json | Shipping cost information | +| ↳ `shipping_details` | object | Shipping information | +| ↳ `name` | string | Recipient name | +| ↳ `phone` | string | Recipient phone number | +| ↳ `address` | object | Address object | +| ↳ `line1` | string | Address line 1 \(street address\) | +| ↳ `line2` | string | Address line 2 \(apartment, suite, etc.\) | +| ↳ `city` | string | City name | +| ↳ `state` | string | State, county, province, or region | +| ↳ `postal_code` | string | ZIP or postal code | +| ↳ `country` | string | Two-letter country code \(ISO 3166-1 alpha-2\) | +| ↳ `starting_balance` | number | Starting customer balance before invoice | +| ↳ `statement_descriptor` | string | Statement descriptor | +| ↳ `status` | string | Status of the invoice \(draft, open, paid, uncollectible, void\) | +| ↳ `status_transitions` | json | Timestamps at which the invoice status was updated | +| ↳ `subscription` | string | ID of the subscription for this invoice | +| ↳ `subscription_details` | json | Details about the subscription | +| ↳ `subscription_proration_date` | number | Only set for upcoming invoices with proration | +| ↳ `subtotal` | number | Total before discounts and taxes | +| ↳ `subtotal_excluding_tax` | number | Subtotal excluding tax | +| ↳ `tax` | number | Total tax amount | +| ↳ `test_clock` | string | ID of the test clock | +| ↳ `threshold_reason` | json | Details about why the invoice was created | +| ↳ `total` | number | Total after discounts and taxes | +| ↳ `total_discount_amounts` | array | Total discount amounts | +| ↳ `total_excluding_tax` | number | Total excluding tax | +| ↳ `total_tax_amounts` | array | Total tax amounts | +| ↳ `transfer_data` | json | Data for creating transfers | +| ↳ `webhooks_delivered_at` | number | Unix timestamp of webhooks delivery | | `metadata` | json | Invoice metadata | -| ↳ `id` | string | Stripe unique identifier | -| ↳ `status` | string | Current state of the resource | -| ↳ `amount_due` | number | Amount remaining to be paid in smallest currency unit | -| ↳ `currency` | string | Three-letter ISO currency code \(lowercase\) | +| ↳ `id` | string | Stripe unique identifier | +| ↳ `status` | string | Current state of the resource | +| ↳ `amount_due` | number | Amount remaining to be paid in smallest currency unit | +| ↳ `currency` | string | Three-letter ISO currency code \(lowercase\) | ### `stripe_pay_invoice` @@ -652,12 +2019,142 @@ Pay an invoice | Parameter | Type | Description | | --------- | ---- | ----------- | -| `invoice` | json | The paid invoice object | +| `invoice` | object | The paid invoice object | +| ↳ `id` | string | Unique identifier for the invoice | +| ↳ `object` | string | String representing the object type \(invoice\) | +| ↳ `account_country` | string | Country of the business associated with this invoice | +| ↳ `account_name` | string | Name of the account associated with this invoice | +| ↳ `account_tax_ids` | array | Account tax IDs | +| ↳ `amount_due` | number | Final amount due in smallest currency unit | +| ↳ `amount_paid` | number | Amount paid in smallest currency unit | +| ↳ `amount_remaining` | number | Amount remaining in smallest currency unit | +| ↳ `amount_shipping` | number | Shipping amount in smallest currency unit | +| ↳ `application` | string | ID of the Connect application that created the invoice | +| ↳ `application_fee_amount` | number | Application fee amount | +| ↳ `attempt_count` | number | Number of payment attempts made | +| ↳ `attempted` | boolean | Whether an attempt has been made to pay the invoice | +| ↳ `auto_advance` | boolean | Controls whether Stripe performs automatic collection | +| ↳ `automatic_tax` | json | Settings and results for automatic tax lookup | +| ↳ `billing_reason` | string | Reason the invoice was created | +| ↳ `charge` | string | ID of the latest charge for this invoice | +| ↳ `collection_method` | string | Collection method \(charge_automatically or send_invoice\) | +| ↳ `created` | number | Unix timestamp when the invoice was created | +| ↳ `currency` | string | Three-letter ISO currency code \(lowercase\) | +| ↳ `custom_fields` | array | Custom fields displayed on the invoice | +| ↳ `customer` | string | ID of the customer who will be billed | +| ↳ `customer_address` | object | Address object | +| ↳ `line1` | string | Address line 1 \(street address\) | +| ↳ `line2` | string | Address line 2 \(apartment, suite, etc.\) | +| ↳ `city` | string | City name | +| ↳ `state` | string | State, county, province, or region | +| ↳ `postal_code` | string | ZIP or postal code | +| ↳ `country` | string | Two-letter country code \(ISO 3166-1 alpha-2\) | +| ↳ `customer_email` | string | Email of the customer | +| ↳ `customer_name` | string | Name of the customer | +| ↳ `customer_phone` | string | Phone number of the customer | +| ↳ `customer_shipping` | object | Shipping information | +| ↳ `name` | string | Recipient name | +| ↳ `phone` | string | Recipient phone number | +| ↳ `address` | object | Address object | +| ↳ `line1` | string | Address line 1 \(street address\) | +| ↳ `line2` | string | Address line 2 \(apartment, suite, etc.\) | +| ↳ `city` | string | City name | +| ↳ `state` | string | State, county, province, or region | +| ↳ `postal_code` | string | ZIP or postal code | +| ↳ `country` | string | Two-letter country code \(ISO 3166-1 alpha-2\) | +| ↳ `customer_tax_exempt` | string | Tax exemption status of the customer | +| ↳ `customer_tax_ids` | array | Customer tax IDs | +| ↳ `default_payment_method` | string | ID of the default payment method | +| ↳ `default_source` | string | ID of the default source | +| ↳ `default_tax_rates` | array | Default tax rates | +| ↳ `description` | string | Description displayed in Dashboard \(memo\) | +| ↳ `discount` | json | Discount applied to the invoice | +| ↳ `discounts` | array | Discounts applied to the invoice | +| ↳ `due_date` | number | Unix timestamp when payment is due | +| ↳ `effective_at` | number | When the invoice was effective | +| ↳ `ending_balance` | number | Ending customer balance after invoice is finalized | +| ↳ `footer` | string | Footer displayed on the invoice | +| ↳ `from_invoice` | json | Details of the invoice that this invoice was created from | +| ↳ `hosted_invoice_url` | string | URL for the hosted invoice page | +| ↳ `invoice_pdf` | string | URL for the invoice PDF | +| ↳ `issuer` | json | The connected account that issues the invoice | +| ↳ `last_finalization_error` | json | Error encountered during finalization | +| ↳ `latest_revision` | string | ID of the most recent revision | +| ↳ `lines` | object | Invoice line items | +| ↳ `id` | string | Unique identifier for the line item | +| ↳ `object` | string | String representing the object type \(line_item\) | +| ↳ `amount` | number | Amount in smallest currency unit | +| ↳ `amount_excluding_tax` | number | Amount excluding tax | +| ↳ `currency` | string | Three-letter ISO currency code \(lowercase\) | +| ↳ `description` | string | Description of the line item | +| ↳ `discount_amounts` | array | Discount amounts applied | +| ↳ `discountable` | boolean | Whether the line item is discountable | +| ↳ `discounts` | array | Discounts applied to the line item | +| ↳ `invoice` | string | ID of the invoice that contains this line item | +| ↳ `livemode` | boolean | Whether object exists in live mode or test mode | +| ↳ `metadata` | json | Set of key-value pairs for storing additional information | +| ↳ `period` | json | Period this line item covers | +| ↳ `price` | json | Price object for this line item | +| ↳ `proration` | boolean | Whether this is a proration | +| ↳ `proration_details` | json | Additional details for proration line items | +| ↳ `quantity` | number | Quantity of the item | +| ↳ `subscription` | string | ID of the subscription | +| ↳ `subscription_item` | string | ID of the subscription item | +| ↳ `tax_amounts` | array | Tax amounts for this line item | +| ↳ `tax_rates` | array | Tax rates applied | +| ↳ `type` | string | Type of line item \(invoiceitem or subscription\) | +| ↳ `unit_amount_excluding_tax` | string | Unit amount excluding tax | +| ↳ `livemode` | boolean | Whether object exists in live mode or test mode | +| ↳ `metadata` | json | Set of key-value pairs for storing additional information | +| ↳ `next_payment_attempt` | number | Unix timestamp of next payment attempt | +| ↳ `number` | string | Human-readable invoice number | +| ↳ `on_behalf_of` | string | Account on behalf of which the invoice was issued | +| ↳ `paid` | boolean | Whether payment was successfully collected | +| ↳ `paid_out_of_band` | boolean | Whether the invoice was paid out of band | +| ↳ `payment_intent` | string | ID of the PaymentIntent associated with the invoice | +| ↳ `payment_settings` | json | Configuration settings for payment collection | +| ↳ `period_end` | number | End of the usage period | +| ↳ `period_start` | number | Start of the usage period | +| ↳ `post_payment_credit_notes_amount` | number | Total of all post-payment credit notes | +| ↳ `pre_payment_credit_notes_amount` | number | Total of all pre-payment credit notes | +| ↳ `quote` | string | ID of the quote this invoice was generated from | +| ↳ `receipt_number` | string | Receipt number for the invoice | +| ↳ `rendering` | json | Invoice rendering options | +| ↳ `rendering_options` | json | Invoice rendering options \(deprecated\) | +| ↳ `shipping_cost` | json | Shipping cost information | +| ↳ `shipping_details` | object | Shipping information | +| ↳ `name` | string | Recipient name | +| ↳ `phone` | string | Recipient phone number | +| ↳ `address` | object | Address object | +| ↳ `line1` | string | Address line 1 \(street address\) | +| ↳ `line2` | string | Address line 2 \(apartment, suite, etc.\) | +| ↳ `city` | string | City name | +| ↳ `state` | string | State, county, province, or region | +| ↳ `postal_code` | string | ZIP or postal code | +| ↳ `country` | string | Two-letter country code \(ISO 3166-1 alpha-2\) | +| ↳ `starting_balance` | number | Starting customer balance before invoice | +| ↳ `statement_descriptor` | string | Statement descriptor | +| ↳ `status` | string | Status of the invoice \(draft, open, paid, uncollectible, void\) | +| ↳ `status_transitions` | json | Timestamps at which the invoice status was updated | +| ↳ `subscription` | string | ID of the subscription for this invoice | +| ↳ `subscription_details` | json | Details about the subscription | +| ↳ `subscription_proration_date` | number | Only set for upcoming invoices with proration | +| ↳ `subtotal` | number | Total before discounts and taxes | +| ↳ `subtotal_excluding_tax` | number | Subtotal excluding tax | +| ↳ `tax` | number | Total tax amount | +| ↳ `test_clock` | string | ID of the test clock | +| ↳ `threshold_reason` | json | Details about why the invoice was created | +| ↳ `total` | number | Total after discounts and taxes | +| ↳ `total_discount_amounts` | array | Total discount amounts | +| ↳ `total_excluding_tax` | number | Total excluding tax | +| ↳ `total_tax_amounts` | array | Total tax amounts | +| ↳ `transfer_data` | json | Data for creating transfers | +| ↳ `webhooks_delivered_at` | number | Unix timestamp of webhooks delivery | | `metadata` | json | Invoice metadata | -| ↳ `id` | string | Stripe unique identifier | -| ↳ `status` | string | Current state of the resource | -| ↳ `amount_due` | number | Amount remaining to be paid in smallest currency unit | -| ↳ `currency` | string | Three-letter ISO currency code \(lowercase\) | +| ↳ `id` | string | Stripe unique identifier | +| ↳ `status` | string | Current state of the resource | +| ↳ `amount_due` | number | Amount remaining to be paid in smallest currency unit | +| ↳ `currency` | string | Three-letter ISO currency code \(lowercase\) | ### `stripe_void_invoice` @@ -674,12 +2171,142 @@ Void an invoice | Parameter | Type | Description | | --------- | ---- | ----------- | -| `invoice` | json | The voided invoice object | +| `invoice` | object | The voided invoice object | +| ↳ `id` | string | Unique identifier for the invoice | +| ↳ `object` | string | String representing the object type \(invoice\) | +| ↳ `account_country` | string | Country of the business associated with this invoice | +| ↳ `account_name` | string | Name of the account associated with this invoice | +| ↳ `account_tax_ids` | array | Account tax IDs | +| ↳ `amount_due` | number | Final amount due in smallest currency unit | +| ↳ `amount_paid` | number | Amount paid in smallest currency unit | +| ↳ `amount_remaining` | number | Amount remaining in smallest currency unit | +| ↳ `amount_shipping` | number | Shipping amount in smallest currency unit | +| ↳ `application` | string | ID of the Connect application that created the invoice | +| ↳ `application_fee_amount` | number | Application fee amount | +| ↳ `attempt_count` | number | Number of payment attempts made | +| ↳ `attempted` | boolean | Whether an attempt has been made to pay the invoice | +| ↳ `auto_advance` | boolean | Controls whether Stripe performs automatic collection | +| ↳ `automatic_tax` | json | Settings and results for automatic tax lookup | +| ↳ `billing_reason` | string | Reason the invoice was created | +| ↳ `charge` | string | ID of the latest charge for this invoice | +| ↳ `collection_method` | string | Collection method \(charge_automatically or send_invoice\) | +| ↳ `created` | number | Unix timestamp when the invoice was created | +| ↳ `currency` | string | Three-letter ISO currency code \(lowercase\) | +| ↳ `custom_fields` | array | Custom fields displayed on the invoice | +| ↳ `customer` | string | ID of the customer who will be billed | +| ↳ `customer_address` | object | Address object | +| ↳ `line1` | string | Address line 1 \(street address\) | +| ↳ `line2` | string | Address line 2 \(apartment, suite, etc.\) | +| ↳ `city` | string | City name | +| ↳ `state` | string | State, county, province, or region | +| ↳ `postal_code` | string | ZIP or postal code | +| ↳ `country` | string | Two-letter country code \(ISO 3166-1 alpha-2\) | +| ↳ `customer_email` | string | Email of the customer | +| ↳ `customer_name` | string | Name of the customer | +| ↳ `customer_phone` | string | Phone number of the customer | +| ↳ `customer_shipping` | object | Shipping information | +| ↳ `name` | string | Recipient name | +| ↳ `phone` | string | Recipient phone number | +| ↳ `address` | object | Address object | +| ↳ `line1` | string | Address line 1 \(street address\) | +| ↳ `line2` | string | Address line 2 \(apartment, suite, etc.\) | +| ↳ `city` | string | City name | +| ↳ `state` | string | State, county, province, or region | +| ↳ `postal_code` | string | ZIP or postal code | +| ↳ `country` | string | Two-letter country code \(ISO 3166-1 alpha-2\) | +| ↳ `customer_tax_exempt` | string | Tax exemption status of the customer | +| ↳ `customer_tax_ids` | array | Customer tax IDs | +| ↳ `default_payment_method` | string | ID of the default payment method | +| ↳ `default_source` | string | ID of the default source | +| ↳ `default_tax_rates` | array | Default tax rates | +| ↳ `description` | string | Description displayed in Dashboard \(memo\) | +| ↳ `discount` | json | Discount applied to the invoice | +| ↳ `discounts` | array | Discounts applied to the invoice | +| ↳ `due_date` | number | Unix timestamp when payment is due | +| ↳ `effective_at` | number | When the invoice was effective | +| ↳ `ending_balance` | number | Ending customer balance after invoice is finalized | +| ↳ `footer` | string | Footer displayed on the invoice | +| ↳ `from_invoice` | json | Details of the invoice that this invoice was created from | +| ↳ `hosted_invoice_url` | string | URL for the hosted invoice page | +| ↳ `invoice_pdf` | string | URL for the invoice PDF | +| ↳ `issuer` | json | The connected account that issues the invoice | +| ↳ `last_finalization_error` | json | Error encountered during finalization | +| ↳ `latest_revision` | string | ID of the most recent revision | +| ↳ `lines` | object | Invoice line items | +| ↳ `id` | string | Unique identifier for the line item | +| ↳ `object` | string | String representing the object type \(line_item\) | +| ↳ `amount` | number | Amount in smallest currency unit | +| ↳ `amount_excluding_tax` | number | Amount excluding tax | +| ↳ `currency` | string | Three-letter ISO currency code \(lowercase\) | +| ↳ `description` | string | Description of the line item | +| ↳ `discount_amounts` | array | Discount amounts applied | +| ↳ `discountable` | boolean | Whether the line item is discountable | +| ↳ `discounts` | array | Discounts applied to the line item | +| ↳ `invoice` | string | ID of the invoice that contains this line item | +| ↳ `livemode` | boolean | Whether object exists in live mode or test mode | +| ↳ `metadata` | json | Set of key-value pairs for storing additional information | +| ↳ `period` | json | Period this line item covers | +| ↳ `price` | json | Price object for this line item | +| ↳ `proration` | boolean | Whether this is a proration | +| ↳ `proration_details` | json | Additional details for proration line items | +| ↳ `quantity` | number | Quantity of the item | +| ↳ `subscription` | string | ID of the subscription | +| ↳ `subscription_item` | string | ID of the subscription item | +| ↳ `tax_amounts` | array | Tax amounts for this line item | +| ↳ `tax_rates` | array | Tax rates applied | +| ↳ `type` | string | Type of line item \(invoiceitem or subscription\) | +| ↳ `unit_amount_excluding_tax` | string | Unit amount excluding tax | +| ↳ `livemode` | boolean | Whether object exists in live mode or test mode | +| ↳ `metadata` | json | Set of key-value pairs for storing additional information | +| ↳ `next_payment_attempt` | number | Unix timestamp of next payment attempt | +| ↳ `number` | string | Human-readable invoice number | +| ↳ `on_behalf_of` | string | Account on behalf of which the invoice was issued | +| ↳ `paid` | boolean | Whether payment was successfully collected | +| ↳ `paid_out_of_band` | boolean | Whether the invoice was paid out of band | +| ↳ `payment_intent` | string | ID of the PaymentIntent associated with the invoice | +| ↳ `payment_settings` | json | Configuration settings for payment collection | +| ↳ `period_end` | number | End of the usage period | +| ↳ `period_start` | number | Start of the usage period | +| ↳ `post_payment_credit_notes_amount` | number | Total of all post-payment credit notes | +| ↳ `pre_payment_credit_notes_amount` | number | Total of all pre-payment credit notes | +| ↳ `quote` | string | ID of the quote this invoice was generated from | +| ↳ `receipt_number` | string | Receipt number for the invoice | +| ↳ `rendering` | json | Invoice rendering options | +| ↳ `rendering_options` | json | Invoice rendering options \(deprecated\) | +| ↳ `shipping_cost` | json | Shipping cost information | +| ↳ `shipping_details` | object | Shipping information | +| ↳ `name` | string | Recipient name | +| ↳ `phone` | string | Recipient phone number | +| ↳ `address` | object | Address object | +| ↳ `line1` | string | Address line 1 \(street address\) | +| ↳ `line2` | string | Address line 2 \(apartment, suite, etc.\) | +| ↳ `city` | string | City name | +| ↳ `state` | string | State, county, province, or region | +| ↳ `postal_code` | string | ZIP or postal code | +| ↳ `country` | string | Two-letter country code \(ISO 3166-1 alpha-2\) | +| ↳ `starting_balance` | number | Starting customer balance before invoice | +| ↳ `statement_descriptor` | string | Statement descriptor | +| ↳ `status` | string | Status of the invoice \(draft, open, paid, uncollectible, void\) | +| ↳ `status_transitions` | json | Timestamps at which the invoice status was updated | +| ↳ `subscription` | string | ID of the subscription for this invoice | +| ↳ `subscription_details` | json | Details about the subscription | +| ↳ `subscription_proration_date` | number | Only set for upcoming invoices with proration | +| ↳ `subtotal` | number | Total before discounts and taxes | +| ↳ `subtotal_excluding_tax` | number | Subtotal excluding tax | +| ↳ `tax` | number | Total tax amount | +| ↳ `test_clock` | string | ID of the test clock | +| ↳ `threshold_reason` | json | Details about why the invoice was created | +| ↳ `total` | number | Total after discounts and taxes | +| ↳ `total_discount_amounts` | array | Total discount amounts | +| ↳ `total_excluding_tax` | number | Total excluding tax | +| ↳ `total_tax_amounts` | array | Total tax amounts | +| ↳ `transfer_data` | json | Data for creating transfers | +| ↳ `webhooks_delivered_at` | number | Unix timestamp of webhooks delivery | | `metadata` | json | Invoice metadata | -| ↳ `id` | string | Stripe unique identifier | -| ↳ `status` | string | Current state of the resource | -| ↳ `amount_due` | number | Amount remaining to be paid in smallest currency unit | -| ↳ `currency` | string | Three-letter ISO currency code \(lowercase\) | +| ↳ `id` | string | Stripe unique identifier | +| ↳ `status` | string | Current state of the resource | +| ↳ `amount_due` | number | Amount remaining to be paid in smallest currency unit | +| ↳ `currency` | string | Three-letter ISO currency code \(lowercase\) | ### `stripe_send_invoice` @@ -698,10 +2325,10 @@ Send an invoice to the customer | --------- | ---- | ----------- | | `invoice` | json | The sent invoice object | | `metadata` | json | Invoice metadata | -| ↳ `id` | string | Stripe unique identifier | -| ↳ `status` | string | Current state of the resource | -| ↳ `amount_due` | number | Amount remaining to be paid in smallest currency unit | -| ↳ `currency` | string | Three-letter ISO currency code \(lowercase\) | +| ↳ `id` | string | Stripe unique identifier | +| ↳ `status` | string | Current state of the resource | +| ↳ `amount_due` | number | Amount remaining to be paid in smallest currency unit | +| ↳ `currency` | string | Three-letter ISO currency code \(lowercase\) | ### `stripe_list_invoices` @@ -722,8 +2349,8 @@ List all invoices | --------- | ---- | ----------- | | `invoices` | json | Array of invoice objects | | `metadata` | json | List metadata | -| ↳ `count` | number | Number of items returned | -| ↳ `has_more` | boolean | Whether more items exist beyond this page | +| ↳ `count` | number | Number of items returned | +| ↳ `has_more` | boolean | Whether more items exist beyond this page | ### `stripe_search_invoices` @@ -743,8 +2370,8 @@ Search for invoices using query syntax | --------- | ---- | ----------- | | `invoices` | json | Array of matching invoice objects | | `metadata` | json | Search metadata | -| ↳ `count` | number | Number of items returned | -| ↳ `has_more` | boolean | Whether more items exist beyond this page | +| ↳ `count` | number | Number of items returned | +| ↳ `has_more` | boolean | Whether more items exist beyond this page | ### `stripe_create_charge` @@ -769,11 +2396,11 @@ Create a new charge to process a payment | --------- | ---- | ----------- | | `charge` | json | The created Charge object | | `metadata` | json | Charge metadata including ID, status, amount, currency, and paid status | -| ↳ `id` | string | Stripe unique identifier | -| ↳ `status` | string | Current state of the resource | -| ↳ `amount` | number | Amount in smallest currency unit \(e.g., cents\) | -| ↳ `currency` | string | Three-letter ISO currency code \(lowercase\) | -| ↳ `paid` | boolean | Whether payment has been received | +| ↳ `id` | string | Stripe unique identifier | +| ↳ `status` | string | Current state of the resource | +| ↳ `amount` | number | Amount in smallest currency unit \(e.g., cents\) | +| ↳ `currency` | string | Three-letter ISO currency code \(lowercase\) | +| ↳ `paid` | boolean | Whether payment has been received | ### `stripe_retrieve_charge` @@ -792,11 +2419,11 @@ Retrieve an existing charge by ID | --------- | ---- | ----------- | | `charge` | json | The retrieved Charge object | | `metadata` | json | Charge metadata including ID, status, amount, currency, and paid status | -| ↳ `id` | string | Stripe unique identifier | -| ↳ `status` | string | Current state of the resource | -| ↳ `amount` | number | Amount in smallest currency unit \(e.g., cents\) | -| ↳ `currency` | string | Three-letter ISO currency code \(lowercase\) | -| ↳ `paid` | boolean | Whether payment has been received | +| ↳ `id` | string | Stripe unique identifier | +| ↳ `status` | string | Current state of the resource | +| ↳ `amount` | number | Amount in smallest currency unit \(e.g., cents\) | +| ↳ `currency` | string | Three-letter ISO currency code \(lowercase\) | +| ↳ `paid` | boolean | Whether payment has been received | ### `stripe_update_charge` @@ -817,11 +2444,11 @@ Update an existing charge | --------- | ---- | ----------- | | `charge` | json | The updated Charge object | | `metadata` | json | Charge metadata including ID, status, amount, currency, and paid status | -| ↳ `id` | string | Stripe unique identifier | -| ↳ `status` | string | Current state of the resource | -| ↳ `amount` | number | Amount in smallest currency unit \(e.g., cents\) | -| ↳ `currency` | string | Three-letter ISO currency code \(lowercase\) | -| ↳ `paid` | boolean | Whether payment has been received | +| ↳ `id` | string | Stripe unique identifier | +| ↳ `status` | string | Current state of the resource | +| ↳ `amount` | number | Amount in smallest currency unit \(e.g., cents\) | +| ↳ `currency` | string | Three-letter ISO currency code \(lowercase\) | +| ↳ `paid` | boolean | Whether payment has been received | ### `stripe_capture_charge` @@ -841,11 +2468,11 @@ Capture an uncaptured charge | --------- | ---- | ----------- | | `charge` | json | The captured Charge object | | `metadata` | json | Charge metadata including ID, status, amount, currency, and paid status | -| ↳ `id` | string | Stripe unique identifier | -| ↳ `status` | string | Current state of the resource | -| ↳ `amount` | number | Amount in smallest currency unit \(e.g., cents\) | -| ↳ `currency` | string | Three-letter ISO currency code \(lowercase\) | -| ↳ `paid` | boolean | Whether payment has been received | +| ↳ `id` | string | Stripe unique identifier | +| ↳ `status` | string | Current state of the resource | +| ↳ `amount` | number | Amount in smallest currency unit \(e.g., cents\) | +| ↳ `currency` | string | Three-letter ISO currency code \(lowercase\) | +| ↳ `paid` | boolean | Whether payment has been received | ### `stripe_list_charges` @@ -866,8 +2493,8 @@ List all charges | --------- | ---- | ----------- | | `charges` | json | Array of Charge objects | | `metadata` | json | List metadata including count and has_more | -| ↳ `count` | number | Number of items returned | -| ↳ `has_more` | boolean | Whether more items exist beyond this page | +| ↳ `count` | number | Number of items returned | +| ↳ `has_more` | boolean | Whether more items exist beyond this page | ### `stripe_search_charges` @@ -887,8 +2514,8 @@ Search for charges using query syntax | --------- | ---- | ----------- | | `charges` | json | Array of matching Charge objects | | `metadata` | json | Search metadata including count and has_more | -| ↳ `count` | number | Number of items returned | -| ↳ `has_more` | boolean | Whether more items exist beyond this page | +| ↳ `count` | number | Number of items returned | +| ↳ `has_more` | boolean | Whether more items exist beyond this page | ### `stripe_create_product` @@ -911,9 +2538,9 @@ Create a new product object | --------- | ---- | ----------- | | `product` | json | The created product object | | `metadata` | json | Product metadata | -| ↳ `id` | string | Stripe unique identifier | -| ↳ `name` | string | Display name | -| ↳ `active` | boolean | Whether the resource is currently active | +| ↳ `id` | string | Stripe unique identifier | +| ↳ `name` | string | Display name | +| ↳ `active` | boolean | Whether the resource is currently active | ### `stripe_retrieve_product` @@ -932,9 +2559,9 @@ Retrieve an existing product by ID | --------- | ---- | ----------- | | `product` | json | The retrieved product object | | `metadata` | json | Product metadata | -| ↳ `id` | string | Stripe unique identifier | -| ↳ `name` | string | Display name | -| ↳ `active` | boolean | Whether the resource is currently active | +| ↳ `id` | string | Stripe unique identifier | +| ↳ `name` | string | Display name | +| ↳ `active` | boolean | Whether the resource is currently active | ### `stripe_update_product` @@ -958,9 +2585,9 @@ Update an existing product | --------- | ---- | ----------- | | `product` | json | The updated product object | | `metadata` | json | Product metadata | -| ↳ `id` | string | Stripe unique identifier | -| ↳ `name` | string | Display name | -| ↳ `active` | boolean | Whether the resource is currently active | +| ↳ `id` | string | Stripe unique identifier | +| ↳ `name` | string | Display name | +| ↳ `active` | boolean | Whether the resource is currently active | ### `stripe_delete_product` @@ -998,8 +2625,8 @@ List all products | --------- | ---- | ----------- | | `products` | json | Array of product objects | | `metadata` | json | List metadata | -| ↳ `count` | number | Number of items returned | -| ↳ `has_more` | boolean | Whether more items exist beyond this page | +| ↳ `count` | number | Number of items returned | +| ↳ `has_more` | boolean | Whether more items exist beyond this page | ### `stripe_search_products` @@ -1019,8 +2646,8 @@ Search for products using query syntax | --------- | ---- | ----------- | | `products` | json | Array of matching product objects | | `metadata` | json | Search metadata | -| ↳ `count` | number | Number of items returned | -| ↳ `has_more` | boolean | Whether more items exist beyond this page | +| ↳ `count` | number | Number of items returned | +| ↳ `has_more` | boolean | Whether more items exist beyond this page | ### `stripe_create_price` @@ -1044,10 +2671,10 @@ Create a new price for a product | --------- | ---- | ----------- | | `price` | json | The created price object | | `metadata` | json | Price metadata | -| ↳ `id` | string | Stripe unique identifier | -| ↳ `product` | string | Associated product ID | -| ↳ `unit_amount` | number | Amount in smallest currency unit \(e.g., cents\) | -| ↳ `currency` | string | Three-letter ISO currency code \(lowercase\) | +| ↳ `id` | string | Stripe unique identifier | +| ↳ `product` | string | Associated product ID | +| ↳ `unit_amount` | number | Amount in smallest currency unit \(e.g., cents\) | +| ↳ `currency` | string | Three-letter ISO currency code \(lowercase\) | ### `stripe_retrieve_price` @@ -1066,10 +2693,10 @@ Retrieve an existing price by ID | --------- | ---- | ----------- | | `price` | json | The retrieved price object | | `metadata` | json | Price metadata | -| ↳ `id` | string | Stripe unique identifier | -| ↳ `product` | string | Associated product ID | -| ↳ `unit_amount` | number | Amount in smallest currency unit \(e.g., cents\) | -| ↳ `currency` | string | Three-letter ISO currency code \(lowercase\) | +| ↳ `id` | string | Stripe unique identifier | +| ↳ `product` | string | Associated product ID | +| ↳ `unit_amount` | number | Amount in smallest currency unit \(e.g., cents\) | +| ↳ `currency` | string | Three-letter ISO currency code \(lowercase\) | ### `stripe_update_price` @@ -1090,10 +2717,10 @@ Update an existing price | --------- | ---- | ----------- | | `price` | json | The updated price object | | `metadata` | json | Price metadata | -| ↳ `id` | string | Stripe unique identifier | -| ↳ `product` | string | Associated product ID | -| ↳ `unit_amount` | number | Amount in smallest currency unit \(e.g., cents\) | -| ↳ `currency` | string | Three-letter ISO currency code \(lowercase\) | +| ↳ `id` | string | Stripe unique identifier | +| ↳ `product` | string | Associated product ID | +| ↳ `unit_amount` | number | Amount in smallest currency unit \(e.g., cents\) | +| ↳ `currency` | string | Three-letter ISO currency code \(lowercase\) | ### `stripe_list_prices` @@ -1114,8 +2741,8 @@ List all prices | --------- | ---- | ----------- | | `prices` | json | Array of price objects | | `metadata` | json | List metadata | -| ↳ `count` | number | Number of items returned | -| ↳ `has_more` | boolean | Whether more items exist beyond this page | +| ↳ `count` | number | Number of items returned | +| ↳ `has_more` | boolean | Whether more items exist beyond this page | ### `stripe_search_prices` @@ -1135,8 +2762,8 @@ Search for prices using query syntax | --------- | ---- | ----------- | | `prices` | json | Array of matching price objects | | `metadata` | json | Search metadata | -| ↳ `count` | number | Number of items returned | -| ↳ `has_more` | boolean | Whether more items exist beyond this page | +| ↳ `count` | number | Number of items returned | +| ↳ `has_more` | boolean | Whether more items exist beyond this page | ### `stripe_retrieve_event` @@ -1155,9 +2782,9 @@ Retrieve an existing Event by ID | --------- | ---- | ----------- | | `event` | json | The retrieved Event object | | `metadata` | json | Event metadata including ID, type, and created timestamp | -| ↳ `id` | string | Stripe unique identifier | -| ↳ `type` | string | Event type identifier | -| ↳ `created` | number | Unix timestamp of creation | +| ↳ `id` | string | Stripe unique identifier | +| ↳ `type` | string | Event type identifier | +| ↳ `created` | number | Unix timestamp of creation | ### `stripe_list_events` @@ -1178,7 +2805,7 @@ List all Events | --------- | ---- | ----------- | | `events` | json | Array of Event objects | | `metadata` | json | List metadata including count and has_more | -| ↳ `count` | number | Number of items returned | -| ↳ `has_more` | boolean | Whether more items exist beyond this page | +| ↳ `count` | number | Number of items returned | +| ↳ `has_more` | boolean | Whether more items exist beyond this page | diff --git a/apps/docs/content/docs/en/tools/stt.mdx b/apps/docs/content/docs/en/tools/stt.mdx index db378e0db..6a75f2f65 100644 --- a/apps/docs/content/docs/en/tools/stt.mdx +++ b/apps/docs/content/docs/en/tools/stt.mdx @@ -74,6 +74,11 @@ Transcribe audio to text using OpenAI Whisper | --------- | ---- | ----------- | | `transcript` | string | Full transcribed text | | `segments` | array | Timestamped segments | +| ↳ `text` | string | Transcribed text for this segment | +| ↳ `start` | number | Start time in seconds | +| ↳ `end` | number | End time in seconds | +| ↳ `speaker` | string | Speaker identifier \(if diarization enabled\) | +| ↳ `confidence` | number | Confidence score \(0-1\) | | `language` | string | Detected or specified language | | `duration` | number | Audio duration in seconds | @@ -101,6 +106,11 @@ Transcribe audio to text using Deepgram | --------- | ---- | ----------- | | `transcript` | string | Full transcribed text | | `segments` | array | Timestamped segments with speaker labels | +| ↳ `text` | string | Transcribed text for this segment | +| ↳ `start` | number | Start time in seconds | +| ↳ `end` | number | End time in seconds | +| ↳ `speaker` | string | Speaker identifier \(if diarization enabled\) | +| ↳ `confidence` | number | Confidence score \(0-1\) | | `language` | string | Detected or specified language | | `duration` | number | Audio duration in seconds | | `confidence` | number | Overall confidence score | @@ -160,11 +170,25 @@ Transcribe audio to text using AssemblyAI with advanced NLP features | --------- | ---- | ----------- | | `transcript` | string | Full transcribed text | | `segments` | array | Timestamped segments with speaker labels | +| ↳ `text` | string | Transcribed text for this segment | +| ↳ `start` | number | Start time in seconds | +| ↳ `end` | number | End time in seconds | +| ↳ `speaker` | string | Speaker identifier \(if diarization enabled\) | +| ↳ `confidence` | number | Confidence score \(0-1\) | | `language` | string | Detected or specified language | | `duration` | number | Audio duration in seconds | | `confidence` | number | Overall confidence score | | `sentiment` | array | Sentiment analysis results | +| ↳ `text` | string | Text that was analyzed | +| ↳ `sentiment` | string | Sentiment \(POSITIVE, NEGATIVE, NEUTRAL\) | +| ↳ `confidence` | number | Confidence score | +| ↳ `start` | number | Start time in milliseconds | +| ↳ `end` | number | End time in milliseconds | | `entities` | array | Detected entities | +| ↳ `entity_type` | string | Entity type \(e.g., person_name, location, organization\) | +| ↳ `text` | string | Entity text | +| ↳ `start` | number | Start time in milliseconds | +| ↳ `end` | number | End time in milliseconds | | `summary` | string | Auto-generated summary | ### `stt_gemini` diff --git a/apps/docs/content/docs/en/tools/supabase.mdx b/apps/docs/content/docs/en/tools/supabase.mdx index 3d7914e84..089def746 100644 --- a/apps/docs/content/docs/en/tools/supabase.mdx +++ b/apps/docs/content/docs/en/tools/supabase.mdx @@ -282,9 +282,24 @@ Introspect Supabase database schema to get table structures, columns, and relati | ↳ `name` | string | Table name | | ↳ `schema` | string | Database schema name | | ↳ `columns` | array | Array of column definitions | +| ↳ `name` | string | Column name | +| ↳ `type` | string | Column data type | +| ↳ `nullable` | boolean | Whether the column allows null values | +| ↳ `default` | string | Default value for the column | +| ↳ `isPrimaryKey` | boolean | Whether the column is a primary key | +| ↳ `isForeignKey` | boolean | Whether the column is a foreign key | +| ↳ `references` | object | Foreign key reference details | +| ↳ `table` | string | Referenced table name | +| ↳ `column` | string | Referenced column name | | ↳ `primaryKey` | array | Array of primary key column names | | ↳ `foreignKeys` | array | Array of foreign key relationships | +| ↳ `column` | string | Local column name | +| ↳ `referencesTable` | string | Referenced table name | +| ↳ `referencesColumn` | string | Referenced column name | | ↳ `indexes` | array | Array of index definitions | +| ↳ `name` | string | Index name | +| ↳ `columns` | array | Columns included in the index | +| ↳ `unique` | boolean | Whether the index enforces uniqueness | | `schemas` | array | List of schemas found in the database | ### `supabase_storage_upload` @@ -310,6 +325,9 @@ Upload a file to a Supabase storage bucket | --------- | ---- | ----------- | | `message` | string | Operation status message | | `results` | object | Upload result including file path, bucket, and public URL | +| ↳ `id` | string | Unique identifier for the uploaded file | +| ↳ `path` | string | Path to the uploaded file within the bucket | +| ↳ `fullPath` | string | Full path including bucket name | ### `supabase_storage_download` @@ -355,6 +373,19 @@ List files in a Supabase storage bucket | --------- | ---- | ----------- | | `message` | string | Operation status message | | `results` | array | Array of file objects with metadata | +| ↳ `id` | string | Unique file identifier | +| ↳ `name` | string | File name | +| ↳ `bucket_id` | string | Bucket identifier the file belongs to | +| ↳ `owner` | string | Owner identifier | +| ↳ `created_at` | string | File creation timestamp | +| ↳ `updated_at` | string | Last update timestamp | +| ↳ `last_accessed_at` | string | Last access timestamp | +| ↳ `metadata` | object | File metadata including size and MIME type | +| ↳ `size` | number | File size in bytes | +| ↳ `mimetype` | string | MIME type of the file | +| ↳ `cacheControl` | string | Cache control header value | +| ↳ `lastModified` | string | Last modified timestamp | +| ↳ `eTag` | string | Entity tag for caching | ### `supabase_storage_delete` @@ -375,6 +406,13 @@ Delete files from a Supabase storage bucket | --------- | ---- | ----------- | | `message` | string | Operation status message | | `results` | array | Array of deleted file objects | +| ↳ `name` | string | Name of the deleted file | +| ↳ `bucket_id` | string | Bucket identifier | +| ↳ `owner` | string | Owner identifier | +| ↳ `id` | string | Unique file identifier | +| ↳ `updated_at` | string | Last update timestamp | +| ↳ `created_at` | string | File creation timestamp | +| ↳ `last_accessed_at` | string | Last access timestamp | ### `supabase_storage_move` @@ -396,6 +434,7 @@ Move a file within a Supabase storage bucket | --------- | ---- | ----------- | | `message` | string | Operation status message | | `results` | object | Move operation result | +| ↳ `message` | string | Operation status message | ### `supabase_storage_copy` @@ -417,6 +456,7 @@ Copy a file within a Supabase storage bucket | --------- | ---- | ----------- | | `message` | string | Operation status message | | `results` | object | Copy operation result | +| ↳ `message` | string | Operation status message | ### `supabase_storage_create_bucket` @@ -439,6 +479,7 @@ Create a new storage bucket in Supabase | --------- | ---- | ----------- | | `message` | string | Operation status message | | `results` | object | Created bucket information | +| ↳ `name` | string | Created bucket name | ### `supabase_storage_list_buckets` @@ -457,6 +498,14 @@ List all storage buckets in Supabase | --------- | ---- | ----------- | | `message` | string | Operation status message | | `results` | array | Array of bucket objects | +| ↳ `id` | string | Unique bucket identifier | +| ↳ `name` | string | Bucket name | +| ↳ `owner` | string | Owner identifier | +| ↳ `public` | boolean | Whether the bucket is publicly accessible | +| ↳ `created_at` | string | Bucket creation timestamp | +| ↳ `updated_at` | string | Last update timestamp | +| ↳ `file_size_limit` | number | Maximum file size allowed in bytes | +| ↳ `allowed_mime_types` | array | List of allowed MIME types for uploads | ### `supabase_storage_delete_bucket` @@ -476,6 +525,7 @@ Delete a storage bucket in Supabase | --------- | ---- | ----------- | | `message` | string | Operation status message | | `results` | object | Delete operation result | +| ↳ `message` | string | Operation status message | ### `supabase_storage_get_public_url` diff --git a/apps/docs/content/docs/en/tools/tavily.mdx b/apps/docs/content/docs/en/tools/tavily.mdx index 46af213ab..44c347a98 100644 --- a/apps/docs/content/docs/en/tools/tavily.mdx +++ b/apps/docs/content/docs/en/tools/tavily.mdx @@ -65,9 +65,17 @@ Perform AI-powered web searches using Tavily | Parameter | Type | Description | | --------- | ---- | ----------- | | `query` | string | The search query that was executed | -| `results` | array | Search results with titles, URLs, content snippets, and optional metadata | +| `results` | array | Ranked search results with titles, URLs, content snippets, and optional metadata | +| ↳ `title` | string | Result title | +| ↳ `url` | string | Result URL | +| ↳ `content` | string | Brief description or content snippet | +| ↳ `score` | number | Relevance score | +| ↳ `raw_content` | string | Full parsed HTML content \(if requested\) | +| ↳ `favicon` | string | Favicon URL for the domain | | `answer` | string | LLM-generated answer to the query \(if requested\) | | `images` | array | Query-related images \(if requested\) | +| ↳ `url` | string | Image URL | +| ↳ `description` | string | Image description | | `auto_parameters` | object | Automatically selected parameters based on query intent \(if enabled\) | | `response_time` | number | Time taken for the search request in seconds | @@ -90,13 +98,14 @@ Extract raw content from multiple web pages simultaneously using Tavily | Parameter | Type | Description | | --------- | ---- | ----------- | -| `results` | array | The URL that was extracted | -| ↳ `url` | string | The URL that was extracted | -| ↳ `raw_content` | string | The raw text content from the webpage | -| ↳ `favicon` | string | Favicon URL \(if requested\) | -| `failed_results` | array | The URL that failed extraction | +| `results` | array | Successfully extracted content from URLs | +| ↳ `url` | string | The source URL | +| ↳ `raw_content` | string | Full extracted content from the page | +| ↳ `images` | array | Image URLs \(when include_images is true\) | +| ↳ `favicon` | string | Favicon URL for the result | +| `failed_results` | array | URLs that failed to extract content | | ↳ `url` | string | The URL that failed extraction | -| ↳ `error` | string | Error message for the failed extraction | +| ↳ `error` | string | Error message describing why extraction failed | | `response_time` | number | Time taken for the extraction request in seconds | ### `tavily_crawl` @@ -128,10 +137,10 @@ Systematically crawl and extract content from websites using Tavily | Parameter | Type | Description | | --------- | ---- | ----------- | | `base_url` | string | The base URL that was crawled | -| `results` | array | The crawled page URL | +| `results` | array | Array of crawled pages with extracted content | | ↳ `url` | string | The crawled page URL | -| ↳ `raw_content` | string | Extracted content from the page | -| ↳ `favicon` | string | Favicon URL \(if requested\) | +| ↳ `raw_content` | string | Full extracted page content | +| ↳ `favicon` | string | Favicon URL for the result | | `response_time` | number | Time taken for the crawl request in seconds | | `request_id` | string | Unique identifier for support reference | @@ -160,7 +169,7 @@ Discover and visualize website structure using Tavily | Parameter | Type | Description | | --------- | ---- | ----------- | | `base_url` | string | The base URL that was mapped | -| `results` | array | Discovered URL | +| `results` | array | Array of discovered URLs during mapping | | ↳ `url` | string | Discovered URL | | `response_time` | number | Time taken for the map request in seconds | | `request_id` | string | Unique identifier for support reference | diff --git a/apps/docs/content/docs/en/tools/telegram.mdx b/apps/docs/content/docs/en/tools/telegram.mdx index da83831e5..dd1a18fff 100644 --- a/apps/docs/content/docs/en/tools/telegram.mdx +++ b/apps/docs/content/docs/en/tools/telegram.mdx @@ -76,19 +76,19 @@ Send messages to Telegram channels or users through the Telegram Bot API. Enable | --------- | ---- | ----------- | | `message` | string | Success or error message | | `data` | object | Telegram message data | -| ↳ `message_id` | number | Unique Telegram message identifier | -| ↳ `from` | object | Chat information | -| ↳ `id` | number | Chat ID | -| ↳ `is_bot` | boolean | Whether the chat is a bot or not | -| ↳ `first_name` | string | Chat username \(if available\) | -| ↳ `username` | string | Chat title \(for groups and channels\) | -| ↳ `chat` | object | Information about the bot that sent the message | -| ↳ `id` | number | Bot user ID | -| ↳ `first_name` | string | Bot first name | -| ↳ `username` | string | Bot username | -| ↳ `type` | string | chat type private or channel | -| ↳ `date` | number | Unix timestamp when message was sent | -| ↳ `text` | string | Text content of the sent message | +| ↳ `message_id` | number | Unique Telegram message identifier | +| ↳ `from` | object | Chat information | +| ↳ `id` | number | Chat ID | +| ↳ `is_bot` | boolean | Whether the chat is a bot or not | +| ↳ `first_name` | string | Chat username \(if available\) | +| ↳ `username` | string | Chat title \(for groups and channels\) | +| ↳ `chat` | object | Information about the bot that sent the message | +| ↳ `id` | number | Bot user ID | +| ↳ `first_name` | string | Bot first name | +| ↳ `username` | string | Bot username | +| ↳ `type` | string | chat type private or channel | +| ↳ `date` | number | Unix timestamp when message was sent | +| ↳ `text` | string | Text content of the sent message | ### `telegram_delete_message` @@ -108,8 +108,8 @@ Delete messages in Telegram channels or chats through the Telegram Bot API. Requ | --------- | ---- | ----------- | | `message` | string | Success or error message | | `data` | object | Delete operation result | -| ↳ `ok` | boolean | API response success status | -| ↳ `deleted` | boolean | Whether the message was successfully deleted | +| ↳ `ok` | boolean | API response success status | +| ↳ `deleted` | boolean | Whether the message was successfully deleted | ### `telegram_send_photo` @@ -130,25 +130,25 @@ Send photos to Telegram channels or users through the Telegram Bot API. | --------- | ---- | ----------- | | `message` | string | Success or error message | | `data` | object | Telegram message data including optional photo\(s\) | -| ↳ `message_id` | number | Unique Telegram message identifier | -| ↳ `from` | object | Chat information | -| ↳ `id` | number | Chat ID | -| ↳ `is_bot` | boolean | Whether the chat is a bot or not | -| ↳ `first_name` | string | Chat username \(if available\) | -| ↳ `username` | string | Chat title \(for groups and channels\) | -| ↳ `chat` | object | Information about the bot that sent the message | -| ↳ `id` | number | Bot user ID | -| ↳ `first_name` | string | Bot first name | -| ↳ `username` | string | Bot username | -| ↳ `type` | string | Chat type \(private, group, supergroup, channel\) | -| ↳ `date` | number | Unix timestamp when message was sent | -| ↳ `text` | string | Text content of the sent message \(if applicable\) | -| ↳ `photo` | array | List of photos included in the message | -| ↳ `file_id` | string | Unique file ID of the photo | -| ↳ `file_unique_id` | string | Unique identifier for this file across different bots | -| ↳ `file_size` | number | Size of the photo file in bytes | -| ↳ `width` | number | Photo width in pixels | -| ↳ `height` | number | Photo height in pixels | +| ↳ `message_id` | number | Unique Telegram message identifier | +| ↳ `from` | object | Chat information | +| ↳ `id` | number | Chat ID | +| ↳ `is_bot` | boolean | Whether the chat is a bot or not | +| ↳ `first_name` | string | Chat username \(if available\) | +| ↳ `username` | string | Chat title \(for groups and channels\) | +| ↳ `chat` | object | Information about the bot that sent the message | +| ↳ `id` | number | Bot user ID | +| ↳ `first_name` | string | Bot first name | +| ↳ `username` | string | Bot username | +| ↳ `type` | string | Chat type \(private, group, supergroup, channel\) | +| ↳ `date` | number | Unix timestamp when message was sent | +| ↳ `text` | string | Text content of the sent message \(if applicable\) | +| ↳ `photo` | array | List of photos included in the message | +| ↳ `file_id` | string | Unique file ID of the photo | +| ↳ `file_unique_id` | string | Unique identifier for this file across different bots | +| ↳ `file_size` | number | Size of the photo file in bytes | +| ↳ `width` | number | Photo width in pixels | +| ↳ `height` | number | Photo height in pixels | ### `telegram_send_video` @@ -169,58 +169,58 @@ Send videos to Telegram channels or users through the Telegram Bot API. | --------- | ---- | ----------- | | `message` | string | Success or error message | | `data` | object | Telegram message data including optional media | -| ↳ `message_id` | number | Unique Telegram message identifier | -| ↳ `from` | object | Information about the sender | -| ↳ `id` | number | Sender ID | -| ↳ `is_bot` | boolean | Whether the chat is a bot or not | -| ↳ `first_name` | string | Sender | -| ↳ `username` | string | Sender | -| ↳ `chat` | object | Information about the chat where message was sent | -| ↳ `id` | number | Chat ID | -| ↳ `first_name` | string | Chat first name \(if private chat\) | -| ↳ `username` | string | Chat username \(for private or channels\) | -| ↳ `type` | string | Type of chat \(private, group, supergroup, or channel\) | -| ↳ `date` | number | Unix timestamp when the message was sent | -| ↳ `text` | string | Text content of the sent message \(if applicable\) | -| ↳ `format` | object | Media format information \(for videos, GIFs, etc.\) | -| ↳ `file_name` | string | Media file name | -| ↳ `mime_type` | string | Media MIME type | -| ↳ `duration` | number | Duration of media in seconds | -| ↳ `width` | number | Media width in pixels | -| ↳ `height` | number | Media height in pixels | -| ↳ `thumbnail` | object | Thumbnail image details | -| ↳ `file_id` | string | Thumbnail file ID | -| ↳ `file_unique_id` | string | Unique thumbnail file identifier | -| ↳ `file_size` | number | Thumbnail file size in bytes | -| ↳ `width` | number | Thumbnail width in pixels | -| ↳ `height` | number | Thumbnail height in pixels | -| ↳ `thumb` | object | Secondary thumbnail details \(duplicate of thumbnail\) | -| ↳ `file_id` | string | Thumbnail file ID | -| ↳ `file_unique_id` | string | Unique thumbnail file identifier | -| ↳ `file_size` | number | Thumbnail file size in bytes | -| ↳ `width` | number | Thumbnail width in pixels | -| ↳ `height` | number | Thumbnail height in pixels | -| ↳ `file_id` | string | Media file ID | -| ↳ `file_unique_id` | string | Unique media file identifier | -| ↳ `file_size` | number | Size of media file in bytes | -| ↳ `document` | object | Document file details if the message contains a document | -| ↳ `file_name` | string | Document file name | -| ↳ `mime_type` | string | Document MIME type | -| ↳ `thumbnail` | object | Document thumbnail information | -| ↳ `file_id` | string | Thumbnail file ID | -| ↳ `file_unique_id` | string | Unique thumbnail file identifier | -| ↳ `file_size` | number | Thumbnail file size in bytes | -| ↳ `width` | number | Thumbnail width in pixels | -| ↳ `height` | number | Thumbnail height in pixels | -| ↳ `thumb` | object | Duplicate thumbnail info \(used for compatibility\) | -| ↳ `file_id` | string | Thumbnail file ID | -| ↳ `file_unique_id` | string | Unique thumbnail file identifier | -| ↳ `file_size` | number | Thumbnail file size in bytes | -| ↳ `width` | number | Thumbnail width in pixels | -| ↳ `height` | number | Thumbnail height in pixels | -| ↳ `file_id` | string | Document file ID | -| ↳ `file_unique_id` | string | Unique document file identifier | -| ↳ `file_size` | number | Size of document file in bytes | +| ↳ `message_id` | number | Unique Telegram message identifier | +| ↳ `from` | object | Information about the sender | +| ↳ `id` | number | Sender ID | +| ↳ `is_bot` | boolean | Whether the chat is a bot or not | +| ↳ `first_name` | string | Sender's first name \(if available\) | +| ↳ `username` | string | Sender's username \(if available\) | +| ↳ `chat` | object | Information about the chat where message was sent | +| ↳ `id` | number | Chat ID | +| ↳ `first_name` | string | Chat first name \(if private chat\) | +| ↳ `username` | string | Chat username \(for private or channels\) | +| ↳ `type` | string | Type of chat \(private, group, supergroup, or channel\) | +| ↳ `date` | number | Unix timestamp when the message was sent | +| ↳ `text` | string | Text content of the sent message \(if applicable\) | +| ↳ `format` | object | Media format information \(for videos, GIFs, etc.\) | +| ↳ `file_name` | string | Media file name | +| ↳ `mime_type` | string | Media MIME type | +| ↳ `duration` | number | Duration of media in seconds | +| ↳ `width` | number | Media width in pixels | +| ↳ `height` | number | Media height in pixels | +| ↳ `thumbnail` | object | Thumbnail image details | +| ↳ `file_id` | string | Thumbnail file ID | +| ↳ `file_unique_id` | string | Unique thumbnail file identifier | +| ↳ `file_size` | number | Thumbnail file size in bytes | +| ↳ `width` | number | Thumbnail width in pixels | +| ↳ `height` | number | Thumbnail height in pixels | +| ↳ `thumb` | object | Secondary thumbnail details \(duplicate of thumbnail\) | +| ↳ `file_id` | string | Thumbnail file ID | +| ↳ `file_unique_id` | string | Unique thumbnail file identifier | +| ↳ `file_size` | number | Thumbnail file size in bytes | +| ↳ `width` | number | Thumbnail width in pixels | +| ↳ `height` | number | Thumbnail height in pixels | +| ↳ `file_id` | string | Media file ID | +| ↳ `file_unique_id` | string | Unique media file identifier | +| ↳ `file_size` | number | Size of media file in bytes | +| ↳ `document` | object | Document file details if the message contains a document | +| ↳ `file_name` | string | Document file name | +| ↳ `mime_type` | string | Document MIME type | +| ↳ `thumbnail` | object | Document thumbnail information | +| ↳ `file_id` | string | Thumbnail file ID | +| ↳ `file_unique_id` | string | Unique thumbnail file identifier | +| ↳ `file_size` | number | Thumbnail file size in bytes | +| ↳ `width` | number | Thumbnail width in pixels | +| ↳ `height` | number | Thumbnail height in pixels | +| ↳ `thumb` | object | Duplicate thumbnail info \(used for compatibility\) | +| ↳ `file_id` | string | Thumbnail file ID | +| ↳ `file_unique_id` | string | Unique thumbnail file identifier | +| ↳ `file_size` | number | Thumbnail file size in bytes | +| ↳ `width` | number | Thumbnail width in pixels | +| ↳ `height` | number | Thumbnail height in pixels | +| ↳ `file_id` | string | Document file ID | +| ↳ `file_unique_id` | string | Unique document file identifier | +| ↳ `file_size` | number | Size of document file in bytes | ### `telegram_send_audio` @@ -241,28 +241,28 @@ Send audio files to Telegram channels or users through the Telegram Bot API. | --------- | ---- | ----------- | | `message` | string | Success or error message | | `data` | object | Telegram message data including voice/audio information | -| ↳ `message_id` | number | Unique Telegram message identifier | -| ↳ `from` | object | Information about the sender | -| ↳ `id` | number | Sender ID | -| ↳ `is_bot` | boolean | Whether the chat is a bot or not | -| ↳ `first_name` | string | Sender | -| ↳ `username` | string | Sender | -| ↳ `chat` | object | Information about the chat where the message was sent | -| ↳ `id` | number | Chat ID | -| ↳ `first_name` | string | Chat first name \(if private chat\) | -| ↳ `username` | string | Chat username \(for private or channels\) | -| ↳ `type` | string | Type of chat \(private, group, supergroup, or channel\) | -| ↳ `date` | number | Unix timestamp when the message was sent | -| ↳ `text` | string | Text content of the sent message \(if applicable\) | -| ↳ `audio` | object | Audio file details | -| ↳ `duration` | number | Duration of the audio in seconds | -| ↳ `performer` | string | Performer of the audio | -| ↳ `title` | string | Title of the audio | -| ↳ `file_name` | string | Original filename of the audio | -| ↳ `mime_type` | string | MIME type of the audio file | -| ↳ `file_id` | string | Unique file identifier for this audio | -| ↳ `file_unique_id` | string | Unique identifier across different bots for this file | -| ↳ `file_size` | number | Size of the audio file in bytes | +| ↳ `message_id` | number | Unique Telegram message identifier | +| ↳ `from` | object | Information about the sender | +| ↳ `id` | number | Sender ID | +| ↳ `is_bot` | boolean | Whether the chat is a bot or not | +| ↳ `first_name` | string | Sender's first name \(if available\) | +| ↳ `username` | string | Sender's username \(if available\) | +| ↳ `chat` | object | Information about the chat where the message was sent | +| ↳ `id` | number | Chat ID | +| ↳ `first_name` | string | Chat first name \(if private chat\) | +| ↳ `username` | string | Chat username \(for private or channels\) | +| ↳ `type` | string | Type of chat \(private, group, supergroup, or channel\) | +| ↳ `date` | number | Unix timestamp when the message was sent | +| ↳ `text` | string | Text content of the sent message \(if applicable\) | +| ↳ `audio` | object | Audio file details | +| ↳ `duration` | number | Duration of the audio in seconds | +| ↳ `performer` | string | Performer of the audio | +| ↳ `title` | string | Title of the audio | +| ↳ `file_name` | string | Original filename of the audio | +| ↳ `mime_type` | string | MIME type of the audio file | +| ↳ `file_id` | string | Unique file identifier for this audio | +| ↳ `file_unique_id` | string | Unique identifier across different bots for this file | +| ↳ `file_size` | number | Size of the audio file in bytes | ### `telegram_send_animation` @@ -283,58 +283,58 @@ Send animations (GIFs) to Telegram channels or users through the Telegram Bot AP | --------- | ---- | ----------- | | `message` | string | Success or error message | | `data` | object | Telegram message data including optional media | -| ↳ `message_id` | number | Unique Telegram message identifier | -| ↳ `from` | object | Information about the sender | -| ↳ `id` | number | Sender ID | -| ↳ `is_bot` | boolean | Whether the chat is a bot or not | -| ↳ `first_name` | string | Sender | -| ↳ `username` | string | Sender | -| ↳ `chat` | object | Information about the chat where message was sent | -| ↳ `id` | number | Chat ID | -| ↳ `first_name` | string | Chat first name \(if private chat\) | -| ↳ `username` | string | Chat username \(for private or channels\) | -| ↳ `type` | string | Type of chat \(private, group, supergroup, or channel\) | -| ↳ `date` | number | Unix timestamp when the message was sent | -| ↳ `text` | string | Text content of the sent message \(if applicable\) | -| ↳ `format` | object | Media format information \(for videos, GIFs, etc.\) | -| ↳ `file_name` | string | Media file name | -| ↳ `mime_type` | string | Media MIME type | -| ↳ `duration` | number | Duration of media in seconds | -| ↳ `width` | number | Media width in pixels | -| ↳ `height` | number | Media height in pixels | -| ↳ `thumbnail` | object | Thumbnail image details | -| ↳ `file_id` | string | Thumbnail file ID | -| ↳ `file_unique_id` | string | Unique thumbnail file identifier | -| ↳ `file_size` | number | Thumbnail file size in bytes | -| ↳ `width` | number | Thumbnail width in pixels | -| ↳ `height` | number | Thumbnail height in pixels | -| ↳ `thumb` | object | Secondary thumbnail details \(duplicate of thumbnail\) | -| ↳ `file_id` | string | Thumbnail file ID | -| ↳ `file_unique_id` | string | Unique thumbnail file identifier | -| ↳ `file_size` | number | Thumbnail file size in bytes | -| ↳ `width` | number | Thumbnail width in pixels | -| ↳ `height` | number | Thumbnail height in pixels | -| ↳ `file_id` | string | Media file ID | -| ↳ `file_unique_id` | string | Unique media file identifier | -| ↳ `file_size` | number | Size of media file in bytes | -| ↳ `document` | object | Document file details if the message contains a document | -| ↳ `file_name` | string | Document file name | -| ↳ `mime_type` | string | Document MIME type | -| ↳ `thumbnail` | object | Document thumbnail information | -| ↳ `file_id` | string | Thumbnail file ID | -| ↳ `file_unique_id` | string | Unique thumbnail file identifier | -| ↳ `file_size` | number | Thumbnail file size in bytes | -| ↳ `width` | number | Thumbnail width in pixels | -| ↳ `height` | number | Thumbnail height in pixels | -| ↳ `thumb` | object | Duplicate thumbnail info \(used for compatibility\) | -| ↳ `file_id` | string | Thumbnail file ID | -| ↳ `file_unique_id` | string | Unique thumbnail file identifier | -| ↳ `file_size` | number | Thumbnail file size in bytes | -| ↳ `width` | number | Thumbnail width in pixels | -| ↳ `height` | number | Thumbnail height in pixels | -| ↳ `file_id` | string | Document file ID | -| ↳ `file_unique_id` | string | Unique document file identifier | -| ↳ `file_size` | number | Size of document file in bytes | +| ↳ `message_id` | number | Unique Telegram message identifier | +| ↳ `from` | object | Information about the sender | +| ↳ `id` | number | Sender ID | +| ↳ `is_bot` | boolean | Whether the chat is a bot or not | +| ↳ `first_name` | string | Sender's first name \(if available\) | +| ↳ `username` | string | Sender's username \(if available\) | +| ↳ `chat` | object | Information about the chat where message was sent | +| ↳ `id` | number | Chat ID | +| ↳ `first_name` | string | Chat first name \(if private chat\) | +| ↳ `username` | string | Chat username \(for private or channels\) | +| ↳ `type` | string | Type of chat \(private, group, supergroup, or channel\) | +| ↳ `date` | number | Unix timestamp when the message was sent | +| ↳ `text` | string | Text content of the sent message \(if applicable\) | +| ↳ `format` | object | Media format information \(for videos, GIFs, etc.\) | +| ↳ `file_name` | string | Media file name | +| ↳ `mime_type` | string | Media MIME type | +| ↳ `duration` | number | Duration of media in seconds | +| ↳ `width` | number | Media width in pixels | +| ↳ `height` | number | Media height in pixels | +| ↳ `thumbnail` | object | Thumbnail image details | +| ↳ `file_id` | string | Thumbnail file ID | +| ↳ `file_unique_id` | string | Unique thumbnail file identifier | +| ↳ `file_size` | number | Thumbnail file size in bytes | +| ↳ `width` | number | Thumbnail width in pixels | +| ↳ `height` | number | Thumbnail height in pixels | +| ↳ `thumb` | object | Secondary thumbnail details \(duplicate of thumbnail\) | +| ↳ `file_id` | string | Thumbnail file ID | +| ↳ `file_unique_id` | string | Unique thumbnail file identifier | +| ↳ `file_size` | number | Thumbnail file size in bytes | +| ↳ `width` | number | Thumbnail width in pixels | +| ↳ `height` | number | Thumbnail height in pixels | +| ↳ `file_id` | string | Media file ID | +| ↳ `file_unique_id` | string | Unique media file identifier | +| ↳ `file_size` | number | Size of media file in bytes | +| ↳ `document` | object | Document file details if the message contains a document | +| ↳ `file_name` | string | Document file name | +| ↳ `mime_type` | string | Document MIME type | +| ↳ `thumbnail` | object | Document thumbnail information | +| ↳ `file_id` | string | Thumbnail file ID | +| ↳ `file_unique_id` | string | Unique thumbnail file identifier | +| ↳ `file_size` | number | Thumbnail file size in bytes | +| ↳ `width` | number | Thumbnail width in pixels | +| ↳ `height` | number | Thumbnail height in pixels | +| ↳ `thumb` | object | Duplicate thumbnail info \(used for compatibility\) | +| ↳ `file_id` | string | Thumbnail file ID | +| ↳ `file_unique_id` | string | Unique thumbnail file identifier | +| ↳ `file_size` | number | Thumbnail file size in bytes | +| ↳ `width` | number | Thumbnail width in pixels | +| ↳ `height` | number | Thumbnail height in pixels | +| ↳ `file_id` | string | Document file ID | +| ↳ `file_unique_id` | string | Unique document file identifier | +| ↳ `file_size` | number | Size of document file in bytes | ### `telegram_send_document` @@ -355,23 +355,23 @@ Send documents (PDF, ZIP, DOC, etc.) to Telegram channels or users through the T | --------- | ---- | ----------- | | `message` | string | Success or error message | | `data` | object | Telegram message data including document | -| ↳ `message_id` | number | Unique Telegram message identifier | -| ↳ `from` | object | Information about the sender | -| ↳ `id` | number | Sender ID | -| ↳ `is_bot` | boolean | Whether the chat is a bot or not | -| ↳ `first_name` | string | Sender | -| ↳ `username` | string | Sender | -| ↳ `chat` | object | Information about the chat where message was sent | -| ↳ `id` | number | Chat ID | -| ↳ `first_name` | string | Chat first name \(if private chat\) | -| ↳ `username` | string | Chat username \(for private or channels\) | -| ↳ `type` | string | Type of chat \(private, group, supergroup, or channel\) | -| ↳ `date` | number | Unix timestamp when the message was sent | -| ↳ `document` | object | Document file details | -| ↳ `file_name` | string | Document file name | -| ↳ `mime_type` | string | Document MIME type | -| ↳ `file_id` | string | Document file ID | -| ↳ `file_unique_id` | string | Unique document file identifier | -| ↳ `file_size` | number | Size of document file in bytes | +| ↳ `message_id` | number | Unique Telegram message identifier | +| ↳ `from` | object | Information about the sender | +| ↳ `id` | number | Sender ID | +| ↳ `is_bot` | boolean | Whether the chat is a bot or not | +| ↳ `first_name` | string | Sender's first name \(if available\) | +| ↳ `username` | string | Sender's username \(if available\) | +| ↳ `chat` | object | Information about the chat where message was sent | +| ↳ `id` | number | Chat ID | +| ↳ `first_name` | string | Chat first name \(if private chat\) | +| ↳ `username` | string | Chat username \(for private or channels\) | +| ↳ `type` | string | Type of chat \(private, group, supergroup, or channel\) | +| ↳ `date` | number | Unix timestamp when the message was sent | +| ↳ `document` | object | Document file details | +| ↳ `file_name` | string | Document file name | +| ↳ `mime_type` | string | Document MIME type | +| ↳ `file_id` | string | Document file ID | +| ↳ `file_unique_id` | string | Unique document file identifier | +| ↳ `file_size` | number | Size of document file in bytes | diff --git a/apps/docs/content/docs/en/tools/textract.mdx b/apps/docs/content/docs/en/tools/textract.mdx index 55024eaac..624e4e4fe 100644 --- a/apps/docs/content/docs/en/tools/textract.mdx +++ b/apps/docs/content/docs/en/tools/textract.mdx @@ -68,17 +68,17 @@ Parse documents using AWS Textract OCR and document analysis | ↳ `Confidence` | number | Confidence score \(0-100\) | | ↳ `Page` | number | Page number | | ↳ `Geometry` | object | Location and bounding box information | -| ↳ `BoundingBox` | object | Height as ratio of document height | -| ↳ `Height` | number | Height as ratio of document height | -| ↳ `Left` | number | Left position as ratio of document width | -| ↳ `Top` | number | Top position as ratio of document height | -| ↳ `Width` | number | Width as ratio of document width | -| ↳ `Polygon` | array | Polygon coordinates | -| ↳ `X` | number | X coordinate | -| ↳ `Y` | number | Y coordinate | +| ↳ `BoundingBox` | object | Height as ratio of document height | +| ↳ `Height` | number | Height as ratio of document height | +| ↳ `Left` | number | Left position as ratio of document width | +| ↳ `Top` | number | Top position as ratio of document height | +| ↳ `Width` | number | Width as ratio of document width | +| ↳ `Polygon` | array | Polygon coordinates | +| ↳ `X` | number | X coordinate | +| ↳ `Y` | number | Y coordinate | | ↳ `Relationships` | array | Relationships to other blocks | -| ↳ `Type` | string | Relationship type \(CHILD, VALUE, ANSWER, etc.\) | -| ↳ `Ids` | array | IDs of related blocks | +| ↳ `Type` | string | Relationship type \(CHILD, VALUE, ANSWER, etc.\) | +| ↳ `Ids` | array | IDs of related blocks | | ↳ `EntityTypes` | array | Entity types for KEY_VALUE_SET \(KEY or VALUE\) | | ↳ `SelectionStatus` | string | For checkboxes: SELECTED or NOT_SELECTED | | ↳ `RowIndex` | number | Row index for table cells | @@ -86,11 +86,11 @@ Parse documents using AWS Textract OCR and document analysis | ↳ `RowSpan` | number | Row span for merged cells | | ↳ `ColumnSpan` | number | Column span for merged cells | | ↳ `Query` | object | Query information for QUERY blocks | -| ↳ `Text` | string | Query text | -| ↳ `Alias` | string | Query alias | -| ↳ `Pages` | array | Pages to search | +| ↳ `Text` | string | Query text | +| ↳ `Alias` | string | Query alias | +| ↳ `Pages` | array | Pages to search | | `documentMetadata` | object | Metadata about the analyzed document | -| ↳ `pages` | number | Number of pages in the document | +| ↳ `pages` | number | Number of pages in the document | | `modelVersion` | string | Version of the Textract model used for processing | diff --git a/apps/docs/content/docs/en/tools/typeform.mdx b/apps/docs/content/docs/en/tools/typeform.mdx index de8095f46..b9456544d 100644 --- a/apps/docs/content/docs/en/tools/typeform.mdx +++ b/apps/docs/content/docs/en/tools/typeform.mdx @@ -102,19 +102,19 @@ Retrieve insights and analytics for Typeform forms | ↳ `type` | string | Field type \(e.g., short_text, multiple_choice\) | | ↳ `views` | number | Number of times this field was viewed | | `form` | object | Average completion time for this platform | -| ↳ `platforms` | array | Average completion time for this platform | -| ↳ `average_time` | number | Average completion time for this platform | -| ↳ `completion_rate` | number | Completion rate for this platform | -| ↳ `platform` | string | Platform name \(e.g., desktop, mobile\) | -| ↳ `responses_count` | number | Number of responses from this platform | -| ↳ `total_visits` | number | Total visits from this platform | -| ↳ `unique_visits` | number | Unique visits from this platform | -| ↳ `summary` | object | Overall average completion time | -| ↳ `average_time` | number | Overall average completion time | -| ↳ `completion_rate` | number | Overall completion rate | -| ↳ `responses_count` | number | Total number of responses | -| ↳ `total_visits` | number | Total number of visits | -| ↳ `unique_visits` | number | Total number of unique visits | +| ↳ `platforms` | array | Average completion time for this platform | +| ↳ `average_time` | number | Average completion time for this platform | +| ↳ `completion_rate` | number | Completion rate for this platform | +| ↳ `platform` | string | Platform name \(e.g., desktop, mobile\) | +| ↳ `responses_count` | number | Number of responses from this platform | +| ↳ `total_visits` | number | Total visits from this platform | +| ↳ `unique_visits` | number | Unique visits from this platform | +| ↳ `summary` | object | Overall average completion time | +| ↳ `average_time` | number | Overall average completion time | +| ↳ `completion_rate` | number | Overall completion rate | +| ↳ `responses_count` | number | Total number of responses | +| ↳ `total_visits` | number | Total number of visits | +| ↳ `unique_visits` | number | Total number of unique visits | ### `typeform_list_forms` diff --git a/apps/docs/content/docs/en/tools/vision.mdx b/apps/docs/content/docs/en/tools/vision.mdx index 0fb8de44e..9ba14b5c4 100644 --- a/apps/docs/content/docs/en/tools/vision.mdx +++ b/apps/docs/content/docs/en/tools/vision.mdx @@ -55,8 +55,8 @@ Process and analyze images using advanced vision models. Capable of understandin | `model` | string | The vision model that was used for analysis | | `tokens` | number | Total tokens used for the analysis | | `usage` | object | Detailed token usage breakdown | -| ↳ `input_tokens` | number | Tokens used for input processing | -| ↳ `output_tokens` | number | Tokens used for response generation | -| ↳ `total_tokens` | number | Total tokens consumed | +| ↳ `input_tokens` | number | Tokens used for input processing | +| ↳ `output_tokens` | number | Tokens used for response generation | +| ↳ `total_tokens` | number | Total tokens consumed | diff --git a/apps/docs/content/docs/en/tools/wealthbox.mdx b/apps/docs/content/docs/en/tools/wealthbox.mdx index 571501c95..c5dfdc7cf 100644 --- a/apps/docs/content/docs/en/tools/wealthbox.mdx +++ b/apps/docs/content/docs/en/tools/wealthbox.mdx @@ -50,12 +50,12 @@ Read content from a Wealthbox note | --------- | ---- | ----------- | | `success` | boolean | Operation success status | | `output` | object | Note data and metadata | -| ↳ `content` | string | Formatted note information | -| ↳ `note` | object | Raw note data from Wealthbox | -| ↳ `metadata` | object | Operation metadata | -| ↳ `itemId` | string | ID of the note | -| ↳ `noteId` | string | ID of the note | -| ↳ `itemType` | string | Type of item \(note\) | +| ↳ `content` | string | Formatted note information | +| ↳ `note` | object | Raw note data from Wealthbox | +| ↳ `metadata` | object | Operation metadata | +| ↳ `itemId` | string | ID of the note | +| ↳ `noteId` | string | ID of the note | +| ↳ `itemType` | string | Type of item \(note\) | ### `wealthbox_write_note` @@ -74,12 +74,12 @@ Create or update a Wealthbox note | --------- | ---- | ----------- | | `success` | boolean | Operation success status | | `output` | object | Created or updated note data and metadata | -| ↳ `note` | object | Raw note data from Wealthbox | -| ↳ `success` | boolean | Operation success indicator | -| ↳ `metadata` | object | Operation metadata | -| ↳ `itemId` | string | ID of the created/updated note | -| ↳ `noteId` | string | ID of the created/updated note | -| ↳ `itemType` | string | Type of item \(note\) | +| ↳ `note` | object | Raw note data from Wealthbox | +| ↳ `success` | boolean | Operation success indicator | +| ↳ `metadata` | object | Operation metadata | +| ↳ `itemId` | string | ID of the created/updated note | +| ↳ `noteId` | string | ID of the created/updated note | +| ↳ `itemType` | string | Type of item \(note\) | ### `wealthbox_read_contact` @@ -97,12 +97,12 @@ Read content from a Wealthbox contact | --------- | ---- | ----------- | | `success` | boolean | Operation success status | | `output` | object | Contact data and metadata | -| ↳ `content` | string | Formatted contact information | -| ↳ `contact` | object | Raw contact data from Wealthbox | -| ↳ `metadata` | object | Operation metadata | -| ↳ `itemId` | string | ID of the contact | -| ↳ `contactId` | string | ID of the contact | -| ↳ `itemType` | string | Type of item \(contact\) | +| ↳ `content` | string | Formatted contact information | +| ↳ `contact` | object | Raw contact data from Wealthbox | +| ↳ `metadata` | object | Operation metadata | +| ↳ `itemId` | string | ID of the contact | +| ↳ `contactId` | string | ID of the contact | +| ↳ `itemType` | string | Type of item \(contact\) | ### `wealthbox_write_contact` @@ -123,12 +123,12 @@ Create a new Wealthbox contact | --------- | ---- | ----------- | | `success` | boolean | Operation success status | | `output` | object | Created or updated contact data and metadata | -| ↳ `contact` | object | Raw contact data from Wealthbox | -| ↳ `success` | boolean | Operation success indicator | -| ↳ `metadata` | object | Operation metadata | -| ↳ `itemId` | string | ID of the created/updated contact | -| ↳ `contactId` | string | ID of the created/updated contact | -| ↳ `itemType` | string | Type of item \(contact\) | +| ↳ `contact` | object | Raw contact data from Wealthbox | +| ↳ `success` | boolean | Operation success indicator | +| ↳ `metadata` | object | Operation metadata | +| ↳ `itemId` | string | ID of the created/updated contact | +| ↳ `contactId` | string | ID of the created/updated contact | +| ↳ `itemType` | string | Type of item \(contact\) | ### `wealthbox_read_task` @@ -146,12 +146,12 @@ Read content from a Wealthbox task | --------- | ---- | ----------- | | `success` | boolean | Operation success status | | `output` | object | Task data and metadata | -| ↳ `content` | string | Formatted task information | -| ↳ `task` | object | Raw task data from Wealthbox | -| ↳ `metadata` | object | Operation metadata | -| ↳ `itemId` | string | ID of the task | -| ↳ `taskId` | string | ID of the task | -| ↳ `itemType` | string | Type of item \(task\) | +| ↳ `content` | string | Formatted task information | +| ↳ `task` | object | Raw task data from Wealthbox | +| ↳ `metadata` | object | Operation metadata | +| ↳ `itemId` | string | ID of the task | +| ↳ `taskId` | string | ID of the task | +| ↳ `itemType` | string | Type of item \(task\) | ### `wealthbox_write_task` @@ -172,11 +172,11 @@ Create or update a Wealthbox task | --------- | ---- | ----------- | | `success` | boolean | Operation success status | | `output` | object | Created or updated task data and metadata | -| ↳ `task` | object | Raw task data from Wealthbox | -| ↳ `success` | boolean | Operation success indicator | -| ↳ `metadata` | object | Operation metadata | -| ↳ `itemId` | string | ID of the created/updated task | -| ↳ `taskId` | string | ID of the created/updated task | -| ↳ `itemType` | string | Type of item \(task\) | +| ↳ `task` | object | Raw task data from Wealthbox | +| ↳ `success` | boolean | Operation success indicator | +| ↳ `metadata` | object | Operation metadata | +| ↳ `itemId` | string | ID of the created/updated task | +| ↳ `taskId` | string | ID of the created/updated task | +| ↳ `itemType` | string | Type of item \(task\) | diff --git a/apps/docs/content/docs/en/tools/webflow.mdx b/apps/docs/content/docs/en/tools/webflow.mdx index 6e53139d0..da81d3c71 100644 --- a/apps/docs/content/docs/en/tools/webflow.mdx +++ b/apps/docs/content/docs/en/tools/webflow.mdx @@ -51,8 +51,19 @@ List all items from a Webflow CMS collection | Parameter | Type | Description | | --------- | ---- | ----------- | -| `items` | json | Array of collection items | -| `metadata` | json | Metadata about the query | +| `items` | array | Array of collection items | +| ↳ `id` | string | Unique item ID | +| ↳ `cmsLocaleId` | string | CMS locale ID | +| ↳ `lastPublished` | string | Last published date \(ISO 8601\) | +| ↳ `lastUpdated` | string | Last updated date \(ISO 8601\) | +| ↳ `createdOn` | string | Creation date \(ISO 8601\) | +| ↳ `isArchived` | boolean | Whether the item is archived | +| ↳ `isDraft` | boolean | Whether the item is a draft | +| ↳ `fieldData` | object | Collection-specific field data \(varies by collection schema\) | +| `metadata` | object | Metadata about the query | +| ↳ `itemCount` | number | Number of items returned | +| ↳ `offset` | number | Pagination offset | +| ↳ `limit` | number | Maximum items per page | ### `webflow_get_item` diff --git a/apps/docs/content/docs/en/tools/wikipedia.mdx b/apps/docs/content/docs/en/tools/wikipedia.mdx index b632fc786..919f54973 100644 --- a/apps/docs/content/docs/en/tools/wikipedia.mdx +++ b/apps/docs/content/docs/en/tools/wikipedia.mdx @@ -47,12 +47,39 @@ Get a summary and metadata for a specific Wikipedia page. | Parameter | Type | Description | | --------- | ---- | ----------- | | `summary` | object | Wikipedia page summary and metadata | -| ↳ `title` | string | Page title | -| ↳ `extract` | string | Page extract/summary text | -| ↳ `description` | string | Short page description | -| ↳ `thumbnail` | object | Thumbnail image data | -| ↳ `content_urls` | object | URLs to access the page | -| ↳ `pageid` | number | Wikipedia page ID | +| ↳ `type` | string | Page type \(standard, disambiguation, etc.\) | +| ↳ `title` | string | Page title | +| ↳ `displaytitle` | string | Display title with formatting | +| ↳ `description` | string | Short page description | +| ↳ `extract` | string | Page extract/summary text | +| ↳ `extract_html` | string | Extract in HTML format | +| ↳ `thumbnail` | object | Thumbnail image data | +| ↳ `source` | string | Thumbnail image URL | +| ↳ `width` | number | Thumbnail width in pixels | +| ↳ `height` | number | Thumbnail height in pixels | +| ↳ `originalimage` | object | Original image data | +| ↳ `source` | string | Thumbnail image URL | +| ↳ `width` | number | Thumbnail width in pixels | +| ↳ `height` | number | Thumbnail height in pixels | +| ↳ `content_urls` | object | URLs to access the page | +| ↳ `desktop` | object | Desktop URLs | +| ↳ `page` | string | Page URL | +| ↳ `revisions` | string | Revisions URL | +| ↳ `edit` | string | Edit URL | +| ↳ `talk` | string | Talk page URL | +| ↳ `mobile` | object | Mobile URLs | +| ↳ `page` | string | Page URL | +| ↳ `revisions` | string | Revisions URL | +| ↳ `edit` | string | Edit URL | +| ↳ `talk` | string | Talk page URL | +| ↳ `lang` | string | Page language code | +| ↳ `dir` | string | Text direction \(ltr or rtl\) | +| ↳ `timestamp` | string | Last modification timestamp | +| ↳ `pageid` | number | Wikipedia page ID | +| ↳ `wikibase_item` | string | Wikidata item ID | +| ↳ `coordinates` | object | Geographic coordinates | +| ↳ `lat` | number | Latitude | +| ↳ `lon` | number | Longitude | ### `wikipedia_search` @@ -70,6 +97,20 @@ Search for Wikipedia pages by title or content. | Parameter | Type | Description | | --------- | ---- | ----------- | | `searchResults` | array | Array of matching Wikipedia pages | +| ↳ `id` | number | Result index | +| ↳ `key` | string | URL-friendly page key | +| ↳ `title` | string | Page title | +| ↳ `excerpt` | string | Search result excerpt | +| ↳ `matched_title` | string | Matched title variant | +| ↳ `description` | string | Page description | +| ↳ `thumbnail` | object | Thumbnail data | +| ↳ `mimetype` | string | Image MIME type | +| ↳ `size` | number | File size in bytes | +| ↳ `width` | number | Width in pixels | +| ↳ `height` | number | Height in pixels | +| ↳ `duration` | number | Duration for video | +| ↳ `url` | string | Thumbnail URL | +| ↳ `url` | string | Page URL | | `totalHits` | number | Total number of search results found | | `query` | string | The search query that was executed | @@ -88,11 +129,14 @@ Get the full HTML content of a Wikipedia page. | Parameter | Type | Description | | --------- | ---- | ----------- | | `content` | object | Full HTML content and metadata of the Wikipedia page | -| ↳ `title` | string | Page title | -| ↳ `pageid` | number | Wikipedia page ID | -| ↳ `html` | string | Full HTML content of the page | -| ↳ `revision` | number | Page revision number | -| ↳ `timestamp` | string | Last modified timestamp | +| ↳ `title` | string | Page title | +| ↳ `pageid` | number | Wikipedia page ID | +| ↳ `html` | string | Full HTML content of the page | +| ↳ `revision` | number | Page revision number | +| ↳ `tid` | string | Transaction ID \(ETag\) | +| ↳ `timestamp` | string | Last modified timestamp | +| ↳ `content_model` | string | Content model \(wikitext\) | +| ↳ `content_format` | string | Content format \(text/html\) | ### `wikipedia_random` @@ -108,10 +152,22 @@ Get a random Wikipedia page. | Parameter | Type | Description | | --------- | ---- | ----------- | | `randomPage` | object | Random Wikipedia page data | -| ↳ `title` | string | Page title | -| ↳ `extract` | string | Page extract/summary | -| ↳ `description` | string | Page description | -| ↳ `thumbnail` | object | Thumbnail image data | -| ↳ `content_urls` | object | URLs to access the page | +| ↳ `type` | string | Page type | +| ↳ `title` | string | Page title | +| ↳ `displaytitle` | string | Display title | +| ↳ `description` | string | Page description | +| ↳ `extract` | string | Page extract/summary | +| ↳ `thumbnail` | object | Thumbnail image data | +| ↳ `source` | string | Thumbnail image URL | +| ↳ `width` | number | Thumbnail width in pixels | +| ↳ `height` | number | Thumbnail height in pixels | +| ↳ `content_urls` | object | URLs to access the page | +| ↳ `desktop` | object | Desktop URL | +| ↳ `page` | string | Page URL | +| ↳ `mobile` | object | Mobile URL | +| ↳ `page` | string | Page URL | +| ↳ `lang` | string | Language code | +| ↳ `timestamp` | string | Timestamp | +| ↳ `pageid` | number | Page ID | diff --git a/apps/docs/content/docs/en/tools/wordpress.mdx b/apps/docs/content/docs/en/tools/wordpress.mdx index 31d57721c..92ebab38f 100644 --- a/apps/docs/content/docs/en/tools/wordpress.mdx +++ b/apps/docs/content/docs/en/tools/wordpress.mdx @@ -50,20 +50,20 @@ Create a new blog post in WordPress.com | Parameter | Type | Description | | --------- | ---- | ----------- | | `post` | object | The created post | -| ↳ `id` | number | Post ID | -| ↳ `date` | string | Post creation date | -| ↳ `modified` | string | Post modification date | -| ↳ `slug` | string | Post slug | -| ↳ `status` | string | Post status | -| ↳ `type` | string | Post type | -| ↳ `link` | string | Post URL | -| ↳ `title` | object | Post title object | -| ↳ `content` | object | Post content object | -| ↳ `excerpt` | object | Post excerpt object | -| ↳ `author` | number | Author ID | -| ↳ `featured_media` | number | Featured media ID | -| ↳ `categories` | array | Category IDs | -| ↳ `tags` | array | Tag IDs | +| ↳ `id` | number | Post ID | +| ↳ `date` | string | Post creation date | +| ↳ `modified` | string | Post modification date | +| ↳ `slug` | string | Post slug | +| ↳ `status` | string | Post status | +| ↳ `type` | string | Post type | +| ↳ `link` | string | Post URL | +| ↳ `title` | object | Post title object | +| ↳ `content` | object | Post content object | +| ↳ `excerpt` | object | Post excerpt object | +| ↳ `author` | number | Author ID | +| ↳ `featured_media` | number | Featured media ID | +| ↳ `categories` | array | Category IDs | +| ↳ `tags` | array | Tag IDs | ### `wordpress_update_post` @@ -89,20 +89,20 @@ Update an existing blog post in WordPress.com | Parameter | Type | Description | | --------- | ---- | ----------- | | `post` | object | The updated post | -| ↳ `id` | number | Post ID | -| ↳ `date` | string | Post creation date | -| ↳ `modified` | string | Post modification date | -| ↳ `slug` | string | Post slug | -| ↳ `status` | string | Post status | -| ↳ `type` | string | Post type | -| ↳ `link` | string | Post URL | -| ↳ `title` | object | Post title object | -| ↳ `content` | object | Post content object | -| ↳ `excerpt` | object | Post excerpt object | -| ↳ `author` | number | Author ID | -| ↳ `featured_media` | number | Featured media ID | -| ↳ `categories` | array | Category IDs | -| ↳ `tags` | array | Tag IDs | +| ↳ `id` | number | Post ID | +| ↳ `date` | string | Post creation date | +| ↳ `modified` | string | Post modification date | +| ↳ `slug` | string | Post slug | +| ↳ `status` | string | Post status | +| ↳ `type` | string | Post type | +| ↳ `link` | string | Post URL | +| ↳ `title` | object | Post title object | +| ↳ `content` | object | Post content object | +| ↳ `excerpt` | object | Post excerpt object | +| ↳ `author` | number | Author ID | +| ↳ `featured_media` | number | Featured media ID | +| ↳ `categories` | array | Category IDs | +| ↳ `tags` | array | Tag IDs | ### `wordpress_delete_post` @@ -122,20 +122,20 @@ Delete a blog post from WordPress.com | --------- | ---- | ----------- | | `deleted` | boolean | Whether the post was deleted | | `post` | object | The deleted post | -| ↳ `id` | number | Post ID | -| ↳ `date` | string | Post creation date | -| ↳ `modified` | string | Post modification date | -| ↳ `slug` | string | Post slug | -| ↳ `status` | string | Post status | -| ↳ `type` | string | Post type | -| ↳ `link` | string | Post URL | -| ↳ `title` | object | Post title object | -| ↳ `content` | object | Post content object | -| ↳ `excerpt` | object | Post excerpt object | -| ↳ `author` | number | Author ID | -| ↳ `featured_media` | number | Featured media ID | -| ↳ `categories` | array | Category IDs | -| ↳ `tags` | array | Tag IDs | +| ↳ `id` | number | Post ID | +| ↳ `date` | string | Post creation date | +| ↳ `modified` | string | Post modification date | +| ↳ `slug` | string | Post slug | +| ↳ `status` | string | Post status | +| ↳ `type` | string | Post type | +| ↳ `link` | string | Post URL | +| ↳ `title` | object | Post title object | +| ↳ `content` | object | Post content object | +| ↳ `excerpt` | object | Post excerpt object | +| ↳ `author` | number | Author ID | +| ↳ `featured_media` | number | Featured media ID | +| ↳ `categories` | array | Category IDs | +| ↳ `tags` | array | Tag IDs | ### `wordpress_get_post` @@ -153,20 +153,20 @@ Get a single blog post from WordPress.com by ID | Parameter | Type | Description | | --------- | ---- | ----------- | | `post` | object | The retrieved post | -| ↳ `id` | number | Post ID | -| ↳ `date` | string | Post creation date | -| ↳ `modified` | string | Post modification date | -| ↳ `slug` | string | Post slug | -| ↳ `status` | string | Post status | -| ↳ `type` | string | Post type | -| ↳ `link` | string | Post URL | -| ↳ `title` | object | Post title object | -| ↳ `content` | object | Post content object | -| ↳ `excerpt` | object | Post excerpt object | -| ↳ `author` | number | Author ID | -| ↳ `featured_media` | number | Featured media ID | -| ↳ `categories` | array | Category IDs | -| ↳ `tags` | array | Tag IDs | +| ↳ `id` | number | Post ID | +| ↳ `date` | string | Post creation date | +| ↳ `modified` | string | Post modification date | +| ↳ `slug` | string | Post slug | +| ↳ `status` | string | Post status | +| ↳ `type` | string | Post type | +| ↳ `link` | string | Post URL | +| ↳ `title` | object | Post title object | +| ↳ `content` | object | Post content object | +| ↳ `excerpt` | object | Post excerpt object | +| ↳ `author` | number | Author ID | +| ↳ `featured_media` | number | Featured media ID | +| ↳ `categories` | array | Category IDs | +| ↳ `tags` | array | Tag IDs | ### `wordpress_list_posts` @@ -232,20 +232,20 @@ Create a new page in WordPress.com | Parameter | Type | Description | | --------- | ---- | ----------- | | `page` | object | The created page | -| ↳ `id` | number | Page ID | -| ↳ `date` | string | Page creation date | -| ↳ `modified` | string | Page modification date | -| ↳ `slug` | string | Page slug | -| ↳ `status` | string | Page status | -| ↳ `type` | string | Content type | -| ↳ `link` | string | Page URL | -| ↳ `title` | object | Page title object | -| ↳ `content` | object | Page content object | -| ↳ `excerpt` | object | Page excerpt object | -| ↳ `author` | number | Author ID | -| ↳ `featured_media` | number | Featured media ID | -| ↳ `parent` | number | Parent page ID | -| ↳ `menu_order` | number | Menu order | +| ↳ `id` | number | Page ID | +| ↳ `date` | string | Page creation date | +| ↳ `modified` | string | Page modification date | +| ↳ `slug` | string | Page slug | +| ↳ `status` | string | Page status | +| ↳ `type` | string | Content type | +| ↳ `link` | string | Page URL | +| ↳ `title` | object | Page title object | +| ↳ `content` | object | Page content object | +| ↳ `excerpt` | object | Page excerpt object | +| ↳ `author` | number | Author ID | +| ↳ `featured_media` | number | Featured media ID | +| ↳ `parent` | number | Parent page ID | +| ↳ `menu_order` | number | Menu order | ### `wordpress_update_page` @@ -271,20 +271,20 @@ Update an existing page in WordPress.com | Parameter | Type | Description | | --------- | ---- | ----------- | | `page` | object | The updated page | -| ↳ `id` | number | Page ID | -| ↳ `date` | string | Page creation date | -| ↳ `modified` | string | Page modification date | -| ↳ `slug` | string | Page slug | -| ↳ `status` | string | Page status | -| ↳ `type` | string | Content type | -| ↳ `link` | string | Page URL | -| ↳ `title` | object | Page title object | -| ↳ `content` | object | Page content object | -| ↳ `excerpt` | object | Page excerpt object | -| ↳ `author` | number | Author ID | -| ↳ `featured_media` | number | Featured media ID | -| ↳ `parent` | number | Parent page ID | -| ↳ `menu_order` | number | Menu order | +| ↳ `id` | number | Page ID | +| ↳ `date` | string | Page creation date | +| ↳ `modified` | string | Page modification date | +| ↳ `slug` | string | Page slug | +| ↳ `status` | string | Page status | +| ↳ `type` | string | Content type | +| ↳ `link` | string | Page URL | +| ↳ `title` | object | Page title object | +| ↳ `content` | object | Page content object | +| ↳ `excerpt` | object | Page excerpt object | +| ↳ `author` | number | Author ID | +| ↳ `featured_media` | number | Featured media ID | +| ↳ `parent` | number | Parent page ID | +| ↳ `menu_order` | number | Menu order | ### `wordpress_delete_page` @@ -304,20 +304,20 @@ Delete a page from WordPress.com | --------- | ---- | ----------- | | `deleted` | boolean | Whether the page was deleted | | `page` | object | The deleted page | -| ↳ `id` | number | Page ID | -| ↳ `date` | string | Page creation date | -| ↳ `modified` | string | Page modification date | -| ↳ `slug` | string | Page slug | -| ↳ `status` | string | Page status | -| ↳ `type` | string | Content type | -| ↳ `link` | string | Page URL | -| ↳ `title` | object | Page title object | -| ↳ `content` | object | Page content object | -| ↳ `excerpt` | object | Page excerpt object | -| ↳ `author` | number | Author ID | -| ↳ `featured_media` | number | Featured media ID | -| ↳ `parent` | number | Parent page ID | -| ↳ `menu_order` | number | Menu order | +| ↳ `id` | number | Page ID | +| ↳ `date` | string | Page creation date | +| ↳ `modified` | string | Page modification date | +| ↳ `slug` | string | Page slug | +| ↳ `status` | string | Page status | +| ↳ `type` | string | Content type | +| ↳ `link` | string | Page URL | +| ↳ `title` | object | Page title object | +| ↳ `content` | object | Page content object | +| ↳ `excerpt` | object | Page excerpt object | +| ↳ `author` | number | Author ID | +| ↳ `featured_media` | number | Featured media ID | +| ↳ `parent` | number | Parent page ID | +| ↳ `menu_order` | number | Menu order | ### `wordpress_get_page` @@ -335,20 +335,20 @@ Get a single page from WordPress.com by ID | Parameter | Type | Description | | --------- | ---- | ----------- | | `page` | object | The retrieved page | -| ↳ `id` | number | Page ID | -| ↳ `date` | string | Page creation date | -| ↳ `modified` | string | Page modification date | -| ↳ `slug` | string | Page slug | -| ↳ `status` | string | Page status | -| ↳ `type` | string | Content type | -| ↳ `link` | string | Page URL | -| ↳ `title` | object | Page title object | -| ↳ `content` | object | Page content object | -| ↳ `excerpt` | object | Page excerpt object | -| ↳ `author` | number | Author ID | -| ↳ `featured_media` | number | Featured media ID | -| ↳ `parent` | number | Parent page ID | -| ↳ `menu_order` | number | Menu order | +| ↳ `id` | number | Page ID | +| ↳ `date` | string | Page creation date | +| ↳ `modified` | string | Page modification date | +| ↳ `slug` | string | Page slug | +| ↳ `status` | string | Page status | +| ↳ `type` | string | Content type | +| ↳ `link` | string | Page URL | +| ↳ `title` | object | Page title object | +| ↳ `content` | object | Page content object | +| ↳ `excerpt` | object | Page excerpt object | +| ↳ `author` | number | Author ID | +| ↳ `featured_media` | number | Featured media ID | +| ↳ `parent` | number | Parent page ID | +| ↳ `menu_order` | number | Menu order | ### `wordpress_list_pages` @@ -410,18 +410,18 @@ Upload a media file (image, video, document) to WordPress.com | Parameter | Type | Description | | --------- | ---- | ----------- | | `media` | object | The uploaded media item | -| ↳ `id` | number | Media ID | -| ↳ `date` | string | Upload date | -| ↳ `slug` | string | Media slug | -| ↳ `type` | string | Content type | -| ↳ `link` | string | Media page URL | -| ↳ `title` | object | Media title object | -| ↳ `caption` | object | Media caption object | -| ↳ `alt_text` | string | Alt text | -| ↳ `media_type` | string | Media type \(image, video, etc.\) | -| ↳ `mime_type` | string | MIME type | -| ↳ `source_url` | string | Direct URL to the media file | -| ↳ `media_details` | object | Media details \(dimensions, etc.\) | +| ↳ `id` | number | Media ID | +| ↳ `date` | string | Upload date | +| ↳ `slug` | string | Media slug | +| ↳ `type` | string | Content type | +| ↳ `link` | string | Media page URL | +| ↳ `title` | object | Media title object | +| ↳ `caption` | object | Media caption object | +| ↳ `alt_text` | string | Alt text | +| ↳ `media_type` | string | Media type \(image, video, etc.\) | +| ↳ `mime_type` | string | MIME type | +| ↳ `source_url` | string | Direct URL to the media file | +| ↳ `media_details` | object | Media details \(dimensions, etc.\) | ### `wordpress_get_media` @@ -439,18 +439,18 @@ Get a single media item from WordPress.com by ID | Parameter | Type | Description | | --------- | ---- | ----------- | | `media` | object | The retrieved media item | -| ↳ `id` | number | Media ID | -| ↳ `date` | string | Upload date | -| ↳ `slug` | string | Media slug | -| ↳ `type` | string | Content type | -| ↳ `link` | string | Media page URL | -| ↳ `title` | object | Media title object | -| ↳ `caption` | object | Media caption object | -| ↳ `alt_text` | string | Alt text | -| ↳ `media_type` | string | Media type \(image, video, etc.\) | -| ↳ `mime_type` | string | MIME type | -| ↳ `source_url` | string | Direct URL to the media file | -| ↳ `media_details` | object | Media details \(dimensions, etc.\) | +| ↳ `id` | number | Media ID | +| ↳ `date` | string | Upload date | +| ↳ `slug` | string | Media slug | +| ↳ `type` | string | Content type | +| ↳ `link` | string | Media page URL | +| ↳ `title` | object | Media title object | +| ↳ `caption` | object | Media caption object | +| ↳ `alt_text` | string | Alt text | +| ↳ `media_type` | string | Media type \(image, video, etc.\) | +| ↳ `mime_type` | string | MIME type | +| ↳ `source_url` | string | Direct URL to the media file | +| ↳ `media_details` | object | Media details \(dimensions, etc.\) | ### `wordpress_list_media` @@ -507,18 +507,18 @@ Delete a media item from WordPress.com | --------- | ---- | ----------- | | `deleted` | boolean | Whether the media was deleted | | `media` | object | The deleted media item | -| ↳ `id` | number | Media ID | -| ↳ `date` | string | Upload date | -| ↳ `slug` | string | Media slug | -| ↳ `type` | string | Content type | -| ↳ `link` | string | Media page URL | -| ↳ `title` | object | Media title object | -| ↳ `caption` | object | Media caption object | -| ↳ `alt_text` | string | Alt text | -| ↳ `media_type` | string | Media type \(image, video, etc.\) | -| ↳ `mime_type` | string | MIME type | -| ↳ `source_url` | string | Direct URL to the media file | -| ↳ `media_details` | object | Media details \(dimensions, etc.\) | +| ↳ `id` | number | Media ID | +| ↳ `date` | string | Upload date | +| ↳ `slug` | string | Media slug | +| ↳ `type` | string | Content type | +| ↳ `link` | string | Media page URL | +| ↳ `title` | object | Media title object | +| ↳ `caption` | object | Media caption object | +| ↳ `alt_text` | string | Alt text | +| ↳ `media_type` | string | Media type \(image, video, etc.\) | +| ↳ `mime_type` | string | MIME type | +| ↳ `source_url` | string | Direct URL to the media file | +| ↳ `media_details` | object | Media details \(dimensions, etc.\) | ### `wordpress_create_comment` @@ -541,17 +541,17 @@ Create a new comment on a WordPress.com post | Parameter | Type | Description | | --------- | ---- | ----------- | | `comment` | object | The created comment | -| ↳ `id` | number | Comment ID | -| ↳ `post` | number | Post ID | -| ↳ `parent` | number | Parent comment ID | -| ↳ `author` | number | Author user ID | -| ↳ `author_name` | string | Author display name | -| ↳ `author_email` | string | Author email | -| ↳ `author_url` | string | Author URL | -| ↳ `date` | string | Comment date | -| ↳ `content` | object | Comment content object | -| ↳ `link` | string | Comment permalink | -| ↳ `status` | string | Comment status | +| ↳ `id` | number | Comment ID | +| ↳ `post` | number | Post ID | +| ↳ `parent` | number | Parent comment ID | +| ↳ `author` | number | Author user ID | +| ↳ `author_name` | string | Author display name | +| ↳ `author_email` | string | Author email | +| ↳ `author_url` | string | Author URL | +| ↳ `date` | string | Comment date | +| ↳ `content` | object | Comment content object | +| ↳ `link` | string | Comment permalink | +| ↳ `status` | string | Comment status | ### `wordpress_list_comments` @@ -607,17 +607,17 @@ Update a comment in WordPress.com (content or status) | Parameter | Type | Description | | --------- | ---- | ----------- | | `comment` | object | The updated comment | -| ↳ `id` | number | Comment ID | -| ↳ `post` | number | Post ID | -| ↳ `parent` | number | Parent comment ID | -| ↳ `author` | number | Author user ID | -| ↳ `author_name` | string | Author display name | -| ↳ `author_email` | string | Author email | -| ↳ `author_url` | string | Author URL | -| ↳ `date` | string | Comment date | -| ↳ `content` | object | Comment content object | -| ↳ `link` | string | Comment permalink | -| ↳ `status` | string | Comment status | +| ↳ `id` | number | Comment ID | +| ↳ `post` | number | Post ID | +| ↳ `parent` | number | Parent comment ID | +| ↳ `author` | number | Author user ID | +| ↳ `author_name` | string | Author display name | +| ↳ `author_email` | string | Author email | +| ↳ `author_url` | string | Author URL | +| ↳ `date` | string | Comment date | +| ↳ `content` | object | Comment content object | +| ↳ `link` | string | Comment permalink | +| ↳ `status` | string | Comment status | ### `wordpress_delete_comment` @@ -637,17 +637,17 @@ Delete a comment from WordPress.com | --------- | ---- | ----------- | | `deleted` | boolean | Whether the comment was deleted | | `comment` | object | The deleted comment | -| ↳ `id` | number | Comment ID | -| ↳ `post` | number | Post ID | -| ↳ `parent` | number | Parent comment ID | -| ↳ `author` | number | Author user ID | -| ↳ `author_name` | string | Author display name | -| ↳ `author_email` | string | Author email | -| ↳ `author_url` | string | Author URL | -| ↳ `date` | string | Comment date | -| ↳ `content` | object | Comment content object | -| ↳ `link` | string | Comment permalink | -| ↳ `status` | string | Comment status | +| ↳ `id` | number | Comment ID | +| ↳ `post` | number | Post ID | +| ↳ `parent` | number | Parent comment ID | +| ↳ `author` | number | Author user ID | +| ↳ `author_name` | string | Author display name | +| ↳ `author_email` | string | Author email | +| ↳ `author_url` | string | Author URL | +| ↳ `date` | string | Comment date | +| ↳ `content` | object | Comment content object | +| ↳ `link` | string | Comment permalink | +| ↳ `status` | string | Comment status | ### `wordpress_create_category` @@ -668,14 +668,14 @@ Create a new category in WordPress.com | Parameter | Type | Description | | --------- | ---- | ----------- | | `category` | object | The created category | -| ↳ `id` | number | Category ID | -| ↳ `count` | number | Number of posts in this category | -| ↳ `description` | string | Category description | -| ↳ `link` | string | Category archive URL | -| ↳ `name` | string | Category name | -| ↳ `slug` | string | Category slug | -| ↳ `taxonomy` | string | Taxonomy name | -| ↳ `parent` | number | Parent category ID | +| ↳ `id` | number | Category ID | +| ↳ `count` | number | Number of posts in this category | +| ↳ `description` | string | Category description | +| ↳ `link` | string | Category archive URL | +| ↳ `name` | string | Category name | +| ↳ `slug` | string | Category slug | +| ↳ `taxonomy` | string | Taxonomy name | +| ↳ `parent` | number | Parent category ID | ### `wordpress_list_categories` @@ -725,13 +725,13 @@ Create a new tag in WordPress.com | Parameter | Type | Description | | --------- | ---- | ----------- | | `tag` | object | The created tag | -| ↳ `id` | number | Tag ID | -| ↳ `count` | number | Number of posts with this tag | -| ↳ `description` | string | Tag description | -| ↳ `link` | string | Tag archive URL | -| ↳ `name` | string | Tag name | -| ↳ `slug` | string | Tag slug | -| ↳ `taxonomy` | string | Taxonomy name | +| ↳ `id` | number | Tag ID | +| ↳ `count` | number | Number of posts with this tag | +| ↳ `description` | string | Tag description | +| ↳ `link` | string | Tag archive URL | +| ↳ `name` | string | Tag name | +| ↳ `slug` | string | Tag slug | +| ↳ `taxonomy` | string | Taxonomy name | ### `wordpress_list_tags` @@ -777,18 +777,18 @@ Get information about the currently authenticated WordPress.com user | Parameter | Type | Description | | --------- | ---- | ----------- | | `user` | object | The current user | -| ↳ `id` | number | User ID | -| ↳ `username` | string | Username | -| ↳ `name` | string | Display name | -| ↳ `first_name` | string | First name | -| ↳ `last_name` | string | Last name | -| ↳ `email` | string | Email address | -| ↳ `url` | string | User website URL | -| ↳ `description` | string | User bio | -| ↳ `link` | string | Author archive URL | -| ↳ `slug` | string | User slug | -| ↳ `roles` | array | User roles | -| ↳ `avatar_urls` | object | Avatar URLs at different sizes | +| ↳ `id` | number | User ID | +| ↳ `username` | string | Username | +| ↳ `name` | string | Display name | +| ↳ `first_name` | string | First name | +| ↳ `last_name` | string | Last name | +| ↳ `email` | string | Email address | +| ↳ `url` | string | User website URL | +| ↳ `description` | string | User bio | +| ↳ `link` | string | Author archive URL | +| ↳ `slug` | string | User slug | +| ↳ `roles` | array | User roles | +| ↳ `avatar_urls` | object | Avatar URLs at different sizes | ### `wordpress_list_users` @@ -841,18 +841,18 @@ Get a specific user from WordPress.com by ID | Parameter | Type | Description | | --------- | ---- | ----------- | | `user` | object | The retrieved user | -| ↳ `id` | number | User ID | -| ↳ `username` | string | Username | -| ↳ `name` | string | Display name | -| ↳ `first_name` | string | First name | -| ↳ `last_name` | string | Last name | -| ↳ `email` | string | Email address | -| ↳ `url` | string | User website URL | -| ↳ `description` | string | User bio | -| ↳ `link` | string | Author archive URL | -| ↳ `slug` | string | User slug | -| ↳ `roles` | array | User roles | -| ↳ `avatar_urls` | object | Avatar URLs at different sizes | +| ↳ `id` | number | User ID | +| ↳ `username` | string | Username | +| ↳ `name` | string | Display name | +| ↳ `first_name` | string | First name | +| ↳ `last_name` | string | Last name | +| ↳ `email` | string | Email address | +| ↳ `url` | string | User website URL | +| ↳ `description` | string | User bio | +| ↳ `link` | string | Author archive URL | +| ↳ `slug` | string | User slug | +| ↳ `roles` | array | User roles | +| ↳ `avatar_urls` | object | Avatar URLs at different sizes | ### `wordpress_search_content` diff --git a/apps/docs/content/docs/en/tools/x.mdx b/apps/docs/content/docs/en/tools/x.mdx index 8db8e2470..0255c5755 100644 --- a/apps/docs/content/docs/en/tools/x.mdx +++ b/apps/docs/content/docs/en/tools/x.mdx @@ -53,14 +53,14 @@ Post new tweets, reply to tweets, or create polls on X (Twitter) | Parameter | Type | Description | | --------- | ---- | ----------- | | `tweet` | object | The newly created tweet data | -| ↳ `id` | string | Tweet ID | -| ↳ `text` | string | Tweet content text | -| ↳ `createdAt` | string | Tweet creation timestamp | -| ↳ `authorId` | string | ID of the tweet author | -| ↳ `conversationId` | string | Conversation thread ID | -| ↳ `attachments` | object | Media or poll attachments | -| ↳ `mediaKeys` | array | Media attachment keys | -| ↳ `pollId` | string | Poll ID if poll attached | +| ↳ `id` | string | Tweet ID | +| ↳ `text` | string | Tweet content text | +| ↳ `createdAt` | string | Tweet creation timestamp | +| ↳ `authorId` | string | ID of the tweet author | +| ↳ `conversationId` | string | Conversation thread ID | +| ↳ `attachments` | object | Media or poll attachments | +| ↳ `mediaKeys` | array | Media attachment keys | +| ↳ `pollId` | string | Poll ID if poll attached | ### `x_read` @@ -78,10 +78,10 @@ Read tweet details, including replies and conversation context | Parameter | Type | Description | | --------- | ---- | ----------- | | `tweet` | object | The main tweet data | -| ↳ `id` | string | Tweet ID | -| ↳ `text` | string | Tweet content text | -| ↳ `createdAt` | string | Tweet creation timestamp | -| ↳ `authorId` | string | ID of the tweet author | +| ↳ `id` | string | Tweet ID | +| ↳ `text` | string | Tweet content text | +| ↳ `createdAt` | string | Tweet creation timestamp | +| ↳ `authorId` | string | ID of the tweet author | | `context` | object | Conversation context including parent and root tweets | ### `x_search` @@ -109,9 +109,9 @@ Search for tweets using keywords, hashtags, or advanced queries | ↳ `authorId` | string | Author user ID | | `includes` | object | Additional data including user profiles and media | | `meta` | object | Search metadata including result count and pagination tokens | -| ↳ `resultCount` | number | Number of results returned | -| ↳ `newestId` | string | ID of the newest tweet | -| ↳ `oldestId` | string | ID of the oldest tweet | +| ↳ `resultCount` | number | Number of results returned | +| ↳ `newestId` | string | ID of the newest tweet | +| ↳ `oldestId` | string | ID of the oldest tweet | ### `x_user` @@ -128,14 +128,14 @@ Get user profile information | Parameter | Type | Description | | --------- | ---- | ----------- | | `user` | object | X user profile information | -| ↳ `id` | string | User ID | -| ↳ `username` | string | Username without @ symbol | -| ↳ `name` | string | Display name | -| ↳ `description` | string | User bio/description | -| ↳ `verified` | boolean | Whether the user is verified | -| ↳ `metrics` | object | User statistics | -| ↳ `followersCount` | number | Number of followers | -| ↳ `followingCount` | number | Number of users following | -| ↳ `tweetCount` | number | Total number of tweets | +| ↳ `id` | string | User ID | +| ↳ `username` | string | Username without @ symbol | +| ↳ `name` | string | Display name | +| ↳ `description` | string | User bio/description | +| ↳ `verified` | boolean | Whether the user is verified | +| ↳ `metrics` | object | User statistics | +| ↳ `followersCount` | number | Number of followers | +| ↳ `followingCount` | number | Number of users following | +| ↳ `tweetCount` | number | Total number of tweets | diff --git a/apps/docs/content/docs/en/tools/zendesk.mdx b/apps/docs/content/docs/en/tools/zendesk.mdx index bf647431a..c7eeb65d3 100644 --- a/apps/docs/content/docs/en/tools/zendesk.mdx +++ b/apps/docs/content/docs/en/tools/zendesk.mdx @@ -77,13 +77,65 @@ Retrieve a list of tickets from Zendesk with optional filtering | Parameter | Type | Description | | --------- | ---- | ----------- | | `tickets` | array | Array of ticket objects | +| ↳ `id` | number | Automatically assigned ticket ID | +| ↳ `url` | string | API URL of the ticket | +| ↳ `external_id` | string | External ID for linking to external records | +| ↳ `via` | object | How the ticket was created | +| ↳ `channel` | string | Channel through which the ticket was created \(e.g., email, web, api\) | +| ↳ `source` | object | Source details for the channel | +| ↳ `from` | object | Information about the source sender | +| ↳ `address` | string | Email address or other identifier | +| ↳ `name` | string | Name of the sender | +| ↳ `to` | object | Information about the recipient | +| ↳ `address` | string | Email address or other identifier | +| ↳ `name` | string | Name of the recipient | +| ↳ `rel` | string | Relationship type | +| ↳ `created_at` | string | When the ticket was created \(ISO 8601 format\) | +| ↳ `updated_at` | string | When the ticket was last updated \(ISO 8601 format\) | +| ↳ `type` | string | Ticket type \(problem, incident, question, task\) | +| ↳ `subject` | string | Subject of the ticket | +| ↳ `raw_subject` | string | Subject of the ticket as entered by the requester | +| ↳ `description` | string | Read-only first comment on the ticket | +| ↳ `priority` | string | Priority level \(low, normal, high, urgent\) | +| ↳ `status` | string | Ticket status \(new, open, pending, hold, solved, closed\) | +| ↳ `recipient` | string | Original recipient email address | +| ↳ `requester_id` | number | User ID of the ticket requester | +| ↳ `submitter_id` | number | User ID of the ticket submitter | +| ↳ `assignee_id` | number | User ID of the agent assigned to the ticket | +| ↳ `organization_id` | number | Organization ID of the requester | +| ↳ `group_id` | number | Group ID assigned to the ticket | +| ↳ `collaborator_ids` | array | User IDs of collaborators \(CC\) | +| ↳ `follower_ids` | array | User IDs of followers | +| ↳ `email_cc_ids` | array | User IDs of email CCs | +| ↳ `forum_topic_id` | number | Topic ID in the community forum | +| ↳ `problem_id` | number | For incident tickets, the ID of the associated problem ticket | +| ↳ `has_incidents` | boolean | Whether the ticket has incident tickets linked | +| ↳ `is_public` | boolean | Whether the first comment is public | +| ↳ `due_at` | string | Due date for task tickets \(ISO 8601 format\) | +| ↳ `tags` | array | Tags associated with the ticket | +| ↳ `custom_fields` | array | Custom ticket fields | +| ↳ `id` | number | Custom field ID | +| ↳ `value` | string | Custom field value | +| ↳ `custom_status_id` | number | Custom status ID | +| ↳ `satisfaction_rating` | object | Customer satisfaction rating | +| ↳ `id` | number | Satisfaction rating ID | +| ↳ `score` | string | Rating score \(e.g., good, bad, offered, unoffered\) | +| ↳ `comment` | string | Comment left with the rating | +| ↳ `sharing_agreement_ids` | array | Sharing agreement IDs | +| ↳ `followup_ids` | array | IDs of follow-up tickets | +| ↳ `brand_id` | number | Brand ID the ticket belongs to | +| ↳ `allow_attachments` | boolean | Whether attachments are allowed | +| ↳ `allow_channelback` | boolean | Whether channelback is enabled | +| ↳ `from_messaging_channel` | boolean | Whether the ticket originated from a messaging channel | +| ↳ `ticket_form_id` | number | Ticket form ID | +| ↳ `generated_timestamp` | number | Unix timestamp of the ticket generation | | `paging` | object | Pagination information | -| ↳ `next_page` | string | URL for next page of results | -| ↳ `previous_page` | string | URL for previous page of results | -| ↳ `count` | number | Total count of tickets | +| ↳ `next_page` | string | URL for next page of results | +| ↳ `previous_page` | string | URL for previous page of results | +| ↳ `count` | number | Total count of items | | `metadata` | object | Response metadata | -| ↳ `total_returned` | number | Number of tickets returned in this response | -| ↳ `has_more` | boolean | Whether more tickets are available | +| ↳ `total_returned` | number | Number of items returned in this response | +| ↳ `has_more` | boolean | Whether more items are available | ### `zendesk_get_ticket` @@ -103,6 +155,58 @@ Get a single ticket by ID from Zendesk | Parameter | Type | Description | | --------- | ---- | ----------- | | `ticket` | object | Ticket object | +| ↳ `id` | number | Automatically assigned ticket ID | +| ↳ `url` | string | API URL of the ticket | +| ↳ `external_id` | string | External ID for linking to external records | +| ↳ `via` | object | How the ticket was created | +| ↳ `channel` | string | Channel through which the ticket was created \(e.g., email, web, api\) | +| ↳ `source` | object | Source details for the channel | +| ↳ `from` | object | Information about the source sender | +| ↳ `address` | string | Email address or other identifier | +| ↳ `name` | string | Name of the sender | +| ↳ `to` | object | Information about the recipient | +| ↳ `address` | string | Email address or other identifier | +| ↳ `name` | string | Name of the recipient | +| ↳ `rel` | string | Relationship type | +| ↳ `created_at` | string | When the ticket was created \(ISO 8601 format\) | +| ↳ `updated_at` | string | When the ticket was last updated \(ISO 8601 format\) | +| ↳ `type` | string | Ticket type \(problem, incident, question, task\) | +| ↳ `subject` | string | Subject of the ticket | +| ↳ `raw_subject` | string | Subject of the ticket as entered by the requester | +| ↳ `description` | string | Read-only first comment on the ticket | +| ↳ `priority` | string | Priority level \(low, normal, high, urgent\) | +| ↳ `status` | string | Ticket status \(new, open, pending, hold, solved, closed\) | +| ↳ `recipient` | string | Original recipient email address | +| ↳ `requester_id` | number | User ID of the ticket requester | +| ↳ `submitter_id` | number | User ID of the ticket submitter | +| ↳ `assignee_id` | number | User ID of the agent assigned to the ticket | +| ↳ `organization_id` | number | Organization ID of the requester | +| ↳ `group_id` | number | Group ID assigned to the ticket | +| ↳ `collaborator_ids` | array | User IDs of collaborators \(CC\) | +| ↳ `follower_ids` | array | User IDs of followers | +| ↳ `email_cc_ids` | array | User IDs of email CCs | +| ↳ `forum_topic_id` | number | Topic ID in the community forum | +| ↳ `problem_id` | number | For incident tickets, the ID of the associated problem ticket | +| ↳ `has_incidents` | boolean | Whether the ticket has incident tickets linked | +| ↳ `is_public` | boolean | Whether the first comment is public | +| ↳ `due_at` | string | Due date for task tickets \(ISO 8601 format\) | +| ↳ `tags` | array | Tags associated with the ticket | +| ↳ `custom_fields` | array | Custom ticket fields | +| ↳ `id` | number | Custom field ID | +| ↳ `value` | string | Custom field value | +| ↳ `custom_status_id` | number | Custom status ID | +| ↳ `satisfaction_rating` | object | Customer satisfaction rating | +| ↳ `id` | number | Satisfaction rating ID | +| ↳ `score` | string | Rating score \(e.g., good, bad, offered, unoffered\) | +| ↳ `comment` | string | Comment left with the rating | +| ↳ `sharing_agreement_ids` | array | Sharing agreement IDs | +| ↳ `followup_ids` | array | IDs of follow-up tickets | +| ↳ `brand_id` | number | Brand ID the ticket belongs to | +| ↳ `allow_attachments` | boolean | Whether attachments are allowed | +| ↳ `allow_channelback` | boolean | Whether channelback is enabled | +| ↳ `from_messaging_channel` | boolean | Whether the ticket originated from a messaging channel | +| ↳ `ticket_form_id` | number | Ticket form ID | +| ↳ `generated_timestamp` | number | Unix timestamp of the ticket generation | | `ticket_id` | number | The ticket ID | ### `zendesk_create_ticket` @@ -132,6 +236,58 @@ Create a new ticket in Zendesk with support for custom fields | Parameter | Type | Description | | --------- | ---- | ----------- | | `ticket` | object | Created ticket object | +| ↳ `id` | number | Automatically assigned ticket ID | +| ↳ `url` | string | API URL of the ticket | +| ↳ `external_id` | string | External ID for linking to external records | +| ↳ `via` | object | How the ticket was created | +| ↳ `channel` | string | Channel through which the ticket was created \(e.g., email, web, api\) | +| ↳ `source` | object | Source details for the channel | +| ↳ `from` | object | Information about the source sender | +| ↳ `address` | string | Email address or other identifier | +| ↳ `name` | string | Name of the sender | +| ↳ `to` | object | Information about the recipient | +| ↳ `address` | string | Email address or other identifier | +| ↳ `name` | string | Name of the recipient | +| ↳ `rel` | string | Relationship type | +| ↳ `created_at` | string | When the ticket was created \(ISO 8601 format\) | +| ↳ `updated_at` | string | When the ticket was last updated \(ISO 8601 format\) | +| ↳ `type` | string | Ticket type \(problem, incident, question, task\) | +| ↳ `subject` | string | Subject of the ticket | +| ↳ `raw_subject` | string | Subject of the ticket as entered by the requester | +| ↳ `description` | string | Read-only first comment on the ticket | +| ↳ `priority` | string | Priority level \(low, normal, high, urgent\) | +| ↳ `status` | string | Ticket status \(new, open, pending, hold, solved, closed\) | +| ↳ `recipient` | string | Original recipient email address | +| ↳ `requester_id` | number | User ID of the ticket requester | +| ↳ `submitter_id` | number | User ID of the ticket submitter | +| ↳ `assignee_id` | number | User ID of the agent assigned to the ticket | +| ↳ `organization_id` | number | Organization ID of the requester | +| ↳ `group_id` | number | Group ID assigned to the ticket | +| ↳ `collaborator_ids` | array | User IDs of collaborators \(CC\) | +| ↳ `follower_ids` | array | User IDs of followers | +| ↳ `email_cc_ids` | array | User IDs of email CCs | +| ↳ `forum_topic_id` | number | Topic ID in the community forum | +| ↳ `problem_id` | number | For incident tickets, the ID of the associated problem ticket | +| ↳ `has_incidents` | boolean | Whether the ticket has incident tickets linked | +| ↳ `is_public` | boolean | Whether the first comment is public | +| ↳ `due_at` | string | Due date for task tickets \(ISO 8601 format\) | +| ↳ `tags` | array | Tags associated with the ticket | +| ↳ `custom_fields` | array | Custom ticket fields | +| ↳ `id` | number | Custom field ID | +| ↳ `value` | string | Custom field value | +| ↳ `custom_status_id` | number | Custom status ID | +| ↳ `satisfaction_rating` | object | Customer satisfaction rating | +| ↳ `id` | number | Satisfaction rating ID | +| ↳ `score` | string | Rating score \(e.g., good, bad, offered, unoffered\) | +| ↳ `comment` | string | Comment left with the rating | +| ↳ `sharing_agreement_ids` | array | Sharing agreement IDs | +| ↳ `followup_ids` | array | IDs of follow-up tickets | +| ↳ `brand_id` | number | Brand ID the ticket belongs to | +| ↳ `allow_attachments` | boolean | Whether attachments are allowed | +| ↳ `allow_channelback` | boolean | Whether channelback is enabled | +| ↳ `from_messaging_channel` | boolean | Whether the ticket originated from a messaging channel | +| ↳ `ticket_form_id` | number | Ticket form ID | +| ↳ `generated_timestamp` | number | Unix timestamp of the ticket generation | | `ticket_id` | number | The created ticket ID | ### `zendesk_create_tickets_bulk` @@ -151,7 +307,21 @@ Create multiple tickets in Zendesk at once (max 100) | Parameter | Type | Description | | --------- | ---- | ----------- | -| `job_status` | object | Job status object | +| `job_status` | object | Job status object for bulk operations | +| ↳ `id` | string | Automatically assigned job ID | +| ↳ `url` | string | URL to poll for status updates | +| ↳ `status` | string | Current job status \(queued, working, failed, completed\) | +| ↳ `job_type` | string | Category of background task | +| ↳ `total` | number | Total number of tasks in this job | +| ↳ `progress` | number | Number of tasks already completed | +| ↳ `message` | string | Message from the job worker | +| ↳ `results` | array | Array of result objects from the job | +| ↳ `id` | number | ID of the created or updated resource | +| ↳ `index` | number | Position of the result in the batch | +| ↳ `action` | string | Action performed \(e.g., create, update\) | +| ↳ `success` | boolean | Whether the operation succeeded | +| ↳ `status` | string | Status message \(e.g., Updated, Created\) | +| ↳ `error` | string | Error message if operation failed | | `job_id` | string | The bulk operation job ID | ### `zendesk_update_ticket` @@ -181,6 +351,58 @@ Update an existing ticket in Zendesk with support for custom fields | Parameter | Type | Description | | --------- | ---- | ----------- | | `ticket` | object | Updated ticket object | +| ↳ `id` | number | Automatically assigned ticket ID | +| ↳ `url` | string | API URL of the ticket | +| ↳ `external_id` | string | External ID for linking to external records | +| ↳ `via` | object | How the ticket was created | +| ↳ `channel` | string | Channel through which the ticket was created \(e.g., email, web, api\) | +| ↳ `source` | object | Source details for the channel | +| ↳ `from` | object | Information about the source sender | +| ↳ `address` | string | Email address or other identifier | +| ↳ `name` | string | Name of the sender | +| ↳ `to` | object | Information about the recipient | +| ↳ `address` | string | Email address or other identifier | +| ↳ `name` | string | Name of the recipient | +| ↳ `rel` | string | Relationship type | +| ↳ `created_at` | string | When the ticket was created \(ISO 8601 format\) | +| ↳ `updated_at` | string | When the ticket was last updated \(ISO 8601 format\) | +| ↳ `type` | string | Ticket type \(problem, incident, question, task\) | +| ↳ `subject` | string | Subject of the ticket | +| ↳ `raw_subject` | string | Subject of the ticket as entered by the requester | +| ↳ `description` | string | Read-only first comment on the ticket | +| ↳ `priority` | string | Priority level \(low, normal, high, urgent\) | +| ↳ `status` | string | Ticket status \(new, open, pending, hold, solved, closed\) | +| ↳ `recipient` | string | Original recipient email address | +| ↳ `requester_id` | number | User ID of the ticket requester | +| ↳ `submitter_id` | number | User ID of the ticket submitter | +| ↳ `assignee_id` | number | User ID of the agent assigned to the ticket | +| ↳ `organization_id` | number | Organization ID of the requester | +| ↳ `group_id` | number | Group ID assigned to the ticket | +| ↳ `collaborator_ids` | array | User IDs of collaborators \(CC\) | +| ↳ `follower_ids` | array | User IDs of followers | +| ↳ `email_cc_ids` | array | User IDs of email CCs | +| ↳ `forum_topic_id` | number | Topic ID in the community forum | +| ↳ `problem_id` | number | For incident tickets, the ID of the associated problem ticket | +| ↳ `has_incidents` | boolean | Whether the ticket has incident tickets linked | +| ↳ `is_public` | boolean | Whether the first comment is public | +| ↳ `due_at` | string | Due date for task tickets \(ISO 8601 format\) | +| ↳ `tags` | array | Tags associated with the ticket | +| ↳ `custom_fields` | array | Custom ticket fields | +| ↳ `id` | number | Custom field ID | +| ↳ `value` | string | Custom field value | +| ↳ `custom_status_id` | number | Custom status ID | +| ↳ `satisfaction_rating` | object | Customer satisfaction rating | +| ↳ `id` | number | Satisfaction rating ID | +| ↳ `score` | string | Rating score \(e.g., good, bad, offered, unoffered\) | +| ↳ `comment` | string | Comment left with the rating | +| ↳ `sharing_agreement_ids` | array | Sharing agreement IDs | +| ↳ `followup_ids` | array | IDs of follow-up tickets | +| ↳ `brand_id` | number | Brand ID the ticket belongs to | +| ↳ `allow_attachments` | boolean | Whether attachments are allowed | +| ↳ `allow_channelback` | boolean | Whether channelback is enabled | +| ↳ `from_messaging_channel` | boolean | Whether the ticket originated from a messaging channel | +| ↳ `ticket_form_id` | number | Ticket form ID | +| ↳ `generated_timestamp` | number | Unix timestamp of the ticket generation | | `ticket_id` | number | The updated ticket ID | ### `zendesk_update_tickets_bulk` @@ -205,7 +427,21 @@ Update multiple tickets in Zendesk at once (max 100) | Parameter | Type | Description | | --------- | ---- | ----------- | -| `job_status` | object | Job status object | +| `job_status` | object | Job status object for bulk operations | +| ↳ `id` | string | Automatically assigned job ID | +| ↳ `url` | string | URL to poll for status updates | +| ↳ `status` | string | Current job status \(queued, working, failed, completed\) | +| ↳ `job_type` | string | Category of background task | +| ↳ `total` | number | Total number of tasks in this job | +| ↳ `progress` | number | Number of tasks already completed | +| ↳ `message` | string | Message from the job worker | +| ↳ `results` | array | Array of result objects from the job | +| ↳ `id` | number | ID of the created or updated resource | +| ↳ `index` | number | Position of the result in the batch | +| ↳ `action` | string | Action performed \(e.g., create, update\) | +| ↳ `success` | boolean | Whether the operation succeeded | +| ↳ `status` | string | Status message \(e.g., Updated, Created\) | +| ↳ `error` | string | Error message if operation failed | | `job_id` | string | The bulk operation job ID | ### `zendesk_delete_ticket` @@ -247,7 +483,21 @@ Merge multiple tickets into a target ticket | Parameter | Type | Description | | --------- | ---- | ----------- | -| `job_status` | object | Job status object | +| `job_status` | object | Job status object for bulk operations | +| ↳ `id` | string | Automatically assigned job ID | +| ↳ `url` | string | URL to poll for status updates | +| ↳ `status` | string | Current job status \(queued, working, failed, completed\) | +| ↳ `job_type` | string | Category of background task | +| ↳ `total` | number | Total number of tasks in this job | +| ↳ `progress` | number | Number of tasks already completed | +| ↳ `message` | string | Message from the job worker | +| ↳ `results` | array | Array of result objects from the job | +| ↳ `id` | number | ID of the created or updated resource | +| ↳ `index` | number | Position of the result in the batch | +| ↳ `action` | string | Action performed \(e.g., create, update\) | +| ↳ `success` | boolean | Whether the operation succeeded | +| ↳ `status` | string | Status message \(e.g., Updated, Created\) | +| ↳ `error` | string | Error message if operation failed | | `job_id` | string | The merge job ID | | `target_ticket_id` | string | The target ticket ID that tickets were merged into | @@ -272,13 +522,54 @@ Retrieve a list of users from Zendesk with optional filtering | Parameter | Type | Description | | --------- | ---- | ----------- | | `users` | array | Array of user objects | +| ↳ `id` | number | Automatically assigned user ID | +| ↳ `url` | string | API URL of the user | +| ↳ `name` | string | User name | +| ↳ `email` | string | Primary email address | +| ↳ `created_at` | string | When the user was created \(ISO 8601 format\) | +| ↳ `updated_at` | string | When the user was last updated \(ISO 8601 format\) | +| ↳ `time_zone` | string | Time zone \(e.g., Eastern Time \(US & Canada\)\) | +| ↳ `iana_time_zone` | string | IANA time zone \(e.g., America/New_York\) | +| ↳ `phone` | string | Phone number | +| ↳ `shared_phone_number` | boolean | Whether the phone number is shared | +| ↳ `photo` | object | User photo details | +| ↳ `content_url` | string | URL to the photo | +| ↳ `file_name` | string | Photo file name | +| ↳ `size` | number | File size in bytes | +| ↳ `locale` | string | Locale \(e.g., en-US\) | +| ↳ `locale_id` | number | Locale ID | +| ↳ `organization_id` | number | Primary organization ID | +| ↳ `role` | string | User role \(end-user, agent, admin\) | +| ↳ `role_type` | number | Role type identifier | +| ↳ `custom_role_id` | number | Custom role ID | +| ↳ `active` | boolean | Whether the user is active \(false if deleted\) | +| ↳ `verified` | boolean | Whether any user identity has been verified | +| ↳ `alias` | string | Alias displayed to end users | +| ↳ `details` | string | Details about the user | +| ↳ `notes` | string | Notes about the user | +| ↳ `signature` | string | User signature for email replies | +| ↳ `default_group_id` | number | Default group ID for the user | +| ↳ `tags` | array | Tags associated with the user | +| ↳ `external_id` | string | External ID for linking to external records | +| ↳ `restricted_agent` | boolean | Whether the agent has restrictions | +| ↳ `suspended` | boolean | Whether the user is suspended | +| ↳ `moderator` | boolean | Whether the user has moderator permissions | +| ↳ `chat_only` | boolean | Whether the user is a chat-only agent | +| ↳ `only_private_comments` | boolean | Whether the user can only create private comments | +| ↳ `two_factor_auth_enabled` | boolean | Whether two-factor auth is enabled | +| ↳ `last_login_at` | string | Last login time \(ISO 8601 format\) | +| ↳ `ticket_restriction` | string | Ticket access restriction \(organization, groups, assigned, requested\) | +| ↳ `user_fields` | json | Custom user fields \(dynamic key-value pairs\) | +| ↳ `shared` | boolean | Whether the user is shared from a different Zendesk | +| ↳ `shared_agent` | boolean | Whether the agent is shared from a different Zendesk | +| ↳ `remote_photo_url` | string | URL to a remote photo | | `paging` | object | Pagination information | -| ↳ `next_page` | string | URL for next page of results | -| ↳ `previous_page` | string | URL for previous page of results | -| ↳ `count` | number | Total count of users | +| ↳ `next_page` | string | URL for next page of results | +| ↳ `previous_page` | string | URL for previous page of results | +| ↳ `count` | number | Total count of items | | `metadata` | object | Response metadata | -| ↳ `total_returned` | number | Number of users returned in this response | -| ↳ `has_more` | boolean | Whether more users are available | +| ↳ `total_returned` | number | Number of items returned in this response | +| ↳ `has_more` | boolean | Whether more items are available | ### `zendesk_get_user` @@ -298,6 +589,47 @@ Get a single user by ID from Zendesk | Parameter | Type | Description | | --------- | ---- | ----------- | | `user` | object | User object | +| ↳ `id` | number | Automatically assigned user ID | +| ↳ `url` | string | API URL of the user | +| ↳ `name` | string | User name | +| ↳ `email` | string | Primary email address | +| ↳ `created_at` | string | When the user was created \(ISO 8601 format\) | +| ↳ `updated_at` | string | When the user was last updated \(ISO 8601 format\) | +| ↳ `time_zone` | string | Time zone \(e.g., Eastern Time \(US & Canada\)\) | +| ↳ `iana_time_zone` | string | IANA time zone \(e.g., America/New_York\) | +| ↳ `phone` | string | Phone number | +| ↳ `shared_phone_number` | boolean | Whether the phone number is shared | +| ↳ `photo` | object | User photo details | +| ↳ `content_url` | string | URL to the photo | +| ↳ `file_name` | string | Photo file name | +| ↳ `size` | number | File size in bytes | +| ↳ `locale` | string | Locale \(e.g., en-US\) | +| ↳ `locale_id` | number | Locale ID | +| ↳ `organization_id` | number | Primary organization ID | +| ↳ `role` | string | User role \(end-user, agent, admin\) | +| ↳ `role_type` | number | Role type identifier | +| ↳ `custom_role_id` | number | Custom role ID | +| ↳ `active` | boolean | Whether the user is active \(false if deleted\) | +| ↳ `verified` | boolean | Whether any user identity has been verified | +| ↳ `alias` | string | Alias displayed to end users | +| ↳ `details` | string | Details about the user | +| ↳ `notes` | string | Notes about the user | +| ↳ `signature` | string | User signature for email replies | +| ↳ `default_group_id` | number | Default group ID for the user | +| ↳ `tags` | array | Tags associated with the user | +| ↳ `external_id` | string | External ID for linking to external records | +| ↳ `restricted_agent` | boolean | Whether the agent has restrictions | +| ↳ `suspended` | boolean | Whether the user is suspended | +| ↳ `moderator` | boolean | Whether the user has moderator permissions | +| ↳ `chat_only` | boolean | Whether the user is a chat-only agent | +| ↳ `only_private_comments` | boolean | Whether the user can only create private comments | +| ↳ `two_factor_auth_enabled` | boolean | Whether two-factor auth is enabled | +| ↳ `last_login_at` | string | Last login time \(ISO 8601 format\) | +| ↳ `ticket_restriction` | string | Ticket access restriction \(organization, groups, assigned, requested\) | +| ↳ `user_fields` | json | Custom user fields \(dynamic key-value pairs\) | +| ↳ `shared` | boolean | Whether the user is shared from a different Zendesk | +| ↳ `shared_agent` | boolean | Whether the agent is shared from a different Zendesk | +| ↳ `remote_photo_url` | string | URL to a remote photo | | `user_id` | number | The user ID | ### `zendesk_get_current_user` @@ -317,6 +649,47 @@ Get the currently authenticated user from Zendesk | Parameter | Type | Description | | --------- | ---- | ----------- | | `user` | object | Current user object | +| ↳ `id` | number | Automatically assigned user ID | +| ↳ `url` | string | API URL of the user | +| ↳ `name` | string | User name | +| ↳ `email` | string | Primary email address | +| ↳ `created_at` | string | When the user was created \(ISO 8601 format\) | +| ↳ `updated_at` | string | When the user was last updated \(ISO 8601 format\) | +| ↳ `time_zone` | string | Time zone \(e.g., Eastern Time \(US & Canada\)\) | +| ↳ `iana_time_zone` | string | IANA time zone \(e.g., America/New_York\) | +| ↳ `phone` | string | Phone number | +| ↳ `shared_phone_number` | boolean | Whether the phone number is shared | +| ↳ `photo` | object | User photo details | +| ↳ `content_url` | string | URL to the photo | +| ↳ `file_name` | string | Photo file name | +| ↳ `size` | number | File size in bytes | +| ↳ `locale` | string | Locale \(e.g., en-US\) | +| ↳ `locale_id` | number | Locale ID | +| ↳ `organization_id` | number | Primary organization ID | +| ↳ `role` | string | User role \(end-user, agent, admin\) | +| ↳ `role_type` | number | Role type identifier | +| ↳ `custom_role_id` | number | Custom role ID | +| ↳ `active` | boolean | Whether the user is active \(false if deleted\) | +| ↳ `verified` | boolean | Whether any user identity has been verified | +| ↳ `alias` | string | Alias displayed to end users | +| ↳ `details` | string | Details about the user | +| ↳ `notes` | string | Notes about the user | +| ↳ `signature` | string | User signature for email replies | +| ↳ `default_group_id` | number | Default group ID for the user | +| ↳ `tags` | array | Tags associated with the user | +| ↳ `external_id` | string | External ID for linking to external records | +| ↳ `restricted_agent` | boolean | Whether the agent has restrictions | +| ↳ `suspended` | boolean | Whether the user is suspended | +| ↳ `moderator` | boolean | Whether the user has moderator permissions | +| ↳ `chat_only` | boolean | Whether the user is a chat-only agent | +| ↳ `only_private_comments` | boolean | Whether the user can only create private comments | +| ↳ `two_factor_auth_enabled` | boolean | Whether two-factor auth is enabled | +| ↳ `last_login_at` | string | Last login time \(ISO 8601 format\) | +| ↳ `ticket_restriction` | string | Ticket access restriction \(organization, groups, assigned, requested\) | +| ↳ `user_fields` | json | Custom user fields \(dynamic key-value pairs\) | +| ↳ `shared` | boolean | Whether the user is shared from a different Zendesk | +| ↳ `shared_agent` | boolean | Whether the agent is shared from a different Zendesk | +| ↳ `remote_photo_url` | string | URL to a remote photo | | `user_id` | number | The current user ID | ### `zendesk_search_users` @@ -340,13 +713,54 @@ Search for users in Zendesk using a query string | Parameter | Type | Description | | --------- | ---- | ----------- | | `users` | array | Array of user objects | +| ↳ `id` | number | Automatically assigned user ID | +| ↳ `url` | string | API URL of the user | +| ↳ `name` | string | User name | +| ↳ `email` | string | Primary email address | +| ↳ `created_at` | string | When the user was created \(ISO 8601 format\) | +| ↳ `updated_at` | string | When the user was last updated \(ISO 8601 format\) | +| ↳ `time_zone` | string | Time zone \(e.g., Eastern Time \(US & Canada\)\) | +| ↳ `iana_time_zone` | string | IANA time zone \(e.g., America/New_York\) | +| ↳ `phone` | string | Phone number | +| ↳ `shared_phone_number` | boolean | Whether the phone number is shared | +| ↳ `photo` | object | User photo details | +| ↳ `content_url` | string | URL to the photo | +| ↳ `file_name` | string | Photo file name | +| ↳ `size` | number | File size in bytes | +| ↳ `locale` | string | Locale \(e.g., en-US\) | +| ↳ `locale_id` | number | Locale ID | +| ↳ `organization_id` | number | Primary organization ID | +| ↳ `role` | string | User role \(end-user, agent, admin\) | +| ↳ `role_type` | number | Role type identifier | +| ↳ `custom_role_id` | number | Custom role ID | +| ↳ `active` | boolean | Whether the user is active \(false if deleted\) | +| ↳ `verified` | boolean | Whether any user identity has been verified | +| ↳ `alias` | string | Alias displayed to end users | +| ↳ `details` | string | Details about the user | +| ↳ `notes` | string | Notes about the user | +| ↳ `signature` | string | User signature for email replies | +| ↳ `default_group_id` | number | Default group ID for the user | +| ↳ `tags` | array | Tags associated with the user | +| ↳ `external_id` | string | External ID for linking to external records | +| ↳ `restricted_agent` | boolean | Whether the agent has restrictions | +| ↳ `suspended` | boolean | Whether the user is suspended | +| ↳ `moderator` | boolean | Whether the user has moderator permissions | +| ↳ `chat_only` | boolean | Whether the user is a chat-only agent | +| ↳ `only_private_comments` | boolean | Whether the user can only create private comments | +| ↳ `two_factor_auth_enabled` | boolean | Whether two-factor auth is enabled | +| ↳ `last_login_at` | string | Last login time \(ISO 8601 format\) | +| ↳ `ticket_restriction` | string | Ticket access restriction \(organization, groups, assigned, requested\) | +| ↳ `user_fields` | json | Custom user fields \(dynamic key-value pairs\) | +| ↳ `shared` | boolean | Whether the user is shared from a different Zendesk | +| ↳ `shared_agent` | boolean | Whether the agent is shared from a different Zendesk | +| ↳ `remote_photo_url` | string | URL to a remote photo | | `paging` | object | Pagination information | -| ↳ `next_page` | string | URL for next page of results | -| ↳ `previous_page` | string | URL for previous page of results | -| ↳ `count` | number | Total count of users | +| ↳ `next_page` | string | URL for next page of results | +| ↳ `previous_page` | string | URL for previous page of results | +| ↳ `count` | number | Total count of items | | `metadata` | object | Response metadata | -| ↳ `total_returned` | number | Number of users returned in this response | -| ↳ `has_more` | boolean | Whether more users are available | +| ↳ `total_returned` | number | Number of items returned in this response | +| ↳ `has_more` | boolean | Whether more items are available | ### `zendesk_create_user` @@ -373,6 +787,47 @@ Create a new user in Zendesk | Parameter | Type | Description | | --------- | ---- | ----------- | | `user` | object | Created user object | +| ↳ `id` | number | Automatically assigned user ID | +| ↳ `url` | string | API URL of the user | +| ↳ `name` | string | User name | +| ↳ `email` | string | Primary email address | +| ↳ `created_at` | string | When the user was created \(ISO 8601 format\) | +| ↳ `updated_at` | string | When the user was last updated \(ISO 8601 format\) | +| ↳ `time_zone` | string | Time zone \(e.g., Eastern Time \(US & Canada\)\) | +| ↳ `iana_time_zone` | string | IANA time zone \(e.g., America/New_York\) | +| ↳ `phone` | string | Phone number | +| ↳ `shared_phone_number` | boolean | Whether the phone number is shared | +| ↳ `photo` | object | User photo details | +| ↳ `content_url` | string | URL to the photo | +| ↳ `file_name` | string | Photo file name | +| ↳ `size` | number | File size in bytes | +| ↳ `locale` | string | Locale \(e.g., en-US\) | +| ↳ `locale_id` | number | Locale ID | +| ↳ `organization_id` | number | Primary organization ID | +| ↳ `role` | string | User role \(end-user, agent, admin\) | +| ↳ `role_type` | number | Role type identifier | +| ↳ `custom_role_id` | number | Custom role ID | +| ↳ `active` | boolean | Whether the user is active \(false if deleted\) | +| ↳ `verified` | boolean | Whether any user identity has been verified | +| ↳ `alias` | string | Alias displayed to end users | +| ↳ `details` | string | Details about the user | +| ↳ `notes` | string | Notes about the user | +| ↳ `signature` | string | User signature for email replies | +| ↳ `default_group_id` | number | Default group ID for the user | +| ↳ `tags` | array | Tags associated with the user | +| ↳ `external_id` | string | External ID for linking to external records | +| ↳ `restricted_agent` | boolean | Whether the agent has restrictions | +| ↳ `suspended` | boolean | Whether the user is suspended | +| ↳ `moderator` | boolean | Whether the user has moderator permissions | +| ↳ `chat_only` | boolean | Whether the user is a chat-only agent | +| ↳ `only_private_comments` | boolean | Whether the user can only create private comments | +| ↳ `two_factor_auth_enabled` | boolean | Whether two-factor auth is enabled | +| ↳ `last_login_at` | string | Last login time \(ISO 8601 format\) | +| ↳ `ticket_restriction` | string | Ticket access restriction \(organization, groups, assigned, requested\) | +| ↳ `user_fields` | json | Custom user fields \(dynamic key-value pairs\) | +| ↳ `shared` | boolean | Whether the user is shared from a different Zendesk | +| ↳ `shared_agent` | boolean | Whether the agent is shared from a different Zendesk | +| ↳ `remote_photo_url` | string | URL to a remote photo | | `user_id` | number | The created user ID | ### `zendesk_create_users_bulk` @@ -392,7 +847,21 @@ Create multiple users in Zendesk using bulk import | Parameter | Type | Description | | --------- | ---- | ----------- | -| `job_status` | object | Job status object | +| `job_status` | object | Job status object for bulk operations | +| ↳ `id` | string | Automatically assigned job ID | +| ↳ `url` | string | URL to poll for status updates | +| ↳ `status` | string | Current job status \(queued, working, failed, completed\) | +| ↳ `job_type` | string | Category of background task | +| ↳ `total` | number | Total number of tasks in this job | +| ↳ `progress` | number | Number of tasks already completed | +| ↳ `message` | string | Message from the job worker | +| ↳ `results` | array | Array of result objects from the job | +| ↳ `id` | number | ID of the created or updated resource | +| ↳ `index` | number | Position of the result in the batch | +| ↳ `action` | string | Action performed \(e.g., create, update\) | +| ↳ `success` | boolean | Whether the operation succeeded | +| ↳ `status` | string | Status message \(e.g., Updated, Created\) | +| ↳ `error` | string | Error message if operation failed | | `job_id` | string | The bulk operation job ID | ### `zendesk_update_user` @@ -420,7 +889,48 @@ Update an existing user in Zendesk | Parameter | Type | Description | | --------- | ---- | ----------- | -| `user` | json | Updated user object | +| `user` | object | Updated user object | +| ↳ `id` | number | Automatically assigned user ID | +| ↳ `url` | string | API URL of the user | +| ↳ `name` | string | User name | +| ↳ `email` | string | Primary email address | +| ↳ `created_at` | string | When the user was created \(ISO 8601 format\) | +| ↳ `updated_at` | string | When the user was last updated \(ISO 8601 format\) | +| ↳ `time_zone` | string | Time zone \(e.g., Eastern Time \(US & Canada\)\) | +| ↳ `iana_time_zone` | string | IANA time zone \(e.g., America/New_York\) | +| ↳ `phone` | string | Phone number | +| ↳ `shared_phone_number` | boolean | Whether the phone number is shared | +| ↳ `photo` | object | User photo details | +| ↳ `content_url` | string | URL to the photo | +| ↳ `file_name` | string | Photo file name | +| ↳ `size` | number | File size in bytes | +| ↳ `locale` | string | Locale \(e.g., en-US\) | +| ↳ `locale_id` | number | Locale ID | +| ↳ `organization_id` | number | Primary organization ID | +| ↳ `role` | string | User role \(end-user, agent, admin\) | +| ↳ `role_type` | number | Role type identifier | +| ↳ `custom_role_id` | number | Custom role ID | +| ↳ `active` | boolean | Whether the user is active \(false if deleted\) | +| ↳ `verified` | boolean | Whether any user identity has been verified | +| ↳ `alias` | string | Alias displayed to end users | +| ↳ `details` | string | Details about the user | +| ↳ `notes` | string | Notes about the user | +| ↳ `signature` | string | User signature for email replies | +| ↳ `default_group_id` | number | Default group ID for the user | +| ↳ `tags` | array | Tags associated with the user | +| ↳ `external_id` | string | External ID for linking to external records | +| ↳ `restricted_agent` | boolean | Whether the agent has restrictions | +| ↳ `suspended` | boolean | Whether the user is suspended | +| ↳ `moderator` | boolean | Whether the user has moderator permissions | +| ↳ `chat_only` | boolean | Whether the user is a chat-only agent | +| ↳ `only_private_comments` | boolean | Whether the user can only create private comments | +| ↳ `two_factor_auth_enabled` | boolean | Whether two-factor auth is enabled | +| ↳ `last_login_at` | string | Last login time \(ISO 8601 format\) | +| ↳ `ticket_restriction` | string | Ticket access restriction \(organization, groups, assigned, requested\) | +| ↳ `user_fields` | json | Custom user fields \(dynamic key-value pairs\) | +| ↳ `shared` | boolean | Whether the user is shared from a different Zendesk | +| ↳ `shared_agent` | boolean | Whether the agent is shared from a different Zendesk | +| ↳ `remote_photo_url` | string | URL to a remote photo | | `user_id` | number | The updated user ID | ### `zendesk_update_users_bulk` @@ -440,7 +950,21 @@ Update multiple users in Zendesk using bulk update | Parameter | Type | Description | | --------- | ---- | ----------- | -| `job_status` | object | Job status object | +| `job_status` | object | Job status object for bulk operations | +| ↳ `id` | string | Automatically assigned job ID | +| ↳ `url` | string | URL to poll for status updates | +| ↳ `status` | string | Current job status \(queued, working, failed, completed\) | +| ↳ `job_type` | string | Category of background task | +| ↳ `total` | number | Total number of tasks in this job | +| ↳ `progress` | number | Number of tasks already completed | +| ↳ `message` | string | Message from the job worker | +| ↳ `results` | array | Array of result objects from the job | +| ↳ `id` | number | ID of the created or updated resource | +| ↳ `index` | number | Position of the result in the batch | +| ↳ `action` | string | Action performed \(e.g., create, update\) | +| ↳ `success` | boolean | Whether the operation succeeded | +| ↳ `status` | string | Status message \(e.g., Updated, Created\) | +| ↳ `error` | string | Error message if operation failed | | `job_id` | string | The bulk operation job ID | ### `zendesk_delete_user` @@ -482,13 +1006,27 @@ Retrieve a list of organizations from Zendesk | Parameter | Type | Description | | --------- | ---- | ----------- | | `organizations` | array | Array of organization objects | +| ↳ `id` | number | Automatically assigned organization ID | +| ↳ `url` | string | API URL of the organization | +| ↳ `name` | string | Unique organization name | +| ↳ `domain_names` | array | Domain names for automatic user assignment | +| ↳ `details` | string | Details about the organization | +| ↳ `notes` | string | Notes about the organization | +| ↳ `group_id` | number | Group ID for auto-routing new tickets | +| ↳ `shared_tickets` | boolean | Whether end users can see each others tickets | +| ↳ `shared_comments` | boolean | Whether end users can see each others comments | +| ↳ `tags` | array | Tags associated with the organization | +| ↳ `organization_fields` | json | Custom organization fields \(dynamic key-value pairs\) | +| ↳ `created_at` | string | When the organization was created \(ISO 8601 format\) | +| ↳ `updated_at` | string | When the organization was last updated \(ISO 8601 format\) | +| ↳ `external_id` | string | External ID for linking to external records | | `paging` | object | Pagination information | -| ↳ `next_page` | string | URL for next page of results | -| ↳ `previous_page` | string | URL for previous page of results | -| ↳ `count` | number | Total count of organizations | +| ↳ `next_page` | string | URL for next page of results | +| ↳ `previous_page` | string | URL for previous page of results | +| ↳ `count` | number | Total count of items | | `metadata` | object | Response metadata | -| ↳ `total_returned` | number | Number of organizations returned in this response | -| ↳ `has_more` | boolean | Whether more organizations are available | +| ↳ `total_returned` | number | Number of items returned in this response | +| ↳ `has_more` | boolean | Whether more items are available | ### `zendesk_get_organization` @@ -507,7 +1045,21 @@ Get a single organization by ID from Zendesk | Parameter | Type | Description | | --------- | ---- | ----------- | -| `organization` | json | Organization object | +| `organization` | object | Organization object | +| ↳ `id` | number | Automatically assigned organization ID | +| ↳ `url` | string | API URL of the organization | +| ↳ `name` | string | Unique organization name | +| ↳ `domain_names` | array | Domain names for automatic user assignment | +| ↳ `details` | string | Details about the organization | +| ↳ `notes` | string | Notes about the organization | +| ↳ `group_id` | number | Group ID for auto-routing new tickets | +| ↳ `shared_tickets` | boolean | Whether end users can see each others tickets | +| ↳ `shared_comments` | boolean | Whether end users can see each others comments | +| ↳ `tags` | array | Tags associated with the organization | +| ↳ `organization_fields` | json | Custom organization fields \(dynamic key-value pairs\) | +| ↳ `created_at` | string | When the organization was created \(ISO 8601 format\) | +| ↳ `updated_at` | string | When the organization was last updated \(ISO 8601 format\) | +| ↳ `external_id` | string | External ID for linking to external records | | `organization_id` | number | The organization ID | ### `zendesk_autocomplete_organizations` @@ -530,13 +1082,27 @@ Autocomplete organizations in Zendesk by name prefix (for name matching/autocomp | Parameter | Type | Description | | --------- | ---- | ----------- | | `organizations` | array | Array of organization objects | +| ↳ `id` | number | Automatically assigned organization ID | +| ↳ `url` | string | API URL of the organization | +| ↳ `name` | string | Unique organization name | +| ↳ `domain_names` | array | Domain names for automatic user assignment | +| ↳ `details` | string | Details about the organization | +| ↳ `notes` | string | Notes about the organization | +| ↳ `group_id` | number | Group ID for auto-routing new tickets | +| ↳ `shared_tickets` | boolean | Whether end users can see each others tickets | +| ↳ `shared_comments` | boolean | Whether end users can see each others comments | +| ↳ `tags` | array | Tags associated with the organization | +| ↳ `organization_fields` | json | Custom organization fields \(dynamic key-value pairs\) | +| ↳ `created_at` | string | When the organization was created \(ISO 8601 format\) | +| ↳ `updated_at` | string | When the organization was last updated \(ISO 8601 format\) | +| ↳ `external_id` | string | External ID for linking to external records | | `paging` | object | Pagination information | -| ↳ `next_page` | string | URL for next page of results | -| ↳ `previous_page` | string | URL for previous page of results | -| ↳ `count` | number | Total count of organizations | +| ↳ `next_page` | string | URL for next page of results | +| ↳ `previous_page` | string | URL for previous page of results | +| ↳ `count` | number | Total count of items | | `metadata` | object | Response metadata | -| ↳ `total_returned` | number | Number of organizations returned in this response | -| ↳ `has_more` | boolean | Whether more organizations are available | +| ↳ `total_returned` | number | Number of items returned in this response | +| ↳ `has_more` | boolean | Whether more items are available | ### `zendesk_create_organization` @@ -560,7 +1126,21 @@ Create a new organization in Zendesk | Parameter | Type | Description | | --------- | ---- | ----------- | -| `organization` | json | Created organization object | +| `organization` | object | Created organization object | +| ↳ `id` | number | Automatically assigned organization ID | +| ↳ `url` | string | API URL of the organization | +| ↳ `name` | string | Unique organization name | +| ↳ `domain_names` | array | Domain names for automatic user assignment | +| ↳ `details` | string | Details about the organization | +| ↳ `notes` | string | Notes about the organization | +| ↳ `group_id` | number | Group ID for auto-routing new tickets | +| ↳ `shared_tickets` | boolean | Whether end users can see each others tickets | +| ↳ `shared_comments` | boolean | Whether end users can see each others comments | +| ↳ `tags` | array | Tags associated with the organization | +| ↳ `organization_fields` | json | Custom organization fields \(dynamic key-value pairs\) | +| ↳ `created_at` | string | When the organization was created \(ISO 8601 format\) | +| ↳ `updated_at` | string | When the organization was last updated \(ISO 8601 format\) | +| ↳ `external_id` | string | External ID for linking to external records | | `organization_id` | number | The created organization ID | ### `zendesk_create_organizations_bulk` @@ -580,7 +1160,21 @@ Create multiple organizations in Zendesk using bulk import | Parameter | Type | Description | | --------- | ---- | ----------- | -| `job_status` | object | Job status object | +| `job_status` | object | Job status object for bulk operations | +| ↳ `id` | string | Automatically assigned job ID | +| ↳ `url` | string | URL to poll for status updates | +| ↳ `status` | string | Current job status \(queued, working, failed, completed\) | +| ↳ `job_type` | string | Category of background task | +| ↳ `total` | number | Total number of tasks in this job | +| ↳ `progress` | number | Number of tasks already completed | +| ↳ `message` | string | Message from the job worker | +| ↳ `results` | array | Array of result objects from the job | +| ↳ `id` | number | ID of the created or updated resource | +| ↳ `index` | number | Position of the result in the batch | +| ↳ `action` | string | Action performed \(e.g., create, update\) | +| ↳ `success` | boolean | Whether the operation succeeded | +| ↳ `status` | string | Status message \(e.g., Updated, Created\) | +| ↳ `error` | string | Error message if operation failed | | `job_id` | string | The bulk operation job ID | ### `zendesk_update_organization` @@ -606,7 +1200,21 @@ Update an existing organization in Zendesk | Parameter | Type | Description | | --------- | ---- | ----------- | -| `organization` | json | Updated organization object | +| `organization` | object | Updated organization object | +| ↳ `id` | number | Automatically assigned organization ID | +| ↳ `url` | string | API URL of the organization | +| ↳ `name` | string | Unique organization name | +| ↳ `domain_names` | array | Domain names for automatic user assignment | +| ↳ `details` | string | Details about the organization | +| ↳ `notes` | string | Notes about the organization | +| ↳ `group_id` | number | Group ID for auto-routing new tickets | +| ↳ `shared_tickets` | boolean | Whether end users can see each others tickets | +| ↳ `shared_comments` | boolean | Whether end users can see each others comments | +| ↳ `tags` | array | Tags associated with the organization | +| ↳ `organization_fields` | json | Custom organization fields \(dynamic key-value pairs\) | +| ↳ `created_at` | string | When the organization was created \(ISO 8601 format\) | +| ↳ `updated_at` | string | When the organization was last updated \(ISO 8601 format\) | +| ↳ `external_id` | string | External ID for linking to external records | | `organization_id` | number | The updated organization ID | ### `zendesk_delete_organization` @@ -650,14 +1258,14 @@ Unified search across tickets, users, and organizations in Zendesk | Parameter | Type | Description | | --------- | ---- | ----------- | -| `results` | array | Array of result objects | | `paging` | object | Pagination information | -| ↳ `next_page` | string | URL for next page of results | -| ↳ `previous_page` | string | URL for previous page of results | -| ↳ `count` | number | Total count of results | +| ↳ `next_page` | string | URL for next page of results | +| ↳ `previous_page` | string | URL for previous page of results | +| ↳ `count` | number | Total count of items | | `metadata` | object | Response metadata | -| ↳ `total_returned` | number | Number of results returned in this response | -| ↳ `has_more` | boolean | Whether more results are available | +| ↳ `total_returned` | number | Number of items returned in this response | +| ↳ `has_more` | boolean | Whether more items are available | +| `results` | array | Array of result objects \(tickets, users, or organizations depending on search query\) | ### `zendesk_search_count` diff --git a/apps/docs/content/docs/en/tools/zep.mdx b/apps/docs/content/docs/en/tools/zep.mdx index ad9a34c93..88226cf45 100644 --- a/apps/docs/content/docs/en/tools/zep.mdx +++ b/apps/docs/content/docs/en/tools/zep.mdx @@ -52,10 +52,10 @@ Start a new conversation thread in Zep | Parameter | Type | Description | | --------- | ---- | ----------- | -| `threadId` | string | The thread ID | -| `userId` | string | The user ID | +| `threadId` | string | Thread identifier | +| `userId` | string | Associated user ID | | `uuid` | string | Internal UUID | -| `createdAt` | string | Creation timestamp | +| `createdAt` | string | Creation timestamp \(ISO 8601\) | | `projectUuid` | string | Project UUID | ### `zep_get_threads` @@ -77,8 +77,15 @@ List all conversation threads | Parameter | Type | Description | | --------- | ---- | ----------- | | `threads` | array | Array of thread objects | -| `responseCount` | number | Number of threads in this response | -| `totalCount` | number | Total number of threads available | +| ↳ `threadId` | string | Thread identifier | +| ↳ `userId` | string | Associated user ID | +| ↳ `uuid` | string | Internal UUID | +| ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) | +| ↳ `updatedAt` | string | Last update timestamp \(ISO 8601\) | +| ↳ `projectUuid` | string | Project UUID | +| ↳ `metadata` | object | Custom metadata \(dynamic key-value pairs\) | +| `responseCount` | number | Number of items in this response | +| `totalCount` | number | Total number of items available | ### `zep_delete_thread` @@ -135,8 +142,16 @@ Retrieve messages from a thread | Parameter | Type | Description | | --------- | ---- | ----------- | | `messages` | array | Array of message objects | -| `rowCount` | number | Number of messages in this response | -| `totalCount` | number | Total number of messages in the thread | +| ↳ `uuid` | string | Message UUID | +| ↳ `role` | string | Message role \(user, assistant, system, tool\) | +| ↳ `roleType` | string | Role type \(AI, human, tool\) | +| ↳ `content` | string | Message content | +| ↳ `name` | string | Sender name | +| ↳ `createdAt` | string | Timestamp \(RFC3339 format\) | +| ↳ `metadata` | object | Message metadata \(dynamic key-value pairs\) | +| ↳ `processed` | boolean | Whether message has been processed | +| `rowCount` | number | Number of rows returned | +| `totalCount` | number | Total number of items available | ### `zep_add_messages` @@ -154,7 +169,7 @@ Add messages to an existing thread | Parameter | Type | Description | | --------- | ---- | ----------- | -| `threadId` | string | The thread ID | +| `threadId` | string | Thread identifier | | `added` | boolean | Whether messages were added successfully | | `messageIds` | array | Array of added message UUIDs | @@ -177,13 +192,13 @@ Create a new user in Zep | Parameter | Type | Description | | --------- | ---- | ----------- | -| `userId` | string | The user ID | -| `email` | string | User email | +| `userId` | string | User identifier | +| `email` | string | User email address | | `firstName` | string | User first name | | `lastName` | string | User last name | | `uuid` | string | Internal UUID | -| `createdAt` | string | Creation timestamp | -| `metadata` | object | User metadata | +| `createdAt` | string | Creation timestamp \(ISO 8601\) | +| `metadata` | object | User metadata \(dynamic key-value pairs\) | ### `zep_get_user` @@ -200,14 +215,14 @@ Retrieve user information from Zep | Parameter | Type | Description | | --------- | ---- | ----------- | -| `userId` | string | The user ID | -| `email` | string | User email | +| `userId` | string | User identifier | +| `email` | string | User email address | | `firstName` | string | User first name | | `lastName` | string | User last name | | `uuid` | string | Internal UUID | -| `createdAt` | string | Creation timestamp | -| `updatedAt` | string | Last update timestamp | -| `metadata` | object | User metadata | +| `createdAt` | string | Creation timestamp \(ISO 8601\) | +| `updatedAt` | string | Last update timestamp \(ISO 8601\) | +| `metadata` | object | User metadata \(dynamic key-value pairs\) | ### `zep_get_user_threads` @@ -225,7 +240,14 @@ List all conversation threads for a specific user | Parameter | Type | Description | | --------- | ---- | ----------- | -| `threads` | array | Array of thread objects for this user | -| `totalCount` | number | Total number of threads returned | +| `threads` | array | Array of thread objects | +| ↳ `threadId` | string | Thread identifier | +| ↳ `userId` | string | Associated user ID | +| ↳ `uuid` | string | Internal UUID | +| ↳ `createdAt` | string | Creation timestamp \(ISO 8601\) | +| ↳ `updatedAt` | string | Last update timestamp \(ISO 8601\) | +| ↳ `projectUuid` | string | Project UUID | +| ↳ `metadata` | object | Custom metadata \(dynamic key-value pairs\) | +| `totalCount` | number | Total number of items available | diff --git a/apps/docs/content/docs/en/tools/zoom.mdx b/apps/docs/content/docs/en/tools/zoom.mdx index c26d324d6..c019a30e4 100644 --- a/apps/docs/content/docs/en/tools/zoom.mdx +++ b/apps/docs/content/docs/en/tools/zoom.mdx @@ -69,22 +69,49 @@ Create a new Zoom meeting | Parameter | Type | Description | | --------- | ---- | ----------- | | `meeting` | object | The created meeting with all its properties | -| ↳ `id` | number | Meeting ID | -| ↳ `uuid` | string | Meeting UUID | -| ↳ `host_id` | string | Host user ID | -| ↳ `host_email` | string | Host email | -| ↳ `topic` | string | Meeting topic | -| ↳ `type` | number | Meeting type | -| ↳ `status` | string | Meeting status | -| ↳ `start_time` | string | Start time | -| ↳ `duration` | number | Duration in minutes | -| ↳ `timezone` | string | Timezone | -| ↳ `agenda` | string | Meeting agenda | -| ↳ `created_at` | string | Creation timestamp | -| ↳ `start_url` | string | Host start URL | -| ↳ `join_url` | string | Participant join URL | -| ↳ `password` | string | Meeting password | -| ↳ `settings` | object | Meeting settings | +| ↳ `id` | number | Meeting ID | +| ↳ `uuid` | string | Meeting UUID | +| ↳ `host_id` | string | Host user ID | +| ↳ `host_email` | string | Host email address | +| ↳ `topic` | string | Meeting topic | +| ↳ `type` | number | Meeting type: 1=instant, 2=scheduled, 3=recurring no fixed time, 8=recurring fixed time | +| ↳ `status` | string | Meeting status \(e.g., waiting, started\) | +| ↳ `start_time` | string | Start time in ISO 8601 format | +| ↳ `duration` | number | Duration in minutes | +| ↳ `timezone` | string | Timezone \(e.g., America/Los_Angeles\) | +| ↳ `agenda` | string | Meeting agenda | +| ↳ `created_at` | string | Creation timestamp in ISO 8601 format | +| ↳ `start_url` | string | URL for host to start the meeting | +| ↳ `join_url` | string | URL for participants to join the meeting | +| ↳ `password` | string | Meeting password | +| ↳ `h323_password` | string | H.323/SIP room system password | +| ↳ `pstn_password` | string | PSTN password for phone dial-in | +| ↳ `encrypted_password` | string | Encrypted password for joining | +| ↳ `settings` | object | Meeting settings | +| ↳ `host_video` | boolean | Start with host video on | +| ↳ `participant_video` | boolean | Start with participant video on | +| ↳ `join_before_host` | boolean | Allow participants to join before host | +| ↳ `mute_upon_entry` | boolean | Mute participants upon entry | +| ↳ `watermark` | boolean | Add watermark when viewing shared screen | +| ↳ `audio` | string | Audio options: both, telephony, or voip | +| ↳ `auto_recording` | string | Auto recording: local, cloud, or none | +| ↳ `waiting_room` | boolean | Enable waiting room | +| ↳ `meeting_authentication` | boolean | Require meeting authentication | +| ↳ `approval_type` | number | Approval type: 0=auto, 1=manual, 2=none | +| ↳ `recurrence` | object | Recurrence settings for recurring meetings | +| ↳ `type` | number | Recurrence type: 1=daily, 2=weekly, 3=monthly | +| ↳ `repeat_interval` | number | Interval between recurring meetings | +| ↳ `weekly_days` | string | Days of week for weekly recurrence \(1-7, comma-separated\) | +| ↳ `monthly_day` | number | Day of month for monthly recurrence | +| ↳ `monthly_week` | number | Week of month for monthly recurrence | +| ↳ `monthly_week_day` | number | Day of week for monthly recurrence | +| ↳ `end_times` | number | Number of occurrences | +| ↳ `end_date_time` | string | End date time in ISO 8601 format | +| ↳ `occurrences` | array | Meeting occurrences for recurring meetings | +| ↳ `occurrence_id` | string | Occurrence ID | +| ↳ `start_time` | string | Start time in ISO 8601 format | +| ↳ `duration` | number | Duration in minutes | +| ↳ `status` | string | Occurrence status | ### `zoom_list_meetings` @@ -104,12 +131,23 @@ List all meetings for a Zoom user | Parameter | Type | Description | | --------- | ---- | ----------- | | `meetings` | array | List of meetings | +| ↳ `id` | number | Meeting ID | +| ↳ `uuid` | string | Meeting UUID | +| ↳ `host_id` | string | Host user ID | +| ↳ `topic` | string | Meeting topic | +| ↳ `type` | number | Meeting type | +| ↳ `start_time` | string | Start time in ISO 8601 format | +| ↳ `duration` | number | Duration in minutes | +| ↳ `timezone` | string | Timezone | +| ↳ `agenda` | string | Meeting agenda | +| ↳ `created_at` | string | Creation timestamp | +| ↳ `join_url` | string | URL for participants to join | | `pageInfo` | object | Pagination information | -| ↳ `pageCount` | number | Total number of pages | -| ↳ `pageNumber` | number | Current page number | -| ↳ `pageSize` | number | Number of records per page | -| ↳ `totalRecords` | number | Total number of records | -| ↳ `nextPageToken` | string | Token for next page | +| ↳ `pageCount` | number | Total number of pages | +| ↳ `pageNumber` | number | Current page number | +| ↳ `pageSize` | number | Number of records per page | +| ↳ `totalRecords` | number | Total number of records | +| ↳ `nextPageToken` | string | Token for next page of results | ### `zoom_get_meeting` @@ -128,24 +166,49 @@ Get details of a specific Zoom meeting | Parameter | Type | Description | | --------- | ---- | ----------- | | `meeting` | object | The meeting details | -| ↳ `id` | number | Meeting ID | -| ↳ `uuid` | string | Meeting UUID | -| ↳ `host_id` | string | Host user ID | -| ↳ `host_email` | string | Host email | -| ↳ `topic` | string | Meeting topic | -| ↳ `type` | number | Meeting type | -| ↳ `status` | string | Meeting status | -| ↳ `start_time` | string | Start time | -| ↳ `duration` | number | Duration in minutes | -| ↳ `timezone` | string | Timezone | -| ↳ `agenda` | string | Meeting agenda | -| ↳ `created_at` | string | Creation timestamp | -| ↳ `start_url` | string | Host start URL | -| ↳ `join_url` | string | Participant join URL | -| ↳ `password` | string | Meeting password | -| ↳ `settings` | object | Meeting settings | -| ↳ `recurrence` | object | Recurrence settings | -| ↳ `occurrences` | array | Meeting occurrences | +| ↳ `id` | number | Meeting ID | +| ↳ `uuid` | string | Meeting UUID | +| ↳ `host_id` | string | Host user ID | +| ↳ `host_email` | string | Host email address | +| ↳ `topic` | string | Meeting topic | +| ↳ `type` | number | Meeting type: 1=instant, 2=scheduled, 3=recurring no fixed time, 8=recurring fixed time | +| ↳ `status` | string | Meeting status \(e.g., waiting, started\) | +| ↳ `start_time` | string | Start time in ISO 8601 format | +| ↳ `duration` | number | Duration in minutes | +| ↳ `timezone` | string | Timezone \(e.g., America/Los_Angeles\) | +| ↳ `agenda` | string | Meeting agenda | +| ↳ `created_at` | string | Creation timestamp in ISO 8601 format | +| ↳ `start_url` | string | URL for host to start the meeting | +| ↳ `join_url` | string | URL for participants to join the meeting | +| ↳ `password` | string | Meeting password | +| ↳ `h323_password` | string | H.323/SIP room system password | +| ↳ `pstn_password` | string | PSTN password for phone dial-in | +| ↳ `encrypted_password` | string | Encrypted password for joining | +| ↳ `settings` | object | Meeting settings | +| ↳ `host_video` | boolean | Start with host video on | +| ↳ `participant_video` | boolean | Start with participant video on | +| ↳ `join_before_host` | boolean | Allow participants to join before host | +| ↳ `mute_upon_entry` | boolean | Mute participants upon entry | +| ↳ `watermark` | boolean | Add watermark when viewing shared screen | +| ↳ `audio` | string | Audio options: both, telephony, or voip | +| ↳ `auto_recording` | string | Auto recording: local, cloud, or none | +| ↳ `waiting_room` | boolean | Enable waiting room | +| ↳ `meeting_authentication` | boolean | Require meeting authentication | +| ↳ `approval_type` | number | Approval type: 0=auto, 1=manual, 2=none | +| ↳ `recurrence` | object | Recurrence settings for recurring meetings | +| ↳ `type` | number | Recurrence type: 1=daily, 2=weekly, 3=monthly | +| ↳ `repeat_interval` | number | Interval between recurring meetings | +| ↳ `weekly_days` | string | Days of week for weekly recurrence \(1-7, comma-separated\) | +| ↳ `monthly_day` | number | Day of month for monthly recurrence | +| ↳ `monthly_week` | number | Week of month for monthly recurrence | +| ↳ `monthly_week_day` | number | Day of week for monthly recurrence | +| ↳ `end_times` | number | Number of occurrences | +| ↳ `end_date_time` | string | End date time in ISO 8601 format | +| ↳ `occurrences` | array | Meeting occurrences for recurring meetings | +| ↳ `occurrence_id` | string | Occurrence ID | +| ↳ `start_time` | string | Start time in ISO 8601 format | +| ↳ `duration` | number | Duration in minutes | +| ↳ `status` | string | Occurrence status | ### `zoom_update_meeting` @@ -231,12 +294,35 @@ List all cloud recordings for a Zoom user | Parameter | Type | Description | | --------- | ---- | ----------- | | `recordings` | array | List of recordings | +| ↳ `uuid` | string | Meeting UUID | +| ↳ `id` | number | Meeting ID | +| ↳ `account_id` | string | Account ID | +| ↳ `host_id` | string | Host user ID | +| ↳ `topic` | string | Meeting topic | +| ↳ `type` | number | Meeting type | +| ↳ `start_time` | string | Meeting start time | +| ↳ `duration` | number | Meeting duration in minutes | +| ↳ `total_size` | number | Total size of all recordings in bytes | +| ↳ `recording_count` | number | Number of recording files | +| ↳ `share_url` | string | URL to share recordings | +| ↳ `recording_files` | array | List of recording files | +| ↳ `id` | string | Recording file ID | +| ↳ `meeting_id` | string | Meeting ID associated with the recording | +| ↳ `recording_start` | string | Start time of the recording | +| ↳ `recording_end` | string | End time of the recording | +| ↳ `file_type` | string | Type of recording file \(MP4, M4A, etc.\) | +| ↳ `file_extension` | string | File extension | +| ↳ `file_size` | number | File size in bytes | +| ↳ `play_url` | string | URL to play the recording | +| ↳ `download_url` | string | URL to download the recording | +| ↳ `status` | string | Recording status | +| ↳ `recording_type` | string | Type of recording \(shared_screen, audio_only, etc.\) | | `pageInfo` | object | Pagination information | -| ↳ `from` | string | Start date of query range | -| ↳ `to` | string | End date of query range | -| ↳ `pageSize` | number | Number of records per page | -| ↳ `totalRecords` | number | Total number of records | -| ↳ `nextPageToken` | string | Token for next page | +| ↳ `from` | string | Start date of query range | +| ↳ `to` | string | End date of query range | +| ↳ `pageSize` | number | Number of records per page | +| ↳ `totalRecords` | number | Total number of records | +| ↳ `nextPageToken` | string | Token for next page of results | ### `zoom_get_meeting_recordings` @@ -255,14 +341,29 @@ Get all recordings for a specific Zoom meeting | Parameter | Type | Description | | --------- | ---- | ----------- | | `recording` | object | The meeting recording with all files | -| ↳ `uuid` | string | Meeting UUID | -| ↳ `id` | number | Meeting ID | -| ↳ `topic` | string | Meeting topic | -| ↳ `start_time` | string | Meeting start time | -| ↳ `duration` | number | Meeting duration in minutes | -| ↳ `total_size` | number | Total size of recordings in bytes | -| ↳ `share_url` | string | URL to share recordings | -| ↳ `recording_files` | array | List of recording files | +| ↳ `uuid` | string | Meeting UUID | +| ↳ `id` | number | Meeting ID | +| ↳ `account_id` | string | Account ID | +| ↳ `host_id` | string | Host user ID | +| ↳ `topic` | string | Meeting topic | +| ↳ `type` | number | Meeting type | +| ↳ `start_time` | string | Meeting start time | +| ↳ `duration` | number | Meeting duration in minutes | +| ↳ `total_size` | number | Total size of all recordings in bytes | +| ↳ `recording_count` | number | Number of recording files | +| ↳ `share_url` | string | URL to share recordings | +| ↳ `recording_files` | array | List of recording files | +| ↳ `id` | string | Recording file ID | +| ↳ `meeting_id` | string | Meeting ID associated with the recording | +| ↳ `recording_start` | string | Start time of the recording | +| ↳ `recording_end` | string | End time of the recording | +| ↳ `file_type` | string | Type of recording file \(MP4, M4A, etc.\) | +| ↳ `file_extension` | string | File extension | +| ↳ `file_size` | number | File size in bytes | +| ↳ `play_url` | string | URL to play the recording | +| ↳ `download_url` | string | URL to download the recording | +| ↳ `status` | string | Recording status | +| ↳ `recording_type` | string | Type of recording \(shared_screen, audio_only, etc.\) | ### `zoom_delete_recording` @@ -299,9 +400,19 @@ List participants from a past Zoom meeting | Parameter | Type | Description | | --------- | ---- | ----------- | | `participants` | array | List of meeting participants | +| ↳ `id` | string | Participant unique identifier | +| ↳ `user_id` | string | User ID if registered Zoom user | +| ↳ `name` | string | Participant display name | +| ↳ `user_email` | string | Participant email address | +| ↳ `join_time` | string | Time when participant joined \(ISO 8601\) | +| ↳ `leave_time` | string | Time when participant left \(ISO 8601\) | +| ↳ `duration` | number | Duration in seconds participant was in meeting | +| ↳ `attentiveness_score` | string | Attentiveness score \(deprecated\) | +| ↳ `failover` | boolean | Whether participant failed over to another data center | +| ↳ `status` | string | Participant status | | `pageInfo` | object | Pagination information | -| ↳ `pageSize` | number | Number of records per page | -| ↳ `totalRecords` | number | Total number of records | -| ↳ `nextPageToken` | string | Token for next page | +| ↳ `pageSize` | number | Number of records per page | +| ↳ `totalRecords` | number | Total number of records | +| ↳ `nextPageToken` | string | Token for next page of results | diff --git a/apps/sim/app/workspace/[workspaceId]/w/[workflowId]/components/panel/components/editor/components/sub-block/components/short-input/short-input.tsx b/apps/sim/app/workspace/[workspaceId]/w/[workflowId]/components/panel/components/editor/components/sub-block/components/short-input/short-input.tsx index 60e74716f..606f120a7 100644 --- a/apps/sim/app/workspace/[workspaceId]/w/[workflowId]/components/panel/components/editor/components/sub-block/components/short-input/short-input.tsx +++ b/apps/sim/app/workspace/[workspaceId]/w/[workflowId]/components/panel/components/editor/components/sub-block/components/short-input/short-input.tsx @@ -1,5 +1,5 @@ import { memo, useCallback, useEffect, useImperativeHandle, useMemo, useRef, useState } from 'react' -import { Check, Copy, Wand2 } from 'lucide-react' +import { Wand2 } from 'lucide-react' import { useReactFlow } from 'reactflow' import { Input } from '@/components/emcn' import { Button } from '@/components/ui/button' @@ -40,8 +40,6 @@ interface ShortInputProps { disabled?: boolean /** Whether the input is read-only */ readOnly?: boolean - /** Whether to show a copy button */ - showCopyButton?: boolean /** Whether to use webhook URL as value */ useWebhookUrl?: boolean /** Ref to expose wand control handlers to parent */ @@ -59,7 +57,6 @@ interface ShortInputProps { * - Handles drag-and-drop for connections and variable references * - Provides environment variable and tag autocomplete * - Password masking with reveal on focus - * - Copy to clipboard functionality * - Integrates with ReactFlow for zoom control */ export const ShortInput = memo(function ShortInput({ @@ -74,14 +71,12 @@ export const ShortInput = memo(function ShortInput({ previewValue, disabled = false, readOnly = false, - showCopyButton = false, useWebhookUrl = false, wandControlRef, hideInternalWand = false, }: ShortInputProps) { const [localContent, setLocalContent] = useState('') const [isFocused, setIsFocused] = useState(false) - const [copied, setCopied] = useState(false) const persistSubBlockValueRef = useRef<(value: string) => void>(() => {}) const justPastedRef = useRef(false) @@ -278,18 +273,6 @@ export const ShortInput = memo(function ShortInput({ [reactFlowInstance] ) - /** - * Handles copying the value to the clipboard. - */ - const handleCopy = useCallback(() => { - const textToCopy = useWebhookUrl ? webhookManagement?.webhookUrl : value?.toString() - if (textToCopy) { - navigator.clipboard.writeText(textToCopy) - setCopied(true) - setTimeout(() => setCopied(false), 2000) - } - }, [useWebhookUrl, webhookManagement?.webhookUrl, value]) - const handleBlur = useCallback(() => { setIsFocused(false) }, []) @@ -366,10 +349,7 @@ export const ShortInput = memo(function ShortInput({ <> } - className={cn( - 'allow-scroll w-full overflow-auto text-transparent caret-foreground [-ms-overflow-style:none] [scrollbar-width:none] placeholder:text-muted-foreground/50 [&::-webkit-scrollbar]:hidden', - showCopyButton && 'pr-14' - )} + className='allow-scroll w-full overflow-auto text-transparent caret-foreground [-ms-overflow-style:none] [scrollbar-width:none] placeholder:text-muted-foreground/50 [&::-webkit-scrollbar]:hidden' readOnly={readOnly} placeholder={placeholder ?? ''} type='text' @@ -392,8 +372,7 @@ export const ShortInput = memo(function ShortInput({
@@ -404,27 +383,6 @@ export const ShortInput = memo(function ShortInput({ }} - {/* Copy Button */} - {showCopyButton && value && ( -
- -
- )} - {/* Wand Button - only show if not hidden by parent */} {isWandEnabled && !isPreview && !wandHook.isStreaming && !hideInternalWand && (
diff --git a/apps/sim/app/workspace/[workspaceId]/w/[workflowId]/components/panel/components/editor/components/sub-block/components/tag-dropdown/components/keyboard-navigation-handler.tsx b/apps/sim/app/workspace/[workspaceId]/w/[workflowId]/components/panel/components/editor/components/sub-block/components/tag-dropdown/components/keyboard-navigation-handler.tsx index ba3443567..adb2981be 100644 --- a/apps/sim/app/workspace/[workspaceId]/w/[workflowId]/components/panel/components/editor/components/sub-block/components/tag-dropdown/components/keyboard-navigation-handler.tsx +++ b/apps/sim/app/workspace/[workspaceId]/w/[workflowId]/components/panel/components/editor/components/sub-block/components/tag-dropdown/components/keyboard-navigation-handler.tsx @@ -14,6 +14,8 @@ interface KeyboardNavigationHandlerProps { flatTagList: Array<{ tag: string; group?: BlockTagGroup }> nestedBlockTagGroups: NestedBlockTagGroup[] handleTagSelect: (tag: string, group?: BlockTagGroup) => void + /** Called when entering a folder from root level via keyboard navigation */ + onFolderEnter?: () => void } /** @@ -107,6 +109,7 @@ export const KeyboardNavigationHandler: React.FC flatTagList, nestedBlockTagGroups, handleTagSelect, + onFolderEnter, }) => { const { openFolder, closeFolder, isInFolder, currentFolder, setKeyboardNav } = usePopoverContext() const nestedNav = useNestedNavigation() @@ -251,7 +254,7 @@ export const KeyboardNavigationHandler: React.FC } else if (currentVisibleIndex < visibleIndices.length - 1) { newIndex = visibleIndices[currentVisibleIndex + 1] } else { - newIndex = visibleIndices[0] + newIndex = selectedIndex } setSelectedIndex(newIndex) scrollIntoView() @@ -269,7 +272,7 @@ export const KeyboardNavigationHandler: React.FC } else if (currentVisibleIndex > 0) { newIndex = visibleIndices[currentVisibleIndex - 1] } else { - newIndex = visibleIndices[visibleIndices.length - 1] + newIndex = selectedIndex } setSelectedIndex(newIndex) scrollIntoView() @@ -295,6 +298,7 @@ export const KeyboardNavigationHandler: React.FC currentFolderInfo.parentTag, currentFolderInfo.group ) + onFolderEnter?.() } } break @@ -346,6 +350,7 @@ export const KeyboardNavigationHandler: React.FC handleTagSelect, nestedNav, setKeyboardNav, + onFolderEnter, ]) return null diff --git a/apps/sim/app/workspace/[workspaceId]/w/[workflowId]/components/panel/components/editor/components/sub-block/components/tag-dropdown/tag-dropdown.tsx b/apps/sim/app/workspace/[workspaceId]/w/[workflowId]/components/panel/components/editor/components/sub-block/components/tag-dropdown/tag-dropdown.tsx index 17b50aad2..bc982daec 100644 --- a/apps/sim/app/workspace/[workspaceId]/w/[workflowId]/components/panel/components/editor/components/sub-block/components/tag-dropdown/tag-dropdown.tsx +++ b/apps/sim/app/workspace/[workspaceId]/w/[workflowId]/components/panel/components/editor/components/sub-block/components/tag-dropdown/tag-dropdown.tsx @@ -444,10 +444,12 @@ interface NestedTagRendererProps { nestedTag: NestedTag group: NestedBlockTagGroup flatTagList: Array<{ tag: string; group?: BlockTagGroup }> + /** Map from tag string to index for O(1) lookups */ + flatTagIndexMap: Map selectedIndex: number setSelectedIndex: (index: number) => void handleTagSelect: (tag: string, blockGroup?: BlockTagGroup) => void - itemRefs: React.RefObject> + itemRefs: React.RefObject> blocks: Record getMergedSubBlocks: (blockId: string) => Record } @@ -469,6 +471,7 @@ interface FolderContentsProps extends NestedTagRendererProps { const FolderContentsInner: React.FC = ({ group, flatTagList, + flatTagIndexMap, selectedIndex, setSelectedIndex, handleTagSelect, @@ -483,7 +486,7 @@ const FolderContentsInner: React.FC = ({ const currentNestedTag = nestedPath.length > 0 ? nestedPath[nestedPath.length - 1] : nestedTag const parentTagIndex = currentNestedTag.parentTag - ? flatTagList.findIndex((item) => item.tag === currentNestedTag.parentTag) + ? (flatTagIndexMap.get(currentNestedTag.parentTag) ?? -1) : -1 return ( @@ -493,7 +496,6 @@ const FolderContentsInner: React.FC = ({ = 0} onMouseEnter={() => { - // Skip selection update during keyboard navigation to prevent scroll-triggered selection changes if (isKeyboardNav) return setKeyboardNav(false) if (parentTagIndex >= 0) setSelectedIndex(parentTagIndex) @@ -504,8 +506,8 @@ const FolderContentsInner: React.FC = ({ handleTagSelect(currentNestedTag.parentTag!, group) }} ref={(el) => { - if (el && parentTagIndex >= 0) { - itemRefs.current?.set(parentTagIndex, el) + if (el && currentNestedTag.parentTag) { + itemRefs.current?.set(currentNestedTag.parentTag, el) } }} > @@ -515,7 +517,7 @@ const FolderContentsInner: React.FC = ({ {/* Render leaf children as PopoverItems */} {currentNestedTag.children?.map((child) => { - const childGlobalIndex = flatTagList.findIndex((item) => item.tag === child.fullTag) + const childGlobalIndex = flatTagIndexMap.get(child.fullTag) ?? -1 const tagParts = child.fullTag.split('.') const outputPath = tagParts.slice(1).join('.') @@ -550,8 +552,8 @@ const FolderContentsInner: React.FC = ({ handleTagSelect(child.fullTag, group) }} ref={(el) => { - if (el && childGlobalIndex >= 0) { - itemRefs.current?.set(childGlobalIndex, el) + if (el) { + itemRefs.current?.set(child.fullTag, el) } }} > @@ -568,7 +570,7 @@ const FolderContentsInner: React.FC = ({ {/* Render nested children as clickable folder items */} {currentNestedTag.nestedChildren?.map((nestedChild) => { const parentGlobalIndex = nestedChild.parentTag - ? flatTagList.findIndex((item) => item.tag === nestedChild.parentTag) + ? (flatTagIndexMap.get(nestedChild.parentTag) ?? -1) : -1 return ( @@ -583,12 +585,11 @@ const FolderContentsInner: React.FC = ({ onMouseDown={(e) => { e.preventDefault() e.stopPropagation() - // Navigate into the subfolder on click onNavigateIn(nestedChild) }} ref={(el) => { - if (el && parentGlobalIndex >= 0) { - itemRefs.current?.set(parentGlobalIndex, el) + if (el && nestedChild.parentTag) { + itemRefs.current?.set(nestedChild.parentTag, el) } }} > @@ -605,7 +606,7 @@ const FolderContentsInner: React.FC = ({ * Wrapper component that uses shared nested navigation state from context. * Handles registration of the base folder and navigation callbacks. */ -const FolderContents: React.FC = (props) => { +const FolderContents: React.FC> = (props) => { const nestedNav = useNestedNavigation() const { currentFolder } = usePopoverContext() @@ -638,6 +639,7 @@ const NestedTagRenderer: React.FC = ({ nestedTag, group, flatTagList, + flatTagIndexMap, selectedIndex, setSelectedIndex, handleTagSelect, @@ -653,7 +655,7 @@ const NestedTagRenderer: React.FC = ({ const folderId = `${group.blockId}-${nestedTag.key}` const parentGlobalIndex = nestedTag.parentTag - ? flatTagList.findIndex((item) => item.tag === nestedTag.parentTag) + ? (flatTagIndexMap.get(nestedTag.parentTag) ?? -1) : -1 return ( @@ -675,8 +677,8 @@ const NestedTagRenderer: React.FC = ({ } }} ref={(el) => { - if (el && parentGlobalIndex >= 0) { - itemRefs.current?.set(parentGlobalIndex, el) + if (el && nestedTag.parentTag) { + itemRefs.current?.set(nestedTag.parentTag, el) } }} > @@ -684,6 +686,7 @@ const NestedTagRenderer: React.FC = ({ nestedTag={nestedTag} group={group} flatTagList={flatTagList} + flatTagIndexMap={flatTagIndexMap} selectedIndex={selectedIndex} setSelectedIndex={setSelectedIndex} handleTagSelect={handleTagSelect} @@ -695,10 +698,7 @@ const NestedTagRenderer: React.FC = ({ ) } - // Leaf tag - render as a simple PopoverItem - const globalIndex = nestedTag.fullTag - ? flatTagList.findIndex((item) => item.tag === nestedTag.fullTag) - : -1 + const globalIndex = nestedTag.fullTag ? (flatTagIndexMap.get(nestedTag.fullTag) ?? -1) : -1 let tagDescription = '' @@ -751,8 +751,8 @@ const NestedTagRenderer: React.FC = ({ } }} ref={(el) => { - if (el && globalIndex >= 0) { - itemRefs.current?.set(globalIndex, el) + if (el && nestedTag.fullTag) { + itemRefs.current?.set(nestedTag.fullTag, el) } }} > @@ -767,7 +767,7 @@ const NestedTagRenderer: React.FC = ({ } /** - * Hook to get mouse enter handler that respects keyboard navigation mode. + * Hook to get mouse enter handler that respects keyboard navigation state. * Returns a handler that only updates selection if not in keyboard mode. */ const useKeyboardAwareMouseEnter = ( @@ -794,7 +794,7 @@ const VariableTagItem: React.FC<{ selectedIndex: number setSelectedIndex: (index: number) => void handleTagSelect: (tag: string) => void - itemRefs: React.RefObject> + itemRefs: React.RefObject> variableInfo: { type: string; id: string } | null }> = ({ tag, @@ -819,8 +819,8 @@ const VariableTagItem: React.FC<{ handleTagSelect(tag) }} ref={(el) => { - if (el && globalIndex >= 0) { - itemRefs.current?.set(globalIndex, el) + if (el) { + itemRefs.current?.set(tag, el) } }} > @@ -845,7 +845,7 @@ const BlockRootTagItem: React.FC<{ selectedIndex: number setSelectedIndex: (index: number) => void handleTagSelect: (tag: string, group?: BlockTagGroup) => void - itemRefs: React.RefObject> + itemRefs: React.RefObject> group: BlockTagGroup tagIcon: string | React.ComponentType<{ className?: string }> blockColor: string @@ -875,8 +875,8 @@ const BlockRootTagItem: React.FC<{ handleTagSelect(rootTag, group) }} ref={(el) => { - if (el && rootTagGlobalIndex >= 0) { - itemRefs.current?.set(rootTagGlobalIndex, el) + if (el) { + itemRefs.current?.set(rootTag, el) } }} > @@ -916,16 +916,12 @@ const TagDropdownBackButton: React.FC = () => { const handleBackClick = (e: React.MouseEvent) => { e.stopPropagation() - // Try to navigate back in nested path first if (nestedNav?.navigateBack()) { - // Successfully navigated back one level return } - // At root folder level, close the folder closeFolder() } - // Just render the back button - the parent tag is rendered as the first item in FolderContentsInner return (
= ({ inputRef, }) => { const [selectedIndex, setSelectedIndex] = useState(0) - const itemRefs = useRef>(new Map()) + const itemRefs = useRef>(new Map()) const [nestedPath, setNestedPath] = useState([]) const baseFolderRef = useRef<{ @@ -998,6 +994,11 @@ export const TagDropdown: React.FC = ({ const handleTagSelectRef = useRef<((tag: string, group?: BlockTagGroup) => void) | null>(null) const scrollAreaRef = useRef(null) + const inputValueRef = useRef(inputValue) + const cursorPositionRef = useRef(cursorPosition) + inputValueRef.current = inputValue + cursorPositionRef.current = cursorPosition + const { blocks, edges, loops, parallels } = useWorkflowStore( useShallow((state) => ({ blocks: state.blocks, @@ -1700,27 +1701,23 @@ export const TagDropdown: React.FC = ({ return list }, [variableTags, nestedBlockTagGroups]) - useEffect(() => { - if (!visible || selectedIndex < 0) return - - const element = itemRefs.current.get(selectedIndex) - if (element) { - element.scrollIntoView({ - behavior: 'auto', - block: 'nearest', - }) - } - }, [selectedIndex, visible]) + const flatTagIndexMap = useMemo(() => { + const map = new Map() + flatTagList.forEach((item, index) => { + map.set(item.tag, index) + }) + return map + }, [flatTagList]) const handleTagSelect = useCallback( (tag: string, blockGroup?: BlockTagGroup) => { - let liveCursor = cursorPosition - let liveValue = inputValue + let liveCursor = cursorPositionRef.current + let liveValue = inputValueRef.current if (typeof window !== 'undefined' && document?.activeElement) { const activeEl = document.activeElement as HTMLInputElement | HTMLTextAreaElement | null if (activeEl && typeof activeEl.selectionStart === 'number') { - liveCursor = activeEl.selectionStart ?? cursorPosition + liveCursor = activeEl.selectionStart ?? cursorPositionRef.current if ('value' in activeEl && typeof activeEl.value === 'string') { liveValue = activeEl.value } @@ -1805,7 +1802,7 @@ export const TagDropdown: React.FC = ({ onSelect(newValue) onClose?.() }, - [inputValue, cursorPosition, workflowVariables, onSelect, onClose, getMergedSubBlocks] + [workflowVariables, onSelect, onClose, getMergedSubBlocks] ) handleTagSelectRef.current = handleTagSelect @@ -1877,9 +1874,6 @@ export const TagDropdown: React.FC = ({ }, registerFolder: (folderId, folderTitle, baseTag, group) => { baseFolderRef.current = { id: folderId, title: folderTitle, baseTag, group } - if (scrollAreaRef.current) { - scrollAreaRef.current.scrollTop = 0 - } }, }), [nestedPath] @@ -1892,13 +1886,9 @@ export const TagDropdown: React.FC = ({ } }, [visible]) - useEffect(() => setSelectedIndex(0), [searchTerm]) - useEffect(() => { - if (selectedIndex >= flatTagList.length) { - setSelectedIndex(Math.max(0, flatTagList.length - 1)) - } - }, [flatTagList.length, selectedIndex]) + setSelectedIndex(0) + }, [flatTagList.length]) useEffect(() => { if (visible) { @@ -1956,6 +1946,11 @@ export const TagDropdown: React.FC = ({ flatTagList={flatTagList} nestedBlockTagGroups={nestedBlockTagGroups} handleTagSelect={handleTagSelect} + onFolderEnter={() => { + if (scrollAreaRef.current) { + scrollAreaRef.current.scrollTop = 0 + } + }} /> = ({ {variableTags.map((tag: string) => { const variableInfo = variableInfoMap?.[tag] || null - const globalIndex = flatTagList.findIndex((item) => item.tag === tag) + const globalIndex = flatTagIndexMap.get(tag) ?? -1 return ( = ({ const rootTagFromTags = group.tags.find((tag) => tag === normalizedBlockName) const rootTag = rootTagFromTags || normalizedBlockName - const rootTagGlobalIndex = flatTagList.findIndex((item) => item.tag === rootTag) + const rootTagGlobalIndex = flatTagIndexMap.get(rootTag) ?? -1 return (
@@ -2054,6 +2049,7 @@ export const TagDropdown: React.FC = ({ nestedTag={nestedTag} group={group} flatTagList={flatTagList} + flatTagIndexMap={flatTagIndexMap} selectedIndex={selectedIndex} setSelectedIndex={setSelectedIndex} handleTagSelect={handleTagSelect} diff --git a/apps/sim/app/workspace/[workspaceId]/w/[workflowId]/components/panel/components/editor/components/sub-block/components/text/text.tsx b/apps/sim/app/workspace/[workspaceId]/w/[workflowId]/components/panel/components/editor/components/sub-block/components/text/text.tsx index ab8772d62..81d572148 100644 --- a/apps/sim/app/workspace/[workspaceId]/w/[workflowId]/components/panel/components/editor/components/sub-block/components/text/text.tsx +++ b/apps/sim/app/workspace/[workspaceId]/w/[workflowId]/components/panel/components/editor/components/sub-block/components/text/text.tsx @@ -17,7 +17,7 @@ interface TextProps { * * @remarks * - Automatically detects and renders HTML content safely - * - Applies prose styling for HTML content (links, code, lists, etc.) + * - Applies consistent styling for HTML content (links, code, lists, etc.) * - Falls back to plain text rendering for non-HTML content * * Note: This component renders trusted, internally-defined content only @@ -33,7 +33,7 @@ export function Text({ blockId, subBlockId, content, className }: TextProps) { className={`rounded-md border bg-[var(--surface-2)] p-4 shadow-sm ${className || ''}`} >
@@ -43,7 +43,7 @@ export function Text({ blockId, subBlockId, content, className }: TextProps) { return (
{content}
diff --git a/apps/sim/app/workspace/[workspaceId]/w/[workflowId]/components/panel/components/editor/components/sub-block/sub-block.test.ts b/apps/sim/app/workspace/[workspaceId]/w/[workflowId]/components/panel/components/editor/components/sub-block/sub-block.test.ts new file mode 100644 index 000000000..babce1898 --- /dev/null +++ b/apps/sim/app/workspace/[workspaceId]/w/[workflowId]/components/panel/components/editor/components/sub-block/sub-block.test.ts @@ -0,0 +1,261 @@ +/** + * @vitest-environment node + */ +import { describe, expect, it } from 'vitest' +import type { SubBlockConfig } from '@/blocks/types' + +const isFieldRequired = (config: SubBlockConfig, subBlockValues?: Record): boolean => { + if (!config.required) return false + if (typeof config.required === 'boolean') return config.required + + const evalCond = ( + cond: { + field: string + value: string | number | boolean | Array + not?: boolean + and?: { + field: string + value: string | number | boolean | Array | undefined + not?: boolean + } + }, + values: Record + ): boolean => { + const fieldValue = values[cond.field]?.value + const condValue = cond.value + + let match: boolean + if (Array.isArray(condValue)) { + match = condValue.includes(fieldValue) + } else { + match = fieldValue === condValue + } + + if (cond.not) match = !match + + if (cond.and) { + const andFieldValue = values[cond.and.field]?.value + const andCondValue = cond.and.value + let andMatch: boolean + if (Array.isArray(andCondValue)) { + andMatch = andCondValue.includes(andFieldValue) + } else { + andMatch = andFieldValue === andCondValue + } + if (cond.and.not) andMatch = !andMatch + match = match && andMatch + } + + return match + } + + const condition = typeof config.required === 'function' ? config.required() : config.required + return evalCond(condition, subBlockValues || {}) +} + +describe('isFieldRequired', () => { + describe('boolean required', () => { + it.concurrent('returns false when required is not set', () => { + const config = { id: 'test', type: 'short-input' } as SubBlockConfig + expect(isFieldRequired(config, {})).toBe(false) + }) + + it.concurrent('returns false when required is false', () => { + const config = { id: 'test', type: 'short-input', required: false } as SubBlockConfig + expect(isFieldRequired(config, {})).toBe(false) + }) + + it.concurrent('returns true when required is true', () => { + const config = { id: 'test', type: 'short-input', required: true } as SubBlockConfig + expect(isFieldRequired(config, {})).toBe(true) + }) + }) + + describe('conditional required - simple value matching', () => { + it.concurrent('returns true when field value matches condition value', () => { + const config = { + id: 'test', + type: 'short-input', + required: { field: 'operation', value: 'create_booking' }, + } as SubBlockConfig + const values = { operation: { value: 'create_booking' } } + expect(isFieldRequired(config, values)).toBe(true) + }) + + it.concurrent('returns false when field value does not match condition value', () => { + const config = { + id: 'test', + type: 'short-input', + required: { field: 'operation', value: 'create_booking' }, + } as SubBlockConfig + const values = { operation: { value: 'cancel_booking' } } + expect(isFieldRequired(config, values)).toBe(false) + }) + + it.concurrent('returns false when field is missing', () => { + const config = { + id: 'test', + type: 'short-input', + required: { field: 'operation', value: 'create_booking' }, + } as SubBlockConfig + expect(isFieldRequired(config, {})).toBe(false) + }) + + it.concurrent('returns false when field value is undefined', () => { + const config = { + id: 'test', + type: 'short-input', + required: { field: 'operation', value: 'create_booking' }, + } as SubBlockConfig + const values = { operation: { value: undefined } } + expect(isFieldRequired(config, values)).toBe(false) + }) + }) + + describe('conditional required - array value matching', () => { + it.concurrent('returns true when field value is in condition array', () => { + const config = { + id: 'test', + type: 'short-input', + required: { field: 'operation', value: ['create_booking', 'update_booking'] }, + } as SubBlockConfig + const values = { operation: { value: 'create_booking' } } + expect(isFieldRequired(config, values)).toBe(true) + }) + + it.concurrent('returns false when field value is not in condition array', () => { + const config = { + id: 'test', + type: 'short-input', + required: { field: 'operation', value: ['create_booking', 'update_booking'] }, + } as SubBlockConfig + const values = { operation: { value: 'cancel_booking' } } + expect(isFieldRequired(config, values)).toBe(false) + }) + }) + + describe('conditional required - negation', () => { + it.concurrent('returns false when field matches but not is true', () => { + const config = { + id: 'test', + type: 'short-input', + required: { field: 'operation', value: 'create_booking', not: true }, + } as SubBlockConfig + const values = { operation: { value: 'create_booking' } } + expect(isFieldRequired(config, values)).toBe(false) + }) + + it.concurrent('returns true when field does not match and not is true', () => { + const config = { + id: 'test', + type: 'short-input', + required: { field: 'operation', value: 'create_booking', not: true }, + } as SubBlockConfig + const values = { operation: { value: 'cancel_booking' } } + expect(isFieldRequired(config, values)).toBe(true) + }) + }) + + describe('conditional required - compound conditions', () => { + it.concurrent('returns true when both conditions match', () => { + const config = { + id: 'test', + type: 'short-input', + required: { + field: 'operation', + value: 'create_booking', + and: { field: 'hasEmail', value: true }, + }, + } as SubBlockConfig + const values = { + operation: { value: 'create_booking' }, + hasEmail: { value: true }, + } + expect(isFieldRequired(config, values)).toBe(true) + }) + + it.concurrent('returns false when first matches but and fails', () => { + const config = { + id: 'test', + type: 'short-input', + required: { + field: 'operation', + value: 'create_booking', + and: { field: 'hasEmail', value: true }, + }, + } as SubBlockConfig + const values = { + operation: { value: 'create_booking' }, + hasEmail: { value: false }, + } + expect(isFieldRequired(config, values)).toBe(false) + }) + }) +}) + +describe('condition + required equivalence', () => { + const conditionValue = { field: 'operation', value: 'calcom_create_booking' } + + const configWithConditionalRequired = { + id: 'attendeeName', + type: 'short-input', + condition: conditionValue, + required: conditionValue, + } as SubBlockConfig + + const configWithSimpleRequired = { + id: 'attendeeName', + type: 'short-input', + condition: conditionValue, + required: true, + } as SubBlockConfig + + describe('when condition IS met (field is visible)', () => { + const valuesWhenVisible = { operation: { value: 'calcom_create_booking' } } + + it.concurrent('conditional required returns true', () => { + expect(isFieldRequired(configWithConditionalRequired, valuesWhenVisible)).toBe(true) + }) + + it.concurrent('simple required returns true', () => { + expect(isFieldRequired(configWithSimpleRequired, valuesWhenVisible)).toBe(true) + }) + + it.concurrent('both configs produce the same result', () => { + const conditionalResult = isFieldRequired(configWithConditionalRequired, valuesWhenVisible) + const simpleResult = isFieldRequired(configWithSimpleRequired, valuesWhenVisible) + expect(conditionalResult).toBe(simpleResult) + }) + }) + + describe('when condition is NOT met (field is hidden)', () => { + const valuesWhenHidden = { operation: { value: 'calcom_cancel_booking' } } + + it.concurrent('conditional required returns false', () => { + expect(isFieldRequired(configWithConditionalRequired, valuesWhenHidden)).toBe(false) + }) + + it.concurrent('simple required returns true but field is hidden', () => { + expect(isFieldRequired(configWithSimpleRequired, valuesWhenHidden)).toBe(true) + }) + + it.concurrent('results differ but field is hidden when condition fails', () => { + const conditionalResult = isFieldRequired(configWithConditionalRequired, valuesWhenHidden) + const simpleResult = isFieldRequired(configWithSimpleRequired, valuesWhenHidden) + expect(conditionalResult).not.toBe(simpleResult) + }) + }) + + describe('practical equivalence for user-facing behavior', () => { + it.concurrent('when field is visible both show required indicator', () => { + const valuesWhenVisible = { operation: { value: 'calcom_create_booking' } } + const showsRequiredIndicatorA = isFieldRequired( + configWithConditionalRequired, + valuesWhenVisible + ) + const showsRequiredIndicatorB = isFieldRequired(configWithSimpleRequired, valuesWhenVisible) + expect(showsRequiredIndicatorA).toBe(true) + expect(showsRequiredIndicatorB).toBe(true) + }) + }) +}) diff --git a/apps/sim/app/workspace/[workspaceId]/w/[workflowId]/components/panel/components/editor/components/sub-block/sub-block.tsx b/apps/sim/app/workspace/[workspaceId]/w/[workflowId]/components/panel/components/editor/components/sub-block/sub-block.tsx index d3bf23e40..cd1e9168e 100644 --- a/apps/sim/app/workspace/[workspaceId]/w/[workflowId]/components/panel/components/editor/components/sub-block/sub-block.tsx +++ b/apps/sim/app/workspace/[workspaceId]/w/[workflowId]/components/panel/components/editor/components/sub-block/sub-block.tsx @@ -1,6 +1,6 @@ -import { type JSX, type MouseEvent, memo, useRef, useState } from 'react' +import { type JSX, type MouseEvent, memo, useCallback, useRef, useState } from 'react' import { isEqual } from 'lodash' -import { AlertTriangle, ArrowLeftRight, ArrowUp } from 'lucide-react' +import { AlertTriangle, ArrowLeftRight, ArrowUp, Check, Clipboard } from 'lucide-react' import { Button, Input, Label, Tooltip } from '@/components/emcn/components' import { cn } from '@/lib/core/utils/cn' import type { FieldDiffStatus } from '@/lib/workflows/diff/types' @@ -44,6 +44,7 @@ import { } from '@/app/workspace/[workspaceId]/w/[workflowId]/components/panel/components/editor/components/sub-block/components' import { useDependsOnGate } from '@/app/workspace/[workspaceId]/w/[workflowId]/components/panel/components/editor/components/sub-block/hooks/use-depends-on-gate' import type { SubBlockConfig } from '@/blocks/types' +import { useWebhookManagement } from '@/hooks/use-webhook-management' /** * Interface for wand control handlers exposed by sub-block inputs @@ -195,7 +196,12 @@ const renderLabel = ( disabled?: boolean onToggle?: () => void }, - canonicalToggleIsDisabled?: boolean + canonicalToggleIsDisabled?: boolean, + copyState?: { + showCopyButton: boolean + copied: boolean + onCopy: () => void + } ): JSX.Element | null => { if (config.type === 'switch') return null if (!config.title) return null @@ -203,6 +209,7 @@ const renderLabel = ( const required = isFieldRequired(config, subBlockValues) const showWand = wandState?.isWandEnabled && !wandState.isPreview && !wandState.disabled const showCanonicalToggle = !!canonicalToggle && !wandState?.isPreview + const showCopy = copyState?.showCopyButton && !wandState?.isPreview const canonicalToggleDisabledResolved = canonicalToggleIsDisabled ?? canonicalToggle?.disabled return ( @@ -226,7 +233,28 @@ const renderLabel = ( )} -
+
+ {showCopy && ( + + + + + +

{copyState.copied ? 'Copied!' : 'Copy'}

+ + + )} {showWand && ( <> {!wandState.isSearchActive ? ( @@ -238,14 +266,19 @@ const renderLabel = ( Generate ) : ( -
+
) => wandState.onSearchChange(e.target.value) } - onBlur={wandState.onSearchBlur} + onBlur={(e: React.FocusEvent) => { + // Only close if clicking outside the input container (not on the submit button) + const relatedTarget = e.relatedTarget as HTMLElement | null + if (relatedTarget?.closest('button')) return + wandState.onSearchBlur() + }} onKeyDown={(e: React.KeyboardEvent) => { if ( e.key === 'Enter' && @@ -259,7 +292,7 @@ const renderLabel = ( }} disabled={wandState.isStreaming} className={cn( - 'h-5 max-w-[200px] flex-1 text-[11px]', + 'h-5 min-w-[80px] flex-1 text-[11px]', wandState.isStreaming && 'text-muted-foreground' )} placeholder='Generate with AI...' @@ -385,9 +418,18 @@ function SubBlockComponent({ const [isValidJson, setIsValidJson] = useState(true) const [isSearchActive, setIsSearchActive] = useState(false) const [searchQuery, setSearchQuery] = useState('') + const [copied, setCopied] = useState(false) const searchInputRef = useRef(null) const wandControlRef = useRef(null) + // Use webhook management hook when config has useWebhookUrl enabled + const webhookManagement = useWebhookManagement({ + blockId, + triggerId: undefined, + isPreview, + useWebhookUrl: config.useWebhookUrl, + }) + const handleMouseDown = (e: MouseEvent): void => { e.stopPropagation() } @@ -398,6 +440,18 @@ function SubBlockComponent({ const isWandEnabled = config.wandConfig?.enabled ?? false + /** + * Handles copying the webhook URL to clipboard. + */ + const handleCopy = useCallback(() => { + const textToCopy = webhookManagement?.webhookUrl + if (textToCopy) { + navigator.clipboard.writeText(textToCopy) + setCopied(true) + setTimeout(() => setCopied(false), 2000) + } + }, [webhookManagement?.webhookUrl]) + /** * Handles wand icon click to activate inline prompt mode. * Focuses the input after a brief delay to ensure DOM is ready. @@ -482,7 +536,6 @@ function SubBlockComponent({ placeholder={config.placeholder} password={config.password} readOnly={config.readOnly} - showCopyButton={config.showCopyButton} useWebhookUrl={config.useWebhookUrl} config={config} isPreview={isPreview} @@ -979,7 +1032,12 @@ function SubBlockComponent({ searchInputRef, }, canonicalToggle, - Boolean(canonicalToggle?.disabled || disabled || isPreview) + Boolean(canonicalToggle?.disabled || disabled || isPreview), + { + showCopyButton: Boolean(config.showCopyButton && config.useWebhookUrl), + copied, + onCopy: handleCopy, + } )} {renderInput()}
diff --git a/apps/sim/app/workspace/[workspaceId]/w/components/sidebar/components/workflow-list/components/delete-modal/delete-modal.tsx b/apps/sim/app/workspace/[workspaceId]/w/components/sidebar/components/workflow-list/components/delete-modal/delete-modal.tsx index 597d0e6cd..f64986291 100644 --- a/apps/sim/app/workspace/[workspaceId]/w/components/sidebar/components/workflow-list/components/delete-modal/delete-modal.tsx +++ b/apps/sim/app/workspace/[workspaceId]/w/components/sidebar/components/workflow-list/components/delete-modal/delete-modal.tsx @@ -21,8 +21,9 @@ interface DeleteModalProps { isDeleting: boolean /** * Type of item being deleted + * - 'mixed' is used when both workflows and folders are selected */ - itemType: 'workflow' | 'folder' | 'workspace' + itemType: 'workflow' | 'folder' | 'workspace' | 'mixed' /** * Name(s) of the item(s) being deleted (optional, for display) * Can be a single name or an array of names for multiple items @@ -54,7 +55,9 @@ export function DeleteModal({ if (itemType === 'workflow') { title = isMultiple ? 'Delete Workflows' : 'Delete Workflow' } else if (itemType === 'folder') { - title = 'Delete Folder' + title = isMultiple ? 'Delete Folders' : 'Delete Folder' + } else if (itemType === 'mixed') { + title = 'Delete Items' } else { title = 'Delete Workspace' } @@ -85,6 +88,18 @@ export function DeleteModal({ } if (itemType === 'folder') { + if (isMultiple) { + return ( + <> + Are you sure you want to delete{' '} + + {displayNames.join(', ')} + + ? This will permanently remove all workflows, logs, and knowledge bases within these + folders. + + ) + } if (isSingle && displayNames.length > 0) { return ( <> @@ -97,6 +112,23 @@ export function DeleteModal({ return 'Are you sure you want to delete this folder? This will permanently remove all associated workflows, logs, and knowledge bases.' } + if (itemType === 'mixed') { + if (displayNames.length > 0) { + return ( + <> + Are you sure you want to delete{' '} + + {displayNames.join(', ')} + + ? This will permanently remove all selected workflows and folders, including their + contents. + + ) + } + return 'Are you sure you want to delete the selected items? This will permanently remove all selected workflows and folders, including their contents.' + } + + // workspace type if (isSingle && displayNames.length > 0) { return ( <> diff --git a/apps/sim/app/workspace/[workspaceId]/w/components/sidebar/components/workflow-list/components/folder-item/folder-item.tsx b/apps/sim/app/workspace/[workspaceId]/w/components/sidebar/components/workflow-list/components/folder-item/folder-item.tsx index 7bd228d25..7cca37364 100644 --- a/apps/sim/app/workspace/[workspaceId]/w/components/sidebar/components/workflow-list/components/folder-item/folder-item.tsx +++ b/apps/sim/app/workspace/[workspaceId]/w/components/sidebar/components/workflow-list/components/folder-item/folder-item.tsx @@ -1,6 +1,6 @@ 'use client' -import { useCallback, useMemo, useState } from 'react' +import { useCallback, useMemo, useRef, useState } from 'react' import { createLogger } from '@sim/logger' import clsx from 'clsx' import { ChevronRight, Folder, FolderOpen, MoreHorizontal } from 'lucide-react' @@ -14,17 +14,23 @@ import { useFolderExpand, useItemDrag, useItemRename, + useSidebarDragContext, } from '@/app/workspace/[workspaceId]/w/components/sidebar/hooks' import { SIDEBAR_SCROLL_EVENT } from '@/app/workspace/[workspaceId]/w/components/sidebar/sidebar' import { useCanDelete, useDeleteFolder, + useDeleteSelection, useDuplicateFolder, + useDuplicateSelection, useExportFolder, + useExportSelection, } from '@/app/workspace/[workspaceId]/w/hooks' import { useCreateFolder, useUpdateFolder } from '@/hooks/queries/folders' import { useCreateWorkflow } from '@/hooks/queries/workflows' +import { useFolderStore } from '@/stores/folders/store' import type { FolderTreeNode } from '@/stores/folders/types' +import { useWorkflowRegistry } from '@/stores/workflows/registry/store' import { generateCreativeWorkflowName } from '@/stores/workflows/registry/utils' const logger = createLogger('FolderItem') @@ -37,26 +43,21 @@ interface FolderItemProps { onDragEnter?: (e: React.DragEvent) => void onDragLeave?: (e: React.DragEvent) => void } + onFolderClick?: (folderId: string, shiftKey: boolean, metaKey: boolean) => void onDragStart?: () => void onDragEnd?: () => void } -/** - * FolderItem component displaying a single folder with drag and expand/collapse support. - * Uses item drag and folder expand hooks for unified behavior. - * Supports hover-to-expand during drag operations via hoverHandlers. - * - * @param props - Component props - * @returns Folder item with drag and expand support - */ export function FolderItem({ folder, level, dragDisabled = false, hoverHandlers, + onFolderClick, onDragStart: onDragStartProp, onDragEnd: onDragEndProp, }: FolderItemProps) { + const { isAnyDragActive } = useSidebarDragContext() const params = useParams() const router = useRouter() const workspaceId = params.workspaceId as string @@ -64,27 +65,64 @@ export function FolderItem({ const createWorkflowMutation = useCreateWorkflow() const createFolderMutation = useCreateFolder() const userPermissions = useUserPermissionsContext() + const selectedFolders = useFolderStore((state) => state.selectedFolders) + const isSelected = selectedFolders.has(folder.id) - const { canDeleteFolder } = useCanDelete({ workspaceId }) - const canDelete = useMemo(() => canDeleteFolder(folder.id), [canDeleteFolder, folder.id]) + const { canDeleteFolder, canDeleteWorkflows } = useCanDelete({ workspaceId }) const [isDeleteModalOpen, setIsDeleteModalOpen] = useState(false) + const [deleteItemType, setDeleteItemType] = useState<'folder' | 'mixed'>('folder') + const [deleteItemNames, setDeleteItemNames] = useState(folder.name) - const { isDeleting, handleDeleteFolder } = useDeleteFolder({ + const capturedSelectionRef = useRef<{ + workflowIds: string[] + folderIds: string[] + isMixed: boolean + names: string[] + } | null>(null) + + const [canDeleteSelection, setCanDeleteSelection] = useState(true) + + const { isDeleting: isDeletingThisFolder, handleDeleteFolder: handleDeleteThisFolder } = + useDeleteFolder({ + workspaceId, + folderIds: folder.id, + onSuccess: () => setIsDeleteModalOpen(false), + }) + + const { isDeleting: isDeletingSelection, handleDeleteSelection } = useDeleteSelection({ workspaceId, - folderIds: folder.id, + workflowIds: capturedSelectionRef.current?.workflowIds || [], + folderIds: capturedSelectionRef.current?.folderIds || [], + isActiveWorkflow: (id) => id === params.workflowId, onSuccess: () => setIsDeleteModalOpen(false), }) - const { handleDuplicateFolder } = useDuplicateFolder({ + const isDeleting = isDeletingThisFolder || isDeletingSelection + + const { handleDuplicateFolder: handleDuplicateThisFolder } = useDuplicateFolder({ workspaceId, folderIds: folder.id, }) - const { isExporting, hasWorkflows, handleExportFolder } = useExportFolder({ + const { isDuplicating: isDuplicatingSelection, handleDuplicateSelection } = useDuplicateSelection( + { + workspaceId, + } + ) + + const { + isExporting: isExportingThisFolder, + hasWorkflows, + handleExportFolder: handleExportThisFolder, + } = useExportFolder({ folderId: folder.id, }) + const { isExporting: isExportingSelection, handleExportSelection } = useExportSelection() + + const isExporting = isExportingThisFolder || isExportingSelection + const { isExpanded, handleToggleExpanded, @@ -94,11 +132,8 @@ export function FolderItem({ folderId: folder.id, }) - /** - * Handle create workflow in folder using React Query mutation. - * Generates name and color upfront for optimistic UI updates. - * The UI disables the trigger when isPending, so no guard needed here. - */ + const isEditingRef = useRef(false) + const handleCreateWorkflowInFolder = useCallback(async () => { try { const name = generateCreativeWorkflowName() @@ -123,10 +158,6 @@ export function FolderItem({ } }, [createWorkflowMutation, workspaceId, folder.id, router, expandFolder]) - /** - * Handle create sub-folder using React Query mutation. - * Creates a new folder inside the current folder. - */ const handleCreateFolderInFolder = useCallback(async () => { try { const result = await createFolderMutation.mutateAsync({ @@ -147,12 +178,25 @@ export function FolderItem({ const onDragStart = useCallback( (e: React.DragEvent) => { - if (isEditing) { + if (isEditingRef.current) { e.preventDefault() return } - e.dataTransfer.setData('folder-id', folder.id) + const { selectedWorkflows, selectedFolders } = useFolderStore.getState() + const isCurrentlySelected = selectedFolders.has(folder.id) + + const selection = isCurrentlySelected + ? { + workflowIds: Array.from(selectedWorkflows), + folderIds: Array.from(selectedFolders), + } + : { + workflowIds: [], + folderIds: [folder.id], + } + + e.dataTransfer.setData('sidebar-selection', JSON.stringify(selection)) e.dataTransfer.effectAllowed = 'move' onDragStartProp?.() }, @@ -177,11 +221,59 @@ export function FolderItem({ isOpen: isContextMenuOpen, position, menuRef, - handleContextMenu, + handleContextMenu: handleContextMenuBase, closeMenu, preventDismiss, } = useContextMenu() + const captureSelectionState = useCallback(() => { + const store = useFolderStore.getState() + const isFolderSelected = store.selectedFolders.has(folder.id) + + if (!isFolderSelected) { + store.selectFolder(folder.id) + } + + const finalFolderSelection = useFolderStore.getState().selectedFolders + const finalWorkflowSelection = useFolderStore.getState().selectedWorkflows + + const folderIds = Array.from(finalFolderSelection) + const workflowIds = Array.from(finalWorkflowSelection) + const isMixed = folderIds.length > 0 && workflowIds.length > 0 + + const { folders } = useFolderStore.getState() + const { workflows } = useWorkflowRegistry.getState() + + const names: string[] = [] + for (const id of folderIds) { + const f = folders[id] + if (f) names.push(f.name) + } + for (const id of workflowIds) { + const w = workflows[id] + if (w) names.push(w.name) + } + + capturedSelectionRef.current = { + workflowIds, + folderIds, + isMixed, + names, + } + + const canDeleteAllFolders = folderIds.every((id) => canDeleteFolder(id)) + const canDeleteAllWorkflows = workflowIds.length === 0 || canDeleteWorkflows(workflowIds) + setCanDeleteSelection(canDeleteAllFolders && canDeleteAllWorkflows) + }, [folder.id, canDeleteFolder, canDeleteWorkflows]) + + const handleContextMenu = useCallback( + (e: React.MouseEvent) => { + captureSelectionState() + handleContextMenuBase(e) + }, + [captureSelectionState, handleContextMenuBase] + ) + const { isEditing, editValue, @@ -204,9 +296,8 @@ export function FolderItem({ itemId: folder.id, }) - /** - * Handle double-click on folder name to enter rename mode - */ + isEditingRef.current = isEditing + const handleDoubleClick = useCallback( (e: React.MouseEvent) => { e.preventDefault() @@ -216,11 +307,6 @@ export function FolderItem({ [handleStartEdit] ) - /** - * Handle click - toggles folder expansion - * - * @param e - React mouse event - */ const handleClick = useCallback( (e: React.MouseEvent) => { e.stopPropagation() @@ -229,14 +315,21 @@ export function FolderItem({ e.preventDefault() return } + + const isModifierClick = e.shiftKey || e.metaKey || e.ctrlKey + + if (isModifierClick && onFolderClick) { + e.preventDefault() + onFolderClick(folder.id, e.shiftKey, e.metaKey || e.ctrlKey) + return + } + + useFolderStore.getState().clearFolderSelection() handleToggleExpanded() }, - [handleToggleExpanded, shouldPreventClickRef, isEditing] + [handleToggleExpanded, shouldPreventClickRef, isEditing, onFolderClick, folder.id] ) - /** - * Combined keyboard handler for both expand and rename - */ const handleKeyDown = useCallback( (e: React.KeyboardEvent) => { if (isEditing) { @@ -248,18 +341,12 @@ export function FolderItem({ [isEditing, handleRenameKeyDown, handleExpandKeyDown] ) - /** - * Handle more button pointerdown - prevents click-outside dismissal when toggling - */ const handleMorePointerDown = useCallback(() => { if (isContextMenuOpen) { preventDismiss() } }, [isContextMenuOpen, preventDismiss]) - /** - * Handle more button click - toggles context menu at button position - */ const handleMoreClick = useCallback( (e: React.MouseEvent) => { e.preventDefault() @@ -270,17 +357,83 @@ export function FolderItem({ return } + captureSelectionState() const rect = e.currentTarget.getBoundingClientRect() - handleContextMenu({ + handleContextMenuBase({ preventDefault: () => {}, stopPropagation: () => {}, clientX: rect.right, clientY: rect.top, } as React.MouseEvent) }, - [isContextMenuOpen, closeMenu, handleContextMenu] + [isContextMenuOpen, closeMenu, captureSelectionState, handleContextMenuBase] ) + const handleOpenDeleteModal = useCallback(() => { + if (!capturedSelectionRef.current) return + + const { isMixed, names, folderIds } = capturedSelectionRef.current + + if (isMixed) { + setDeleteItemType('mixed') + setDeleteItemNames(names) + } else if (folderIds.length > 1) { + setDeleteItemType('folder') + setDeleteItemNames(names) + } else { + setDeleteItemType('folder') + setDeleteItemNames(folder.name) + } + + setIsDeleteModalOpen(true) + }, [folder.name]) + + const handleConfirmDelete = useCallback(async () => { + if (!capturedSelectionRef.current) return + + const { isMixed, folderIds } = capturedSelectionRef.current + + if (isMixed || folderIds.length > 1) { + await handleDeleteSelection() + } else { + await handleDeleteThisFolder() + } + }, [handleDeleteSelection, handleDeleteThisFolder]) + + const handleExport = useCallback(async () => { + if (!capturedSelectionRef.current) return + + const { isMixed, workflowIds, folderIds } = capturedSelectionRef.current + + if (isMixed || folderIds.length > 1) { + await handleExportSelection(workflowIds, folderIds) + } else { + await handleExportThisFolder() + } + }, [handleExportSelection, handleExportThisFolder]) + + const handleDuplicate = useCallback(async () => { + if (!capturedSelectionRef.current) return + + const { isMixed, workflowIds, folderIds } = capturedSelectionRef.current + + if (isMixed || folderIds.length > 1) { + await handleDuplicateSelection(workflowIds, folderIds) + } else { + await handleDuplicateThisFolder() + } + }, [handleDuplicateSelection, handleDuplicateThisFolder]) + + const isMixedSelection = useMemo(() => { + return capturedSelectionRef.current?.isMixed ?? false + }, [isContextMenuOpen]) + + const hasExportableContent = useMemo(() => { + if (!capturedSelectionRef.current) return hasWorkflows + const { workflowIds } = capturedSelectionRef.current + return workflowIds.length > 0 || hasWorkflows + }, [isContextMenuOpen, hasWorkflows]) + return ( <>