lithic 0.1.0.pre.alpha.31 → 0.1.0.pre.alpha.33

data/lib/lithic/models/auth_rules/velocity_limit_params.rb

@@ -113,6 +113,7 @@ module Lithic
           # * `DAY`: Velocity over the current day since midnight Eastern Time.
           # * `WEEK`: Velocity over the current week since 00:00 / 12 AM on Monday in Eastern Time.
           # * `MONTH`: Velocity over the current month since 00:00 / 12 AM on the first of the month in Eastern Time.
+          # * `YEAR`: Velocity over the current year since 00:00 / 12 AM on January 1st in Eastern Time.
           variant enum: -> { Lithic::AuthRules::VelocityLimitParamsPeriodWindow }
 
           # @!method self.variants

data/lib/lithic/models/auth_rules/velocity_limit_params_period_window.rb

@@ -10,12 +10,15 @@ module Lithic
       #   Eastern Time.
       # - `MONTH`: Velocity over the current month since 00:00 / 12 AM on the first of
       #   the month in Eastern Time.
+      # - `YEAR`: Velocity over the current year since 00:00 / 12 AM on January 1st in
+      #   Eastern Time.
       module VelocityLimitParamsPeriodWindow
         extend Lithic::Internal::Type::Enum
 
         DAY = :DAY
         WEEK = :WEEK
         MONTH = :MONTH
+        YEAR = :YEAR
 
         # @!method self.values
         #   @return [Array<Symbol>]

data/lib/lithic/models/financial_account.rb

@@ -209,6 +209,7 @@ module Lithic
         CHARGED_OFF_PRINCIPAL = :CHARGED_OFF_PRINCIPAL
         SECURITY = :SECURITY
         PROGRAM_RECEIVABLES = :PROGRAM_RECEIVABLES
+        COLLECTION = :COLLECTION
 
         # @!method self.values
         #   @return [Array<Symbol>]

data/lib/lithic/models/financial_account_register_account_number_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    # @see Lithic::Resources::FinancialAccounts#register_account_number
+    class FinancialAccountRegisterAccountNumberParams < Lithic::Internal::Type::BaseModel
+      extend Lithic::Internal::Type::RequestParameters::Converter
+      include Lithic::Internal::Type::RequestParameters
+
+      # @!attribute account_number
+      #
+      #   @return [String]
+      required :account_number, String
+
+      # @!method initialize(account_number:, request_options: {})
+      #   @param account_number [String]
+      #   @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/lithic/models/instance_financial_account_type.rb

@@ -14,6 +14,7 @@ module Lithic
       CHARGED_OFF_PRINCIPAL = :CHARGED_OFF_PRINCIPAL
       SECURITY = :SECURITY
       PROGRAM_RECEIVABLES = :PROGRAM_RECEIVABLES
+      COLLECTION = :COLLECTION
 
       # @!method self.values
       #   @return [Array<Symbol>]

data/lib/lithic/models/settlement_detail.rb

@@ -98,7 +98,9 @@ module Lithic
       required :report_date, String
 
       # @!attribute settlement_date
-      #   Date of when money movement is triggered for the transaction.
+      #   Date of when money movement is triggered for the transaction. One exception
+      #   applies - for Mastercard dual message settlement, this is the settlement
+      #   advisement date, which is distinct from the date of money movement.
       #
       #   @return [String]
       required :settlement_date, String
@@ -168,7 +170,7 @@ module Lithic
       #
       #   @param report_date [String] Date of when the report was first generated.
       #
-      #   @param settlement_date [String] Date of when money movement is triggered for the transaction.
+      #   @param settlement_date [String] Date of when money movement is triggered for the transaction. One exception appl
       #
       #   @param transaction_token [String] Globally unique identifier denoting the associated Transaction object.
       #

data/lib/lithic/models/transaction.rb

@@ -508,6 +508,7 @@ module Lithic
         module DecisionMadeBy
           extend Lithic::Internal::Type::Enum
 
+          CUSTOMER_RULES = :CUSTOMER_RULES
           CUSTOMER_ENDPOINT = :CUSTOMER_ENDPOINT
           LITHIC_DEFAULT = :LITHIC_DEFAULT
           LITHIC_RULES = :LITHIC_RULES

data/lib/lithic/models/verification_method.rb

@@ -10,6 +10,7 @@ module Lithic
       PLAID = :PLAID
       PRENOTE = :PRENOTE
       EXTERNALLY_VERIFIED = :EXTERNALLY_VERIFIED
+      UNVERIFIED = :UNVERIFIED
 
       # @!method self.values
       #   @return [Array<Symbol>]

data/lib/lithic/models.rb

@@ -230,6 +230,8 @@ module Lithic
 
   FinancialAccountListParams = Lithic::Models::FinancialAccountListParams
 
+  FinancialAccountRegisterAccountNumberParams = Lithic::Models::FinancialAccountRegisterAccountNumberParams
+
   FinancialAccountRetrieveParams = Lithic::Models::FinancialAccountRetrieveParams
 
   FinancialAccounts = Lithic::Models::FinancialAccounts

data/lib/lithic/resources/financial_accounts.rb

@@ -119,6 +119,30 @@ module Lithic
         )
       end
 
+      # Register account number
+      #
+      # @overload register_account_number(financial_account_token, account_number:, request_options: {})
+      #
+      # @param financial_account_token [String] Globally unique identifier for financial account.
+      #
+      # @param account_number [String]
+      #
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [nil]
+      #
+      # @see Lithic::Models::FinancialAccountRegisterAccountNumberParams
+      def register_account_number(financial_account_token, params)
+        parsed, options = Lithic::FinancialAccountRegisterAccountNumberParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: ["v1/financial_accounts/%1$s/register_account_number", financial_account_token],
+          body: parsed,
+          model: NilClass,
+          options: options
+        )
+      end
+
       # Update financial account status
       #
       # @overload update_status(financial_account_token, status:, substatus:, request_options: {})

data/lib/lithic/resources/three_ds/authentication.rb

@@ -30,7 +30,9 @@ module Lithic
         # Simulates a 3DS authentication request from the payment network as if it came
         # from an ACS. If you're configured for 3DS Customer Decisioning, simulating
         # authentications requires your customer decisioning endpoint to be set up
-        # properly (respond with a valid JSON).
+        # properly (respond with a valid JSON). If the authentication decision is to
+        # challenge, ensure that the account holder associated with the card transaction
+        # has a valid phone number configured to receive the OTP code via SMS.
         #
         # @overload simulate(merchant:, pan:, transaction:, card_expiry_check: nil, request_options: {})
         #

data/lib/lithic/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Lithic
-  VERSION = "0.1.0.pre.alpha.31"
+  VERSION = "0.1.0.pre.alpha.33"
 end

data/lib/lithic.rb

@@ -211,6 +211,7 @@ require_relative "lithic/models/external_payment_settle_params"
 require_relative "lithic/models/financial_account"
 require_relative "lithic/models/financial_account_create_params"
 require_relative "lithic/models/financial_account_list_params"
+require_relative "lithic/models/financial_account_register_account_number_params"
 require_relative "lithic/models/financial_account_retrieve_params"
 require_relative "lithic/models/financial_accounts/balance_list_params"
 require_relative "lithic/models/financial_accounts/balance_list_response"

data/rbi/lithic/errors.rbi

@@ -8,6 +8,22 @@ module Lithic
     end
 
     class ConversionError < Lithic::Errors::Error
+      sig { returns(T.nilable(StandardError)) }
+      def cause
+      end
+
+      # @api private
+      sig do
+        params(
+          on: T::Class[StandardError],
+          method: Symbol,
+          target: T.anything,
+          value: T.anything,
+          cause: T.nilable(StandardError)
+        ).returns(T.attached_class)
+      end
+      def self.new(on:, method:, target:, value:, cause: nil)
+      end
     end
 
     class APIError < Lithic::Errors::Error

data/rbi/lithic/internal/type/boolean.rbi

@@ -22,6 +22,8 @@ module Lithic
 
         class << self
           # @api private
+          #
+          # Coerce value to Boolean if possible, otherwise return the original value.
           sig do
             override
               .params(

data/rbi/lithic/internal/type/converter.rbi

@@ -15,12 +15,14 @@ module Lithic
         CoerceState =
           T.type_alias do
             {
-              strictness: T.any(T::Boolean, Symbol),
+              translate_names: T::Boolean,
+              strictness: T::Boolean,
               exactness: {
                 yes: Integer,
                 no: Integer,
                 maybe: Integer
               },
+              error: T::Class[StandardError],
               branched: Integer
             }
           end
@@ -84,6 +86,15 @@ module Lithic
           def self.type_info(spec)
           end
 
+          # @api private
+          sig do
+            params(translate_names: T::Boolean).returns(
+              Lithic::Internal::Type::Converter::CoerceState
+            )
+          end
+          def self.new_coerce_state(translate_names: true)
+          end
+
           # @api private
           #
           # Based on `target`, transform `value` into `target`, to the extent possible:
@@ -105,14 +116,11 @@ module Lithic
           def self.coerce(
             target,
             value,
-            # The `strictness` is one of `true`, `false`, or `:strong`. This informs the
-            # coercion strategy when we have to decide between multiple possible conversion
-            # targets:
+            # The `strictness` is one of `true`, `false`. This informs the coercion strategy
+            # when we have to decide between multiple possible conversion targets:
             #
             # - `true`: the conversion must be exact, with minimum coercion.
             # - `false`: the conversion can be approximate, with some coercion.
-            # - `:strong`: the conversion must be exact, with no coercion, and raise an error
-            #   if not possible.
             #
             # The `exactness` is `Hash` with keys being one of `yes`, `no`, or `maybe`. For
             # any given conversion attempt, the exactness will be updated based on how closely
@@ -124,15 +132,7 @@ module Lithic
             # - `no`: the value cannot be converted to the target type.
             #
             # See implementation below for more details.
-            state: {
-              strictness: true,
-              exactness: {
-                yes: 0,
-                no: 0,
-                maybe: 0
-              },
-              branched: 0
-            }
+            state: Lithic::Internal::Type::Converter.new_coerce_state
           )
           end
 

data/rbi/lithic/internal/type/union.rbi

@@ -78,6 +78,11 @@ module Lithic
         end
 
         # @api private
+        #
+        # Tries to efficiently coerce the given value to one of the known variants.
+        #
+        # If the value cannot match any of the known variants, the coercion is considered
+        # non-viable and returns the original value.
         sig do
           override
             .params(

data/rbi/lithic/internal/type/unknown.rbi

@@ -22,6 +22,8 @@ module Lithic
 
         class << self
           # @api private
+          #
+          # No coercion needed for Unknown type.
           sig do
             override
               .params(

data/rbi/lithic/models/account.rbi

@@ -33,11 +33,11 @@ module Lithic
       # - `PAUSED` - Account will not be able to transact or create new cards. It can be
       #   set back to `ACTIVE`.
       # - `CLOSED` - Account will not be able to transact or create new cards. `CLOSED`
-      #   accounts are also unable to be transitioned to `ACTIVE` or `PAUSED` states.
-      #   `CLOSED` accounts result from failing to pass KYB/KYC or Lithic closing for
-      #   risk/compliance reasons. Please contact
-      #   [support@lithic.com](mailto:support@lithic.com) if you believe this was in
-      #   error.
+      #   accounts are unable to be transitioned to `ACTIVE` or `PAUSED` states.
+      #   Accounts can be manually set to `CLOSED`, or this can be done by Lithic due to
+      #   failure to pass KYB/KYC or for risk/compliance reasons. Please contact
+      #   [support@lithic.com](mailto:support@lithic.com) if you believe this was done
+      #   by mistake.
       sig { returns(Lithic::Account::State::TaggedSymbol) }
       attr_accessor :state
 
@@ -107,11 +107,11 @@ module Lithic
         # - `PAUSED` - Account will not be able to transact or create new cards. It can be
         #   set back to `ACTIVE`.
         # - `CLOSED` - Account will not be able to transact or create new cards. `CLOSED`
-        #   accounts are also unable to be transitioned to `ACTIVE` or `PAUSED` states.
-        #   `CLOSED` accounts result from failing to pass KYB/KYC or Lithic closing for
-        #   risk/compliance reasons. Please contact
-        #   [support@lithic.com](mailto:support@lithic.com) if you believe this was in
-        #   error.
+        #   accounts are unable to be transitioned to `ACTIVE` or `PAUSED` states.
+        #   Accounts can be manually set to `CLOSED`, or this can be done by Lithic due to
+        #   failure to pass KYB/KYC or for risk/compliance reasons. Please contact
+        #   [support@lithic.com](mailto:support@lithic.com) if you believe this was done
+        #   by mistake.
         state:,
         account_holder: nil,
         # List of identifiers for the Auth Rule(s) that are applied on the account. This
@@ -195,11 +195,11 @@ module Lithic
       # - `PAUSED` - Account will not be able to transact or create new cards. It can be
       #   set back to `ACTIVE`.
       # - `CLOSED` - Account will not be able to transact or create new cards. `CLOSED`
-      #   accounts are also unable to be transitioned to `ACTIVE` or `PAUSED` states.
-      #   `CLOSED` accounts result from failing to pass KYB/KYC or Lithic closing for
-      #   risk/compliance reasons. Please contact
-      #   [support@lithic.com](mailto:support@lithic.com) if you believe this was in
-      #   error.
+      #   accounts are unable to be transitioned to `ACTIVE` or `PAUSED` states.
+      #   Accounts can be manually set to `CLOSED`, or this can be done by Lithic due to
+      #   failure to pass KYB/KYC or for risk/compliance reasons. Please contact
+      #   [support@lithic.com](mailto:support@lithic.com) if you believe this was done
+      #   by mistake.
       module State
         extend Lithic::Internal::Type::Enum
 

data/rbi/lithic/models/account_update_params.rbi

@@ -129,6 +129,8 @@ module Lithic
           T.let(:ACTIVE, Lithic::AccountUpdateParams::State::TaggedSymbol)
         PAUSED =
           T.let(:PAUSED, Lithic::AccountUpdateParams::State::TaggedSymbol)
+        CLOSED =
+          T.let(:CLOSED, Lithic::AccountUpdateParams::State::TaggedSymbol)
 
         sig do
           override.returns(

data/rbi/lithic/models/auth_rules/velocity_limit_params_period_window.rbi

@@ -10,6 +10,8 @@ module Lithic
       #   Eastern Time.
       # - `MONTH`: Velocity over the current month since 00:00 / 12 AM on the first of
       #   the month in Eastern Time.
+      # - `YEAR`: Velocity over the current year since 00:00 / 12 AM on January 1st in
+      #   Eastern Time.
       module VelocityLimitParamsPeriodWindow
         extend Lithic::Internal::Type::Enum
 
@@ -34,6 +36,11 @@ module Lithic
             :MONTH,
             Lithic::AuthRules::VelocityLimitParamsPeriodWindow::TaggedSymbol
           )
+        YEAR =
+          T.let(
+            :YEAR,
+            Lithic::AuthRules::VelocityLimitParamsPeriodWindow::TaggedSymbol
+          )
 
         sig do
           override.returns(

data/rbi/lithic/models/financial_account.rbi

@@ -353,6 +353,8 @@ module Lithic
             :PROGRAM_RECEIVABLES,
             Lithic::FinancialAccount::Type::TaggedSymbol
           )
+        COLLECTION =
+          T.let(:COLLECTION, Lithic::FinancialAccount::Type::TaggedSymbol)
 
         sig do
           override.returns(

data/rbi/lithic/models/financial_account_register_account_number_params.rbi

@@ -0,0 +1,38 @@
+# typed: strong
+
+module Lithic
+  module Models
+    class FinancialAccountRegisterAccountNumberParams < Lithic::Internal::Type::BaseModel
+      extend Lithic::Internal::Type::RequestParameters::Converter
+      include Lithic::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Lithic::FinancialAccountRegisterAccountNumberParams,
+            Lithic::Internal::AnyHash
+          )
+        end
+
+      sig { returns(String) }
+      attr_accessor :account_number
+
+      sig do
+        params(
+          account_number: String,
+          request_options: Lithic::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(account_number:, request_options: {})
+      end
+
+      sig do
+        override.returns(
+          { account_number: String, request_options: Lithic::RequestOptions }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/lithic/models/instance_financial_account_type.rbi

@@ -38,6 +38,8 @@ module Lithic
           :PROGRAM_RECEIVABLES,
           Lithic::InstanceFinancialAccountType::TaggedSymbol
         )
+      COLLECTION =
+        T.let(:COLLECTION, Lithic::InstanceFinancialAccountType::TaggedSymbol)
 
       sig do
         override.returns(

data/rbi/lithic/models/settlement_detail.rbi

@@ -79,7 +79,9 @@ module Lithic
       sig { returns(String) }
       attr_accessor :report_date
 
-      # Date of when money movement is triggered for the transaction.
+      # Date of when money movement is triggered for the transaction. One exception
+      # applies - for Mastercard dual message settlement, this is the settlement
+      # advisement date, which is distinct from the date of money movement.
       sig { returns(String) }
       attr_accessor :settlement_date
 
@@ -168,7 +170,9 @@ module Lithic
         other_fees_gross_amount:,
         # Date of when the report was first generated.
         report_date:,
-        # Date of when money movement is triggered for the transaction.
+        # Date of when money movement is triggered for the transaction. One exception
+        # applies - for Mastercard dual message settlement, this is the settlement
+        # advisement date, which is distinct from the date of money movement.
         settlement_date:,
         # Globally unique identifier denoting the associated Transaction object.
         transaction_token:,

data/rbi/lithic/models/transaction.rbi

@@ -815,6 +815,11 @@ module Lithic
             end
           OrSymbol = T.type_alias { T.any(Symbol, String) }
 
+          CUSTOMER_RULES =
+            T.let(
+              :CUSTOMER_RULES,
+              Lithic::Transaction::CardholderAuthentication::DecisionMadeBy::TaggedSymbol
+            )
           CUSTOMER_ENDPOINT =
             T.let(
               :CUSTOMER_ENDPOINT,

data/rbi/lithic/models/verification_method.rbi

@@ -15,6 +15,7 @@ module Lithic
       PRENOTE = T.let(:PRENOTE, Lithic::VerificationMethod::TaggedSymbol)
       EXTERNALLY_VERIFIED =
         T.let(:EXTERNALLY_VERIFIED, Lithic::VerificationMethod::TaggedSymbol)
+      UNVERIFIED = T.let(:UNVERIFIED, Lithic::VerificationMethod::TaggedSymbol)
 
       sig do
         override.returns(T::Array[Lithic::VerificationMethod::TaggedSymbol])

data/rbi/lithic/models.rbi

@@ -205,6 +205,9 @@ module Lithic
 
   FinancialAccountListParams = Lithic::Models::FinancialAccountListParams
 
+  FinancialAccountRegisterAccountNumberParams =
+    Lithic::Models::FinancialAccountRegisterAccountNumberParams
+
   FinancialAccountRetrieveParams =
     Lithic::Models::FinancialAccountRetrieveParams
 

data/rbi/lithic/resources/financial_accounts.rbi

@@ -88,6 +88,22 @@ module Lithic
       )
       end
 
+      # Register account number
+      sig do
+        params(
+          financial_account_token: String,
+          account_number: String,
+          request_options: Lithic::RequestOptions::OrHash
+        ).void
+      end
+      def register_account_number(
+        # Globally unique identifier for financial account.
+        financial_account_token,
+        account_number:,
+        request_options: {}
+      )
+      end
+
       # Update financial account status
       sig do
         params(

data/rbi/lithic/resources/three_ds/authentication.rbi

@@ -21,7 +21,9 @@ module Lithic
         # Simulates a 3DS authentication request from the payment network as if it came
         # from an ACS. If you're configured for 3DS Customer Decisioning, simulating
         # authentications requires your customer decisioning endpoint to be set up
-        # properly (respond with a valid JSON).
+        # properly (respond with a valid JSON). If the authentication decision is to
+        # challenge, ensure that the account holder associated with the card transaction
+        # has a valid phone number configured to receive the OTP code via SMS.
         sig do
           params(
             merchant:

data/sig/lithic/errors.rbs

@@ -5,6 +5,15 @@ module Lithic
     end
 
     class ConversionError < Lithic::Errors::Error
+      def cause: -> StandardError?
+
+      def initialize: (
+        on: Class,
+        method: Symbol,
+        target: top,
+        value: top,
+        ?cause: StandardError?
+      ) -> void
     end
 
     class APIError < Lithic::Errors::Error

data/sig/lithic/internal/type/converter.rbs

@@ -8,8 +8,10 @@ module Lithic
 
         type coerce_state =
           {
-            strictness: bool | :strong,
+            translate_names: bool,
+            strictness: bool,
             exactness: { yes: Integer, no: Integer, maybe: Integer },
+            error: Class,
             branched: Integer
           }
 
@@ -37,6 +39,10 @@ module Lithic
           | Lithic::Internal::Type::Converter::input spec
         ) -> (^-> top)
 
+        def self.new_coerce_state: (
+          ?translate_names: bool
+        ) -> Lithic::Internal::Type::Converter::coerce_state
+
         def self.coerce: (
           Lithic::Internal::Type::Converter::input target,
           top value,

data/sig/lithic/models/account_update_params.rbs

@@ -56,13 +56,14 @@ module Lithic
         request_options: Lithic::RequestOptions
       }
 
-      type state = :ACTIVE | :PAUSED
+      type state = :ACTIVE | :PAUSED | :CLOSED
 
       module State
         extend Lithic::Internal::Type::Enum
 
         ACTIVE: :ACTIVE
         PAUSED: :PAUSED
+        CLOSED: :CLOSED
 
         def self?.values: -> ::Array[Lithic::Models::AccountUpdateParams::state]
       end

data/sig/lithic/models/auth_rules/velocity_limit_params_period_window.rbs

@@ -1,7 +1,7 @@
 module Lithic
   module Models
     module AuthRules
-      type velocity_limit_params_period_window = :DAY | :WEEK | :MONTH
+      type velocity_limit_params_period_window = :DAY | :WEEK | :MONTH | :YEAR
 
       module VelocityLimitParamsPeriodWindow
         extend Lithic::Internal::Type::Enum
@@ -9,6 +9,7 @@ module Lithic
         DAY: :DAY
         WEEK: :WEEK
         MONTH: :MONTH
+        YEAR: :YEAR
 
         def self?.values: -> ::Array[Lithic::Models::AuthRules::velocity_limit_params_period_window]
       end

data/sig/lithic/models/financial_account.rbs

@@ -165,6 +165,7 @@ module Lithic
         | :CHARGED_OFF_PRINCIPAL
         | :SECURITY
         | :PROGRAM_RECEIVABLES
+        | :COLLECTION
 
       module Type
         extend Lithic::Internal::Type::Enum
@@ -177,6 +178,7 @@ module Lithic
         CHARGED_OFF_PRINCIPAL: :CHARGED_OFF_PRINCIPAL
         SECURITY: :SECURITY
         PROGRAM_RECEIVABLES: :PROGRAM_RECEIVABLES
+        COLLECTION: :COLLECTION
 
         def self?.values: -> ::Array[Lithic::Models::FinancialAccount::type_]
       end

data/sig/lithic/models/financial_account_register_account_number_params.rbs

@@ -0,0 +1,23 @@
+module Lithic
+  module Models
+    type financial_account_register_account_number_params =
+      { account_number: String } & Lithic::Internal::Type::request_parameters
+
+    class FinancialAccountRegisterAccountNumberParams < Lithic::Internal::Type::BaseModel
+      extend Lithic::Internal::Type::RequestParameters::Converter
+      include Lithic::Internal::Type::RequestParameters
+
+      attr_accessor account_number: String
+
+      def initialize: (
+        account_number: String,
+        ?request_options: Lithic::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        account_number: String,
+        request_options: Lithic::RequestOptions
+      }
+    end
+  end
+end