Skip to content

Commit 8c818a5

Browse files
chore(docs): small updates to doc strings on a few endpoints
1 parent 1fde7dc commit 8c818a5

File tree

3 files changed

+8
-5
lines changed

3 files changed

+8
-5
lines changed

.stats.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
configured_endpoints: 168
2-
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/lithic%2Flithic-1d44bb7fad99487af1161eb24dfd5369440eda7e80ed237cbc1acc6802a7d212.yml
3-
openapi_spec_hash: 1b6b6215b60094b76b91c56b925a251a
2+
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/lithic%2Flithic-fbbce0ea11d3e86e532f705804f3d79e8eecfb8a7796e3a6ad3c50cccee14bb1.yml
3+
openapi_spec_hash: 3f44b97866ca74effe5e70fc9c64effb
44
config_hash: 768e8f0faa1a21e26b07e6cdc395cebf

src/lithic/resources/transactions/transactions.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -690,7 +690,8 @@ def simulate_void(
690690
token: The transaction token returned from the /v1/simulate/authorize response.
691691
692692
amount: Amount (in cents) to void. Typically this will match the amount in the original
693-
authorization, but can be less.
693+
authorization, but can be less. Applies to authorization reversals only. An
694+
authorization expiry will always apply to the full pending amount.
694695
695696
type: Type of event to simulate. Defaults to `AUTHORIZATION_REVERSAL`.
696697
@@ -1354,7 +1355,8 @@ async def simulate_void(
13541355
token: The transaction token returned from the /v1/simulate/authorize response.
13551356
13561357
amount: Amount (in cents) to void. Typically this will match the amount in the original
1357-
authorization, but can be less.
1358+
authorization, but can be less. Applies to authorization reversals only. An
1359+
authorization expiry will always apply to the full pending amount.
13581360
13591361
type: Type of event to simulate. Defaults to `AUTHORIZATION_REVERSAL`.
13601362

src/lithic/types/transaction_simulate_void_params.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,8 @@ class TransactionSimulateVoidParams(TypedDict, total=False):
1515
"""Amount (in cents) to void.
1616
1717
Typically this will match the amount in the original authorization, but can be
18-
less.
18+
less. Applies to authorization reversals only. An authorization expiry will
19+
always apply to the full pending amount.
1920
"""
2021

2122
type: Literal["AUTHORIZATION_EXPIRY", "AUTHORIZATION_REVERSAL"]

0 commit comments

Comments
 (0)