lithic 0.14.0 → 0.16.0

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

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    module TransactionMonitoring
+      # @see Lithic::Resources::TransactionMonitoring::Cases#update
+      class CaseUpdateParams < 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 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
+
+        # @!attribute assignee
+        #   New assignee for the case, or `null` to unassign
+        #
+        #   @return [String, nil]
+        optional :assignee, String, nil?: true
+
+        # @!attribute priority
+        #   Priority level of a case, controlling queue ordering and SLA urgency
+        #
+        #   @return [Symbol, Lithic::Models::TransactionMonitoring::CasePriority, nil]
+        optional :priority, enum: -> { Lithic::TransactionMonitoring::CasePriority }
+
+        # @!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]
+        optional :resolution, enum: -> { Lithic::TransactionMonitoring::ResolutionOutcome }
+
+        # @!attribute resolution_notes
+        #   Notes describing the resolution
+        #
+        #   @return [String, nil]
+        optional :resolution_notes, String
+
+        # @!attribute sla_deadline
+        #   New SLA deadline for the case, or `null` to clear it
+        #
+        #   @return [Time, nil]
+        optional :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, nil]
+        optional :status, enum: -> { Lithic::TransactionMonitoring::CaseStatus }
+
+        # @!attribute tags
+        #   Arbitrary key-value metadata to set on the case
+        #
+        #   @return [Hash{Symbol=>String}, nil]
+        optional :tags, Lithic::Internal::Type::HashOf[String]
+
+        # @!attribute title
+        #   New title for the case, or `null` to clear it
+        #
+        #   @return [String, nil]
+        optional :title, String, nil?: true
+
+        # @!method initialize(case_token:, actor_token: nil, assignee: nil, priority: nil, resolution: nil, resolution_notes: nil, sla_deadline: nil, status: nil, tags: nil, title: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Lithic::Models::TransactionMonitoring::CaseUpdateParams} for more details.
+        #
+        #   @param case_token [String]
+        #
+        #   @param actor_token [String] Optional client-provided identifier for the actor performing this action,
+        #
+        #   @param assignee [String, nil] New assignee for the case, or `null` to unassign
+        #
+        #   @param priority [Symbol, Lithic::Models::TransactionMonitoring::CasePriority] Priority level of a case, controlling queue ordering and SLA urgency
+        #
+        #   @param resolution [Symbol, Lithic::Models::TransactionMonitoring::ResolutionOutcome] Outcome recorded when a case is resolved:
+        #
+        #   @param resolution_notes [String] Notes describing the resolution
+        #
+        #   @param sla_deadline [Time, nil] New SLA deadline for the case, or `null` to clear it
+        #
+        #   @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 to set on the case
+        #
+        #   @param title [String, nil] New title for the case, or `null` to clear it
+        #
+        #   @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,141 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    module TransactionMonitoring
+      module Cases
+        # @see Lithic::Resources::TransactionMonitoring::Cases::Files#create
+        class CaseFile < Lithic::Internal::Type::BaseModel
+          # @!attribute token
+          #   Globally unique identifier for the file
+          #
+          #   @return [String]
+          required :token, String
+
+          # @!attribute created
+          #   Date and time at which the file record was created
+          #
+          #   @return [Time]
+          required :created, Time
+
+          # @!attribute download_url
+          #   Presigned URL the client uses to download the file
+          #
+          #   @return [String, nil]
+          required :download_url, String, nil?: true
+
+          # @!attribute download_url_expires
+          #   Date and time at which the download URL expires
+          #
+          #   @return [Time, nil]
+          required :download_url_expires, Time, nil?: true
+
+          # @!attribute failure_reason
+          #   Reason the file was rejected, when applicable
+          #
+          #   @return [String, nil]
+          required :failure_reason, String, nil?: true
+
+          # @!attribute mime_type
+          #   MIME type of the file, available once the file is ready
+          #
+          #   @return [String, nil]
+          required :mime_type, String, nil?: true
+
+          # @!attribute name
+          #   Name of the file
+          #
+          #   @return [String]
+          required :name, String
+
+          # @!attribute size_bytes
+          #   Size of the file in bytes, available once the file is ready
+          #
+          #   @return [Integer, nil]
+          required :size_bytes, Integer, nil?: true
+
+          # @!attribute status
+          #   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
+          #
+          #   @return [Symbol, Lithic::Models::TransactionMonitoring::Cases::FileStatus]
+          required :status, enum: -> { Lithic::TransactionMonitoring::Cases::FileStatus }
+
+          # @!attribute updated
+          #   Date and time at which the file record was last updated
+          #
+          #   @return [Time]
+          required :updated, Time
+
+          # @!attribute upload_constraints
+          #   Constraints applied to a file upload, returned alongside the upload URL so
+          #   clients can validate before uploading
+          #
+          #   @return [Lithic::Models::TransactionMonitoring::Cases::UploadConstraints, nil]
+          required :upload_constraints,
+                   -> {
+                     Lithic::TransactionMonitoring::Cases::UploadConstraints
+                   },
+                   nil?: true
+
+          # @!attribute upload_url
+          #   Presigned URL the client uses to upload the file
+          #
+          #   @return [String, nil]
+          required :upload_url, String, nil?: true
+
+          # @!attribute upload_url_expires
+          #   Date and time at which the upload URL expires
+          #
+          #   @return [Time, nil]
+          required :upload_url_expires, Time, nil?: true
+
+          # @!method initialize(token:, created:, download_url:, download_url_expires:, failure_reason:, mime_type:, name:, size_bytes:, status:, updated:, upload_constraints:, upload_url:, upload_url_expires:)
+          #   Some parameter documentations has been truncated, see
+          #   {Lithic::Models::TransactionMonitoring::Cases::CaseFile} for more details.
+          #
+          #   A file attached to a case. Status-dependent fields are always present but may be
+          #   `null`:
+          #
+          #   - `upload_url`, `upload_url_expires`, and `upload_constraints` are populated
+          #     when `status` is `PENDING` or `REJECTED`
+          #   - `download_url` and `download_url_expires` are populated when `status` is
+          #     `READY`
+          #   - `failure_reason` is populated when `status` is `REJECTED`
+          #
+          #   @param token [String] Globally unique identifier for the file
+          #
+          #   @param created [Time] Date and time at which the file record was created
+          #
+          #   @param download_url [String, nil] Presigned URL the client uses to download the file
+          #
+          #   @param download_url_expires [Time, nil] Date and time at which the download URL expires
+          #
+          #   @param failure_reason [String, nil] Reason the file was rejected, when applicable
+          #
+          #   @param mime_type [String, nil] MIME type of the file, available once the file is ready
+          #
+          #   @param name [String] Name of the file
+          #
+          #   @param size_bytes [Integer, nil] Size of the file in bytes, available once the file is ready
+          #
+          #   @param status [Symbol, Lithic::Models::TransactionMonitoring::Cases::FileStatus] Lifecycle status of a case file:
+          #
+          #   @param updated [Time] Date and time at which the file record was last updated
+          #
+          #   @param upload_constraints [Lithic::Models::TransactionMonitoring::Cases::UploadConstraints, nil] Constraints applied to a file upload, returned alongside the upload URL so clien
+          #
+          #   @param upload_url [String, nil] Presigned URL the client uses to upload the file
+          #
+          #   @param upload_url_expires [Time, nil] Date and time at which the upload URL expires
+        end
+      end
+
+      CaseFile = Cases::CaseFile
+    end
+  end
+end

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