Skip to content

Commit 94dadbc

Browse files
docs(api): update disputes terminology to chargeback request
1 parent a9df6e3 commit 94dadbc

9 files changed

Lines changed: 90 additions & 90 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: 189
2-
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/lithic%2Flithic-716063c7d5d29dd3904168352017d0a065e50eec066f78ed8a3f7c796a48a78b.yml
3-
openapi_spec_hash: 3d930f469199651974e9bfbee65486ef
2+
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/lithic%2Flithic-20de8e5670f8b5c47d263b6bf61c86ef65079ae0a1be0fe15ff815083b47a72d.yml
3+
openapi_spec_hash: 5033b4e762488df1010a932b9688bb23
44
config_hash: 8799cfd589579f105ef8696a6d664c71

lib/lithic/models/dispute_create_params.rb

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -8,49 +8,49 @@ class DisputeCreateParams < Lithic::Internal::Type::BaseModel
88
include Lithic::Internal::Type::RequestParameters
99

1010
# @!attribute amount
11-
# Amount to dispute
11+
# Amount for chargeback
1212
#
1313
# @return [Integer]
1414
required :amount, Integer
1515

1616
# @!attribute reason
17-
# Reason for dispute
17+
# Reason for chargeback
1818
#
1919
# @return [Symbol, Lithic::Models::DisputeCreateParams::Reason]
2020
required :reason, enum: -> { Lithic::DisputeCreateParams::Reason }
2121

2222
# @!attribute transaction_token
23-
# Transaction to dispute
23+
# Transaction for chargeback
2424
#
2525
# @return [String]
2626
required :transaction_token, String
2727

2828
# @!attribute customer_filed_date
29-
# Date the customer filed the dispute
29+
# Date the customer filed the chargeback request
3030
#
3131
# @return [Time, nil]
3232
optional :customer_filed_date, Time
3333

3434
# @!attribute customer_note
35-
# Customer description of dispute
35+
# Customer description
3636
#
3737
# @return [String, nil]
3838
optional :customer_note, String
3939

4040
# @!method initialize(amount:, reason:, transaction_token:, customer_filed_date: nil, customer_note: nil, request_options: {})
41-
# @param amount [Integer] Amount to dispute
41+
# @param amount [Integer] Amount for chargeback
4242
#
43-
# @param reason [Symbol, Lithic::Models::DisputeCreateParams::Reason] Reason for dispute
43+
# @param reason [Symbol, Lithic::Models::DisputeCreateParams::Reason] Reason for chargeback
4444
#
45-
# @param transaction_token [String] Transaction to dispute
45+
# @param transaction_token [String] Transaction for chargeback
4646
#
47-
# @param customer_filed_date [Time] Date the customer filed the dispute
47+
# @param customer_filed_date [Time] Date the customer filed the chargeback request
4848
#
49-
# @param customer_note [String] Customer description of dispute
49+
# @param customer_note [String] Customer description
5050
#
5151
# @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
5252

53-
# Reason for dispute
53+
# Reason for chargeback
5454
module Reason
5555
extend Lithic::Internal::Type::Enum
5656

lib/lithic/models/dispute_list_params.rb

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ class DisputeListParams < Lithic::Internal::Type::BaseModel
4242
optional :starting_after, String
4343

4444
# @!attribute status
45-
# List disputes of a specific status.
45+
# Filter by status.
4646
#
4747
# @return [Symbol, Lithic::Models::DisputeListParams::Status, nil]
4848
optional :status, enum: -> { Lithic::DisputeListParams::Status }
@@ -67,13 +67,13 @@ class DisputeListParams < Lithic::Internal::Type::BaseModel
6767
#
6868
# @param starting_after [String] A cursor representing an item's token after which a page of results should begin
6969
#
70-
# @param status [Symbol, Lithic::Models::DisputeListParams::Status] List disputes of a specific status.
70+
# @param status [Symbol, Lithic::Models::DisputeListParams::Status] Filter by status.
7171
#
7272
# @param transaction_tokens [Array<String>] Transaction tokens to filter by.
7373
#
7474
# @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
7575

76-
# List disputes of a specific status.
76+
# Filter by status.
7777
module Status
7878
extend Lithic::Internal::Type::Enum
7979

lib/lithic/models/dispute_update_params.rb

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -13,43 +13,43 @@ class DisputeUpdateParams < Lithic::Internal::Type::BaseModel
1313
required :dispute_token, String
1414

1515
# @!attribute amount
16-
# Amount to dispute
16+
# Amount for chargeback
1717
#
1818
# @return [Integer, nil]
1919
optional :amount, Integer
2020

2121
# @!attribute customer_filed_date
22-
# Date the customer filed the dispute
22+
# Date the customer filed the chargeback request
2323
#
2424
# @return [Time, nil]
2525
optional :customer_filed_date, Time
2626

2727
# @!attribute customer_note
28-
# Customer description of dispute
28+
# Customer description
2929
#
3030
# @return [String, nil]
3131
optional :customer_note, String
3232

3333
# @!attribute reason
34-
# Reason for dispute
34+
# Reason for chargeback
3535
#
3636
# @return [Symbol, Lithic::Models::DisputeUpdateParams::Reason, nil]
3737
optional :reason, enum: -> { Lithic::DisputeUpdateParams::Reason }
3838

3939
# @!method initialize(dispute_token:, amount: nil, customer_filed_date: nil, customer_note: nil, reason: nil, request_options: {})
4040
# @param dispute_token [String]
4141
#
42-
# @param amount [Integer] Amount to dispute
42+
# @param amount [Integer] Amount for chargeback
4343
#
44-
# @param customer_filed_date [Time] Date the customer filed the dispute
44+
# @param customer_filed_date [Time] Date the customer filed the chargeback request
4545
#
46-
# @param customer_note [String] Customer description of dispute
46+
# @param customer_note [String] Customer description
4747
#
48-
# @param reason [Symbol, Lithic::Models::DisputeUpdateParams::Reason] Reason for dispute
48+
# @param reason [Symbol, Lithic::Models::DisputeUpdateParams::Reason] Reason for chargeback
4949
#
5050
# @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
5151

52-
# Reason for dispute
52+
# Reason for chargeback
5353
module Reason
5454
extend Lithic::Internal::Type::Enum
5555

lib/lithic/resources/disputes.rb

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -3,19 +3,19 @@
33
module 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
#

rbi/lithic/models/dispute_create_params.rbi

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -11,26 +11,26 @@ module Lithic
1111
T.any(Lithic::DisputeCreateParams, Lithic::Internal::AnyHash)
1212
end
1313

14-
# Amount to dispute
14+
# Amount for chargeback
1515
sig { returns(Integer) }
1616
attr_accessor :amount
1717

18-
# Reason for dispute
18+
# Reason for chargeback
1919
sig { returns(Lithic::DisputeCreateParams::Reason::OrSymbol) }
2020
attr_accessor :reason
2121

22-
# Transaction to dispute
22+
# Transaction for chargeback
2323
sig { returns(String) }
2424
attr_accessor :transaction_token
2525

26-
# Date the customer filed the dispute
26+
# Date the customer filed the chargeback request
2727
sig { returns(T.nilable(Time)) }
2828
attr_reader :customer_filed_date
2929

3030
sig { params(customer_filed_date: Time).void }
3131
attr_writer :customer_filed_date
3232

33-
# Customer description of dispute
33+
# Customer description
3434
sig { returns(T.nilable(String)) }
3535
attr_reader :customer_note
3636

@@ -48,15 +48,15 @@ module Lithic
4848
).returns(T.attached_class)
4949
end
5050
def self.new(
51-
# Amount to dispute
51+
# Amount for chargeback
5252
amount:,
53-
# Reason for dispute
53+
# Reason for chargeback
5454
reason:,
55-
# Transaction to dispute
55+
# Transaction for chargeback
5656
transaction_token:,
57-
# Date the customer filed the dispute
57+
# Date the customer filed the chargeback request
5858
customer_filed_date: nil,
59-
# Customer description of dispute
59+
# Customer description
6060
customer_note: nil,
6161
request_options: {}
6262
)
@@ -77,7 +77,7 @@ module Lithic
7777
def to_hash
7878
end
7979

80-
# Reason for dispute
80+
# Reason for chargeback
8181
module Reason
8282
extend Lithic::Internal::Type::Enum
8383

rbi/lithic/models/dispute_list_params.rbi

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ module Lithic
5050
sig { params(starting_after: String).void }
5151
attr_writer :starting_after
5252

53-
# List disputes of a specific status.
53+
# Filter by status.
5454
sig { returns(T.nilable(Lithic::DisputeListParams::Status::OrSymbol)) }
5555
attr_reader :status
5656

@@ -91,7 +91,7 @@ module Lithic
9191
# A cursor representing an item's token after which a page of results should
9292
# begin. Used to retrieve the next page of results after this item.
9393
starting_after: nil,
94-
# List disputes of a specific status.
94+
# Filter by status.
9595
status: nil,
9696
# Transaction tokens to filter by.
9797
transaction_tokens: nil,
@@ -116,7 +116,7 @@ module Lithic
116116
def to_hash
117117
end
118118

119-
# List disputes of a specific status.
119+
# Filter by status.
120120
module Status
121121
extend Lithic::Internal::Type::Enum
122122

0 commit comments

Comments
 (0)