fix(api): Modify return type of returns API to payment-transaction

feat(api): Add Payoff Details

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 172
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/lithic%2Flithic-e1901db484e520cc1f6aa88c8b00d0fcda30c8f9e5ea562a12b9edfc3fb3b6d6.yml
-openapi_spec_hash: 59c317749628f3ed4cc7911b68f6351f
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/lithic%2Flithic-9791980619fc7ce8afb01f77dfe3c660a540975327378287cb666136ae4b0a99.yml
+openapi_spec_hash: 0752074b2a7b0534329a1e3176c94a62
 config_hash: aab05d0cf41f1f6b9f4d5677273c1600

lib/lithic.rb

@@ -289,7 +289,6 @@
 require_relative "lithic/models/payment_retry_params"
 require_relative "lithic/models/payment_retry_response"
 require_relative "lithic/models/payment_return_params"
-require_relative "lithic/models/payment_return_response"
 require_relative "lithic/models/payment_simulate_action_params"
 require_relative "lithic/models/payment_simulate_action_response"
 require_relative "lithic/models/payment_simulate_receipt_params"

lib/lithic/models/financial_accounts/statement.rb

@@ -126,7 +126,13 @@ class Statement < Lithic::Internal::Type::BaseModel
         #   @return [Date, nil]
         optional :next_statement_end_date, Date
 
-        # @!method initialize(token:, account_standing:, amount_due:, available_credit:, created:, credit_limit:, credit_product_token:, days_in_billing_cycle:, ending_balance:, financial_account_token:, payment_due_date:, period_totals:, starting_balance:, statement_end_date:, statement_start_date:, statement_type:, updated:, ytd_totals:, interest_details: nil, next_payment_due_date: nil, next_statement_end_date: nil)
+        # @!attribute payoff_details
+        #   Details on number and size of payments to pay off balance
+        #
+        #   @return [Lithic::Models::FinancialAccounts::Statement::PayoffDetails, nil]
+        optional :payoff_details, -> { Lithic::FinancialAccounts::Statement::PayoffDetails }, nil?: true
+
+        # @!method initialize(token:, account_standing:, amount_due:, available_credit:, created:, credit_limit:, credit_product_token:, days_in_billing_cycle:, ending_balance:, financial_account_token:, payment_due_date:, period_totals:, starting_balance:, statement_end_date:, statement_start_date:, statement_type:, updated:, ytd_totals:, interest_details: nil, next_payment_due_date: nil, next_statement_end_date: nil, payoff_details: nil)
         #   Some parameter documentations has been truncated, see
         #   {Lithic::Models::FinancialAccounts::Statement} for more details.
         #
@@ -171,6 +177,8 @@ class Statement < Lithic::Internal::Type::BaseModel
         #   @param next_payment_due_date [Date] Date when the next payment is due
         #
         #   @param next_statement_end_date [Date] Date when the next billing period will end
+        #
+        #   @param payoff_details [Lithic::Models::FinancialAccounts::Statement::PayoffDetails, nil] Details on number and size of payments to pay off balance
 
         # @see Lithic::Models::FinancialAccounts::Statement#account_standing
         class AccountStanding < Lithic::Internal::Type::BaseModel
@@ -406,6 +414,59 @@ module InterestCalculationMethod
             #   @return [Array<Symbol>]
           end
         end
+
+        # @see Lithic::Models::FinancialAccounts::Statement#payoff_details
+        class PayoffDetails < Lithic::Internal::Type::BaseModel
+          # @!attribute minimum_payment_months
+          #   The number of months it would take to pay off the balance in full by only paying
+          #   the minimum payment. "NA" will signal negative or zero amortization
+          #
+          #   @return [String]
+          required :minimum_payment_months, String
+
+          # @!attribute minimum_payment_total
+          #   The sum of all interest and principal paid, in cents, when only paying minimum
+          #   monthly payment. "NA" will signal negative or zero amortization
+          #
+          #   @return [String]
+          required :minimum_payment_total, String
+
+          # @!attribute payoff_period_length_months
+          #   Number of months to full pay off
+          #
+          #   @return [Integer]
+          required :payoff_period_length_months, Integer
+
+          # @!attribute payoff_period_monthly_payment_amount
+          #   The amount needed to be paid, in cents, each month in order to pay off current
+          #   balance in the payoff period
+          #
+          #   @return [Integer]
+          required :payoff_period_monthly_payment_amount, Integer
+
+          # @!attribute payoff_period_payment_total
+          #   The sum of all interest and principal paid, in cents, when paying off in the
+          #   payoff period
+          #
+          #   @return [Integer]
+          required :payoff_period_payment_total, Integer
+
+          # @!method initialize(minimum_payment_months:, minimum_payment_total:, payoff_period_length_months:, payoff_period_monthly_payment_amount:, payoff_period_payment_total:)
+          #   Some parameter documentations has been truncated, see
+          #   {Lithic::Models::FinancialAccounts::Statement::PayoffDetails} for more details.
+          #
+          #   Details on number and size of payments to pay off balance
+          #
+          #   @param minimum_payment_months [String] The number of months it would take to pay off the balance in full by only paying
+          #
+          #   @param minimum_payment_total [String] The sum of all interest and principal paid, in cents, when only paying minimum m
+          #
+          #   @param payoff_period_length_months [Integer] Number of months to full pay off
+          #
+          #   @param payoff_period_monthly_payment_amount [Integer] The amount needed to be paid, in cents, each month in order to pay off current b
+          #
+          #   @param payoff_period_payment_total [Integer] The sum of all interest and principal paid, in cents, when paying off in the pay
+        end
       end
     end
   end

lib/lithic/models/payment_return_response.rb

@@ -162,7 +162,7 @@ def retry_(payment_token, params = {})
       #
       # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Lithic::Models::PaymentReturnResponse]
+      # @return [Lithic::Models::Payment]
       #
       # @see Lithic::Models::PaymentReturnParams
       def return_(payment_token, params)
@@ -171,7 +171,7 @@ def return_(payment_token, params)
           method: :post,
           path: ["v1/payments/%1$s/return", payment_token],
           body: parsed,
-          model: Lithic::Models::PaymentReturnResponse,
+          model: Lithic::Payment,
           options: options
         )
       end

lib/lithic/resources/payments.rb

@@ -136,6 +136,24 @@ module Lithic
         sig { params(next_statement_end_date: Date).void }
         attr_writer :next_statement_end_date
 
+        # Details on number and size of payments to pay off balance
+        sig do
+          returns(
+            T.nilable(Lithic::FinancialAccounts::Statement::PayoffDetails)
+          )
+        end
+        attr_reader :payoff_details
+
+        sig do
+          params(
+            payoff_details:
+              T.nilable(
+                Lithic::FinancialAccounts::Statement::PayoffDetails::OrHash
+              )
+          ).void
+        end
+        attr_writer :payoff_details
+
         sig do
           params(
             token: String,
@@ -163,7 +181,11 @@ module Lithic
                 Lithic::FinancialAccounts::Statement::InterestDetails::OrHash
               ),
             next_payment_due_date: Date,
-            next_statement_end_date: Date
+            next_statement_end_date: Date,
+            payoff_details:
+              T.nilable(
+                Lithic::FinancialAccounts::Statement::PayoffDetails::OrHash
+              )
           ).returns(T.attached_class)
         end
         def self.new(
@@ -203,7 +225,9 @@ module Lithic
           # Date when the next payment is due
           next_payment_due_date: nil,
           # Date when the next billing period will end
-          next_statement_end_date: nil
+          next_statement_end_date: nil,
+          # Details on number and size of payments to pay off balance
+          payoff_details: nil
         )
         end
 
@@ -235,7 +259,9 @@ module Lithic
                   Lithic::FinancialAccounts::Statement::InterestDetails
                 ),
               next_payment_due_date: Date,
-              next_statement_end_date: Date
+              next_statement_end_date: Date,
+              payoff_details:
+                T.nilable(Lithic::FinancialAccounts::Statement::PayoffDetails)
             }
           )
         end
@@ -743,6 +769,82 @@ module Lithic
             end
           end
         end
+
+        class PayoffDetails < Lithic::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Lithic::FinancialAccounts::Statement::PayoffDetails,
+                Lithic::Internal::AnyHash
+              )
+            end
+
+          # The number of months it would take to pay off the balance in full by only paying
+          # the minimum payment. "NA" will signal negative or zero amortization
+          sig { returns(String) }
+          attr_accessor :minimum_payment_months
+
+          # The sum of all interest and principal paid, in cents, when only paying minimum
+          # monthly payment. "NA" will signal negative or zero amortization
+          sig { returns(String) }
+          attr_accessor :minimum_payment_total
+
+          # Number of months to full pay off
+          sig { returns(Integer) }
+          attr_accessor :payoff_period_length_months
+
+          # The amount needed to be paid, in cents, each month in order to pay off current
+          # balance in the payoff period
+          sig { returns(Integer) }
+          attr_accessor :payoff_period_monthly_payment_amount
+
+          # The sum of all interest and principal paid, in cents, when paying off in the
+          # payoff period
+          sig { returns(Integer) }
+          attr_accessor :payoff_period_payment_total
+
+          # Details on number and size of payments to pay off balance
+          sig do
+            params(
+              minimum_payment_months: String,
+              minimum_payment_total: String,
+              payoff_period_length_months: Integer,
+              payoff_period_monthly_payment_amount: Integer,
+              payoff_period_payment_total: Integer
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # The number of months it would take to pay off the balance in full by only paying
+            # the minimum payment. "NA" will signal negative or zero amortization
+            minimum_payment_months:,
+            # The sum of all interest and principal paid, in cents, when only paying minimum
+            # monthly payment. "NA" will signal negative or zero amortization
+            minimum_payment_total:,
+            # Number of months to full pay off
+            payoff_period_length_months:,
+            # The amount needed to be paid, in cents, each month in order to pay off current
+            # balance in the payoff period
+            payoff_period_monthly_payment_amount:,
+            # The sum of all interest and principal paid, in cents, when paying off in the
+            # payoff period
+            payoff_period_payment_total:
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                minimum_payment_months: String,
+                minimum_payment_total: String,
+                payoff_period_length_months: Integer,
+                payoff_period_monthly_payment_amount: Integer,
+                payoff_period_payment_total: Integer
+              }
+            )
+          end
+          def to_hash
+          end
+        end
       end
     end
   end