lithic 0.1.0.pre.alpha.1

data/lib/lithic/models/transaction_expire_authorization_params.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    class TransactionExpireAuthorizationParams < 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/transaction_list_params.rb

@@ -0,0 +1,168 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    class TransactionListParams < Lithic::BaseModel
+      # @!parse
+      #   extend Lithic::RequestParameters::Converter
+      include Lithic::RequestParameters
+
+      # @!attribute [r] account_token
+      #   Filters for transactions associated with a specific account.
+      #
+      #   @return [String, nil]
+      optional :account_token, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :account_token
+
+      # @!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] card_token
+      #   Filters for transactions associated with a specific card.
+      #
+      #   @return [String, nil]
+      optional :card_token, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :card_token
+
+      # @!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] page_size
+      #   Page size (for pagination).
+      #
+      #   @return [Integer, nil]
+      optional :page_size, Integer
+
+      # @!parse
+      #   # @return [Integer]
+      #   attr_writer :page_size
+
+      # @!attribute [r] result
+      #   Filters for transactions using transaction result field. Can filter by
+      #     `APPROVED`, and `DECLINED`.
+      #
+      #   @return [Symbol, Lithic::Models::TransactionListParams::Result, nil]
+      optional :result, enum: -> { Lithic::Models::TransactionListParams::Result }
+
+      # @!parse
+      #   # @return [Symbol, Lithic::Models::TransactionListParams::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
+      #   Filters for transactions using transaction status field.
+      #
+      #   @return [Symbol, Lithic::Models::TransactionListParams::Status, nil]
+      optional :status, enum: -> { Lithic::Models::TransactionListParams::Status }
+
+      # @!parse
+      #   # @return [Symbol, Lithic::Models::TransactionListParams::Status]
+      #   attr_writer :status
+
+      # @!parse
+      #   # @param account_token [String]
+      #   # @param begin_ [Time]
+      #   # @param card_token [String]
+      #   # @param end_ [Time]
+      #   # @param ending_before [String]
+      #   # @param page_size [Integer]
+      #   # @param result [Symbol, Lithic::Models::TransactionListParams::Result]
+      #   # @param starting_after [String]
+      #   # @param status [Symbol, Lithic::Models::TransactionListParams::Status]
+      #   # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(
+      #     account_token: nil,
+      #     begin_: nil,
+      #     card_token: nil,
+      #     end_: nil,
+      #     ending_before: nil,
+      #     page_size: nil,
+      #     result: nil,
+      #     starting_after: nil,
+      #     status: nil,
+      #     request_options: {},
+      #     **
+      #   )
+      #     super
+      #   end
+
+      # def initialize: (Hash | Lithic::BaseModel) -> void
+
+      # Filters for transactions using transaction result field. Can filter by
+      #   `APPROVED`, and `DECLINED`.
+      module Result
+        extend Lithic::Enum
+
+        APPROVED = :APPROVED
+        DECLINED = :DECLINED
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
+      end
+
+      # Filters for transactions using transaction status field.
+      module Status
+        extend Lithic::Enum
+
+        PENDING = :PENDING
+        VOIDED = :VOIDED
+        SETTLED = :SETTLED
+        DECLINED = :DECLINED
+        EXPIRED = :EXPIRED
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
+      end
+    end
+  end
+end

data/lib/lithic/models/transaction_retrieve_params.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    class TransactionRetrieveParams < 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/transaction_simulate_authorization_advice_params.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    class TransactionSimulateAuthorizationAdviceParams < Lithic::BaseModel
+      # @!parse
+      #   extend Lithic::RequestParameters::Converter
+      include Lithic::RequestParameters
+
+      # @!attribute token
+      #   The transaction token returned from the /v1/simulate/authorize. response.
+      #
+      #   @return [String]
+      required :token, String
+
+      # @!attribute amount
+      #   Amount (in cents) to authorize. This amount will override the transaction's
+      #     amount that was originally set by /v1/simulate/authorize.
+      #
+      #   @return [Integer]
+      required :amount, Integer
+
+      # @!parse
+      #   # @param token [String]
+      #   # @param amount [Integer]
+      #   # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(token:, amount:, request_options: {}, **) = super
+
+      # def initialize: (Hash | Lithic::BaseModel) -> void
+    end
+  end
+end

data/lib/lithic/models/transaction_simulate_authorization_advice_response.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    class TransactionSimulateAuthorizationAdviceResponse < Lithic::BaseModel
+      # @!attribute [r] token
+      #   A unique token to reference this transaction.
+      #
+      #   @return [String, nil]
+      optional :token, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :token
+
+      # @!attribute [r] debugging_request_id
+      #   Debugging request ID to share with Lithic Support team.
+      #
+      #   @return [String, nil]
+      optional :debugging_request_id, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :debugging_request_id
+
+      # @!parse
+      #   # @param token [String]
+      #   # @param debugging_request_id [String]
+      #   #
+      #   def initialize(token: nil, debugging_request_id: nil, **) = super
+
+      # def initialize: (Hash | Lithic::BaseModel) -> void
+    end
+  end
+end

data/lib/lithic/models/transaction_simulate_authorization_params.rb

@@ -0,0 +1,188 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    class TransactionSimulateAuthorizationParams < Lithic::BaseModel
+      # @!parse
+      #   extend Lithic::RequestParameters::Converter
+      include Lithic::RequestParameters
+
+      # @!attribute amount
+      #   Amount (in cents) to authorize. For credit authorizations and financial credit
+      #     authorizations, any value entered will be converted into a negative amount in
+      #     the simulated transaction. For example, entering 100 in this field will result
+      #     in a -100 amount in the transaction. For balance inquiries, this field must be
+      #     set to 0.
+      #
+      #   @return [Integer]
+      required :amount, Integer
+
+      # @!attribute descriptor
+      #   Merchant descriptor.
+      #
+      #   @return [String]
+      required :descriptor, String
+
+      # @!attribute pan
+      #   Sixteen digit card number.
+      #
+      #   @return [String]
+      required :pan, String
+
+      # @!attribute [r] mcc
+      #   Merchant category code for the transaction to be simulated. A four-digit number
+      #     listed in ISO 18245. Supported merchant category codes can be found
+      #     [here](https://docs.lithic.com/docs/transactions#merchant-category-codes-mccs).
+      #
+      #   @return [String, nil]
+      optional :mcc, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :mcc
+
+      # @!attribute [r] merchant_acceptor_id
+      #   Unique identifier to identify the payment card acceptor.
+      #
+      #   @return [String, nil]
+      optional :merchant_acceptor_id, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :merchant_acceptor_id
+
+      # @!attribute [r] merchant_amount
+      #   Amount of the transaction to be simulated in currency specified in
+      #     merchant_currency, including any acquirer fees.
+      #
+      #   @return [Integer, nil]
+      optional :merchant_amount, Integer
+
+      # @!parse
+      #   # @return [Integer]
+      #   attr_writer :merchant_amount
+
+      # @!attribute [r] merchant_currency
+      #   3-character alphabetic ISO 4217 currency code. Note: Simulator only accepts USD,
+      #     GBP, EUR and defaults to GBP if another ISO 4217 code is provided
+      #
+      #   @return [String, nil]
+      optional :merchant_currency, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :merchant_currency
+
+      # @!attribute [r] partial_approval_capable
+      #   Set to true if the terminal is capable of partial approval otherwise false.
+      #     Partial approval is when part of a transaction is approved and another payment
+      #     must be used for the remainder.
+      #
+      #   @return [Boolean, nil]
+      optional :partial_approval_capable, Lithic::BooleanModel
+
+      # @!parse
+      #   # @return [Boolean]
+      #   attr_writer :partial_approval_capable
+
+      # @!attribute [r] pin
+      #   Simulate entering a PIN. If omitted, PIN check will not be performed.
+      #
+      #   @return [String, nil]
+      optional :pin, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :pin
+
+      # @!attribute [r] status
+      #   Type of event to simulate.
+      #
+      #     - `AUTHORIZATION` is a dual message purchase authorization, meaning a subsequent
+      #       clearing step is required to settle the transaction.
+      #     - `BALANCE_INQUIRY` is a $0 authorization requesting the balance held on the
+      #       card, and is most often observed when a cardholder requests to view a card's
+      #       balance at an ATM.
+      #     - `CREDIT_AUTHORIZATION` is a dual message request from a merchant to authorize
+      #       a refund, meaning a subsequent clearing step is required to settle the
+      #       transaction.
+      #     - `FINANCIAL_AUTHORIZATION` is a single message request from a merchant to debit
+      #       funds immediately (such as an ATM withdrawal), and no subsequent clearing is
+      #       required to settle the transaction.
+      #     - `FINANCIAL_CREDIT_AUTHORIZATION` is a single message request from a merchant
+      #       to credit funds immediately, and no subsequent clearing is required to settle
+      #       the transaction.
+      #
+      #   @return [Symbol, Lithic::Models::TransactionSimulateAuthorizationParams::Status, nil]
+      optional :status, enum: -> { Lithic::Models::TransactionSimulateAuthorizationParams::Status }
+
+      # @!parse
+      #   # @return [Symbol, Lithic::Models::TransactionSimulateAuthorizationParams::Status]
+      #   attr_writer :status
+
+      # @!parse
+      #   # @param amount [Integer]
+      #   # @param descriptor [String]
+      #   # @param pan [String]
+      #   # @param mcc [String]
+      #   # @param merchant_acceptor_id [String]
+      #   # @param merchant_amount [Integer]
+      #   # @param merchant_currency [String]
+      #   # @param partial_approval_capable [Boolean]
+      #   # @param pin [String]
+      #   # @param status [Symbol, Lithic::Models::TransactionSimulateAuthorizationParams::Status]
+      #   # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(
+      #     amount:,
+      #     descriptor:,
+      #     pan:,
+      #     mcc: nil,
+      #     merchant_acceptor_id: nil,
+      #     merchant_amount: nil,
+      #     merchant_currency: nil,
+      #     partial_approval_capable: nil,
+      #     pin: nil,
+      #     status: nil,
+      #     request_options: {},
+      #     **
+      #   )
+      #     super
+      #   end
+
+      # def initialize: (Hash | Lithic::BaseModel) -> void
+
+      # Type of event to simulate.
+      #
+      #   - `AUTHORIZATION` is a dual message purchase authorization, meaning a subsequent
+      #     clearing step is required to settle the transaction.
+      #   - `BALANCE_INQUIRY` is a $0 authorization requesting the balance held on the
+      #     card, and is most often observed when a cardholder requests to view a card's
+      #     balance at an ATM.
+      #   - `CREDIT_AUTHORIZATION` is a dual message request from a merchant to authorize
+      #     a refund, meaning a subsequent clearing step is required to settle the
+      #     transaction.
+      #   - `FINANCIAL_AUTHORIZATION` is a single message request from a merchant to debit
+      #     funds immediately (such as an ATM withdrawal), and no subsequent clearing is
+      #     required to settle the transaction.
+      #   - `FINANCIAL_CREDIT_AUTHORIZATION` is a single message request from a merchant
+      #     to credit funds immediately, and no subsequent clearing is required to settle
+      #     the transaction.
+      module Status
+        extend Lithic::Enum
+
+        AUTHORIZATION = :AUTHORIZATION
+        BALANCE_INQUIRY = :BALANCE_INQUIRY
+        CREDIT_AUTHORIZATION = :CREDIT_AUTHORIZATION
+        FINANCIAL_AUTHORIZATION = :FINANCIAL_AUTHORIZATION
+        FINANCIAL_CREDIT_AUTHORIZATION = :FINANCIAL_CREDIT_AUTHORIZATION
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
+      end
+    end
+  end
+end

data/lib/lithic/models/transaction_simulate_authorization_response.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    class TransactionSimulateAuthorizationResponse < Lithic::BaseModel
+      # @!attribute [r] token
+      #   A unique token to reference this transaction with later calls to void or clear
+      #     the authorization.
+      #
+      #   @return [String, nil]
+      optional :token, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :token
+
+      # @!attribute [r] debugging_request_id
+      #   Debugging request ID to share with Lithic Support team.
+      #
+      #   @return [String, nil]
+      optional :debugging_request_id, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :debugging_request_id
+
+      # @!parse
+      #   # @param token [String]
+      #   # @param debugging_request_id [String]
+      #   #
+      #   def initialize(token: nil, debugging_request_id: nil, **) = super
+
+      # def initialize: (Hash | Lithic::BaseModel) -> void
+    end
+  end
+end

data/lib/lithic/models/transaction_simulate_clearing_params.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    class TransactionSimulateClearingParams < Lithic::BaseModel
+      # @!parse
+      #   extend Lithic::RequestParameters::Converter
+      include Lithic::RequestParameters
+
+      # @!attribute token
+      #   The transaction token returned from the /v1/simulate/authorize response.
+      #
+      #   @return [String]
+      required :token, String
+
+      # @!attribute [r] amount
+      #   Amount (in cents) to clear. Typically this will match the amount in the original
+      #     authorization, but can be higher or lower. The sign of this amount will
+      #     automatically match the sign of the original authorization's amount. For
+      #     example, entering 100 in this field will result in a -100 amount in the
+      #     transaction, if the original authorization is a credit authorization.
+      #
+      #     If `amount` is not set, the full amount of the transaction will be cleared.
+      #     Transactions that have already cleared, either partially or fully, cannot be
+      #     cleared again using this endpoint.
+      #
+      #   @return [Integer, nil]
+      optional :amount, Integer
+
+      # @!parse
+      #   # @return [Integer]
+      #   attr_writer :amount
+
+      # @!parse
+      #   # @param token [String]
+      #   # @param amount [Integer]
+      #   # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(token:, amount: nil, request_options: {}, **) = super
+
+      # def initialize: (Hash | Lithic::BaseModel) -> void
+    end
+  end
+end

data/lib/lithic/models/transaction_simulate_clearing_response.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    class TransactionSimulateClearingResponse < Lithic::BaseModel
+      # @!attribute [r] debugging_request_id
+      #   Debugging request ID to share with Lithic Support team.
+      #
+      #   @return [String, nil]
+      optional :debugging_request_id, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :debugging_request_id
+
+      # @!parse
+      #   # @param debugging_request_id [String]
+      #   #
+      #   def initialize(debugging_request_id: nil, **) = super
+
+      # def initialize: (Hash | Lithic::BaseModel) -> void
+    end
+  end
+end

data/lib/lithic/models/transaction_simulate_credit_authorization_params.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    class TransactionSimulateCreditAuthorizationParams < Lithic::BaseModel
+      # @!parse
+      #   extend Lithic::RequestParameters::Converter
+      include Lithic::RequestParameters
+
+      # @!attribute amount
+      #   Amount (in cents). Any value entered will be converted into a negative amount in
+      #     the simulated transaction. For example, entering 100 in this field will appear
+      #     as a -100 amount in the transaction.
+      #
+      #   @return [Integer]
+      required :amount, Integer
+
+      # @!attribute descriptor
+      #   Merchant descriptor.
+      #
+      #   @return [String]
+      required :descriptor, String
+
+      # @!attribute pan
+      #   Sixteen digit card number.
+      #
+      #   @return [String]
+      required :pan, String
+
+      # @!attribute [r] mcc
+      #   Merchant category code for the transaction to be simulated. A four-digit number
+      #     listed in ISO 18245. Supported merchant category codes can be found
+      #     [here](https://docs.lithic.com/docs/transactions#merchant-category-codes-mccs).
+      #
+      #   @return [String, nil]
+      optional :mcc, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :mcc
+
+      # @!attribute [r] merchant_acceptor_id
+      #   Unique identifier to identify the payment card acceptor.
+      #
+      #   @return [String, nil]
+      optional :merchant_acceptor_id, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :merchant_acceptor_id
+
+      # @!parse
+      #   # @param amount [Integer]
+      #   # @param descriptor [String]
+      #   # @param pan [String]
+      #   # @param mcc [String]
+      #   # @param merchant_acceptor_id [String]
+      #   # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(amount:, descriptor:, pan:, mcc: nil, merchant_acceptor_id: nil, request_options: {}, **) = super
+
+      # def initialize: (Hash | Lithic::BaseModel) -> void
+    end
+  end
+end

data/lib/lithic/models/transaction_simulate_credit_authorization_response.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    class TransactionSimulateCreditAuthorizationResponse < Lithic::BaseModel
+      # @!attribute [r] token
+      #   A unique token to reference this transaction.
+      #
+      #   @return [String, nil]
+      optional :token, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :token
+
+      # @!attribute [r] debugging_request_id
+      #   Debugging request ID to share with Lithic Support team.
+      #
+      #   @return [String, nil]
+      optional :debugging_request_id, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :debugging_request_id
+
+      # @!parse
+      #   # @param token [String]
+      #   # @param debugging_request_id [String]
+      #   #
+      #   def initialize(token: nil, debugging_request_id: nil, **) = super
+
+      # def initialize: (Hash | Lithic::BaseModel) -> void
+    end
+  end
+end