DealMakerAPI 0.93.2 → 0.93.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 58ca0eb5a0221dd6e48db1c291d1ac26772a344e3df62cfd7a2465d3b325ba61
-  data.tar.gz: a30d6e02ae0a6d30942260219f08ab3a52abbc07aa8eff218e2306e48ab3acce
+  metadata.gz: 3102bc8d161a1ffd6af4e4306711cdb3139a25edef2059e6a2ca736ce57ddcc3
+  data.tar.gz: c7df9d8579434c004ca34b791b49b3d2730554544ba093a148f1fb495f3767b6
 SHA512:
-  metadata.gz: 4f533e894db385f43ba222ff9560798b4d6dd15c0fe3545ab6dfdc48a1d22d354fb35451a556b1ba1210caec219ced271de5161609293496dfe5c8634ccb3051
-  data.tar.gz: 8a9b8d298f7f501f10d0242f6d2bec43e98022abcff22f7ae03ebb4bd181fd1908031a5de47ccf6917ee4c83a451babd9f24e4ddf570090b211b59f350507259
+  metadata.gz: bfb66cccd3b99792b1a0120977fd78158623208b532c23ab7ea890d4720c62adb20af7fb07c548b66d6121fe3eb9661682fe5b1984f8766cf8eae3693d79772f
+  data.tar.gz: 2708eecb6c2bd0cc59e794d8903969de7af77b827a08ae2d5df46256437cbdba5dc0faca0ba242f68ac7134a05f832e5de8e7e461fef4c677e300460bd689a85

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.93.2
+- Package version: 0.93.3
 - 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.93.2.gem
+gem install ./DealMakerAPI-0.93.3.gem
 ```
 
-(for development, run `gem install --dev ./DealMakerAPI-0.93.2.gem` to install the development dependencies)
+(for development, run `gem install --dev ./DealMakerAPI-0.93.3.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.93.2'
+    gem 'DealMakerAPI', '~> 0.93.3'
 
 ### Install from Git
 
@@ -443,6 +443,8 @@ Class | Method | HTTP request | Description
 *DealMakerAPI::DefaultApi* | [**post_webhooks**](docs/DefaultApi.md#post_webhooks) | **POST** /webhooks | Creates a webhook subscription which is associated to the user
 *DealMakerAPI::DefaultApi* | [**put_webhooks_id**](docs/DefaultApi.md#put_webhooks_id) | **PUT** /webhooks/{id} | Updates webhook subscription and webhooks subcription deals
 *DealMakerAPI::IncentivePlanApi* | [**get_deal_incentive_plans_time**](docs/IncentivePlanApi.md#get_deal_incentive_plans_time) | **GET** /deals/{id}/incentive_plans/time | Get incentive plans by deal id
+*DealMakerAPI::IncentivePlanApi* | [**patch_deal_incentive_plan**](docs/IncentivePlanApi.md#patch_deal_incentive_plan) | **PATCH** /deals/{id}/incentive_plans/{incentive_plan_id} | Updates incentive plan by deal id
+*DealMakerAPI::IncentivePlanApi* | [**post_deal_incentive_plan**](docs/IncentivePlanApi.md#post_deal_incentive_plan) | **POST** /deals/{id}/incentive_plans | Creates incentive plan by deal id
 *DealMakerAPI::InvestorApi* | [**add506c_document**](docs/InvestorApi.md#add506c_document) | **POST** /deals/{id}/investors/{investor_id}/add_506c_document | Add 506c document for deal investor
 *DealMakerAPI::InvestorApi* | [**add_document**](docs/InvestorApi.md#add_document) | **POST** /deals/{id}/investors/{investor_id}/add_document | Add document for deal investor
 *DealMakerAPI::InvestorApi* | [**bulk_upload_investors**](docs/InvestorApi.md#bulk_upload_investors) | **POST** /deals/{id}/investors/bulk_upload | Bulk upload investors for deal investor
@@ -490,6 +492,7 @@ Class | Method | HTTP request | Description
  - [DealMakerAPI::CreateShareholderActionRequest](docs/CreateShareholderActionRequest.md)
  - [DealMakerAPI::EditInvestorTagsRequest](docs/EditInvestorTagsRequest.md)
  - [DealMakerAPI::GenerateUrlRequest](docs/GenerateUrlRequest.md)
+ - [DealMakerAPI::PatchDealIncentivePlanRequest](docs/PatchDealIncentivePlanRequest.md)
  - [DealMakerAPI::PatchInvestorProfilesCorporations](docs/PatchInvestorProfilesCorporations.md)
  - [DealMakerAPI::PatchInvestorProfilesCorporationsBeneficialOwnersInner](docs/PatchInvestorProfilesCorporationsBeneficialOwnersInner.md)
  - [DealMakerAPI::PatchInvestorProfilesIndividuals](docs/PatchInvestorProfilesIndividuals.md)
@@ -497,6 +500,7 @@ Class | Method | HTTP request | Description
  - [DealMakerAPI::PatchInvestorProfilesTrusts](docs/PatchInvestorProfilesTrusts.md)
  - [DealMakerAPI::PatchInvestorProfilesTrustsTrusteesInner](docs/PatchInvestorProfilesTrustsTrusteesInner.md)
  - [DealMakerAPI::PatchInvestorRequest](docs/PatchInvestorRequest.md)
+ - [DealMakerAPI::PostDealIncentivePlanRequest](docs/PostDealIncentivePlanRequest.md)
  - [DealMakerAPI::PostDealsIdInvestors](docs/PostDealsIdInvestors.md)
  - [DealMakerAPI::PostInvestorProfilesCorporations](docs/PostInvestorProfilesCorporations.md)
  - [DealMakerAPI::PostInvestorProfilesCorporationsBeneficialOwnersInner](docs/PostInvestorProfilesCorporationsBeneficialOwnersInner.md)

data/docs/IncentivePlanApi.md

@@ -5,6 +5,8 @@ All URIs are relative to *http://api.dealmaker.tech*
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
 | [**get_deal_incentive_plans_time**](IncentivePlanApi.md#get_deal_incentive_plans_time) | **GET** /deals/{id}/incentive_plans/time | Get incentive plans by deal id |
+| [**patch_deal_incentive_plan**](IncentivePlanApi.md#patch_deal_incentive_plan) | **PATCH** /deals/{id}/incentive_plans/{incentive_plan_id} | Updates incentive plan by deal id |
+| [**post_deal_incentive_plan**](IncentivePlanApi.md#post_deal_incentive_plan) | **POST** /deals/{id}/incentive_plans | Creates incentive plan by deal id |
 
 
 ## get_deal_incentive_plans_time
@@ -80,3 +82,143 @@ No authorization required
 - **Content-Type**: Not defined
 - **Accept**: application/json
 
+
+## patch_deal_incentive_plan
+
+> <V1EntitiesDealsPriceDetails> patch_deal_incentive_plan(id, incentive_plan_id, opts)
+
+Updates incentive plan by deal id
+
+Updates an incentive plan for the given deal id with respectve tiers.
+
+### Examples
+
+```ruby
+require 'time'
+require 'DealMakerAPI'
+# setup authorization
+DealMakerAPI.configure do |config|end
+
+api_instance = DealMakerAPI::IncentivePlanApi.new
+id = 56 # Integer | The deal id.
+incentive_plan_id = 56 # Integer | The deal id.
+opts = {
+  patch_deal_incentive_plan_request: DealMakerAPI::PatchDealIncentivePlanRequest.new # PatchDealIncentivePlanRequest | 
+}
+
+begin
+  # Updates incentive plan by deal id
+  result = api_instance.patch_deal_incentive_plan(id, incentive_plan_id, opts)
+  p result
+rescue DealMakerAPI::ApiError => e
+  puts "Error when calling IncentivePlanApi->patch_deal_incentive_plan: #{e}"
+end
+```
+
+#### Using the patch_deal_incentive_plan_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<V1EntitiesDealsPriceDetails>, Integer, Hash)> patch_deal_incentive_plan_with_http_info(id, incentive_plan_id, opts)
+
+```ruby
+begin
+  # Updates incentive plan by deal id
+  data, status_code, headers = api_instance.patch_deal_incentive_plan_with_http_info(id, incentive_plan_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <V1EntitiesDealsPriceDetails>
+rescue DealMakerAPI::ApiError => e
+  puts "Error when calling IncentivePlanApi->patch_deal_incentive_plan_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | The deal id. |  |
+| **incentive_plan_id** | **Integer** | The deal id. |  |
+| **patch_deal_incentive_plan_request** | [**PatchDealIncentivePlanRequest**](PatchDealIncentivePlanRequest.md) |  | [optional] |
+
+### Return type
+
+[**V1EntitiesDealsPriceDetails**](V1EntitiesDealsPriceDetails.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## post_deal_incentive_plan
+
+> <V1EntitiesDealsPriceDetails> post_deal_incentive_plan(id, post_deal_incentive_plan_request)
+
+Creates incentive plan by deal id
+
+Creates an incentive plan for the given deal id with respectve tiers.
+
+### Examples
+
+```ruby
+require 'time'
+require 'DealMakerAPI'
+# setup authorization
+DealMakerAPI.configure do |config|end
+
+api_instance = DealMakerAPI::IncentivePlanApi.new
+id = 56 # Integer | The deal id.
+post_deal_incentive_plan_request = DealMakerAPI::PostDealIncentivePlanRequest.new({active_at: Time.now, tiers_incentive_percentage: [3.56], tiers_end_at: [Time.now]}) # PostDealIncentivePlanRequest | 
+
+begin
+  # Creates incentive plan by deal id
+  result = api_instance.post_deal_incentive_plan(id, post_deal_incentive_plan_request)
+  p result
+rescue DealMakerAPI::ApiError => e
+  puts "Error when calling IncentivePlanApi->post_deal_incentive_plan: #{e}"
+end
+```
+
+#### Using the post_deal_incentive_plan_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<V1EntitiesDealsPriceDetails>, Integer, Hash)> post_deal_incentive_plan_with_http_info(id, post_deal_incentive_plan_request)
+
+```ruby
+begin
+  # Creates incentive plan by deal id
+  data, status_code, headers = api_instance.post_deal_incentive_plan_with_http_info(id, post_deal_incentive_plan_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <V1EntitiesDealsPriceDetails>
+rescue DealMakerAPI::ApiError => e
+  puts "Error when calling IncentivePlanApi->post_deal_incentive_plan_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | The deal id. |  |
+| **post_deal_incentive_plan_request** | [**PostDealIncentivePlanRequest**](PostDealIncentivePlanRequest.md) |  |  |
+
+### Return type
+
+[**V1EntitiesDealsPriceDetails**](V1EntitiesDealsPriceDetails.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/PatchDealIncentivePlanRequest.md

@@ -0,0 +1,28 @@
+# DealMakerAPI::PatchDealIncentivePlanRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **active_at** | **Time** | The incentive plan active date. | [optional] |
+| **funded_by_offset** | **Integer** | The incentive plan funded by offset in days. | [optional] |
+| **tiers_id** | **Array<Integer>** | The incentive plan tier id. If none it will be created | [optional] |
+| **tiers__delete** | **Array<Boolean>** | If true, this entry will be cleared. | [optional] |
+| **tiers_incentive_percentage** | **Array<Float>** | The incentive plan tier percentage. | [optional] |
+| **tiers_end_at** | **Array<Time>** | The incentive plan tier end date. | [optional] |
+
+## Example
+
+```ruby
+require 'DealMakerAPI'
+
+instance = DealMakerAPI::PatchDealIncentivePlanRequest.new(
+  active_at: null,
+  funded_by_offset: null,
+  tiers_id: null,
+  tiers__delete: null,
+  tiers_incentive_percentage: null,
+  tiers_end_at: null
+)
+```
+

data/docs/PostDealIncentivePlanRequest.md

@@ -0,0 +1,24 @@
+# DealMakerAPI::PostDealIncentivePlanRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **active_at** | **Time** | The incentive plan active date. |  |
+| **funded_by_offset** | **Integer** | The incentive plan funded by offset in days. | [optional][default to 0] |
+| **tiers_incentive_percentage** | **Array<Float>** | The incentive plan tier percentage. |  |
+| **tiers_end_at** | **Array<Time>** | The incentive plan tier end date. |  |
+
+## Example
+
+```ruby
+require 'DealMakerAPI'
+
+instance = DealMakerAPI::PostDealIncentivePlanRequest.new(
+  active_at: null,
+  funded_by_offset: null,
+  tiers_incentive_percentage: null,
+  tiers_end_at: null
+)
+```
+

data/lib/DealMakerAPI/api/incentive_plan_api.rb

@@ -90,5 +90,155 @@ module DealMakerAPI
       end
       return data, status_code, headers
     end
+
+    # Updates incentive plan by deal id
+    # Updates an incentive plan for the given deal id with respectve tiers.
+    # @param id [Integer] The deal id.
+    # @param incentive_plan_id [Integer] The deal id.
+    # @param [Hash] opts the optional parameters
+    # @option opts [PatchDealIncentivePlanRequest] :patch_deal_incentive_plan_request 
+    # @return [V1EntitiesDealsPriceDetails]
+    def patch_deal_incentive_plan(id, incentive_plan_id, opts = {})
+      data, _status_code, _headers = patch_deal_incentive_plan_with_http_info(id, incentive_plan_id, opts)
+      data
+    end
+
+    # Updates incentive plan by deal id
+    # Updates an incentive plan for the given deal id with respectve tiers.
+    # @param id [Integer] The deal id.
+    # @param incentive_plan_id [Integer] The deal id.
+    # @param [Hash] opts the optional parameters
+    # @option opts [PatchDealIncentivePlanRequest] :patch_deal_incentive_plan_request 
+    # @return [Array<(V1EntitiesDealsPriceDetails, Integer, Hash)>] V1EntitiesDealsPriceDetails data, response status code and response headers
+    def patch_deal_incentive_plan_with_http_info(id, incentive_plan_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: IncentivePlanApi.patch_deal_incentive_plan ...'
+      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 IncentivePlanApi.patch_deal_incentive_plan"
+      end
+      # verify the required parameter 'incentive_plan_id' is set
+      if @api_client.config.client_side_validation && incentive_plan_id.nil?
+        fail ArgumentError, "Missing the required parameter 'incentive_plan_id' when calling IncentivePlanApi.patch_deal_incentive_plan"
+      end
+      # resource path
+      local_var_path = '/deals/{id}/incentive_plans/{incentive_plan_id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'incentive_plan_id' + '}', CGI.escape(incentive_plan_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'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'patch_deal_incentive_plan_request'])
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'V1EntitiesDealsPriceDetails'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"IncentivePlanApi.patch_deal_incentive_plan",
+        :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(:PATCH, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: IncentivePlanApi#patch_deal_incentive_plan\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Creates incentive plan by deal id
+    # Creates an incentive plan for the given deal id with respectve tiers.
+    # @param id [Integer] The deal id.
+    # @param post_deal_incentive_plan_request [PostDealIncentivePlanRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [V1EntitiesDealsPriceDetails]
+    def post_deal_incentive_plan(id, post_deal_incentive_plan_request, opts = {})
+      data, _status_code, _headers = post_deal_incentive_plan_with_http_info(id, post_deal_incentive_plan_request, opts)
+      data
+    end
+
+    # Creates incentive plan by deal id
+    # Creates an incentive plan for the given deal id with respectve tiers.
+    # @param id [Integer] The deal id.
+    # @param post_deal_incentive_plan_request [PostDealIncentivePlanRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(V1EntitiesDealsPriceDetails, Integer, Hash)>] V1EntitiesDealsPriceDetails data, response status code and response headers
+    def post_deal_incentive_plan_with_http_info(id, post_deal_incentive_plan_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: IncentivePlanApi.post_deal_incentive_plan ...'
+      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 IncentivePlanApi.post_deal_incentive_plan"
+      end
+      # verify the required parameter 'post_deal_incentive_plan_request' is set
+      if @api_client.config.client_side_validation && post_deal_incentive_plan_request.nil?
+        fail ArgumentError, "Missing the required parameter 'post_deal_incentive_plan_request' when calling IncentivePlanApi.post_deal_incentive_plan"
+      end
+      # resource path
+      local_var_path = '/deals/{id}/incentive_plans'.sub('{' + 'id' + '}', CGI.escape(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'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(post_deal_incentive_plan_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'V1EntitiesDealsPriceDetails'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"IncentivePlanApi.post_deal_incentive_plan",
+        :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: IncentivePlanApi#post_deal_incentive_plan\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
   end
 end