lithic 0.1.0.pre.alpha.38 → 0.1.0.pre.alpha.40

data/lib/lithic/models/external_resource.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    class ExternalResource < Lithic::Internal::Type::BaseModel
+      # @!attribute external_resource_token
+      #   Token identifying the external resource
+      #
+      #   @return [String]
+      required :external_resource_token, String
+
+      # @!attribute external_resource_type
+      #   Type of external resource associated with the management operation
+      #
+      #   @return [Symbol, Lithic::Models::ExternalResourceType]
+      required :external_resource_type, enum: -> { Lithic::ExternalResourceType }
+
+      # @!attribute external_resource_sub_token
+      #   Token identifying the external resource sub-resource
+      #
+      #   @return [String, nil]
+      optional :external_resource_sub_token, String
+
+      # @!method initialize(external_resource_token:, external_resource_type:, external_resource_sub_token: nil)
+      #   External resource associated with the management operation
+      #
+      #   @param external_resource_token [String] Token identifying the external resource
+      #
+      #   @param external_resource_type [Symbol, Lithic::Models::ExternalResourceType] Type of external resource associated with the management operation
+      #
+      #   @param external_resource_sub_token [String] Token identifying the external resource sub-resource
+    end
+  end
+end

data/lib/lithic/models/external_resource_type.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    # Type of external resource associated with the management operation
+    module ExternalResourceType
+      extend Lithic::Internal::Type::Enum
+
+      STATEMENT = :STATEMENT
+      COLLECTION = :COLLECTION
+      DISPUTE = :DISPUTE
+      UNKNOWN = :UNKNOWN
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/lithic/models/financial_account_list_params.rb

@@ -41,6 +41,7 @@ module Lithic
         ISSUING = :ISSUING
         OPERATING = :OPERATING
         RESERVE = :RESERVE
+        SECURITY = :SECURITY
 
         # @!method self.values
         #   @return [Array<Symbol>]

data/lib/lithic/models/financial_accounts/balance_list_response.rb

@@ -104,6 +104,7 @@ module Lithic
           ISSUING = :ISSUING
           OPERATING = :OPERATING
           RESERVE = :RESERVE
+          SECURITY = :SECURITY
 
           # @!method self.values
           #   @return [Array<Symbol>]

data/lib/lithic/models/management_operation_create_params.rb

@@ -47,6 +47,12 @@ module Lithic
       #   @return [String, nil]
       optional :memo, String
 
+      # @!attribute on_closed_account
+      #   What to do if the financial account is closed when posting an operation
+      #
+      #   @return [Symbol, Lithic::Models::ManagementOperationCreateParams::OnClosedAccount, nil]
+      optional :on_closed_account, enum: -> { Lithic::ManagementOperationCreateParams::OnClosedAccount }
+
       # @!attribute subtype
       #
       #   @return [String, nil]
@@ -57,17 +63,29 @@ module Lithic
       #   @return [String, nil]
       optional :user_defined_id, String
 
-      # @!method initialize(amount:, category:, direction:, effective_date:, event_type:, financial_account_token:, token: nil, memo: nil, subtype: nil, user_defined_id: nil, request_options: {})
+      # @!method initialize(amount:, category:, direction:, effective_date:, event_type:, financial_account_token:, token: nil, memo: nil, on_closed_account: nil, subtype: nil, user_defined_id: nil, request_options: {})
       #   @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 on_closed_account [Symbol, Lithic::Models::ManagementOperationCreateParams::OnClosedAccount] What to do if the financial account is closed when posting an operation
+      #
       #   @param subtype [String]
+      #
       #   @param user_defined_id [String]
+      #
       #   @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
 
       module Category
@@ -119,6 +137,17 @@ module Lithic
         # @!method self.values
         #   @return [Array<Symbol>]
       end
+
+      # What to do if the financial account is closed when posting an operation
+      module OnClosedAccount
+        extend Lithic::Internal::Type::Enum
+
+        FAIL = :FAIL
+        USE_SUSPENSE = :USE_SUSPENSE
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
     end
   end
 end

data/lib/lithic/models/management_operation_transaction.rb

@@ -73,25 +73,46 @@ module Lithic
       #   @return [Time]
       required :updated, Time
 
+      # @!attribute external_resource
+      #   External resource associated with the management operation
+      #
+      #   @return [Lithic::Models::ExternalResource, nil]
+      optional :external_resource, -> { Lithic::ExternalResource }, nil?: true
+
       # @!attribute user_defined_id
       #
       #   @return [String, nil]
       optional :user_defined_id, String
 
-      # @!method initialize(token:, category:, created:, currency:, direction:, events:, financial_account_token:, pending_amount:, result:, settled_amount:, status:, transaction_series:, updated:, user_defined_id: nil)
+      # @!method initialize(token:, category:, created:, currency:, direction:, events:, financial_account_token:, pending_amount:, result:, settled_amount:, status:, transaction_series:, updated:, external_resource: nil, user_defined_id: nil)
       #   @param token [String]
+      #
       #   @param category [Symbol, Lithic::Models::ManagementOperationTransaction::Category]
+      #
       #   @param created [Time]
+      #
       #   @param currency [String]
+      #
       #   @param direction [Symbol, Lithic::Models::ManagementOperationTransaction::Direction]
+      #
       #   @param events [Array<Lithic::Models::ManagementOperationTransaction::Event>]
+      #
       #   @param financial_account_token [String]
+      #
       #   @param pending_amount [Integer]
+      #
       #   @param result [Symbol, Lithic::Models::ManagementOperationTransaction::Result]
+      #
       #   @param settled_amount [Integer]
+      #
       #   @param status [Symbol, Lithic::Models::ManagementOperationTransaction::Status]
+      #
       #   @param transaction_series [Lithic::Models::ManagementOperationTransaction::TransactionSeries, nil]
+      #
       #   @param updated [Time]
+      #
+      #   @param external_resource [Lithic::Models::ExternalResource, nil] External resource associated with the management operation
+      #
       #   @param user_defined_id [String]
 
       # @see Lithic::Models::ManagementOperationTransaction#category

data/lib/lithic/models/network_program.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    # @see Lithic::Resources::NetworkPrograms#retrieve
+    class NetworkProgram < Lithic::Internal::Type::BaseModel
+      # @!attribute token
+      #   Lithic-generated unique identifier for the program
+      #
+      #   @return [String]
+      required :token, String
+
+      # @!attribute default_product_code
+      #   Network product ID associated with this program.
+      #
+      #   @return [String]
+      required :default_product_code, String
+
+      # @!attribute name
+      #   The name of the network program.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute registered_program_identification_number
+      #   RPIN value assigned by the network.
+      #
+      #   @return [String]
+      required :registered_program_identification_number, String
+
+      # @!method initialize(token:, default_product_code:, name:, registered_program_identification_number:)
+      #   @param token [String] Lithic-generated unique identifier for the program
+      #
+      #   @param default_product_code [String] Network product ID associated with this program.
+      #
+      #   @param name [String] The name of the network program.
+      #
+      #   @param registered_program_identification_number [String] RPIN value assigned by the network.
+    end
+  end
+end

data/lib/lithic/models/network_program_list_params.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    # @see Lithic::Resources::NetworkPrograms#list
+    class NetworkProgramListParams < Lithic::Internal::Type::BaseModel
+      extend Lithic::Internal::Type::RequestParameters::Converter
+      include Lithic::Internal::Type::RequestParameters
+
+      # @!attribute 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
+
+      # @!attribute 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
+
+      # @!attribute page_size
+      #   Page size (for pagination).
+      #
+      #   @return [Integer, nil]
+      optional :page_size, Integer
+
+      # @!method initialize(begin_: nil, end_: nil, page_size: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Lithic::Models::NetworkProgramListParams} for more details.
+      #
+      #   @param begin_ [Time] Date string in RFC 3339 format. Only entries created after the specified time wi
+      #
+      #   @param end_ [Time] Date string in RFC 3339 format. Only entries created before the specified time w
+      #
+      #   @param page_size [Integer] Page size (for pagination).
+      #
+      #   @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/lithic/models/network_program_retrieve_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    # @see Lithic::Resources::NetworkPrograms#retrieve
+    class NetworkProgramRetrieveParams < Lithic::Internal::Type::BaseModel
+      extend Lithic::Internal::Type::RequestParameters::Converter
+      include Lithic::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/lithic/models/non_pci_card.rb

@@ -123,6 +123,12 @@ module Lithic
       #   @return [String, nil]
       optional :cardholder_currency, String
 
+      # @!attribute comment
+      #   Additional context or information related to the card.
+      #
+      #   @return [String, nil]
+      optional :comment, String
+
       # @!attribute digital_card_art_token
       #   Specifies the digital card art to be displayed in the user's digital wallet
       #   after tokenization. This artwork must be approved by Mastercard and configured
@@ -155,6 +161,14 @@ module Lithic
       #   @return [String, nil]
       optional :memo, String
 
+      # @!attribute network_program_token
+      #   Globally unique identifier for the card's network program. Null if the card is
+      #   not associated with a network program. Currently applicable to Visa cards
+      #   participating in Account Level Management only
+      #
+      #   @return [String, nil]
+      optional :network_program_token, String, nil?: true
+
       # @!attribute pending_commands
       #   Indicates if there are offline PIN changes pending card interaction with an
       #   offline PIN terminal. Possible commands are: CHANGE_PIN, UNBLOCK_PIN. Applicable
@@ -178,7 +192,32 @@ module Lithic
       #   @return [String, nil]
       optional :replacement_for, String, nil?: true
 
-      # @!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, digital_card_art_token: nil, exp_month: nil, exp_year: nil, hostname: nil, memo: nil, pending_commands: nil, product_id: nil, replacement_for: nil)
+      # @!attribute substatus
+      #   Card state substatus values: _ `LOST` - The physical card is no longer in the
+      #   cardholder's possession due to being lost or never received by the cardholder. _
+      #   `COMPROMISED` - Card information has been exposed, potentially leading to
+      #   unauthorized access. This may involve physical card theft, cloning, or online
+      #   data breaches. _ `DAMAGED` - The physical card is not functioning properly, such
+      #   as having chip failures or a demagnetized magnetic stripe. _
+      #   `END_USER_REQUEST` - The cardholder requested the closure of the card for
+      #   reasons unrelated to fraud or damage, such as switching to a different product
+      #   or closing the account. _ `ISSUER_REQUEST` - The issuer closed the card for
+      #   reasons unrelated to fraud or damage, such as account inactivity, product or
+      #   policy changes, or technology upgrades. _ `NOT_ACTIVE` - The card hasn’t had any
+      #   transaction activity for a specified period, applicable to statuses like
+      #   `PAUSED` or `CLOSED`. _ `SUSPICIOUS_ACTIVITY` - The card has one or more
+      #   suspicious transactions or activities that require review. This can involve
+      #   prompting the cardholder to confirm legitimate use or report confirmed fraud. _
+      #   `INTERNAL_REVIEW` - The card is temporarily paused pending further internal
+      #   review. _ `EXPIRED` - The card has expired and has been closed without being
+      #   reissued. _ `UNDELIVERABLE` - The card cannot be delivered to the cardholder and
+      #   has been returned. \* `OTHER` - The reason for the status does not fall into any
+      #   of the above categories. A comment can be provided to specify the reason.
+      #
+      #   @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)
       #   Some parameter documentations has been truncated, see
       #   {Lithic::Models::NonPCICard} for more details.
       #
@@ -212,6 +251,8 @@ module Lithic
       #
       #   @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.
+      #
       #   @param digital_card_art_token [String] Specifies the digital card art to be displayed in the user's digital wallet afte
       #
       #   @param exp_month [String] Two digit (MM) expiry month.
@@ -222,11 +263,16 @@ module Lithic
       #
       #   @param memo [String] Friendly name to identify the card.
       #
+      #   @param network_program_token [String, nil] Globally unique identifier for the card's network program. Null if the card is n
+      #
       #   @param pending_commands [Array<String>] Indicates if there are offline PIN changes pending card interaction with an offl
       #
       #   @param product_id [String] Only applicable to cards of type `PHYSICAL`. This must be configured with Lithic
       #
       #   @param replacement_for [String, nil] If the card is a replacement for another card, the globally unique identifier fo
+      #
+      #   @param substatus [Symbol, Lithic::Models::NonPCICard::Substatus] Card state substatus values: \* `LOST` - The physical card is no longer in the
+      #   ca
 
       # @see Lithic::Models::NonPCICard#funding
       class Funding < Lithic::Internal::Type::BaseModel
@@ -401,6 +447,47 @@ module Lithic
         # @!method self.values
         #   @return [Array<Symbol>]
       end
+
+      # Card state substatus values: _ `LOST` - The physical card is no longer in the
+      # cardholder's possession due to being lost or never received by the cardholder. _
+      # `COMPROMISED` - Card information has been exposed, potentially leading to
+      # unauthorized access. This may involve physical card theft, cloning, or online
+      # data breaches. _ `DAMAGED` - The physical card is not functioning properly, such
+      # as having chip failures or a demagnetized magnetic stripe. _
+      # `END_USER_REQUEST` - The cardholder requested the closure of the card for
+      # reasons unrelated to fraud or damage, such as switching to a different product
+      # or closing the account. _ `ISSUER_REQUEST` - The issuer closed the card for
+      # reasons unrelated to fraud or damage, such as account inactivity, product or
+      # policy changes, or technology upgrades. _ `NOT_ACTIVE` - The card hasn’t had any
+      # transaction activity for a specified period, applicable to statuses like
+      # `PAUSED` or `CLOSED`. _ `SUSPICIOUS_ACTIVITY` - The card has one or more
+      # suspicious transactions or activities that require review. This can involve
+      # prompting the cardholder to confirm legitimate use or report confirmed fraud. _
+      # `INTERNAL_REVIEW` - The card is temporarily paused pending further internal
+      # review. _ `EXPIRED` - The card has expired and has been closed without being
+      # reissued. _ `UNDELIVERABLE` - The card cannot be delivered to the cardholder and
+      # has been returned. \* `OTHER` - The reason for the status does not fall into any
+      # of the above categories. A comment can be provided to specify the reason.
+      #
+      # @see Lithic::Models::NonPCICard#substatus
+      module Substatus
+        extend Lithic::Internal::Type::Enum
+
+        LOST = :LOST
+        COMPROMISED = :COMPROMISED
+        DAMAGED = :DAMAGED
+        END_USER_REQUEST = :END_USER_REQUEST
+        ISSUER_REQUEST = :ISSUER_REQUEST
+        NOT_ACTIVE = :NOT_ACTIVE
+        SUSPICIOUS_ACTIVITY = :SUSPICIOUS_ACTIVITY
+        INTERNAL_REVIEW = :INTERNAL_REVIEW
+        EXPIRED = :EXPIRED
+        UNDELIVERABLE = :UNDELIVERABLE
+        OTHER = :OTHER
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
     end
   end
 end

data/lib/lithic/models/payment_simulate_action_params.rb

@@ -43,6 +43,7 @@ module Lithic
         ACH_ORIGINATION_PROCESSED = :ACH_ORIGINATION_PROCESSED
         ACH_ORIGINATION_SETTLED = :ACH_ORIGINATION_SETTLED
         ACH_RECEIPT_SETTLED = :ACH_RECEIPT_SETTLED
+        ACH_RECEIPT_RELEASED = :ACH_RECEIPT_RELEASED
         ACH_RETURN_INITIATED = :ACH_RETURN_INITIATED
         ACH_RETURN_PROCESSED = :ACH_RETURN_PROCESSED
         ACH_RETURN_SETTLED = :ACH_RETURN_SETTLED

data/lib/lithic/models/reports/settlement/network_total_list_response.rb

@@ -37,9 +37,16 @@ module Lithic
           #   @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. VISA, MASTERCARD, MAESTRO, or
-          #   INTERLINK.
+          #   Card network where the transaction took place. AMEX, VISA, MASTERCARD, MAESTRO,
+          #   or INTERLINK.
           #
           #   @return [Symbol, Lithic::Models::Reports::Settlement::NetworkTotalListResponse::Network]
           required :network, enum: -> { Lithic::Models::Reports::Settlement::NetworkTotalListResponse::Network }
@@ -76,7 +83,7 @@ module Lithic
           #   @return [Integer, nil]
           optional :cycle, Integer
 
-          # @!method initialize(token:, amounts:, created:, currency:, institution_id:, network:, report_date:, settlement_institution_id:, settlement_service:, updated:, cycle: nil)
+          # @!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::Reports::Settlement::NetworkTotalListResponse} for more
           #   details.
@@ -91,7 +98,9 @@ module Lithic
           #
           #   @param institution_id [String] The institution that activity occurred on. For Mastercard: ICA (Interbank Card A
           #
-          #   @param network [Symbol, Lithic::Models::Reports::Settlement::NetworkTotalListResponse::Network] Card network where the transaction took place. VISA, MASTERCARD, MAESTRO, or INT
+          #   @param is_complete [Boolean] Indicates that all settlement records related to this Network Total are availabl
+          #
+          #   @param network [Symbol, Lithic::Models::Reports::Settlement::NetworkTotalListResponse::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.
           #
@@ -144,13 +153,14 @@ module Lithic
             #   @param visa_charges [Integer] Charges specific to Visa/Interlink, in currency's smallest unit.
           end
 
-          # Card network where the transaction took place. VISA, MASTERCARD, MAESTRO, or
-          # INTERLINK.
+          # Card network where the transaction took place. AMEX, VISA, MASTERCARD, MAESTRO,
+          # or INTERLINK.
           #
           # @see Lithic::Models::Reports::Settlement::NetworkTotalListResponse#network
           module Network
             extend Lithic::Internal::Type::Enum
 
+            AMEX = :AMEX
             VISA = :VISA
             MASTERCARD = :MASTERCARD
             MAESTRO = :MAESTRO

data/lib/lithic/models/reports/settlement/network_total_retrieve_response.rb

@@ -37,9 +37,16 @@ module Lithic
           #   @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. VISA, MASTERCARD, MAESTRO, or
-          #   INTERLINK.
+          #   Card network where the transaction took place. AMEX, VISA, MASTERCARD, MAESTRO,
+          #   or INTERLINK.
           #
           #   @return [Symbol, Lithic::Models::Reports::Settlement::NetworkTotalRetrieveResponse::Network]
           required :network, enum: -> { Lithic::Models::Reports::Settlement::NetworkTotalRetrieveResponse::Network }
@@ -76,7 +83,7 @@ module Lithic
           #   @return [Integer, nil]
           optional :cycle, Integer
 
-          # @!method initialize(token:, amounts:, created:, currency:, institution_id:, network:, report_date:, settlement_institution_id:, settlement_service:, updated:, cycle: nil)
+          # @!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::Reports::Settlement::NetworkTotalRetrieveResponse} for more
           #   details.
@@ -91,7 +98,9 @@ module Lithic
           #
           #   @param institution_id [String] The institution that activity occurred on. For Mastercard: ICA (Interbank Card A
           #
-          #   @param network [Symbol, Lithic::Models::Reports::Settlement::NetworkTotalRetrieveResponse::Network] Card network where the transaction took place. VISA, MASTERCARD, MAESTRO, or INT
+          #   @param is_complete [Boolean] Indicates that all settlement records related to this Network Total are availabl
+          #
+          #   @param network [Symbol, Lithic::Models::Reports::Settlement::NetworkTotalRetrieveResponse::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.
           #
@@ -144,13 +153,14 @@ module Lithic
             #   @param visa_charges [Integer] Charges specific to Visa/Interlink, in currency's smallest unit.
           end
 
-          # Card network where the transaction took place. VISA, MASTERCARD, MAESTRO, or
-          # INTERLINK.
+          # Card network where the transaction took place. AMEX, VISA, MASTERCARD, MAESTRO,
+          # or INTERLINK.
           #
           # @see Lithic::Models::Reports::Settlement::NetworkTotalRetrieveResponse#network
           module Network
             extend Lithic::Internal::Type::Enum
 
+            AMEX = :AMEX
             VISA = :VISA
             MASTERCARD = :MASTERCARD
             MAESTRO = :MAESTRO