DealMakerAPI 0.89.3 → 0.89.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f9f6f1f79f3700e4eff09f5f72ae54e9451e2aba7498b9f6a2af5d8ae541dd1f
-  data.tar.gz: 3b7befbfc70a8810ce0564990b1227348a2bc3dd0f4f008565f7e9ed3aa975d3
+  metadata.gz: 6316919348b360c98db63f98b7392b416fb05fd3361174bec9231a9a14de300d
+  data.tar.gz: afb6773b6f524f5df6f2faf6b7003f43d0c27d4d9da26d315f6db137eb7dbbaf
 SHA512:
-  metadata.gz: ed5237e33e957a7c7a1ba95338509287314197bfebf94f04e60186bf5e2b2ce7f30722a6c0b7c7355022fde355edc9b491321c2dabbe4c07e44e2fcd77f9e501
-  data.tar.gz: a6b14bd37aa9b746a3b6cdeafe486dc43c54c46b89ed30acedd8444e4e13bc1074b196e0cecc7549c42f15124e0bc0841cf3d630f5a299632464406ce1aa9f90
+  metadata.gz: e2560977def9c7427b248c79b790620ff607c3a0c00c9d9a28c45cb10538f8435599477b23ae68ec2f6c1b0a728dadf8bb3673c4f0e2c7b57f9fe4cbe1b8c508
+  data.tar.gz: 7859da6bcf44be33d16392449a88c87b23cf5fa2f3f1f9164791d888b4dc3bd60f2913f3658abbe9bb5ede1e6dcd90e3d5c94402227a9893f650cb518ea0427f

data/README.md

@@ -338,7 +338,7 @@ Given the high number of updates our platform performs on any investor, we’ve
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 1.75.0
-- Package version: 0.89.3
+- Package version: 0.89.4
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 
 ## Installation
@@ -354,16 +354,16 @@ gem build DealMakerAPI.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./DealMakerAPI-0.89.3.gem
+gem install ./DealMakerAPI-0.89.4.gem
 ```
 
-(for development, run `gem install --dev ./DealMakerAPI-0.89.3.gem` to install the development dependencies)
+(for development, run `gem install --dev ./DealMakerAPI-0.89.4.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'DealMakerAPI', '~> 0.89.3'
+    gem 'DealMakerAPI', '~> 0.89.4'
 
 ### Install from Git
 
@@ -446,6 +446,7 @@ Class | Method | HTTP request | Description
 *DealMakerAPI::InvestorApi* | [**get_investor_otp_link**](docs/InvestorApi.md#get_investor_otp_link) | **GET** /deals/{id}/investors/{investor_id}/otp_access_link | Get OTP access link for deal investor
 *DealMakerAPI::InvestorApi* | [**list_investors**](docs/InvestorApi.md#list_investors) | **GET** /deals/{id}/investors | List deal investors
 *DealMakerAPI::InvestorApi* | [**patch_investor**](docs/InvestorApi.md#patch_investor) | **PATCH** /deals/{id}/investors/{investor_id} | Patch a deal investor
+*DealMakerAPI::InvestorApi* | [**run_background_search**](docs/InvestorApi.md#run_background_search) | **POST** /deals/{id}/investors/{investor_id}/background_checks/{search_entity_id}/run | Run Alloy background search for the investor
 *DealMakerAPI::InvestorApi* | [**update_investor**](docs/InvestorApi.md#update_investor) | **PUT** /deals/{id}/investors/{investor_id} | Update a deal investor
 *DealMakerAPI::InvestorProfileApi* | [**create_corporation_profile**](docs/InvestorProfileApi.md#create_corporation_profile) | **POST** /investor_profiles/corporations | Create new corporation investor profile.
 *DealMakerAPI::InvestorProfileApi* | [**create_individual_profile**](docs/InvestorProfileApi.md#create_individual_profile) | **POST** /investor_profiles/individuals | Create new individual investor profile

data/docs/InvestorApi.md

@@ -16,6 +16,7 @@ All URIs are relative to *http://api.dealmaker.tech*
 | [**get_investor_otp_link**](InvestorApi.md#get_investor_otp_link) | **GET** /deals/{id}/investors/{investor_id}/otp_access_link | Get OTP access link for deal investor |
 | [**list_investors**](InvestorApi.md#list_investors) | **GET** /deals/{id}/investors | List deal investors |
 | [**patch_investor**](InvestorApi.md#patch_investor) | **PATCH** /deals/{id}/investors/{investor_id} | Patch a deal investor |
+| [**run_background_search**](InvestorApi.md#run_background_search) | **POST** /deals/{id}/investors/{investor_id}/background_checks/{search_entity_id}/run | Run Alloy background search for the investor |
 | [**update_investor**](InvestorApi.md#update_investor) | **PUT** /deals/{id}/investors/{investor_id} | Update a deal investor |
 
 
@@ -855,6 +856,74 @@ No authorization required
 - **Accept**: application/json
 
 
+## run_background_search
+
+> <V1EntitiesInvestor> run_background_search(id, investor_id, search_entity_id)
+
+Run Alloy background search for the investor
+
+Run Alloy background search for the investor
+
+### Examples
+
+```ruby
+require 'time'
+require 'DealMakerAPI'
+
+api_instance = DealMakerAPI::InvestorApi.new
+id = 56 # Integer | 
+investor_id = 56 # Integer | 
+search_entity_id = 56 # Integer | 
+
+begin
+  # Run Alloy background search for the investor
+  result = api_instance.run_background_search(id, investor_id, search_entity_id)
+  p result
+rescue DealMakerAPI::ApiError => e
+  puts "Error when calling InvestorApi->run_background_search: #{e}"
+end
+```
+
+#### Using the run_background_search_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<V1EntitiesInvestor>, Integer, Hash)> run_background_search_with_http_info(id, investor_id, search_entity_id)
+
+```ruby
+begin
+  # Run Alloy background search for the investor
+  data, status_code, headers = api_instance.run_background_search_with_http_info(id, investor_id, search_entity_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <V1EntitiesInvestor>
+rescue DealMakerAPI::ApiError => e
+  puts "Error when calling InvestorApi->run_background_search_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** |  |  |
+| **investor_id** | **Integer** |  |  |
+| **search_entity_id** | **Integer** |  |  |
+
+### Return type
+
+[**V1EntitiesInvestor**](V1EntitiesInvestor.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## update_investor
 
 > <V1EntitiesInvestor> update_investor(id, investor_id, deals_id_investors)

data/lib/DealMakerAPI/api/investor_api.rb

@@ -918,6 +918,81 @@ module DealMakerAPI
       return data, status_code, headers
     end
 
+    # Run Alloy background search for the investor
+    # Run Alloy background search for the investor
+    # @param id [Integer] 
+    # @param investor_id [Integer] 
+    # @param search_entity_id [Integer] 
+    # @param [Hash] opts the optional parameters
+    # @return [V1EntitiesInvestor]
+    def run_background_search(id, investor_id, search_entity_id, opts = {})
+      data, _status_code, _headers = run_background_search_with_http_info(id, investor_id, search_entity_id, opts)
+      data
+    end
+
+    # Run Alloy background search for the investor
+    # Run Alloy background search for the investor
+    # @param id [Integer] 
+    # @param investor_id [Integer] 
+    # @param search_entity_id [Integer] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(V1EntitiesInvestor, Integer, Hash)>] V1EntitiesInvestor data, response status code and response headers
+    def run_background_search_with_http_info(id, investor_id, search_entity_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: InvestorApi.run_background_search ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling InvestorApi.run_background_search"
+      end
+      # verify the required parameter 'investor_id' is set
+      if @api_client.config.client_side_validation && investor_id.nil?
+        fail ArgumentError, "Missing the required parameter 'investor_id' when calling InvestorApi.run_background_search"
+      end
+      # verify the required parameter 'search_entity_id' is set
+      if @api_client.config.client_side_validation && search_entity_id.nil?
+        fail ArgumentError, "Missing the required parameter 'search_entity_id' when calling InvestorApi.run_background_search"
+      end
+      # resource path
+      local_var_path = '/deals/{id}/investors/{investor_id}/background_checks/{search_entity_id}/run'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'investor_id' + '}', CGI.escape(investor_id.to_s)).sub('{' + 'search_entity_id' + '}', CGI.escape(search_entity_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'V1EntitiesInvestor'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"InvestorApi.run_background_search",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: InvestorApi#run_background_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Update a deal investor
     # Update deal investor
     # @param id [Integer] The deal id.

data/lib/DealMakerAPI/version.rb

@@ -11,5 +11,5 @@ OpenAPI Generator version: 7.1.0-SNAPSHOT
 =end
 
 module DealMakerAPI
-  VERSION = '0.89.3'
+  VERSION = '0.89.4'
 end

data/spec/api/investor_api_spec.rb

@@ -198,6 +198,20 @@ describe 'InvestorApi' do
     end
   end
 
+  # unit tests for run_background_search
+  # Run Alloy background search for the investor
+  # Run Alloy background search for the investor
+  # @param id 
+  # @param investor_id 
+  # @param search_entity_id 
+  # @param [Hash] opts the optional parameters
+  # @return [V1EntitiesInvestor]
+  describe 'run_background_search test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
   # unit tests for update_investor
   # Update a deal investor
   # Update deal investor

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: DealMakerAPI
 version: !ruby/object:Gem::Version
-  version: 0.89.3
+  version: 0.89.4
 platform: ruby
 authors:
 - DealMaker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-10-16 00:00:00.000000000 Z
+date: 2023-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -376,100 +376,100 @@ signing_key:
 specification_version: 4
 summary: A ruby wrapper for the DealMaker API
 test_files:
+- spec/api/upload_api_spec.rb
+- spec/api/investor_api_spec.rb
+- spec/api/company_api_spec.rb
 - spec/api/deal_setup_api_spec.rb
-- spec/api/deal_api_spec.rb
-- spec/api/shareholder_api_spec.rb
 - spec/api/country_api_spec.rb
-- spec/api/company_api_spec.rb
-- spec/api/upload_api_spec.rb
-- spec/api/users_api_spec.rb
-- spec/api/deals_api_spec.rb
 - spec/api/investor_profile_api_spec.rb
+- spec/api/deals_api_spec.rb
+- spec/api/users_api_spec.rb
+- spec/api/shareholder_api_spec.rb
+- spec/api/deal_api_spec.rb
 - spec/api/default_api_spec.rb
-- spec/api/investor_api_spec.rb
 - spec/api_client_spec.rb
 - spec/configuration_spec.rb
-- spec/models/v1_entities_shareholders_spec.rb
-- spec/models/post_investor_profiles_joints_spec.rb
-- spec/models/v1_entities_investor_profile_fields_trust_spec.rb
-- spec/models/v1_entities_investor_profile_joint_spec.rb
+- spec/models/v1_entities_webhooks_subscription_deal_spec.rb
+- spec/models/v1_entities_investor_profiles_spec.rb
+- spec/models/v1_entities_bulk_upload_spec.rb
+- spec/models/v1_entities_deal_funding_metrics_spec.rb
+- spec/models/v1_entities_company_deals_spec.rb
+- spec/models/v1_entities_addresses_spec.rb
+- spec/models/v1_entities_webhooks_subscription_deals_spec.rb
+- spec/models/post_investor_profiles_corporations_beneficial_owners_inner_spec.rb
+- spec/models/v1_entities_address_spec.rb
+- spec/models/v1_entities_webhooks_security_token_spec.rb
+- spec/models/put_webhooks_id_request_spec.rb
+- spec/models/v1_entities_express_wire_instructions_spec.rb
+- spec/models/v1_entities_dividend_spec.rb
+- spec/models/generate_url_request_spec.rb
+- spec/models/v1_entities_investor_spec.rb
+- spec/models/patch_investor_profiles_trusts_trustees_inner_spec.rb
+- spec/models/v1_entities_investor_profile_owner_spec.rb
+- spec/models/patch_investor_profiles_trusts_spec.rb
+- spec/models/v1_entities_bulk_upload_detail_spec.rb
+- spec/models/v1_entities_webhooks_subscription_spec.rb
+- spec/models/v1_entities_deal_investor_metrics_spec.rb
+- spec/models/v1_entities_investor_profile_fields_signing_officer_spec.rb
+- spec/models/add_document_request_spec.rb
+- spec/models/v1_entities_deal_enterprise_spec.rb
+- spec/models/v1_entities_investor_user_spec.rb
+- spec/models/create_bulk_upload_detail_request_spec.rb
+- spec/models/v1_entities_investor_profile_item_spec.rb
 - spec/models/patch_investor_profiles_joints_spec.rb
-- spec/models/v1_entities_investor_otp_access_link_spec.rb
+- spec/models/put_deals_id_script_tag_environment_request_spec.rb
+- spec/models/v1_entities_attachment_spec.rb
 - spec/models/v1_entities_deal_setup_user_spec.rb
-- spec/models/v1_entities_shareholder_spec.rb
-- spec/models/patch_investor_profiles_trusts_spec.rb
+- spec/models/v1_entities_investor_profile_trust_spec.rb
+- spec/models/post_investor_profiles_trusts_spec.rb
+- spec/models/post_investor_profiles_corporations_spec.rb
 - spec/models/patch_investor_request_spec.rb
-- spec/models/add_document_request_spec.rb
-- spec/models/post_investor_profiles_individuals_spec.rb
-- spec/models/put_webhooks_id_request_spec.rb
-- spec/models/v1_entities_country_spec.rb
-- spec/models/v1_entities_bulk_uploads_spec.rb
+- spec/models/add506c_document_request_spec.rb
+- spec/models/v1_entities_state_spec.rb
+- spec/models/v1_entities_background_check_search_spec.rb
+- spec/models/post_deals_id_investors_spec.rb
+- spec/models/v1_entities_investor_profile_joint_spec.rb
 - spec/models/v1_entities_dividends_spec.rb
+- spec/models/v1_entities_investor_profile_individual_spec.rb
+- spec/models/v1_entities_investor_profile_fields_primary_holder_spec.rb
+- spec/models/v1_entities_investor_profile_fields_beneficial_owner_spec.rb
+- spec/models/v1_entities_bulk_upload_details_spec.rb
+- spec/models/v1_entities_investors_spec.rb
+- spec/models/create_company_request_spec.rb
 - spec/models/edit_investor_tags_request_spec.rb
+- spec/models/v1_entities_shareholder_spec.rb
+- spec/models/bulk_upload_investors_request_spec.rb
+- spec/models/create_deal_setup_request_spec.rb
+- spec/models/v1_entities_investor_profile_address_spec.rb
+- spec/models/v1_entities_express_wire_instruction_spec.rb
+- spec/models/v1_entities_generic_response_spec.rb
+- spec/models/v1_entities_presigned_url_result_spec.rb
+- spec/models/v1_entities_deal_setup_spec.rb
 - spec/models/post_webhooks_request_spec.rb
-- spec/models/patch_investor_profiles_corporations_spec.rb
-- spec/models/v1_entities_company_deals_spec.rb
 - spec/models/post_investor_profiles_trusts_trustees_inner_spec.rb
-- spec/models/v1_entities_investor_profile_fields_beneficial_owner_spec.rb
+- spec/models/post_investor_profiles_individuals_spec.rb
 - spec/models/v1_entities_webhooks_deal_spec.rb
-- spec/models/v1_entities_investor_profile_fields_signing_officer_spec.rb
-- spec/models/v1_entities_deal_investor_metrics_spec.rb
-- spec/models/post_investor_profiles_corporations_beneficial_owners_inner_spec.rb
-- spec/models/put_deals_id_script_tag_environment_request_spec.rb
-- spec/models/v1_entities_deal_issuer_spec.rb
-- spec/models/v1_entities_investor_profile_owner_spec.rb
-- spec/models/v1_entities_investor_user_spec.rb
-- spec/models/v1_entities_subscription_agreement_spec.rb
-- spec/models/v1_entities_express_wire_instruction_spec.rb
-- spec/models/v1_entities_webhooks_subscription_deal_spec.rb
-- spec/models/v1_entities_background_check_search_spec.rb
-- spec/models/v1_entities_investor_profile_corporation_spec.rb
-- spec/models/v1_entities_deal_setup_spec.rb
-- spec/models/v1_entities_generic_response_spec.rb
-- spec/models/v1_entities_investor_profile_individual_spec.rb
-- spec/models/v1_entities_bulk_upload_detail_spec.rb
-- spec/models/v1_entities_dividend_spec.rb
-- spec/models/v1_entities_address_spec.rb
-- spec/models/v1_entities_company_spec.rb
-- spec/models/v1_entities_investor_profile_fields_primary_holder_spec.rb
-- spec/models/v1_entities_investor_profile_item_spec.rb
+- spec/models/patch_investor_profiles_corporations_spec.rb
+- spec/models/v1_entities_deal_spec.rb
+- spec/models/v1_entities_bulk_uploads_spec.rb
+- spec/models/put_deals_id_investors_spec.rb
 - spec/models/patch_investor_profiles_corporations_beneficial_owners_inner_spec.rb
-- spec/models/v1_entities_express_wire_instructions_spec.rb
-- spec/models/create_company_request_spec.rb
-- spec/models/v1_entities_deals_spec.rb
-- spec/models/v1_entities_webhooks_security_token_spec.rb
-- spec/models/create_shareholder_action_request_spec.rb
-- spec/models/post_investor_profiles_corporations_spec.rb
-- spec/models/v1_entities_webhooks_subscription_deals_spec.rb
+- spec/models/v1_entities_company_spec.rb
 - spec/models/v1_entities_countries_spec.rb
+- spec/models/v1_entities_investor_profile_fields_corporation_spec.rb
+- spec/models/v1_entities_country_spec.rb
+- spec/models/patch_investor_profiles_individuals_spec.rb
+- spec/models/v1_entities_investor_profile_fields_trust_spec.rb
+- spec/models/v1_entities_subscription_agreement_spec.rb
+- spec/models/v1_entities_deal_issuer_spec.rb
+- spec/models/post_investor_profiles_joints_spec.rb
+- spec/models/create_shareholder_action_request_spec.rb
+- spec/models/v1_entities_deals_spec.rb
+- spec/models/v1_entities_investor_profile_corporation_spec.rb
+- spec/models/v1_entities_investor_profile_fields_account_holder_spec.rb
 - spec/models/v1_entities_shareholders_tags_spec.rb
-- spec/models/v1_entities_attachment_spec.rb
-- spec/models/post_deals_id_investors_spec.rb
-- spec/models/create_bulk_upload_detail_request_spec.rb
-- spec/models/create_deal_setup_request_spec.rb
-- spec/models/patch_investor_profiles_trusts_trustees_inner_spec.rb
-- spec/models/v1_entities_webhooks_subscription_spec.rb
-- spec/models/v1_entities_investors_spec.rb
-- spec/models/v1_entities_deal_enterprise_spec.rb
-- spec/models/v1_entities_deal_funding_metrics_spec.rb
-- spec/models/v1_entities_bulk_upload_details_spec.rb
-- spec/models/v1_entities_bulk_upload_spec.rb
-- spec/models/v1_entities_investor_profiles_spec.rb
-- spec/models/add506c_document_request_spec.rb
-- spec/models/v1_entities_investor_spec.rb
-- spec/models/generate_url_request_spec.rb
 - spec/models/v1_entities_company_deal_spec.rb
-- spec/models/put_deals_id_investors_spec.rb
-- spec/models/v1_entities_deal_spec.rb
-- spec/models/post_investor_profiles_trusts_spec.rb
-- spec/models/v1_entities_state_spec.rb
-- spec/models/v1_entities_investor_profile_address_spec.rb
-- spec/models/v1_entities_investor_profile_fields_account_holder_spec.rb
-- spec/models/patch_investor_profiles_individuals_spec.rb
-- spec/models/v1_entities_presigned_url_result_spec.rb
-- spec/models/v1_entities_addresses_spec.rb
-- spec/models/v1_entities_investor_profile_trust_spec.rb
+- spec/models/v1_entities_investor_otp_access_link_spec.rb
+- spec/models/v1_entities_shareholders_spec.rb
 - spec/models/create_bulk_upload_request_spec.rb
-- spec/models/bulk_upload_investors_request_spec.rb
-- spec/models/v1_entities_investor_profile_fields_corporation_spec.rb
 - spec/spec_helper.rb