lithic 0.1.0.pre.alpha.1

data/lib/lithic/models/responder_endpoint_check_status_params.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    class ResponderEndpointCheckStatusParams < Lithic::BaseModel
+      # @!parse
+      #   extend Lithic::RequestParameters::Converter
+      include Lithic::RequestParameters
+
+      # @!attribute type
+      #   The type of the endpoint.
+      #
+      #   @return [Symbol, Lithic::Models::ResponderEndpointCheckStatusParams::Type]
+      required :type, enum: -> { Lithic::Models::ResponderEndpointCheckStatusParams::Type }
+
+      # @!parse
+      #   # @param type [Symbol, Lithic::Models::ResponderEndpointCheckStatusParams::Type]
+      #   # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(type:, request_options: {}, **) = super
+
+      # def initialize: (Hash | Lithic::BaseModel) -> void
+
+      # The type of the endpoint.
+      module Type
+        extend Lithic::Enum
+
+        AUTH_STREAM_ACCESS = :AUTH_STREAM_ACCESS
+        THREE_DS_DECISIONING = :THREE_DS_DECISIONING
+        TOKENIZATION_DECISIONING = :TOKENIZATION_DECISIONING
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
+      end
+    end
+  end
+end

data/lib/lithic/models/responder_endpoint_create_params.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    class ResponderEndpointCreateParams < Lithic::BaseModel
+      # @!parse
+      #   extend Lithic::RequestParameters::Converter
+      include Lithic::RequestParameters
+
+      # @!attribute [r] type
+      #   The type of the endpoint.
+      #
+      #   @return [Symbol, Lithic::Models::ResponderEndpointCreateParams::Type, nil]
+      optional :type, enum: -> { Lithic::Models::ResponderEndpointCreateParams::Type }
+
+      # @!parse
+      #   # @return [Symbol, Lithic::Models::ResponderEndpointCreateParams::Type]
+      #   attr_writer :type
+
+      # @!attribute [r] url
+      #   The URL for the responder endpoint (must be http(s)).
+      #
+      #   @return [String, nil]
+      optional :url, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :url
+
+      # @!parse
+      #   # @param type [Symbol, Lithic::Models::ResponderEndpointCreateParams::Type]
+      #   # @param url [String]
+      #   # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(type: nil, url: nil, request_options: {}, **) = super
+
+      # def initialize: (Hash | Lithic::BaseModel) -> void
+
+      # The type of the endpoint.
+      module Type
+        extend Lithic::Enum
+
+        AUTH_STREAM_ACCESS = :AUTH_STREAM_ACCESS
+        THREE_DS_DECISIONING = :THREE_DS_DECISIONING
+        TOKENIZATION_DECISIONING = :TOKENIZATION_DECISIONING
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
+      end
+    end
+  end
+end

data/lib/lithic/models/responder_endpoint_create_response.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    class ResponderEndpointCreateResponse < Lithic::BaseModel
+      # @!attribute [r] enrolled
+      #   True if the endpoint was enrolled successfully.
+      #
+      #   @return [Boolean, nil]
+      optional :enrolled, Lithic::BooleanModel
+
+      # @!parse
+      #   # @return [Boolean]
+      #   attr_writer :enrolled
+
+      # @!parse
+      #   # @param enrolled [Boolean]
+      #   #
+      #   def initialize(enrolled: nil, **) = super
+
+      # def initialize: (Hash | Lithic::BaseModel) -> void
+    end
+  end
+end

data/lib/lithic/models/responder_endpoint_delete_params.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    class ResponderEndpointDeleteParams < Lithic::BaseModel
+      # @!parse
+      #   extend Lithic::RequestParameters::Converter
+      include Lithic::RequestParameters
+
+      # @!attribute type
+      #   The type of the endpoint.
+      #
+      #   @return [Symbol, Lithic::Models::ResponderEndpointDeleteParams::Type]
+      required :type, enum: -> { Lithic::Models::ResponderEndpointDeleteParams::Type }
+
+      # @!parse
+      #   # @param type [Symbol, Lithic::Models::ResponderEndpointDeleteParams::Type]
+      #   # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(type:, request_options: {}, **) = super
+
+      # def initialize: (Hash | Lithic::BaseModel) -> void
+
+      # The type of the endpoint.
+      module Type
+        extend Lithic::Enum
+
+        AUTH_STREAM_ACCESS = :AUTH_STREAM_ACCESS
+        THREE_DS_DECISIONING = :THREE_DS_DECISIONING
+        TOKENIZATION_DECISIONING = :TOKENIZATION_DECISIONING
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
+      end
+    end
+  end
+end

data/lib/lithic/models/responder_endpoint_status.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    class ResponderEndpointStatus < Lithic::BaseModel
+      # @!attribute [r] enrolled
+      #   True if the instance has an endpoint enrolled.
+      #
+      #   @return [Boolean, nil]
+      optional :enrolled, Lithic::BooleanModel
+
+      # @!parse
+      #   # @return [Boolean]
+      #   attr_writer :enrolled
+
+      # @!attribute url
+      #   The URL of the currently enrolled endpoint or null.
+      #
+      #   @return [String, nil]
+      optional :url, String, nil?: true
+
+      # @!parse
+      #   # @param enrolled [Boolean]
+      #   # @param url [String, nil]
+      #   #
+      #   def initialize(enrolled: nil, url: nil, **) = super
+
+      # def initialize: (Hash | Lithic::BaseModel) -> void
+    end
+  end
+end

data/lib/lithic/models/settlement_detail.rb

@@ -0,0 +1,252 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    class SettlementDetail < Lithic::BaseModel
+      # @!attribute token
+      #   Globally unique identifier denoting the Settlement Detail.
+      #
+      #   @return [String]
+      required :token, String
+
+      # @!attribute account_token
+      #   The most granular ID the network settles with (e.g., ICA for Mastercard, FTSRE
+      #     for Visa).
+      #
+      #   @return [String]
+      required :account_token, String
+
+      # @!attribute card_program_token
+      #   Globally unique identifier denoting the card program that the associated
+      #     Transaction occurred on.
+      #
+      #   @return [String]
+      required :card_program_token, String
+
+      # @!attribute card_token
+      #   Globally unique identifier denoting the card that the associated Transaction
+      #     occurred on.
+      #
+      #   @return [String]
+      required :card_token, String
+
+      # @!attribute created
+      #   Date and time when the transaction first occurred. UTC time zone.
+      #
+      #   @return [Time]
+      required :created, Time
+
+      # @!attribute currency
+      #   Three-character alphabetic ISO 4217 code.
+      #
+      #   @return [String]
+      required :currency, String
+
+      # @!attribute disputes_gross_amount
+      #   The total gross amount of disputes settlements.
+      #
+      #   @return [Integer]
+      required :disputes_gross_amount, Integer
+
+      # @!attribute event_tokens
+      #   Globally unique identifiers denoting the Events associated with this settlement.
+      #
+      #   @return [Array<String>]
+      required :event_tokens, Lithic::ArrayOf[String]
+
+      # @!attribute institution
+      #   The most granular ID the network settles with (e.g., ICA for Mastercard, FTSRE
+      #     for Visa).
+      #
+      #   @return [String]
+      required :institution, String
+
+      # @!attribute interchange_fee_extended_precision
+      #   The total amount of interchange in six-digit extended precision.
+      #
+      #   @return [Integer]
+      required :interchange_fee_extended_precision, Integer
+
+      # @!attribute interchange_gross_amount
+      #   The total amount of interchange.
+      #
+      #   @return [Integer]
+      required :interchange_gross_amount, Integer
+
+      # @!attribute network
+      #   Card network where the transaction took place.
+      #
+      #   @return [Symbol, Lithic::Models::SettlementDetail::Network]
+      required :network, enum: -> { Lithic::Models::SettlementDetail::Network }
+
+      # @!attribute other_fees_details
+      #   The total gross amount of other fees by type.
+      #
+      #   @return [Lithic::Models::SettlementDetail::OtherFeesDetails]
+      required :other_fees_details, -> { Lithic::Models::SettlementDetail::OtherFeesDetails }
+
+      # @!attribute other_fees_gross_amount
+      #   Total amount of gross other fees outside of interchange.
+      #
+      #   @return [Integer]
+      required :other_fees_gross_amount, Integer
+
+      # @!attribute report_date
+      #   Date of when the report was first generated.
+      #
+      #   @return [String]
+      required :report_date, String
+
+      # @!attribute settlement_date
+      #   Date of when money movement is triggered for the transaction.
+      #
+      #   @return [String]
+      required :settlement_date, String
+
+      # @!attribute transaction_token
+      #   Globally unique identifier denoting the associated Transaction object.
+      #
+      #   @return [String]
+      required :transaction_token, String
+
+      # @!attribute transactions_gross_amount
+      #   The total amount of settlement impacting transactions (excluding interchange,
+      #     fees, and disputes).
+      #
+      #   @return [Integer]
+      required :transactions_gross_amount, Integer
+
+      # @!attribute type
+      #   The type of settlement record.
+      #
+      #   @return [Symbol, Lithic::Models::SettlementDetail::Type]
+      required :type, enum: -> { Lithic::Models::SettlementDetail::Type }
+
+      # @!attribute updated
+      #   Date and time when the transaction first occurred. UTC time zone.
+      #
+      #   @return [Time]
+      required :updated, Time
+
+      # @!attribute [r] fee_description
+      #   Network's description of a fee, only present on records with type `FEE`.
+      #
+      #   @return [String, nil]
+      optional :fee_description, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :fee_description
+
+      # @!parse
+      #   # @param token [String]
+      #   # @param account_token [String]
+      #   # @param card_program_token [String]
+      #   # @param card_token [String]
+      #   # @param created [Time]
+      #   # @param currency [String]
+      #   # @param disputes_gross_amount [Integer]
+      #   # @param event_tokens [Array<String>]
+      #   # @param institution [String]
+      #   # @param interchange_fee_extended_precision [Integer]
+      #   # @param interchange_gross_amount [Integer]
+      #   # @param network [Symbol, Lithic::Models::SettlementDetail::Network]
+      #   # @param other_fees_details [Lithic::Models::SettlementDetail::OtherFeesDetails]
+      #   # @param other_fees_gross_amount [Integer]
+      #   # @param report_date [String]
+      #   # @param settlement_date [String]
+      #   # @param transaction_token [String]
+      #   # @param transactions_gross_amount [Integer]
+      #   # @param type [Symbol, Lithic::Models::SettlementDetail::Type]
+      #   # @param updated [Time]
+      #   # @param fee_description [String]
+      #   #
+      #   def initialize(
+      #     token:,
+      #     account_token:,
+      #     card_program_token:,
+      #     card_token:,
+      #     created:,
+      #     currency:,
+      #     disputes_gross_amount:,
+      #     event_tokens:,
+      #     institution:,
+      #     interchange_fee_extended_precision:,
+      #     interchange_gross_amount:,
+      #     network:,
+      #     other_fees_details:,
+      #     other_fees_gross_amount:,
+      #     report_date:,
+      #     settlement_date:,
+      #     transaction_token:,
+      #     transactions_gross_amount:,
+      #     type:,
+      #     updated:,
+      #     fee_description: nil,
+      #     **
+      #   )
+      #     super
+      #   end
+
+      # def initialize: (Hash | Lithic::BaseModel) -> void
+
+      # Card network where the transaction took place.
+      module Network
+        extend Lithic::Enum
+
+        INTERLINK = :INTERLINK
+        MAESTRO = :MAESTRO
+        MASTERCARD = :MASTERCARD
+        UNKNOWN = :UNKNOWN
+        VISA = :VISA
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
+      end
+
+      class OtherFeesDetails < Lithic::BaseModel
+        # @!attribute [r] isa
+        #
+        #   @return [Integer, nil]
+        optional :isa, Integer, api_name: :ISA
+
+        # @!parse
+        #   # @return [Integer]
+        #   attr_writer :isa
+
+        # @!parse
+        #   # The total gross amount of other fees by type.
+        #   #
+        #   # @param isa [Integer]
+        #   #
+        #   def initialize(isa: nil, **) = super
+
+        # def initialize: (Hash | Lithic::BaseModel) -> void
+      end
+
+      # The type of settlement record.
+      module Type
+        extend Lithic::Enum
+
+        ADJUSTMENT = :ADJUSTMENT
+        ARBITRATION = :ARBITRATION
+        CHARGEBACK = :CHARGEBACK
+        CLEARING = :CLEARING
+        FEE = :FEE
+        FINANCIAL = :FINANCIAL
+        NON_FINANCIAL = :"NON-FINANCIAL"
+        PREARBITRATION = :PREARBITRATION
+        REPRESENTMENT = :REPRESENTMENT
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
+      end
+    end
+  end
+end

data/lib/lithic/models/settlement_report.rb

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    class SettlementReport < Lithic::BaseModel
+      # @!attribute created
+      #   Date and time when the transaction first occurred. UTC time zone.
+      #
+      #   @return [Time]
+      required :created, Time
+
+      # @!attribute currency
+      #   3-character alphabetic ISO 4217 code. (This field is deprecated and will be
+      #     removed in a future version of the API.)
+      #
+      #   @return [String]
+      required :currency, String
+
+      # @!attribute details
+      #
+      #   @return [Array<Lithic::Models::SettlementSummaryDetails>]
+      required :details, -> { Lithic::ArrayOf[Lithic::Models::SettlementSummaryDetails] }
+
+      # @!attribute disputes_gross_amount
+      #   The total gross amount of disputes settlements. (This field is deprecated and
+      #     will be removed in a future version of the API. To compute total amounts, Lithic
+      #     recommends that customers sum the relevant settlement amounts found within
+      #     `details`.)
+      #
+      #   @return [Integer]
+      required :disputes_gross_amount, Integer
+
+      # @!attribute interchange_gross_amount
+      #   The total amount of interchange. (This field is deprecated and will be removed
+      #     in a future version of the API. To compute total amounts, Lithic recommends that
+      #     customers sum the relevant settlement amounts found within `details`.)
+      #
+      #   @return [Integer]
+      required :interchange_gross_amount, Integer
+
+      # @!attribute is_complete
+      #   Indicates that all data expected on the given report date is available.
+      #
+      #   @return [Boolean]
+      required :is_complete, Lithic::BooleanModel
+
+      # @!attribute other_fees_gross_amount
+      #   Total amount of gross other fees outside of interchange. (This field is
+      #     deprecated and will be removed in a future version of the API. To compute total
+      #     amounts, Lithic recommends that customers sum the relevant settlement amounts
+      #     found within `details`.)
+      #
+      #   @return [Integer]
+      required :other_fees_gross_amount, Integer
+
+      # @!attribute report_date
+      #   Date of when the report was first generated.
+      #
+      #   @return [String]
+      required :report_date, String
+
+      # @!attribute settled_net_amount
+      #   The total net amount of cash moved. (net value of settled_gross_amount,
+      #     interchange, fees). (This field is deprecated and will be removed in a future
+      #     version of the API. To compute total amounts, Lithic recommends that customers
+      #     sum the relevant settlement amounts found within `details`.)
+      #
+      #   @return [Integer]
+      required :settled_net_amount, Integer
+
+      # @!attribute transactions_gross_amount
+      #   The total amount of settlement impacting transactions (excluding interchange,
+      #     fees, and disputes). (This field is deprecated and will be removed in a future
+      #     version of the API. To compute total amounts, Lithic recommends that customers
+      #     sum the relevant settlement amounts found within `details`.)
+      #
+      #   @return [Integer]
+      required :transactions_gross_amount, Integer
+
+      # @!attribute updated
+      #   Date and time when the transaction first occurred. UTC time zone.
+      #
+      #   @return [Time]
+      required :updated, Time
+
+      # @!parse
+      #   # @param created [Time]
+      #   # @param currency [String]
+      #   # @param details [Array<Lithic::Models::SettlementSummaryDetails>]
+      #   # @param disputes_gross_amount [Integer]
+      #   # @param interchange_gross_amount [Integer]
+      #   # @param is_complete [Boolean]
+      #   # @param other_fees_gross_amount [Integer]
+      #   # @param report_date [String]
+      #   # @param settled_net_amount [Integer]
+      #   # @param transactions_gross_amount [Integer]
+      #   # @param updated [Time]
+      #   #
+      #   def initialize(
+      #     created:,
+      #     currency:,
+      #     details:,
+      #     disputes_gross_amount:,
+      #     interchange_gross_amount:,
+      #     is_complete:,
+      #     other_fees_gross_amount:,
+      #     report_date:,
+      #     settled_net_amount:,
+      #     transactions_gross_amount:,
+      #     updated:,
+      #     **
+      #   )
+      #     super
+      #   end
+
+      # def initialize: (Hash | Lithic::BaseModel) -> void
+    end
+  end
+end

data/lib/lithic/models/settlement_summary_details.rb

@@ -0,0 +1,133 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    class SettlementSummaryDetails < Lithic::BaseModel
+      # @!attribute [r] currency
+      #   3-character alphabetic ISO 4217 code.
+      #
+      #   @return [String, nil]
+      optional :currency, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :currency
+
+      # @!attribute [r] disputes_gross_amount
+      #   The total gross amount of disputes settlements.
+      #
+      #   @return [Integer, nil]
+      optional :disputes_gross_amount, Integer
+
+      # @!parse
+      #   # @return [Integer]
+      #   attr_writer :disputes_gross_amount
+
+      # @!attribute [r] institution
+      #   The most granular ID the network settles with (e.g., ICA for Mastercard, FTSRE
+      #     for Visa).
+      #
+      #   @return [String, nil]
+      optional :institution, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :institution
+
+      # @!attribute [r] interchange_gross_amount
+      #   The total amount of interchange.
+      #
+      #   @return [Integer, nil]
+      optional :interchange_gross_amount, Integer
+
+      # @!parse
+      #   # @return [Integer]
+      #   attr_writer :interchange_gross_amount
+
+      # @!attribute [r] network
+      #   Card network where the transaction took place
+      #
+      #   @return [Symbol, Lithic::Models::SettlementSummaryDetails::Network, nil]
+      optional :network, enum: -> { Lithic::Models::SettlementSummaryDetails::Network }
+
+      # @!parse
+      #   # @return [Symbol, Lithic::Models::SettlementSummaryDetails::Network]
+      #   attr_writer :network
+
+      # @!attribute [r] other_fees_gross_amount
+      #   Total amount of gross other fees outside of interchange.
+      #
+      #   @return [Integer, nil]
+      optional :other_fees_gross_amount, Integer
+
+      # @!parse
+      #   # @return [Integer]
+      #   attr_writer :other_fees_gross_amount
+
+      # @!attribute [r] settled_net_amount
+      #   The total net amount of cash moved. (net value of settled_gross_amount,
+      #     interchange, fees).
+      #
+      #   @return [Integer, nil]
+      optional :settled_net_amount, Integer
+
+      # @!parse
+      #   # @return [Integer]
+      #   attr_writer :settled_net_amount
+
+      # @!attribute [r] transactions_gross_amount
+      #   The total amount of settlement impacting transactions (excluding interchange,
+      #     fees, and disputes).
+      #
+      #   @return [Integer, nil]
+      optional :transactions_gross_amount, Integer
+
+      # @!parse
+      #   # @return [Integer]
+      #   attr_writer :transactions_gross_amount
+
+      # @!parse
+      #   # @param currency [String]
+      #   # @param disputes_gross_amount [Integer]
+      #   # @param institution [String]
+      #   # @param interchange_gross_amount [Integer]
+      #   # @param network [Symbol, Lithic::Models::SettlementSummaryDetails::Network]
+      #   # @param other_fees_gross_amount [Integer]
+      #   # @param settled_net_amount [Integer]
+      #   # @param transactions_gross_amount [Integer]
+      #   #
+      #   def initialize(
+      #     currency: nil,
+      #     disputes_gross_amount: nil,
+      #     institution: nil,
+      #     interchange_gross_amount: nil,
+      #     network: nil,
+      #     other_fees_gross_amount: nil,
+      #     settled_net_amount: nil,
+      #     transactions_gross_amount: nil,
+      #     **
+      #   )
+      #     super
+      #   end
+
+      # def initialize: (Hash | Lithic::BaseModel) -> void
+
+      # Card network where the transaction took place
+      module Network
+        extend Lithic::Enum
+
+        INTERLINK = :INTERLINK
+        MAESTRO = :MAESTRO
+        MASTERCARD = :MASTERCARD
+        UNKNOWN = :UNKNOWN
+        VISA = :VISA
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
+      end
+    end
+  end
+end