lithic 0.1.0.pre.alpha.56 → 0.2.0

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/internal_transaction_created_webhook_event.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    class InternalTransactionCreatedWebhookEvent < Lithic::Models::InternalTransactionAPI
+      # @!attribute event_type
+      #   The type of event that occurred.
+      #
+      #   @return [Symbol, :"internal_transaction.created"]
+      required :event_type, const: :"internal_transaction.created"
+
+      # @!method initialize(event_type: :"internal_transaction.created")
+      #   @param event_type [Symbol, :"internal_transaction.created"] The type of event that occurred.
+    end
+  end
+end

data/lib/lithic/models/internal_transaction_updated_webhook_event.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    class InternalTransactionUpdatedWebhookEvent < Lithic::Models::InternalTransactionAPI
+      # @!attribute event_type
+      #   The type of event that occurred.
+      #
+      #   @return [Symbol, :"internal_transaction.updated"]
+      required :event_type, const: :"internal_transaction.updated"
+
+      # @!method initialize(event_type: :"internal_transaction.updated")
+      #   @param event_type [Symbol, :"internal_transaction.updated"] The type of event that occurred.
+    end
+  end
+end

data/lib/lithic/models/loan_tape_created_webhook_event.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    class LoanTapeCreatedWebhookEvent < Lithic::Models::FinancialAccounts::LoanTape
+      # @!attribute event_type
+      #   The type of event that occurred.
+      #
+      #   @return [Symbol, :"loan_tape.created"]
+      required :event_type, const: :"loan_tape.created"
+
+      # @!method initialize(event_type: :"loan_tape.created")
+      #   @param event_type [Symbol, :"loan_tape.created"] The type of event that occurred.
+    end
+  end
+end

data/lib/lithic/models/loan_tape_updated_webhook_event.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    class LoanTapeUpdatedWebhookEvent < Lithic::Models::FinancialAccounts::LoanTape
+      # @!attribute event_type
+      #   The type of event that occurred.
+      #
+      #   @return [Symbol, :"loan_tape.updated"]
+      required :event_type, const: :"loan_tape.updated"
+
+      # @!method initialize(event_type: :"loan_tape.updated")
+      #   @param event_type [Symbol, :"loan_tape.updated"] The type of event that occurred.
+    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_created_webhook_event.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    class ManagementOperationCreatedWebhookEvent < Lithic::Models::ManagementOperationTransaction
+      # @!attribute event_type
+      #   The type of event that occurred.
+      #
+      #   @return [Symbol, :"management_operation.created"]
+      required :event_type, const: :"management_operation.created"
+
+      # @!method initialize(event_type: :"management_operation.created")
+      #   @param event_type [Symbol, :"management_operation.created"] The type of event that occurred.
+    end
+  end
+end

data/lib/lithic/models/management_operation_transaction.rb

@@ -271,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/management_operation_updated_webhook_event.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    class ManagementOperationUpdatedWebhookEvent < Lithic::Models::ManagementOperationTransaction
+      # @!attribute event_type
+      #   The type of event that occurred.
+      #
+      #   @return [Symbol, :"management_operation.updated"]
+      required :event_type, const: :"management_operation.updated"
+
+      # @!method initialize(event_type: :"management_operation.updated")
+      #   @param event_type [Symbol, :"management_operation.updated"] The type of event that occurred.
+    end
+  end
+end

data/lib/lithic/models/network_total.rb

@@ -0,0 +1,169 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    class NetworkTotal < Lithic::Internal::Type::BaseModel
+      # @!attribute token
+      #   Globally unique identifier.
+      #
+      #   @return [String]
+      required :token, String
+
+      # @!attribute amounts
+      #
+      #   @return [Lithic::Models::NetworkTotal::Amounts]
+      required :amounts, -> { Lithic::NetworkTotal::Amounts }
+
+      # @!attribute created
+      #   RFC 3339 timestamp for when the record was created. UTC time zone.
+      #
+      #   @return [Time]
+      required :created, Time
+
+      # @!attribute currency
+      #   3-character alphabetic ISO 4217 code.
+      #
+      #   @return [String]
+      required :currency, String
+
+      # @!attribute institution_id
+      #   The institution that activity occurred on. For Mastercard: ICA (Interbank Card
+      #   Association). For Maestro: institution ID. For Visa: lowest level SRE
+      #   (Settlement Reporting Entity).
+      #
+      #   @return [String]
+      required :institution_id, String
+
+      # @!attribute is_complete
+      #   Indicates that all settlement records related to this Network Total are
+      #   available in the details endpoint.
+      #
+      #   @return [Boolean]
+      required :is_complete, Lithic::Internal::Type::Boolean
+
+      # @!attribute network
+      #   Card network where the transaction took place. AMEX, VISA, MASTERCARD, MAESTRO,
+      #   or INTERLINK.
+      #
+      #   @return [Symbol, Lithic::Models::NetworkTotal::Network]
+      required :network, enum: -> { Lithic::NetworkTotal::Network }
+
+      # @!attribute report_date
+      #   Date that the network total record applies to. YYYY-MM-DD format.
+      #
+      #   @return [Date]
+      required :report_date, Date
+
+      # @!attribute settlement_institution_id
+      #   The institution responsible for settlement. For Mastercard: same as
+      #   `institution_id`. For Maestro: billing ICA. For Visa: Funds Transfer SRE
+      #   (FTSRE).
+      #
+      #   @return [String]
+      required :settlement_institution_id, String
+
+      # @!attribute settlement_service
+      #   Settlement service.
+      #
+      #   @return [String]
+      required :settlement_service, String
+
+      # @!attribute updated
+      #   RFC 3339 timestamp for when the record was last updated. UTC time zone.
+      #
+      #   @return [Time]
+      required :updated, Time
+
+      # @!attribute cycle
+      #   The clearing cycle that the network total record applies to. Mastercard only.
+      #
+      #   @return [Integer, nil]
+      optional :cycle, Integer
+
+      # @!method initialize(token:, amounts:, created:, currency:, institution_id:, is_complete:, network:, report_date:, settlement_institution_id:, settlement_service:, updated:, cycle: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Lithic::Models::NetworkTotal} for more details.
+      #
+      #   @param token [String] Globally unique identifier.
+      #
+      #   @param amounts [Lithic::Models::NetworkTotal::Amounts]
+      #
+      #   @param created [Time] RFC 3339 timestamp for when the record was created. UTC time zone.
+      #
+      #   @param currency [String] 3-character alphabetic ISO 4217 code.
+      #
+      #   @param institution_id [String] The institution that activity occurred on. For Mastercard: ICA (Interbank Card A
+      #
+      #   @param is_complete [Boolean] Indicates that all settlement records related to this Network Total are availabl
+      #
+      #   @param network [Symbol, Lithic::Models::NetworkTotal::Network] Card network where the transaction took place. AMEX, VISA, MASTERCARD, MAESTRO,
+      #
+      #   @param report_date [Date] Date that the network total record applies to. YYYY-MM-DD format.
+      #
+      #   @param settlement_institution_id [String] The institution responsible for settlement. For Mastercard: same as `institution
+      #
+      #   @param settlement_service [String] Settlement service.
+      #
+      #   @param updated [Time] RFC 3339 timestamp for when the record was last updated. UTC time zone.
+      #
+      #   @param cycle [Integer] The clearing cycle that the network total record applies to. Mastercard only.
+
+      # @see Lithic::Models::NetworkTotal#amounts
+      class Amounts < Lithic::Internal::Type::BaseModel
+        # @!attribute gross_settlement
+        #   Total settlement amount excluding interchange, in currency's smallest unit.
+        #
+        #   @return [Integer]
+        required :gross_settlement, Integer
+
+        # @!attribute interchange_fees
+        #   Interchange amount, in currency's smallest unit.
+        #
+        #   @return [Integer]
+        required :interchange_fees, Integer
+
+        # @!attribute net_settlement
+        #   `gross_settlement` net of `interchange_fees` and `visa_charges` (if applicable),
+        #   in currency's smallest unit.
+        #
+        #   @return [Integer]
+        required :net_settlement, Integer
+
+        # @!attribute visa_charges
+        #   Charges specific to Visa/Interlink, in currency's smallest unit.
+        #
+        #   @return [Integer, nil]
+        optional :visa_charges, Integer
+
+        # @!method initialize(gross_settlement:, interchange_fees:, net_settlement:, visa_charges: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Lithic::Models::NetworkTotal::Amounts} for more details.
+        #
+        #   @param gross_settlement [Integer] Total settlement amount excluding interchange, in currency's smallest unit.
+        #
+        #   @param interchange_fees [Integer] Interchange amount, in currency's smallest unit.
+        #
+        #   @param net_settlement [Integer] `gross_settlement` net of `interchange_fees` and `visa_charges` (if applicable),
+        #
+        #   @param visa_charges [Integer] Charges specific to Visa/Interlink, in currency's smallest unit.
+      end
+
+      # Card network where the transaction took place. AMEX, VISA, MASTERCARD, MAESTRO,
+      # or INTERLINK.
+      #
+      # @see Lithic::Models::NetworkTotal#network
+      module Network
+        extend Lithic::Internal::Type::Enum
+
+        AMEX = :AMEX
+        VISA = :VISA
+        MASTERCARD = :MASTERCARD
+        MAESTRO = :MAESTRO
+        INTERLINK = :INTERLINK
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/lithic/models/network_total_created_webhook_event.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    class NetworkTotalCreatedWebhookEvent < Lithic::Models::NetworkTotal
+      # @!attribute event_type
+      #   The type of event that occurred.
+      #
+      #   @return [Symbol, :"network_total.created"]
+      required :event_type, const: :"network_total.created"
+
+      # @!method initialize(event_type: :"network_total.created")
+      #   @param event_type [Symbol, :"network_total.created"] The type of event that occurred.
+    end
+  end
+end

data/lib/lithic/models/network_total_updated_webhook_event.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    class NetworkTotalUpdatedWebhookEvent < Lithic::Models::NetworkTotal
+      # @!attribute event_type
+      #   The type of event that occurred.
+      #
+      #   @return [Symbol, :"network_total.updated"]
+      required :event_type, const: :"network_total.updated"
+
+      # @!method initialize(event_type: :"network_total.updated")
+      #   @param event_type [Symbol, :"network_total.updated"] The type of event that occurred.
+    end
+  end
+end

data/lib/lithic/models/non_pci_card.rb

@@ -117,6 +117,13 @@ module Lithic
       #   @return [Array<String>, nil]
       optional :auth_rule_tokens, Lithic::Internal::Type::ArrayOf[String]
 
+      # @!attribute bulk_order_token
+      #   Globally unique identifier for the bulk order associated with this card. Only
+      #   applicable to physical cards that are part of a bulk shipment
+      #
+      #   @return [String, nil]
+      optional :bulk_order_token, String, nil?: true
+
       # @!attribute cardholder_currency
       #   3-character alphabetic ISO 4217 code for the currency of the cardholder.
       #
@@ -217,7 +224,7 @@ module Lithic
       #   @return [Symbol, Lithic::Models::NonPCICard::Substatus, nil]
       optional :substatus, enum: -> { Lithic::NonPCICard::Substatus }
 
-      # @!method initialize(token:, account_token:, card_program_token:, created:, funding:, last_four:, pin_status:, spend_limit:, spend_limit_duration:, state:, type:, auth_rule_tokens: nil, cardholder_currency: nil, comment: nil, digital_card_art_token: nil, exp_month: nil, exp_year: nil, hostname: nil, memo: nil, network_program_token: nil, pending_commands: nil, product_id: nil, replacement_for: nil, substatus: nil)
+      # @!method initialize(token:, account_token:, card_program_token:, created:, funding:, last_four:, pin_status:, spend_limit:, spend_limit_duration:, state:, type:, auth_rule_tokens: nil, bulk_order_token: nil, cardholder_currency: nil, comment: nil, digital_card_art_token: nil, exp_month: nil, exp_year: nil, hostname: nil, memo: nil, network_program_token: nil, pending_commands: nil, product_id: nil, replacement_for: nil, substatus: nil)
       #   Some parameter documentations has been truncated, see
       #   {Lithic::Models::NonPCICard} for more details.
       #
@@ -249,6 +256,8 @@ module Lithic
       #
       #   @param auth_rule_tokens [Array<String>] List of identifiers for the Auth Rule(s) that are applied on the card. This fiel
       #
+      #   @param bulk_order_token [String, nil] Globally unique identifier for the bulk order associated with this card. Only ap
+      #
       #   @param cardholder_currency [String] 3-character alphabetic ISO 4217 code for the currency of the cardholder.
       #
       #   @param comment [String] Additional context or information related to the card.