lithic 0.1.0.pre.alpha.55 → 0.1.0

data/lib/lithic/models/financial_transaction.rb

@@ -44,8 +44,8 @@ module Lithic
       # @!attribute events
       #   A list of all financial events that have modified this financial transaction.
       #
-      #   @return [Array<Lithic::Models::FinancialTransaction::Event>]
-      required :events, -> { Lithic::Internal::Type::ArrayOf[Lithic::FinancialTransaction::Event] }
+      #   @return [Array<Lithic::Models::FinancialEvent>]
+      required :events, -> { Lithic::Internal::Type::ArrayOf[Lithic::FinancialEvent] }
 
       # @!attribute pending_amount
       #   Pending amount of the transaction in the currency's smallest unit (e.g., cents),
@@ -103,7 +103,7 @@ module Lithic
       #
       #   @param descriptor [String] A string that provides a description of the financial transaction; may be useful
       #
-      #   @param events [Array<Lithic::Models::FinancialTransaction::Event>] A list of all financial events that have modified this financial transaction.
+      #   @param events [Array<Lithic::Models::FinancialEvent>] A list of all financial events that have modified this financial transaction.
       #
       #   @param pending_amount [Integer] Pending amount of the transaction in the currency's smallest unit (e.g., cents),
       #
@@ -136,149 +136,6 @@ module Lithic
         #   @return [Array<Symbol>]
       end
 
-      class Event < Lithic::Internal::Type::BaseModel
-        # @!attribute token
-        #   Globally unique identifier.
-        #
-        #   @return [String, nil]
-        optional :token, String
-
-        # @!attribute amount
-        #   Amount of the financial event that has been settled in the currency's smallest
-        #   unit (e.g., cents).
-        #
-        #   @return [Integer, nil]
-        optional :amount, Integer
-
-        # @!attribute created
-        #   Date and time when the financial event occurred. UTC time zone.
-        #
-        #   @return [Time, nil]
-        optional :created, Time
-
-        # @!attribute result
-        #   APPROVED financial events were successful while DECLINED financial events were
-        #   declined by user, Lithic, or the network.
-        #
-        #   @return [Symbol, Lithic::Models::FinancialTransaction::Event::Result, nil]
-        optional :result, enum: -> { Lithic::FinancialTransaction::Event::Result }
-
-        # @!attribute type
-        #
-        #   @return [Symbol, Lithic::Models::FinancialTransaction::Event::Type, nil]
-        optional :type, enum: -> { Lithic::FinancialTransaction::Event::Type }
-
-        # @!method initialize(token: nil, amount: nil, created: nil, result: nil, type: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {Lithic::Models::FinancialTransaction::Event} for more details.
-        #
-        #   Financial Event
-        #
-        #   @param token [String] Globally unique identifier.
-        #
-        #   @param amount [Integer] Amount of the financial event that has been settled in the currency's smallest u
-        #
-        #   @param created [Time] Date and time when the financial event occurred. UTC time zone.
-        #
-        #   @param result [Symbol, Lithic::Models::FinancialTransaction::Event::Result] APPROVED financial events were successful while DECLINED financial events were d
-        #
-        #   @param type [Symbol, Lithic::Models::FinancialTransaction::Event::Type]
-
-        # APPROVED financial events were successful while DECLINED financial events were
-        # declined by user, Lithic, or the network.
-        #
-        # @see Lithic::Models::FinancialTransaction::Event#result
-        module Result
-          extend Lithic::Internal::Type::Enum
-
-          APPROVED = :APPROVED
-          DECLINED = :DECLINED
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-
-        # @see Lithic::Models::FinancialTransaction::Event#type
-        module Type
-          extend Lithic::Internal::Type::Enum
-
-          ACH_ORIGINATION_CANCELLED = :ACH_ORIGINATION_CANCELLED
-          ACH_ORIGINATION_INITIATED = :ACH_ORIGINATION_INITIATED
-          ACH_ORIGINATION_PROCESSED = :ACH_ORIGINATION_PROCESSED
-          ACH_ORIGINATION_RELEASED = :ACH_ORIGINATION_RELEASED
-          ACH_ORIGINATION_REJECTED = :ACH_ORIGINATION_REJECTED
-          ACH_ORIGINATION_REVIEWED = :ACH_ORIGINATION_REVIEWED
-          ACH_ORIGINATION_SETTLED = :ACH_ORIGINATION_SETTLED
-          ACH_RECEIPT_PROCESSED = :ACH_RECEIPT_PROCESSED
-          ACH_RECEIPT_RELEASED = :ACH_RECEIPT_RELEASED
-          ACH_RECEIPT_SETTLED = :ACH_RECEIPT_SETTLED
-          ACH_RETURN_INITIATED = :ACH_RETURN_INITIATED
-          ACH_RETURN_PROCESSED = :ACH_RETURN_PROCESSED
-          ACH_RETURN_REJECTED = :ACH_RETURN_REJECTED
-          ACH_RETURN_SETTLED = :ACH_RETURN_SETTLED
-          AUTHORIZATION = :AUTHORIZATION
-          AUTHORIZATION_ADVICE = :AUTHORIZATION_ADVICE
-          AUTHORIZATION_EXPIRY = :AUTHORIZATION_EXPIRY
-          AUTHORIZATION_REVERSAL = :AUTHORIZATION_REVERSAL
-          BALANCE_INQUIRY = :BALANCE_INQUIRY
-          BILLING_ERROR = :BILLING_ERROR
-          BILLING_ERROR_REVERSAL = :BILLING_ERROR_REVERSAL
-          CARD_TO_CARD = :CARD_TO_CARD
-          CASH_BACK = :CASH_BACK
-          CASH_BACK_REVERSAL = :CASH_BACK_REVERSAL
-          CLEARING = :CLEARING
-          COLLECTION = :COLLECTION
-          CORRECTION_CREDIT = :CORRECTION_CREDIT
-          CORRECTION_DEBIT = :CORRECTION_DEBIT
-          CREDIT_AUTHORIZATION = :CREDIT_AUTHORIZATION
-          CREDIT_AUTHORIZATION_ADVICE = :CREDIT_AUTHORIZATION_ADVICE
-          CURRENCY_CONVERSION = :CURRENCY_CONVERSION
-          CURRENCY_CONVERSION_REVERSAL = :CURRENCY_CONVERSION_REVERSAL
-          DISPUTE_WON = :DISPUTE_WON
-          EXTERNAL_ACH_CANCELED = :EXTERNAL_ACH_CANCELED
-          EXTERNAL_ACH_INITIATED = :EXTERNAL_ACH_INITIATED
-          EXTERNAL_ACH_RELEASED = :EXTERNAL_ACH_RELEASED
-          EXTERNAL_ACH_REVERSED = :EXTERNAL_ACH_REVERSED
-          EXTERNAL_ACH_SETTLED = :EXTERNAL_ACH_SETTLED
-          EXTERNAL_CHECK_CANCELED = :EXTERNAL_CHECK_CANCELED
-          EXTERNAL_CHECK_INITIATED = :EXTERNAL_CHECK_INITIATED
-          EXTERNAL_CHECK_RELEASED = :EXTERNAL_CHECK_RELEASED
-          EXTERNAL_CHECK_REVERSED = :EXTERNAL_CHECK_REVERSED
-          EXTERNAL_CHECK_SETTLED = :EXTERNAL_CHECK_SETTLED
-          EXTERNAL_TRANSFER_CANCELED = :EXTERNAL_TRANSFER_CANCELED
-          EXTERNAL_TRANSFER_INITIATED = :EXTERNAL_TRANSFER_INITIATED
-          EXTERNAL_TRANSFER_RELEASED = :EXTERNAL_TRANSFER_RELEASED
-          EXTERNAL_TRANSFER_REVERSED = :EXTERNAL_TRANSFER_REVERSED
-          EXTERNAL_TRANSFER_SETTLED = :EXTERNAL_TRANSFER_SETTLED
-          EXTERNAL_WIRE_CANCELED = :EXTERNAL_WIRE_CANCELED
-          EXTERNAL_WIRE_INITIATED = :EXTERNAL_WIRE_INITIATED
-          EXTERNAL_WIRE_RELEASED = :EXTERNAL_WIRE_RELEASED
-          EXTERNAL_WIRE_REVERSED = :EXTERNAL_WIRE_REVERSED
-          EXTERNAL_WIRE_SETTLED = :EXTERNAL_WIRE_SETTLED
-          FINANCIAL_AUTHORIZATION = :FINANCIAL_AUTHORIZATION
-          FINANCIAL_CREDIT_AUTHORIZATION = :FINANCIAL_CREDIT_AUTHORIZATION
-          INTEREST = :INTEREST
-          INTEREST_REVERSAL = :INTEREST_REVERSAL
-          INTERNAL_ADJUSTMENT = :INTERNAL_ADJUSTMENT
-          LATE_PAYMENT = :LATE_PAYMENT
-          LATE_PAYMENT_REVERSAL = :LATE_PAYMENT_REVERSAL
-          LOSS_WRITE_OFF = :LOSS_WRITE_OFF
-          PROVISIONAL_CREDIT = :PROVISIONAL_CREDIT
-          PROVISIONAL_CREDIT_REVERSAL = :PROVISIONAL_CREDIT_REVERSAL
-          SERVICE = :SERVICE
-          RETURN = :RETURN
-          RETURN_REVERSAL = :RETURN_REVERSAL
-          TRANSFER = :TRANSFER
-          TRANSFER_INSUFFICIENT_FUNDS = :TRANSFER_INSUFFICIENT_FUNDS
-          RETURNED_PAYMENT = :RETURNED_PAYMENT
-          RETURNED_PAYMENT_REVERSAL = :RETURNED_PAYMENT_REVERSAL
-          LITHIC_NETWORK_PAYMENT = :LITHIC_NETWORK_PAYMENT
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-      end
-
       # APPROVED transactions were successful while DECLINED transactions were declined
       # by user, Lithic, or the network.
       #

data/lib/lithic/models/{funding_event_retrieve_response.rb → funding_event.rb}

@@ -3,7 +3,7 @@
 module Lithic
   module Models
     # @see Lithic::Resources::FundingEvents#retrieve
-    class FundingEventRetrieveResponse < Lithic::Internal::Type::BaseModel
+    class FundingEvent < Lithic::Internal::Type::BaseModel
       # @!attribute token
       #   Unique token ID
       #
@@ -13,9 +13,8 @@ module Lithic
       # @!attribute collection_resource_type
       #   Collection resource type
       #
-      #   @return [Symbol, Lithic::Models::FundingEventRetrieveResponse::CollectionResourceType]
-      required :collection_resource_type,
-               enum: -> { Lithic::Models::FundingEventRetrieveResponse::CollectionResourceType }
+      #   @return [Symbol, Lithic::Models::FundingEvent::CollectionResourceType]
+      required :collection_resource_type, enum: -> { Lithic::FundingEvent::CollectionResourceType }
 
       # @!attribute collection_tokens
       #   IDs of collections, further information can be gathered from the appropriate
@@ -39,9 +38,9 @@ module Lithic
       # @!attribute network_settlement_summary
       #   Network settlement summary breakdown by network settlement date
       #
-      #   @return [Array<Lithic::Models::FundingEventRetrieveResponse::NetworkSettlementSummary>]
+      #   @return [Array<Lithic::Models::FundingEvent::NetworkSettlementSummary>]
       required :network_settlement_summary,
-               -> { Lithic::Internal::Type::ArrayOf[Lithic::Models::FundingEventRetrieveResponse::NetworkSettlementSummary] }
+               -> { Lithic::Internal::Type::ArrayOf[Lithic::FundingEvent::NetworkSettlementSummary] }
 
       # @!attribute previous_high_watermark
       #   Time of the previous high watermark
@@ -57,11 +56,11 @@ module Lithic
 
       # @!method initialize(token:, collection_resource_type:, collection_tokens:, created:, high_watermark:, network_settlement_summary:, previous_high_watermark:, updated:)
       #   Some parameter documentations has been truncated, see
-      #   {Lithic::Models::FundingEventRetrieveResponse} for more details.
+      #   {Lithic::Models::FundingEvent} for more details.
       #
       #   @param token [String] Unique token ID
       #
-      #   @param collection_resource_type [Symbol, Lithic::Models::FundingEventRetrieveResponse::CollectionResourceType] Collection resource type
+      #   @param collection_resource_type [Symbol, Lithic::Models::FundingEvent::CollectionResourceType] Collection resource type
       #
       #   @param collection_tokens [Array<String>] IDs of collections, further information can be gathered from the appropriate col
       #
@@ -69,7 +68,7 @@ module Lithic
       #
       #   @param high_watermark [Time] Time of the high watermark
       #
-      #   @param network_settlement_summary [Array<Lithic::Models::FundingEventRetrieveResponse::NetworkSettlementSummary>] Network settlement summary breakdown by network settlement date
+      #   @param network_settlement_summary [Array<Lithic::Models::FundingEvent::NetworkSettlementSummary>] Network settlement summary breakdown by network settlement date
       #
       #   @param previous_high_watermark [Time] Time of the previous high watermark
       #
@@ -77,7 +76,7 @@ module Lithic
 
       # Collection resource type
       #
-      # @see Lithic::Models::FundingEventRetrieveResponse#collection_resource_type
+      # @see Lithic::Models::FundingEvent#collection_resource_type
       module CollectionResourceType
         extend Lithic::Internal::Type::Enum
 

data/lib/lithic/models/internal_transaction.rb

@@ -0,0 +1,166 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    class InternalTransactionAPI < Lithic::Internal::Type::BaseModel
+      # @!attribute token
+      #
+      #   @return [String]
+      required :token, String
+
+      # @!attribute category
+      #
+      #   @return [Symbol, Lithic::Models::InternalTransactionAPI::Category]
+      required :category, enum: -> { Lithic::InternalTransactionAPI::Category }
+
+      # @!attribute created
+      #
+      #   @return [Time]
+      required :created, Time
+
+      # @!attribute currency
+      #
+      #   @return [String]
+      required :currency, String
+
+      # @!attribute descriptor
+      #
+      #   @return [String]
+      required :descriptor, String
+
+      # @!attribute events
+      #
+      #   @return [Array<Lithic::Models::InternalTransactionAPI::Event>]
+      required :events, -> { Lithic::Internal::Type::ArrayOf[Lithic::InternalTransactionAPI::Event] }
+
+      # @!attribute pending_amount
+      #
+      #   @return [Integer]
+      required :pending_amount, Integer
+
+      # @!attribute result
+      #
+      #   @return [Symbol, Lithic::Models::InternalTransactionAPI::Result]
+      required :result, enum: -> { Lithic::InternalTransactionAPI::Result }
+
+      # @!attribute settled_amount
+      #
+      #   @return [Integer]
+      required :settled_amount, Integer
+
+      # @!attribute status
+      #
+      #   @return [Symbol, Lithic::Models::InternalTransactionAPI::Status]
+      required :status, enum: -> { Lithic::InternalTransactionAPI::Status }
+
+      # @!attribute updated
+      #
+      #   @return [Time]
+      required :updated, Time
+
+      # @!method initialize(token:, category:, created:, currency:, descriptor:, events:, pending_amount:, result:, settled_amount:, status:, updated:)
+      #   @param token [String]
+      #   @param category [Symbol, Lithic::Models::InternalTransactionAPI::Category]
+      #   @param created [Time]
+      #   @param currency [String]
+      #   @param descriptor [String]
+      #   @param events [Array<Lithic::Models::InternalTransactionAPI::Event>]
+      #   @param pending_amount [Integer]
+      #   @param result [Symbol, Lithic::Models::InternalTransactionAPI::Result]
+      #   @param settled_amount [Integer]
+      #   @param status [Symbol, Lithic::Models::InternalTransactionAPI::Status]
+      #   @param updated [Time]
+
+      # @see Lithic::Models::InternalTransactionAPI#category
+      module Category
+        extend Lithic::Internal::Type::Enum
+
+        INTERNAL = :INTERNAL
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      class Event < Lithic::Internal::Type::BaseModel
+        # @!attribute token
+        #
+        #   @return [String]
+        required :token, String
+
+        # @!attribute amount
+        #
+        #   @return [Integer]
+        required :amount, Integer
+
+        # @!attribute created
+        #
+        #   @return [Time]
+        required :created, Time
+
+        # @!attribute result
+        #
+        #   @return [Symbol, Lithic::Models::InternalTransactionAPI::Event::Result]
+        required :result, enum: -> { Lithic::InternalTransactionAPI::Event::Result }
+
+        # @!attribute type
+        #
+        #   @return [Symbol, Lithic::Models::InternalTransactionAPI::Event::Type]
+        required :type, enum: -> { Lithic::InternalTransactionAPI::Event::Type }
+
+        # @!method initialize(token:, amount:, created:, result:, type:)
+        #   @param token [String]
+        #   @param amount [Integer]
+        #   @param created [Time]
+        #   @param result [Symbol, Lithic::Models::InternalTransactionAPI::Event::Result]
+        #   @param type [Symbol, Lithic::Models::InternalTransactionAPI::Event::Type]
+
+        # @see Lithic::Models::InternalTransactionAPI::Event#result
+        module Result
+          extend Lithic::Internal::Type::Enum
+
+          APPROVED = :APPROVED
+          DECLINED = :DECLINED
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # @see Lithic::Models::InternalTransactionAPI::Event#type
+        module Type
+          extend Lithic::Internal::Type::Enum
+
+          INTERNAL_ADJUSTMENT = :INTERNAL_ADJUSTMENT
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
+      # @see Lithic::Models::InternalTransactionAPI#result
+      module Result
+        extend Lithic::Internal::Type::Enum
+
+        APPROVED = :APPROVED
+        DECLINED = :DECLINED
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # @see Lithic::Models::InternalTransactionAPI#status
+      module Status
+        extend Lithic::Internal::Type::Enum
+
+        PENDING = :PENDING
+        SETTLED = :SETTLED
+        DECLINED = :DECLINED
+        REVERSED = :REVERSED
+        CANCELED = :CANCELED
+        RETURNED = :RETURNED
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/lithic/models/management_operation_create_params.rb

@@ -133,6 +133,12 @@ module Lithic
         DISPUTE_WON_REVERSAL = :DISPUTE_WON_REVERSAL
         DISBURSE = :DISBURSE
         DISBURSE_REVERSAL = :DISBURSE_REVERSAL
+        ANNUAL = :ANNUAL
+        ANNUAL_REVERSAL = :ANNUAL_REVERSAL
+        QUARTERLY = :QUARTERLY
+        QUARTERLY_REVERSAL = :QUARTERLY_REVERSAL
+        MONTHLY = :MONTHLY
+        MONTHLY_REVERSAL = :MONTHLY_REVERSAL
 
         # @!method self.values
         #   @return [Array<Symbol>]

data/lib/lithic/models/management_operation_list_params.rb

@@ -112,6 +112,7 @@ module Lithic
         DECLINED = :DECLINED
         REVERSED = :REVERSED
         CANCELED = :CANCELED
+        RETURNED = :RETURNED
 
         # @!method self.values
         #   @return [Array<Symbol>]

data/lib/lithic/models/management_operation_transaction.rb

@@ -92,7 +92,7 @@ module Lithic
       # @!attribute user_defined_id
       #
       #   @return [String, nil]
-      optional :user_defined_id, String
+      optional :user_defined_id, String, nil?: true
 
       # @!method initialize(token:, created:, status:, updated:, category: nil, currency: nil, direction: nil, events: nil, external_resource: nil, family: nil, financial_account_token: nil, pending_amount: nil, result: nil, settled_amount: nil, transaction_series: nil, user_defined_id: nil)
       #   @param token [String] Unique identifier for the transaction
@@ -125,7 +125,7 @@ module Lithic
       #
       #   @param transaction_series [Lithic::Models::ManagementOperationTransaction::TransactionSeries, nil]
       #
-      #   @param user_defined_id [String]
+      #   @param user_defined_id [String, nil]
 
       # The status of the transaction
       #
@@ -138,6 +138,7 @@ module Lithic
         DECLINED = :DECLINED
         REVERSED = :REVERSED
         CANCELED = :CANCELED
+        RETURNED = :RETURNED
 
         # @!method self.values
         #   @return [Array<Symbol>]
@@ -213,7 +214,7 @@ module Lithic
         # @!attribute subtype
         #
         #   @return [String, nil]
-        optional :subtype, String
+        optional :subtype, String, nil?: true
 
         # @!method initialize(token:, amount:, created:, detailed_results:, effective_date:, memo:, result:, type:, subtype: nil)
         #   @param token [String]
@@ -224,7 +225,7 @@ module Lithic
         #   @param memo [String]
         #   @param result [Symbol, Lithic::Models::ManagementOperationTransaction::Event::Result]
         #   @param type [Symbol, Lithic::Models::ManagementOperationTransaction::Event::Type]
-        #   @param subtype [String]
+        #   @param subtype [String, nil]
 
         module DetailedResult
           extend Lithic::Internal::Type::Enum
@@ -270,6 +271,12 @@ module Lithic
           DISPUTE_WON_REVERSAL = :DISPUTE_WON_REVERSAL
           DISBURSE = :DISBURSE
           DISBURSE_REVERSAL = :DISBURSE_REVERSAL
+          ANNUAL = :ANNUAL
+          ANNUAL_REVERSAL = :ANNUAL_REVERSAL
+          QUARTERLY = :QUARTERLY
+          QUARTERLY_REVERSAL = :QUARTERLY_REVERSAL
+          MONTHLY = :MONTHLY
+          MONTHLY_REVERSAL = :MONTHLY_REVERSAL
 
           # @!method self.values
           #   @return [Array<Symbol>]

data/lib/lithic/models/merchant.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    class Merchant < Lithic::Internal::Type::BaseModel
+      # @!attribute acceptor_id
+      #   Unique alphanumeric identifier for the payment card acceptor (merchant).
+      #
+      #   @return [String]
+      required :acceptor_id, String
+
+      # @!attribute acquiring_institution_id
+      #   Unique numeric identifier of the acquiring institution.
+      #
+      #   @return [String]
+      required :acquiring_institution_id, String
+
+      # @!attribute city
+      #   City of card acceptor. Note that in many cases, particularly in card-not-present
+      #   transactions, merchants may send through a phone number or URL in this field.
+      #
+      #   @return [String]
+      required :city, String
+
+      # @!attribute country
+      #   Country or entity of card acceptor. Possible values are: (1) all ISO 3166-1
+      #   alpha-3 country codes, (2) QZZ for Kosovo, and (3) ANT for Netherlands Antilles.
+      #
+      #   @return [String]
+      required :country, String
+
+      # @!attribute descriptor
+      #   Short description of card acceptor.
+      #
+      #   @return [String]
+      required :descriptor, String
+
+      # @!attribute mcc
+      #   Merchant category code (MCC). A four-digit number listed in ISO 18245. An MCC is
+      #   used to classify a business by the types of goods or services it provides.
+      #
+      #   @return [String]
+      required :mcc, String
+
+      # @!attribute state
+      #   Geographic state of card acceptor.
+      #
+      #   @return [String]
+      required :state, String
+
+      # @!method initialize(acceptor_id:, acquiring_institution_id:, city:, country:, descriptor:, mcc:, state:)
+      #   Some parameter documentations has been truncated, see {Lithic::Models::Merchant}
+      #   for more details.
+      #
+      #   @param acceptor_id [String] Unique alphanumeric identifier for the payment card acceptor (merchant).
+      #
+      #   @param acquiring_institution_id [String] Unique numeric identifier of the acquiring institution.
+      #
+      #   @param city [String] City of card acceptor. Note that in many cases, particularly in card-not-present
+      #
+      #   @param country [String] Country or entity of card acceptor. Possible values are: (1) all ISO 3166-1 alph
+      #
+      #   @param descriptor [String] Short description of card acceptor.
+      #
+      #   @param mcc [String] Merchant category code (MCC). A four-digit number listed in ISO 18245. An MCC is
+      #
+      #   @param state [String] Geographic state of card acceptor.
+    end
+  end
+end