lithic 0.1.0 → 0.2.0

data/lib/lithic/models/auth_rules_backtest_report_created_webhook_event.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    class AuthRulesBacktestReportCreatedWebhookEvent < Lithic::Models::AuthRules::V2::BacktestResults
+      # @!attribute event_type
+      #   The type of event that occurred.
+      #
+      #   @return [Symbol, :"auth_rules.backtest_report.created"]
+      required :event_type, const: :"auth_rules.backtest_report.created"
+
+      # @!method initialize(event_type: :"auth_rules.backtest_report.created")
+      #   @param event_type [Symbol, :"auth_rules.backtest_report.created"] The type of event that occurred.
+    end
+  end
+end

data/lib/lithic/models/balance_updated_webhook_event.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    class BalanceUpdatedWebhookEvent < Lithic::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [Array<Lithic::Models::FinancialAccountBalance>]
+      required :data, -> { Lithic::Internal::Type::ArrayOf[Lithic::FinancialAccountBalance] }
+
+      # @!attribute event_type
+      #   The type of event that occurred.
+      #
+      #   @return [Symbol, :"balance.updated"]
+      required :event_type, const: :"balance.updated"
+
+      # @!method initialize(data:, event_type: :"balance.updated")
+      #   @param data [Array<Lithic::Models::FinancialAccountBalance>]
+      #
+      #   @param event_type [Symbol, :"balance.updated"] The type of event that occurred.
+    end
+  end
+end

data/lib/lithic/models/book_transfer_transaction_created_webhook_event.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    class BookTransferTransactionCreatedWebhookEvent < Lithic::Models::BookTransferResponse
+      # @!attribute event_type
+      #   The type of event that occurred.
+      #
+      #   @return [Symbol, :"book_transfer_transaction.created"]
+      required :event_type, const: :"book_transfer_transaction.created"
+
+      # @!method initialize(event_type: :"book_transfer_transaction.created")
+      #   Book transfer transaction
+      #
+      #   @param event_type [Symbol, :"book_transfer_transaction.created"] The type of event that occurred.
+    end
+  end
+end

data/lib/lithic/models/book_transfer_transaction_updated_webhook_event.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    class BookTransferTransactionUpdatedWebhookEvent < Lithic::Models::BookTransferResponse
+      # @!attribute event_type
+      #   The type of event that occurred.
+      #
+      #   @return [Symbol, :"book_transfer_transaction.updated"]
+      required :event_type, const: :"book_transfer_transaction.updated"
+
+      # @!method initialize(event_type: :"book_transfer_transaction.updated")
+      #   Book transfer transaction
+      #
+      #   @param event_type [Symbol, :"book_transfer_transaction.updated"] The type of event that occurred.
+    end
+  end
+end

data/lib/lithic/models/card_converted_webhook_event.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    class CardConvertedWebhookEvent < Lithic::Internal::Type::BaseModel
+      # @!attribute card_token
+      #   The token of the card that was created.
+      #
+      #   @return [String]
+      required :card_token, String
+
+      # @!attribute event_type
+      #   The type of event that occurred.
+      #
+      #   @return [Symbol, :"card.converted"]
+      required :event_type, const: :"card.converted"
+
+      # @!method initialize(card_token:, event_type: :"card.converted")
+      #   @param card_token [String] The token of the card that was created.
+      #
+      #   @param event_type [Symbol, :"card.converted"] The type of event that occurred.
+    end
+  end
+end

data/lib/lithic/models/card_created_webhook_event.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    class CardCreatedWebhookEvent < Lithic::Internal::Type::BaseModel
+      # @!attribute card_token
+      #   The token of the card that was created.
+      #
+      #   @return [String]
+      required :card_token, String
+
+      # @!attribute event_type
+      #   The type of event that occurred.
+      #
+      #   @return [Symbol, :"card.created"]
+      required :event_type, const: :"card.created"
+
+      # @!attribute replacement_for
+      #   The token of the card that was replaced, if the new card is a replacement card.
+      #
+      #   @return [String, nil]
+      optional :replacement_for, String, nil?: true
+
+      # @!method initialize(card_token:, replacement_for: nil, event_type: :"card.created")
+      #   @param card_token [String] The token of the card that was created.
+      #
+      #   @param replacement_for [String, nil] The token of the card that was replaced, if the new card is a replacement card.
+      #
+      #   @param event_type [Symbol, :"card.created"] The type of event that occurred.
+    end
+  end
+end

data/lib/lithic/models/card_reissued_webhook_event.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    class CardReissuedWebhookEvent < Lithic::Internal::Type::BaseModel
+      # @!attribute event_type
+      #   The type of event that occurred.
+      #
+      #   @return [Symbol, :"card.reissued"]
+      required :event_type, const: :"card.reissued"
+
+      # @!attribute card_token
+      #   The token of the card that was reissued.
+      #
+      #   @return [String, nil]
+      optional :card_token, String
+
+      # @!method initialize(card_token: nil, event_type: :"card.reissued")
+      #   @param card_token [String] The token of the card that was reissued.
+      #
+      #   @param event_type [Symbol, :"card.reissued"] The type of event that occurred.
+    end
+  end
+end

data/lib/lithic/models/card_renewed_webhook_event.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    class CardRenewedWebhookEvent < Lithic::Internal::Type::BaseModel
+      # @!attribute event_type
+      #   The type of event that occurred.
+      #
+      #   @return [Symbol, :"card.renewed"]
+      required :event_type, const: :"card.renewed"
+
+      # @!attribute card_token
+      #   The token of the card that was renewed.
+      #
+      #   @return [String, nil]
+      optional :card_token, String
+
+      # @!attribute exp_month
+      #   The new expiration month of the card.
+      #
+      #   @return [String, nil]
+      optional :exp_month, String
+
+      # @!attribute exp_year
+      #   The new expiration year of the card.
+      #
+      #   @return [String, nil]
+      optional :exp_year, String
+
+      # @!attribute previous_exp_month
+      #   The previous expiration month of the card.
+      #
+      #   @return [String, nil]
+      optional :previous_exp_month, String
+
+      # @!attribute previous_exp_year
+      #   The previous expiration year of the card.
+      #
+      #   @return [String, nil]
+      optional :previous_exp_year, String
+
+      # @!method initialize(card_token: nil, exp_month: nil, exp_year: nil, previous_exp_month: nil, previous_exp_year: nil, event_type: :"card.renewed")
+      #   @param card_token [String] The token of the card that was renewed.
+      #
+      #   @param exp_month [String] The new expiration month of the card.
+      #
+      #   @param exp_year [String] The new expiration year of the card.
+      #
+      #   @param previous_exp_month [String] The previous expiration month of the card.
+      #
+      #   @param previous_exp_year [String] The previous expiration year of the card.
+      #
+      #   @param event_type [Symbol, :"card.renewed"] The type of event that occurred.
+    end
+  end
+end

data/lib/lithic/models/card_shipped_webhook_event.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    class CardShippedWebhookEvent < Lithic::Internal::Type::BaseModel
+      # @!attribute bulk_order_token
+      #   The token of the bulk order associated with this card shipment, if applicable.
+      #
+      #   @return [String, nil]
+      required :bulk_order_token, String, nil?: true
+
+      # @!attribute card_token
+      #   The token of the card that was shipped.
+      #
+      #   @return [String]
+      required :card_token, String
+
+      # @!attribute event_type
+      #   The type of event that occurred.
+      #
+      #   @return [Symbol, :"card.shipped"]
+      required :event_type, const: :"card.shipped"
+
+      # @!attribute shipping_method
+      #   The specific shipping method used to ship the card.
+      #
+      #   @return [Symbol, Lithic::Models::CardShippedWebhookEvent::ShippingMethod]
+      required :shipping_method, enum: -> { Lithic::CardShippedWebhookEvent::ShippingMethod }
+
+      # @!attribute tracking_number
+      #   The tracking number of the shipment.
+      #
+      #   @return [String, nil]
+      required :tracking_number, String, nil?: true
+
+      # @!method initialize(bulk_order_token:, card_token:, shipping_method:, tracking_number:, event_type: :"card.shipped")
+      #   @param bulk_order_token [String, nil] The token of the bulk order associated with this card shipment, if applicable.
+      #
+      #   @param card_token [String] The token of the card that was shipped.
+      #
+      #   @param shipping_method [Symbol, Lithic::Models::CardShippedWebhookEvent::ShippingMethod] The specific shipping method used to ship the card.
+      #
+      #   @param tracking_number [String, nil] The tracking number of the shipment.
+      #
+      #   @param event_type [Symbol, :"card.shipped"] The type of event that occurred.
+
+      # The specific shipping method used to ship the card.
+      #
+      # @see Lithic::Models::CardShippedWebhookEvent#shipping_method
+      module ShippingMethod
+        extend Lithic::Internal::Type::Enum
+
+        EX_US_EXPEDITED_WITH_TRACKING = :"Ex-US expedited with tracking"
+        EX_US_STANDARD_WITH_TRACKING = :"Ex-US standard with tracking"
+        EX_US_STANDARD_WITHOUT_TRACKING = :"Ex-US standard without tracking"
+        FED_EX_2_DAYS = :"FedEx 2 days"
+        FED_EX_EXPRESS = :"FedEx express"
+        FED_EX_OVERNIGHT = :"FedEx overnight"
+        USPS_PRIORITY = :"USPS priority"
+        USPS_WITH_TRACKING = :"USPS with tracking"
+        USPS_WITHOUT_TRACKING_ENVELOPE = :"USPS without tracking envelope"
+        USPS_WITHOUT_TRACKING_ENVELOPE_NON_MACHINE = :"USPS without tracking envelope non-machine"
+        USPS_WITHOUT_TRACKING_FLAT = :"USPS without tracking flat"
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/lithic/models/card_transaction_enhanced_data_created_webhook_event.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    class CardTransactionEnhancedDataCreatedWebhookEvent < Lithic::Models::Transactions::Events::EnhancedData
+      # @!attribute event_type
+      #   The type of event that occurred.
+      #
+      #   @return [Symbol, :"card_transaction.enhanced_data.created"]
+      required :event_type, const: :"card_transaction.enhanced_data.created"
+
+      # @!method initialize(event_type: :"card_transaction.enhanced_data.created")
+      #   @param event_type [Symbol, :"card_transaction.enhanced_data.created"] The type of event that occurred.
+    end
+  end
+end

data/lib/lithic/models/card_transaction_enhanced_data_updated_webhook_event.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    class CardTransactionEnhancedDataUpdatedWebhookEvent < Lithic::Models::Transactions::Events::EnhancedData
+      # @!attribute event_type
+      #   The type of event that occurred.
+      #
+      #   @return [Symbol, :"card_transaction.enhanced_data.updated"]
+      required :event_type, const: :"card_transaction.enhanced_data.updated"
+
+      # @!method initialize(event_type: :"card_transaction.enhanced_data.updated")
+      #   @param event_type [Symbol, :"card_transaction.enhanced_data.updated"] The type of event that occurred.
+    end
+  end
+end

data/lib/lithic/models/card_transaction_updated_webhook_event.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    class CardTransactionUpdatedWebhookEvent < Lithic::Models::Transaction
+      # @!attribute event_type
+      #   The type of event that occurred.
+      #
+      #   @return [Symbol, :"card_transaction.updated"]
+      required :event_type, const: :"card_transaction.updated"
+
+      # @!method initialize(event_type: :"card_transaction.updated")
+      #   @param event_type [Symbol, :"card_transaction.updated"] The type of event that occurred.
+    end
+  end
+end

data/lib/lithic/models/digital_wallet_tokenization_approval_request_webhook_event.rb

@@ -0,0 +1,253 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    class DigitalWalletTokenizationApprovalRequestWebhookEvent < Lithic::Internal::Type::BaseModel
+      # @!attribute account_token
+      #   Unique identifier for the user tokenizing a card
+      #
+      #   @return [String]
+      required :account_token, String
+
+      # @!attribute card_token
+      #   Unique identifier for the card being tokenized
+      #
+      #   @return [String]
+      required :card_token, String
+
+      # @!attribute created
+      #   Indicate when the request was received from Mastercard or Visa
+      #
+      #   @return [Time]
+      required :created, Time
+
+      # @!attribute customer_tokenization_decision
+      #   Contains the metadata for the customer tokenization decision.
+      #
+      #   @return [Lithic::Models::DigitalWalletTokenizationApprovalRequestWebhookEvent::CustomerTokenizationDecision, nil]
+      required :customer_tokenization_decision,
+               -> {
+                 Lithic::DigitalWalletTokenizationApprovalRequestWebhookEvent::CustomerTokenizationDecision
+               },
+               nil?: true
+
+      # @!attribute event_type
+      #   The name of this event
+      #
+      #   @return [Symbol, Lithic::Models::DigitalWalletTokenizationApprovalRequestWebhookEvent::EventType]
+      required :event_type, enum: -> { Lithic::DigitalWalletTokenizationApprovalRequestWebhookEvent::EventType }
+
+      # @!attribute issuer_decision
+      #   Whether Lithic decisioned on the token, and if so, what the decision was.
+      #   APPROVED/VERIFICATION_REQUIRED/DENIED.
+      #
+      #   @return [Symbol, Lithic::Models::DigitalWalletTokenizationApprovalRequestWebhookEvent::IssuerDecision]
+      required :issuer_decision,
+               enum: -> { Lithic::DigitalWalletTokenizationApprovalRequestWebhookEvent::IssuerDecision }
+
+      # @!attribute tokenization_channel
+      #   The channel through which the tokenization was made.
+      #
+      #   @return [Symbol, Lithic::Models::DigitalWalletTokenizationApprovalRequestWebhookEvent::TokenizationChannel]
+      required :tokenization_channel,
+               enum: -> { Lithic::DigitalWalletTokenizationApprovalRequestWebhookEvent::TokenizationChannel }
+
+      # @!attribute tokenization_token
+      #   Unique identifier for the digital wallet token attempt
+      #
+      #   @return [String]
+      required :tokenization_token, String
+
+      # @!attribute wallet_decisioning_info
+      #
+      #   @return [Lithic::Models::WalletDecisioningInfo]
+      required :wallet_decisioning_info, -> { Lithic::WalletDecisioningInfo }
+
+      # @!attribute device
+      #
+      #   @return [Lithic::Models::Device, nil]
+      optional :device, -> { Lithic::Device }
+
+      # @!attribute digital_wallet_token_metadata
+      #   Contains the metadata for the digital wallet being tokenized.
+      #
+      #   @return [Lithic::Models::DigitalWalletTokenMetadata, nil]
+      optional :digital_wallet_token_metadata, -> { Lithic::DigitalWalletTokenMetadata }
+
+      # @!attribute rule_results
+      #   Results from rules that were evaluated for this tokenization
+      #
+      #   @return [Array<Lithic::Models::TokenizationRuleResult>, nil]
+      optional :rule_results, -> { Lithic::Internal::Type::ArrayOf[Lithic::TokenizationRuleResult] }
+
+      # @!attribute tokenization_decline_reasons
+      #   List of reasons why the tokenization was declined
+      #
+      #   @return [Array<Symbol, Lithic::Models::TokenizationDeclineReason>, nil]
+      optional :tokenization_decline_reasons,
+               -> { Lithic::Internal::Type::ArrayOf[enum: Lithic::TokenizationDeclineReason] }
+
+      # @!attribute tokenization_source
+      #   The source of the tokenization.
+      #
+      #   @return [Symbol, Lithic::Models::DigitalWalletTokenizationApprovalRequestWebhookEvent::TokenizationSource, nil]
+      optional :tokenization_source,
+               enum: -> { Lithic::DigitalWalletTokenizationApprovalRequestWebhookEvent::TokenizationSource }
+
+      # @!attribute tokenization_tfa_reasons
+      #   List of reasons why two-factor authentication was required
+      #
+      #   @return [Array<Symbol, Lithic::Models::TokenizationTfaReason>, nil]
+      optional :tokenization_tfa_reasons,
+               -> { Lithic::Internal::Type::ArrayOf[enum: Lithic::TokenizationTfaReason] }
+
+      # @!method initialize(account_token:, card_token:, created:, customer_tokenization_decision:, event_type:, issuer_decision:, tokenization_channel:, tokenization_token:, wallet_decisioning_info:, device: nil, digital_wallet_token_metadata: nil, rule_results: nil, tokenization_decline_reasons: nil, tokenization_source: nil, tokenization_tfa_reasons: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Lithic::Models::DigitalWalletTokenizationApprovalRequestWebhookEvent} for more
+      #   details.
+      #
+      #   @param account_token [String] Unique identifier for the user tokenizing a card
+      #
+      #   @param card_token [String] Unique identifier for the card being tokenized
+      #
+      #   @param created [Time] Indicate when the request was received from Mastercard or Visa
+      #
+      #   @param customer_tokenization_decision [Lithic::Models::DigitalWalletTokenizationApprovalRequestWebhookEvent::CustomerTokenizationDecision, nil] Contains the metadata for the customer tokenization decision.
+      #
+      #   @param event_type [Symbol, Lithic::Models::DigitalWalletTokenizationApprovalRequestWebhookEvent::EventType] The name of this event
+      #
+      #   @param issuer_decision [Symbol, Lithic::Models::DigitalWalletTokenizationApprovalRequestWebhookEvent::IssuerDecision] Whether Lithic decisioned on the token, and if so, what the decision was. APPROV
+      #
+      #   @param tokenization_channel [Symbol, Lithic::Models::DigitalWalletTokenizationApprovalRequestWebhookEvent::TokenizationChannel] The channel through which the tokenization was made.
+      #
+      #   @param tokenization_token [String] Unique identifier for the digital wallet token attempt
+      #
+      #   @param wallet_decisioning_info [Lithic::Models::WalletDecisioningInfo]
+      #
+      #   @param device [Lithic::Models::Device]
+      #
+      #   @param digital_wallet_token_metadata [Lithic::Models::DigitalWalletTokenMetadata] Contains the metadata for the digital wallet being tokenized.
+      #
+      #   @param rule_results [Array<Lithic::Models::TokenizationRuleResult>] Results from rules that were evaluated for this tokenization
+      #
+      #   @param tokenization_decline_reasons [Array<Symbol, Lithic::Models::TokenizationDeclineReason>] List of reasons why the tokenization was declined
+      #
+      #   @param tokenization_source [Symbol, Lithic::Models::DigitalWalletTokenizationApprovalRequestWebhookEvent::TokenizationSource] The source of the tokenization.
+      #
+      #   @param tokenization_tfa_reasons [Array<Symbol, Lithic::Models::TokenizationTfaReason>] List of reasons why two-factor authentication was required
+
+      # @see Lithic::Models::DigitalWalletTokenizationApprovalRequestWebhookEvent#customer_tokenization_decision
+      class CustomerTokenizationDecision < Lithic::Internal::Type::BaseModel
+        # @!attribute outcome
+        #   The outcome of the customer's decision
+        #
+        #   @return [Symbol, Lithic::Models::DigitalWalletTokenizationApprovalRequestWebhookEvent::CustomerTokenizationDecision::Outcome]
+        required :outcome,
+                 enum: -> { Lithic::DigitalWalletTokenizationApprovalRequestWebhookEvent::CustomerTokenizationDecision::Outcome }
+
+        # @!attribute responder_url
+        #   The customer's subscribed URL
+        #
+        #   @return [String]
+        required :responder_url, String
+
+        # @!attribute latency
+        #   Time in ms it took for the customer's URL to respond
+        #
+        #   @return [String, nil]
+        optional :latency, String
+
+        # @!attribute response_code
+        #   The response code that the customer provided
+        #
+        #   @return [String, nil]
+        optional :response_code, String
+
+        # @!method initialize(outcome:, responder_url:, latency: nil, response_code: nil)
+        #   Contains the metadata for the customer tokenization decision.
+        #
+        #   @param outcome [Symbol, Lithic::Models::DigitalWalletTokenizationApprovalRequestWebhookEvent::CustomerTokenizationDecision::Outcome] The outcome of the customer's decision
+        #
+        #   @param responder_url [String] The customer's subscribed URL
+        #
+        #   @param latency [String] Time in ms it took for the customer's URL to respond
+        #
+        #   @param response_code [String] The response code that the customer provided
+
+        # The outcome of the customer's decision
+        #
+        # @see Lithic::Models::DigitalWalletTokenizationApprovalRequestWebhookEvent::CustomerTokenizationDecision#outcome
+        module Outcome
+          extend Lithic::Internal::Type::Enum
+
+          APPROVED = :APPROVED
+          DECLINED = :DECLINED
+          ERROR = :ERROR
+          INVALID_RESPONSE = :INVALID_RESPONSE
+          REQUIRE_ADDITIONAL_AUTHENTICATION = :REQUIRE_ADDITIONAL_AUTHENTICATION
+          TIMEOUT = :TIMEOUT
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
+      # The name of this event
+      #
+      # @see Lithic::Models::DigitalWalletTokenizationApprovalRequestWebhookEvent#event_type
+      module EventType
+        extend Lithic::Internal::Type::Enum
+
+        DIGITAL_WALLET_TOKENIZATION_APPROVAL_REQUEST = :"digital_wallet.tokenization_approval_request"
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # Whether Lithic decisioned on the token, and if so, what the decision was.
+      # APPROVED/VERIFICATION_REQUIRED/DENIED.
+      #
+      # @see Lithic::Models::DigitalWalletTokenizationApprovalRequestWebhookEvent#issuer_decision
+      module IssuerDecision
+        extend Lithic::Internal::Type::Enum
+
+        APPROVED = :APPROVED
+        DENIED = :DENIED
+        VERIFICATION_REQUIRED = :VERIFICATION_REQUIRED
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # The channel through which the tokenization was made.
+      #
+      # @see Lithic::Models::DigitalWalletTokenizationApprovalRequestWebhookEvent#tokenization_channel
+      module TokenizationChannel
+        extend Lithic::Internal::Type::Enum
+
+        DIGITAL_WALLET = :DIGITAL_WALLET
+        MERCHANT = :MERCHANT
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # The source of the tokenization.
+      #
+      # @see Lithic::Models::DigitalWalletTokenizationApprovalRequestWebhookEvent#tokenization_source
+      module TokenizationSource
+        extend Lithic::Internal::Type::Enum
+
+        ACCOUNT_ON_FILE = :ACCOUNT_ON_FILE
+        CONTACTLESS_TAP = :CONTACTLESS_TAP
+        MANUAL_PROVISION = :MANUAL_PROVISION
+        PUSH_PROVISION = :PUSH_PROVISION
+        TOKEN = :TOKEN
+        UNKNOWN = :UNKNOWN
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end