lithic 0.14.0 → 0.16.0

data/lib/lithic/resources/card_authorizations.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Resources
+    class CardAuthorizations
+      # Some parameter documentations has been truncated, see
+      # {Lithic::Models::CardAuthorizationChallengeResponseParams} for more details.
+      #
+      # Card program's response to Authorization Challenge. Programs that have
+      # Authorization Challenges configured as Out of Band receive a
+      # [card_authorization.challenge](https://docs.lithic.com/reference/post_card-authorization-challenge)
+      # webhook when an authorization attempt triggers a challenge. The card program
+      # should respond using this endpoint after the cardholder completes the challenge.
+      #
+      # @overload challenge_response(event_token, response:, request_options: {})
+      #
+      # @param event_token [String] Globally unique identifier for the authorization event that triggered the challe
+      #
+      # @param response [Symbol, Lithic::Models::CardAuthorizationChallengeResponseParams::Response] Whether the cardholder has approved or declined the issued challenge
+      #
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [nil]
+      #
+      # @see Lithic::Models::CardAuthorizationChallengeResponseParams
+      def challenge_response(event_token, params)
+        parsed, options = Lithic::CardAuthorizationChallengeResponseParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: ["v1/card_authorizations/%1$s/challenge_response", event_token],
+          body: parsed,
+          model: NilClass,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Lithic::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

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/external_bank_accounts.rb

@@ -132,6 +132,25 @@ module Lithic
         )
       end
 
+      # Pause an external bank account
+      #
+      # @overload pause(external_bank_account_token, request_options: {})
+      #
+      # @param external_bank_account_token [String]
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Lithic::Models::ExternalBankAccount]
+      #
+      # @see Lithic::Models::ExternalBankAccountPauseParams
+      def pause(external_bank_account_token, params = {})
+        @client.request(
+          method: :post,
+          path: ["v1/external_bank_accounts/%1$s/pause", external_bank_account_token],
+          model: Lithic::ExternalBankAccount,
+          options: params[:request_options]
+        )
+      end
+
       # Retry external bank account micro deposit verification.
       #
       # @overload retry_micro_deposits(external_bank_account_token, financial_account_token: nil, 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

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

@@ -0,0 +1,228 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Resources
+    class TransactionMonitoring
+      class Cases
+        # @return [Lithic::Resources::TransactionMonitoring::Cases::Comments]
+        attr_reader :comments
+
+        # @return [Lithic::Resources::TransactionMonitoring::Cases::Files]
+        attr_reader :files
+
+        # Retrieves a single transaction monitoring case.
+        #
+        # @overload retrieve(case_token, request_options: {})
+        #
+        # @param case_token [String] Globally unique identifier for the case.
+        #
+        # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Lithic::Models::TransactionMonitoring::MonitoringCase]
+        #
+        # @see Lithic::Models::TransactionMonitoring::CaseRetrieveParams
+        def retrieve(case_token, params = {})
+          @client.request(
+            method: :get,
+            path: ["v1/transaction_monitoring/cases/%1$s", case_token],
+            model: Lithic::TransactionMonitoring::MonitoringCase,
+            options: params[:request_options]
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {Lithic::Models::TransactionMonitoring::CaseUpdateParams} for more details.
+        #
+        # Updates a transaction monitoring case.
+        #
+        # @overload update(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: {})
+        #
+        # @param case_token [String] Globally unique identifier for the case.
+        #
+        # @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}, nil]
+        #
+        # @return [Lithic::Models::TransactionMonitoring::MonitoringCase]
+        #
+        # @see Lithic::Models::TransactionMonitoring::CaseUpdateParams
+        def update(case_token, params = {})
+          parsed, options = Lithic::TransactionMonitoring::CaseUpdateParams.dump_request(params)
+          @client.request(
+            method: :patch,
+            path: ["v1/transaction_monitoring/cases/%1$s", case_token],
+            body: parsed,
+            model: Lithic::TransactionMonitoring::MonitoringCase,
+            options: options
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {Lithic::Models::TransactionMonitoring::CaseListParams} for more details.
+        #
+        # Lists transaction monitoring cases, optionally filtered.
+        #
+        # @overload list(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: {})
+        #
+        # @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}, nil]
+        #
+        # @return [Lithic::Internal::CursorPage<Lithic::Models::TransactionMonitoring::MonitoringCase>]
+        #
+        # @see Lithic::Models::TransactionMonitoring::CaseListParams
+        def list(params = {})
+          parsed, options = Lithic::TransactionMonitoring::CaseListParams.dump_request(params)
+          query = Lithic::Internal::Util.encode_query_params(parsed)
+          @client.request(
+            method: :get,
+            path: "v1/transaction_monitoring/cases",
+            query: query.transform_keys(begin_: "begin", end_: "end"),
+            page: Lithic::Internal::CursorPage,
+            model: Lithic::TransactionMonitoring::MonitoringCase,
+            options: options
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {Lithic::Models::TransactionMonitoring::CaseListActivityParams} for more
+        # details.
+        #
+        # Lists the activity feed for a case.
+        #
+        # @overload list_activity(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::CaseActivityEntry>]
+        #
+        # @see Lithic::Models::TransactionMonitoring::CaseListActivityParams
+        def list_activity(case_token, params = {})
+          parsed, options = Lithic::TransactionMonitoring::CaseListActivityParams.dump_request(params)
+          query = Lithic::Internal::Util.encode_query_params(parsed)
+          @client.request(
+            method: :get,
+            path: ["v1/transaction_monitoring/cases/%1$s/activity", case_token],
+            query: query,
+            page: Lithic::Internal::CursorPage,
+            model: Lithic::TransactionMonitoring::CaseActivityEntry,
+            options: options
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {Lithic::Models::TransactionMonitoring::CaseListTransactionsParams} for more
+        # details.
+        #
+        # Lists the transactions associated with a case.
+        #
+        # @overload list_transactions(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::CaseTransaction>]
+        #
+        # @see Lithic::Models::TransactionMonitoring::CaseListTransactionsParams
+        def list_transactions(case_token, params = {})
+          parsed, options = Lithic::TransactionMonitoring::CaseListTransactionsParams.dump_request(params)
+          query = Lithic::Internal::Util.encode_query_params(parsed)
+          @client.request(
+            method: :get,
+            path: ["v1/transaction_monitoring/cases/%1$s/transactions", case_token],
+            query: query,
+            page: Lithic::Internal::CursorPage,
+            model: Lithic::TransactionMonitoring::CaseTransaction,
+            options: options
+          )
+        end
+
+        # Lists the cards involved in a case, with per-card transaction counts.
+        #
+        # @overload retrieve_cards(case_token, request_options: {})
+        #
+        # @param case_token [String] Globally unique identifier for the case.
+        #
+        # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Array<Lithic::Models::TransactionMonitoring::CaseCard>]
+        #
+        # @see Lithic::Models::TransactionMonitoring::CaseRetrieveCardsParams
+        def retrieve_cards(case_token, params = {})
+          @client.request(
+            method: :get,
+            path: ["v1/transaction_monitoring/cases/%1$s/cards", case_token],
+            model: Lithic::Internal::Type::ArrayOf[Lithic::TransactionMonitoring::CaseCard],
+            options: params[:request_options]
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Lithic::Client]
+        def initialize(client:)
+          @client = client
+          @comments = Lithic::Resources::TransactionMonitoring::Cases::Comments.new(client: client)
+          @files = Lithic::Resources::TransactionMonitoring::Cases::Files.new(client: client)
+        end
+      end
+    end
+  end
+end