lithic 0.15.0 → 0.16.0

data/lib/lithic/models/transaction_monitoring/cases/comment_create_params.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    module TransactionMonitoring
+      module Cases
+        # @see Lithic::Resources::TransactionMonitoring::Cases::Comments#create
+        class CommentCreateParams < Lithic::Internal::Type::BaseModel
+          extend Lithic::Internal::Type::RequestParameters::Converter
+          include Lithic::Internal::Type::RequestParameters
+
+          # @!attribute case_token
+          #
+          #   @return [String]
+          required :case_token, String
+
+          # @!attribute comment
+          #   Text of the comment
+          #
+          #   @return [String]
+          required :comment, String
+
+          # @!attribute actor_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
+          #
+          #   @return [String, nil]
+          optional :actor_token, String
+
+          # @!method initialize(case_token:, comment:, actor_token: nil, request_options: {})
+          #   Some parameter documentations has been truncated, see
+          #   {Lithic::Models::TransactionMonitoring::Cases::CommentCreateParams} for more
+          #   details.
+          #
+          #   @param case_token [String]
+          #
+          #   @param comment [String] Text of the comment
+          #
+          #   @param actor_token [String] Optional client-provided identifier for the actor performing this action,
+          #
+          #   @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

data/lib/lithic/models/transaction_monitoring/cases/comment_delete_params.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    module TransactionMonitoring
+      module Cases
+        # @see Lithic::Resources::TransactionMonitoring::Cases::Comments#delete
+        class CommentDeleteParams < Lithic::Internal::Type::BaseModel
+          extend Lithic::Internal::Type::RequestParameters::Converter
+          include Lithic::Internal::Type::RequestParameters
+
+          # @!attribute case_token
+          #
+          #   @return [String]
+          required :case_token, String
+
+          # @!attribute comment_token
+          #
+          #   @return [String]
+          required :comment_token, String
+
+          # @!method initialize(case_token:, comment_token:, request_options: {})
+          #   @param case_token [String]
+          #   @param comment_token [String]
+          #   @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

data/lib/lithic/models/transaction_monitoring/cases/comment_update_params.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    module TransactionMonitoring
+      module Cases
+        # @see Lithic::Resources::TransactionMonitoring::Cases::Comments#update
+        class CommentUpdateParams < Lithic::Internal::Type::BaseModel
+          extend Lithic::Internal::Type::RequestParameters::Converter
+          include Lithic::Internal::Type::RequestParameters
+
+          # @!attribute case_token
+          #
+          #   @return [String]
+          required :case_token, String
+
+          # @!attribute comment_token
+          #
+          #   @return [String]
+          required :comment_token, String
+
+          # @!attribute comment
+          #   New text of the comment
+          #
+          #   @return [String]
+          required :comment, String
+
+          # @!attribute actor_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
+          #
+          #   @return [String, nil]
+          optional :actor_token, String
+
+          # @!method initialize(case_token:, comment_token:, comment:, actor_token: nil, request_options: {})
+          #   Some parameter documentations has been truncated, see
+          #   {Lithic::Models::TransactionMonitoring::Cases::CommentUpdateParams} for more
+          #   details.
+          #
+          #   @param case_token [String]
+          #
+          #   @param comment_token [String]
+          #
+          #   @param comment [String] New text of the comment
+          #
+          #   @param actor_token [String] Optional client-provided identifier for the actor performing this action,
+          #
+          #   @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

data/lib/lithic/models/transaction_monitoring/cases/file_create_params.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    module TransactionMonitoring
+      module Cases
+        # @see Lithic::Resources::TransactionMonitoring::Cases::Files#create
+        class FileCreateParams < Lithic::Internal::Type::BaseModel
+          extend Lithic::Internal::Type::RequestParameters::Converter
+          include Lithic::Internal::Type::RequestParameters
+
+          # @!attribute case_token
+          #
+          #   @return [String]
+          required :case_token, String
+
+          # @!attribute name
+          #   Name of the file to upload
+          #
+          #   @return [String]
+          required :name, String
+
+          # @!method initialize(case_token:, name:, request_options: {})
+          #   @param case_token [String]
+          #
+          #   @param name [String] Name of the file to upload
+          #
+          #   @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

data/lib/lithic/models/transaction_monitoring/cases/file_delete_params.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    module TransactionMonitoring
+      module Cases
+        # @see Lithic::Resources::TransactionMonitoring::Cases::Files#delete
+        class FileDeleteParams < Lithic::Internal::Type::BaseModel
+          extend Lithic::Internal::Type::RequestParameters::Converter
+          include Lithic::Internal::Type::RequestParameters
+
+          # @!attribute case_token
+          #
+          #   @return [String]
+          required :case_token, String
+
+          # @!attribute file_token
+          #
+          #   @return [String]
+          required :file_token, String
+
+          # @!method initialize(case_token:, file_token:, request_options: {})
+          #   @param case_token [String]
+          #   @param file_token [String]
+          #   @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

data/lib/lithic/models/transaction_monitoring/cases/file_list_params.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    module TransactionMonitoring
+      module Cases
+        # @see Lithic::Resources::TransactionMonitoring::Cases::Files#list
+        class FileListParams < Lithic::Internal::Type::BaseModel
+          extend Lithic::Internal::Type::RequestParameters::Converter
+          include Lithic::Internal::Type::RequestParameters
+
+          # @!attribute case_token
+          #
+          #   @return [String]
+          required :case_token, String
+
+          # @!attribute ending_before
+          #   A cursor representing an item's token before which a page of results should end.
+          #   Used to retrieve the previous page of results before this item.
+          #
+          #   @return [String, nil]
+          optional :ending_before, String
+
+          # @!attribute page_size
+          #   Page size (for pagination).
+          #
+          #   @return [Integer, nil]
+          optional :page_size, Integer
+
+          # @!attribute starting_after
+          #   A cursor representing an item's token after which a page of results should
+          #   begin. Used to retrieve the next page of results after this item.
+          #
+          #   @return [String, nil]
+          optional :starting_after, String
+
+          # @!method initialize(case_token:, ending_before: nil, page_size: nil, starting_after: nil, request_options: {})
+          #   Some parameter documentations has been truncated, see
+          #   {Lithic::Models::TransactionMonitoring::Cases::FileListParams} for more details.
+          #
+          #   @param case_token [String]
+          #
+          #   @param ending_before [String] A cursor representing an item's token before which a page of results should end.
+          #
+          #   @param page_size [Integer] Page size (for pagination).
+          #
+          #   @param starting_after [String] A cursor representing an item's token after which a page of results should begin
+          #
+          #   @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

data/lib/lithic/models/transaction_monitoring/cases/file_retrieve_params.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    module TransactionMonitoring
+      module Cases
+        # @see Lithic::Resources::TransactionMonitoring::Cases::Files#retrieve
+        class FileRetrieveParams < Lithic::Internal::Type::BaseModel
+          extend Lithic::Internal::Type::RequestParameters::Converter
+          include Lithic::Internal::Type::RequestParameters
+
+          # @!attribute case_token
+          #
+          #   @return [String]
+          required :case_token, String
+
+          # @!attribute file_token
+          #
+          #   @return [String]
+          required :file_token, String
+
+          # @!method initialize(case_token:, file_token:, request_options: {})
+          #   @param case_token [String]
+          #   @param file_token [String]
+          #   @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

data/lib/lithic/models/transaction_monitoring/cases/file_status.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    module TransactionMonitoring
+      module Cases
+        # Lifecycle status of a case file:
+        #
+        # - `PENDING` - An upload URL has been issued and the file is awaiting upload
+        # - `READY` - The file has been uploaded and validated; a download URL is
+        #   available
+        # - `REJECTED` - File validation failed; see `failure_reason` for details
+        module FileStatus
+          extend Lithic::Internal::Type::Enum
+
+          PENDING = :PENDING
+          READY = :READY
+          REJECTED = :REJECTED
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/lithic/models/transaction_monitoring/cases/upload_constraints.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    module TransactionMonitoring
+      module Cases
+        class UploadConstraints < Lithic::Internal::Type::BaseModel
+          # @!attribute accepted_mime_types
+          #   MIME types accepted for the upload
+          #
+          #   @return [Array<String>]
+          required :accepted_mime_types, Lithic::Internal::Type::ArrayOf[String]
+
+          # @!attribute max_size_bytes
+          #   Maximum accepted file size, in bytes
+          #
+          #   @return [Integer]
+          required :max_size_bytes, Integer
+
+          # @!method initialize(accepted_mime_types:, max_size_bytes:)
+          #   Constraints applied to a file upload, returned alongside the upload URL so
+          #   clients can validate before uploading
+          #
+          #   @param accepted_mime_types [Array<String>] MIME types accepted for the upload
+          #
+          #   @param max_size_bytes [Integer] Maximum accepted file size, in bytes
+        end
+      end
+    end
+  end
+end

data/lib/lithic/models/transaction_monitoring/entity_type.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    module TransactionMonitoring
+      # The type of entity associated with an account holder
+      module EntityType
+        extend Lithic::Internal::Type::Enum
+
+        BENEFICIAL_OWNER_INDIVIDUAL = :BENEFICIAL_OWNER_INDIVIDUAL
+        CONTROL_PERSON = :CONTROL_PERSON
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/lithic/models/transaction_monitoring/monitoring_case.rb

@@ -0,0 +1,168 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    module TransactionMonitoring
+      # @see Lithic::Resources::TransactionMonitoring::Cases#retrieve
+      class MonitoringCase < Lithic::Internal::Type::BaseModel
+        # @!attribute token
+        #   Globally unique identifier for the case
+        #
+        #   @return [String]
+        required :token, String
+
+        # @!attribute assignee
+        #   Identifier of the user the case is currently assigned to
+        #
+        #   @return [String, nil]
+        required :assignee, String, nil?: true
+
+        # @!attribute collection_stopped
+        #   Date and time at which transaction collection stopped for the case
+        #
+        #   @return [Time, nil]
+        required :collection_stopped, Time, nil?: true
+
+        # @!attribute created
+        #   Date and time at which the case was created
+        #
+        #   @return [Time]
+        required :created, Time
+
+        # @!attribute entity
+        #   The entity a case is associated with
+        #
+        #   @return [Lithic::Models::TransactionMonitoring::CaseEntity, nil]
+        required :entity, -> { Lithic::TransactionMonitoring::CaseEntity }, nil?: true
+
+        # @!attribute pending_transactions
+        #   Whether the case still has transaction scopes pending resolution
+        #
+        #   @return [Boolean]
+        required :pending_transactions, Lithic::Internal::Type::Boolean
+
+        # @!attribute priority
+        #   Priority level of a case, controlling queue ordering and SLA urgency
+        #
+        #   @return [Symbol, Lithic::Models::TransactionMonitoring::CasePriority]
+        required :priority, enum: -> { Lithic::TransactionMonitoring::CasePriority }
+
+        # @!attribute queue_token
+        #   Token of the queue the case belongs to
+        #
+        #   @return [String]
+        required :queue_token, String
+
+        # @!attribute resolution
+        #   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
+        #
+        #   @return [Symbol, Lithic::Models::TransactionMonitoring::ResolutionOutcome, nil]
+        required :resolution, enum: -> { Lithic::TransactionMonitoring::ResolutionOutcome }, nil?: true
+
+        # @!attribute resolution_notes
+        #   Free-form notes describing the resolution
+        #
+        #   @return [String, nil]
+        required :resolution_notes, String, nil?: true
+
+        # @!attribute resolved
+        #   Date and time at which the case was resolved
+        #
+        #   @return [Time, nil]
+        required :resolved, Time, nil?: true
+
+        # @!attribute rule_token
+        #   Token of the transaction monitoring rule that triggered the case
+        #
+        #   @return [String, nil]
+        required :rule_token, String, nil?: true
+
+        # @!attribute sla_deadline
+        #   Deadline by which the case is expected to be resolved
+        #
+        #   @return [Time, nil]
+        required :sla_deadline, Time, nil?: true
+
+        # @!attribute status
+        #   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
+        #
+        #   @return [Symbol, Lithic::Models::TransactionMonitoring::CaseStatus]
+        required :status, enum: -> { Lithic::TransactionMonitoring::CaseStatus }
+
+        # @!attribute tags
+        #   Arbitrary key-value metadata associated with the case
+        #
+        #   @return [Hash{Symbol=>String}]
+        required :tags, Lithic::Internal::Type::HashOf[String]
+
+        # @!attribute title
+        #   Short, human-readable summary of the case
+        #
+        #   @return [String, nil]
+        required :title, String, nil?: true
+
+        # @!attribute updated
+        #   Date and time at which the case was last updated
+        #
+        #   @return [Time]
+        required :updated, Time
+
+        # @!method initialize(token:, assignee:, collection_stopped:, created:, entity:, pending_transactions:, priority:, queue_token:, resolution:, resolution_notes:, resolved:, rule_token:, sla_deadline:, status:, tags:, title:, updated:)
+        #   Some parameter documentations has been truncated, see
+        #   {Lithic::Models::TransactionMonitoring::MonitoringCase} for more details.
+        #
+        #   A transaction monitoring case
+        #
+        #   @param token [String] Globally unique identifier for the case
+        #
+        #   @param assignee [String, nil] Identifier of the user the case is currently assigned to
+        #
+        #   @param collection_stopped [Time, nil] Date and time at which transaction collection stopped for the case
+        #
+        #   @param created [Time] Date and time at which the case was created
+        #
+        #   @param entity [Lithic::Models::TransactionMonitoring::CaseEntity, nil] The entity a case is associated with
+        #
+        #   @param pending_transactions [Boolean] Whether the case still has transaction scopes pending resolution
+        #
+        #   @param priority [Symbol, Lithic::Models::TransactionMonitoring::CasePriority] Priority level of a case, controlling queue ordering and SLA urgency
+        #
+        #   @param queue_token [String] Token of the queue the case belongs to
+        #
+        #   @param resolution [Symbol, Lithic::Models::TransactionMonitoring::ResolutionOutcome, nil] Outcome recorded when a case is resolved:
+        #
+        #   @param resolution_notes [String, nil] Free-form notes describing the resolution
+        #
+        #   @param resolved [Time, nil] Date and time at which the case was resolved
+        #
+        #   @param rule_token [String, nil] Token of the transaction monitoring rule that triggered the case
+        #
+        #   @param sla_deadline [Time, nil] Deadline by which the case is expected to be resolved
+        #
+        #   @param status [Symbol, Lithic::Models::TransactionMonitoring::CaseStatus] Status of a case as it progresses through the review workflow:
+        #
+        #   @param tags [Hash{Symbol=>String}] Arbitrary key-value metadata associated with the case
+        #
+        #   @param title [String, nil] Short, human-readable summary of the case
+        #
+        #   @param updated [Time] Date and time at which the case was last updated
+      end
+    end
+  end
+end

data/lib/lithic/models/transaction_monitoring/queue.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    module TransactionMonitoring
+      # @see Lithic::Resources::TransactionMonitoring::Queues#create
+      class Queue < Lithic::Internal::Type::BaseModel
+        # @!attribute token
+        #   Globally unique identifier for the queue
+        #
+        #   @return [String]
+        required :token, String
+
+        # @!attribute case_counts
+        #   Number of cases in the queue, broken down by status. A status is omitted when
+        #   the queue has no cases in that status
+        #
+        #   @return [Lithic::Models::TransactionMonitoring::Queue::CaseCounts]
+        required :case_counts, -> { Lithic::TransactionMonitoring::Queue::CaseCounts }
+
+        # @!attribute created
+        #   Date and time at which the queue was created
+        #
+        #   @return [Time]
+        required :created, Time
+
+        # @!attribute description
+        #   Optional description of the queue
+        #
+        #   @return [String, nil]
+        required :description, String, nil?: true
+
+        # @!attribute name
+        #   Human-readable name of the queue
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!attribute updated
+        #   Date and time at which the queue was last updated
+        #
+        #   @return [Time]
+        required :updated, Time
+
+        # @!method initialize(token:, case_counts:, created:, description:, name:, updated:)
+        #   Some parameter documentations has been truncated, see
+        #   {Lithic::Models::TransactionMonitoring::Queue} for more details.
+        #
+        #   A queue that groups transaction monitoring cases for review
+        #
+        #   @param token [String] Globally unique identifier for the queue
+        #
+        #   @param case_counts [Lithic::Models::TransactionMonitoring::Queue::CaseCounts] Number of cases in the queue, broken down by status. A status is omitted
+        #
+        #   @param created [Time] Date and time at which the queue was created
+        #
+        #   @param description [String, nil] Optional description of the queue
+        #
+        #   @param name [String] Human-readable name of the queue
+        #
+        #   @param updated [Time] Date and time at which the queue was last updated
+
+        # @see Lithic::Models::TransactionMonitoring::Queue#case_counts
+        class CaseCounts < Lithic::Internal::Type::BaseModel
+          # @!attribute assigned
+          #   Number of cases in the queue with status `ASSIGNED`
+          #
+          #   @return [Integer, nil]
+          optional :assigned, Integer, api_name: :ASSIGNED
+
+          # @!attribute closed
+          #   Number of cases in the queue with status `CLOSED`
+          #
+          #   @return [Integer, nil]
+          optional :closed, Integer, api_name: :CLOSED
+
+          # @!attribute escalated
+          #   Number of cases in the queue with status `ESCALATED`
+          #
+          #   @return [Integer, nil]
+          optional :escalated, Integer, api_name: :ESCALATED
+
+          # @!attribute in_review
+          #   Number of cases in the queue with status `IN_REVIEW`
+          #
+          #   @return [Integer, nil]
+          optional :in_review, Integer, api_name: :IN_REVIEW
+
+          # @!attribute open_
+          #   Number of cases in the queue with status `OPEN`
+          #
+          #   @return [Integer, nil]
+          optional :open_, Integer, api_name: :OPEN
+
+          # @!attribute resolved
+          #   Number of cases in the queue with status `RESOLVED`
+          #
+          #   @return [Integer, nil]
+          optional :resolved, Integer, api_name: :RESOLVED
+
+          # @!method initialize(assigned: nil, closed: nil, escalated: nil, in_review: nil, open_: nil, resolved: nil)
+          #   Number of cases in the queue, broken down by status. A status is omitted when
+          #   the queue has no cases in that status
+          #
+          #   @param assigned [Integer] Number of cases in the queue with status `ASSIGNED`
+          #
+          #   @param closed [Integer] Number of cases in the queue with status `CLOSED`
+          #
+          #   @param escalated [Integer] Number of cases in the queue with status `ESCALATED`
+          #
+          #   @param in_review [Integer] Number of cases in the queue with status `IN_REVIEW`
+          #
+          #   @param open_ [Integer] Number of cases in the queue with status `OPEN`
+          #
+          #   @param resolved [Integer] Number of cases in the queue with status `RESOLVED`
+        end
+      end
+    end
+  end
+end

data/lib/lithic/models/transaction_monitoring/queue_create_params.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    module TransactionMonitoring
+      # @see Lithic::Resources::TransactionMonitoring::Queues#create
+      class QueueCreateParams < Lithic::Internal::Type::BaseModel
+        extend Lithic::Internal::Type::RequestParameters::Converter
+        include Lithic::Internal::Type::RequestParameters
+
+        # @!attribute name
+        #   Human-readable name of the queue
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!attribute description
+        #   Optional description of the queue
+        #
+        #   @return [String, nil]
+        optional :description, String, nil?: true
+
+        # @!method initialize(name:, description: nil, request_options: {})
+        #   @param name [String] Human-readable name of the queue
+        #
+        #   @param description [String, nil] Optional description of the queue
+        #
+        #   @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end