lithic 0.15.0 → 0.16.0

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

@@ -0,0 +1,136 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    module TransactionMonitoring
+      # @see Lithic::Resources::TransactionMonitoring::Cases#list
+      class CaseListParams < Lithic::Internal::Type::BaseModel
+        extend Lithic::Internal::Type::RequestParameters::Converter
+        include Lithic::Internal::Type::RequestParameters
+
+        # @!attribute account_token
+        #   Only return cases that include transactions on the provided account.
+        #
+        #   @return [String, nil]
+        optional :account_token, String
+
+        # @!attribute assignee
+        #   Only return cases assigned to the provided value. Pass an empty string to return
+        #   only unassigned cases.
+        #
+        #   @return [String, nil]
+        optional :assignee, String
+
+        # @!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 card_token
+        #   Only return cases that include transactions on the provided card.
+        #
+        #   @return [String, nil]
+        optional :card_token, String
+
+        # @!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 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 entity_token
+        #   Only return cases associated with the provided entity.
+        #
+        #   @return [String, nil]
+        optional :entity_token, String
+
+        # @!attribute page_size
+        #   Page size (for pagination).
+        #
+        #   @return [Integer, nil]
+        optional :page_size, Integer
+
+        # @!attribute queue_token
+        #   Only return cases belonging to the provided queue.
+        #
+        #   @return [String, nil]
+        optional :queue_token, String
+
+        # @!attribute rule_token
+        #   Only return cases triggered by the provided transaction monitoring rule.
+        #
+        #   @return [String, nil]
+        optional :rule_token, String
+
+        # @!attribute sort_by
+        #   Sort order for the returned cases.
+        #
+        #   @return [Symbol, Lithic::Models::TransactionMonitoring::CaseSortOrder, nil]
+        optional :sort_by, enum: -> { Lithic::TransactionMonitoring::CaseSortOrder }
+
+        # @!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
+
+        # @!attribute status
+        #   Only return cases with the provided status.
+        #
+        #   @return [Symbol, Lithic::Models::TransactionMonitoring::CaseStatus, nil]
+        optional :status, enum: -> { Lithic::TransactionMonitoring::CaseStatus }
+
+        # @!attribute transaction_token
+        #   Only return cases that include the provided transaction.
+        #
+        #   @return [String, nil]
+        optional :transaction_token, String
+
+        # @!method initialize(account_token: nil, assignee: nil, begin_: nil, card_token: nil, end_: nil, ending_before: nil, entity_token: nil, page_size: nil, queue_token: nil, rule_token: nil, sort_by: nil, starting_after: nil, status: nil, transaction_token: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Lithic::Models::TransactionMonitoring::CaseListParams} for more details.
+        #
+        #   @param account_token [String] Only return cases that include transactions on the provided account.
+        #
+        #   @param assignee [String] Only return cases assigned to the provided value. Pass an empty string to return
+        #
+        #   @param begin_ [Time] Date string in RFC 3339 format. Only entries created after the specified time wi
+        #
+        #   @param card_token [String] Only return cases that include transactions on the provided card.
+        #
+        #   @param end_ [Time] Date string in RFC 3339 format. Only entries created before the specified time w
+        #
+        #   @param ending_before [String] A cursor representing an item's token before which a page of results should end.
+        #
+        #   @param entity_token [String] Only return cases associated with the provided entity.
+        #
+        #   @param page_size [Integer] Page size (for pagination).
+        #
+        #   @param queue_token [String] Only return cases belonging to the provided queue.
+        #
+        #   @param rule_token [String] Only return cases triggered by the provided transaction monitoring rule.
+        #
+        #   @param sort_by [Symbol, Lithic::Models::TransactionMonitoring::CaseSortOrder] Sort order for the returned cases.
+        #
+        #   @param starting_after [String] A cursor representing an item's token after which a page of results should begin
+        #
+        #   @param status [Symbol, Lithic::Models::TransactionMonitoring::CaseStatus] Only return cases with the provided status.
+        #
+        #   @param transaction_token [String] Only return cases that include the provided transaction.
+        #
+        #   @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    module TransactionMonitoring
+      # @see Lithic::Resources::TransactionMonitoring::Cases#list_transactions
+      class CaseListTransactionsParams < 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::CaseListTransactionsParams} 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

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    module TransactionMonitoring
+      # Priority level of a case, controlling queue ordering and SLA urgency
+      module CasePriority
+        extend Lithic::Internal::Type::Enum
+
+        LOW = :LOW
+        MEDIUM = :MEDIUM
+        HIGH = :HIGH
+        CRITICAL = :CRITICAL
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    module TransactionMonitoring
+      # @type [Lithic::Internal::Type::Converter]
+      CaseRetrieveCardsResponse =
+        Lithic::Internal::Type::ArrayOf[-> { Lithic::TransactionMonitoring::CaseCard }]
+    end
+  end
+end

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

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

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    module TransactionMonitoring
+      # Sort order for listing cases. Defaults to `CREATED_DESC` (newest first):
+      #
+      # - `CREATED_ASC` - Oldest first
+      # - `CREATED_DESC` - Newest first
+      # - `PRIORITY_DESC` - Highest priority first
+      # - `PRIORITY_ASC` - Lowest priority first
+      # - `STATUS_DESC` - Furthest workflow stage first
+      # - `STATUS_ASC` - Earliest workflow stage first
+      module CaseSortOrder
+        extend Lithic::Internal::Type::Enum
+
+        CREATED_ASC = :CREATED_ASC
+        CREATED_DESC = :CREATED_DESC
+        PRIORITY_DESC = :PRIORITY_DESC
+        PRIORITY_ASC = :PRIORITY_ASC
+        STATUS_DESC = :STATUS_DESC
+        STATUS_ASC = :STATUS_ASC
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    module TransactionMonitoring
+      # 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
+      module CaseStatus
+        extend Lithic::Internal::Type::Enum
+
+        OPEN = :OPEN
+        ASSIGNED = :ASSIGNED
+        IN_REVIEW = :IN_REVIEW
+        ESCALATED = :ESCALATED
+        RESOLVED = :RESOLVED
+        CLOSED = :CLOSED
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    module TransactionMonitoring
+      # @see Lithic::Resources::TransactionMonitoring::Cases#list_transactions
+      class CaseTransaction < Lithic::Internal::Type::BaseModel
+        # @!attribute token
+        #   Globally unique identifier for the transaction
+        #
+        #   @return [String]
+        required :token, String
+
+        # @!attribute account_token
+        #   Token of the account the transaction belongs to
+        #
+        #   @return [String]
+        required :account_token, String
+
+        # @!attribute added_at
+        #   Date and time at which the transaction was added to the case
+        #
+        #   @return [Time]
+        required :added_at, Time
+
+        # @!attribute card_token
+        #   Token of the card the transaction was made on
+        #
+        #   @return [String]
+        required :card_token, String
+
+        # @!attribute transaction_created_at
+        #   Date and time at which the transaction was created
+        #
+        #   @return [Time]
+        required :transaction_created_at, Time
+
+        # @!method initialize(token:, account_token:, added_at:, card_token:, transaction_created_at:)
+        #   A single transaction associated with a case
+        #
+        #   @param token [String] Globally unique identifier for the transaction
+        #
+        #   @param account_token [String] Token of the account the transaction belongs to
+        #
+        #   @param added_at [Time] Date and time at which the transaction was added to the case
+        #
+        #   @param card_token [String] Token of the card the transaction was made on
+        #
+        #   @param transaction_created_at [Time] Date and time at which the transaction was created
+      end
+    end
+  end
+end

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