lithic 0.1.0.pre.alpha.1

data/lib/lithic/models/external_payment.rb

@@ -0,0 +1,282 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    class ExternalPayment < Lithic::BaseModel
+      # @!attribute token
+      #
+      #   @return [String]
+      required :token, String
+
+      # @!attribute category
+      #
+      #   @return [Symbol, Lithic::Models::ExternalPayment::Category]
+      required :category, enum: -> { Lithic::Models::ExternalPayment::Category }
+
+      # @!attribute created
+      #
+      #   @return [Time]
+      required :created, Time
+
+      # @!attribute currency
+      #
+      #   @return [String]
+      required :currency, String
+
+      # @!attribute events
+      #
+      #   @return [Array<Lithic::Models::ExternalPayment::Event>]
+      required :events, -> { Lithic::ArrayOf[Lithic::Models::ExternalPayment::Event] }
+
+      # @!attribute financial_account_token
+      #
+      #   @return [String]
+      required :financial_account_token, String
+
+      # @!attribute payment_type
+      #
+      #   @return [Symbol, Lithic::Models::ExternalPayment::PaymentType]
+      required :payment_type, enum: -> { Lithic::Models::ExternalPayment::PaymentType }
+
+      # @!attribute pending_amount
+      #
+      #   @return [Integer]
+      required :pending_amount, Integer
+
+      # @!attribute result
+      #
+      #   @return [Symbol, Lithic::Models::ExternalPayment::Result]
+      required :result, enum: -> { Lithic::Models::ExternalPayment::Result }
+
+      # @!attribute settled_amount
+      #
+      #   @return [Integer]
+      required :settled_amount, Integer
+
+      # @!attribute status
+      #
+      #   @return [Symbol, Lithic::Models::ExternalPayment::Status]
+      required :status, enum: -> { Lithic::Models::ExternalPayment::Status }
+
+      # @!attribute updated
+      #
+      #   @return [Time]
+      required :updated, Time
+
+      # @!attribute [r] user_defined_id
+      #
+      #   @return [String, nil]
+      optional :user_defined_id, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :user_defined_id
+
+      # @!parse
+      #   # @param token [String]
+      #   # @param category [Symbol, Lithic::Models::ExternalPayment::Category]
+      #   # @param created [Time]
+      #   # @param currency [String]
+      #   # @param events [Array<Lithic::Models::ExternalPayment::Event>]
+      #   # @param financial_account_token [String]
+      #   # @param payment_type [Symbol, Lithic::Models::ExternalPayment::PaymentType]
+      #   # @param pending_amount [Integer]
+      #   # @param result [Symbol, Lithic::Models::ExternalPayment::Result]
+      #   # @param settled_amount [Integer]
+      #   # @param status [Symbol, Lithic::Models::ExternalPayment::Status]
+      #   # @param updated [Time]
+      #   # @param user_defined_id [String]
+      #   #
+      #   def initialize(
+      #     token:,
+      #     category:,
+      #     created:,
+      #     currency:,
+      #     events:,
+      #     financial_account_token:,
+      #     payment_type:,
+      #     pending_amount:,
+      #     result:,
+      #     settled_amount:,
+      #     status:,
+      #     updated:,
+      #     user_defined_id: nil,
+      #     **
+      #   )
+      #     super
+      #   end
+
+      # def initialize: (Hash | Lithic::BaseModel) -> void
+
+      module Category
+        extend Lithic::Enum
+
+        EXTERNAL_WIRE = :EXTERNAL_WIRE
+        EXTERNAL_ACH = :EXTERNAL_ACH
+        EXTERNAL_CHECK = :EXTERNAL_CHECK
+        EXTERNAL_TRANSFER = :EXTERNAL_TRANSFER
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
+      end
+
+      class Event < Lithic::BaseModel
+        # @!attribute token
+        #
+        #   @return [String]
+        required :token, String
+
+        # @!attribute amount
+        #
+        #   @return [Integer]
+        required :amount, Integer
+
+        # @!attribute created
+        #
+        #   @return [Time]
+        required :created, Time
+
+        # @!attribute detailed_results
+        #
+        #   @return [Array<Symbol, Lithic::Models::ExternalPayment::Event::DetailedResult>]
+        required :detailed_results,
+                 -> { Lithic::ArrayOf[enum: Lithic::Models::ExternalPayment::Event::DetailedResult] }
+
+        # @!attribute effective_date
+        #
+        #   @return [Date]
+        required :effective_date, Date
+
+        # @!attribute memo
+        #
+        #   @return [String]
+        required :memo, String
+
+        # @!attribute result
+        #
+        #   @return [Symbol, Lithic::Models::ExternalPayment::Event::Result]
+        required :result, enum: -> { Lithic::Models::ExternalPayment::Event::Result }
+
+        # @!attribute type
+        #
+        #   @return [Symbol, Lithic::Models::ExternalPayment::Event::Type]
+        required :type, enum: -> { Lithic::Models::ExternalPayment::Event::Type }
+
+        # @!parse
+        #   # @param token [String]
+        #   # @param amount [Integer]
+        #   # @param created [Time]
+        #   # @param detailed_results [Array<Symbol, Lithic::Models::ExternalPayment::Event::DetailedResult>]
+        #   # @param effective_date [Date]
+        #   # @param memo [String]
+        #   # @param result [Symbol, Lithic::Models::ExternalPayment::Event::Result]
+        #   # @param type [Symbol, Lithic::Models::ExternalPayment::Event::Type]
+        #   #
+        #   def initialize(token:, amount:, created:, detailed_results:, effective_date:, memo:, result:, type:, **) = super
+
+        # def initialize: (Hash | Lithic::BaseModel) -> void
+
+        module DetailedResult
+          extend Lithic::Enum
+
+          APPROVED = :APPROVED
+
+          finalize!
+
+          # @!parse
+          #   # @return [Array<Symbol>]
+          #   def self.values; end
+        end
+
+        module Result
+          extend Lithic::Enum
+
+          APPROVED = :APPROVED
+          DECLINED = :DECLINED
+
+          finalize!
+
+          # @!parse
+          #   # @return [Array<Symbol>]
+          #   def self.values; end
+        end
+
+        module Type
+          extend Lithic::Enum
+
+          EXTERNAL_WIRE_INITIATED = :EXTERNAL_WIRE_INITIATED
+          EXTERNAL_WIRE_CANCELED = :EXTERNAL_WIRE_CANCELED
+          EXTERNAL_WIRE_SETTLED = :EXTERNAL_WIRE_SETTLED
+          EXTERNAL_WIRE_REVERSED = :EXTERNAL_WIRE_REVERSED
+          EXTERNAL_WIRE_RELEASED = :EXTERNAL_WIRE_RELEASED
+          EXTERNAL_ACH_INITIATED = :EXTERNAL_ACH_INITIATED
+          EXTERNAL_ACH_CANCELED = :EXTERNAL_ACH_CANCELED
+          EXTERNAL_ACH_SETTLED = :EXTERNAL_ACH_SETTLED
+          EXTERNAL_ACH_REVERSED = :EXTERNAL_ACH_REVERSED
+          EXTERNAL_ACH_RELEASED = :EXTERNAL_ACH_RELEASED
+          EXTERNAL_TRANSFER_INITIATED = :EXTERNAL_TRANSFER_INITIATED
+          EXTERNAL_TRANSFER_CANCELED = :EXTERNAL_TRANSFER_CANCELED
+          EXTERNAL_TRANSFER_SETTLED = :EXTERNAL_TRANSFER_SETTLED
+          EXTERNAL_TRANSFER_REVERSED = :EXTERNAL_TRANSFER_REVERSED
+          EXTERNAL_TRANSFER_RELEASED = :EXTERNAL_TRANSFER_RELEASED
+          EXTERNAL_CHECK_INITIATED = :EXTERNAL_CHECK_INITIATED
+          EXTERNAL_CHECK_CANCELED = :EXTERNAL_CHECK_CANCELED
+          EXTERNAL_CHECK_SETTLED = :EXTERNAL_CHECK_SETTLED
+          EXTERNAL_CHECK_REVERSED = :EXTERNAL_CHECK_REVERSED
+          EXTERNAL_CHECK_RELEASED = :EXTERNAL_CHECK_RELEASED
+
+          finalize!
+
+          # @!parse
+          #   # @return [Array<Symbol>]
+          #   def self.values; end
+        end
+      end
+
+      module PaymentType
+        extend Lithic::Enum
+
+        DEPOSIT = :DEPOSIT
+        WITHDRAWAL = :WITHDRAWAL
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
+      end
+
+      module Result
+        extend Lithic::Enum
+
+        APPROVED = :APPROVED
+        DECLINED = :DECLINED
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
+      end
+
+      module Status
+        extend Lithic::Enum
+
+        PENDING = :PENDING
+        SETTLED = :SETTLED
+        DECLINED = :DECLINED
+        REVERSED = :REVERSED
+        CANCELED = :CANCELED
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
+      end
+    end
+  end
+end

data/lib/lithic/models/external_payment_cancel_params.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    class ExternalPaymentCancelParams < Lithic::BaseModel
+      # @!parse
+      #   extend Lithic::RequestParameters::Converter
+      include Lithic::RequestParameters
+
+      # @!attribute effective_date
+      #
+      #   @return [Date]
+      required :effective_date, Date
+
+      # @!attribute [r] memo
+      #
+      #   @return [String, nil]
+      optional :memo, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :memo
+
+      # @!parse
+      #   # @param effective_date [Date]
+      #   # @param memo [String]
+      #   # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(effective_date:, memo: nil, request_options: {}, **) = super
+
+      # def initialize: (Hash | Lithic::BaseModel) -> void
+    end
+  end
+end

data/lib/lithic/models/external_payment_create_params.rb

@@ -0,0 +1,143 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    class ExternalPaymentCreateParams < Lithic::BaseModel
+      # @!parse
+      #   extend Lithic::RequestParameters::Converter
+      include Lithic::RequestParameters
+
+      # @!attribute amount
+      #
+      #   @return [Integer]
+      required :amount, Integer
+
+      # @!attribute category
+      #
+      #   @return [Symbol, Lithic::Models::ExternalPaymentCreateParams::Category]
+      required :category, enum: -> { Lithic::Models::ExternalPaymentCreateParams::Category }
+
+      # @!attribute effective_date
+      #
+      #   @return [Date]
+      required :effective_date, Date
+
+      # @!attribute financial_account_token
+      #
+      #   @return [String]
+      required :financial_account_token, String
+
+      # @!attribute payment_type
+      #
+      #   @return [Symbol, Lithic::Models::ExternalPaymentCreateParams::PaymentType]
+      required :payment_type, enum: -> { Lithic::Models::ExternalPaymentCreateParams::PaymentType }
+
+      # @!attribute [r] token
+      #
+      #   @return [String, nil]
+      optional :token, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :token
+
+      # @!attribute [r] memo
+      #
+      #   @return [String, nil]
+      optional :memo, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :memo
+
+      # @!attribute [r] progress_to
+      #
+      #   @return [Symbol, Lithic::Models::ExternalPaymentCreateParams::ProgressTo, nil]
+      optional :progress_to, enum: -> { Lithic::Models::ExternalPaymentCreateParams::ProgressTo }
+
+      # @!parse
+      #   # @return [Symbol, Lithic::Models::ExternalPaymentCreateParams::ProgressTo]
+      #   attr_writer :progress_to
+
+      # @!attribute [r] user_defined_id
+      #
+      #   @return [String, nil]
+      optional :user_defined_id, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :user_defined_id
+
+      # @!parse
+      #   # @param amount [Integer]
+      #   # @param category [Symbol, Lithic::Models::ExternalPaymentCreateParams::Category]
+      #   # @param effective_date [Date]
+      #   # @param financial_account_token [String]
+      #   # @param payment_type [Symbol, Lithic::Models::ExternalPaymentCreateParams::PaymentType]
+      #   # @param token [String]
+      #   # @param memo [String]
+      #   # @param progress_to [Symbol, Lithic::Models::ExternalPaymentCreateParams::ProgressTo]
+      #   # @param user_defined_id [String]
+      #   # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(
+      #     amount:,
+      #     category:,
+      #     effective_date:,
+      #     financial_account_token:,
+      #     payment_type:,
+      #     token: nil,
+      #     memo: nil,
+      #     progress_to: nil,
+      #     user_defined_id: nil,
+      #     request_options: {},
+      #     **
+      #   )
+      #     super
+      #   end
+
+      # def initialize: (Hash | Lithic::BaseModel) -> void
+
+      module Category
+        extend Lithic::Enum
+
+        EXTERNAL_WIRE = :EXTERNAL_WIRE
+        EXTERNAL_ACH = :EXTERNAL_ACH
+        EXTERNAL_CHECK = :EXTERNAL_CHECK
+        EXTERNAL_TRANSFER = :EXTERNAL_TRANSFER
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
+      end
+
+      module PaymentType
+        extend Lithic::Enum
+
+        DEPOSIT = :DEPOSIT
+        WITHDRAWAL = :WITHDRAWAL
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
+      end
+
+      module ProgressTo
+        extend Lithic::Enum
+
+        SETTLED = :SETTLED
+        RELEASED = :RELEASED
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
+      end
+    end
+  end
+end

data/lib/lithic/models/external_payment_list_params.rb

@@ -0,0 +1,194 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    class ExternalPaymentListParams < Lithic::BaseModel
+      # @!parse
+      #   extend Lithic::RequestParameters::Converter
+      include Lithic::RequestParameters
+
+      # @!attribute [r] begin_
+      #   Date string in RFC 3339 format. Only entries created after the specified time
+      #     will be included. UTC time zone.
+      #
+      #   @return [Time, nil]
+      optional :begin_, Time, api_name: :begin
+
+      # @!parse
+      #   # @return [Time]
+      #   attr_writer :begin_
+
+      # @!attribute [r] business_account_token
+      #
+      #   @return [String, nil]
+      optional :business_account_token, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :business_account_token
+
+      # @!attribute [r] category
+      #   External Payment category to be returned.
+      #
+      #   @return [Symbol, Lithic::Models::ExternalPaymentListParams::Category, nil]
+      optional :category, enum: -> { Lithic::Models::ExternalPaymentListParams::Category }
+
+      # @!parse
+      #   # @return [Symbol, Lithic::Models::ExternalPaymentListParams::Category]
+      #   attr_writer :category
+
+      # @!attribute [r] end_
+      #   Date string in RFC 3339 format. Only entries created before the specified time
+      #     will be included. UTC time zone.
+      #
+      #   @return [Time, nil]
+      optional :end_, Time, api_name: :end
+
+      # @!parse
+      #   # @return [Time]
+      #   attr_writer :end_
+
+      # @!attribute [r] 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
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :ending_before
+
+      # @!attribute [r] financial_account_token
+      #   Globally unique identifier for the financial account or card that will send the
+      #     funds. Accepted type dependent on the program's use case.
+      #
+      #   @return [String, nil]
+      optional :financial_account_token, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :financial_account_token
+
+      # @!attribute [r] page_size
+      #   Page size (for pagination).
+      #
+      #   @return [Integer, nil]
+      optional :page_size, Integer
+
+      # @!parse
+      #   # @return [Integer]
+      #   attr_writer :page_size
+
+      # @!attribute [r] result
+      #   External Payment result to be returned.
+      #
+      #   @return [Symbol, Lithic::Models::ExternalPaymentListParams::Result, nil]
+      optional :result, enum: -> { Lithic::Models::ExternalPaymentListParams::Result }
+
+      # @!parse
+      #   # @return [Symbol, Lithic::Models::ExternalPaymentListParams::Result]
+      #   attr_writer :result
+
+      # @!attribute [r] 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
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :starting_after
+
+      # @!attribute [r] status
+      #   Book transfer status to be returned.
+      #
+      #   @return [Symbol, Lithic::Models::ExternalPaymentListParams::Status, nil]
+      optional :status, enum: -> { Lithic::Models::ExternalPaymentListParams::Status }
+
+      # @!parse
+      #   # @return [Symbol, Lithic::Models::ExternalPaymentListParams::Status]
+      #   attr_writer :status
+
+      # @!parse
+      #   # @param begin_ [Time]
+      #   # @param business_account_token [String]
+      #   # @param category [Symbol, Lithic::Models::ExternalPaymentListParams::Category]
+      #   # @param end_ [Time]
+      #   # @param ending_before [String]
+      #   # @param financial_account_token [String]
+      #   # @param page_size [Integer]
+      #   # @param result [Symbol, Lithic::Models::ExternalPaymentListParams::Result]
+      #   # @param starting_after [String]
+      #   # @param status [Symbol, Lithic::Models::ExternalPaymentListParams::Status]
+      #   # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(
+      #     begin_: nil,
+      #     business_account_token: nil,
+      #     category: nil,
+      #     end_: nil,
+      #     ending_before: nil,
+      #     financial_account_token: nil,
+      #     page_size: nil,
+      #     result: nil,
+      #     starting_after: nil,
+      #     status: nil,
+      #     request_options: {},
+      #     **
+      #   )
+      #     super
+      #   end
+
+      # def initialize: (Hash | Lithic::BaseModel) -> void
+
+      # External Payment category to be returned.
+      module Category
+        extend Lithic::Enum
+
+        EXTERNAL_WIRE = :EXTERNAL_WIRE
+        EXTERNAL_ACH = :EXTERNAL_ACH
+        EXTERNAL_CHECK = :EXTERNAL_CHECK
+        EXTERNAL_TRANSFER = :EXTERNAL_TRANSFER
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
+      end
+
+      # External Payment result to be returned.
+      module Result
+        extend Lithic::Enum
+
+        APPROVED = :APPROVED
+        DECLINED = :DECLINED
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
+      end
+
+      # Book transfer status to be returned.
+      module Status
+        extend Lithic::Enum
+
+        PENDING = :PENDING
+        SETTLED = :SETTLED
+        DECLINED = :DECLINED
+        REVERSED = :REVERSED
+        CANCELED = :CANCELED
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
+      end
+    end
+  end
+end

data/lib/lithic/models/external_payment_release_params.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    class ExternalPaymentReleaseParams < Lithic::BaseModel
+      # @!parse
+      #   extend Lithic::RequestParameters::Converter
+      include Lithic::RequestParameters
+
+      # @!attribute effective_date
+      #
+      #   @return [Date]
+      required :effective_date, Date
+
+      # @!attribute [r] memo
+      #
+      #   @return [String, nil]
+      optional :memo, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :memo
+
+      # @!parse
+      #   # @param effective_date [Date]
+      #   # @param memo [String]
+      #   # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(effective_date:, memo: nil, request_options: {}, **) = super
+
+      # def initialize: (Hash | Lithic::BaseModel) -> void
+    end
+  end
+end

data/lib/lithic/models/external_payment_retrieve_params.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    class ExternalPaymentRetrieveParams < Lithic::BaseModel
+      # @!parse
+      #   extend Lithic::RequestParameters::Converter
+      include Lithic::RequestParameters
+
+      # @!parse
+      #   # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(request_options: {}, **) = super
+
+      # def initialize: (Hash | Lithic::BaseModel) -> void
+    end
+  end
+end