lithic 0.15.0 → 0.16.0

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

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

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

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    module TransactionMonitoring
+      # @see Lithic::Resources::TransactionMonitoring::Queues#list
+      class QueueListParams < Lithic::Internal::Type::BaseModel
+        extend Lithic::Internal::Type::RequestParameters::Converter
+        include Lithic::Internal::Type::RequestParameters
+
+        # @!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(ending_before: nil, page_size: nil, starting_after: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Lithic::Models::TransactionMonitoring::QueueListParams} for more details.
+        #
+        #   @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/queue_retrieve_params.rb

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

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

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    module TransactionMonitoring
+      # @see Lithic::Resources::TransactionMonitoring::Queues#update
+      class QueueUpdateParams < Lithic::Internal::Type::BaseModel
+        extend Lithic::Internal::Type::RequestParameters::Converter
+        include Lithic::Internal::Type::RequestParameters
+
+        # @!attribute queue_token
+        #
+        #   @return [String]
+        required :queue_token, String
+
+        # @!attribute description
+        #   New description for the queue, or `null` to clear it
+        #
+        #   @return [String, nil]
+        optional :description, String, nil?: true
+
+        # @!attribute name
+        #   New name for the queue
+        #
+        #   @return [String, nil]
+        optional :name, String
+
+        # @!method initialize(queue_token:, description: nil, name: nil, request_options: {})
+        #   @param queue_token [String]
+        #
+        #   @param description [String, nil] New description for the queue, or `null` to clear it
+        #
+        #   @param name [String] New name for the queue
+        #
+        #   @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    module TransactionMonitoring
+      # 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
+      module ResolutionOutcome
+        extend Lithic::Internal::Type::Enum
+
+        CONFIRMED_FRAUD = :CONFIRMED_FRAUD
+        SUSPICIOUS_ACTIVITY = :SUSPICIOUS_ACTIVITY
+        FALSE_POSITIVE = :FALSE_POSITIVE
+        NO_ACTION_REQUIRED = :NO_ACTION_REQUIRED
+        ESCALATED_EXTERNAL = :ESCALATED_EXTERNAL
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/lithic/models/transaction_route_params.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    # @see Lithic::Resources::Transactions#route
+    class TransactionRouteParams < Lithic::Internal::Type::BaseModel
+      extend Lithic::Internal::Type::RequestParameters::Converter
+      include Lithic::Internal::Type::RequestParameters
+
+      # @!attribute transaction_token
+      #
+      #   @return [String]
+      required :transaction_token, String
+
+      # @!attribute financial_account_token
+      #   The token of the financial account to route the transaction to.
+      #
+      #   @return [String]
+      required :financial_account_token, String
+
+      # @!method initialize(transaction_token:, financial_account_token:, request_options: {})
+      #   @param transaction_token [String]
+      #
+      #   @param financial_account_token [String] The token of the financial account to route the transaction to.
+      #
+      #   @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/lithic/models.rb

@@ -574,8 +574,12 @@ module Lithic
 
   TransactionListParams = Lithic::Models::TransactionListParams
 
+  TransactionMonitoring = Lithic::Models::TransactionMonitoring
+
   TransactionRetrieveParams = Lithic::Models::TransactionRetrieveParams
 
+  TransactionRouteParams = Lithic::Models::TransactionRouteParams
+
   Transactions = Lithic::Models::Transactions
 
   TransactionSimulateAuthorizationAdviceParams =

data/lib/lithic/resources/account_holders/entities.rb

@@ -31,7 +31,7 @@ module Lithic
         #
         # @param phone_number [String] Individual's phone number, entered in E.164 format.
         #
-        # @param type [Symbol, Lithic::Models::AccountHolders::EntityCreateParams::Type] The type of entity to create on the account holder
+        # @param type [Symbol, Lithic::Models::TransactionMonitoring::EntityType] The type of entity to create on the account holder
         #
         # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
         #

data/lib/lithic/resources/cards.rb

@@ -453,8 +453,8 @@ module Lithic
 
       # Get card configuration such as spend limit and state. Customers must be PCI
       # compliant to use this endpoint. Please contact
-      # [support@lithic.com](mailto:support@lithic.com) for questions. _Note: this is a
-      # `POST` endpoint because it is more secure to send sensitive data in a request
+      # [support.lithic.com](https://support.lithic.com/) for questions. _Note: this is
+      # a `POST` endpoint because it is more secure to send sensitive data in a request
       # body than in a URL._
       #
       # @overload search_by_pan(pan:, request_options: {})

data/lib/lithic/resources/transaction_monitoring/cases/comments.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Resources
+    class TransactionMonitoring
+      class Cases
+        class Comments
+          # Some parameter documentations has been truncated, see
+          # {Lithic::Models::TransactionMonitoring::Cases::CommentCreateParams} for more
+          # details.
+          #
+          # Adds a comment to a case.
+          #
+          # @overload create(case_token, comment:, actor_token: nil, request_options: {})
+          #
+          # @param case_token [String] Globally unique identifier for the case.
+          #
+          # @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}, nil]
+          #
+          # @return [Lithic::Models::TransactionMonitoring::CaseActivityEntry]
+          #
+          # @see Lithic::Models::TransactionMonitoring::Cases::CommentCreateParams
+          def create(case_token, params)
+            parsed, options = Lithic::TransactionMonitoring::Cases::CommentCreateParams.dump_request(params)
+            @client.request(
+              method: :post,
+              path: ["v1/transaction_monitoring/cases/%1$s/comments", case_token],
+              body: parsed,
+              model: Lithic::TransactionMonitoring::CaseActivityEntry,
+              options: options
+            )
+          end
+
+          # Some parameter documentations has been truncated, see
+          # {Lithic::Models::TransactionMonitoring::Cases::CommentUpdateParams} for more
+          # details.
+          #
+          # Edits an existing comment on a case.
+          #
+          # @overload update(comment_token, case_token:, comment:, actor_token: nil, request_options: {})
+          #
+          # @param comment_token [String] Path param: Globally unique identifier for the comment.
+          #
+          # @param case_token [String] Path param: Globally unique identifier for the case.
+          #
+          # @param comment [String] Body param: New text of the comment
+          #
+          # @param actor_token [String] Body param: Optional client-provided identifier for the actor performing this ac
+          #
+          # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [Lithic::Models::TransactionMonitoring::CaseActivityEntry]
+          #
+          # @see Lithic::Models::TransactionMonitoring::Cases::CommentUpdateParams
+          def update(comment_token, params)
+            parsed, options = Lithic::TransactionMonitoring::Cases::CommentUpdateParams.dump_request(params)
+            case_token =
+              parsed.delete(:case_token) do
+                raise ArgumentError.new("missing required path argument #{_1}")
+              end
+            @client.request(
+              method: :patch,
+              path: ["v1/transaction_monitoring/cases/%1$s/comments/%2$s", case_token, comment_token],
+              body: parsed,
+              model: Lithic::TransactionMonitoring::CaseActivityEntry,
+              options: options
+            )
+          end
+
+          # Deletes a comment from a case.
+          #
+          # @overload delete(comment_token, case_token:, request_options: {})
+          #
+          # @param comment_token [String] Globally unique identifier for the comment.
+          #
+          # @param case_token [String] Globally unique identifier for the case.
+          #
+          # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [nil]
+          #
+          # @see Lithic::Models::TransactionMonitoring::Cases::CommentDeleteParams
+          def delete(comment_token, params)
+            parsed, options = Lithic::TransactionMonitoring::Cases::CommentDeleteParams.dump_request(params)
+            case_token =
+              parsed.delete(:case_token) do
+                raise ArgumentError.new("missing required path argument #{_1}")
+              end
+            @client.request(
+              method: :delete,
+              path: ["v1/transaction_monitoring/cases/%1$s/comments/%2$s", case_token, comment_token],
+              model: NilClass,
+              options: options
+            )
+          end
+
+          # @api private
+          #
+          # @param client [Lithic::Client]
+          def initialize(client:)
+            @client = client
+          end
+        end
+      end
+    end
+  end
+end

data/lib/lithic/resources/transaction_monitoring/cases/files.rb

@@ -0,0 +1,131 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Resources
+    class TransactionMonitoring
+      class Cases
+        class Files
+          # Creates a file record and returns a presigned URL for uploading the file to the
+          # case.
+          #
+          # @overload create(case_token, name:, request_options: {})
+          #
+          # @param case_token [String] Globally unique identifier for the case.
+          #
+          # @param name [String] Name of the file to upload
+          #
+          # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [Lithic::Models::TransactionMonitoring::Cases::CaseFile]
+          #
+          # @see Lithic::Models::TransactionMonitoring::Cases::FileCreateParams
+          def create(case_token, params)
+            parsed, options = Lithic::TransactionMonitoring::Cases::FileCreateParams.dump_request(params)
+            @client.request(
+              method: :post,
+              path: ["v1/transaction_monitoring/cases/%1$s/files", case_token],
+              body: parsed,
+              model: Lithic::TransactionMonitoring::Cases::CaseFile,
+              options: options
+            )
+          end
+
+          # Retrieves a single file attached to a case, including a presigned download URL
+          # when the file is ready.
+          #
+          # @overload retrieve(file_token, case_token:, request_options: {})
+          #
+          # @param file_token [String] Globally unique identifier for the file.
+          #
+          # @param case_token [String] Globally unique identifier for the case.
+          #
+          # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [Lithic::Models::TransactionMonitoring::Cases::CaseFile]
+          #
+          # @see Lithic::Models::TransactionMonitoring::Cases::FileRetrieveParams
+          def retrieve(file_token, params)
+            parsed, options = Lithic::TransactionMonitoring::Cases::FileRetrieveParams.dump_request(params)
+            case_token =
+              parsed.delete(:case_token) do
+                raise ArgumentError.new("missing required path argument #{_1}")
+              end
+            @client.request(
+              method: :get,
+              path: ["v1/transaction_monitoring/cases/%1$s/files/%2$s", case_token, file_token],
+              model: Lithic::TransactionMonitoring::Cases::CaseFile,
+              options: options
+            )
+          end
+
+          # Some parameter documentations has been truncated, see
+          # {Lithic::Models::TransactionMonitoring::Cases::FileListParams} for more details.
+          #
+          # Lists the files attached to a case.
+          #
+          # @overload list(case_token, ending_before: nil, page_size: nil, starting_after: nil, request_options: {})
+          #
+          # @param case_token [String] Globally unique identifier for the case.
+          #
+          # @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}, nil]
+          #
+          # @return [Lithic::Internal::CursorPage<Lithic::Models::TransactionMonitoring::Cases::CaseFile>]
+          #
+          # @see Lithic::Models::TransactionMonitoring::Cases::FileListParams
+          def list(case_token, params = {})
+            parsed, options = Lithic::TransactionMonitoring::Cases::FileListParams.dump_request(params)
+            query = Lithic::Internal::Util.encode_query_params(parsed)
+            @client.request(
+              method: :get,
+              path: ["v1/transaction_monitoring/cases/%1$s/files", case_token],
+              query: query,
+              page: Lithic::Internal::CursorPage,
+              model: Lithic::TransactionMonitoring::Cases::CaseFile,
+              options: options
+            )
+          end
+
+          # Deletes a file from a case.
+          #
+          # @overload delete(file_token, case_token:, request_options: {})
+          #
+          # @param file_token [String] Globally unique identifier for the file.
+          #
+          # @param case_token [String] Globally unique identifier for the case.
+          #
+          # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [nil]
+          #
+          # @see Lithic::Models::TransactionMonitoring::Cases::FileDeleteParams
+          def delete(file_token, params)
+            parsed, options = Lithic::TransactionMonitoring::Cases::FileDeleteParams.dump_request(params)
+            case_token =
+              parsed.delete(:case_token) do
+                raise ArgumentError.new("missing required path argument #{_1}")
+              end
+            @client.request(
+              method: :delete,
+              path: ["v1/transaction_monitoring/cases/%1$s/files/%2$s", case_token, file_token],
+              model: NilClass,
+              options: options
+            )
+          end
+
+          # @api private
+          #
+          # @param client [Lithic::Client]
+          def initialize(client:)
+            @client = client
+          end
+        end
+      end
+    end
+  end
+end