DealMakerAPI 0.99.2 → 0.99.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 47aa37c17ad29161a49d3ce3662065a4b5d264c45677162f0141989074091f8b
-  data.tar.gz: 81b0869578558f7546abf41fe8050342229138ac31276ffa8f760b1daa460576
+  metadata.gz: a4b448caa776f032a1fc1d5787af603d59dc13199d81d67d772c9b1a08b8ba61
+  data.tar.gz: 0d435bcfd2f82f3f2c0c709d5fc6dbef222d01c4c5970714e848ebbb49ecc1e8
 SHA512:
-  metadata.gz: f864a056ec993286553a22a6db0eba618ebc080c69e5672507e2337dae6617fa150b874644cde3d05640144f81edf567c1b0d3102c9aa16df92600e57028f922
-  data.tar.gz: 1fe543fbe4bafcfbf4d0cf8dfdf68458533817f3bfc74786fcbc18e0a3323148a648bb800220c520f97363fffbf2096de71db3dea9d7e4b5c95200e1ec5c5f60
+  metadata.gz: '09f5ccf05b370e44caba35fe191684672275902e2470e5b1a33eacfcd332bcb7aeb5804974cd1ed0f9726c793cd451577ceda2bfd8d30f1cba4e7df2b90bdc70'
+  data.tar.gz: daa6ff4a42d4d036d81773d9f2ec10b3ebc2b573f71630a3a5d4bae7821cb6b83d31851102be4269aa6da4b2bed8deec0dfa37a096831b9b4a45caed6783aca5

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.99.2
+- Package version: 0.99.4
 - Generator version: 7.5.0-SNAPSHOT
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 
@@ -355,16 +355,16 @@ gem build DealMakerAPI.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./DealMakerAPI-0.99.2.gem
+gem install ./DealMakerAPI-0.99.4.gem
 ```
 
-(for development, run `gem install --dev ./DealMakerAPI-0.99.2.gem` to install the development dependencies)
+(for development, run `gem install --dev ./DealMakerAPI-0.99.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.99.2'
+    gem 'DealMakerAPI', '~> 0.99.4'
 
 ### Install from Git
 
@@ -438,6 +438,7 @@ Class | Method | HTTP request | Description
 *DealMakerAPI::DealApi* | [**get_deal**](docs/DealApi.md#get_deal) | **GET** /deals/{id} | Get deal by Deal ID
 *DealMakerAPI::DealApi* | [**get_deal_incentive_plan**](docs/DealApi.md#get_deal_incentive_plan) | **GET** /deals/{id}/incentive_plan | Get incentive plan by deal id
 *DealMakerAPI::DealApi* | [**list_deals**](docs/DealApi.md#list_deals) | **GET** /deals | List available deals
+*DealMakerAPI::DealsApi* | [**post_deals_id_email_campaign_email_campaign_id_send_email**](docs/DealsApi.md#post_deals_id_email_campaign_email_campaign_id_send_email) | **POST** /deals/{id}/email_campaign/{email_campaign_id}/send_email | Send emails to all the investors invited to the material change campaign
 *DealMakerAPI::DealsApi* | [**put_deals_id_script_tag_environment**](docs/DealsApi.md#put_deals_id_script_tag_environment) | **PUT** /deals/{id}/script_tag_environment | Update script tag environment for the deal.
 *DealMakerAPI::DefaultApi* | [**get_deals_deal_id_payment_onboarding_questionnaire_digital_payments_connection_data**](docs/DefaultApi.md#get_deals_deal_id_payment_onboarding_questionnaire_digital_payments_connection_data) | **GET** /deals/{deal_id}/payment_onboarding/questionnaire/digital_payments_connection/data | Load data for the digital payments connection stage
 *DealMakerAPI::DefaultApi* | [**get_deals_deal_id_payment_onboarding_questionnaire_payout_account_details_data**](docs/DefaultApi.md#get_deals_deal_id_payment_onboarding_questionnaire_payout_account_details_data) | **GET** /deals/{deal_id}/payment_onboarding/questionnaire/payout_account_details/data | Get payout account data

data/docs/DealsApi.md

@@ -4,9 +4,77 @@ All URIs are relative to *http://api.dealmaker.tech*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
+| [**post_deals_id_email_campaign_email_campaign_id_send_email**](DealsApi.md#post_deals_id_email_campaign_email_campaign_id_send_email) | **POST** /deals/{id}/email_campaign/{email_campaign_id}/send_email | Send emails to all the investors invited to the material change campaign |
 | [**put_deals_id_script_tag_environment**](DealsApi.md#put_deals_id_script_tag_environment) | **PUT** /deals/{id}/script_tag_environment | Update script tag environment for the deal. |
 
 
+## post_deals_id_email_campaign_email_campaign_id_send_email
+
+> post_deals_id_email_campaign_email_campaign_id_send_email(id, email_campaign_id)
+
+Send emails to all the investors invited to the material change campaign
+
+Send material campaign emails
+
+### Examples
+
+```ruby
+require 'time'
+require 'DealMakerAPI'
+# setup authorization
+DealMakerAPI.configure do |config|end
+
+api_instance = DealMakerAPI::DealsApi.new
+id = 56 # Integer | The deal id.
+email_campaign_id = 56 # Integer | The email campaign id.
+
+begin
+  # Send emails to all the investors invited to the material change campaign
+  api_instance.post_deals_id_email_campaign_email_campaign_id_send_email(id, email_campaign_id)
+rescue DealMakerAPI::ApiError => e
+  puts "Error when calling DealsApi->post_deals_id_email_campaign_email_campaign_id_send_email: #{e}"
+end
+```
+
+#### Using the post_deals_id_email_campaign_email_campaign_id_send_email_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> post_deals_id_email_campaign_email_campaign_id_send_email_with_http_info(id, email_campaign_id)
+
+```ruby
+begin
+  # Send emails to all the investors invited to the material change campaign
+  data, status_code, headers = api_instance.post_deals_id_email_campaign_email_campaign_id_send_email_with_http_info(id, email_campaign_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue DealMakerAPI::ApiError => e
+  puts "Error when calling DealsApi->post_deals_id_email_campaign_email_campaign_id_send_email_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | The deal id. |  |
+| **email_campaign_id** | **Integer** | The email campaign id. |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
 ## put_deals_id_script_tag_environment
 
 > put_deals_id_script_tag_environment(id, put_deals_id_script_tag_environment_request)

data/lib/DealMakerAPI/api/deals_api.rb

@@ -19,6 +19,73 @@ module DealMakerAPI
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
+    # Send emails to all the investors invited to the material change campaign
+    # Send material campaign emails
+    # @param id [Integer] The deal id.
+    # @param email_campaign_id [Integer] The email campaign id.
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def post_deals_id_email_campaign_email_campaign_id_send_email(id, email_campaign_id, opts = {})
+      post_deals_id_email_campaign_email_campaign_id_send_email_with_http_info(id, email_campaign_id, opts)
+      nil
+    end
+
+    # Send emails to all the investors invited to the material change campaign
+    # Send material campaign emails
+    # @param id [Integer] The deal id.
+    # @param email_campaign_id [Integer] The email campaign id.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def post_deals_id_email_campaign_email_campaign_id_send_email_with_http_info(id, email_campaign_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DealsApi.post_deals_id_email_campaign_email_campaign_id_send_email ...'
+      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 DealsApi.post_deals_id_email_campaign_email_campaign_id_send_email"
+      end
+      # verify the required parameter 'email_campaign_id' is set
+      if @api_client.config.client_side_validation && email_campaign_id.nil?
+        fail ArgumentError, "Missing the required parameter 'email_campaign_id' when calling DealsApi.post_deals_id_email_campaign_email_campaign_id_send_email"
+      end
+      # resource path
+      local_var_path = '/deals/{id}/email_campaign/{email_campaign_id}/send_email'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'email_campaign_id' + '}', CGI.escape(email_campaign_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"DealsApi.post_deals_id_email_campaign_email_campaign_id_send_email",
+        :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: DealsApi#post_deals_id_email_campaign_email_campaign_id_send_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Update script tag environment for the deal.
     # Update script tag environment for the deal.
     # @param id [Integer] The deal id.

data/lib/DealMakerAPI/models/v1_entities_investor.rb

@@ -353,7 +353,7 @@ module DealMakerAPI
       return false unless funding_state_validator.valid?(@funding_state)
       verification_status_validator = EnumAttributeValidator.new('String', ["pending", "approved", "rejected", "new_documents_requested"])
       return false unless verification_status_validator.valid?(@verification_status)
-      checkout_state_validator = EnumAttributeValidator.new('String', ["pre_checkout", "investment_amount", "contact_information", "investor_confirmation", "terms_conditions", "payment", "checkout_complete", "resubmit_agreement", "legacy_checkout"])
+      checkout_state_validator = EnumAttributeValidator.new('String', ["pre_checkout", "investment_amount", "contact_information", "investor_confirmation", "terms_conditions", "payment", "checkout_complete", "resubmit_agreement", "legacy_checkout", "document_upload"])
       return false unless checkout_state_validator.valid?(@checkout_state)
       true
     end
@@ -401,7 +401,7 @@ module DealMakerAPI
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] checkout_state Object to be assigned
     def checkout_state=(checkout_state)
-      validator = EnumAttributeValidator.new('String', ["pre_checkout", "investment_amount", "contact_information", "investor_confirmation", "terms_conditions", "payment", "checkout_complete", "resubmit_agreement", "legacy_checkout"])
+      validator = EnumAttributeValidator.new('String', ["pre_checkout", "investment_amount", "contact_information", "investor_confirmation", "terms_conditions", "payment", "checkout_complete", "resubmit_agreement", "legacy_checkout", "document_upload"])
       unless validator.valid?(checkout_state)
         fail ArgumentError, "invalid value for \"checkout_state\", must be one of #{validator.allowable_values}."
       end

data/lib/DealMakerAPI/version.rb

@@ -11,5 +11,5 @@ Generator version: 7.5.0-SNAPSHOT
 =end
 
 module DealMakerAPI
-  VERSION = '0.99.2'
+  VERSION = '0.99.4'
 end

data/spec/api/deals_api_spec.rb

@@ -32,6 +32,19 @@ describe 'DealsApi' do
     end
   end
 
+  # unit tests for post_deals_id_email_campaign_email_campaign_id_send_email
+  # Send emails to all the investors invited to the material change campaign
+  # Send material campaign emails
+  # @param id The deal id.
+  # @param email_campaign_id The email campaign id.
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'post_deals_id_email_campaign_email_campaign_id_send_email 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 put_deals_id_script_tag_environment
   # Update script tag environment for the deal.
   # Update script tag environment for the deal.

data/spec/models/v1_entities_investor_spec.rb

@@ -208,7 +208,7 @@ describe DealMakerAPI::V1EntitiesInvestor do
   describe 'test attribute "checkout_state"' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
-      # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["pre_checkout", "investment_amount", "contact_information", "investor_confirmation", "terms_conditions", "payment", "checkout_complete", "resubmit_agreement", "legacy_checkout"])
+      # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["pre_checkout", "investment_amount", "contact_information", "investor_confirmation", "terms_conditions", "payment", "checkout_complete", "resubmit_agreement", "legacy_checkout", "document_upload"])
       # validator.allowable_values.each do |value|
       #   expect { instance.checkout_state = value }.not_to raise_error
       # end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: DealMakerAPI
 version: !ruby/object:Gem::Version
-  version: 0.99.2
+  version: 0.99.4
 platform: ruby
 authors:
 - DealMaker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-03-25 00:00:00.000000000 Z
+date: 2024-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus