docs(api): update simulate_clearing method documentation in transactions

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 214
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/lithic/lithic-9e397c65ffb81e2928b8ecf979769a79131ae6058b6fb373a5e930dc8a168732.yml
-openapi_spec_hash: 93aea3855d2d1c390107d223762aa818
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/lithic/lithic-1514911f233cb8bf0d6752c45bfa53a61b8f9b8ff215a4ea94a95f9505911000.yml
+openapi_spec_hash: 9820a9c9a4ff778c627041eb53fd4ee5
 config_hash: 5bb913c05ebeb301ec925b16e75bb251

packages/mcp-server/src/local-docs-search.ts

@@ -7187,13 +7187,13 @@ const EMBEDDED_METHODS: MethodEntry[] = [
     httpMethod: 'post',
     summary: 'Simulate clearing',
     description:
-      'Clears an existing authorization, either debit or credit. After this event, the transaction transitions from `PENDING` to `SETTLED` status.\n\nIf `amount` is not set, the full amount of the transaction will be cleared. Transactions that have already cleared, either partially or fully, cannot be cleared again using this endpoint.\n',
+      'Clears an existing authorization, either debit or credit. After this event, the transaction transitions from `PENDING` to `SETTLED` status.\n\nIf `amount` is not set, the full amount of the transaction will be cleared. This endpoint may be called multiple times against the same authorization to simulate a multiple-completion scenario, with each call creating a separate clearing event.\n',
     stainlessPath: '(resource) transactions > (method) simulate_clearing',
     qualified: 'client.transactions.simulateClearing',
     params: ['token: string;', 'amount?: number;'],
     response: '{ debugging_request_id?: string; }',
     markdown:
-      "## simulate_clearing\n\n`client.transactions.simulateClearing(token: string, amount?: number): { debugging_request_id?: string; }`\n\n**post** `/v1/simulate/clearing`\n\nClears an existing authorization, either debit or credit. After this event, the transaction transitions from `PENDING` to `SETTLED` status.\n\nIf `amount` is not set, the full amount of the transaction will be cleared. Transactions that have already cleared, either partially or fully, cannot be cleared again using this endpoint.\n\n\n### Parameters\n\n- `token: string`\n  The transaction token returned from the /v1/simulate/authorize response.\n\n- `amount?: number`\n  Amount (in cents) to clear. Typically this will match the amount in the original authorization, but can be higher or lower. The sign of this amount will automatically match the sign of the original authorization's amount. For example, entering 100 in this field will result in a -100 amount in the transaction, if the original authorization is a credit authorization.\n\nIf `amount` is not set, the full amount of the transaction will be cleared. Transactions that have already cleared, either partially or fully, cannot be cleared again using this endpoint.\n\n\n### Returns\n\n- `{ debugging_request_id?: string; }`\n\n  - `debugging_request_id?: string`\n\n### Example\n\n```typescript\nimport Lithic from 'lithic';\n\nconst client = new Lithic();\n\nconst response = await client.transactions.simulateClearing({ token: 'fabd829d-7f7b-4432-a8f2-07ea4889aaac' });\n\nconsole.log(response);\n```",
+      "## simulate_clearing\n\n`client.transactions.simulateClearing(token: string, amount?: number): { debugging_request_id?: string; }`\n\n**post** `/v1/simulate/clearing`\n\nClears an existing authorization, either debit or credit. After this event, the transaction transitions from `PENDING` to `SETTLED` status.\n\nIf `amount` is not set, the full amount of the transaction will be cleared. This endpoint may be called multiple times against the same authorization to simulate a multiple-completion scenario, with each call creating a separate clearing event.\n\n\n### Parameters\n\n- `token: string`\n  The transaction token returned from the /v1/simulate/authorize response.\n\n- `amount?: number`\n  Amount (in cents) to clear. Typically this will match the amount in the original authorization, but can be higher or lower. The sign of this amount will automatically match the sign of the original authorization's amount. For example, entering 100 in this field will result in a -100 amount in the transaction, if the original authorization is a credit authorization.\n\nIf `amount` is not set, the full amount of the transaction will be cleared. This endpoint may be called multiple times against the same authorization to simulate a multiple-completion scenario, with each call creating a separate clearing event.\n\n\n### Returns\n\n- `{ debugging_request_id?: string; }`\n\n  - `debugging_request_id?: string`\n\n### Example\n\n```typescript\nimport Lithic from 'lithic';\n\nconst client = new Lithic();\n\nconst response = await client.transactions.simulateClearing({ token: 'fabd829d-7f7b-4432-a8f2-07ea4889aaac' });\n\nconsole.log(response);\n```",
     perLanguage: {
       typescript: {
         method: 'client.transactions.simulateClearing',

src/resources/transactions/transactions.ts

@@ -138,9 +138,10 @@ export class Transactions extends APIResource {
    * Clears an existing authorization, either debit or credit. After this event, the
    * transaction transitions from `PENDING` to `SETTLED` status.
    *
-   * If `amount` is not set, the full amount of the transaction will be cleared.
-   * Transactions that have already cleared, either partially or fully, cannot be
-   * cleared again using this endpoint.
+   * If `amount` is not set, the full amount of the transaction will be cleared. This
+   * endpoint may be called multiple times against the same authorization to simulate
+   * a multiple-completion scenario, with each call creating a separate clearing
+   * event.
    *
    * @example
    * ```ts
@@ -1440,9 +1441,10 @@ export interface TransactionSimulateClearingParams {
    * example, entering 100 in this field will result in a -100 amount in the
    * transaction, if the original authorization is a credit authorization.
    *
-   * If `amount` is not set, the full amount of the transaction will be cleared.
-   * Transactions that have already cleared, either partially or fully, cannot be
-   * cleared again using this endpoint.
+   * If `amount` is not set, the full amount of the transaction will be cleared. This
+   * endpoint may be called multiple times against the same authorization to simulate
+   * a multiple-completion scenario, with each call creating a separate clearing
+   * event.
    */
   amount?: number;
 }

yarn.lock

@@ -1220,9 +1220,9 @@ baseline-browser-mapping@^2.9.0:
   integrity sha512-B0xUquLkiGLgHhpPBqvl7GWegWBUNuujQ6kXd/r1U38ElPT6Ok8KZ8e+FpUGEc2ZoRQUzq/aUnaKFc/svWUGSg==
 
 brace-expansion@^2.0.2:
-  version "2.1.1"
-  resolved "https://registry.yarnpkg.com/brace-expansion/-/brace-expansion-2.1.1.tgz#c68b1c4111c76aae3a6fba55d496cee10c39dad8"
-  integrity sha512-WR1cURNjuvBLMZBMbqM0UoE+WAfdUcEV1ccD8PVBVOI+Z3ND4+SZbN8RsfT2bMuG1qwz5RFvPukSZm5fF2D5eA==
+  version "2.1.2"
+  resolved "https://registry.yarnpkg.com/brace-expansion/-/brace-expansion-2.1.2.tgz#0bba2271feb7d458b0d31ad13625aaa4754431e2"
+  integrity sha512-w5JZcKgdhDOgOwm8H+KgbosopHMuGcl6qbulwjtz3SM7I7P3yW1eAjzMPLrIE+NQ9vjgANKHWeMHnrT0OXW1oA==
   dependencies:
     balanced-match "^1.0.0"