DealMakerAPI 0.0.3 → 0.68.6

data/docs/CreateDealSetupRequest.md

@@ -0,0 +1,30 @@
+# DealMakerAPI::CreateDealSetupRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **invoicing_email** | **String** | The invoice email address. |  |
+| **issuer_industry** | **String** | The industry. | [optional][default to 'other'] |
+| **prohibited_industry** | **String** | Determine if the deal is a high risk or not. | [optional][default to 'prohibited'] |
+| **offering_type** | **String** | The deal kind | [default to 'other'] |
+| **title** | **String** | The name of deal to setup. |  |
+| **company_id** | **Integer** | the company id. |  |
+| **representative** | **String** | The email of the representative. | [optional] |
+
+## Example
+
+```ruby
+require 'DealMakerAPI'
+
+instance = DealMakerAPI::CreateDealSetupRequest.new(
+  invoicing_email: null,
+  issuer_industry: null,
+  prohibited_industry: null,
+  offering_type: null,
+  title: null,
+  company_id: null,
+  representative: null
+)
+```
+

data/docs/CreateIndividualProfileRequest.md

@@ -0,0 +1,44 @@
+# DealMakerAPI::CreateIndividualProfileRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email** | **String** | User email which is associated with individual investor profile. |  |
+| **us_accredited_category** | **String** | The accredited investor information. | [optional] |
+| **first_name** | **String** | The first name of the individual investor profile (required). | [optional] |
+| **last_name** | **String** | The last name of the individual investor profile (required) | [optional] |
+| **suffix** | **String** | The suffix of the individual investor profile | [optional] |
+| **date_of_birth** | **String** | The date of birth of the investor profile (required) | [optional] |
+| **taxpayer_id** | **String** | The taxpayer identification number of the investor profile (required) | [optional] |
+| **phone_number** | **String** | The phone number of the investor profile (required) | [optional] |
+| **country** | **String** | The country of the individual investor profile (required) | [optional] |
+| **street_address** | **String** | The street address of the individual investor profile (required) | [optional] |
+| **unit2** | **String** | The street address line 2 of the individual investor profile | [optional] |
+| **city** | **String** | The city of the individual investor profile (required) | [optional] |
+| **region** | **String** | The region or state of the individual investor profile (required) | [optional] |
+| **postal_code** | **String** | The postal code or zipcode of the individual investor profile (required) | [optional] |
+
+## Example
+
+```ruby
+require 'DealMakerAPI'
+
+instance = DealMakerAPI::CreateIndividualProfileRequest.new(
+  email: null,
+  us_accredited_category: null,
+  first_name: null,
+  last_name: null,
+  suffix: null,
+  date_of_birth: null,
+  taxpayer_id: null,
+  phone_number: null,
+  country: null,
+  street_address: null,
+  unit2: null,
+  city: null,
+  region: null,
+  postal_code: null
+)
+```
+

data/docs/CreateInvestorRequest.md

@@ -0,0 +1,40 @@
+# DealMakerAPI::CreateInvestorRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email** | **String** | The investor email address. |  |
+| **investor_profile_id** | **Integer** | The Investor Profile id. | [optional] |
+| **tags** | **Array<String>** |  | [optional] |
+| **first_name** | **String** | The first name of the investor. | [optional] |
+| **last_name** | **String** | The last name of the investor. | [optional] |
+| **phone_number** | **String** | The phone number of the investor. | [optional] |
+| **message** | **String** | The reminder email text of the investor. | [optional] |
+| **warrant_expiry_date** | **Date** | The warrant expiry date of the investor. | [optional] |
+| **warrant_certificate_number** | **Integer** | The certificate number of the investor. | [optional] |
+| **allocated_amount** | **Float** | The allocation amount of the investor. | [optional] |
+| **allocation_unit** | **String** | The allocation unit of the investor. | [optional][default to 'securities'] |
+| **state** | **String** | The initial state of the investor. | [optional][default to 'invited'] |
+
+## Example
+
+```ruby
+require 'DealMakerAPI'
+
+instance = DealMakerAPI::CreateInvestorRequest.new(
+  email: null,
+  investor_profile_id: null,
+  tags: null,
+  first_name: null,
+  last_name: null,
+  phone_number: null,
+  message: null,
+  warrant_expiry_date: null,
+  warrant_certificate_number: null,
+  allocated_amount: null,
+  allocation_unit: null,
+  state: null
+)
+```
+

data/docs/CreateJointProfileRequest.md

@@ -0,0 +1,68 @@
+# DealMakerAPI::CreateJointProfileRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email** | **String** | User email which is associated with investor profile. |  |
+| **us_accredited_category** | **String** | The accredited investor information. | [optional] |
+| **joint_type** | **String** | The types of joint investor. | [optional] |
+| **first_name** | **String** | The first name of the primary holder (required). | [optional] |
+| **last_name** | **String** | The last name of the primary holder (required). | [optional] |
+| **suffix** | **String** | The suffix of the primary holder. | [optional] |
+| **country** | **String** | The country the primary holder (required). | [optional] |
+| **street_address** | **String** | The street address of the primary holder (required). | [optional] |
+| **unit2** | **String** | The street address line 2 of the primary holder. | [optional] |
+| **city** | **String** | The city of the primary holder (required). | [optional] |
+| **region** | **String** | The region or State of the primary holder (required). | [optional] |
+| **postal_code** | **String** | The postal code or zipcode of the primary holder (required). | [optional] |
+| **date_of_birth** | **String** | The date of birth of the primary holder (required). | [optional] |
+| **taxpayer_id** | **String** | The taxpayer identification number of the primary holder (required). | [optional] |
+| **phone_number** | **String** | The phone number of the primary holder (required). | [optional] |
+| **joint_holder_first_name** | **String** | The first name of the joint holder (required). | [optional] |
+| **joint_holder_last_name** | **String** | The last name of the joint holder (required). | [optional] |
+| **joint_holder_suffix** | **String** | The suffix of the joint holder. | [optional] |
+| **joint_holder_country** | **String** | The country of the joint holder (required). | [optional] |
+| **joint_holder_street_address** | **String** | The street address of the joint holder (required). | [optional] |
+| **joint_holder_unit2** | **String** | The street address line 2 of the joint holder. | [optional] |
+| **joint_holder_city** | **String** | The city of the joint holder (required). | [optional] |
+| **joint_holder_region** | **String** | The region or state of the joint holder (required). | [optional] |
+| **joint_holder_postal_code** | **String** | The postal code or zipcode of the joint holder (required). | [optional] |
+| **joint_holder_date_of_birth** | **String** | The date of birth of the joint holder (required). | [optional] |
+| **joint_holder_taxpayer_id** | **String** | The taxpayer identification number of the joint holder (required). | [optional] |
+
+## Example
+
+```ruby
+require 'DealMakerAPI'
+
+instance = DealMakerAPI::CreateJointProfileRequest.new(
+  email: null,
+  us_accredited_category: null,
+  joint_type: null,
+  first_name: null,
+  last_name: null,
+  suffix: null,
+  country: null,
+  street_address: null,
+  unit2: null,
+  city: null,
+  region: null,
+  postal_code: null,
+  date_of_birth: null,
+  taxpayer_id: null,
+  phone_number: null,
+  joint_holder_first_name: null,
+  joint_holder_last_name: null,
+  joint_holder_suffix: null,
+  joint_holder_country: null,
+  joint_holder_street_address: null,
+  joint_holder_unit2: null,
+  joint_holder_city: null,
+  joint_holder_region: null,
+  joint_holder_postal_code: null,
+  joint_holder_date_of_birth: null,
+  joint_holder_taxpayer_id: null
+)
+```
+

data/docs/CreateTrustProfileRequest.md

@@ -0,0 +1,60 @@
+# DealMakerAPI::CreateTrustProfileRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email** | **String** | User email which is associated with investor profile (required). |  |
+| **us_accredited_category** | **String** | The accredited investor information. | [optional] |
+| **name** | **String** | The name of the trust (required). | [optional] |
+| **date** | **String** | The creation date of the trust (required). | [optional] |
+| **country** | **String** | The country of the trust (required). | [optional] |
+| **street_address** | **String** | Trust street address of the trust (required). | [optional] |
+| **unit2** | **String** | The street address line 2 of the trust. | [optional] |
+| **city** | **String** | The city of the trust (required). | [optional] |
+| **region** | **String** | The region or state of the trust (required). | [optional] |
+| **postal_code** | **String** | The postal code or zipcode of the trust (required). | [optional] |
+| **phone_number** | **String** | The phone number of the trust (required). | [optional] |
+| **trustees_first_name** | **Array<String>** | The list of first names for the trustees (required for trustee 1). | [optional] |
+| **trustees_last_name** | **Array<String>** | The list of last names for the trustees (required for trustee 1). | [optional] |
+| **trustees_suffix** | **Array<String>** | The list of suffixes for the trustees. | [optional] |
+| **trustees_country** | **Array<String>** | The list of countries for the trustees (required for trustee 1). | [optional] |
+| **trustees_street_address** | **Array<String>** | The list of street addresses for the trustees (required for trustee 1). | [optional] |
+| **trustees_unit_2** | **Array<String>** | The list of street address line 2 for the trustees. | [optional] |
+| **trustees_city** | **Array<String>** | The list of cities for the trustees (required for trustee 1). | [optional] |
+| **trustees_region** | **Array<String>** | The list of regions or states for the trustees (required for trustee 1). | [optional] |
+| **trustees_postal_code** | **Array<String>** | The list of postal codes or zipcodes for the trustees (required) for trustee 1. | [optional] |
+| **trustees_date_of_birth** | **Array<String>** | The list of dates of birth for the trustees (required for trustee 1). | [optional] |
+| **trustees_taxpayer_id** | **Array<String>** | The list of taxpayer identification numbers for the trustees (required for trustee 1). | [optional] |
+
+## Example
+
+```ruby
+require 'DealMakerAPI'
+
+instance = DealMakerAPI::CreateTrustProfileRequest.new(
+  email: null,
+  us_accredited_category: null,
+  name: null,
+  date: null,
+  country: null,
+  street_address: null,
+  unit2: null,
+  city: null,
+  region: null,
+  postal_code: null,
+  phone_number: null,
+  trustees_first_name: null,
+  trustees_last_name: null,
+  trustees_suffix: null,
+  trustees_country: null,
+  trustees_street_address: null,
+  trustees_unit_2: null,
+  trustees_city: null,
+  trustees_region: null,
+  trustees_postal_code: null,
+  trustees_date_of_birth: null,
+  trustees_taxpayer_id: null
+)
+```
+

data/docs/DealApi.md

@@ -4,88 +4,17 @@ All URIs are relative to *http://api.dealmaker.tech*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
-| [**create_investor**](DealApi.md#create_investor) | **POST** /deals/{id}/investors | Create a deal investor |
-| [**get_deal**](DealApi.md#get_deal) | **GET** /deals/{id} | Get a deal by id |
-| [**get_investor**](DealApi.md#get_investor) | **GET** /deals/{id}/investors/{investor_id} | Get a deal investor by id |
+| [**get_deal**](DealApi.md#get_deal) | **GET** /deals/{id} | Get deal by Deal ID |
 | [**list_deals**](DealApi.md#list_deals) | **GET** /deals | List available deals |
-| [**list_investors**](DealApi.md#list_investors) | **GET** /deals/{id}/investors | List deal investors |
-
-
-## create_investor
-
-> <V1EntitiesInvestor> create_investor(id, unknown_base_type)
-
-Create a deal investor
-
-Create a single deal investor.
-
-### Examples
-
-```ruby
-require 'time'
-require 'DealMakerAPI'
-# setup authorization
-DealMakerAPI.configure do |config|end
-
-api_instance = DealMakerAPI::DealApi.new
-id = 56 # Integer | The deal id.
-unknown_base_type = TODO # UNKNOWN_BASE_TYPE | 
-
-begin
-  # Create a deal investor
-  result = api_instance.create_investor(id, unknown_base_type)
-  p result
-rescue DealMakerAPI::ApiError => e
-  puts "Error when calling DealApi->create_investor: #{e}"
-end
-```
-
-#### Using the create_investor_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<V1EntitiesInvestor>, Integer, Hash)> create_investor_with_http_info(id, unknown_base_type)
-
-```ruby
-begin
-  # Create a deal investor
-  data, status_code, headers = api_instance.create_investor_with_http_info(id, unknown_base_type)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <V1EntitiesInvestor>
-rescue DealMakerAPI::ApiError => e
-  puts "Error when calling DealApi->create_investor_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **id** | **Integer** | The deal id. |  |
-| **unknown_base_type** | [**UNKNOWN_BASE_TYPE**](UNKNOWN_BASE_TYPE.md) |  |  |
-
-### Return type
-
-[**V1EntitiesInvestor**](V1EntitiesInvestor.md)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
-- **Content-Type**: application/json
-- **Accept**: application/json
 
 
 ## get_deal
 
 > <V1EntitiesDeal> get_deal(id)
 
-Get a deal by id
+Get deal by Deal ID
 
-Get a deal
+Gets a single deal using the Deal ID
 
 ### Examples
 
@@ -99,7 +28,7 @@ api_instance = DealMakerAPI::DealApi.new
 id = 56 # Integer | The deal id.
 
 begin
-  # Get a deal by id
+  # Get deal by Deal ID
   result = api_instance.get_deal(id)
   p result
 rescue DealMakerAPI::ApiError => e
@@ -115,7 +44,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # Get a deal by id
+  # Get deal by Deal ID
   data, status_code, headers = api_instance.get_deal_with_http_info(id)
   p status_code # => 2xx
   p headers # => { ... }
@@ -145,74 +74,6 @@ No authorization required
 - **Accept**: application/json
 
 
-## get_investor
-
-> <V1EntitiesInvestor> get_investor(id, investor_id)
-
-Get a deal investor by id
-
-Gets a single investor by the id.
-
-### Examples
-
-```ruby
-require 'time'
-require 'DealMakerAPI'
-# setup authorization
-DealMakerAPI.configure do |config|end
-
-api_instance = DealMakerAPI::DealApi.new
-id = 56 # Integer | The deal id.
-investor_id = 56 # Integer | The investor id.
-
-begin
-  # Get a deal investor by id
-  result = api_instance.get_investor(id, investor_id)
-  p result
-rescue DealMakerAPI::ApiError => e
-  puts "Error when calling DealApi->get_investor: #{e}"
-end
-```
-
-#### Using the get_investor_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<V1EntitiesInvestor>, Integer, Hash)> get_investor_with_http_info(id, investor_id)
-
-```ruby
-begin
-  # Get a deal investor by id
-  data, status_code, headers = api_instance.get_investor_with_http_info(id, investor_id)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <V1EntitiesInvestor>
-rescue DealMakerAPI::ApiError => e
-  puts "Error when calling DealApi->get_investor_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **id** | **Integer** | The deal id. |  |
-| **investor_id** | **Integer** | The investor id. |  |
-
-### Return type
-
-[**V1EntitiesInvestor**](V1EntitiesInvestor.md)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
 ## list_deals
 
 > <V1EntitiesDeals> list_deals(opts)
@@ -284,81 +145,3 @@ No authorization required
 - **Content-Type**: Not defined
 - **Accept**: application/json
 
-
-## list_investors
-
-> <V1EntitiesInvestors> list_investors(id, opts)
-
-List deal investors
-
-List deal investors according to the specified search criteria.
-
-### Examples
-
-```ruby
-require 'time'
-require 'DealMakerAPI'
-# setup authorization
-DealMakerAPI.configure do |config|end
-
-api_instance = DealMakerAPI::DealApi.new
-id = 56 # Integer | The deal id.
-opts = {
-  page: 56, # Integer | Page offset to fetch.
-  per_page: 56, # Integer | Number of results to return per page.
-  offset: 56, # Integer | Pad a number of results.
-  investor_ids: [37], # Array<Integer> | An array of investor ids.
-  q: 'q_example' # String | The search query for investors. For additional information on filtering and seach, click [here](#section/Search-and-Filtering-(The-q-parameter)/Keyword-filtering)
-}
-
-begin
-  # List deal investors
-  result = api_instance.list_investors(id, opts)
-  p result
-rescue DealMakerAPI::ApiError => e
-  puts "Error when calling DealApi->list_investors: #{e}"
-end
-```
-
-#### Using the list_investors_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<V1EntitiesInvestors>, Integer, Hash)> list_investors_with_http_info(id, opts)
-
-```ruby
-begin
-  # List deal investors
-  data, status_code, headers = api_instance.list_investors_with_http_info(id, opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <V1EntitiesInvestors>
-rescue DealMakerAPI::ApiError => e
-  puts "Error when calling DealApi->list_investors_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **id** | **Integer** | The deal id. |  |
-| **page** | **Integer** | Page offset to fetch. | [optional][default to 1] |
-| **per_page** | **Integer** | Number of results to return per page. | [optional][default to 25] |
-| **offset** | **Integer** | Pad a number of results. | [optional][default to 0] |
-| **investor_ids** | [**Array&lt;Integer&gt;**](Integer.md) | An array of investor ids. | [optional] |
-| **q** | **String** | The search query for investors. For additional information on filtering and seach, click [here](#section/Search-and-Filtering-(The-q-parameter)/Keyword-filtering) | [optional] |
-
-### Return type
-
-[**V1EntitiesInvestors**](V1EntitiesInvestors.md)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-

data/docs/DealSetupApi.md

@@ -0,0 +1,74 @@
+# DealMakerAPI::DealSetupApi
+
+All URIs are relative to *http://api.dealmaker.tech*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_deal_setup**](DealSetupApi.md#create_deal_setup) | **POST** /deal_setups | Create deal setup |
+
+
+## create_deal_setup
+
+> <V1EntitiesDealSetup> create_deal_setup(create_deal_setup_request)
+
+Create deal setup
+
+Create deal setup
+
+### Examples
+
+```ruby
+require 'time'
+require 'DealMakerAPI'
+# setup authorization
+DealMakerAPI.configure do |config|end
+
+api_instance = DealMakerAPI::DealSetupApi.new
+create_deal_setup_request = DealMakerAPI::CreateDealSetupRequest.new({invoicing_email: 'invoicing_email_example', offering_type: 'other', title: 'title_example', company_id: 37}) # CreateDealSetupRequest | 
+
+begin
+  # Create deal setup
+  result = api_instance.create_deal_setup(create_deal_setup_request)
+  p result
+rescue DealMakerAPI::ApiError => e
+  puts "Error when calling DealSetupApi->create_deal_setup: #{e}"
+end
+```
+
+#### Using the create_deal_setup_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<V1EntitiesDealSetup>, Integer, Hash)> create_deal_setup_with_http_info(create_deal_setup_request)
+
+```ruby
+begin
+  # Create deal setup
+  data, status_code, headers = api_instance.create_deal_setup_with_http_info(create_deal_setup_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <V1EntitiesDealSetup>
+rescue DealMakerAPI::ApiError => e
+  puts "Error when calling DealSetupApi->create_deal_setup_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_deal_setup_request** | [**CreateDealSetupRequest**](CreateDealSetupRequest.md) |  |  |
+
+### Return type
+
+[**V1EntitiesDealSetup**](V1EntitiesDealSetup.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+