DealMakerAPI 0.0.2 → 0.68.6

data/docs/DealApi.md

@@ -4,87 +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 |
-| [**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**](DealApi.md#get_deal) | **GET** /deals/{id} | Get deal by Deal ID |
+| [**list_deals**](DealApi.md#list_deals) | **GET** /deals | List available deals |
 
 
 ## 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
 
@@ -98,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
@@ -114,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 # => { ... }
@@ -144,13 +74,13 @@ No authorization required
 - **Accept**: application/json
 
 
-## get_investor
+## list_deals
 
-> <V1EntitiesInvestor> get_investor(id, investor_id)
+> <V1EntitiesDeals> list_deals(opts)
 
-Get a deal investor by id
+List available deals
 
-Gets a single investor by the id.
+List available deals
 
 ### Examples
 
@@ -161,107 +91,36 @@ require 'DealMakerAPI'
 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_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.
+  offset: 56 # Integer | Pad a number of results.
 }
 
 begin
-  # List deal investors
-  result = api_instance.list_investors(id, opts)
+  # List available deals
+  result = api_instance.list_deals(opts)
   p result
 rescue DealMakerAPI::ApiError => e
-  puts "Error when calling DealApi->list_investors: #{e}"
+  puts "Error when calling DealApi->list_deals: #{e}"
 end
 ```
 
-#### Using the list_investors_with_http_info variant
+#### Using the list_deals_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)
+> <Array(<V1EntitiesDeals>, Integer, Hash)> list_deals_with_http_info(opts)
 
 ```ruby
 begin
-  # List deal investors
-  data, status_code, headers = api_instance.list_investors_with_http_info(id, opts)
+  # List available deals
+  data, status_code, headers = api_instance.list_deals_with_http_info(opts)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <V1EntitiesInvestors>
+  p data # => <V1EntitiesDeals>
 rescue DealMakerAPI::ApiError => e
-  puts "Error when calling DealApi->list_investors_with_http_info: #{e}"
+  puts "Error when calling DealApi->list_deals_with_http_info: #{e}"
 end
 ```
 
@@ -269,16 +128,13 @@ end
 
 | 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. | [optional] |
 
 ### Return type
 
-[**V1EntitiesInvestors**](V1EntitiesInvestors.md)
+[**V1EntitiesDeals**](V1EntitiesDeals.md)
 
 ### Authorization
 

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
+