feat(api): Add service and merchant location fields

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 190
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/lithic%2Flithic-5f3c4878ed085a0e8925abdf14ed250ba25b04d5a128e3edd81f28be5fd79b69.yml
-openapi_spec_hash: f2cc51f780daf0454712a4f73b9c8302
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/lithic%2Flithic-7fb459122adaf544433c3d5acd17566e642289b3eccb7ee25d7b7ce418967e32.yml
+openapi_spec_hash: fe69fbb129fa5b7d7b1e71d4f2a908f1
 config_hash: 400b9afe0f7f7b7d96177d05950775f9

lib/lithic.rb

@@ -55,6 +55,7 @@
 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_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"

lib/lithic/models/auth_rules/conditional_authorization_action_parameters.rb

@@ -90,6 +90,14 @@ class Condition < Lithic::Internal::Type::BaseModel
           #   - `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.
@@ -175,6 +183,14 @@ class Condition < Lithic::Internal::Type::BaseModel
           # - `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.
@@ -202,6 +218,8 @@ module Attribute
             WALLET_TYPE = :WALLET_TYPE
             TRANSACTION_INITIATOR = :TRANSACTION_INITIATOR
             ADDRESS_MATCH = :ADDRESS_MATCH
+            SERVICE_LOCATION_STATE = :SERVICE_LOCATION_STATE
+            SERVICE_LOCATION_POSTAL_CODE = :SERVICE_LOCATION_POSTAL_CODE
             CARD_AGE = :CARD_AGE
             ACCOUNT_AGE = :ACCOUNT_AGE
 

lib/lithic/models/card_authorization_approval_request_webhook_event.rb

@@ -90,9 +90,10 @@ class CardAuthorizationApprovalRequestWebhookEvent < Lithic::Internal::Type::Bas
       required :event_type, const: :"card_authorization.approval_request"
 
       # @!attribute merchant
+      #   Merchant information including full location details.
       #
-      #   @return [Lithic::Models::Merchant]
-      required :merchant, -> { Lithic::Merchant }
+      #   @return [Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::Merchant]
+      required :merchant, -> { Lithic::CardAuthorizationApprovalRequestWebhookEvent::Merchant }
 
       # @!attribute merchant_amount
       #   @deprecated
@@ -114,6 +115,16 @@ class CardAuthorizationApprovalRequestWebhookEvent < Lithic::Internal::Type::Bas
       #   @return [String]
       required :merchant_currency, String
 
+      # @!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::CardAuthorizationApprovalRequestWebhookEvent::ServiceLocation, nil]
+      required :service_location,
+               -> { Lithic::CardAuthorizationApprovalRequestWebhookEvent::ServiceLocation },
+               nil?: true
+
       # @!attribute settled_amount
       #   @deprecated
       #
@@ -232,7 +243,7 @@ class CardAuthorizationApprovalRequestWebhookEvent < Lithic::Internal::Type::Bas
       #   @return [Time, nil]
       optional :ttl, Time
 
-      # @!method initialize(token:, acquirer_fee:, amount:, amounts:, authorization_amount:, avs:, card:, cardholder_currency:, cash_amount:, created:, merchant:, merchant_amount:, merchant_currency:, settled_amount:, status:, transaction_initiator:, account_type: nil, cardholder_authentication: nil, cashback: nil, conversion_rate: nil, event_token: nil, fleet_info: nil, latest_challenge: nil, network: nil, network_risk_score: nil, network_specific_data: nil, pos: nil, token_info: nil, ttl: nil, event_type: :"card_authorization.approval_request")
+      # @!method initialize(token:, acquirer_fee:, amount:, amounts:, authorization_amount:, avs:, card:, cardholder_currency:, cash_amount:, created:, merchant:, merchant_amount:, merchant_currency:, service_location:, settled_amount:, status:, transaction_initiator:, account_type: nil, cardholder_authentication: nil, cashback: nil, conversion_rate: nil, event_token: nil, fleet_info: nil, latest_challenge: nil, network: nil, network_risk_score: nil, network_specific_data: nil, pos: nil, token_info: nil, ttl: nil, event_type: :"card_authorization.approval_request")
       #   Some parameter documentations has been truncated, see
       #   {Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent} for more details.
       #
@@ -256,12 +267,14 @@ class CardAuthorizationApprovalRequestWebhookEvent < Lithic::Internal::Type::Bas
       #
       #   @param created [Time] Date and time when the transaction first occurred in UTC.
       #
-      #   @param merchant [Lithic::Models::Merchant]
+      #   @param merchant [Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::Merchant] Merchant information including full location details.
       #
       #   @param merchant_amount [Integer] Deprecated, use `amounts`. The amount that the merchant will receive, denominate
       #
       #   @param merchant_currency [String] 3-character alphabetic ISO 4217 code for the local currency of the transaction.
       #
+      #   @param service_location [Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::ServiceLocation, nil] Where the cardholder received the service, when different from the card acceptor
+      #
       #   @param settled_amount [Integer] Deprecated, use `amounts`. Amount (in cents) of the transaction that has been se
       #
       #   @param status [Symbol, Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent::Status] The type of authorization request that this request is for. Note that `CREDIT_AU
@@ -605,6 +618,84 @@ module Type
         end
       end
 
+      # @see Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent#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
+
+      # @see Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent#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
+
       # The type of authorization request that this request is for. Note that
       # `CREDIT_AUTHORIZATION` and `FINANCIAL_CREDIT_AUTHORIZATION` is only available to
       # users with credit decisioning via ASA enabled.

lib/lithic/models/transaction.rb

@@ -93,9 +93,10 @@ class Transaction < Lithic::Internal::Type::BaseModel
       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 @@ class Transaction < Lithic::Internal::Type::BaseModel
       #   @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 @@ class Transaction < Lithic::Internal::Type::BaseModel
       #   @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 @@ class Transaction < Lithic::Internal::Type::BaseModel
       #
       #   @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 @@ class Transaction < Lithic::Internal::Type::BaseModel
       #
       #   @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 @@ class Avs < Lithic::Internal::Type::BaseModel
         #   @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 Result
         #   @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