feat(api): new Funding Events and Card Web Provision API's

- Card Web Provisioning API allows your cardholders to directly add payment cards to the device's digital wallet from a browser on the web. Currently only supported for Apple Pay.
- new Funding Events API and Webhooks

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
-configured_endpoints: 157
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/lithic%2Flithic-9580d7ed7ee603cba3dd0db9bb1ee48094dfe2a90c1ca13a7f10ab8deaa73e2c.yml
-openapi_spec_hash: 6f707e3df699aec761f20db720fb3a32
-config_hash: dc221a354631e360e545ebb7435ecd35
+configured_endpoints: 161
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/lithic%2Flithic-025f40c854a9485cf316c9058f9cc5fa37f069add30e409d49ab93f2e166f4fb.yml
+openapi_spec_hash: a9391f3a54b8db5d5df40169de8c645c
+config_hash: fa3481d1d8505e4157f6cebe93211bd0

lib/lithic.rb

@@ -140,6 +140,8 @@
 require_relative "lithic/models/card_search_by_pan_params"
 require_relative "lithic/models/card_spend_limits"
 require_relative "lithic/models/card_update_params"
+require_relative "lithic/models/card_web_provision_params"
+require_relative "lithic/models/card_web_provision_response"
 require_relative "lithic/models/carrier"
 require_relative "lithic/models/client_api_status_params"
 require_relative "lithic/models/credit_products/extended_credit"
@@ -227,6 +229,12 @@
 require_relative "lithic/models/financial_account_update_params"
 require_relative "lithic/models/financial_account_update_status_params"
 require_relative "lithic/models/financial_transaction"
+require_relative "lithic/models/funding_event_list_params"
+require_relative "lithic/models/funding_event_list_response"
+require_relative "lithic/models/funding_event_retrieve_details_params"
+require_relative "lithic/models/funding_event_retrieve_details_response"
+require_relative "lithic/models/funding_event_retrieve_params"
+require_relative "lithic/models/funding_event_retrieve_response"
 require_relative "lithic/models/instance_financial_account_type"
 require_relative "lithic/models/kyb"
 require_relative "lithic/models/kyb_business_entity"
@@ -355,6 +363,7 @@
 require_relative "lithic/resources/financial_accounts/loan_tapes"
 require_relative "lithic/resources/financial_accounts/statements"
 require_relative "lithic/resources/financial_accounts/statements/line_items"
+require_relative "lithic/resources/funding_events"
 require_relative "lithic/resources/management_operations"
 require_relative "lithic/resources/payments"
 require_relative "lithic/resources/reports"

lib/lithic/client.rb

@@ -98,6 +98,9 @@ class Client < Lithic::Internal::Transport::BaseClient
     # @return [Lithic::Resources::ManagementOperations]
     attr_reader :management_operations
 
+    # @return [Lithic::Resources::FundingEvents]
+    attr_reader :funding_events
+
     # Status of api
     #
     # @overload api_status(request_options: {})
@@ -197,6 +200,7 @@ def initialize(
       @credit_products = Lithic::Resources::CreditProducts.new(client: self)
       @external_payments = Lithic::Resources::ExternalPayments.new(client: self)
       @management_operations = Lithic::Resources::ManagementOperations.new(client: self)
+      @funding_events = Lithic::Resources::FundingEvents.new(client: self)
     end
   end
 end

lib/lithic/models.rb

@@ -129,6 +129,8 @@ module Lithic
 
   CardUpdateParams = Lithic::Models::CardUpdateParams
 
+  CardWebProvisionParams = Lithic::Models::CardWebProvisionParams
+
   Carrier = Lithic::Models::Carrier
 
   ClientAPIStatusParams = Lithic::Models::ClientAPIStatusParams
@@ -227,6 +229,12 @@ module Lithic
 
   FinancialTransaction = Lithic::Models::FinancialTransaction
 
+  FundingEventListParams = Lithic::Models::FundingEventListParams
+
+  FundingEventRetrieveDetailsParams = Lithic::Models::FundingEventRetrieveDetailsParams
+
+  FundingEventRetrieveParams = Lithic::Models::FundingEventRetrieveParams
+
   InstanceFinancialAccountType = Lithic::Models::InstanceFinancialAccountType
 
   KYB = Lithic::Models::KYB

lib/lithic/models/card_web_provision_params.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    # @see Lithic::Resources::Cards#web_provision
+    class CardWebProvisionParams < Lithic::Internal::Type::BaseModel
+      extend Lithic::Internal::Type::RequestParameters::Converter
+      include Lithic::Internal::Type::RequestParameters
+
+      # @!attribute digital_wallet
+      #   Name of digital wallet provider.
+      #
+      #   @return [Symbol, Lithic::CardWebProvisionParams::DigitalWallet, nil]
+      optional :digital_wallet, enum: -> { Lithic::CardWebProvisionParams::DigitalWallet }
+
+      # @!method initialize(digital_wallet: nil, request_options: {})
+      #   @param digital_wallet [Symbol, Lithic::CardWebProvisionParams::DigitalWallet] Name of digital wallet provider.
+      #
+      #   @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
+
+      # Name of digital wallet provider.
+      module DigitalWallet
+        extend Lithic::Internal::Type::Enum
+
+        APPLE_PAY = :APPLE_PAY
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

lib/lithic/models/card_web_provision_response.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    # @see Lithic::Resources::Cards#web_provision
+    class CardWebProvisionResponse < Lithic::Internal::Type::BaseModel
+      # @!attribute jws
+      #   JWS object required for handoff to Apple's script.
+      #
+      #   @return [Lithic::Models::CardWebProvisionResponse::Jws, nil]
+      optional :jws, -> { Lithic::Models::CardWebProvisionResponse::Jws }
+
+      # @!attribute state
+      #   A unique identifier for the JWS object.
+      #
+      #   @return [String, nil]
+      optional :state, String
+
+      # @!method initialize(jws: nil, state: nil)
+      #   @param jws [Lithic::Models::CardWebProvisionResponse::Jws] JWS object required for handoff to Apple's script.
+      #
+      #   @param state [String] A unique identifier for the JWS object.
+
+      # @see Lithic::Models::CardWebProvisionResponse#jws
+      class Jws < Lithic::Internal::Type::BaseModel
+        # @!attribute header
+        #   JWS unprotected headers containing header parameters that aren't
+        #   integrity-protected by the JWS signature.
+        #
+        #   @return [Lithic::Models::CardWebProvisionResponse::Jws::Header, nil]
+        optional :header, -> { Lithic::Models::CardWebProvisionResponse::Jws::Header }
+
+        # @!attribute payload
+        #   Base64url encoded JSON object containing the provisioning payload.
+        #
+        #   @return [String, nil]
+        optional :payload, String
+
+        # @!attribute protected
+        #   Base64url encoded JWS protected headers containing the header parameters that
+        #   are integrity-protected by the JWS signature.
+        #
+        #   @return [String, nil]
+        optional :protected, String
+
+        # @!attribute signature
+        #   Base64url encoded signature of the JWS object.
+        #
+        #   @return [String, nil]
+        optional :signature, String
+
+        # @!method initialize(header: nil, payload: nil, protected: nil, signature: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Lithic::Models::CardWebProvisionResponse::Jws} for more details.
+        #
+        #   JWS object required for handoff to Apple's script.
+        #
+        #   @param header [Lithic::Models::CardWebProvisionResponse::Jws::Header] JWS unprotected headers containing header parameters that aren't integrity-prote
+        #
+        #   @param payload [String] Base64url encoded JSON object containing the provisioning payload.
+        #
+        #   @param protected [String] Base64url encoded JWS protected headers containing the header parameters that ar
+        #
+        #   @param signature [String] Base64url encoded signature of the JWS object.
+
+        # @see Lithic::Models::CardWebProvisionResponse::Jws#header
+        class Header < Lithic::Internal::Type::BaseModel
+          # @!attribute kid
+          #   The ID for the JWS Public Key of the key pair used to generate the signature.
+          #
+          #   @return [String, nil]
+          optional :kid, String
+
+          # @!method initialize(kid: nil)
+          #   JWS unprotected headers containing header parameters that aren't
+          #   integrity-protected by the JWS signature.
+          #
+          #   @param kid [String] The ID for the JWS Public Key of the key pair used to generate the signature.
+        end
+      end
+    end
+  end
+end

lib/lithic/models/funding_event_list_params.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    # @see Lithic::Resources::FundingEvents#list
+    class FundingEventListParams < Lithic::Internal::Type::BaseModel
+      extend Lithic::Internal::Type::RequestParameters::Converter
+      include Lithic::Internal::Type::RequestParameters
+
+      # @!attribute ending_before
+      #   A cursor representing an item's token before which a page of results should end.
+      #   Used to retrieve the previous page of results before this item.
+      #
+      #   @return [String, nil]
+      optional :ending_before, String
+
+      # @!attribute page_size
+      #   Page size (for pagination).
+      #
+      #   @return [Integer, nil]
+      optional :page_size, Integer
+
+      # @!attribute starting_after
+      #   A cursor representing an item's token after which a page of results should
+      #   begin. Used to retrieve the next page of results after this item.
+      #
+      #   @return [String, nil]
+      optional :starting_after, String
+
+      # @!method initialize(ending_before: nil, page_size: nil, starting_after: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Lithic::Models::FundingEventListParams} for more details.
+      #
+      #   @param ending_before [String] A cursor representing an item's token before which a page of results should end.
+      #
+      #   @param page_size [Integer] Page size (for pagination).
+      #
+      #   @param starting_after [String] A cursor representing an item's token after which a page of results should begin
+      #
+      #   @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

lib/lithic/models/funding_event_list_response.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    # @see Lithic::Resources::FundingEvents#list
+    class FundingEventListResponse < Lithic::Internal::Type::BaseModel
+      # @!attribute token
+      #   Unique token ID
+      #
+      #   @return [String]
+      required :token, String
+
+      # @!attribute collection_resource_type
+      #   Collection resource type
+      #
+      #   @return [Symbol, Lithic::Models::FundingEventListResponse::CollectionResourceType]
+      required :collection_resource_type,
+               enum: -> { Lithic::Models::FundingEventListResponse::CollectionResourceType }
+
+      # @!attribute collection_tokens
+      #   IDs of collections
+      #
+      #   @return [Array<String>]
+      required :collection_tokens, Lithic::Internal::Type::ArrayOf[String]
+
+      # @!attribute created
+      #   Time of the creation
+      #
+      #   @return [Time]
+      required :created, Time
+
+      # @!attribute high_watermark
+      #   Time of the high watermark
+      #
+      #   @return [Time]
+      required :high_watermark, Time
+
+      # @!attribute previous_high_watermark
+      #   Time of the previous high watermark
+      #
+      #   @return [Time]
+      required :previous_high_watermark, Time
+
+      # @!attribute settlement_breakdowns
+      #   List of settlements
+      #
+      #   @return [Array<Lithic::Models::FundingEventListResponse::SettlementBreakdown>]
+      required :settlement_breakdowns,
+               -> { Lithic::Internal::Type::ArrayOf[Lithic::Models::FundingEventListResponse::SettlementBreakdown] }
+
+      # @!attribute updated
+      #   Time of the update
+      #
+      #   @return [Time]
+      required :updated, Time
+
+      # @!method initialize(token:, collection_resource_type:, collection_tokens:, created:, high_watermark:, previous_high_watermark:, settlement_breakdowns:, updated:)
+      #   @param token [String] Unique token ID
+      #
+      #   @param collection_resource_type [Symbol, Lithic::Models::FundingEventListResponse::CollectionResourceType] Collection resource type
+      #
+      #   @param collection_tokens [Array<String>] IDs of collections
+      #
+      #   @param created [Time] Time of the creation
+      #
+      #   @param high_watermark [Time] Time of the high watermark
+      #
+      #   @param previous_high_watermark [Time] Time of the previous high watermark
+      #
+      #   @param settlement_breakdowns [Array<Lithic::Models::FundingEventListResponse::SettlementBreakdown>] List of settlements
+      #
+      #   @param updated [Time] Time of the update
+
+      # Collection resource type
+      #
+      # @see Lithic::Models::FundingEventListResponse#collection_resource_type
+      module CollectionResourceType
+        extend Lithic::Internal::Type::Enum
+
+        BOOK_TRANSFER = :BOOK_TRANSFER
+        PAYMENT = :PAYMENT
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      class SettlementBreakdown < Lithic::Internal::Type::BaseModel
+        # @!attribute amount
+        #
+        #   @return [Integer]
+        required :amount, Integer
+
+        # @!attribute settlement_date
+        #
+        #   @return [Date]
+        required :settlement_date, Date
+
+        # @!method initialize(amount:, settlement_date:)
+        #   @param amount [Integer]
+        #   @param settlement_date [Date]
+      end
+    end
+  end
+end

lib/lithic/models/funding_event_retrieve_details_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    # @see Lithic::Resources::FundingEvents#retrieve_details
+    class FundingEventRetrieveDetailsParams < Lithic::Internal::Type::BaseModel
+      extend Lithic::Internal::Type::RequestParameters::Converter
+      include Lithic::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

lib/lithic/models/funding_event_retrieve_details_response.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    # @see Lithic::Resources::FundingEvents#retrieve_details
+    class FundingEventRetrieveDetailsResponse < Lithic::Internal::Type::BaseModel
+      # @!attribute token
+      #   Unique token ID
+      #
+      #   @return [String]
+      required :token, String
+
+      # @!attribute settlement_details_url
+      #   URL of the settlement details
+      #
+      #   @return [String]
+      required :settlement_details_url, String
+
+      # @!attribute settlement_summary_url
+      #   URL of the settlement summary
+      #
+      #   @return [String]
+      required :settlement_summary_url, String
+
+      # @!method initialize(token:, settlement_details_url:, settlement_summary_url:)
+      #   @param token [String] Unique token ID
+      #
+      #   @param settlement_details_url [String] URL of the settlement details
+      #
+      #   @param settlement_summary_url [String] URL of the settlement summary
+    end
+  end
+end