Skip to content

Commit 3babc64

Browse files
committed
fix: clarify Stripe guidance and log snapshot defaults
1 parent 9b068c3 commit 3babc64

11 files changed

Lines changed: 17 additions & 16 deletions

File tree

‎apps/docs/content/docs/cli/logs.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ sim logs get <runId> [options]
3131

3232
| Option | Required | Description |
3333
| --- | --- | --- |
34-
| `--include-workflow-state` | No | Include the saved workflow snapshot. Set false to omit block configuration from a log read. Other run fields are unchanged. |
34+
| `--include-workflow-state` | No | Include the saved workflow snapshot (default: true). Set false to omit block configuration from a log read. Other run fields are unchanged. |
3535
| `--no-include-workflow-state` | No | Send --include-workflow-state as false. |
3636
| `--trace` | No | Show expanded trace spans with inputs, outputs, errors, timing, and cost. |
3737

‎apps/docs/content/docs/cli/reference.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2731,7 +2731,7 @@ sim logs get <runId> [options]
27312731

27322732
| Option | Required | Description |
27332733
| --- | --- | --- |
2734-
| `--include-workflow-state` | No | Include the saved workflow snapshot. Set false to omit block configuration from a log read. Other run fields are unchanged. |
2734+
| `--include-workflow-state` | No | Include the saved workflow snapshot (default: true). Set false to omit block configuration from a log read. Other run fields are unchanged. |
27352735
| `--no-include-workflow-state` | No | Send --include-workflow-state as false. |
27362736
| `--trace` | No | Show expanded trace spans with inputs, outputs, errors, timing, and cost. |
27372737

‎apps/docs/content/docs/integrations/stripe.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1222,7 +1222,7 @@ Cancel a subscription
12221222

12231223
### Stripe Resume Subscription
12241224

1225-
Resume a subscription that was scheduled for cancellation
1225+
Resume a paused subscription
12261226

12271227
#### Input
12281228

@@ -1387,7 +1387,7 @@ Search one page of subscriptions using query syntax. Pass metadata.next_page as
13871387
| Parameter | Type | Required | Description |
13881388
| --------- | ---- | -------- | ----------- |
13891389
| `apiKey` | string | Yes | Stripe API key \(secret key\) |
1390-
| `query` | string | Yes | Search query \(e.g., "status:'active' AND customer:'cus_xxx'"\) |
1390+
| `query` | string | Yes | Search query \(e.g., "status:'active' AND metadata\['order_id'\]:'6735'"\) |
13911391
| `page` | string | No | Pagination token from metadata.next_page. Omit for the first page and keep the same query. |
13921392
| `limit` | number | No | Number of results to return \(default 10, max 100\) |
13931393

‎apps/docs/openapi-v2-logs.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -388,9 +388,9 @@
388388
"name": "includeWorkflowState",
389389
"in": "query",
390390
"required": false,
391-
"description": "Include the saved workflow snapshot. Set false to omit block configuration from a log read. Other run fields are unchanged.",
391+
"description": "Include the saved workflow snapshot (default: true). Set false to omit block configuration from a log read. Other run fields are unchanged.",
392392
"schema": {
393-
"description": "Include the saved workflow snapshot. Set false to omit block configuration from a log read. Other run fields are unchanged.",
393+
"description": "Include the saved workflow snapshot (default: true). Set false to omit block configuration from a log read. Other run fields are unchanged.",
394394
"type": "boolean"
395395
}
396396
}

‎apps/sim/blocks/blocks/stripe.ts‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1123,19 +1123,20 @@ export const StripeBlockMeta = {
11231123
description:
11241124
'Create and confirm a Stripe payment intent to collect a charge from a customer.',
11251125
content:
1126-
'# Collect Payment\n\nCharge a customer by creating and confirming a payment intent.\n\n## Steps\n1. Run Create Payment Intent with the amount, currency, and customer.\n2. Confirm the intent with Confirm Payment Intent, or Capture Payment Intent if it was created for manual capture.\n3. If a charge needs to be aborted, run Cancel Payment Intent instead.\n\n## Output\nReturn the payment intent ID, its status (succeeded, requires action, or canceled), and the captured amount.',
1126+
'# Collect Payment\n\nCharge a customer by creating and confirming a payment intent.\n\n## Steps\n1. Run Create Payment Intent with the amount, currency, and customer.\n2. Confirm the intent with Confirm Payment Intent and a payment method. If the confirmed intent has status requires_capture, run Capture Payment Intent to collect the authorized funds.\n3. If a charge needs to be aborted, run Cancel Payment Intent instead.\n\n## Output\nReturn the payment intent ID, its status (succeeded, requires action, or canceled), and the captured amount.',
11271127
},
11281128
{
11291129
name: 'manage-subscription',
1130-
description: 'Create, update, pause, or cancel a Stripe subscription for a customer.',
1130+
description:
1131+
'Create a Stripe subscription, manage its cancellation, or resume a paused subscription.',
11311132
content:
1132-
'# Manage Subscription\n\nHandle the lifecycle of a recurring subscription.\n\n## Steps\n1. To start a subscription, run Create Subscription with the customer and price items.\n2. To change a plan, run Update Subscription with the new items. To pause and later restart, use Cancel Subscription or Resume Subscription as appropriate.\n3. Confirm the current state with Retrieve Subscription.\n\n## Output\nReturn the subscription ID, its status, current period end, and the plan items, and note exactly what changed.',
1133+
'# Manage Subscription\n\nHandle the lifecycle of a recurring subscription.\n\n## Steps\n1. To start a subscription, run Create Subscription with the customer and price items.\n2. Use Update Subscription with cancel_at_period_end to schedule or reverse a cancellation before it takes effect. Use Cancel Subscription only for immediate cancellation. Resume Subscription applies only to a paused subscription; it does not restart a canceled subscription.\n3. Confirm the current state with Retrieve Subscription.\n\n## Output\nReturn the subscription ID, its status, and the returned subscription items, and note exactly what changed.',
11331134
},
11341135
{
11351136
name: 'issue-invoice',
11361137
description: 'Create, finalize, and send a Stripe invoice to a customer, then track payment.',
11371138
content:
1138-
'# Issue Invoice\n\nBill a customer with a Stripe invoice.\n\n## Steps\n1. Run Create Invoice for the customer with the line items.\n2. Run Finalize Invoice to lock it, then Send Invoice to deliver it to the customer.\n3. Track payment with Retrieve Invoice, or run Pay Invoice to charge a saved payment method. Use Void Invoice to cancel an unpaid invoice.\n\n## Output\nReturn the invoice ID, its status (draft, open, paid, or void), the amount due, and the hosted invoice URL when available.',
1139+
'# Issue Invoice\n\nBill a customer with a Stripe invoice.\n\n## Steps\n1. Run Create Invoice for the customer. This tool does not add line items; add them in Stripe and verify the draft with Retrieve Invoice before finalizing.\n2. Run Finalize Invoice to lock it, then Send Invoice to deliver it to the customer.\n3. Track payment with Retrieve Invoice, or run Pay Invoice to charge a saved payment method. Use Void Invoice to cancel an unpaid invoice.\n\n## Output\nReturn the invoice ID, its status (draft, open, paid, or void), the amount due, and the hosted invoice URL when available.',
11391140
},
11401141
{
11411142
name: 'find-customer-activity',

‎apps/sim/lib/api/contracts/v2/logs.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -720,7 +720,7 @@ export const v2GetLogContract = defineRouteContract({
720720
includeWorkflowState: booleanQueryFlagSchema
721721
.default(true)
722722
.describe(
723-
'Include the saved workflow snapshot. Set false to omit block configuration from a log read. Other run fields are unchanged.'
723+
'Include the saved workflow snapshot (default: true). Set false to omit block configuration from a log read. Other run fields are unchanged.'
724724
),
725725
})
726726
.strict()

‎apps/sim/tools/generated/tool-metadata.ts‎

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

‎apps/sim/tools/stripe/resume_subscription.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ export const stripeResumeSubscriptionTool: ToolConfig<
1818
> = {
1919
id: 'stripe_resume_subscription',
2020
name: 'Stripe Resume Subscription',
21-
description: 'Resume a subscription that was scheduled for cancellation',
21+
description: 'Resume a paused subscription',
2222
version: '1.0.0',
2323

2424
params: {

‎apps/sim/tools/stripe/search_subscriptions.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ export const stripeSearchSubscriptionsTool: ToolConfig<
2323
type: 'string',
2424
required: true,
2525
visibility: 'user-or-llm',
26-
description: "Search query (e.g., \"status:'active' AND customer:'cus_xxx'\")",
26+
description: "Search query (e.g., \"status:'active' AND metadata['order_id']:'6735'\")",
2727
},
2828
page: {
2929
type: 'string',

‎packages/deployment-config/src/integrations.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24693,7 +24693,7 @@
2469324693
},
2469424694
{
2469524695
"name": "Resume Subscription",
24696-
"description": "Resume a subscription that was scheduled for cancellation"
24696+
"description": "Resume a paused subscription"
2469724697
},
2469824698
{
2469924699
"name": "List Subscriptions",

0 commit comments

Comments
 (0)