lithic 0.15.0 → 0.17.0

data/rbi/lithic/resources/transaction_monitoring/cases/comments.rbi

@@ -0,0 +1,81 @@
+# typed: strong
+
+module Lithic
+  module Resources
+    class TransactionMonitoring
+      class Cases
+        class Comments
+          # Adds a comment to a case.
+          sig do
+            params(
+              case_token: String,
+              comment: String,
+              actor_token: String,
+              request_options: Lithic::RequestOptions::OrHash
+            ).returns(Lithic::TransactionMonitoring::CaseActivityEntry)
+          end
+          def create(
+            # Globally unique identifier for the case.
+            case_token,
+            # Text of the comment
+            comment:,
+            # Optional client-provided identifier for the actor performing this action,
+            # recorded on the resulting activity entry. This value is supplied by the client
+            # (for example, your own internal user ID) and is not authenticated by Lithic
+            actor_token: nil,
+            request_options: {}
+          )
+          end
+
+          # Edits an existing comment on a case.
+          sig do
+            params(
+              comment_token: String,
+              case_token: String,
+              comment: String,
+              actor_token: String,
+              request_options: Lithic::RequestOptions::OrHash
+            ).returns(Lithic::TransactionMonitoring::CaseActivityEntry)
+          end
+          def update(
+            # Path param: Globally unique identifier for the comment.
+            comment_token,
+            # Path param: Globally unique identifier for the case.
+            case_token:,
+            # Body param: New text of the comment
+            comment:,
+            # Body param: Optional client-provided identifier for the actor performing this
+            # action, recorded on the resulting activity entry. This value is supplied by the
+            # client (for example, your own internal user ID) and is not authenticated by
+            # Lithic
+            actor_token: nil,
+            request_options: {}
+          )
+          end
+
+          # Deletes a comment from a case.
+          sig do
+            params(
+              comment_token: String,
+              case_token: String,
+              request_options: Lithic::RequestOptions::OrHash
+            ).void
+          end
+          def delete(
+            # Globally unique identifier for the comment.
+            comment_token,
+            # Globally unique identifier for the case.
+            case_token:,
+            request_options: {}
+          )
+          end
+
+          # @api private
+          sig { params(client: Lithic::Client).returns(T.attached_class) }
+          def self.new(client:)
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/lithic/resources/transaction_monitoring/cases/files.rbi

@@ -0,0 +1,98 @@
+# typed: strong
+
+module Lithic
+  module Resources
+    class TransactionMonitoring
+      class Cases
+        class Files
+          # Creates a file record and returns a presigned URL for uploading the file to the
+          # case.
+          sig do
+            params(
+              case_token: String,
+              name: String,
+              request_options: Lithic::RequestOptions::OrHash
+            ).returns(Lithic::TransactionMonitoring::Cases::CaseFile)
+          end
+          def create(
+            # Globally unique identifier for the case.
+            case_token,
+            # Name of the file to upload
+            name:,
+            request_options: {}
+          )
+          end
+
+          # Retrieves a single file attached to a case, including a presigned download URL
+          # when the file is ready.
+          sig do
+            params(
+              file_token: String,
+              case_token: String,
+              request_options: Lithic::RequestOptions::OrHash
+            ).returns(Lithic::TransactionMonitoring::Cases::CaseFile)
+          end
+          def retrieve(
+            # Globally unique identifier for the file.
+            file_token,
+            # Globally unique identifier for the case.
+            case_token:,
+            request_options: {}
+          )
+          end
+
+          # Lists the files attached to a case.
+          sig do
+            params(
+              case_token: String,
+              ending_before: String,
+              page_size: Integer,
+              starting_after: String,
+              request_options: Lithic::RequestOptions::OrHash
+            ).returns(
+              Lithic::Internal::CursorPage[
+                Lithic::TransactionMonitoring::Cases::CaseFile
+              ]
+            )
+          end
+          def list(
+            # Globally unique identifier for the case.
+            case_token,
+            # 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.
+            ending_before: nil,
+            # Page size (for pagination).
+            page_size: nil,
+            # 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.
+            starting_after: nil,
+            request_options: {}
+          )
+          end
+
+          # Deletes a file from a case.
+          sig do
+            params(
+              file_token: String,
+              case_token: String,
+              request_options: Lithic::RequestOptions::OrHash
+            ).void
+          end
+          def delete(
+            # Globally unique identifier for the file.
+            file_token,
+            # Globally unique identifier for the case.
+            case_token:,
+            request_options: {}
+          )
+          end
+
+          # @api private
+          sig { params(client: Lithic::Client).returns(T.attached_class) }
+          def self.new(client:)
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/lithic/resources/transaction_monitoring/cases.rbi

@@ -0,0 +1,230 @@
+# typed: strong
+
+module Lithic
+  module Resources
+    class TransactionMonitoring
+      class Cases
+        sig do
+          returns(Lithic::Resources::TransactionMonitoring::Cases::Comments)
+        end
+        attr_reader :comments
+
+        sig { returns(Lithic::Resources::TransactionMonitoring::Cases::Files) }
+        attr_reader :files
+
+        # Retrieves a single transaction monitoring case.
+        sig do
+          params(
+            case_token: String,
+            request_options: Lithic::RequestOptions::OrHash
+          ).returns(Lithic::TransactionMonitoring::MonitoringCase)
+        end
+        def retrieve(
+          # Globally unique identifier for the case.
+          case_token,
+          request_options: {}
+        )
+        end
+
+        # Updates a transaction monitoring case.
+        sig do
+          params(
+            case_token: String,
+            actor_token: String,
+            assignee: T.nilable(String),
+            priority: Lithic::TransactionMonitoring::CasePriority::OrSymbol,
+            resolution:
+              Lithic::TransactionMonitoring::ResolutionOutcome::OrSymbol,
+            resolution_notes: String,
+            sla_deadline: T.nilable(Time),
+            status: Lithic::TransactionMonitoring::CaseStatus::OrSymbol,
+            tags: T::Hash[Symbol, String],
+            title: T.nilable(String),
+            request_options: Lithic::RequestOptions::OrHash
+          ).returns(Lithic::TransactionMonitoring::MonitoringCase)
+        end
+        def update(
+          # Globally unique identifier for the case.
+          case_token,
+          # Optional client-provided identifier for the actor performing this action,
+          # recorded on the resulting activity entry. This value is supplied by the client
+          # (for example, your own internal user ID) and is not authenticated by Lithic
+          actor_token: nil,
+          # New assignee for the case, or `null` to unassign
+          assignee: nil,
+          # Priority level of a case, controlling queue ordering and SLA urgency
+          priority: nil,
+          # Outcome recorded when a case is resolved:
+          #
+          # - `CONFIRMED_FRAUD` - The reviewed activity was confirmed to be fraudulent
+          # - `SUSPICIOUS_ACTIVITY` - The activity is suspicious but not confirmed fraud
+          # - `FALSE_POSITIVE` - The activity was legitimate and the alert was a false
+          #   positive
+          # - `NO_ACTION_REQUIRED` - No further action is required
+          # - `ESCALATED_EXTERNAL` - The case was escalated to an external party
+          resolution: nil,
+          # Notes describing the resolution
+          resolution_notes: nil,
+          # New SLA deadline for the case, or `null` to clear it
+          sla_deadline: nil,
+          # Status of a case as it progresses through the review workflow:
+          #
+          # - `OPEN` - The case has been created and is still collecting matching
+          #   transactions
+          # - `ASSIGNED` - An analyst has been assigned and transaction collection has
+          #   stopped
+          # - `IN_REVIEW` - The case is actively being investigated
+          # - `ESCALATED` - The case has been reviewed and requires additional oversight
+          # - `RESOLVED` - A determination has been made and a resolution recorded
+          # - `CLOSED` - The case is finalized
+          status: nil,
+          # Arbitrary key-value metadata to set on the case
+          tags: nil,
+          # New title for the case, or `null` to clear it
+          title: nil,
+          request_options: {}
+        )
+        end
+
+        # Lists transaction monitoring cases, optionally filtered.
+        sig do
+          params(
+            account_token: String,
+            assignee: String,
+            begin_: Time,
+            card_token: String,
+            end_: Time,
+            ending_before: String,
+            entity_token: String,
+            page_size: Integer,
+            queue_token: String,
+            rule_token: String,
+            sort_by: Lithic::TransactionMonitoring::CaseSortOrder::OrSymbol,
+            starting_after: String,
+            status: Lithic::TransactionMonitoring::CaseStatus::OrSymbol,
+            transaction_token: String,
+            request_options: Lithic::RequestOptions::OrHash
+          ).returns(
+            Lithic::Internal::CursorPage[
+              Lithic::TransactionMonitoring::MonitoringCase
+            ]
+          )
+        end
+        def list(
+          # Only return cases that include transactions on the provided account.
+          account_token: nil,
+          # Only return cases assigned to the provided value. Pass an empty string to return
+          # only unassigned cases.
+          assignee: nil,
+          # Date string in RFC 3339 format. Only entries created after the specified time
+          # will be included. UTC time zone.
+          begin_: nil,
+          # Only return cases that include transactions on the provided card.
+          card_token: nil,
+          # Date string in RFC 3339 format. Only entries created before the specified time
+          # will be included. UTC time zone.
+          end_: nil,
+          # 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.
+          ending_before: nil,
+          # Only return cases associated with the provided entity.
+          entity_token: nil,
+          # Page size (for pagination).
+          page_size: nil,
+          # Only return cases belonging to the provided queue.
+          queue_token: nil,
+          # Only return cases triggered by the provided transaction monitoring rule.
+          rule_token: nil,
+          # Sort order for the returned cases.
+          sort_by: nil,
+          # 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.
+          starting_after: nil,
+          # Only return cases with the provided status.
+          status: nil,
+          # Only return cases that include the provided transaction.
+          transaction_token: nil,
+          request_options: {}
+        )
+        end
+
+        # Lists the activity feed for a case.
+        sig do
+          params(
+            case_token: String,
+            ending_before: String,
+            page_size: Integer,
+            starting_after: String,
+            request_options: Lithic::RequestOptions::OrHash
+          ).returns(
+            Lithic::Internal::CursorPage[
+              Lithic::TransactionMonitoring::CaseActivityEntry
+            ]
+          )
+        end
+        def list_activity(
+          # Globally unique identifier for the case.
+          case_token,
+          # 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.
+          ending_before: nil,
+          # Page size (for pagination).
+          page_size: nil,
+          # 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.
+          starting_after: nil,
+          request_options: {}
+        )
+        end
+
+        # Lists the transactions associated with a case.
+        sig do
+          params(
+            case_token: String,
+            ending_before: String,
+            page_size: Integer,
+            starting_after: String,
+            request_options: Lithic::RequestOptions::OrHash
+          ).returns(
+            Lithic::Internal::CursorPage[
+              Lithic::TransactionMonitoring::CaseTransaction
+            ]
+          )
+        end
+        def list_transactions(
+          # Globally unique identifier for the case.
+          case_token,
+          # 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.
+          ending_before: nil,
+          # Page size (for pagination).
+          page_size: nil,
+          # 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.
+          starting_after: nil,
+          request_options: {}
+        )
+        end
+
+        # Lists the cards involved in a case, with per-card transaction counts.
+        sig do
+          params(
+            case_token: String,
+            request_options: Lithic::RequestOptions::OrHash
+          ).returns(T::Array[Lithic::TransactionMonitoring::CaseCard])
+        end
+        def retrieve_cards(
+          # Globally unique identifier for the case.
+          case_token,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: Lithic::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/lithic/resources/transaction_monitoring/queues.rbi

@@ -0,0 +1,103 @@
+# typed: strong
+
+module Lithic
+  module Resources
+    class TransactionMonitoring
+      class Queues
+        # Creates a new queue for grouping transaction monitoring cases.
+        sig do
+          params(
+            name: String,
+            description: T.nilable(String),
+            request_options: Lithic::RequestOptions::OrHash
+          ).returns(Lithic::TransactionMonitoring::Queue)
+        end
+        def create(
+          # Human-readable name of the queue
+          name:,
+          # Optional description of the queue
+          description: nil,
+          request_options: {}
+        )
+        end
+
+        # Retrieves a single transaction monitoring queue.
+        sig do
+          params(
+            queue_token: String,
+            request_options: Lithic::RequestOptions::OrHash
+          ).returns(Lithic::TransactionMonitoring::Queue)
+        end
+        def retrieve(
+          # Globally unique identifier for the queue.
+          queue_token,
+          request_options: {}
+        )
+        end
+
+        # Updates a transaction monitoring queue.
+        sig do
+          params(
+            queue_token: String,
+            description: T.nilable(String),
+            name: String,
+            request_options: Lithic::RequestOptions::OrHash
+          ).returns(Lithic::TransactionMonitoring::Queue)
+        end
+        def update(
+          # Globally unique identifier for the queue.
+          queue_token,
+          # New description for the queue, or `null` to clear it
+          description: nil,
+          # New name for the queue
+          name: nil,
+          request_options: {}
+        )
+        end
+
+        # Lists transaction monitoring queues.
+        sig do
+          params(
+            ending_before: String,
+            page_size: Integer,
+            starting_after: String,
+            request_options: Lithic::RequestOptions::OrHash
+          ).returns(
+            Lithic::Internal::CursorPage[Lithic::TransactionMonitoring::Queue]
+          )
+        end
+        def list(
+          # 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.
+          ending_before: nil,
+          # Page size (for pagination).
+          page_size: nil,
+          # 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.
+          starting_after: nil,
+          request_options: {}
+        )
+        end
+
+        # Deletes a transaction monitoring queue.
+        sig do
+          params(
+            queue_token: String,
+            request_options: Lithic::RequestOptions::OrHash
+          ).void
+        end
+        def delete(
+          # Globally unique identifier for the queue.
+          queue_token,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: Lithic::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/lithic/resources/transaction_monitoring.rbi

@@ -0,0 +1,18 @@
+# typed: strong
+
+module Lithic
+  module Resources
+    class TransactionMonitoring
+      sig { returns(Lithic::Resources::TransactionMonitoring::Cases) }
+      attr_reader :cases
+
+      sig { returns(Lithic::Resources::TransactionMonitoring::Queues) }
+      attr_reader :queues
+
+      # @api private
+      sig { params(client: Lithic::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/lithic/resources/transactions.rbi

@@ -82,6 +82,24 @@ module Lithic
       )
       end
 
+      # Route a card transaction to a financial account. Only available for select use
+      # cases and programs.
+      sig do
+        params(
+          transaction_token: String,
+          financial_account_token: String,
+          request_options: Lithic::RequestOptions::OrHash
+        ).void
+      end
+      def route(
+        # The token of the transaction to route.
+        transaction_token,
+        # The token of the financial account to route the transaction to.
+        financial_account_token:,
+        request_options: {}
+      )
+      end
+
       # Simulates an authorization request from the card network as if it came from a
       # merchant acquirer. If you are configured for ASA, simulating authorizations
       # requires your ASA client to be set up properly, i.e. be able to respond to the

data/sig/lithic/client.rbs

@@ -23,6 +23,8 @@ module Lithic
 
     attr_reader auth_rules: Lithic::Resources::AuthRules
 
+    attr_reader transaction_monitoring: Lithic::Resources::TransactionMonitoring
+
     attr_reader auth_stream_enrollment: Lithic::Resources::AuthStreamEnrollment
 
     attr_reader tokenization_decisioning: Lithic::Resources::TokenizationDecisioning

data/sig/lithic/models/account_holders/account_holder_entity.rbs

@@ -14,7 +14,7 @@ module Lithic
           last_name: String?,
           phone_number: String?,
           status: Lithic::Models::AccountHolders::AccountHolderEntity::status,
-          type: Lithic::Models::AccountHolders::AccountHolderEntity::type_
+          type: Lithic::Models::TransactionMonitoring::entity_type
         }
 
       class AccountHolderEntity < Lithic::Internal::Type::BaseModel
@@ -36,7 +36,7 @@ module Lithic
 
         attr_accessor status: Lithic::Models::AccountHolders::AccountHolderEntity::status
 
-        attr_accessor type: Lithic::Models::AccountHolders::AccountHolderEntity::type_
+        attr_accessor type: Lithic::Models::TransactionMonitoring::entity_type
 
         def initialize: (
           token: String,
@@ -48,7 +48,7 @@ module Lithic
           last_name: String?,
           phone_number: String?,
           status: Lithic::Models::AccountHolders::AccountHolderEntity::status,
-          type: Lithic::Models::AccountHolders::AccountHolderEntity::type_
+          type: Lithic::Models::TransactionMonitoring::entity_type
         ) -> void
 
         def to_hash: -> {
@@ -61,7 +61,7 @@ module Lithic
           last_name: String?,
           phone_number: String?,
           status: Lithic::Models::AccountHolders::AccountHolderEntity::status,
-          type: Lithic::Models::AccountHolders::AccountHolderEntity::type_
+          type: Lithic::Models::TransactionMonitoring::entity_type
         }
 
         type address =
@@ -120,17 +120,6 @@ module Lithic
 
           def self?.values: -> ::Array[Lithic::Models::AccountHolders::AccountHolderEntity::status]
         end
-
-        type type_ = :BENEFICIAL_OWNER_INDIVIDUAL | :CONTROL_PERSON
-
-        module Type
-          extend Lithic::Internal::Type::Enum
-
-          BENEFICIAL_OWNER_INDIVIDUAL: :BENEFICIAL_OWNER_INDIVIDUAL
-          CONTROL_PERSON: :CONTROL_PERSON
-
-          def self?.values: -> ::Array[Lithic::Models::AccountHolders::AccountHolderEntity::type_]
-        end
       end
     end
   end

data/sig/lithic/models/account_holders/entity_create_params.rbs

@@ -11,7 +11,7 @@ module Lithic
           government_id: String,
           last_name: String,
           phone_number: String,
-          type: Lithic::Models::AccountHolders::EntityCreateParams::type_
+          type: Lithic::Models::TransactionMonitoring::entity_type
         }
         & Lithic::Internal::Type::request_parameters
 
@@ -35,7 +35,7 @@ module Lithic
 
         attr_accessor phone_number: String
 
-        attr_accessor type: Lithic::Models::AccountHolders::EntityCreateParams::type_
+        attr_accessor type: Lithic::Models::TransactionMonitoring::entity_type
 
         def initialize: (
           account_holder_token: String,
@@ -46,7 +46,7 @@ module Lithic
           government_id: String,
           last_name: String,
           phone_number: String,
-          type: Lithic::Models::AccountHolders::EntityCreateParams::type_,
+          type: Lithic::Models::TransactionMonitoring::entity_type,
           ?request_options: Lithic::request_opts
         ) -> void
 
@@ -59,7 +59,7 @@ module Lithic
           government_id: String,
           last_name: String,
           phone_number: String,
-          type: Lithic::Models::AccountHolders::EntityCreateParams::type_,
+          type: Lithic::Models::TransactionMonitoring::entity_type,
           request_options: Lithic::RequestOptions
         }
 
@@ -106,17 +106,6 @@ module Lithic
             :address2 => String
           }
         end
-
-        type type_ = :BENEFICIAL_OWNER_INDIVIDUAL | :CONTROL_PERSON
-
-        module Type
-          extend Lithic::Internal::Type::Enum
-
-          BENEFICIAL_OWNER_INDIVIDUAL: :BENEFICIAL_OWNER_INDIVIDUAL
-          CONTROL_PERSON: :CONTROL_PERSON
-
-          def self?.values: -> ::Array[Lithic::Models::AccountHolders::EntityCreateParams::type_]
-        end
       end
     end
   end