Skip to content

Commit 92638f2

Browse files
docs(api): clarify dispute event descriptions in Event model
1 parent 7c331aa commit 92638f2

2 files changed

Lines changed: 18 additions & 7 deletions

File tree

.stats.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
configured_endpoints: 213
2-
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/lithic/lithic-021aecb037a2f6b44056d6ebe08129e55f2dd95d8a6944c6e2c1c8e2bede56b4.yml
3-
openapi_spec_hash: 3567c6592916d79ce38248d922cd0db6
2+
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/lithic/lithic-7944f9c14da86359cf30f16d97dff357f656f8fab9a59e923c436304624438ee.yml
3+
openapi_spec_hash: 4b45cf81f64bc52e739731108d2cc482
44
config_hash: 5bb913c05ebeb301ec925b16e75bb251

src/lithic/types/event.py

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ class Event(BaseModel):
8585
"""The type of event that occurred. Possible values:
8686
8787
- account_holder_document.updated: Occurs when an account holder's document
88-
upload status has been updated
88+
upload status has been updated.
8989
- account_holder.created: Occurs when a new account_holder is created.
9090
- account_holder.updated: Occurs when an account_holder is updated.
9191
- account_holder.verification: Occurs when an asynchronous account_holder's
@@ -149,10 +149,21 @@ class Event(BaseModel):
149149
This event will be deprecated in the future. We recommend using
150150
`tokenization.updated` instead.
151151
152-
- dispute_evidence.upload_failed: Occurs when a dispute evidence upload fails.
152+
- dispute_evidence.upload_failed: Occurs when an evidence upload fails for a
153+
dispute filed through the Chargebacks API (`/v1/disputes`).
154+
155+
This event is not emitted for Managed Disputes.
156+
153157
- dispute_transaction.created: Occurs when a new dispute transaction is created
154-
- dispute_transaction.updated: Occurs when a dispute transaction is updated
155-
- dispute.updated: Occurs when a dispute is updated.
158+
for a Managed Disputes case.
159+
- dispute_transaction.updated: Occurs when a dispute transaction for a Managed
160+
Disputes case is updated.
161+
- dispute.updated: Occurs when a dispute filed through the Chargebacks API
162+
(`/v1/disputes`) is created or updated.
163+
164+
This event is not emitted for Managed Disputes. Use
165+
`dispute_transaction.created` and `dispute_transaction.updated` instead.
166+
156167
- external_bank_account.created: Occurs when an external bank account is
157168
created.
158169
- external_bank_account.updated: Occurs when an external bank account is
@@ -174,7 +185,7 @@ class Event(BaseModel):
174185
- payment_transaction.updated: Occurs when a payment transaction is updated.
175186
- settlement_report.updated: Occurs when a settlement report is created or
176187
updated.
177-
- statements.created: Occurs when a statement has been created
188+
- statements.created: Occurs when a statement has been created.
178189
- three_ds_authentication.challenge: The `three_ds_authentication.challenge`
179190
event. Upon receiving this request, the Card Program should issue its own
180191
challenge to the cardholder. After a cardholder challenge is successfully

0 commit comments

Comments
 (0)