lithic 0.14.0 → 0.16.0

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

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    module TransactionMonitoring
+      # @see Lithic::Resources::TransactionMonitoring::Cases#list_activity
+      class CaseActivityEntry < Lithic::Internal::Type::BaseModel
+        # @!attribute token
+        #   Globally unique identifier for the activity entry
+        #
+        #   @return [String]
+        required :token, String
+
+        # @!attribute actor_token
+        #   Identifier of the actor that produced the activity entry
+        #
+        #   @return [String, nil]
+        required :actor_token, String, nil?: true
+
+        # @!attribute created
+        #   Date and time at which the activity entry was created
+        #
+        #   @return [Time]
+        required :created, Time
+
+        # @!attribute entry_type
+        #   The case field that changed, or the action that was taken, in an activity entry:
+        #
+        #   - `STATUS` - The case status changed
+        #   - `TITLE` - The case title changed
+        #   - `ASSIGNED_TO` - The case assignee changed
+        #   - `RESOLUTION_OUTCOME` - The resolution outcome was set or changed
+        #   - `RESOLUTION_NOTES` - The resolution notes were set or changed
+        #   - `TAGS` - The case tags changed
+        #   - `PRIORITY` - The case priority changed
+        #   - `COMMENT` - A comment was added or edited
+        #   - `FILE` - A file was attached to the case
+        #
+        #   @return [Symbol, Lithic::Models::TransactionMonitoring::CaseActivityType]
+        required :entry_type, enum: -> { Lithic::TransactionMonitoring::CaseActivityType }
+
+        # @!attribute new_value
+        #   New value of the changed field, when applicable
+        #
+        #   @return [String, nil]
+        required :new_value, String, nil?: true
+
+        # @!attribute previous_value
+        #   Previous value of the changed field, when applicable
+        #
+        #   @return [String, nil]
+        required :previous_value, String, nil?: true
+
+        # @!method initialize(token:, actor_token:, created:, entry_type:, new_value:, previous_value:)
+        #   Some parameter documentations has been truncated, see
+        #   {Lithic::Models::TransactionMonitoring::CaseActivityEntry} for more details.
+        #
+        #   A single entry in a case's activity feed
+        #
+        #   @param token [String] Globally unique identifier for the activity entry
+        #
+        #   @param actor_token [String, nil] Identifier of the actor that produced the activity entry
+        #
+        #   @param created [Time] Date and time at which the activity entry was created
+        #
+        #   @param entry_type [Symbol, Lithic::Models::TransactionMonitoring::CaseActivityType] The case field that changed, or the action that was taken, in an activity entry:
+        #
+        #   @param new_value [String, nil] New value of the changed field, when applicable
+        #
+        #   @param previous_value [String, nil] Previous value of the changed field, when applicable
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    module TransactionMonitoring
+      # The case field that changed, or the action that was taken, in an activity entry:
+      #
+      # - `STATUS` - The case status changed
+      # - `TITLE` - The case title changed
+      # - `ASSIGNED_TO` - The case assignee changed
+      # - `RESOLUTION_OUTCOME` - The resolution outcome was set or changed
+      # - `RESOLUTION_NOTES` - The resolution notes were set or changed
+      # - `TAGS` - The case tags changed
+      # - `PRIORITY` - The case priority changed
+      # - `COMMENT` - A comment was added or edited
+      # - `FILE` - A file was attached to the case
+      module CaseActivityType
+        extend Lithic::Internal::Type::Enum
+
+        STATUS = :STATUS
+        TITLE = :TITLE
+        ASSIGNED_TO = :ASSIGNED_TO
+        RESOLUTION_OUTCOME = :RESOLUTION_OUTCOME
+        RESOLUTION_NOTES = :RESOLUTION_NOTES
+        TAGS = :TAGS
+        PRIORITY = :PRIORITY
+        COMMENT = :COMMENT
+        FILE = :FILE
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    module TransactionMonitoring
+      class CaseCard < Lithic::Internal::Type::BaseModel
+        # @!attribute account_token
+        #   Token of the account the card belongs to
+        #
+        #   @return [String]
+        required :account_token, String
+
+        # @!attribute card_token
+        #   Token of the card
+        #
+        #   @return [String]
+        required :card_token, String
+
+        # @!attribute transaction_count
+        #   Number of the card's transactions associated with the case
+        #
+        #   @return [Integer]
+        required :transaction_count, Integer
+
+        # @!method initialize(account_token:, card_token:, transaction_count:)
+        #   Summary of a card's involvement in a case, aggregated across the case's
+        #   transactions
+        #
+        #   @param account_token [String] Token of the account the card belongs to
+        #
+        #   @param card_token [String] Token of the card
+        #
+        #   @param transaction_count [Integer] Number of the card's transactions associated with the case
+      end
+    end
+  end
+end

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

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    module TransactionMonitoring
+      class CaseEntity < Lithic::Internal::Type::BaseModel
+        # @!attribute entity_token
+        #   Globally unique identifier for the associated entity
+        #
+        #   @return [String]
+        required :entity_token, String
+
+        # @!attribute entity_type
+        #   The type of entity a case is associated with:
+        #
+        #   - `CARD` - The case is associated with a card
+        #   - `ACCOUNT` - The case is associated with an account
+        #
+        #   @return [Symbol, Lithic::Models::TransactionMonitoring::CaseEntity::EntityType]
+        required :entity_type, enum: -> { Lithic::TransactionMonitoring::CaseEntity::EntityType }
+
+        # @!method initialize(entity_token:, entity_type:)
+        #   Some parameter documentations has been truncated, see
+        #   {Lithic::Models::TransactionMonitoring::CaseEntity} for more details.
+        #
+        #   The entity a case is associated with
+        #
+        #   @param entity_token [String] Globally unique identifier for the associated entity
+        #
+        #   @param entity_type [Symbol, Lithic::Models::TransactionMonitoring::CaseEntity::EntityType] The type of entity a case is associated with:
+
+        # The type of entity a case is associated with:
+        #
+        # - `CARD` - The case is associated with a card
+        # - `ACCOUNT` - The case is associated with an account
+        #
+        # @see Lithic::Models::TransactionMonitoring::CaseEntity#entity_type
+        module EntityType
+          extend Lithic::Internal::Type::Enum
+
+          CARD = :CARD
+          ACCOUNT = :ACCOUNT
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

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

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