33module Lithic
44 module Resources
55 class Disputes
6- # Initiate a dispute .
6+ # Request a chargeback .
77 #
88 # @overload create(amount:, reason:, transaction_token:, customer_filed_date: nil, customer_note: nil, request_options: {})
99 #
10- # @param amount [Integer] Amount to dispute
10+ # @param amount [Integer] Amount for chargeback
1111 #
12- # @param reason [Symbol, Lithic::Models::DisputeCreateParams::Reason] Reason for dispute
12+ # @param reason [Symbol, Lithic::Models::DisputeCreateParams::Reason] Reason for chargeback
1313 #
14- # @param transaction_token [String] Transaction to dispute
14+ # @param transaction_token [String] Transaction for chargeback
1515 #
16- # @param customer_filed_date [Time] Date the customer filed the dispute
16+ # @param customer_filed_date [Time] Date the customer filed the chargeback request
1717 #
18- # @param customer_note [String] Customer description of dispute
18+ # @param customer_note [String] Customer description
1919 #
2020 # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
2121 #
@@ -33,7 +33,7 @@ def create(params)
3333 )
3434 end
3535
36- # Get dispute .
36+ # Get chargeback request .
3737 #
3838 # @overload retrieve(dispute_token, request_options: {})
3939 #
@@ -52,19 +52,19 @@ def retrieve(dispute_token, params = {})
5252 )
5353 end
5454
55- # Update dispute . Can only be modified if status is `NEW`.
55+ # Update chargeback request . Can only be modified if status is `NEW`.
5656 #
5757 # @overload update(dispute_token, amount: nil, customer_filed_date: nil, customer_note: nil, reason: nil, request_options: {})
5858 #
5959 # @param dispute_token [String]
6060 #
61- # @param amount [Integer] Amount to dispute
61+ # @param amount [Integer] Amount for chargeback
6262 #
63- # @param customer_filed_date [Time] Date the customer filed the dispute
63+ # @param customer_filed_date [Time] Date the customer filed the chargeback request
6464 #
65- # @param customer_note [String] Customer description of dispute
65+ # @param customer_note [String] Customer description
6666 #
67- # @param reason [Symbol, Lithic::Models::DisputeUpdateParams::Reason] Reason for dispute
67+ # @param reason [Symbol, Lithic::Models::DisputeUpdateParams::Reason] Reason for chargeback
6868 #
6969 # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
7070 #
@@ -85,7 +85,7 @@ def update(dispute_token, params = {})
8585 # Some parameter documentations has been truncated, see
8686 # {Lithic::Models::DisputeListParams} for more details.
8787 #
88- # List disputes .
88+ # List chargeback requests .
8989 #
9090 # @overload list(begin_: nil, end_: nil, ending_before: nil, page_size: nil, starting_after: nil, status: nil, transaction_tokens: nil, request_options: {})
9191 #
@@ -99,7 +99,7 @@ def update(dispute_token, params = {})
9999 #
100100 # @param starting_after [String] A cursor representing an item's token after which a page of results should begin
101101 #
102- # @param status [Symbol, Lithic::Models::DisputeListParams::Status] List disputes of a specific status.
102+ # @param status [Symbol, Lithic::Models::DisputeListParams::Status] Filter by status.
103103 #
104104 # @param transaction_tokens [Array<String>] Transaction tokens to filter by.
105105 #
@@ -121,7 +121,7 @@ def list(params = {})
121121 )
122122 end
123123
124- # Withdraw dispute .
124+ # Withdraw chargeback request .
125125 #
126126 # @overload delete(dispute_token, request_options: {})
127127 #
@@ -140,8 +140,8 @@ def delete(dispute_token, params = {})
140140 )
141141 end
142142
143- # Soft delete evidence for a dispute . Evidence will not be reviewed or submitted
144- # by Lithic after it is withdrawn.
143+ # Soft delete evidence for a chargeback request . Evidence will not be reviewed or
144+ # submitted by Lithic after it is withdrawn.
145145 #
146146 # @overload delete_evidence(evidence_token, dispute_token:, request_options: {})
147147 #
@@ -166,8 +166,8 @@ def delete_evidence(evidence_token, params)
166166 )
167167 end
168168
169- # Use this endpoint to upload evidences for the dispute . It will return a URL to
170- # upload your documents to. The URL will expire in 30 minutes.
169+ # Use this endpoint to upload evidence for a chargeback request . It will return a
170+ # URL to upload your documents to. The URL will expire in 30 minutes.
171171 #
172172 # Uploaded documents must either be a `jpg`, `png` or `pdf` file, and each must be
173173 # less than 5 GiB.
@@ -197,7 +197,7 @@ def initiate_evidence_upload(dispute_token, params = {})
197197 # Some parameter documentations has been truncated, see
198198 # {Lithic::Models::DisputeListEvidencesParams} for more details.
199199 #
200- # List evidence metadata for a dispute .
200+ # List evidence for a chargeback request .
201201 #
202202 # @overload list_evidences(dispute_token, begin_: nil, end_: nil, ending_before: nil, page_size: nil, starting_after: nil, request_options: {})
203203 #
@@ -231,7 +231,7 @@ def list_evidences(dispute_token, params = {})
231231 )
232232 end
233233
234- # Get a dispute's evidence metadata .
234+ # Get evidence for a chargeback request .
235235 #
236236 # @overload retrieve_evidence(evidence_token, dispute_token:, request_options: {})
237237 #
0 commit comments