merge_ruby_client 0.1.4 → 1.0.0

data/lib/merge_ruby_client/accounting/bank_feed_accounts/client.rb

@@ -0,0 +1,369 @@
+# frozen_string_literal: true
+
+require_relative "../../../requests"
+require_relative "../types/paginated_bank_feed_account_list"
+require_relative "../types/bank_feed_account_request"
+require_relative "../types/bank_feed_account_response"
+require_relative "../types/bank_feed_account"
+require_relative "../types/meta_response"
+require "async"
+
+module Merge
+  module Accounting
+    class BankFeedAccountsClient
+      # @return [Merge::RequestClient]
+      attr_reader :request_client
+
+      # @param request_client [Merge::RequestClient]
+      # @return [Merge::Accounting::BankFeedAccountsClient]
+      def initialize(request_client:)
+        @request_client = request_client
+      end
+
+      # Returns a list of `BankFeedAccount` objects.
+      #
+      # @param cursor [String] The pagination cursor value.
+      # @param include_deleted_data [Boolean] Indicates whether or not this object has been deleted in the third party
+      #  platform. Full coverage deletion detection is a premium add-on. Native deletion
+      #  detection is offered for free with limited coverage. [Learn
+      #  more](https://docs.merge.dev/integrations/hris/supported-features/).
+      # @param include_remote_data [Boolean] Whether to include the original data Merge fetched from the third-party to
+      #  produce these models.
+      # @param include_shell_data [Boolean] Whether to include shell records. Shell records are empty records (they may
+      #  contain some metadata but all other fields are null).
+      # @param page_size [Integer] Number of results to return per page.
+      # @param request_options [Merge::RequestOptions]
+      # @return [Merge::Accounting::PaginatedBankFeedAccountList]
+      # @example
+      #  api = Merge::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: Merge::Environment::PRODUCTION,
+      #    api_key: "YOUR_AUTH_TOKEN"
+      #  )
+      #  api.accounting.bank_feed_accounts.list
+      def list(cursor: nil, include_deleted_data: nil, include_remote_data: nil, include_shell_data: nil,
+               page_size: nil, request_options: nil)
+        response = @request_client.conn.get do |req|
+          req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+          req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
+          req.headers["X-Account-Token"] = request_options.account_token unless request_options&.account_token.nil?
+          req.headers = {
+        **(req.headers || {}),
+        **@request_client.get_headers,
+        **(request_options&.additional_headers || {})
+          }.compact
+          req.params = {
+            **(request_options&.additional_query_parameters || {}),
+            "cursor": cursor,
+            "include_deleted_data": include_deleted_data,
+            "include_remote_data": include_remote_data,
+            "include_shell_data": include_shell_data,
+            "page_size": page_size
+          }.compact
+          unless request_options.nil? || request_options&.additional_body_parameters.nil?
+            req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+          end
+          req.url "#{@request_client.get_url(request_options: request_options)}/accounting/v1/bank-feed-accounts"
+        end
+        Merge::Accounting::PaginatedBankFeedAccountList.from_json(json_object: response.body)
+      end
+
+      # Creates a `BankFeedAccount` object with the given values.
+      #
+      # @param is_debug_mode [Boolean] Whether to include debug fields (such as log file links) in the response.
+      # @param run_async [Boolean] Whether or not third-party updates should be run asynchronously.
+      # @param model [Hash] Request of type Merge::Accounting::BankFeedAccountRequest, as a Hash
+      #   * :source_account_id (String)
+      #   * :target_account_id (String)
+      #   * :source_account_name (String)
+      #   * :source_account_number (String)
+      #   * :target_account_name (String)
+      #   * :currency (Merge::Accounting::TransactionCurrencyEnum)
+      #   * :feed_status (Merge::Accounting::FeedStatusEnum)
+      #   * :feed_start_date (DateTime)
+      #   * :source_account_balance (Float)
+      #   * :account_type (Merge::Accounting::BankFeedAccountAccountTypeEnum)
+      #   * :integration_params (Hash{String => Object})
+      #   * :linked_account_params (Hash{String => Object})
+      # @param request_options [Merge::RequestOptions]
+      # @return [Merge::Accounting::BankFeedAccountResponse]
+      # @example
+      #  api = Merge::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: Merge::Environment::PRODUCTION,
+      #    api_key: "YOUR_AUTH_TOKEN"
+      #  )
+      #  api.accounting.bank_feed_accounts.create(model: {  })
+      def create(model:, is_debug_mode: nil, run_async: nil, request_options: nil)
+        response = @request_client.conn.post do |req|
+          req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+          req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
+          req.headers["X-Account-Token"] = request_options.account_token unless request_options&.account_token.nil?
+          req.headers = {
+        **(req.headers || {}),
+        **@request_client.get_headers,
+        **(request_options&.additional_headers || {})
+          }.compact
+          req.params = {
+            **(request_options&.additional_query_parameters || {}),
+            "is_debug_mode": is_debug_mode,
+            "run_async": run_async
+          }.compact
+          req.body = { **(request_options&.additional_body_parameters || {}), model: model }.compact
+          req.url "#{@request_client.get_url(request_options: request_options)}/accounting/v1/bank-feed-accounts"
+        end
+        Merge::Accounting::BankFeedAccountResponse.from_json(json_object: response.body)
+      end
+
+      # Returns a `BankFeedAccount` object with the given `id`.
+      #
+      # @param id [String]
+      # @param include_remote_data [Boolean] Whether to include the original data Merge fetched from the third-party to
+      #  produce these models.
+      # @param request_options [Merge::RequestOptions]
+      # @return [Merge::Accounting::BankFeedAccount]
+      # @example
+      #  api = Merge::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: Merge::Environment::PRODUCTION,
+      #    api_key: "YOUR_AUTH_TOKEN"
+      #  )
+      #  api.accounting.bank_feed_accounts.retrieve(id: "id")
+      def retrieve(id:, include_remote_data: nil, request_options: nil)
+        response = @request_client.conn.get do |req|
+          req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+          req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
+          req.headers["X-Account-Token"] = request_options.account_token unless request_options&.account_token.nil?
+          req.headers = {
+        **(req.headers || {}),
+        **@request_client.get_headers,
+        **(request_options&.additional_headers || {})
+          }.compact
+          req.params = {
+            **(request_options&.additional_query_parameters || {}),
+            "include_remote_data": include_remote_data
+          }.compact
+          unless request_options.nil? || request_options&.additional_body_parameters.nil?
+            req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+          end
+          req.url "#{@request_client.get_url(request_options: request_options)}/accounting/v1/bank-feed-accounts/#{id}"
+        end
+        Merge::Accounting::BankFeedAccount.from_json(json_object: response.body)
+      end
+
+      # Returns metadata for `BankFeedAccount` POSTs.
+      #
+      # @param request_options [Merge::RequestOptions]
+      # @return [Merge::Accounting::MetaResponse]
+      # @example
+      #  api = Merge::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: Merge::Environment::PRODUCTION,
+      #    api_key: "YOUR_AUTH_TOKEN"
+      #  )
+      #  api.accounting.bank_feed_accounts.meta_post_retrieve
+      def meta_post_retrieve(request_options: nil)
+        response = @request_client.conn.get do |req|
+          req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+          req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
+          req.headers["X-Account-Token"] = request_options.account_token unless request_options&.account_token.nil?
+          req.headers = {
+        **(req.headers || {}),
+        **@request_client.get_headers,
+        **(request_options&.additional_headers || {})
+          }.compact
+          unless request_options.nil? || request_options&.additional_query_parameters.nil?
+            req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+          end
+          unless request_options.nil? || request_options&.additional_body_parameters.nil?
+            req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+          end
+          req.url "#{@request_client.get_url(request_options: request_options)}/accounting/v1/bank-feed-accounts/meta/post"
+        end
+        Merge::Accounting::MetaResponse.from_json(json_object: response.body)
+      end
+    end
+
+    class AsyncBankFeedAccountsClient
+      # @return [Merge::AsyncRequestClient]
+      attr_reader :request_client
+
+      # @param request_client [Merge::AsyncRequestClient]
+      # @return [Merge::Accounting::AsyncBankFeedAccountsClient]
+      def initialize(request_client:)
+        @request_client = request_client
+      end
+
+      # Returns a list of `BankFeedAccount` objects.
+      #
+      # @param cursor [String] The pagination cursor value.
+      # @param include_deleted_data [Boolean] Indicates whether or not this object has been deleted in the third party
+      #  platform. Full coverage deletion detection is a premium add-on. Native deletion
+      #  detection is offered for free with limited coverage. [Learn
+      #  more](https://docs.merge.dev/integrations/hris/supported-features/).
+      # @param include_remote_data [Boolean] Whether to include the original data Merge fetched from the third-party to
+      #  produce these models.
+      # @param include_shell_data [Boolean] Whether to include shell records. Shell records are empty records (they may
+      #  contain some metadata but all other fields are null).
+      # @param page_size [Integer] Number of results to return per page.
+      # @param request_options [Merge::RequestOptions]
+      # @return [Merge::Accounting::PaginatedBankFeedAccountList]
+      # @example
+      #  api = Merge::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: Merge::Environment::PRODUCTION,
+      #    api_key: "YOUR_AUTH_TOKEN"
+      #  )
+      #  api.accounting.bank_feed_accounts.list
+      def list(cursor: nil, include_deleted_data: nil, include_remote_data: nil, include_shell_data: nil,
+               page_size: nil, request_options: nil)
+        Async do
+          response = @request_client.conn.get do |req|
+            req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+            req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
+            req.headers["X-Account-Token"] = request_options.account_token unless request_options&.account_token.nil?
+            req.headers = {
+          **(req.headers || {}),
+          **@request_client.get_headers,
+          **(request_options&.additional_headers || {})
+            }.compact
+            req.params = {
+              **(request_options&.additional_query_parameters || {}),
+              "cursor": cursor,
+              "include_deleted_data": include_deleted_data,
+              "include_remote_data": include_remote_data,
+              "include_shell_data": include_shell_data,
+              "page_size": page_size
+            }.compact
+            unless request_options.nil? || request_options&.additional_body_parameters.nil?
+              req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+            end
+            req.url "#{@request_client.get_url(request_options: request_options)}/accounting/v1/bank-feed-accounts"
+          end
+          Merge::Accounting::PaginatedBankFeedAccountList.from_json(json_object: response.body)
+        end
+      end
+
+      # Creates a `BankFeedAccount` object with the given values.
+      #
+      # @param is_debug_mode [Boolean] Whether to include debug fields (such as log file links) in the response.
+      # @param run_async [Boolean] Whether or not third-party updates should be run asynchronously.
+      # @param model [Hash] Request of type Merge::Accounting::BankFeedAccountRequest, as a Hash
+      #   * :source_account_id (String)
+      #   * :target_account_id (String)
+      #   * :source_account_name (String)
+      #   * :source_account_number (String)
+      #   * :target_account_name (String)
+      #   * :currency (Merge::Accounting::TransactionCurrencyEnum)
+      #   * :feed_status (Merge::Accounting::FeedStatusEnum)
+      #   * :feed_start_date (DateTime)
+      #   * :source_account_balance (Float)
+      #   * :account_type (Merge::Accounting::BankFeedAccountAccountTypeEnum)
+      #   * :integration_params (Hash{String => Object})
+      #   * :linked_account_params (Hash{String => Object})
+      # @param request_options [Merge::RequestOptions]
+      # @return [Merge::Accounting::BankFeedAccountResponse]
+      # @example
+      #  api = Merge::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: Merge::Environment::PRODUCTION,
+      #    api_key: "YOUR_AUTH_TOKEN"
+      #  )
+      #  api.accounting.bank_feed_accounts.create(model: {  })
+      def create(model:, is_debug_mode: nil, run_async: nil, request_options: nil)
+        Async do
+          response = @request_client.conn.post do |req|
+            req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+            req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
+            req.headers["X-Account-Token"] = request_options.account_token unless request_options&.account_token.nil?
+            req.headers = {
+          **(req.headers || {}),
+          **@request_client.get_headers,
+          **(request_options&.additional_headers || {})
+            }.compact
+            req.params = {
+              **(request_options&.additional_query_parameters || {}),
+              "is_debug_mode": is_debug_mode,
+              "run_async": run_async
+            }.compact
+            req.body = { **(request_options&.additional_body_parameters || {}), model: model }.compact
+            req.url "#{@request_client.get_url(request_options: request_options)}/accounting/v1/bank-feed-accounts"
+          end
+          Merge::Accounting::BankFeedAccountResponse.from_json(json_object: response.body)
+        end
+      end
+
+      # Returns a `BankFeedAccount` object with the given `id`.
+      #
+      # @param id [String]
+      # @param include_remote_data [Boolean] Whether to include the original data Merge fetched from the third-party to
+      #  produce these models.
+      # @param request_options [Merge::RequestOptions]
+      # @return [Merge::Accounting::BankFeedAccount]
+      # @example
+      #  api = Merge::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: Merge::Environment::PRODUCTION,
+      #    api_key: "YOUR_AUTH_TOKEN"
+      #  )
+      #  api.accounting.bank_feed_accounts.retrieve(id: "id")
+      def retrieve(id:, include_remote_data: nil, request_options: nil)
+        Async do
+          response = @request_client.conn.get do |req|
+            req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+            req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
+            req.headers["X-Account-Token"] = request_options.account_token unless request_options&.account_token.nil?
+            req.headers = {
+          **(req.headers || {}),
+          **@request_client.get_headers,
+          **(request_options&.additional_headers || {})
+            }.compact
+            req.params = {
+              **(request_options&.additional_query_parameters || {}),
+              "include_remote_data": include_remote_data
+            }.compact
+            unless request_options.nil? || request_options&.additional_body_parameters.nil?
+              req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+            end
+            req.url "#{@request_client.get_url(request_options: request_options)}/accounting/v1/bank-feed-accounts/#{id}"
+          end
+          Merge::Accounting::BankFeedAccount.from_json(json_object: response.body)
+        end
+      end
+
+      # Returns metadata for `BankFeedAccount` POSTs.
+      #
+      # @param request_options [Merge::RequestOptions]
+      # @return [Merge::Accounting::MetaResponse]
+      # @example
+      #  api = Merge::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: Merge::Environment::PRODUCTION,
+      #    api_key: "YOUR_AUTH_TOKEN"
+      #  )
+      #  api.accounting.bank_feed_accounts.meta_post_retrieve
+      def meta_post_retrieve(request_options: nil)
+        Async do
+          response = @request_client.conn.get do |req|
+            req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
+            req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
+            req.headers["X-Account-Token"] = request_options.account_token unless request_options&.account_token.nil?
+            req.headers = {
+          **(req.headers || {}),
+          **@request_client.get_headers,
+          **(request_options&.additional_headers || {})
+            }.compact
+            unless request_options.nil? || request_options&.additional_query_parameters.nil?
+              req.params = { **(request_options&.additional_query_parameters || {}) }.compact
+            end
+            unless request_options.nil? || request_options&.additional_body_parameters.nil?
+              req.body = { **(request_options&.additional_body_parameters || {}) }.compact
+            end
+            req.url "#{@request_client.get_url(request_options: request_options)}/accounting/v1/bank-feed-accounts/meta/post"
+          end
+          Merge::Accounting::MetaResponse.from_json(json_object: response.body)
+        end
+      end
+    end
+  end
+end