docs(api): update disputes docstrings to use chargeback terminology

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 188
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/lithic%2Flithic-716063c7d5d29dd3904168352017d0a065e50eec066f78ed8a3f7c796a48a78b.yml
-openapi_spec_hash: 3d930f469199651974e9bfbee65486ef
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/lithic%2Flithic-20de8e5670f8b5c47d263b6bf61c86ef65079ae0a1be0fe15ff815083b47a72d.yml
+openapi_spec_hash: 5033b4e762488df1010a932b9688bb23
 config_hash: 8799cfd589579f105ef8696a6d664c71

src/lithic/resources/disputes.py

@@ -80,18 +80,18 @@ def create(
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> Dispute:
         """
-        Initiate a dispute.
+        Request a chargeback.
 
         Args:
-          amount: Amount to dispute
+          amount: Amount for chargeback
 
-          reason: Reason for dispute
+          reason: Reason for chargeback
 
-          transaction_token: Transaction to dispute
+          transaction_token: Transaction for chargeback
 
-          customer_filed_date: Date the customer filed the dispute
+          customer_filed_date: Date the customer filed the chargeback request
 
-          customer_note: Customer description of dispute
+          customer_note: Customer description
 
           extra_headers: Send extra headers
 
@@ -131,7 +131,7 @@ def retrieve(
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> Dispute:
         """
-        Get dispute.
+        Get chargeback request.
 
         Args:
           extra_headers: Send extra headers
@@ -183,18 +183,18 @@ def update(
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> Dispute:
-        """Update dispute.
+        """Update chargeback request.
 
         Can only be modified if status is `NEW`.
 
         Args:
-          amount: Amount to dispute
+          amount: Amount for chargeback
 
-          customer_filed_date: Date the customer filed the dispute
+          customer_filed_date: Date the customer filed the chargeback request
 
-          customer_note: Customer description of dispute
+          customer_note: Customer description
 
-          reason: Reason for dispute
+          reason: Reason for chargeback
 
           extra_headers: Send extra headers
 
@@ -250,7 +250,7 @@ def list(
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> SyncCursorPage[Dispute]:
-        """List disputes.
+        """List chargeback requests.
 
         Args:
           begin: Date string in RFC 3339 format.
@@ -269,7 +269,7 @@ def list(
           starting_after: A cursor representing an item's token after which a page of results should
               begin. Used to retrieve the next page of results after this item.
 
-          status: List disputes of a specific status.
+          status: Filter by status.
 
           transaction_tokens: Transaction tokens to filter by.
 
@@ -317,7 +317,7 @@ def delete(
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> Dispute:
         """
-        Withdraw dispute.
+        Withdraw chargeback request.
 
         Args:
           extra_headers: Send extra headers
@@ -350,10 +350,10 @@ def delete_evidence(
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> DisputeEvidence:
-        """Soft delete evidence for a dispute.
+        """Soft delete evidence for a chargeback request.
 
-        Evidence will not be reviewed or submitted
-        by Lithic after it is withdrawn.
+        Evidence will not be reviewed or
+        submitted by Lithic after it is withdrawn.
 
         Args:
           extra_headers: Send extra headers
@@ -388,10 +388,10 @@ def initiate_evidence_upload(
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> DisputeEvidence:
-        """Use this endpoint to upload evidences for the dispute.
+        """Use this endpoint to upload evidence for a chargeback request.
 
-        It will return a URL to
-        upload your documents to. The URL will expire in 30 minutes.
+        It will return a
+        URL to upload your documents to. The URL will expire in 30 minutes.
 
         Uploaded documents must either be a `jpg`, `png` or `pdf` file, and each must be
         less than 5 GiB.
@@ -437,7 +437,7 @@ def list_evidences(
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> SyncCursorPage[DisputeEvidence]:
         """
-        List evidence metadata for a dispute.
+        List evidence for a chargeback request.
 
         Args:
           begin: Date string in RFC 3339 format. Only entries created after the specified time
@@ -499,7 +499,7 @@ def retrieve_evidence(
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> DisputeEvidence:
         """
-        Get a dispute's evidence metadata.
+        Get evidence for a chargeback request.
 
         Args:
           extra_headers: Send extra headers
@@ -596,18 +596,18 @@ async def create(
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> Dispute:
         """
-        Initiate a dispute.
+        Request a chargeback.
 
         Args:
-          amount: Amount to dispute
+          amount: Amount for chargeback
 
-          reason: Reason for dispute
+          reason: Reason for chargeback
 
-          transaction_token: Transaction to dispute
+          transaction_token: Transaction for chargeback
 
-          customer_filed_date: Date the customer filed the dispute
+          customer_filed_date: Date the customer filed the chargeback request
 
-          customer_note: Customer description of dispute
+          customer_note: Customer description
 
           extra_headers: Send extra headers
 
@@ -647,7 +647,7 @@ async def retrieve(
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> Dispute:
         """
-        Get dispute.
+        Get chargeback request.
 
         Args:
           extra_headers: Send extra headers
@@ -699,18 +699,18 @@ async def update(
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> Dispute:
-        """Update dispute.
+        """Update chargeback request.
 
         Can only be modified if status is `NEW`.
 
         Args:
-          amount: Amount to dispute
+          amount: Amount for chargeback
 
-          customer_filed_date: Date the customer filed the dispute
+          customer_filed_date: Date the customer filed the chargeback request
 
-          customer_note: Customer description of dispute
+          customer_note: Customer description
 
-          reason: Reason for dispute
+          reason: Reason for chargeback
 
           extra_headers: Send extra headers
 
@@ -766,7 +766,7 @@ def list(
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> AsyncPaginator[Dispute, AsyncCursorPage[Dispute]]:
-        """List disputes.
+        """List chargeback requests.
 
         Args:
           begin: Date string in RFC 3339 format.
@@ -785,7 +785,7 @@ def list(
           starting_after: A cursor representing an item's token after which a page of results should
               begin. Used to retrieve the next page of results after this item.
 
-          status: List disputes of a specific status.
+          status: Filter by status.
 
           transaction_tokens: Transaction tokens to filter by.
 
@@ -833,7 +833,7 @@ async def delete(
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> Dispute:
         """
-        Withdraw dispute.
+        Withdraw chargeback request.
 
         Args:
           extra_headers: Send extra headers
@@ -866,10 +866,10 @@ async def delete_evidence(
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> DisputeEvidence:
-        """Soft delete evidence for a dispute.
+        """Soft delete evidence for a chargeback request.
 
-        Evidence will not be reviewed or submitted
-        by Lithic after it is withdrawn.
+        Evidence will not be reviewed or
+        submitted by Lithic after it is withdrawn.
 
         Args:
           extra_headers: Send extra headers
@@ -904,10 +904,10 @@ async def initiate_evidence_upload(
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> DisputeEvidence:
-        """Use this endpoint to upload evidences for the dispute.
+        """Use this endpoint to upload evidence for a chargeback request.
 
-        It will return a URL to
-        upload your documents to. The URL will expire in 30 minutes.
+        It will return a
+        URL to upload your documents to. The URL will expire in 30 minutes.
 
         Uploaded documents must either be a `jpg`, `png` or `pdf` file, and each must be
         less than 5 GiB.
@@ -953,7 +953,7 @@ def list_evidences(
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> AsyncPaginator[DisputeEvidence, AsyncCursorPage[DisputeEvidence]]:
         """
-        List evidence metadata for a dispute.
+        List evidence for a chargeback request.
 
         Args:
           begin: Date string in RFC 3339 format. Only entries created after the specified time
@@ -1015,7 +1015,7 @@ async def retrieve_evidence(
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> DisputeEvidence:
         """
-        Get a dispute's evidence metadata.
+        Get evidence for a chargeback request.
 
         Args:
           extra_headers: Send extra headers

src/lithic/types/dispute_create_params.py

@@ -13,7 +13,7 @@
 
 class DisputeCreateParams(TypedDict, total=False):
     amount: Required[int]
-    """Amount to dispute"""
+    """Amount for chargeback"""
 
     reason: Required[
         Literal[
@@ -33,13 +33,13 @@ class DisputeCreateParams(TypedDict, total=False):
             "REFUND_NOT_PROCESSED",
         ]
     ]
-    """Reason for dispute"""
+    """Reason for chargeback"""
 
     transaction_token: Required[str]
-    """Transaction to dispute"""
+    """Transaction for chargeback"""
 
     customer_filed_date: Annotated[Union[str, datetime], PropertyInfo(format="iso8601")]
-    """Date the customer filed the dispute"""
+    """Date the customer filed the chargeback request"""
 
     customer_note: str
-    """Customer description of dispute"""
+    """Customer description"""

src/lithic/types/dispute_list_params.py

@@ -51,7 +51,7 @@ class DisputeListParams(TypedDict, total=False):
         "REPRESENTMENT",
         "SUBMITTED",
     ]
-    """List disputes of a specific status."""
+    """Filter by status."""
 
     transaction_tokens: SequenceNotStr[str]
     """Transaction tokens to filter by."""

src/lithic/types/dispute_update_params.py

@@ -13,13 +13,13 @@
 
 class DisputeUpdateParams(TypedDict, total=False):
     amount: int
-    """Amount to dispute"""
+    """Amount for chargeback"""
 
     customer_filed_date: Annotated[Union[str, datetime], PropertyInfo(format="iso8601")]
-    """Date the customer filed the dispute"""
+    """Date the customer filed the chargeback request"""
 
     customer_note: str
-    """Customer description of dispute"""
+    """Customer description"""
 
     reason: Literal[
         "ATM_CASH_MISDISPENSE",
@@ -37,4 +37,4 @@ class DisputeUpdateParams(TypedDict, total=False):
         "RECURRING_TRANSACTION_NOT_CANCELLED",
         "REFUND_NOT_PROCESSED",
     ]
-    """Reason for dispute"""
+    """Reason for chargeback"""