DealMakerAPI 0.99.3 → 0.99.4
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +5 -4
- data/docs/DealsApi.md +68 -0
- data/lib/DealMakerAPI/api/deals_api.rb +67 -0
- data/lib/DealMakerAPI/models/v1_entities_investor.rb +2 -2
- data/lib/DealMakerAPI/version.rb +1 -1
- data/spec/api/deals_api_spec.rb +13 -0
- data/spec/models/v1_entities_investor_spec.rb +1 -1
- metadata +1 -1
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: a4b448caa776f032a1fc1d5787af603d59dc13199d81d67d772c9b1a08b8ba61
|
4
|
+
data.tar.gz: 0d435bcfd2f82f3f2c0c709d5fc6dbef222d01c4c5970714e848ebbb49ecc1e8
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: '09f5ccf05b370e44caba35fe191684672275902e2470e5b1a33eacfcd332bcb7aeb5804974cd1ed0f9726c793cd451577ceda2bfd8d30f1cba4e7df2b90bdc70'
|
7
|
+
data.tar.gz: daa6ff4a42d4d036d81773d9f2ec10b3ebc2b573f71630a3a5d4bae7821cb6b83d31851102be4269aa6da4b2bed8deec0dfa37a096831b9b4a45caed6783aca5
|
data/README.md
CHANGED
@@ -338,7 +338,7 @@ Given the high number of updates our platform performs on any investor, we’ve
|
|
338
338
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
339
339
|
|
340
340
|
- API version: 1.75.0
|
341
|
-
- Package version: 0.99.
|
341
|
+
- Package version: 0.99.4
|
342
342
|
- Generator version: 7.5.0-SNAPSHOT
|
343
343
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
344
344
|
|
@@ -355,16 +355,16 @@ gem build DealMakerAPI.gemspec
|
|
355
355
|
Then either install the gem locally:
|
356
356
|
|
357
357
|
```shell
|
358
|
-
gem install ./DealMakerAPI-0.99.
|
358
|
+
gem install ./DealMakerAPI-0.99.4.gem
|
359
359
|
```
|
360
360
|
|
361
|
-
(for development, run `gem install --dev ./DealMakerAPI-0.99.
|
361
|
+
(for development, run `gem install --dev ./DealMakerAPI-0.99.4.gem` to install the development dependencies)
|
362
362
|
|
363
363
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
364
364
|
|
365
365
|
Finally add this to the Gemfile:
|
366
366
|
|
367
|
-
gem 'DealMakerAPI', '~> 0.99.
|
367
|
+
gem 'DealMakerAPI', '~> 0.99.4'
|
368
368
|
|
369
369
|
### Install from Git
|
370
370
|
|
@@ -438,6 +438,7 @@ Class | Method | HTTP request | Description
|
|
438
438
|
*DealMakerAPI::DealApi* | [**get_deal**](docs/DealApi.md#get_deal) | **GET** /deals/{id} | Get deal by Deal ID
|
439
439
|
*DealMakerAPI::DealApi* | [**get_deal_incentive_plan**](docs/DealApi.md#get_deal_incentive_plan) | **GET** /deals/{id}/incentive_plan | Get incentive plan by deal id
|
440
440
|
*DealMakerAPI::DealApi* | [**list_deals**](docs/DealApi.md#list_deals) | **GET** /deals | List available deals
|
441
|
+
*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
|
441
442
|
*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.
|
442
443
|
*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
|
443
444
|
*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
CHANGED
@@ -4,9 +4,77 @@ All URIs are relative to *http://api.dealmaker.tech*
|
|
4
4
|
|
5
5
|
| Method | HTTP request | Description |
|
6
6
|
| ------ | ------------ | ----------- |
|
7
|
+
| [**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 |
|
7
8
|
| [**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. |
|
8
9
|
|
9
10
|
|
11
|
+
## post_deals_id_email_campaign_email_campaign_id_send_email
|
12
|
+
|
13
|
+
> post_deals_id_email_campaign_email_campaign_id_send_email(id, email_campaign_id)
|
14
|
+
|
15
|
+
Send emails to all the investors invited to the material change campaign
|
16
|
+
|
17
|
+
Send material campaign emails
|
18
|
+
|
19
|
+
### Examples
|
20
|
+
|
21
|
+
```ruby
|
22
|
+
require 'time'
|
23
|
+
require 'DealMakerAPI'
|
24
|
+
# setup authorization
|
25
|
+
DealMakerAPI.configure do |config|end
|
26
|
+
|
27
|
+
api_instance = DealMakerAPI::DealsApi.new
|
28
|
+
id = 56 # Integer | The deal id.
|
29
|
+
email_campaign_id = 56 # Integer | The email campaign id.
|
30
|
+
|
31
|
+
begin
|
32
|
+
# Send emails to all the investors invited to the material change campaign
|
33
|
+
api_instance.post_deals_id_email_campaign_email_campaign_id_send_email(id, email_campaign_id)
|
34
|
+
rescue DealMakerAPI::ApiError => e
|
35
|
+
puts "Error when calling DealsApi->post_deals_id_email_campaign_email_campaign_id_send_email: #{e}"
|
36
|
+
end
|
37
|
+
```
|
38
|
+
|
39
|
+
#### Using the post_deals_id_email_campaign_email_campaign_id_send_email_with_http_info variant
|
40
|
+
|
41
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
42
|
+
|
43
|
+
> <Array(nil, Integer, Hash)> post_deals_id_email_campaign_email_campaign_id_send_email_with_http_info(id, email_campaign_id)
|
44
|
+
|
45
|
+
```ruby
|
46
|
+
begin
|
47
|
+
# Send emails to all the investors invited to the material change campaign
|
48
|
+
data, status_code, headers = api_instance.post_deals_id_email_campaign_email_campaign_id_send_email_with_http_info(id, email_campaign_id)
|
49
|
+
p status_code # => 2xx
|
50
|
+
p headers # => { ... }
|
51
|
+
p data # => nil
|
52
|
+
rescue DealMakerAPI::ApiError => e
|
53
|
+
puts "Error when calling DealsApi->post_deals_id_email_campaign_email_campaign_id_send_email_with_http_info: #{e}"
|
54
|
+
end
|
55
|
+
```
|
56
|
+
|
57
|
+
### Parameters
|
58
|
+
|
59
|
+
| Name | Type | Description | Notes |
|
60
|
+
| ---- | ---- | ----------- | ----- |
|
61
|
+
| **id** | **Integer** | The deal id. | |
|
62
|
+
| **email_campaign_id** | **Integer** | The email campaign id. | |
|
63
|
+
|
64
|
+
### Return type
|
65
|
+
|
66
|
+
nil (empty response body)
|
67
|
+
|
68
|
+
### Authorization
|
69
|
+
|
70
|
+
No authorization required
|
71
|
+
|
72
|
+
### HTTP request headers
|
73
|
+
|
74
|
+
- **Content-Type**: Not defined
|
75
|
+
- **Accept**: Not defined
|
76
|
+
|
77
|
+
|
10
78
|
## put_deals_id_script_tag_environment
|
11
79
|
|
12
80
|
> put_deals_id_script_tag_environment(id, put_deals_id_script_tag_environment_request)
|
@@ -19,6 +19,73 @@ module DealMakerAPI
|
|
19
19
|
def initialize(api_client = ApiClient.default)
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
|
+
# Send emails to all the investors invited to the material change campaign
|
23
|
+
# Send material campaign emails
|
24
|
+
# @param id [Integer] The deal id.
|
25
|
+
# @param email_campaign_id [Integer] The email campaign id.
|
26
|
+
# @param [Hash] opts the optional parameters
|
27
|
+
# @return [nil]
|
28
|
+
def post_deals_id_email_campaign_email_campaign_id_send_email(id, email_campaign_id, opts = {})
|
29
|
+
post_deals_id_email_campaign_email_campaign_id_send_email_with_http_info(id, email_campaign_id, opts)
|
30
|
+
nil
|
31
|
+
end
|
32
|
+
|
33
|
+
# Send emails to all the investors invited to the material change campaign
|
34
|
+
# Send material campaign emails
|
35
|
+
# @param id [Integer] The deal id.
|
36
|
+
# @param email_campaign_id [Integer] The email campaign id.
|
37
|
+
# @param [Hash] opts the optional parameters
|
38
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
39
|
+
def post_deals_id_email_campaign_email_campaign_id_send_email_with_http_info(id, email_campaign_id, opts = {})
|
40
|
+
if @api_client.config.debugging
|
41
|
+
@api_client.config.logger.debug 'Calling API: DealsApi.post_deals_id_email_campaign_email_campaign_id_send_email ...'
|
42
|
+
end
|
43
|
+
# verify the required parameter 'id' is set
|
44
|
+
if @api_client.config.client_side_validation && id.nil?
|
45
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling DealsApi.post_deals_id_email_campaign_email_campaign_id_send_email"
|
46
|
+
end
|
47
|
+
# verify the required parameter 'email_campaign_id' is set
|
48
|
+
if @api_client.config.client_side_validation && email_campaign_id.nil?
|
49
|
+
fail ArgumentError, "Missing the required parameter 'email_campaign_id' when calling DealsApi.post_deals_id_email_campaign_email_campaign_id_send_email"
|
50
|
+
end
|
51
|
+
# resource path
|
52
|
+
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))
|
53
|
+
|
54
|
+
# query parameters
|
55
|
+
query_params = opts[:query_params] || {}
|
56
|
+
|
57
|
+
# header parameters
|
58
|
+
header_params = opts[:header_params] || {}
|
59
|
+
|
60
|
+
# form parameters
|
61
|
+
form_params = opts[:form_params] || {}
|
62
|
+
|
63
|
+
# http body (model)
|
64
|
+
post_body = opts[:debug_body]
|
65
|
+
|
66
|
+
# return_type
|
67
|
+
return_type = opts[:debug_return_type]
|
68
|
+
|
69
|
+
# auth_names
|
70
|
+
auth_names = opts[:debug_auth_names] || []
|
71
|
+
|
72
|
+
new_options = opts.merge(
|
73
|
+
:operation => :"DealsApi.post_deals_id_email_campaign_email_campaign_id_send_email",
|
74
|
+
:header_params => header_params,
|
75
|
+
:query_params => query_params,
|
76
|
+
:form_params => form_params,
|
77
|
+
:body => post_body,
|
78
|
+
:auth_names => auth_names,
|
79
|
+
:return_type => return_type
|
80
|
+
)
|
81
|
+
|
82
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
83
|
+
if @api_client.config.debugging
|
84
|
+
@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}"
|
85
|
+
end
|
86
|
+
return data, status_code, headers
|
87
|
+
end
|
88
|
+
|
22
89
|
# Update script tag environment for the deal.
|
23
90
|
# Update script tag environment for the deal.
|
24
91
|
# @param id [Integer] The deal id.
|
@@ -353,7 +353,7 @@ module DealMakerAPI
|
|
353
353
|
return false unless funding_state_validator.valid?(@funding_state)
|
354
354
|
verification_status_validator = EnumAttributeValidator.new('String', ["pending", "approved", "rejected", "new_documents_requested"])
|
355
355
|
return false unless verification_status_validator.valid?(@verification_status)
|
356
|
-
checkout_state_validator = EnumAttributeValidator.new('String', ["pre_checkout", "investment_amount", "contact_information", "investor_confirmation", "terms_conditions", "payment", "checkout_complete", "resubmit_agreement", "legacy_checkout"])
|
356
|
+
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"])
|
357
357
|
return false unless checkout_state_validator.valid?(@checkout_state)
|
358
358
|
true
|
359
359
|
end
|
@@ -401,7 +401,7 @@ module DealMakerAPI
|
|
401
401
|
# Custom attribute writer method checking allowed values (enum).
|
402
402
|
# @param [Object] checkout_state Object to be assigned
|
403
403
|
def checkout_state=(checkout_state)
|
404
|
-
validator = EnumAttributeValidator.new('String', ["pre_checkout", "investment_amount", "contact_information", "investor_confirmation", "terms_conditions", "payment", "checkout_complete", "resubmit_agreement", "legacy_checkout"])
|
404
|
+
validator = EnumAttributeValidator.new('String', ["pre_checkout", "investment_amount", "contact_information", "investor_confirmation", "terms_conditions", "payment", "checkout_complete", "resubmit_agreement", "legacy_checkout", "document_upload"])
|
405
405
|
unless validator.valid?(checkout_state)
|
406
406
|
fail ArgumentError, "invalid value for \"checkout_state\", must be one of #{validator.allowable_values}."
|
407
407
|
end
|
data/lib/DealMakerAPI/version.rb
CHANGED
data/spec/api/deals_api_spec.rb
CHANGED
@@ -32,6 +32,19 @@ describe 'DealsApi' do
|
|
32
32
|
end
|
33
33
|
end
|
34
34
|
|
35
|
+
# unit tests for post_deals_id_email_campaign_email_campaign_id_send_email
|
36
|
+
# Send emails to all the investors invited to the material change campaign
|
37
|
+
# Send material campaign emails
|
38
|
+
# @param id The deal id.
|
39
|
+
# @param email_campaign_id The email campaign id.
|
40
|
+
# @param [Hash] opts the optional parameters
|
41
|
+
# @return [nil]
|
42
|
+
describe 'post_deals_id_email_campaign_email_campaign_id_send_email test' do
|
43
|
+
it 'should work' do
|
44
|
+
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
45
|
+
end
|
46
|
+
end
|
47
|
+
|
35
48
|
# unit tests for put_deals_id_script_tag_environment
|
36
49
|
# Update script tag environment for the deal.
|
37
50
|
# Update script tag environment for the deal.
|
@@ -208,7 +208,7 @@ describe DealMakerAPI::V1EntitiesInvestor do
|
|
208
208
|
describe 'test attribute "checkout_state"' do
|
209
209
|
it 'should work' do
|
210
210
|
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
|
211
|
-
# validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["pre_checkout", "investment_amount", "contact_information", "investor_confirmation", "terms_conditions", "payment", "checkout_complete", "resubmit_agreement", "legacy_checkout"])
|
211
|
+
# 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"])
|
212
212
|
# validator.allowable_values.each do |value|
|
213
213
|
# expect { instance.checkout_state = value }.not_to raise_error
|
214
214
|
# end
|