lithic 0.1.0.pre.alpha.1

data/lib/lithic/request_options.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+module Lithic
+  # @api private
+  module RequestParameters
+    # @!parse
+    #   # Options to specify HTTP behaviour for this request.
+    #   # @return [Lithic::RequestOptions, Hash{Symbol=>Object}]
+    #   attr_accessor :request_options
+
+    # @param mod [Module]
+    def self.included(mod)
+      return unless mod <= Lithic::BaseModel
+
+      mod.extend(Lithic::RequestParameters::Converter)
+      mod.optional(:request_options, Lithic::RequestOptions)
+    end
+
+    # @api private
+    module Converter
+      # @api private
+      #
+      # @param params [Object]
+      #
+      # @return [Array(Object, Hash{Symbol=>Object})]
+      def dump_request(params)
+        case (dumped = dump(params))
+        in Hash
+          [dumped.except(:request_options), dumped[:request_options]]
+        else
+          [dumped, nil]
+        end
+      end
+    end
+  end
+
+  # Specify HTTP behaviour to use for a specific request. These options supplement
+  #   or override those provided at the client level.
+  #
+  #   When making a request, you can pass an actual {RequestOptions} instance, or
+  #   simply pass a Hash with symbol keys matching the attributes on this class.
+  class RequestOptions < Lithic::BaseModel
+    # @api private
+    #
+    # @param opts [Lithic::RequestOptions, Hash{Symbol=>Object}]
+    #
+    # @raise [ArgumentError]
+    def self.validate!(opts)
+      case opts
+      in Lithic::RequestOptions | Hash
+        opts.to_h.each_key do |k|
+          unless fields.include?(k)
+            raise ArgumentError.new("Request `opts` keys must be one of #{fields.keys}, got #{k.inspect}")
+          end
+        end
+      else
+        raise ArgumentError.new("Request `opts` must be a Hash or RequestOptions, got #{opts.inspect}")
+      end
+    end
+
+    # @!attribute idempotency_key
+    #   Idempotency key to send with request and all associated retries. Will only be
+    #     sent for write requests.
+    #
+    #   @return [String, nil]
+    optional :idempotency_key, String
+
+    # @!attribute extra_query
+    #   Extra query params to send with the request. These are `.merge`’d into any
+    #     `query` given at the client level.
+    #
+    #   @return [Hash{String=>Array<String>, String, nil}, nil]
+    optional :extra_query, Lithic::HashOf[Lithic::ArrayOf[String]]
+
+    # @!attribute extra_headers
+    #   Extra headers to send with the request. These are `.merged`’d into any
+    #     `extra_headers` given at the client level.
+    #
+    #   @return [Hash{String=>String, nil}, nil]
+    optional :extra_headers, Lithic::HashOf[String, nil?: true]
+
+    # @!attribute extra_body
+    #   Extra data to send with the request. These are deep merged into any data
+    #     generated as part of the normal request.
+    #
+    #   @return [Object, nil]
+    optional :extra_body, Lithic::HashOf[Lithic::Unknown]
+
+    # @!attribute max_retries
+    #   Maximum number of retries to attempt after a failed initial request.
+    #
+    #   @return [Integer, nil]
+    optional :max_retries, Integer
+
+    # @!attribute timeout
+    #   Request timeout in seconds.
+    #
+    #   @return [Float, nil]
+    optional :timeout, Float
+
+    # @!parse
+    #   # Returns a new instance of RequestOptions.
+    #   #
+    #   # @param values [Hash{Symbol=>Object}]
+    #   #
+    #   def initialize(values = {}) = super
+  end
+end

data/lib/lithic/resources/account_holders.rb

@@ -0,0 +1,428 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Resources
+    class AccountHolders
+      # Create an account holder and initiate the appropriate onboarding workflow.
+      #   Account holders and accounts have a 1:1 relationship. When an account holder is
+      #   successfully created an associated account is also created. All calls to this
+      #   endpoint will return an immediate response - though in some cases, the response
+      #   may indicate the enrollment is under review or further action will be needed to
+      #   complete the account enrollment process. This endpoint can only be used on
+      #   accounts that are part of the program that the calling API key manages.
+      #
+      # @param params [Lithic::Models::AccountHolderCreateParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [Array<Lithic::Models::AccountHolderCreateParams::BeneficialOwnerEntity>] :beneficial_owner_entities List of all entities with >25% ownership in the company. If no entity or
+      #     individual owns >25% of the company, and the largest shareholder is an entity,
+      #     please identify them in this field. See
+      #     [FinCEN requirements](https://www.fincen.gov/sites/default/files/shared/CDD_Rev6.7_Sept_2017_Certificate.pdf)
+      #     (Section I) for more background. If no business owner is an entity, pass in an
+      #     empty list. However, either this parameter or `beneficial_owner_individuals`
+      #     must be populated. on entities that should be included.
+      #
+      #   @option params [Array<Lithic::Models::AccountHolderCreateParams::BeneficialOwnerIndividual>] :beneficial_owner_individuals List of all direct and indirect individuals with >25% ownership in the company.
+      #     If no entity or individual owns >25% of the company, and the largest shareholder
+      #     is an individual, please identify them in this field. See
+      #     [FinCEN requirements](https://www.fincen.gov/sites/default/files/shared/CDD_Rev6.7_Sept_2017_Certificate.pdf)
+      #     (Section I) for more background on individuals that should be included. If no
+      #     individual is an entity, pass in an empty list. However, either this parameter
+      #     or `beneficial_owner_entities` must be populated.
+      #
+      #   @option params [Lithic::Models::AccountHolderCreateParams::BusinessEntity] :business_entity Information for business for which the account is being opened and KYB is being
+      #     run.
+      #
+      #   @option params [Lithic::Models::AccountHolderCreateParams::ControlPerson] :control_person An individual with significant responsibility for managing the legal entity
+      #     (e.g., a Chief Executive Officer, Chief Financial Officer, Chief Operating
+      #     Officer, Managing Member, General Partner, President, Vice President, or
+      #     Treasurer). This can be an executive, or someone who will have program-wide
+      #     access to the cards that Lithic will provide. In some cases, this individual
+      #     could also be a beneficial owner listed above. See
+      #     [FinCEN requirements](https://www.fincen.gov/sites/default/files/shared/CDD_Rev6.7_Sept_2017_Certificate.pdf)
+      #     (Section II) for more background.
+      #
+      #   @option params [String] :nature_of_business Short description of the company's line of business (i.e., what does the company
+      #     do?).
+      #
+      #   @option params [String] :tos_timestamp An RFC 3339 timestamp indicating when the account holder accepted the applicable
+      #     legal agreements (e.g., cardholder terms) as agreed upon during API customer's
+      #     implementation with Lithic.
+      #
+      #   @option params [Symbol, Lithic::Models::AccountHolderCreateParams::Workflow] :workflow Specifies the workflow type. This must be 'KYC_EXEMPT'
+      #
+      #   @option params [Lithic::Models::AccountHolderCreateParams::Individual] :individual Information on individual for whom the account is being opened and KYC is being
+      #     run.
+      #
+      #   @option params [Lithic::Models::Address] :address KYC Exempt user's current address - PO boxes, UPS drops, and FedEx drops are not
+      #     acceptable; APO/FPO are acceptable.
+      #
+      #   @option params [String] :email The KYC Exempt user's email
+      #
+      #   @option params [String] :first_name The KYC Exempt user's first name
+      #
+      #   @option params [Symbol, Lithic::Models::AccountHolderCreateParams::KYCExemptionType] :kyc_exemption_type Specifies the type of KYC Exempt user
+      #
+      #   @option params [String] :last_name The KYC Exempt user's last name
+      #
+      #   @option params [String] :phone_number The KYC Exempt user's phone number, entered in E.164 format.
+      #
+      #   @option params [String] :external_id A user provided id that can be used to link an account holder with an external
+      #     system
+      #
+      #   @option params [String] :kyb_passed_timestamp An RFC 3339 timestamp indicating when precomputed KYC was completed on the
+      #     business with a pass result.
+      #
+      #     This field is required only if workflow type is `KYB_BYO`.
+      #
+      #   @option params [String] :website_url Company website URL.
+      #
+      #   @option params [String] :kyc_passed_timestamp An RFC 3339 timestamp indicating when precomputed KYC was completed on the
+      #     individual with a pass result.
+      #
+      #     This field is required only if workflow type is `KYC_BYO`.
+      #
+      #   @option params [String] :business_account_token Only applicable for customers using the KYC-Exempt workflow to enroll authorized
+      #     users of businesses. Pass the account_token of the enrolled business associated
+      #     with the AUTHORIZED_USER in this field.
+      #
+      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [Lithic::Models::AccountHolderCreateResponse]
+      def create(params)
+        parsed, options = Lithic::Models::AccountHolderCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "v1/account_holders",
+          body: parsed,
+          model: Lithic::Models::AccountHolderCreateResponse,
+          options: options
+        )
+      end
+
+      # Get an Individual or Business Account Holder and/or their KYC or KYB evaluation
+      #   status.
+      #
+      # @param account_holder_token [String] Globally unique identifier for the account holder.
+      #
+      # @param params [Lithic::Models::AccountHolderRetrieveParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [Lithic::Models::AccountHolder]
+      def retrieve(account_holder_token, params = {})
+        @client.request(
+          method: :get,
+          path: ["v1/account_holders/%0s", account_holder_token],
+          model: Lithic::Models::AccountHolder,
+          options: params[:request_options]
+        )
+      end
+
+      # Update the information associated with a particular account holder (including
+      #   business owners and control persons associated to a business account). If Lithic
+      #   is performing KYB or KYC and additional verification is required we will run the
+      #   individual's or business's updated information again and return whether the
+      #   status is accepted or pending (i.e., further action required). All calls to this
+      #   endpoint will return an immediate response - though in some cases, the response
+      #   may indicate the workflow is under review or further action will be needed to
+      #   complete the evaluation process. This endpoint can only be used on existing
+      #   accounts that are part of the program that the calling API key manages.
+      #
+      # @param account_holder_token [String] Globally unique identifier for the account holder.
+      #
+      # @param params [Lithic::Models::AccountHolderUpdateParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [Array<Lithic::Models::AccountHolderUpdateParams::BeneficialOwnerEntity>] :beneficial_owner_entities List of all entities with >25% ownership in the company. If no entity or
+      #     individual owns >25% of the company, and the largest shareholder is an entity,
+      #     please identify them in this field. See
+      #     [FinCEN requirements](https://www.fincen.gov/sites/default/files/shared/CDD_Rev6.7_Sept_2017_Certificate.pdf)(Section
+      #     I) for more background. If no business owner is an entity, pass in an empty
+      #     list. However, either this parameter or `beneficial_owner_individuals` must be
+      #     populated. on entities that should be included.
+      #
+      #   @option params [Array<Lithic::Models::AccountHolderUpdateParams::BeneficialOwnerIndividual>] :beneficial_owner_individuals List of all individuals with >25% ownership in the company. If no entity or
+      #     individual owns >25% of the company, and the largest shareholder is an
+      #     individual, please identify them in this field. See
+      #     [FinCEN requirements](https://www.fincen.gov/sites/default/files/shared/CDD_Rev6.7_Sept_2017_Certificate.pdf)(Section
+      #     I) for more background on individuals that should be included. If no individual
+      #     is an entity, pass in an empty list. However, either this parameter or
+      #     `beneficial_owner_entities` must be populated.
+      #
+      #   @option params [Lithic::Models::AccountHolderUpdateParams::BusinessEntity] :business_entity Information for business for which the account is being opened and KYB is being
+      #     run.
+      #
+      #   @option params [Lithic::Models::AccountHolderUpdateParams::ControlPerson] :control_person An individual with significant responsibility for managing the legal entity
+      #     (e.g., a Chief Executive Officer, Chief Financial Officer, Chief Operating
+      #     Officer, Managing Member, General Partner, President, Vice President, or
+      #     Treasurer). This can be an executive, or someone who will have program-wide
+      #     access to the cards that Lithic will provide. In some cases, this individual
+      #     could also be a beneficial owner listed above. See
+      #     [FinCEN requirements](https://www.fincen.gov/sites/default/files/shared/CDD_Rev6.7_Sept_2017_Certificate.pdf)
+      #     (Section II) for more background.
+      #
+      #   @option params [String] :external_id A user provided id that can be used to link an account holder with an external
+      #     system
+      #
+      #   @option params [String] :nature_of_business Short description of the company's line of business (i.e., what does the company
+      #     do?).
+      #
+      #   @option params [String] :website_url Company website URL.
+      #
+      #   @option params [Lithic::Models::AccountHolderUpdateParams::Individual] :individual Information on the individual for whom the account is being opened and KYC is
+      #     being run.
+      #
+      #   @option params [Lithic::Models::AddressUpdate] :address Allowed for: KYC-Exempt, BYO-KYC, BYO-KYB.
+      #
+      #   @option params [String] :business_account_token Allowed for: KYC-Exempt, BYO-KYC. The token of the business account to which the
+      #     account holder is associated.
+      #
+      #   @option params [String] :email Allowed for all Account Holders. Account holder's email address. The primary
+      #     purpose of this field is for cardholder identification and verification during
+      #     the digital wallet tokenization process.
+      #
+      #   @option params [String] :first_name Allowed for KYC-Exempt, BYO-KYC. Account holder's first name.
+      #
+      #   @option params [String] :last_name Allowed for KYC-Exempt, BYO-KYC. Account holder's last name.
+      #
+      #   @option params [String] :legal_business_name Allowed for BYO-KYB. Legal business name of the account holder.
+      #
+      #   @option params [String] :phone_number Allowed for all Account Holders. Account holder's phone number, entered in E.164
+      #     format. The primary purpose of this field is for cardholder identification and
+      #     verification during the digital wallet tokenization process.
+      #
+      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [Lithic::Models::AccountHolderUpdateResponse::KYBKYCPatchResponse, Lithic::Models::AccountHolderUpdateResponse::PatchResponse]
+      def update(account_holder_token, params = {})
+        parsed, options = Lithic::Models::AccountHolderUpdateParams.dump_request(params)
+        @client.request(
+          method: :patch,
+          path: ["v1/account_holders/%0s", account_holder_token],
+          body: parsed,
+          model: Lithic::Models::AccountHolderUpdateResponse,
+          options: options
+        )
+      end
+
+      # Get a list of individual or business account holders and their KYC or KYB
+      #   evaluation status.
+      #
+      # @param params [Lithic::Models::AccountHolderListParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [Time] :begin_ Date string in RFC 3339 format. Only entries created after the specified time
+      #     will be included. UTC time zone.
+      #
+      #   @option params [String] :email Email address of the account holder. The query must be an exact match, case
+      #     insensitive.
+      #
+      #   @option params [Time] :end_ Date string in RFC 3339 format. Only entries created before the specified time
+      #     will be included. UTC time zone.
+      #
+      #   @option params [String] :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.
+      #
+      #   @option params [String] :external_id If applicable, represents the external_id associated with the account_holder.
+      #
+      #   @option params [String] :first_name (Individual Account Holders only) The first name of the account holder. The
+      #     query is case insensitive and supports partial matches.
+      #
+      #   @option params [String] :last_name (Individual Account Holders only) The last name of the account holder. The query
+      #     is case insensitive and supports partial matches.
+      #
+      #   @option params [String] :legal_business_name (Business Account Holders only) The legal business name of the account holder.
+      #     The query is case insensitive and supports partial matches.
+      #
+      #   @option params [Integer] :limit The number of account_holders to limit the response to.
+      #
+      #   @option params [String] :phone_number Phone number of the account holder. The query must be an exact match.
+      #
+      #   @option params [String] :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.
+      #
+      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [Lithic::SinglePage<Lithic::Models::AccountHolder>]
+      def list(params = {})
+        parsed, options = Lithic::Models::AccountHolderListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "v1/account_holders",
+          query: parsed,
+          page: Lithic::SinglePage,
+          model: Lithic::Models::AccountHolder,
+          options: options
+        )
+      end
+
+      # Retrieve the status of account holder document uploads, or retrieve the upload
+      #   URLs to process your image uploads.
+      #
+      #   Note that this is not equivalent to checking the status of the KYC evaluation
+      #   overall (a document may be successfully uploaded but not be sufficient for KYC
+      #   to pass).
+      #
+      #   In the event your upload URLs have expired, calling this endpoint will refresh
+      #   them. Similarly, in the event a previous account holder document upload has
+      #   failed, you can use this endpoint to get a new upload URL for the failed image
+      #   upload.
+      #
+      #   When a new document upload is generated for a failed attempt, the response will
+      #   show an additional entry in the `required_document_uploads` list in a `PENDING`
+      #   state for the corresponding `image_type`.
+      #
+      # @param account_holder_token [String] Globally unique identifier for the account holder.
+      #
+      # @param params [Lithic::Models::AccountHolderListDocumentsParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [Lithic::Models::AccountHolderListDocumentsResponse]
+      def list_documents(account_holder_token, params = {})
+        @client.request(
+          method: :get,
+          path: ["v1/account_holders/%0s/documents", account_holder_token],
+          model: Lithic::Models::AccountHolderListDocumentsResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # Check the status of an account holder document upload, or retrieve the upload
+      #   URLs to process your image uploads.
+      #
+      #   Note that this is not equivalent to checking the status of the KYC evaluation
+      #   overall (a document may be successfully uploaded but not be sufficient for KYC
+      #   to pass).
+      #
+      #   In the event your upload URLs have expired, calling this endpoint will refresh
+      #   them. Similarly, in the event a document upload has failed, you can use this
+      #   endpoint to get a new upload URL for the failed image upload.
+      #
+      #   When a new account holder document upload is generated for a failed attempt, the
+      #   response will show an additional entry in the `required_document_uploads` array
+      #   in a `PENDING` state for the corresponding `image_type`.
+      #
+      # @param document_token [String] Globally unique identifier for the document.
+      #
+      # @param params [Lithic::Models::AccountHolderRetrieveDocumentParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [String] :account_holder_token Globally unique identifier for the account holder.
+      #
+      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [Lithic::Models::Document]
+      def retrieve_document(document_token, params)
+        parsed, options = Lithic::Models::AccountHolderRetrieveDocumentParams.dump_request(params)
+        account_holder_token =
+          parsed.delete(:account_holder_token) do
+            raise ArgumentError.new("missing required path argument #{_1}")
+          end
+        @client.request(
+          method: :get,
+          path: ["v1/account_holders/%0s/documents/%1s", account_holder_token, document_token],
+          model: Lithic::Models::Document,
+          options: options
+        )
+      end
+
+      # Simulates a review for an account holder document upload.
+      #
+      # @param params [Lithic::Models::AccountHolderSimulateEnrollmentDocumentReviewParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [String] :document_upload_token The account holder document upload which to perform the simulation upon.
+      #
+      #   @option params [Symbol, Lithic::Models::AccountHolderSimulateEnrollmentDocumentReviewParams::Status] :status An account holder document's upload status for use within the simulation.
+      #
+      #   @option params [Array<String>] :accepted_entity_status_reasons A list of status reasons associated with a KYB account holder in PENDING_REVIEW
+      #
+      #   @option params [Symbol, Lithic::Models::AccountHolderSimulateEnrollmentDocumentReviewParams::StatusReason] :status_reason Status reason that will be associated with the simulated account holder status.
+      #     Only required for a `REJECTED` status or `PARTIAL_APPROVAL` status.
+      #
+      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [Lithic::Models::Document]
+      def simulate_enrollment_document_review(params)
+        parsed, options =
+          Lithic::Models::AccountHolderSimulateEnrollmentDocumentReviewParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "v1/simulate/account_holders/enrollment_document_review",
+          body: parsed,
+          model: Lithic::Models::Document,
+          options: options
+        )
+      end
+
+      # Simulates an enrollment review for an account holder. This endpoint is only
+      #   applicable for workflows that may required intervention such as `KYB_BASIC`.
+      #
+      # @param params [Lithic::Models::AccountHolderSimulateEnrollmentReviewParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [String] :account_holder_token The account holder which to perform the simulation upon.
+      #
+      #   @option params [Symbol, Lithic::Models::AccountHolderSimulateEnrollmentReviewParams::Status] :status An account holder's status for use within the simulation.
+      #
+      #   @option params [Array<Symbol, Lithic::Models::AccountHolderSimulateEnrollmentReviewParams::StatusReason>] :status_reasons Status reason that will be associated with the simulated account holder status.
+      #     Only required for a `REJECTED` status.
+      #
+      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse]
+      def simulate_enrollment_review(params = {})
+        parsed, options = Lithic::Models::AccountHolderSimulateEnrollmentReviewParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "v1/simulate/account_holders/enrollment_review",
+          body: parsed,
+          model: Lithic::Models::AccountHolderSimulateEnrollmentReviewResponse,
+          options: options
+        )
+      end
+
+      # Use this endpoint to identify which type of supported government-issued
+      #   documentation you will upload for further verification. It will return two URLs
+      #   to upload your document images to - one for the front image and one for the back
+      #   image.
+      #
+      #   This endpoint is only valid for evaluations in a `PENDING_DOCUMENT` state.
+      #
+      #   Uploaded images must either be a `jpg` or `png` file, and each must be less than
+      #   15 MiB. Once both required uploads have been successfully completed, your
+      #   document will be run through KYC verification.
+      #
+      #   If you have registered a webhook, you will receive evaluation updates for any
+      #   document submission evaluations, as well as for any failed document uploads.
+      #
+      #   Two document submission attempts are permitted via this endpoint before a
+      #   `REJECTED` status is returned and the account creation process is ended.
+      #   Currently only one type of account holder document is supported per KYC
+      #   verification.
+      #
+      # @param account_holder_token [String] Globally unique identifier for the account holder.
+      #
+      # @param params [Lithic::Models::AccountHolderUploadDocumentParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [Symbol, Lithic::Models::AccountHolderUploadDocumentParams::DocumentType] :document_type The type of document to upload
+      #
+      #   @option params [String] :entity_token Globally unique identifier for the entity.
+      #
+      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [Lithic::Models::Document]
+      def upload_document(account_holder_token, params)
+        parsed, options = Lithic::Models::AccountHolderUploadDocumentParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: ["v1/account_holders/%0s/documents", account_holder_token],
+          body: parsed,
+          model: Lithic::Models::Document,
+          options: options
+        )
+      end
+
+      # @param client [Lithic::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/lithic/resources/accounts.rb

@@ -0,0 +1,128 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Resources
+    class Accounts
+      # Get account configuration such as spend limits.
+      #
+      # @param account_token [String] Globally unique identifier for account.
+      #
+      # @param params [Lithic::Models::AccountRetrieveParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [Lithic::Models::Account]
+      def retrieve(account_token, params = {})
+        @client.request(
+          method: :get,
+          path: ["v1/accounts/%0s", account_token],
+          model: Lithic::Models::Account,
+          options: params[:request_options]
+        )
+      end
+
+      # Update account configuration such as state or spend limits. Can only be run on
+      #   accounts that are part of the program managed by this API key. Accounts that are
+      #   in the `PAUSED` state will not be able to transact or create new cards.
+      #
+      # @param account_token [String] Globally unique identifier for account.
+      #
+      # @param params [Lithic::Models::AccountUpdateParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [Integer] :daily_spend_limit Amount (in cents) for the account's daily spend limit (e.g. 100000 would be a
+      #     $1,000 limit). By default the daily spend limit is set to $1,250.
+      #
+      #   @option params [Integer] :lifetime_spend_limit Amount (in cents) for the account's lifetime spend limit (e.g. 100000 would be a
+      #     $1,000 limit). Once this limit is reached, no transactions will be accepted on
+      #     any card created for this account until the limit is updated. Note that a spend
+      #     limit of 0 is effectively no limit, and should only be used to reset or remove a
+      #     prior limit. Only a limit of 1 or above will result in declined transactions due
+      #     to checks against the account limit. This behavior differs from the daily spend
+      #     limit and the monthly spend limit.
+      #
+      #   @option params [Integer] :monthly_spend_limit Amount (in cents) for the account's monthly spend limit (e.g. 100000 would be a
+      #     $1,000 limit). By default the monthly spend limit is set to $5,000.
+      #
+      #   @option params [Symbol, Lithic::Models::AccountUpdateParams::State] :state Account states.
+      #
+      #   @option params [Lithic::Models::AccountUpdateParams::VerificationAddress] :verification_address Address used during Address Verification Service (AVS) checks during
+      #     transactions if enabled via Auth Rules. This field is deprecated as AVS checks
+      #     are no longer supported by Authorization Rules. The field will be removed from
+      #     the schema in a future release.
+      #
+      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [Lithic::Models::Account]
+      def update(account_token, params = {})
+        parsed, options = Lithic::Models::AccountUpdateParams.dump_request(params)
+        @client.request(
+          method: :patch,
+          path: ["v1/accounts/%0s", account_token],
+          body: parsed,
+          model: Lithic::Models::Account,
+          options: options
+        )
+      end
+
+      # List account configurations.
+      #
+      # @param params [Lithic::Models::AccountListParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [Time] :begin_ Date string in RFC 3339 format. Only entries created after the specified time
+      #     will be included. UTC time zone.
+      #
+      #   @option params [Time] :end_ Date string in RFC 3339 format. Only entries created before the specified time
+      #     will be included. UTC time zone.
+      #
+      #   @option params [String] :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.
+      #
+      #   @option params [Integer] :page_size Page size (for pagination).
+      #
+      #   @option params [String] :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.
+      #
+      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [Lithic::CursorPage<Lithic::Models::Account>]
+      def list(params = {})
+        parsed, options = Lithic::Models::AccountListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "v1/accounts",
+          query: parsed,
+          page: Lithic::CursorPage,
+          model: Lithic::Models::Account,
+          options: options
+        )
+      end
+
+      # Get an Account's available spend limits, which is based on the spend limit
+      #   configured on the Account and the amount already spent over the spend limit's
+      #   duration. For example, if the Account has a daily spend limit of $1000
+      #   configured, and has spent $600 in the last 24 hours, the available spend limit
+      #   returned would be $400.
+      #
+      # @param account_token [String] Globally unique identifier for account.
+      #
+      # @param params [Lithic::Models::AccountRetrieveSpendLimitsParams, Hash{Symbol=>Object}] .
+      #
+      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      #
+      # @return [Lithic::Models::AccountSpendLimits]
+      def retrieve_spend_limits(account_token, params = {})
+        @client.request(
+          method: :get,
+          path: ["v1/accounts/%0s/spend_limits", account_token],
+          model: Lithic::Models::AccountSpendLimits,
+          options: params[:request_options]
+        )
+      end
+
+      # @param client [Lithic::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end