lithic 0.1.0.pre.alpha.16 → 0.1.0.pre.alpha.18

data/lib/lithic/resources/book_transfers.rb

@@ -3,19 +3,34 @@
 module Lithic
   module Resources
     class BookTransfers
+      # Some parameter documentations has been truncated, see
+      # {Lithic::Models::BookTransferCreateParams} for more details.
+      #
       # Book transfer funds between two financial accounts or between a financial
       # account and card
       #
       # @overload create(amount:, category:, from_financial_account_token:, subtype:, to_financial_account_token:, type:, token: nil, memo: nil, request_options: {})
       #
-      # @param amount [Integer]
-      # @param category [Symbol, Lithic::Models::BookTransferCreateParams::Category]
-      # @param from_financial_account_token [String]
-      # @param subtype [String]
-      # @param to_financial_account_token [String]
-      # @param type [Symbol, Lithic::Models::BookTransferCreateParams::Type]
-      # @param token [String]
-      # @param memo [String]
+      # @param amount [Integer] Amount to be transferred in the currency’s smallest unit (e.g., cents for USD).
+      # ...
+      #
+      # @param category [Symbol, Lithic::Models::BookTransferCreateParams::Category] Category of the book transfer
+      #
+      # @param from_financial_account_token [String] Globally unique identifier for the financial account or card that will send the
+      # ...
+      #
+      # @param subtype [String] The program specific subtype code for the specified category/type.
+      #
+      # @param to_financial_account_token [String] Globally unique identifier for the financial account or card that will receive t
+      # ...
+      #
+      # @param type [Symbol, Lithic::Models::BookTransferCreateParams::Type] Type of book_transfer
+      #
+      # @param token [String] Customer-provided token that will serve as an idempotency token. This token will
+      # ...
+      #
+      # @param memo [String] Optional descriptor for the transfer.
+      #
       # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::BookTransferResponse]
@@ -36,7 +51,8 @@ module Lithic
       #
       # @overload retrieve(book_transfer_token, request_options: {})
       #
-      # @param book_transfer_token [String]
+      # @param book_transfer_token [String] Id of the book transfer to retrieve
+      #
       # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::BookTransferResponse]
@@ -51,21 +67,40 @@ module Lithic
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Lithic::Models::BookTransferListParams} for more details.
+      #
       # List book transfers
       #
       # @overload list(account_token: nil, begin_: nil, business_account_token: nil, category: nil, end_: nil, ending_before: nil, financial_account_token: nil, page_size: nil, result: nil, starting_after: nil, status: nil, request_options: {})
       #
       # @param account_token [String]
-      # @param begin_ [Time]
+      #
+      # @param begin_ [Time] Date string in RFC 3339 format. Only entries created after the specified time wi
+      # ...
+      #
       # @param business_account_token [String]
-      # @param category [Symbol, Lithic::Models::BookTransferListParams::Category]
-      # @param end_ [Time]
-      # @param ending_before [String]
-      # @param financial_account_token [String]
-      # @param page_size [Integer]
-      # @param result [Symbol, Lithic::Models::BookTransferListParams::Result]
-      # @param starting_after [String]
-      # @param status [Symbol, Lithic::Models::BookTransferListParams::Status]
+      #
+      # @param category [Symbol, Lithic::Models::BookTransferListParams::Category] Book Transfer category to be returned.
+      #
+      # @param end_ [Time] Date string in RFC 3339 format. Only entries created before the specified time w
+      # ...
+      #
+      # @param ending_before [String] A cursor representing an item's token before which a page of results should end.
+      # ...
+      #
+      # @param financial_account_token [String] Globally unique identifier for the financial account or card that will send the
+      # ...
+      #
+      # @param page_size [Integer] Page size (for pagination).
+      #
+      # @param result [Symbol, Lithic::Models::BookTransferListParams::Result] Book transfer result to be returned.
+      #
+      # @param starting_after [String] A cursor representing an item's token after which a page of results should begin
+      # ...
+      #
+      # @param status [Symbol, Lithic::Models::BookTransferListParams::Status] Book transfer status to be returned.
+      #
       # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Internal::CursorPage<Lithic::Models::BookTransferResponse>]
@@ -87,8 +122,10 @@ module Lithic
       #
       # @overload reverse(book_transfer_token, memo: nil, request_options: {})
       #
-      # @param book_transfer_token [String]
-      # @param memo [String]
+      # @param book_transfer_token [String] Id of the book transfer to retrieve
+      #
+      # @param memo [String] Optional descriptor for the reversal.
+      #
       # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::BookTransferResponse]

data/lib/lithic/resources/card_programs.rb

@@ -7,7 +7,8 @@ module Lithic
       #
       # @overload retrieve(card_program_token, request_options: {})
       #
-      # @param card_program_token [String]
+      # @param card_program_token [String] Globally unique identifier for the card program.
+      #
       # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::CardProgram]
@@ -22,13 +23,21 @@ module Lithic
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Lithic::Models::CardProgramListParams} for more details.
+      #
       # List card programs.
       #
       # @overload list(ending_before: nil, page_size: nil, starting_after: nil, request_options: {})
       #
-      # @param ending_before [String]
-      # @param page_size [Integer]
-      # @param starting_after [String]
+      # @param ending_before [String] A cursor representing an item's token before which a page of results should end.
+      # ...
+      #
+      # @param page_size [Integer] Page size (for pagination).
+      #
+      # @param starting_after [String] A cursor representing an item's token after which a page of results should begin
+      # ...
+      #
       # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Internal::CursorPage<Lithic::Models::CardProgram>]

data/lib/lithic/resources/cards/aggregate_balances.rb

@@ -8,8 +8,10 @@ module Lithic
         #
         # @overload list(account_token: nil, business_account_token: nil, request_options: {})
         #
-        # @param account_token [String]
-        # @param business_account_token [String]
+        # @param account_token [String] Cardholder to retrieve aggregate balances for.
+        #
+        # @param business_account_token [String] Business to retrieve aggregate balances for.
+        #
         # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [Lithic::Internal::SinglePage<Lithic::Models::Cards::AggregateBalanceListResponse>]

data/lib/lithic/resources/cards/balances.rb

@@ -4,13 +4,19 @@ module Lithic
   module Resources
     class Cards
       class Balances
+        # Some parameter documentations has been truncated, see
+        # {Lithic::Models::Cards::BalanceListParams} for more details.
+        #
         # Get the balances for a given card.
         #
         # @overload list(card_token, balance_date: nil, last_transaction_event_token: nil, request_options: {})
         #
         # @param card_token [String]
-        # @param balance_date [Time]
-        # @param last_transaction_event_token [String]
+        #
+        # @param balance_date [Time] UTC date of the balance to retrieve. Defaults to latest available balance
+        #
+        # @param last_transaction_event_token [String] Balance after a given financial event occured. ...
+        #
         # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [Lithic::Internal::SinglePage<Lithic::Models::Cards::BalanceListResponse>]

data/lib/lithic/resources/cards/financial_transactions.rb

@@ -8,8 +8,10 @@ module Lithic
         #
         # @overload retrieve(financial_transaction_token, card_token:, request_options: {})
         #
-        # @param financial_transaction_token [String]
+        # @param financial_transaction_token [String] Globally unique identifier for financial transaction token.
+        #
         # @param card_token [String]
+        #
         # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [Lithic::Models::FinancialTransaction]
@@ -29,18 +31,33 @@ module Lithic
           )
         end
 
+        # Some parameter documentations has been truncated, see
+        # {Lithic::Models::Cards::FinancialTransactionListParams} for more details.
+        #
         # List the financial transactions for a given card.
         #
         # @overload list(card_token, begin_: nil, category: nil, end_: nil, ending_before: nil, result: nil, starting_after: nil, status: nil, request_options: {})
         #
         # @param card_token [String]
-        # @param begin_ [Time]
-        # @param category [Symbol, Lithic::Models::Cards::FinancialTransactionListParams::Category]
-        # @param end_ [Time]
-        # @param ending_before [String]
-        # @param result [Symbol, Lithic::Models::Cards::FinancialTransactionListParams::Result]
-        # @param starting_after [String]
-        # @param status [Symbol, Lithic::Models::Cards::FinancialTransactionListParams::Status]
+        #
+        # @param begin_ [Time] Date string in RFC 3339 format. Only entries created after the specified time wi
+        # ...
+        #
+        # @param category [Symbol, Lithic::Models::Cards::FinancialTransactionListParams::Category] Financial Transaction category to be returned.
+        #
+        # @param end_ [Time] Date string in RFC 3339 format. Only entries created before the specified time w
+        # ...
+        #
+        # @param ending_before [String] A cursor representing an item's token before which a page of results should end.
+        # ...
+        #
+        # @param result [Symbol, Lithic::Models::Cards::FinancialTransactionListParams::Result] Financial Transaction result to be returned.
+        #
+        # @param starting_after [String] A cursor representing an item's token after which a page of results should begin
+        # ...
+        #
+        # @param status [Symbol, Lithic::Models::Cards::FinancialTransactionListParams::Status] Financial Transaction status to be returned.
+        #
         # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [Lithic::Internal::SinglePage<Lithic::Models::FinancialTransaction>]

data/lib/lithic/resources/cards.rb

@@ -12,31 +12,61 @@ module Lithic
       # @return [Lithic::Resources::Cards::FinancialTransactions]
       attr_reader :financial_transactions
 
+      # Some parameter documentations has been truncated, see
+      # {Lithic::Models::CardCreateParams} for more details.
+      #
       # Create a new virtual or physical card. Parameters `shipping_address` and
       # `product_id` only apply to physical cards.
       #
       # @overload create(type:, account_token: nil, card_program_token: nil, carrier: nil, digital_card_art_token: nil, exp_month: nil, exp_year: nil, memo: nil, pin: nil, product_id: nil, replacement_account_token: nil, replacement_for: nil, shipping_address: nil, shipping_method: nil, spend_limit: nil, spend_limit_duration: nil, state: nil, request_options: {})
       #
-      # @param type [Symbol, Lithic::Models::CardCreateParams::Type]
-      # @param account_token [String]
-      # @param card_program_token [String]
+      # @param type [Symbol, Lithic::Models::CardCreateParams::Type] Card types: ...
+      #
+      # @param account_token [String] Globally unique identifier for the account that the card will be associated with
+      # ...
+      #
+      # @param card_program_token [String] For card programs with more than one BIN range. This must be configured with Lit
+      # ...
+      #
       # @param carrier [Lithic::Models::Carrier]
-      # @param digital_card_art_token [String]
-      # @param exp_month [String]
-      # @param exp_year [String]
-      # @param memo [String]
-      # @param pin [String]
-      # @param product_id [String]
-      # @param replacement_account_token [String]
-      # @param replacement_for [String]
+      #
+      # @param digital_card_art_token [String] Specifies the digital card art to be displayed in the user’s digital wallet afte
+      # ...
+      #
+      # @param exp_month [String] Two digit (MM) expiry month. If neither `exp_month` nor `exp_year` is provided,
+      # ...
+      #
+      # @param exp_year [String] Four digit (yyyy) expiry year. If neither `exp_month` nor `exp_year` is provided
+      # ...
+      #
+      # @param memo [String] Friendly name to identify the card.
+      #
+      # @param pin [String] Encrypted PIN block (in base64). Applies to cards of type `PHYSICAL` and `VIRTUA
+      # ...
+      #
+      # @param product_id [String] Only applicable to cards of type `PHYSICAL`. This must be configured with Lithic
+      # ...
+      #
+      # @param replacement_account_token [String] Restricted field limited to select use cases. Lithic will reach out directly if
+      # ...
+      #
+      # @param replacement_for [String] Globally unique identifier for the card that this card will replace. If the card
+      # ...
+      #
       # @param shipping_address [Lithic::Models::ShippingAddress]
-      # @param shipping_method [Symbol, Lithic::Models::CardCreateParams::ShippingMethod]
-      # @param spend_limit [Integer]
-      # @param spend_limit_duration [Symbol, Lithic::Models::SpendLimitDuration]
-      # @param state [Symbol, Lithic::Models::CardCreateParams::State]
+      #
+      # @param shipping_method [Symbol, Lithic::Models::CardCreateParams::ShippingMethod] Shipping method for the card. Only applies to cards of type PHYSICAL. ...
+      #
+      # @param spend_limit [Integer] Amount (in cents) to limit approved authorizations (e.g. 100000 would be a $1,00
+      # ...
+      #
+      # @param spend_limit_duration [Symbol, Lithic::Models::SpendLimitDuration] Spend limit duration values: ...
+      #
+      # @param state [Symbol, Lithic::Models::CardCreateParams::State] Card state values: ...
+      #
       # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Lithic::Models::CardCreateResponse]
+      # @return [Lithic::Models::Card]
       #
       # @see Lithic::Models::CardCreateParams
       def create(params)
@@ -45,7 +75,7 @@ module Lithic
           method: :post,
           path: "v1/cards",
           body: parsed,
-          model: Lithic::Models::CardCreateResponse,
+          model: Lithic::Models::Card,
           options: options
         )
       end
@@ -57,18 +87,21 @@ module Lithic
       # @param card_token [String]
       # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Lithic::Models::CardRetrieveResponse]
+      # @return [Lithic::Models::Card]
       #
       # @see Lithic::Models::CardRetrieveParams
       def retrieve(card_token, params = {})
         @client.request(
           method: :get,
           path: ["v1/cards/%1$s", card_token],
-          model: Lithic::Models::CardRetrieveResponse,
+          model: Lithic::Models::Card,
           options: params[:request_options]
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Lithic::Models::CardUpdateParams} for more details.
+      #
       # Update the specified properties of the card. Unsupplied properties will remain
       # unchanged.
       #
@@ -78,16 +111,28 @@ module Lithic
       # @overload update(card_token, digital_card_art_token: nil, memo: nil, pin: nil, pin_status: nil, spend_limit: nil, spend_limit_duration: nil, state: nil, request_options: {})
       #
       # @param card_token [String]
-      # @param digital_card_art_token [String]
-      # @param memo [String]
-      # @param pin [String]
-      # @param pin_status [Symbol, Lithic::Models::CardUpdateParams::PinStatus]
-      # @param spend_limit [Integer]
-      # @param spend_limit_duration [Symbol, Lithic::Models::SpendLimitDuration]
-      # @param state [Symbol, Lithic::Models::CardUpdateParams::State]
+      #
+      # @param digital_card_art_token [String] Specifies the digital card art to be displayed in the user’s digital wallet afte
+      # ...
+      #
+      # @param memo [String] Friendly name to identify the card.
+      #
+      # @param pin [String] Encrypted PIN block (in base64). Only applies to cards of type `PHYSICAL` and `V
+      # ...
+      #
+      # @param pin_status [Symbol, Lithic::Models::CardUpdateParams::PinStatus] Indicates if a card is blocked due a PIN status issue (e.g. excessive incorrect
+      # ...
+      #
+      # @param spend_limit [Integer] Amount (in cents) to limit approved authorizations (e.g. 100000 would be a $1,00
+      # ...
+      #
+      # @param spend_limit_duration [Symbol, Lithic::Models::SpendLimitDuration] Spend limit duration values: ...
+      #
+      # @param state [Symbol, Lithic::Models::CardUpdateParams::State] Card state values: ...
+      #
       # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Lithic::Models::CardUpdateResponse]
+      # @return [Lithic::Models::Card]
       #
       # @see Lithic::Models::CardUpdateParams
       def update(card_token, params = {})
@@ -96,25 +141,39 @@ module Lithic
           method: :patch,
           path: ["v1/cards/%1$s", card_token],
           body: parsed,
-          model: Lithic::Models::CardUpdateResponse,
+          model: Lithic::Models::Card,
           options: options
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Lithic::Models::CardListParams} for more details.
+      #
       # List cards.
       #
       # @overload list(account_token: nil, begin_: nil, end_: nil, ending_before: nil, page_size: nil, starting_after: nil, state: nil, request_options: {})
       #
-      # @param account_token [String]
-      # @param begin_ [Time]
-      # @param end_ [Time]
-      # @param ending_before [String]
-      # @param page_size [Integer]
-      # @param starting_after [String]
-      # @param state [Symbol, Lithic::Models::CardListParams::State]
+      # @param account_token [String] Returns cards associated with the specified account. ...
+      #
+      # @param begin_ [Time] Date string in RFC 3339 format. Only entries created after the specified time wi
+      # ...
+      #
+      # @param end_ [Time] Date string in RFC 3339 format. Only entries created before the specified time w
+      # ...
+      #
+      # @param ending_before [String] A cursor representing an item's token before which a page of results should end.
+      # ...
+      #
+      # @param page_size [Integer] Page size (for pagination).
+      #
+      # @param starting_after [String] A cursor representing an item's token after which a page of results should begin
+      # ...
+      #
+      # @param state [Symbol, Lithic::Models::CardListParams::State] Returns cards with the specified state. ...
+      #
       # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Lithic::Internal::CursorPage<Lithic::Models::CardListResponse>]
+      # @return [Lithic::Internal::CursorPage<Lithic::Models::NonPCICard>]
       #
       # @see Lithic::Models::CardListParams
       def list(params = {})
@@ -124,11 +183,14 @@ module Lithic
           path: "v1/cards",
           query: parsed.transform_keys(begin_: "begin", end_: "end"),
           page: Lithic::Internal::CursorPage,
-          model: Lithic::Models::CardListResponse,
+          model: Lithic::Models::NonPCICard,
           options: options
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Lithic::Models::CardConvertPhysicalParams} for more details.
+      #
       # Convert a virtual card into a physical card and manufacture it. Customer must
       # supply relevant fields for physical card creation including `product_id`,
       # `carrier`, `shipping_method`, and `shipping_address`. The card token will be
@@ -143,13 +205,19 @@ module Lithic
       # @overload convert_physical(card_token, shipping_address:, carrier: nil, product_id: nil, shipping_method: nil, request_options: {})
       #
       # @param card_token [String]
-      # @param shipping_address [Lithic::Models::ShippingAddress]
-      # @param carrier [Lithic::Models::Carrier]
-      # @param product_id [String]
-      # @param shipping_method [Symbol, Lithic::Models::CardConvertPhysicalParams::ShippingMethod]
+      #
+      # @param shipping_address [Lithic::Models::ShippingAddress] The shipping address this card will be sent to.
+      #
+      # @param carrier [Lithic::Models::Carrier] If omitted, the previous carrier will be used.
+      #
+      # @param product_id [String] Specifies the configuration (e.g. physical card art) that the card should be man
+      # ...
+      #
+      # @param shipping_method [Symbol, Lithic::Models::CardConvertPhysicalParams::ShippingMethod] Shipping method for the card. Only applies to cards of type PHYSICAL. ...
+      #
       # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Lithic::Models::CardConvertPhysicalResponse]
+      # @return [Lithic::Models::Card]
       #
       # @see Lithic::Models::CardConvertPhysicalParams
       def convert_physical(card_token, params)
@@ -158,7 +226,7 @@ module Lithic
           method: :post,
           path: ["v1/cards/%1$s/convert_physical", card_token],
           body: parsed,
-          model: Lithic::Models::CardConvertPhysicalResponse,
+          model: Lithic::Models::Card,
           options: options
         )
       end
@@ -193,8 +261,10 @@ module Lithic
       #
       # @overload embed(embed_request:, hmac:, request_options: {})
       #
-      # @param embed_request [String]
-      # @param hmac [String]
+      # @param embed_request [String] A base64 encoded JSON string of an EmbedRequest to specify which card to load.
+      #
+      # @param hmac [String] SHA256 HMAC of the embed_request JSON string with base64 digest.
+      #
       # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [String]
@@ -212,6 +282,9 @@ module Lithic
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Lithic::Models::CardProvisionParams} for more details.
+      #
       # Allow your cardholders to directly add payment cards to the device's digital
       # wallet (e.g. Apple Pay) with one touch from your app.
       #
@@ -221,13 +294,25 @@ module Lithic
       #
       # @overload provision(card_token, certificate: nil, client_device_id: nil, client_wallet_account_id: nil, digital_wallet: nil, nonce: nil, nonce_signature: nil, request_options: {})
       #
-      # @param card_token [String]
-      # @param certificate [String]
-      # @param client_device_id [String]
-      # @param client_wallet_account_id [String]
-      # @param digital_wallet [Symbol, Lithic::Models::CardProvisionParams::DigitalWallet]
-      # @param nonce [String]
-      # @param nonce_signature [String]
+      # @param card_token [String] The unique token of the card to add to the device's digital wallet.
+      #
+      # @param certificate [String] Only applicable if `digital_wallet` is `APPLE_PAY`. Omit to receive only `activa
+      # ...
+      #
+      # @param client_device_id [String] Only applicable if `digital_wallet` is `GOOGLE_PAY` or `SAMSUNG_PAY` and the car
+      # ...
+      #
+      # @param client_wallet_account_id [String] Only applicable if `digital_wallet` is `GOOGLE_PAY` or `SAMSUNG_PAY` and the car
+      # ...
+      #
+      # @param digital_wallet [Symbol, Lithic::Models::CardProvisionParams::DigitalWallet] Name of digital wallet provider.
+      #
+      # @param nonce [String] Only applicable if `digital_wallet` is `APPLE_PAY`. Omit to receive only `activa
+      # ...
+      #
+      # @param nonce_signature [String] Only applicable if `digital_wallet` is `APPLE_PAY`. Omit to receive only `activa
+      # ...
+      #
       # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::CardProvisionResponse]
@@ -244,6 +329,9 @@ module Lithic
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Lithic::Models::CardReissueParams} for more details.
+      #
       # Initiate print and shipment of a duplicate physical card (e.g. card is
       # physically damaged). The PAN, expiry, and CVC2 will remain the same and the
       # original card can continue to be used until the new card is activated. Only
@@ -253,13 +341,19 @@ module Lithic
       # @overload reissue(card_token, carrier: nil, product_id: nil, shipping_address: nil, shipping_method: nil, request_options: {})
       #
       # @param card_token [String]
-      # @param carrier [Lithic::Models::Carrier]
-      # @param product_id [String]
-      # @param shipping_address [Lithic::Models::ShippingAddress]
-      # @param shipping_method [Symbol, Lithic::Models::CardReissueParams::ShippingMethod]
+      #
+      # @param carrier [Lithic::Models::Carrier] If omitted, the previous carrier will be used.
+      #
+      # @param product_id [String] Specifies the configuration (e.g. physical card art) that the card should be man
+      # ...
+      #
+      # @param shipping_address [Lithic::Models::ShippingAddress] If omitted, the previous shipping address will be used.
+      #
+      # @param shipping_method [Symbol, Lithic::Models::CardReissueParams::ShippingMethod] Shipping method for the card. Only applies to cards of type PHYSICAL. ...
+      #
       # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Lithic::Models::CardReissueResponse]
+      # @return [Lithic::Models::Card]
       #
       # @see Lithic::Models::CardReissueParams
       def reissue(card_token, params = {})
@@ -268,11 +362,14 @@ module Lithic
           method: :post,
           path: ["v1/cards/%1$s/reissue", card_token],
           body: parsed,
-          model: Lithic::Models::CardReissueResponse,
+          model: Lithic::Models::Card,
           options: options
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Lithic::Models::CardRenewParams} for more details.
+      #
       # Applies to card types `PHYSICAL` and `VIRTUAL`. For `PHYSICAL`, creates a new
       # card with the same card token and PAN, but updated expiry and CVC2 code. The
       # original card will keep working for card-present transactions until the new card
@@ -286,15 +383,25 @@ module Lithic
       # @overload renew(card_token, shipping_address:, carrier: nil, exp_month: nil, exp_year: nil, product_id: nil, shipping_method: nil, request_options: {})
       #
       # @param card_token [String]
-      # @param shipping_address [Lithic::Models::ShippingAddress]
-      # @param carrier [Lithic::Models::Carrier]
-      # @param exp_month [String]
-      # @param exp_year [String]
-      # @param product_id [String]
-      # @param shipping_method [Symbol, Lithic::Models::CardRenewParams::ShippingMethod]
+      #
+      # @param shipping_address [Lithic::Models::ShippingAddress] The shipping address this card will be sent to.
+      #
+      # @param carrier [Lithic::Models::Carrier] If omitted, the previous carrier will be used.
+      #
+      # @param exp_month [String] Two digit (MM) expiry month. If neither `exp_month` nor `exp_year` is provided,
+      # ...
+      #
+      # @param exp_year [String] Four digit (yyyy) expiry year. If neither `exp_month` nor `exp_year` is provided
+      # ...
+      #
+      # @param product_id [String] Specifies the configuration (e.g. physical card art) that the card should be man
+      # ...
+      #
+      # @param shipping_method [Symbol, Lithic::Models::CardRenewParams::ShippingMethod] Shipping method for the card. Only applies to cards of type PHYSICAL. ...
+      #
       # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Lithic::Models::CardRenewResponse]
+      # @return [Lithic::Models::Card]
       #
       # @see Lithic::Models::CardRenewParams
       def renew(card_token, params)
@@ -303,7 +410,7 @@ module Lithic
           method: :post,
           path: ["v1/cards/%1$s/renew", card_token],
           body: parsed,
-          model: Lithic::Models::CardRenewResponse,
+          model: Lithic::Models::Card,
           options: options
         )
       end
@@ -338,10 +445,11 @@ module Lithic
       #
       # @overload search_by_pan(pan:, request_options: {})
       #
-      # @param pan [String]
+      # @param pan [String] The PAN for the card being retrieved.
+      #
       # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Lithic::Models::CardSearchByPanResponse]
+      # @return [Lithic::Models::Card]
       #
       # @see Lithic::Models::CardSearchByPanParams
       def search_by_pan(params)
@@ -350,7 +458,7 @@ module Lithic
           method: :post,
           path: "v1/cards/search_by_pan",
           body: parsed,
-          model: Lithic::Models::CardSearchByPanResponse,
+          model: Lithic::Models::Card,
           options: options
         )
       end

data/lib/lithic/resources/credit_products/extended_credit.rb

@@ -8,7 +8,8 @@ module Lithic
         #
         # @overload retrieve(credit_product_token, request_options: {})
         #
-        # @param credit_product_token [String]
+        # @param credit_product_token [String] Credit Product Token
+        #
         # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [Lithic::Models::CreditProducts::CreditProductsExtendedCredit]