|
| 1 | +# frozen_string_literal: true |
| 2 | + |
| 3 | +module Lithic |
| 4 | + module Models |
| 5 | + module TransactionMonitoring |
| 6 | + # @see Lithic::Resources::TransactionMonitoring::Cases#list_activity |
| 7 | + class CaseActivityEntry < Lithic::Internal::Type::BaseModel |
| 8 | + # @!attribute token |
| 9 | + # Globally unique identifier for the activity entry |
| 10 | + # |
| 11 | + # @return [String] |
| 12 | + required :token, String |
| 13 | + |
| 14 | + # @!attribute actor_token |
| 15 | + # Identifier of the actor that produced the activity entry |
| 16 | + # |
| 17 | + # @return [String, nil] |
| 18 | + required :actor_token, String, nil?: true |
| 19 | + |
| 20 | + # @!attribute created |
| 21 | + # Date and time at which the activity entry was created |
| 22 | + # |
| 23 | + # @return [Time] |
| 24 | + required :created, Time |
| 25 | + |
| 26 | + # @!attribute entry_type |
| 27 | + # The case field that changed, or the action that was taken, in an activity entry: |
| 28 | + # |
| 29 | + # - `STATUS` - The case status changed |
| 30 | + # - `TITLE` - The case title changed |
| 31 | + # - `ASSIGNED_TO` - The case assignee changed |
| 32 | + # - `RESOLUTION_OUTCOME` - The resolution outcome was set or changed |
| 33 | + # - `RESOLUTION_NOTES` - The resolution notes were set or changed |
| 34 | + # - `TAGS` - The case tags changed |
| 35 | + # - `PRIORITY` - The case priority changed |
| 36 | + # - `COMMENT` - A comment was added or edited |
| 37 | + # - `FILE` - A file was attached to the case |
| 38 | + # |
| 39 | + # @return [Symbol, Lithic::Models::TransactionMonitoring::CaseActivityType] |
| 40 | + required :entry_type, enum: -> { Lithic::TransactionMonitoring::CaseActivityType } |
| 41 | + |
| 42 | + # @!attribute new_value |
| 43 | + # New value of the changed field, when applicable |
| 44 | + # |
| 45 | + # @return [String, nil] |
| 46 | + required :new_value, String, nil?: true |
| 47 | + |
| 48 | + # @!attribute previous_value |
| 49 | + # Previous value of the changed field, when applicable |
| 50 | + # |
| 51 | + # @return [String, nil] |
| 52 | + required :previous_value, String, nil?: true |
| 53 | + |
| 54 | + # @!method initialize(token:, actor_token:, created:, entry_type:, new_value:, previous_value:) |
| 55 | + # Some parameter documentations has been truncated, see |
| 56 | + # {Lithic::Models::TransactionMonitoring::CaseActivityEntry} for more details. |
| 57 | + # |
| 58 | + # A single entry in a case's activity feed |
| 59 | + # |
| 60 | + # @param token [String] Globally unique identifier for the activity entry |
| 61 | + # |
| 62 | + # @param actor_token [String, nil] Identifier of the actor that produced the activity entry |
| 63 | + # |
| 64 | + # @param created [Time] Date and time at which the activity entry was created |
| 65 | + # |
| 66 | + # @param entry_type [Symbol, Lithic::Models::TransactionMonitoring::CaseActivityType] The case field that changed, or the action that was taken, in an activity entry: |
| 67 | + # |
| 68 | + # @param new_value [String, nil] New value of the changed field, when applicable |
| 69 | + # |
| 70 | + # @param previous_value [String, nil] Previous value of the changed field, when applicable |
| 71 | + end |
| 72 | + end |
| 73 | + end |
| 74 | +end |
0 commit comments