lithic 0.1.0.pre.alpha.55 → 0.1.0

data/rbi/lithic/models/card_web_provision_response.rbi

@@ -2,168 +2,248 @@
 
 module Lithic
   module Models
-    class CardWebProvisionResponse < Lithic::Internal::Type::BaseModel
-      OrHash =
+    module CardWebProvisionResponse
+      extend Lithic::Internal::Type::Union
+
+      Variants =
         T.type_alias do
           T.any(
-            Lithic::Models::CardWebProvisionResponse,
-            Lithic::Internal::AnyHash
+            Lithic::Models::CardWebProvisionResponse::AppleWebPushProvisioningResponse,
+            Lithic::Models::CardWebProvisionResponse::GoogleWebPushProvisioningResponse
           )
         end
 
-      # JWS object required for handoff to Apple's script.
-      sig { returns(T.nilable(Lithic::Models::CardWebProvisionResponse::Jws)) }
-      attr_reader :jws
-
-      sig do
-        params(jws: Lithic::Models::CardWebProvisionResponse::Jws::OrHash).void
-      end
-      attr_writer :jws
-
-      # A unique identifier for the JWS object.
-      sig { returns(T.nilable(String)) }
-      attr_reader :state
-
-      sig { params(state: String).void }
-      attr_writer :state
-
-      sig do
-        params(
-          jws: Lithic::Models::CardWebProvisionResponse::Jws::OrHash,
-          state: String
-        ).returns(T.attached_class)
-      end
-      def self.new(
-        # JWS object required for handoff to Apple's script.
-        jws: nil,
-        # A unique identifier for the JWS object.
-        state: nil
-      )
-      end
-
-      sig do
-        override.returns(
-          { jws: Lithic::Models::CardWebProvisionResponse::Jws, state: String }
-        )
-      end
-      def to_hash
-      end
-
-      class Jws < Lithic::Internal::Type::BaseModel
+      class AppleWebPushProvisioningResponse < Lithic::Internal::Type::BaseModel
         OrHash =
           T.type_alias do
             T.any(
-              Lithic::Models::CardWebProvisionResponse::Jws,
+              Lithic::Models::CardWebProvisionResponse::AppleWebPushProvisioningResponse,
               Lithic::Internal::AnyHash
             )
           end
 
-        # JWS unprotected headers containing header parameters that aren't
-        # integrity-protected by the JWS signature.
+        # JWS object required for handoff to Apple's script.
         sig do
           returns(
-            T.nilable(Lithic::Models::CardWebProvisionResponse::Jws::Header)
+            T.nilable(
+              Lithic::Models::CardWebProvisionResponse::AppleWebPushProvisioningResponse::Jws
+            )
           )
         end
-        attr_reader :header
+        attr_reader :jws
 
         sig do
           params(
-            header:
-              Lithic::Models::CardWebProvisionResponse::Jws::Header::OrHash
+            jws:
+              Lithic::Models::CardWebProvisionResponse::AppleWebPushProvisioningResponse::Jws::OrHash
           ).void
         end
-        attr_writer :header
-
-        # Base64url encoded JSON object containing the provisioning payload.
-        sig { returns(T.nilable(String)) }
-        attr_reader :payload
-
-        sig { params(payload: String).void }
-        attr_writer :payload
-
-        # Base64url encoded JWS protected headers containing the header parameters that
-        # are integrity-protected by the JWS signature.
-        sig { returns(T.nilable(String)) }
-        attr_reader :protected
+        attr_writer :jws
 
-        sig { params(protected: String).void }
-        attr_writer :protected
-
-        # Base64url encoded signature of the JWS object.
+        # A unique identifier for the JWS object.
         sig { returns(T.nilable(String)) }
-        attr_reader :signature
+        attr_reader :state
 
-        sig { params(signature: String).void }
-        attr_writer :signature
+        sig { params(state: String).void }
+        attr_writer :state
 
-        # JWS object required for handoff to Apple's script.
         sig do
           params(
-            header:
-              Lithic::Models::CardWebProvisionResponse::Jws::Header::OrHash,
-            payload: String,
-            protected: String,
-            signature: String
+            jws:
+              Lithic::Models::CardWebProvisionResponse::AppleWebPushProvisioningResponse::Jws::OrHash,
+            state: String
           ).returns(T.attached_class)
         end
         def self.new(
-          # JWS unprotected headers containing header parameters that aren't
-          # integrity-protected by the JWS signature.
-          header: nil,
-          # Base64url encoded JSON object containing the provisioning payload.
-          payload: nil,
-          # Base64url encoded JWS protected headers containing the header parameters that
-          # are integrity-protected by the JWS signature.
-          protected: nil,
-          # Base64url encoded signature of the JWS object.
-          signature: nil
+          # JWS object required for handoff to Apple's script.
+          jws: nil,
+          # A unique identifier for the JWS object.
+          state: nil
         )
         end
 
         sig do
           override.returns(
             {
-              header: Lithic::Models::CardWebProvisionResponse::Jws::Header,
-              payload: String,
-              protected: String,
-              signature: String
+              jws:
+                Lithic::Models::CardWebProvisionResponse::AppleWebPushProvisioningResponse::Jws,
+              state: String
             }
           )
         end
         def to_hash
         end
 
-        class Header < Lithic::Internal::Type::BaseModel
+        class Jws < Lithic::Internal::Type::BaseModel
           OrHash =
             T.type_alias do
               T.any(
-                Lithic::Models::CardWebProvisionResponse::Jws::Header,
+                Lithic::Models::CardWebProvisionResponse::AppleWebPushProvisioningResponse::Jws,
                 Lithic::Internal::AnyHash
               )
             end
 
-          # The ID for the JWS Public Key of the key pair used to generate the signature.
+          # JWS unprotected headers containing header parameters that aren't
+          # integrity-protected by the JWS signature.
+          sig do
+            returns(
+              T.nilable(
+                Lithic::Models::CardWebProvisionResponse::AppleWebPushProvisioningResponse::Jws::Header
+              )
+            )
+          end
+          attr_reader :header
+
+          sig do
+            params(
+              header:
+                Lithic::Models::CardWebProvisionResponse::AppleWebPushProvisioningResponse::Jws::Header::OrHash
+            ).void
+          end
+          attr_writer :header
+
+          # Base64url encoded JSON object containing the provisioning payload.
           sig { returns(T.nilable(String)) }
-          attr_reader :kid
+          attr_reader :payload
 
-          sig { params(kid: String).void }
-          attr_writer :kid
+          sig { params(payload: String).void }
+          attr_writer :payload
 
-          # JWS unprotected headers containing header parameters that aren't
-          # integrity-protected by the JWS signature.
-          sig { params(kid: String).returns(T.attached_class) }
+          # Base64url encoded JWS protected headers containing the header parameters that
+          # are integrity-protected by the JWS signature.
+          sig { returns(T.nilable(String)) }
+          attr_reader :protected
+
+          sig { params(protected: String).void }
+          attr_writer :protected
+
+          # Base64url encoded signature of the JWS object.
+          sig { returns(T.nilable(String)) }
+          attr_reader :signature
+
+          sig { params(signature: String).void }
+          attr_writer :signature
+
+          # JWS object required for handoff to Apple's script.
+          sig do
+            params(
+              header:
+                Lithic::Models::CardWebProvisionResponse::AppleWebPushProvisioningResponse::Jws::Header::OrHash,
+              payload: String,
+              protected: String,
+              signature: String
+            ).returns(T.attached_class)
+          end
           def self.new(
-            # The ID for the JWS Public Key of the key pair used to generate the signature.
-            kid: nil
+            # JWS unprotected headers containing header parameters that aren't
+            # integrity-protected by the JWS signature.
+            header: nil,
+            # Base64url encoded JSON object containing the provisioning payload.
+            payload: nil,
+            # Base64url encoded JWS protected headers containing the header parameters that
+            # are integrity-protected by the JWS signature.
+            protected: nil,
+            # Base64url encoded signature of the JWS object.
+            signature: nil
           )
           end
 
-          sig { override.returns({ kid: String }) }
+          sig do
+            override.returns(
+              {
+                header:
+                  Lithic::Models::CardWebProvisionResponse::AppleWebPushProvisioningResponse::Jws::Header,
+                payload: String,
+                protected: String,
+                signature: String
+              }
+            )
+          end
           def to_hash
           end
+
+          class Header < Lithic::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Lithic::Models::CardWebProvisionResponse::AppleWebPushProvisioningResponse::Jws::Header,
+                  Lithic::Internal::AnyHash
+                )
+              end
+
+            # The ID for the JWS Public Key of the key pair used to generate the signature.
+            sig { returns(T.nilable(String)) }
+            attr_reader :kid
+
+            sig { params(kid: String).void }
+            attr_writer :kid
+
+            # JWS unprotected headers containing header parameters that aren't
+            # integrity-protected by the JWS signature.
+            sig { params(kid: String).returns(T.attached_class) }
+            def self.new(
+              # The ID for the JWS Public Key of the key pair used to generate the signature.
+              kid: nil
+            )
+            end
+
+            sig { override.returns({ kid: String }) }
+            def to_hash
+            end
+          end
         end
       end
+
+      class GoogleWebPushProvisioningResponse < Lithic::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Lithic::Models::CardWebProvisionResponse::GoogleWebPushProvisioningResponse,
+              Lithic::Internal::AnyHash
+            )
+          end
+
+        # A base64 encoded and encrypted payload representing card data for the Google Pay
+        # UWPP FPAN flow.
+        sig { returns(T.nilable(String)) }
+        attr_reader :google_opc
+
+        sig { params(google_opc: String).void }
+        attr_writer :google_opc
+
+        # A base64 encoded and encrypted payload representing card data for the Google Pay
+        # UWPP tokenization flow.
+        sig { returns(T.nilable(String)) }
+        attr_reader :tsp_opc
+
+        sig { params(tsp_opc: String).void }
+        attr_writer :tsp_opc
+
+        sig do
+          params(google_opc: String, tsp_opc: String).returns(T.attached_class)
+        end
+        def self.new(
+          # A base64 encoded and encrypted payload representing card data for the Google Pay
+          # UWPP FPAN flow.
+          google_opc: nil,
+          # A base64 encoded and encrypted payload representing card data for the Google Pay
+          # UWPP tokenization flow.
+          tsp_opc: nil
+        )
+        end
+
+        sig { override.returns({ google_opc: String, tsp_opc: String }) }
+        def to_hash
+        end
+      end
+
+      sig do
+        override.returns(
+          T::Array[Lithic::Models::CardWebProvisionResponse::Variants]
+        )
+      end
+      def self.variants
+      end
     end
   end
 end

data/rbi/lithic/models/cardholder_authentication.rbi

@@ -0,0 +1,296 @@
+# typed: strong
+
+module Lithic
+  module Models
+    class CardholderAuthentication < Lithic::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Lithic::CardholderAuthentication, Lithic::Internal::AnyHash)
+        end
+
+      # Indicates the method used to authenticate the cardholder.
+      sig do
+        returns(
+          Lithic::CardholderAuthentication::AuthenticationMethod::TaggedSymbol
+        )
+      end
+      attr_accessor :authentication_method
+
+      # Indicates the outcome of the 3DS authentication process.
+      sig do
+        returns(
+          Lithic::CardholderAuthentication::AuthenticationResult::TaggedSymbol
+        )
+      end
+      attr_accessor :authentication_result
+
+      # Indicates which party made the 3DS authentication decision.
+      sig do
+        returns(Lithic::CardholderAuthentication::DecisionMadeBy::TaggedSymbol)
+      end
+      attr_accessor :decision_made_by
+
+      # Indicates whether chargeback liability shift applies to the transaction.
+      # Possible enum values:
+      #
+      # - `3DS_AUTHENTICATED`: The transaction was fully authenticated through a 3-D
+      #   Secure flow, chargeback liability shift applies.
+      # - `NONE`: Chargeback liability shift has not shifted to the issuer, i.e. the
+      #   merchant is liable.
+      # - `TOKEN_AUTHENTICATED`: The transaction was a tokenized payment with validated
+      #   cryptography, possibly recurring. Chargeback liability shift to the issuer
+      #   applies.
+      sig do
+        returns(Lithic::CardholderAuthentication::LiabilityShift::TaggedSymbol)
+      end
+      attr_accessor :liability_shift
+
+      # Unique identifier you can use to match a given 3DS authentication (available via
+      # the three_ds_authentication.created event webhook) and the transaction. Note
+      # that in cases where liability shift does not occur, this token is matched to the
+      # transaction on a best-effort basis.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :three_ds_authentication_token
+
+      sig do
+        params(
+          authentication_method:
+            Lithic::CardholderAuthentication::AuthenticationMethod::OrSymbol,
+          authentication_result:
+            Lithic::CardholderAuthentication::AuthenticationResult::OrSymbol,
+          decision_made_by:
+            Lithic::CardholderAuthentication::DecisionMadeBy::OrSymbol,
+          liability_shift:
+            Lithic::CardholderAuthentication::LiabilityShift::OrSymbol,
+          three_ds_authentication_token: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Indicates the method used to authenticate the cardholder.
+        authentication_method:,
+        # Indicates the outcome of the 3DS authentication process.
+        authentication_result:,
+        # Indicates which party made the 3DS authentication decision.
+        decision_made_by:,
+        # Indicates whether chargeback liability shift applies to the transaction.
+        # Possible enum values:
+        #
+        # - `3DS_AUTHENTICATED`: The transaction was fully authenticated through a 3-D
+        #   Secure flow, chargeback liability shift applies.
+        # - `NONE`: Chargeback liability shift has not shifted to the issuer, i.e. the
+        #   merchant is liable.
+        # - `TOKEN_AUTHENTICATED`: The transaction was a tokenized payment with validated
+        #   cryptography, possibly recurring. Chargeback liability shift to the issuer
+        #   applies.
+        liability_shift:,
+        # Unique identifier you can use to match a given 3DS authentication (available via
+        # the three_ds_authentication.created event webhook) and the transaction. Note
+        # that in cases where liability shift does not occur, this token is matched to the
+        # transaction on a best-effort basis.
+        three_ds_authentication_token:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            authentication_method:
+              Lithic::CardholderAuthentication::AuthenticationMethod::TaggedSymbol,
+            authentication_result:
+              Lithic::CardholderAuthentication::AuthenticationResult::TaggedSymbol,
+            decision_made_by:
+              Lithic::CardholderAuthentication::DecisionMadeBy::TaggedSymbol,
+            liability_shift:
+              Lithic::CardholderAuthentication::LiabilityShift::TaggedSymbol,
+            three_ds_authentication_token: T.nilable(String)
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # Indicates the method used to authenticate the cardholder.
+      module AuthenticationMethod
+        extend Lithic::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              Lithic::CardholderAuthentication::AuthenticationMethod
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        FRICTIONLESS =
+          T.let(
+            :FRICTIONLESS,
+            Lithic::CardholderAuthentication::AuthenticationMethod::TaggedSymbol
+          )
+        CHALLENGE =
+          T.let(
+            :CHALLENGE,
+            Lithic::CardholderAuthentication::AuthenticationMethod::TaggedSymbol
+          )
+        NONE =
+          T.let(
+            :NONE,
+            Lithic::CardholderAuthentication::AuthenticationMethod::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Lithic::CardholderAuthentication::AuthenticationMethod::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
+      # Indicates the outcome of the 3DS authentication process.
+      module AuthenticationResult
+        extend Lithic::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              Lithic::CardholderAuthentication::AuthenticationResult
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ATTEMPTS =
+          T.let(
+            :ATTEMPTS,
+            Lithic::CardholderAuthentication::AuthenticationResult::TaggedSymbol
+          )
+        DECLINE =
+          T.let(
+            :DECLINE,
+            Lithic::CardholderAuthentication::AuthenticationResult::TaggedSymbol
+          )
+        NONE =
+          T.let(
+            :NONE,
+            Lithic::CardholderAuthentication::AuthenticationResult::TaggedSymbol
+          )
+        SUCCESS =
+          T.let(
+            :SUCCESS,
+            Lithic::CardholderAuthentication::AuthenticationResult::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Lithic::CardholderAuthentication::AuthenticationResult::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
+      # Indicates which party made the 3DS authentication decision.
+      module DecisionMadeBy
+        extend Lithic::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Lithic::CardholderAuthentication::DecisionMadeBy)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        CUSTOMER_RULES =
+          T.let(
+            :CUSTOMER_RULES,
+            Lithic::CardholderAuthentication::DecisionMadeBy::TaggedSymbol
+          )
+        CUSTOMER_ENDPOINT =
+          T.let(
+            :CUSTOMER_ENDPOINT,
+            Lithic::CardholderAuthentication::DecisionMadeBy::TaggedSymbol
+          )
+        LITHIC_DEFAULT =
+          T.let(
+            :LITHIC_DEFAULT,
+            Lithic::CardholderAuthentication::DecisionMadeBy::TaggedSymbol
+          )
+        LITHIC_RULES =
+          T.let(
+            :LITHIC_RULES,
+            Lithic::CardholderAuthentication::DecisionMadeBy::TaggedSymbol
+          )
+        NETWORK =
+          T.let(
+            :NETWORK,
+            Lithic::CardholderAuthentication::DecisionMadeBy::TaggedSymbol
+          )
+        UNKNOWN =
+          T.let(
+            :UNKNOWN,
+            Lithic::CardholderAuthentication::DecisionMadeBy::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Lithic::CardholderAuthentication::DecisionMadeBy::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
+      # Indicates whether chargeback liability shift applies to the transaction.
+      # Possible enum values:
+      #
+      # - `3DS_AUTHENTICATED`: The transaction was fully authenticated through a 3-D
+      #   Secure flow, chargeback liability shift applies.
+      # - `NONE`: Chargeback liability shift has not shifted to the issuer, i.e. the
+      #   merchant is liable.
+      # - `TOKEN_AUTHENTICATED`: The transaction was a tokenized payment with validated
+      #   cryptography, possibly recurring. Chargeback liability shift to the issuer
+      #   applies.
+      module LiabilityShift
+        extend Lithic::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Lithic::CardholderAuthentication::LiabilityShift)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        LIABILITY_SHIFT_3DS_AUTHENTICATED =
+          T.let(
+            :"3DS_AUTHENTICATED",
+            Lithic::CardholderAuthentication::LiabilityShift::TaggedSymbol
+          )
+        TOKEN_AUTHENTICATED =
+          T.let(
+            :TOKEN_AUTHENTICATED,
+            Lithic::CardholderAuthentication::LiabilityShift::TaggedSymbol
+          )
+        NONE =
+          T.let(
+            :NONE,
+            Lithic::CardholderAuthentication::LiabilityShift::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Lithic::CardholderAuthentication::LiabilityShift::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/lithic/models/category_details.rbi

@@ -0,0 +1,43 @@
+# typed: strong
+
+module Lithic
+  module Models
+    class CategoryDetails < Lithic::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Lithic::CategoryDetails, Lithic::Internal::AnyHash)
+        end
+
+      sig { returns(String) }
+      attr_accessor :balance_transfers
+
+      sig { returns(String) }
+      attr_accessor :cash_advances
+
+      sig { returns(String) }
+      attr_accessor :purchases
+
+      sig do
+        params(
+          balance_transfers: String,
+          cash_advances: String,
+          purchases: String
+        ).returns(T.attached_class)
+      end
+      def self.new(balance_transfers:, cash_advances:, purchases:)
+      end
+
+      sig do
+        override.returns(
+          {
+            balance_transfers: String,
+            cash_advances: String,
+            purchases: String
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end