lithic 0.8.0 → 0.10.0

data/lib/lithic/models/transaction.rb

@@ -93,9 +93,10 @@ module Lithic
       required :financial_account_token, String, nil?: true
 
       # @!attribute merchant
+      #   Merchant information including full location details.
       #
-      #   @return [Lithic::Models::Merchant]
-      required :merchant, -> { Lithic::Merchant }
+      #   @return [Lithic::Models::Transaction::Merchant]
+      required :merchant, -> { Lithic::Transaction::Merchant }
 
       # @!attribute merchant_amount
       #   @deprecated
@@ -148,6 +149,14 @@ module Lithic
       #   @return [Symbol, Lithic::Models::Transaction::Result]
       required :result, enum: -> { Lithic::Transaction::Result }
 
+      # @!attribute service_location
+      #   Where the cardholder received the service, when different from the card acceptor
+      #   location. This is populated from network data elements such as Mastercard DE-122
+      #   SE1 SF9-14 and Visa F34 DS02.
+      #
+      #   @return [Lithic::Models::Transaction::ServiceLocation, nil]
+      required :service_location, -> { Lithic::Transaction::ServiceLocation }, nil?: true
+
       # @!attribute settled_amount
       #   @deprecated
       #
@@ -185,7 +194,7 @@ module Lithic
       #   @return [Array<Lithic::Models::Transaction::Event>, nil]
       optional :events, -> { Lithic::Internal::Type::ArrayOf[Lithic::Transaction::Event] }
 
-      # @!method initialize(token:, account_token:, acquirer_fee:, acquirer_reference_number:, amount:, amounts:, authorization_amount:, authorization_code:, avs:, card_token:, cardholder_authentication:, created:, financial_account_token:, merchant:, merchant_amount:, merchant_authorization_amount:, merchant_currency:, network:, network_risk_score:, pos:, result:, settled_amount:, status:, tags:, token_info:, updated:, events: nil)
+      # @!method initialize(token:, account_token:, acquirer_fee:, acquirer_reference_number:, amount:, amounts:, authorization_amount:, authorization_code:, avs:, card_token:, cardholder_authentication:, created:, financial_account_token:, merchant:, merchant_amount:, merchant_authorization_amount:, merchant_currency:, network:, network_risk_score:, pos:, result:, service_location:, settled_amount:, status:, tags:, token_info:, updated:, events: nil)
       #   Some parameter documentations has been truncated, see
       #   {Lithic::Models::Transaction} for more details.
       #
@@ -215,7 +224,7 @@ module Lithic
       #
       #   @param financial_account_token [String, nil]
       #
-      #   @param merchant [Lithic::Models::Merchant]
+      #   @param merchant [Lithic::Models::Transaction::Merchant] Merchant information including full location details.
       #
       #   @param merchant_amount [Integer, nil] Analogous to the 'amount', but in the merchant currency.
       #
@@ -231,6 +240,8 @@ module Lithic
       #
       #   @param result [Symbol, Lithic::Models::Transaction::Result]
       #
+      #   @param service_location [Lithic::Models::Transaction::ServiceLocation, nil] Where the cardholder received the service, when different from the card acceptor
+      #
       #   @param settled_amount [Integer] The settled amount of the transaction in the settlement currency.
       #
       #   @param status [Symbol, Lithic::Models::Transaction::Status] Status of the transaction.
@@ -385,6 +396,36 @@ module Lithic
         #   @param zipcode [String] Cardholder ZIP code
       end
 
+      # @see Lithic::Models::Transaction#merchant
+      class Merchant < Lithic::Models::Merchant
+        # @!attribute phone_number
+        #   Phone number of card acceptor.
+        #
+        #   @return [String, nil]
+        required :phone_number, String, nil?: true
+
+        # @!attribute postal_code
+        #   Postal code of card acceptor.
+        #
+        #   @return [String, nil]
+        required :postal_code, String, nil?: true
+
+        # @!attribute street_address
+        #   Street address of card acceptor.
+        #
+        #   @return [String, nil]
+        required :street_address, String, nil?: true
+
+        # @!method initialize(phone_number:, postal_code:, street_address:)
+        #   Merchant information including full location details.
+        #
+        #   @param phone_number [String, nil] Phone number of card acceptor.
+        #
+        #   @param postal_code [String, nil] Postal code of card acceptor.
+        #
+        #   @param street_address [String, nil] Street address of card acceptor.
+      end
+
       # Card network of the authorization. Value is `UNKNOWN` when Lithic cannot
       # determine the network code from the upstream provider.
       #
@@ -693,6 +734,54 @@ module Lithic
         #   @return [Array<Symbol>]
       end
 
+      # @see Lithic::Models::Transaction#service_location
+      class ServiceLocation < Lithic::Internal::Type::BaseModel
+        # @!attribute city
+        #   City of service location.
+        #
+        #   @return [String, nil]
+        required :city, String, nil?: true
+
+        # @!attribute country
+        #   Country code of service location, ISO 3166-1 alpha-3.
+        #
+        #   @return [String, nil]
+        required :country, String, nil?: true
+
+        # @!attribute postal_code
+        #   Postal code of service location.
+        #
+        #   @return [String, nil]
+        required :postal_code, String, nil?: true
+
+        # @!attribute state
+        #   State/province code of service location, ISO 3166-2.
+        #
+        #   @return [String, nil]
+        required :state, String, nil?: true
+
+        # @!attribute street_address
+        #   Street address of service location.
+        #
+        #   @return [String, nil]
+        required :street_address, String, nil?: true
+
+        # @!method initialize(city:, country:, postal_code:, state:, street_address:)
+        #   Where the cardholder received the service, when different from the card acceptor
+        #   location. This is populated from network data elements such as Mastercard DE-122
+        #   SE1 SF9-14 and Visa F34 DS02.
+        #
+        #   @param city [String, nil] City of service location.
+        #
+        #   @param country [String, nil] Country code of service location, ISO 3166-1 alpha-3.
+        #
+        #   @param postal_code [String, nil] Postal code of service location.
+        #
+        #   @param state [String, nil] State/province code of service location, ISO 3166-2.
+        #
+        #   @param street_address [String, nil] Street address of service location.
+      end
+
       # Status of the transaction.
       #
       # @see Lithic::Models::Transaction#status

data/lib/lithic/resources/account_holders.rb

@@ -279,8 +279,8 @@ module Lithic
       #
       # This endpoint is only valid for evaluations in a `PENDING_DOCUMENT` state.
       #
-      # Uploaded images must either be a `jpg` or `png` file, and each must be less than
-      # 15 MiB. Once both required uploads have been successfully completed, your
+      # Supported file types include `jpg`, `png`, and `pdf`. Each file must be less
+      # than 15 MiB. Once both required uploads have been successfully completed, your
       # document will be run through KYC verification.
       #
       # If you have registered a webhook, you will receive evaluation updates for any

data/lib/lithic/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Lithic
-  VERSION = "0.8.0"
+  VERSION = "0.10.0"
 end

data/lib/lithic.rb

@@ -55,6 +55,7 @@ require_relative "lithic/internal/transport/pooled_net_requester"
 require_relative "lithic/client"
 require_relative "lithic/internal/cursor_page"
 require_relative "lithic/internal/single_page"
+require_relative "lithic/models/merchant"
 require_relative "lithic/models/transaction"
 require_relative "lithic/models/auth_rules/v2/backtest_results"
 require_relative "lithic/models/book_transfer_response"
@@ -348,7 +349,6 @@ require_relative "lithic/models/management_operation_list_params"
 require_relative "lithic/models/management_operation_retrieve_params"
 require_relative "lithic/models/management_operation_reverse_params"
 require_relative "lithic/models/management_operation_updated_webhook_event"
-require_relative "lithic/models/merchant"
 require_relative "lithic/models/message_attempt"
 require_relative "lithic/models/network_program"
 require_relative "lithic/models/network_program_list_params"

data/rbi/lithic/models/account_holder_create_params.rbi

@@ -162,7 +162,8 @@ module Lithic
           attr_writer :naics_code
 
           # Short description of the company's line of business (i.e., what does the company
-          # do?).
+          # do?). Values longer than 255 characters will be truncated before KYB
+          # verification
           sig { returns(T.nilable(String)) }
           attr_reader :nature_of_business
 
@@ -248,7 +249,8 @@ module Lithic
             # business.
             naics_code: nil,
             # Short description of the company's line of business (i.e., what does the company
-            # do?).
+            # do?). Values longer than 255 characters will be truncated before KYB
+            # verification
             nature_of_business: nil,
             # An RFC 3339 timestamp indicating when the account holder accepted the applicable
             # legal agreements (e.g., cardholder terms) as agreed upon during API customer's
@@ -395,37 +397,46 @@ module Lithic
                 )
               end
 
+            # Individual's first name, as it appears on government-issued identity documents.
+            sig { returns(String) }
+            attr_accessor :first_name
+
+            # Individual's last name, as it appears on government-issued identity documents.
+            sig { returns(String) }
+            attr_accessor :last_name
+
             # Individual's current address - PO boxes, UPS drops, and FedEx drops are not
             # acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
-            sig { returns(Lithic::Address) }
+            sig { returns(T.nilable(Lithic::Address)) }
             attr_reader :address
 
             sig { params(address: Lithic::Address::OrHash).void }
             attr_writer :address
 
             # Individual's date of birth, as an RFC 3339 date.
-            sig { returns(String) }
-            attr_accessor :dob
+            sig { returns(T.nilable(String)) }
+            attr_reader :dob
+
+            sig { params(dob: String).void }
+            attr_writer :dob
 
             # Individual's email address. If utilizing Lithic for chargeback processing, this
             # customer email address may be used to communicate dispute status and resolution.
-            sig { returns(String) }
-            attr_accessor :email
+            sig { returns(T.nilable(String)) }
+            attr_reader :email
 
-            # Individual's first name, as it appears on government-issued identity documents.
-            sig { returns(String) }
-            attr_accessor :first_name
+            sig { params(email: String).void }
+            attr_writer :email
 
             # Government-issued identification number (required for identity verification and
             # compliance with banking regulations). Social Security Numbers (SSN) and
             # Individual Taxpayer Identification Numbers (ITIN) are currently supported,
             # entered as full nine-digits, with or without hyphens
-            sig { returns(String) }
-            attr_accessor :government_id
+            sig { returns(T.nilable(String)) }
+            attr_reader :government_id
 
-            # Individual's last name, as it appears on government-issued identity documents.
-            sig { returns(String) }
-            attr_accessor :last_name
+            sig { params(government_id: String).void }
+            attr_writer :government_id
 
             # Individual's phone number, entered in E.164 format.
             sig { returns(T.nilable(String)) }
@@ -434,36 +445,37 @@ module Lithic
             sig { params(phone_number: String).void }
             attr_writer :phone_number
 
-            # Individuals associated with a KYB application. Phone number is optional.
+            # Individuals associated with a KYB_DELEGATED application. Only first and last
+            # name are required.
             sig do
               params(
+                first_name: String,
+                last_name: String,
                 address: Lithic::Address::OrHash,
                 dob: String,
                 email: String,
-                first_name: String,
                 government_id: String,
-                last_name: String,
                 phone_number: String
               ).returns(T.attached_class)
             end
             def self.new(
+              # Individual's first name, as it appears on government-issued identity documents.
+              first_name:,
+              # Individual's last name, as it appears on government-issued identity documents.
+              last_name:,
               # Individual's current address - PO boxes, UPS drops, and FedEx drops are not
               # acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
-              address:,
+              address: nil,
               # Individual's date of birth, as an RFC 3339 date.
-              dob:,
+              dob: nil,
               # Individual's email address. If utilizing Lithic for chargeback processing, this
               # customer email address may be used to communicate dispute status and resolution.
-              email:,
-              # Individual's first name, as it appears on government-issued identity documents.
-              first_name:,
+              email: nil,
               # Government-issued identification number (required for identity verification and
               # compliance with banking regulations). Social Security Numbers (SSN) and
               # Individual Taxpayer Identification Numbers (ITIN) are currently supported,
               # entered as full nine-digits, with or without hyphens
-              government_id:,
-              # Individual's last name, as it appears on government-issued identity documents.
-              last_name:,
+              government_id: nil,
               # Individual's phone number, entered in E.164 format.
               phone_number: nil
             )
@@ -472,12 +484,12 @@ module Lithic
             sig do
               override.returns(
                 {
+                  first_name: String,
+                  last_name: String,
                   address: Lithic::Address,
                   dob: String,
                   email: String,
-                  first_name: String,
                   government_id: String,
-                  last_name: String,
                   phone_number: String
                 }
               )
@@ -495,37 +507,46 @@ module Lithic
                 )
               end
 
+            # Individual's first name, as it appears on government-issued identity documents.
+            sig { returns(String) }
+            attr_accessor :first_name
+
+            # Individual's last name, as it appears on government-issued identity documents.
+            sig { returns(String) }
+            attr_accessor :last_name
+
             # Individual's current address - PO boxes, UPS drops, and FedEx drops are not
             # acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
-            sig { returns(Lithic::Address) }
+            sig { returns(T.nilable(Lithic::Address)) }
             attr_reader :address
 
             sig { params(address: Lithic::Address::OrHash).void }
             attr_writer :address
 
             # Individual's date of birth, as an RFC 3339 date.
-            sig { returns(String) }
-            attr_accessor :dob
+            sig { returns(T.nilable(String)) }
+            attr_reader :dob
+
+            sig { params(dob: String).void }
+            attr_writer :dob
 
             # Individual's email address. If utilizing Lithic for chargeback processing, this
             # customer email address may be used to communicate dispute status and resolution.
-            sig { returns(String) }
-            attr_accessor :email
+            sig { returns(T.nilable(String)) }
+            attr_reader :email
 
-            # Individual's first name, as it appears on government-issued identity documents.
-            sig { returns(String) }
-            attr_accessor :first_name
+            sig { params(email: String).void }
+            attr_writer :email
 
             # Government-issued identification number (required for identity verification and
             # compliance with banking regulations). Social Security Numbers (SSN) and
             # Individual Taxpayer Identification Numbers (ITIN) are currently supported,
             # entered as full nine-digits, with or without hyphens
-            sig { returns(String) }
-            attr_accessor :government_id
+            sig { returns(T.nilable(String)) }
+            attr_reader :government_id
 
-            # Individual's last name, as it appears on government-issued identity documents.
-            sig { returns(String) }
-            attr_accessor :last_name
+            sig { params(government_id: String).void }
+            attr_writer :government_id
 
             # Individual's phone number, entered in E.164 format.
             sig { returns(T.nilable(String)) }
@@ -544,33 +565,33 @@ module Lithic
             # (Section II) for more background.
             sig do
               params(
+                first_name: String,
+                last_name: String,
                 address: Lithic::Address::OrHash,
                 dob: String,
                 email: String,
-                first_name: String,
                 government_id: String,
-                last_name: String,
                 phone_number: String
               ).returns(T.attached_class)
             end
             def self.new(
+              # Individual's first name, as it appears on government-issued identity documents.
+              first_name:,
+              # Individual's last name, as it appears on government-issued identity documents.
+              last_name:,
               # Individual's current address - PO boxes, UPS drops, and FedEx drops are not
               # acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
-              address:,
+              address: nil,
               # Individual's date of birth, as an RFC 3339 date.
-              dob:,
+              dob: nil,
               # Individual's email address. If utilizing Lithic for chargeback processing, this
               # customer email address may be used to communicate dispute status and resolution.
-              email:,
-              # Individual's first name, as it appears on government-issued identity documents.
-              first_name:,
+              email: nil,
               # Government-issued identification number (required for identity verification and
               # compliance with banking regulations). Social Security Numbers (SSN) and
               # Individual Taxpayer Identification Numbers (ITIN) are currently supported,
               # entered as full nine-digits, with or without hyphens
-              government_id:,
-              # Individual's last name, as it appears on government-issued identity documents.
-              last_name:,
+              government_id: nil,
               # Individual's phone number, entered in E.164 format.
               phone_number: nil
             )
@@ -579,12 +600,12 @@ module Lithic
             sig do
               override.returns(
                 {
+                  first_name: String,
+                  last_name: String,
                   address: Lithic::Address,
                   dob: String,
                   email: String,
-                  first_name: String,
                   government_id: String,
-                  last_name: String,
                   phone_number: String
                 }
               )

data/rbi/lithic/models/account_holder_update_params.rbi

@@ -173,7 +173,8 @@ module Lithic
           attr_writer :naics_code
 
           # Short description of the company's line of business (i.e., what does the company
-          # do?).
+          # do?). Values longer than 255 characters will be truncated before KYB
+          # verification
           sig { returns(T.nilable(String)) }
           attr_reader :nature_of_business
 
@@ -231,7 +232,8 @@ module Lithic
             # business.
             naics_code: nil,
             # Short description of the company's line of business (i.e., what does the company
-            # do?).
+            # do?). Values longer than 255 characters will be truncated before KYB
+            # verification
             nature_of_business: nil,
             # Company website URL.
             website_url: nil

data/rbi/lithic/models/account_holder_updated_webhook_event.rbi

@@ -79,7 +79,8 @@ module Lithic
         attr_writer :naics_code
 
         # Short description of the company's line of business (i.e., what does the company
-        # do?).
+        # do?). Values longer than 255 characters will be truncated before KYB
+        # verification
         sig { returns(T.nilable(String)) }
         attr_reader :nature_of_business
 
@@ -121,7 +122,8 @@ module Lithic
           # business. Only present if naics_code was included in the update request.
           naics_code: nil,
           # Short description of the company's line of business (i.e., what does the company
-          # do?).
+          # do?). Values longer than 255 characters will be truncated before KYB
+          # verification
           nature_of_business: nil,
           # Company website URL.
           website_url: nil

data/rbi/lithic/models/auth_rules/conditional_authorization_action_parameters.rbi

@@ -159,6 +159,17 @@ module Lithic
           # - `ADDRESS_MATCH`: Lithic's evaluation result comparing transaction's address
           #   data with the cardholder KYC data if it exists. Valid values are `MATCH`,
           #   `MATCH_ADDRESS_ONLY`, `MATCH_ZIP_ONLY`,`MISMATCH`,`NOT_PRESENT`.
+          # - `SERVICE_LOCATION_STATE`: The state/province code (ISO 3166-2) where the
+          #   cardholder received the service, e.g. "NY". When a service location is present
+          #   in the network data, the service location state is used. Otherwise, falls back
+          #   to the card acceptor state.
+          # - `SERVICE_LOCATION_POSTAL_CODE`: The postal code where the cardholder received
+          #   the service, e.g. "10001". When a service location is present in the network
+          #   data, the service location postal code is used. Otherwise, falls back to the
+          #   card acceptor postal code.
+          # - `CARD_AGE`: The age of the card in seconds at the time of the authorization.
+          # - `ACCOUNT_AGE`: The age of the account holder's account in seconds at the time
+          #   of the authorization.
           sig do
             returns(
               Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Attribute::OrSymbol
@@ -237,6 +248,17 @@ module Lithic
             # - `ADDRESS_MATCH`: Lithic's evaluation result comparing transaction's address
             #   data with the cardholder KYC data if it exists. Valid values are `MATCH`,
             #   `MATCH_ADDRESS_ONLY`, `MATCH_ZIP_ONLY`,`MISMATCH`,`NOT_PRESENT`.
+            # - `SERVICE_LOCATION_STATE`: The state/province code (ISO 3166-2) where the
+            #   cardholder received the service, e.g. "NY". When a service location is present
+            #   in the network data, the service location state is used. Otherwise, falls back
+            #   to the card acceptor state.
+            # - `SERVICE_LOCATION_POSTAL_CODE`: The postal code where the cardholder received
+            #   the service, e.g. "10001". When a service location is present in the network
+            #   data, the service location postal code is used. Otherwise, falls back to the
+            #   card acceptor postal code.
+            # - `CARD_AGE`: The age of the card in seconds at the time of the authorization.
+            # - `ACCOUNT_AGE`: The age of the account holder's account in seconds at the time
+            #   of the authorization.
             attribute:,
             # The operation to apply to the attribute
             operation:,
@@ -312,6 +334,17 @@ module Lithic
           # - `ADDRESS_MATCH`: Lithic's evaluation result comparing transaction's address
           #   data with the cardholder KYC data if it exists. Valid values are `MATCH`,
           #   `MATCH_ADDRESS_ONLY`, `MATCH_ZIP_ONLY`,`MISMATCH`,`NOT_PRESENT`.
+          # - `SERVICE_LOCATION_STATE`: The state/province code (ISO 3166-2) where the
+          #   cardholder received the service, e.g. "NY". When a service location is present
+          #   in the network data, the service location state is used. Otherwise, falls back
+          #   to the card acceptor state.
+          # - `SERVICE_LOCATION_POSTAL_CODE`: The postal code where the cardholder received
+          #   the service, e.g. "10001". When a service location is present in the network
+          #   data, the service location postal code is used. Otherwise, falls back to the
+          #   card acceptor postal code.
+          # - `CARD_AGE`: The age of the card in seconds at the time of the authorization.
+          # - `ACCOUNT_AGE`: The age of the account holder's account in seconds at the time
+          #   of the authorization.
           module Attribute
             extend Lithic::Internal::Type::Enum
 
@@ -419,6 +452,26 @@ module Lithic
                 :ADDRESS_MATCH,
                 Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Attribute::TaggedSymbol
               )
+            SERVICE_LOCATION_STATE =
+              T.let(
+                :SERVICE_LOCATION_STATE,
+                Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Attribute::TaggedSymbol
+              )
+            SERVICE_LOCATION_POSTAL_CODE =
+              T.let(
+                :SERVICE_LOCATION_POSTAL_CODE,
+                Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Attribute::TaggedSymbol
+              )
+            CARD_AGE =
+              T.let(
+                :CARD_AGE,
+                Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Attribute::TaggedSymbol
+              )
+            ACCOUNT_AGE =
+              T.let(
+                :ACCOUNT_AGE,
+                Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Attribute::TaggedSymbol
+              )
 
             sig do
               override.returns(

data/rbi/lithic/models/auth_rules/rule_feature.rbi

@@ -18,7 +18,7 @@ module Lithic
       # - `CARD`: The card associated with the event. Available for AUTHORIZATION and
       #   THREE_DS_AUTHENTICATION event stream rules.
       # - `ACCOUNT_HOLDER`: The account holder associated with the card. Available for
-      #   THREE_DS_AUTHENTICATION event stream rules.
+      #   AUTHORIZATION and THREE_DS_AUTHENTICATION event stream rules.
       # - `IP_METADATA`: IP address metadata for the request. Available for
       #   THREE_DS_AUTHENTICATION event stream rules.
       # - `SPEND_VELOCITY`: Spend velocity data for the card or account. Requires