Skip to content

Commit b7c4832

Browse files
chore(docs): small updates to doc strings on a few endpoints
1 parent 5c934d6 commit b7c4832

7 files changed

Lines changed: 23 additions & 13 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: 169
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

lib/lithic/internal/type/union.rb

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,16 @@ module Type
66
# @api private
77
#
88
# @example
9-
# # `account_holder_update_response` is a `Lithic::Models::AccountHolderUpdateResponse`
10-
# case account_holder_update_response
11-
# when Lithic::Models::AccountHolderUpdateResponse::KYBKYCPatchResponse
12-
# puts(account_holder_update_response.token)
13-
# when Lithic::Models::AccountHolderUpdateResponse::PatchResponse
14-
# puts(account_holder_update_response.address)
9+
# # `account_activity_list_response` is a `Lithic::Models::AccountActivityListResponse`
10+
# case account_activity_list_response
11+
# when Lithic::Models::AccountActivityListResponse::FinancialTransaction
12+
# puts(account_activity_list_response.token)
13+
# when Lithic::Models::AccountActivityListResponse::BookTransferTransaction
14+
# puts(account_activity_list_response.category)
15+
# when Lithic::Models::AccountActivityListResponse::CardTransaction
16+
# # ...
1517
# else
16-
# puts(account_holder_update_response)
18+
# puts(account_activity_list_response)
1719
# end
1820
module Union
1921
include Lithic::Internal::Type::Converter

lib/lithic/models/account_activity_list_response.rb

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ module Models
88
module AccountActivityListResponse
99
extend Lithic::Internal::Type::Union
1010

11+
discriminator :family
12+
1113
# Financial transaction with inheritance from unified base transaction
1214
variant -> { Lithic::Models::AccountActivityListResponse::FinancialTransaction }
1315

lib/lithic/models/account_activity_retrieve_transaction_response.rb

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ module Models
88
module AccountActivityRetrieveTransactionResponse
99
extend Lithic::Internal::Type::Union
1010

11+
discriminator :family
12+
1113
# Financial transaction with inheritance from unified base transaction
1214
variant -> { Lithic::Models::AccountActivityRetrieveTransactionResponse::FinancialTransaction }
1315

lib/lithic/models/transaction_simulate_void_params.rb

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,8 @@ class TransactionSimulateVoidParams < Lithic::Internal::Type::BaseModel
1515

1616
# @!attribute amount
1717
# Amount (in cents) to void. Typically this will match the amount in the original
18-
# authorization, but can be less.
18+
# authorization, but can be less. Applies to authorization reversals only. An
19+
# authorization expiry will always apply to the full pending amount.
1920
#
2021
# @return [Integer, nil]
2122
optional :amount, Integer

rbi/lithic/models/transaction_simulate_void_params.rbi

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,8 @@ module Lithic
1919
attr_accessor :token
2020

2121
# Amount (in cents) to void. Typically this will match the amount in the original
22-
# authorization, but can be less.
22+
# authorization, but can be less. Applies to authorization reversals only. An
23+
# authorization expiry will always apply to the full pending amount.
2324
sig { returns(T.nilable(Integer)) }
2425
attr_reader :amount
2526

@@ -55,7 +56,8 @@ module Lithic
5556
# The transaction token returned from the /v1/simulate/authorize response.
5657
token:,
5758
# Amount (in cents) to void. Typically this will match the amount in the original
58-
# authorization, but can be less.
59+
# authorization, but can be less. Applies to authorization reversals only. An
60+
# authorization expiry will always apply to the full pending amount.
5961
amount: nil,
6062
# Type of event to simulate. Defaults to `AUTHORIZATION_REVERSAL`.
6163
#

rbi/lithic/resources/transactions.rbi

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -295,7 +295,8 @@ module Lithic
295295
# The transaction token returned from the /v1/simulate/authorize response.
296296
token:,
297297
# Amount (in cents) to void. Typically this will match the amount in the original
298-
# authorization, but can be less.
298+
# authorization, but can be less. Applies to authorization reversals only. An
299+
# authorization expiry will always apply to the full pending amount.
299300
amount: nil,
300301
# Type of event to simulate. Defaults to `AUTHORIZATION_REVERSAL`.
301302
#

0 commit comments

Comments
 (0)