lithic 0.1.0.pre.alpha.1

data/lib/lithic/models/kyc.rb

@@ -0,0 +1,142 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    class KYC < Lithic::BaseModel
+      # @!attribute individual
+      #   Information on individual for whom the account is being opened and KYC is being
+      #     run.
+      #
+      #   @return [Lithic::Models::KYC::Individual]
+      required :individual, -> { Lithic::Models::KYC::Individual }
+
+      # @!attribute tos_timestamp
+      #   An RFC 3339 timestamp indicating when the account holder accepted the applicable
+      #     legal agreements (e.g., cardholder terms) as agreed upon during API customer's
+      #     implementation with Lithic.
+      #
+      #   @return [String]
+      required :tos_timestamp, String
+
+      # @!attribute workflow
+      #   Specifies the type of KYC workflow to run.
+      #
+      #   @return [Symbol, Lithic::Models::KYC::Workflow]
+      required :workflow, enum: -> { Lithic::Models::KYC::Workflow }
+
+      # @!attribute [r] external_id
+      #   A user provided id that can be used to link an account holder with an external
+      #     system
+      #
+      #   @return [String, nil]
+      optional :external_id, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :external_id
+
+      # @!attribute [r] kyc_passed_timestamp
+      #   An RFC 3339 timestamp indicating when precomputed KYC was completed on the
+      #     individual with a pass result.
+      #
+      #     This field is required only if workflow type is `KYC_BYO`.
+      #
+      #   @return [String, nil]
+      optional :kyc_passed_timestamp, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :kyc_passed_timestamp
+
+      # @!parse
+      #   # @param individual [Lithic::Models::KYC::Individual]
+      #   # @param tos_timestamp [String]
+      #   # @param workflow [Symbol, Lithic::Models::KYC::Workflow]
+      #   # @param external_id [String]
+      #   # @param kyc_passed_timestamp [String]
+      #   #
+      #   def initialize(individual:, tos_timestamp:, workflow:, external_id: nil, kyc_passed_timestamp: nil, **) = super
+
+      # def initialize: (Hash | Lithic::BaseModel) -> void
+
+      class Individual < Lithic::BaseModel
+        # @!attribute address
+        #   Individual's current address - PO boxes, UPS drops, and FedEx drops are not
+        #     acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
+        #
+        #   @return [Lithic::Models::Address]
+        required :address, -> { Lithic::Models::Address }
+
+        # @!attribute dob
+        #   Individual's date of birth, as an RFC 3339 date.
+        #
+        #   @return [String]
+        required :dob, String
+
+        # @!attribute email
+        #   Individual's email address. If utilizing Lithic for chargeback processing, this
+        #     customer email address may be used to communicate dispute status and resolution.
+        #
+        #   @return [String]
+        required :email, String
+
+        # @!attribute first_name
+        #   Individual's first name, as it appears on government-issued identity documents.
+        #
+        #   @return [String]
+        required :first_name, String
+
+        # @!attribute government_id
+        #   Government-issued identification number (required for identity verification and
+        #     compliance with banking regulations). Social Security Numbers (SSN) and
+        #     Individual Taxpayer Identification Numbers (ITIN) are currently supported,
+        #     entered as full nine-digits, with or without hyphens
+        #
+        #   @return [String]
+        required :government_id, String
+
+        # @!attribute last_name
+        #   Individual's last name, as it appears on government-issued identity documents.
+        #
+        #   @return [String]
+        required :last_name, String
+
+        # @!attribute phone_number
+        #   Individual's phone number, entered in E.164 format.
+        #
+        #   @return [String]
+        required :phone_number, String
+
+        # @!parse
+        #   # Information on individual for whom the account is being opened and KYC is being
+        #   #   run.
+        #   #
+        #   # @param address [Lithic::Models::Address]
+        #   # @param dob [String]
+        #   # @param email [String]
+        #   # @param first_name [String]
+        #   # @param government_id [String]
+        #   # @param last_name [String]
+        #   # @param phone_number [String]
+        #   #
+        #   def initialize(address:, dob:, email:, first_name:, government_id:, last_name:, phone_number:, **) = super
+
+        # def initialize: (Hash | Lithic::BaseModel) -> void
+      end
+
+      # Specifies the type of KYC workflow to run.
+      module Workflow
+        extend Lithic::Enum
+
+        KYC_BASIC = :KYC_BASIC
+        KYC_BYO = :KYC_BYO
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
+      end
+    end
+  end
+end

data/lib/lithic/models/kyc_exempt.rb

@@ -0,0 +1,128 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    class KYCExempt < Lithic::BaseModel
+      # @!attribute address
+      #   KYC Exempt user's current address - PO boxes, UPS drops, and FedEx drops are not
+      #     acceptable; APO/FPO are acceptable.
+      #
+      #   @return [Lithic::Models::Address]
+      required :address, -> { Lithic::Models::Address }
+
+      # @!attribute email
+      #   The KYC Exempt user's email
+      #
+      #   @return [String]
+      required :email, String
+
+      # @!attribute first_name
+      #   The KYC Exempt user's first name
+      #
+      #   @return [String]
+      required :first_name, String
+
+      # @!attribute kyc_exemption_type
+      #   Specifies the type of KYC Exempt user
+      #
+      #   @return [Symbol, Lithic::Models::KYCExempt::KYCExemptionType]
+      required :kyc_exemption_type, enum: -> { Lithic::Models::KYCExempt::KYCExemptionType }
+
+      # @!attribute last_name
+      #   The KYC Exempt user's last name
+      #
+      #   @return [String]
+      required :last_name, String
+
+      # @!attribute phone_number
+      #   The KYC Exempt user's phone number, entered in E.164 format.
+      #
+      #   @return [String]
+      required :phone_number, String
+
+      # @!attribute workflow
+      #   Specifies the workflow type. This must be 'KYC_EXEMPT'
+      #
+      #   @return [Symbol, Lithic::Models::KYCExempt::Workflow]
+      required :workflow, enum: -> { Lithic::Models::KYCExempt::Workflow }
+
+      # @!attribute [r] business_account_token
+      #   Only applicable for customers using the KYC-Exempt workflow to enroll authorized
+      #     users of businesses. Pass the account_token of the enrolled business associated
+      #     with the AUTHORIZED_USER in this field.
+      #
+      #   @return [String, nil]
+      optional :business_account_token, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :business_account_token
+
+      # @!attribute [r] external_id
+      #   A user provided id that can be used to link an account holder with an external
+      #     system
+      #
+      #   @return [String, nil]
+      optional :external_id, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :external_id
+
+      # @!parse
+      #   # @param address [Lithic::Models::Address]
+      #   # @param email [String]
+      #   # @param first_name [String]
+      #   # @param kyc_exemption_type [Symbol, Lithic::Models::KYCExempt::KYCExemptionType]
+      #   # @param last_name [String]
+      #   # @param phone_number [String]
+      #   # @param workflow [Symbol, Lithic::Models::KYCExempt::Workflow]
+      #   # @param business_account_token [String]
+      #   # @param external_id [String]
+      #   #
+      #   def initialize(
+      #     address:,
+      #     email:,
+      #     first_name:,
+      #     kyc_exemption_type:,
+      #     last_name:,
+      #     phone_number:,
+      #     workflow:,
+      #     business_account_token: nil,
+      #     external_id: nil,
+      #     **
+      #   )
+      #     super
+      #   end
+
+      # def initialize: (Hash | Lithic::BaseModel) -> void
+
+      # Specifies the type of KYC Exempt user
+      module KYCExemptionType
+        extend Lithic::Enum
+
+        AUTHORIZED_USER = :AUTHORIZED_USER
+        PREPAID_CARD_USER = :PREPAID_CARD_USER
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
+      end
+
+      # Specifies the workflow type. This must be 'KYC_EXEMPT'
+      module Workflow
+        extend Lithic::Enum
+
+        KYC_EXEMPT = :KYC_EXEMPT
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
+      end
+    end
+  end
+end

data/lib/lithic/models/management_operation_create_params.rb

@@ -0,0 +1,163 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    class ManagementOperationCreateParams < Lithic::BaseModel
+      # @!parse
+      #   extend Lithic::RequestParameters::Converter
+      include Lithic::RequestParameters
+
+      # @!attribute amount
+      #
+      #   @return [Integer]
+      required :amount, Integer
+
+      # @!attribute category
+      #
+      #   @return [Symbol, Lithic::Models::ManagementOperationCreateParams::Category]
+      required :category, enum: -> { Lithic::Models::ManagementOperationCreateParams::Category }
+
+      # @!attribute direction
+      #
+      #   @return [Symbol, Lithic::Models::ManagementOperationCreateParams::Direction]
+      required :direction, enum: -> { Lithic::Models::ManagementOperationCreateParams::Direction }
+
+      # @!attribute effective_date
+      #
+      #   @return [Date]
+      required :effective_date, Date
+
+      # @!attribute event_type
+      #
+      #   @return [Symbol, Lithic::Models::ManagementOperationCreateParams::EventType]
+      required :event_type, enum: -> { Lithic::Models::ManagementOperationCreateParams::EventType }
+
+      # @!attribute financial_account_token
+      #
+      #   @return [String]
+      required :financial_account_token, String
+
+      # @!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] subtype
+      #
+      #   @return [String, nil]
+      optional :subtype, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :subtype
+
+      # @!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::ManagementOperationCreateParams::Category]
+      #   # @param direction [Symbol, Lithic::Models::ManagementOperationCreateParams::Direction]
+      #   # @param effective_date [Date]
+      #   # @param event_type [Symbol, Lithic::Models::ManagementOperationCreateParams::EventType]
+      #   # @param financial_account_token [String]
+      #   # @param token [String]
+      #   # @param memo [String]
+      #   # @param subtype [String]
+      #   # @param user_defined_id [String]
+      #   # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(
+      #     amount:,
+      #     category:,
+      #     direction:,
+      #     effective_date:,
+      #     event_type:,
+      #     financial_account_token:,
+      #     token: nil,
+      #     memo: nil,
+      #     subtype: nil,
+      #     user_defined_id: nil,
+      #     request_options: {},
+      #     **
+      #   )
+      #     super
+      #   end
+
+      # def initialize: (Hash | Lithic::BaseModel) -> void
+
+      module Category
+        extend Lithic::Enum
+
+        MANAGEMENT_FEE = :MANAGEMENT_FEE
+        MANAGEMENT_DISPUTE = :MANAGEMENT_DISPUTE
+        MANAGEMENT_REWARD = :MANAGEMENT_REWARD
+        MANAGEMENT_ADJUSTMENT = :MANAGEMENT_ADJUSTMENT
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
+      end
+
+      module Direction
+        extend Lithic::Enum
+
+        CREDIT = :CREDIT
+        DEBIT = :DEBIT
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
+      end
+
+      module EventType
+        extend Lithic::Enum
+
+        CASH_BACK = :CASH_BACK
+        CURRENCY_CONVERSION = :CURRENCY_CONVERSION
+        INTEREST = :INTEREST
+        LATE_PAYMENT = :LATE_PAYMENT
+        BILLING_ERROR = :BILLING_ERROR
+        PROVISIONAL_CREDIT = :PROVISIONAL_CREDIT
+        LOSS_WRITE_OFF = :LOSS_WRITE_OFF
+        CASH_BACK_REVERSAL = :CASH_BACK_REVERSAL
+        CURRENCY_CONVERSION_REVERSAL = :CURRENCY_CONVERSION_REVERSAL
+        INTEREST_REVERSAL = :INTEREST_REVERSAL
+        LATE_PAYMENT_REVERSAL = :LATE_PAYMENT_REVERSAL
+        BILLING_ERROR_REVERSAL = :BILLING_ERROR_REVERSAL
+        PROVISIONAL_CREDIT_REVERSAL = :PROVISIONAL_CREDIT_REVERSAL
+        RETURNED_PAYMENT = :RETURNED_PAYMENT
+        RETURNED_PAYMENT_REVERSAL = :RETURNED_PAYMENT_REVERSAL
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
+      end
+    end
+  end
+end

data/lib/lithic/models/management_operation_list_params.rb

@@ -0,0 +1,168 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    class ManagementOperationListParams < 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
+      #   Management operation category to be returned.
+      #
+      #   @return [Symbol, Lithic::Models::ManagementOperationListParams::Category, nil]
+      optional :category, enum: -> { Lithic::Models::ManagementOperationListParams::Category }
+
+      # @!parse
+      #   # @return [Symbol, Lithic::Models::ManagementOperationListParams::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. 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] 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
+      #   Management operation status to be returned.
+      #
+      #   @return [Symbol, Lithic::Models::ManagementOperationListParams::Status, nil]
+      optional :status, enum: -> { Lithic::Models::ManagementOperationListParams::Status }
+
+      # @!parse
+      #   # @return [Symbol, Lithic::Models::ManagementOperationListParams::Status]
+      #   attr_writer :status
+
+      # @!parse
+      #   # @param begin_ [Time]
+      #   # @param business_account_token [String]
+      #   # @param category [Symbol, Lithic::Models::ManagementOperationListParams::Category]
+      #   # @param end_ [Time]
+      #   # @param ending_before [String]
+      #   # @param financial_account_token [String]
+      #   # @param page_size [Integer]
+      #   # @param starting_after [String]
+      #   # @param status [Symbol, Lithic::Models::ManagementOperationListParams::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,
+      #     starting_after: nil,
+      #     status: nil,
+      #     request_options: {},
+      #     **
+      #   )
+      #     super
+      #   end
+
+      # def initialize: (Hash | Lithic::BaseModel) -> void
+
+      # Management operation category to be returned.
+      module Category
+        extend Lithic::Enum
+
+        MANAGEMENT_FEE = :MANAGEMENT_FEE
+        MANAGEMENT_DISPUTE = :MANAGEMENT_DISPUTE
+        MANAGEMENT_REWARD = :MANAGEMENT_REWARD
+        MANAGEMENT_ADJUSTMENT = :MANAGEMENT_ADJUSTMENT
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
+      end
+
+      # Management operation 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/management_operation_retrieve_params.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    class ManagementOperationRetrieveParams < 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

data/lib/lithic/models/management_operation_reverse_params.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    class ManagementOperationReverseParams < 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