fern_gusto 0.0.6.pre.alpha6

data/lib/fern_gusto/companies/bank_accounts/client.rb

@@ -0,0 +1,435 @@
+# frozen_string_literal: true
+require_relative "../../../requests"
+require_relative "../../company_bank_accounts/types/company_bank_account"
+require "json"
+require_relative "types/bank_accounts_create_request_account_type"
+require "async"
+require "async"
+require "async"
+require "async"
+require_relative "../../../requests"
+
+module Gusto
+  module Companies
+    class BankAccountsClient
+    # @return [Gusto::RequestClient] 
+      attr_reader :request_client
+
+
+      # @param request_client [Gusto::RequestClient] 
+      # @return [Gusto::Companies::BankAccountsClient]
+      def initialize(request_client:)
+        @request_client = request_client
+      end
+# Returns company bank accounts. Currently, we only support a single default bank
+#  account per company.
+#  scope: `company_bank_accounts:read`
+      #
+      # @param company_id [String] The UUID of the company
+      # @param request_options [Gusto::RequestOptions] 
+      # @return [Array<Gusto::CompanyBankAccounts::CompanyBankAccount>]
+      # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.companies.bank_accounts.get(company_id: "company_id")
+      def get(company_id:, request_options: nil)
+        response = @request_client.conn.get do | req |
+  unless request_options&.timeout_in_seconds.nil?
+    req.options.timeout = request_options.timeout_in_seconds
+  end
+  unless request_options&.token.nil?
+    req.headers["Authorization"] = request_options.token
+  end
+  unless request_options&.gusto_api_version.nil?
+    req.headers["X-Gusto-API-Version"] = request_options.gusto_api_version
+  end
+  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)}/v1/companies/#{company_id}/bank_accounts"
+end
+        parsed_json = JSON.parse(response.body)
+        parsed_json&.map do | item |
+          item = item.to_json
+          Gusto::CompanyBankAccounts::CompanyBankAccount.from_json(json_object: item)
+        end
+      end
+# This endpoint creates a new company bank account.
+#  Upon being created, two verification deposits are automatically sent to the bank
+#  account, and the bank account's verification_status is 'awaiting_deposits'.
+#  When the deposits are successfully transferred, the verification_status changes
+#  to 'ready_for_verification', at which point the verify endpoint can be used to
+#  verify the bank account.
+#  After successful verification, the bank account's verification_status is
+#  'verified'.
+#  scope: `company_bank_accounts:write`
+#  > 🚧 Warning
+#  >
+#  > If a default bank account exists, it will be disabled and the new bank account
+#  will replace it as the company's default funding method.
+      #
+      # @param company_id [String] The UUID of the company
+      # @param routing_number [String] The bank routing number
+      # @param account_number [String] The bank account number
+      # @param account_type [Gusto::Companies::BankAccounts::BankAccountsCreateRequestAccountType] The bank account type
+      # @param request_options [Gusto::RequestOptions] 
+      # @return [Gusto::CompanyBankAccounts::CompanyBankAccount]
+      # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.companies.bank_accounts.create(
+#    company_id: "company_id",
+#    routing_number: "115092013",
+#    account_number: "9775014007",
+#    account_type: CHECKING
+#  )
+      def create(company_id:, routing_number: nil, account_number: nil, account_type: nil, request_options: nil)
+        response = @request_client.conn.post do | req |
+  unless request_options&.timeout_in_seconds.nil?
+    req.options.timeout = request_options.timeout_in_seconds
+  end
+  unless request_options&.token.nil?
+    req.headers["Authorization"] = request_options.token
+  end
+  unless request_options&.gusto_api_version.nil?
+    req.headers["X-Gusto-API-Version"] = request_options.gusto_api_version
+  end
+  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
+  req.body = { **(request_options&.additional_body_parameters || {}), routing_number: routing_number, account_number: account_number, account_type: account_type }.compact
+  req.url "#{@request_client.get_url(request_options: request_options)}/v1/companies/#{company_id}/bank_accounts"
+end
+        Gusto::CompanyBankAccounts::CompanyBankAccount.from_json(json_object: response.body)
+      end
+# Verify a company bank account by confirming the two micro-deposits sent to the
+#  bank account. Note that the order of the two deposits specified in request
+#  parameters does not matter. There's a maximum of 5 verification attempts, after
+#  which we will automatically initiate a new set of micro-deposits and require the
+#  bank account to be verified with the new micro-deposits.
+#  ### Bank account verification in demo
+#  We provide the endpoint `POST
+#  v1/companies/{company_id}/bank_accounts/{bank_account_uuid}/send_test_deposits'`
+#  to facilitate bank account verification in the demo environment. This endpoint
+#  simulates the micro-deposits transfer and returns them in the response. You can
+#  call this endpoint as many times as you wish to retrieve the values of the two
+#  micro deposits.
+#  ```
+#  POST
+#  dfbcb56d9/bank_accounts/ade55e57-4800-4059-9ecd-fa29cfeb6dd2/send_test_deposits'
+#  {
+#  "deposit_1": 0.02,
+#  "deposit_2": 0.42
+#  }
+#  ```
+#  scope: `company_bank_accounts:write`
+      #
+      # @param bank_account_uuid [String] The UUID of the bank account
+      # @param company_id [String] The UUID of the company
+      # @param deposit1 [Float] The dollar amount of the first micro-deposit
+      # @param deposit2 [Float] The dollar amount of the second micro-deposit
+      # @param request_options [Gusto::RequestOptions] 
+      # @return [Gusto::CompanyBankAccounts::CompanyBankAccount]
+      # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.companies.bank_accounts.verify(
+#    bank_account_uuid: "bank_account_uuid",
+#    company_id: "company_id",
+#    deposit1: 0.02,
+#    deposit2: 0.42
+#  )
+      def verify(bank_account_uuid:, company_id:, deposit1: nil, deposit2: nil, request_options: nil)
+        response = @request_client.conn.put do | req |
+  unless request_options&.timeout_in_seconds.nil?
+    req.options.timeout = request_options.timeout_in_seconds
+  end
+  unless request_options&.token.nil?
+    req.headers["Authorization"] = request_options.token
+  end
+  unless request_options&.gusto_api_version.nil?
+    req.headers["X-Gusto-API-Version"] = request_options.gusto_api_version
+  end
+  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
+  req.body = { **(request_options&.additional_body_parameters || {}), deposit_1: deposit1, deposit_2: deposit2 }.compact
+  req.url "#{@request_client.get_url(request_options: request_options)}/v1/companies/#{bank_account_uuid}/bank_accounts/#{company_id}/verify"
+end
+        Gusto::CompanyBankAccounts::CompanyBankAccount.from_json(json_object: response.body)
+      end
+# This endpoint creates a new **verified** bank account by using a plaid processor
+#  token to retrieve its information.
+#  scope: `plaid_processor:write`
+#  > 📘
+#  > To create a token please use the [plaid
+#  api](https://plaid.com/docs/api/processors/#processortokencreate) and select
+#  "gusto" as processor.
+#  > 🚧 Warning - Company Bank Accounts
+#  >
+#  > If a default company bank account exists, it will be disabled and the new bank
+#  account will replace it as the company's default funding method.
+      #
+      # @param owner_id [String] The owner uuid of the bank account
+      # @param processor_token [String] The Plaid processor token
+      # @param request_options [Gusto::RequestOptions] 
+      # @return [Gusto::CompanyBankAccounts::CompanyBankAccount]
+      # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.companies.bank_accounts.create_processor_token(owner_id: "ef279fbd-0fc6-4cf1-a977-6939d621c429", processor_token: "processor-sandbox-0asd1-a92nc")
+      def create_processor_token(owner_id:, processor_token:, request_options: nil)
+        response = @request_client.conn.post do | req |
+  unless request_options&.timeout_in_seconds.nil?
+    req.options.timeout = request_options.timeout_in_seconds
+  end
+  unless request_options&.token.nil?
+    req.headers["Authorization"] = request_options.token
+  end
+  unless request_options&.gusto_api_version.nil?
+    req.headers["X-Gusto-API-Version"] = request_options.gusto_api_version
+  end
+  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
+  req.body = { **(request_options&.additional_body_parameters || {}), "owner_type": "Company", owner_id: owner_id, processor_token: processor_token }.compact
+  req.url "#{@request_client.get_url(request_options: request_options)}/v1/plaid/processor_token"
+end
+        Gusto::CompanyBankAccounts::CompanyBankAccount.from_json(json_object: response.body)
+      end
+    end
+    class AsyncBankAccountsClient
+    # @return [Gusto::AsyncRequestClient] 
+      attr_reader :request_client
+
+
+      # @param request_client [Gusto::RequestClient] 
+      # @return [Gusto::Companies::AsyncBankAccountsClient]
+      def initialize(request_client:)
+        @request_client = request_client
+      end
+# Returns company bank accounts. Currently, we only support a single default bank
+#  account per company.
+#  scope: `company_bank_accounts:read`
+      #
+      # @param company_id [String] The UUID of the company
+      # @param request_options [Gusto::RequestOptions] 
+      # @return [Array<Gusto::CompanyBankAccounts::CompanyBankAccount>]
+      # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.companies.bank_accounts.get(company_id: "company_id")
+      def get(company_id:, request_options: nil)
+        Async do
+          response = @request_client.conn.get do | req |
+  unless request_options&.timeout_in_seconds.nil?
+    req.options.timeout = request_options.timeout_in_seconds
+  end
+  unless request_options&.token.nil?
+    req.headers["Authorization"] = request_options.token
+  end
+  unless request_options&.gusto_api_version.nil?
+    req.headers["X-Gusto-API-Version"] = request_options.gusto_api_version
+  end
+  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)}/v1/companies/#{company_id}/bank_accounts"
+end
+          parsed_json = JSON.parse(response.body)
+          parsed_json&.map do | item |
+            item = item.to_json
+            Gusto::CompanyBankAccounts::CompanyBankAccount.from_json(json_object: item)
+          end
+        end
+      end
+# This endpoint creates a new company bank account.
+#  Upon being created, two verification deposits are automatically sent to the bank
+#  account, and the bank account's verification_status is 'awaiting_deposits'.
+#  When the deposits are successfully transferred, the verification_status changes
+#  to 'ready_for_verification', at which point the verify endpoint can be used to
+#  verify the bank account.
+#  After successful verification, the bank account's verification_status is
+#  'verified'.
+#  scope: `company_bank_accounts:write`
+#  > 🚧 Warning
+#  >
+#  > If a default bank account exists, it will be disabled and the new bank account
+#  will replace it as the company's default funding method.
+      #
+      # @param company_id [String] The UUID of the company
+      # @param routing_number [String] The bank routing number
+      # @param account_number [String] The bank account number
+      # @param account_type [Gusto::Companies::BankAccounts::BankAccountsCreateRequestAccountType] The bank account type
+      # @param request_options [Gusto::RequestOptions] 
+      # @return [Gusto::CompanyBankAccounts::CompanyBankAccount]
+      # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.companies.bank_accounts.create(
+#    company_id: "company_id",
+#    routing_number: "115092013",
+#    account_number: "9775014007",
+#    account_type: CHECKING
+#  )
+      def create(company_id:, routing_number: nil, account_number: nil, account_type: nil, request_options: nil)
+        Async do
+          response = @request_client.conn.post do | req |
+  unless request_options&.timeout_in_seconds.nil?
+    req.options.timeout = request_options.timeout_in_seconds
+  end
+  unless request_options&.token.nil?
+    req.headers["Authorization"] = request_options.token
+  end
+  unless request_options&.gusto_api_version.nil?
+    req.headers["X-Gusto-API-Version"] = request_options.gusto_api_version
+  end
+  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
+  req.body = { **(request_options&.additional_body_parameters || {}), routing_number: routing_number, account_number: account_number, account_type: account_type }.compact
+  req.url "#{@request_client.get_url(request_options: request_options)}/v1/companies/#{company_id}/bank_accounts"
+end
+          Gusto::CompanyBankAccounts::CompanyBankAccount.from_json(json_object: response.body)
+        end
+      end
+# Verify a company bank account by confirming the two micro-deposits sent to the
+#  bank account. Note that the order of the two deposits specified in request
+#  parameters does not matter. There's a maximum of 5 verification attempts, after
+#  which we will automatically initiate a new set of micro-deposits and require the
+#  bank account to be verified with the new micro-deposits.
+#  ### Bank account verification in demo
+#  We provide the endpoint `POST
+#  v1/companies/{company_id}/bank_accounts/{bank_account_uuid}/send_test_deposits'`
+#  to facilitate bank account verification in the demo environment. This endpoint
+#  simulates the micro-deposits transfer and returns them in the response. You can
+#  call this endpoint as many times as you wish to retrieve the values of the two
+#  micro deposits.
+#  ```
+#  POST
+#  dfbcb56d9/bank_accounts/ade55e57-4800-4059-9ecd-fa29cfeb6dd2/send_test_deposits'
+#  {
+#  "deposit_1": 0.02,
+#  "deposit_2": 0.42
+#  }
+#  ```
+#  scope: `company_bank_accounts:write`
+      #
+      # @param bank_account_uuid [String] The UUID of the bank account
+      # @param company_id [String] The UUID of the company
+      # @param deposit1 [Float] The dollar amount of the first micro-deposit
+      # @param deposit2 [Float] The dollar amount of the second micro-deposit
+      # @param request_options [Gusto::RequestOptions] 
+      # @return [Gusto::CompanyBankAccounts::CompanyBankAccount]
+      # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.companies.bank_accounts.verify(
+#    bank_account_uuid: "bank_account_uuid",
+#    company_id: "company_id",
+#    deposit1: 0.02,
+#    deposit2: 0.42
+#  )
+      def verify(bank_account_uuid:, company_id:, deposit1: nil, deposit2: nil, request_options: nil)
+        Async do
+          response = @request_client.conn.put do | req |
+  unless request_options&.timeout_in_seconds.nil?
+    req.options.timeout = request_options.timeout_in_seconds
+  end
+  unless request_options&.token.nil?
+    req.headers["Authorization"] = request_options.token
+  end
+  unless request_options&.gusto_api_version.nil?
+    req.headers["X-Gusto-API-Version"] = request_options.gusto_api_version
+  end
+  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
+  req.body = { **(request_options&.additional_body_parameters || {}), deposit_1: deposit1, deposit_2: deposit2 }.compact
+  req.url "#{@request_client.get_url(request_options: request_options)}/v1/companies/#{bank_account_uuid}/bank_accounts/#{company_id}/verify"
+end
+          Gusto::CompanyBankAccounts::CompanyBankAccount.from_json(json_object: response.body)
+        end
+      end
+# This endpoint creates a new **verified** bank account by using a plaid processor
+#  token to retrieve its information.
+#  scope: `plaid_processor:write`
+#  > 📘
+#  > To create a token please use the [plaid
+#  api](https://plaid.com/docs/api/processors/#processortokencreate) and select
+#  "gusto" as processor.
+#  > 🚧 Warning - Company Bank Accounts
+#  >
+#  > If a default company bank account exists, it will be disabled and the new bank
+#  account will replace it as the company's default funding method.
+      #
+      # @param owner_id [String] The owner uuid of the bank account
+      # @param processor_token [String] The Plaid processor token
+      # @param request_options [Gusto::RequestOptions] 
+      # @return [Gusto::CompanyBankAccounts::CompanyBankAccount]
+      # @example
+#  api = Gusto::Client.new(
+#    base_url: "https://api.example.com",
+#    environment: Gusto::Environment::DEMO,
+#    token: "YOUR_AUTH_TOKEN"
+#  )
+#  api.companies.bank_accounts.create_processor_token(owner_id: "ef279fbd-0fc6-4cf1-a977-6939d621c429", processor_token: "processor-sandbox-0asd1-a92nc")
+      def create_processor_token(owner_id:, processor_token:, request_options: nil)
+        Async do
+          response = @request_client.conn.post do | req |
+  unless request_options&.timeout_in_seconds.nil?
+    req.options.timeout = request_options.timeout_in_seconds
+  end
+  unless request_options&.token.nil?
+    req.headers["Authorization"] = request_options.token
+  end
+  unless request_options&.gusto_api_version.nil?
+    req.headers["X-Gusto-API-Version"] = request_options.gusto_api_version
+  end
+  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
+  req.body = { **(request_options&.additional_body_parameters || {}), "owner_type": "Company", owner_id: owner_id, processor_token: processor_token }.compact
+  req.url "#{@request_client.get_url(request_options: request_options)}/v1/plaid/processor_token"
+end
+          Gusto::CompanyBankAccounts::CompanyBankAccount.from_json(json_object: response.body)
+        end
+      end
+    end
+  end
+end

data/lib/fern_gusto/companies/bank_accounts/types/bank_accounts_create_request_account_type.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Gusto
+  module Companies
+    module BankAccounts
+# The bank account type
+      class BankAccountsCreateRequestAccountType
+
+        CHECKING = "Checking"
+        SAVINGS = "Savings"
+
+      end
+    end
+  end
+end