DealMakerAPI 0.0.2 → 0.68.6
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/DealMakerAPI.gemspec +4 -4
- data/README.md +221 -127
- data/docs/CompanyApi.md +214 -0
- data/docs/CreateCompanyRequest.md +32 -0
- data/docs/CreateCorporationProfileRequest.md +82 -0
- data/docs/CreateDealSetupRequest.md +30 -0
- data/docs/CreateIndividualProfileRequest.md +44 -0
- data/docs/CreateInvestorRequest.md +40 -0
- data/docs/CreateJointProfileRequest.md +68 -0
- data/docs/CreateTrustProfileRequest.md +60 -0
- data/docs/DealApi.md +21 -165
- data/docs/DealSetupApi.md +74 -0
- data/docs/DefaultApi.md +413 -0
- data/docs/InvestorApi.md +368 -0
- data/docs/InvestorProfileApi.md +573 -15
- data/docs/PatchCorporationProfileRequest.md +58 -0
- data/docs/PatchIndividualProfileRequest.md +42 -0
- data/docs/PatchInvestorRequest.md +18 -0
- data/docs/PatchJointProfileRequest.md +66 -0
- data/docs/PatchTrustProfileRequest.md +58 -0
- data/docs/PostWebhooksRequest.md +26 -0
- data/docs/PutWebhooksIdRequest.md +30 -0
- data/docs/UpdateInvestorRequest.md +24 -0
- data/docs/V1EntitiesAddress.md +28 -0
- data/docs/V1EntitiesAddresses.md +18 -0
- data/docs/V1EntitiesCompany.md +34 -0
- data/docs/V1EntitiesCompanyDeal.md +20 -0
- data/docs/V1EntitiesCompanyDeals.md +18 -0
- data/docs/V1EntitiesDealSetup.md +34 -0
- data/docs/V1EntitiesDealSetupUser.md +20 -0
- data/docs/V1EntitiesDeals.md +18 -0
- data/docs/V1EntitiesInvestor.md +10 -4
- data/docs/V1EntitiesInvestorProfileAddress.md +28 -0
- data/docs/V1EntitiesInvestorProfileCorporation.md +34 -0
- data/docs/V1EntitiesInvestorProfileFieldsAccountHolder.md +28 -0
- data/docs/V1EntitiesInvestorProfileFieldsCorporation.md +24 -0
- data/docs/V1EntitiesInvestorProfileFieldsPrimaryHolder.md +30 -0
- data/docs/V1EntitiesInvestorProfileFieldsTrust.md +24 -0
- data/docs/V1EntitiesInvestorProfileIndividual.md +6 -16
- data/docs/V1EntitiesInvestorProfileItem.md +18 -0
- data/docs/V1EntitiesInvestorProfileJoint.md +34 -0
- data/docs/V1EntitiesInvestorProfileTrust.md +32 -0
- data/docs/V1EntitiesInvestorProfiles.md +18 -0
- data/docs/V1EntitiesWebhooksDeal.md +22 -0
- data/docs/V1EntitiesWebhooksSecurityToken.md +18 -0
- data/docs/V1EntitiesWebhooksSubscription.md +28 -0
- data/docs/V1EntitiesWebhooksSubscriptionDeal.md +24 -0
- data/docs/V1EntitiesWebhooksSubscriptionDeals.md +18 -0
- data/lib/DealMakerAPI/api/company_api.rb +219 -0
- data/lib/DealMakerAPI/api/deal_api.rb +23 -174
- data/lib/DealMakerAPI/api/deal_setup_api.rb +90 -0
- data/lib/DealMakerAPI/api/default_api.rb +403 -0
- data/lib/DealMakerAPI/api/investor_api.rb +399 -0
- data/lib/DealMakerAPI/api/investor_profile_api.rb +570 -16
- data/lib/DealMakerAPI/api_client.rb +5 -3
- data/lib/DealMakerAPI/api_error.rb +3 -2
- data/lib/DealMakerAPI/configuration.rb +4 -3
- data/lib/DealMakerAPI/models/create_company_request.rb +320 -0
- data/lib/DealMakerAPI/models/create_corporation_profile_request.rb +601 -0
- data/lib/DealMakerAPI/models/create_deal_setup_request.rb +364 -0
- data/lib/DealMakerAPI/models/create_individual_profile_request.rb +389 -0
- data/lib/DealMakerAPI/models/create_investor_request.rb +386 -0
- data/lib/DealMakerAPI/models/create_joint_profile_request.rb +521 -0
- data/lib/DealMakerAPI/models/create_trust_profile_request.rb +491 -0
- data/lib/DealMakerAPI/models/patch_corporation_profile_request.rb +454 -0
- data/lib/DealMakerAPI/models/patch_individual_profile_request.rb +374 -0
- data/lib/DealMakerAPI/models/patch_investor_request.rb +225 -0
- data/lib/DealMakerAPI/models/patch_joint_profile_request.rb +506 -0
- data/lib/DealMakerAPI/models/patch_trust_profile_request.rb +454 -0
- data/lib/DealMakerAPI/models/post_webhooks_request.rb +277 -0
- data/lib/DealMakerAPI/models/put_webhooks_id_request.rb +286 -0
- data/lib/DealMakerAPI/models/update_investor_request.rb +286 -0
- data/lib/DealMakerAPI/models/v1_entities_address.rb +270 -0
- data/lib/DealMakerAPI/models/v1_entities_addresses.rb +219 -0
- data/lib/DealMakerAPI/models/v1_entities_attachment.rb +3 -2
- data/lib/DealMakerAPI/models/v1_entities_background_check_search.rb +3 -2
- data/lib/DealMakerAPI/models/v1_entities_company.rb +299 -0
- data/lib/DealMakerAPI/models/v1_entities_company_deal.rb +230 -0
- data/lib/DealMakerAPI/models/v1_entities_company_deals.rb +219 -0
- data/lib/DealMakerAPI/models/v1_entities_deal.rb +5 -4
- data/lib/DealMakerAPI/models/v1_entities_deal_enterprise.rb +3 -2
- data/lib/DealMakerAPI/models/v1_entities_deal_funding_metrics.rb +3 -2
- data/lib/DealMakerAPI/models/v1_entities_deal_investor_metrics.rb +3 -2
- data/lib/DealMakerAPI/models/v1_entities_deal_issuer.rb +3 -2
- data/lib/DealMakerAPI/models/v1_entities_deal_setup.rb +300 -0
- data/lib/DealMakerAPI/models/v1_entities_deal_setup_user.rb +230 -0
- data/lib/DealMakerAPI/models/v1_entities_deals.rb +220 -0
- data/lib/DealMakerAPI/models/v1_entities_investor.rb +50 -20
- data/lib/DealMakerAPI/models/v1_entities_investor_profile_address.rb +270 -0
- data/lib/DealMakerAPI/models/v1_entities_investor_profile_corporation.rb +332 -0
- data/lib/DealMakerAPI/models/v1_entities_investor_profile_fields_account_holder.rb +269 -0
- data/lib/DealMakerAPI/models/v1_entities_investor_profile_fields_corporation.rb +249 -0
- data/lib/DealMakerAPI/models/v1_entities_investor_profile_fields_primary_holder.rb +279 -0
- data/lib/DealMakerAPI/models/v1_entities_investor_profile_fields_trust.rb +249 -0
- data/lib/DealMakerAPI/models/v1_entities_investor_profile_individual.rb +26 -76
- data/lib/DealMakerAPI/models/v1_entities_investor_profile_item.rb +219 -0
- data/lib/DealMakerAPI/models/v1_entities_investor_profile_joint.rb +333 -0
- data/lib/DealMakerAPI/models/v1_entities_investor_profile_trust.rb +323 -0
- data/lib/DealMakerAPI/models/v1_entities_investor_profiles.rb +220 -0
- data/lib/DealMakerAPI/models/v1_entities_investor_user.rb +3 -2
- data/lib/DealMakerAPI/models/v1_entities_investors.rb +3 -2
- data/lib/DealMakerAPI/models/v1_entities_subscription_agreement.rb +3 -2
- data/lib/DealMakerAPI/models/v1_entities_webhooks_deal.rb +241 -0
- data/lib/DealMakerAPI/models/v1_entities_webhooks_security_token.rb +221 -0
- data/lib/DealMakerAPI/models/v1_entities_webhooks_subscription.rb +270 -0
- data/lib/DealMakerAPI/models/v1_entities_webhooks_subscription_deal.rb +250 -0
- data/lib/DealMakerAPI/models/v1_entities_webhooks_subscription_deals.rb +219 -0
- data/lib/DealMakerAPI/version.rb +3 -3
- data/lib/DealMakerAPI.rb +44 -2
- data/spec/api/company_api_spec.rb +73 -0
- data/spec/api/deal_api_spec.rb +9 -37
- data/spec/api/deal_setup_api_spec.rb +47 -0
- data/spec/api/default_api_spec.rb +108 -0
- data/spec/api/investor_api_spec.rb +106 -0
- data/spec/api/investor_profile_api_spec.rb +109 -7
- data/spec/api_client_spec.rb +2 -2
- data/spec/configuration_spec.rb +2 -2
- data/spec/models/create_company_request_spec.rb +76 -0
- data/spec/models/create_corporation_profile_request_spec.rb +230 -0
- data/spec/models/create_deal_setup_request_spec.rb +82 -0
- data/spec/models/create_individual_profile_request_spec.rb +116 -0
- data/spec/models/create_investor_request_spec.rb +108 -0
- data/spec/models/create_joint_profile_request_spec.rb +192 -0
- data/spec/models/create_trust_profile_request_spec.rb +164 -0
- data/spec/models/patch_corporation_profile_request_spec.rb +158 -0
- data/spec/models/patch_individual_profile_request_spec.rb +110 -0
- data/spec/models/patch_investor_request_spec.rb +34 -0
- data/spec/models/patch_joint_profile_request_spec.rb +186 -0
- data/spec/models/patch_trust_profile_request_spec.rb +158 -0
- data/spec/models/post_webhooks_request_spec.rb +58 -0
- data/spec/models/put_webhooks_id_request_spec.rb +70 -0
- data/spec/models/update_investor_request_spec.rb +56 -0
- data/spec/models/v1_entities_address_spec.rb +64 -0
- data/spec/models/v1_entities_addresses_spec.rb +34 -0
- data/spec/models/v1_entities_attachment_spec.rb +2 -2
- data/spec/models/v1_entities_background_check_search_spec.rb +2 -2
- data/spec/models/v1_entities_company_deal_spec.rb +40 -0
- data/spec/models/v1_entities_company_deals_spec.rb +34 -0
- data/spec/models/v1_entities_company_spec.rb +82 -0
- data/spec/models/v1_entities_deal_enterprise_spec.rb +2 -2
- data/spec/models/v1_entities_deal_funding_metrics_spec.rb +2 -2
- data/spec/models/v1_entities_deal_investor_metrics_spec.rb +2 -2
- data/spec/models/v1_entities_deal_issuer_spec.rb +2 -2
- data/spec/models/v1_entities_deal_setup_spec.rb +82 -0
- data/spec/models/v1_entities_deal_setup_user_spec.rb +40 -0
- data/spec/models/v1_entities_deal_spec.rb +76 -2
- data/spec/models/v1_entities_deals_spec.rb +34 -0
- data/spec/models/v1_entities_investor_profile_address_spec.rb +64 -0
- data/spec/models/v1_entities_investor_profile_corporation_spec.rb +86 -0
- data/spec/models/v1_entities_investor_profile_fields_account_holder_spec.rb +64 -0
- data/spec/models/v1_entities_investor_profile_fields_corporation_spec.rb +52 -0
- data/spec/models/v1_entities_investor_profile_fields_primary_holder_spec.rb +70 -0
- data/spec/models/v1_entities_investor_profile_fields_trust_spec.rb +52 -0
- data/spec/models/v1_entities_investor_profile_individual_spec.rb +6 -36
- data/spec/models/v1_entities_investor_profile_item_spec.rb +34 -0
- data/spec/models/v1_entities_investor_profile_joint_spec.rb +86 -0
- data/spec/models/v1_entities_investor_profile_trust_spec.rb +80 -0
- data/spec/models/v1_entities_investor_profiles_spec.rb +34 -0
- data/spec/models/v1_entities_investor_spec.rb +29 -5
- data/spec/models/v1_entities_investor_user_spec.rb +2 -2
- data/spec/models/v1_entities_investors_spec.rb +2 -2
- data/spec/models/v1_entities_subscription_agreement_spec.rb +2 -2
- data/spec/models/v1_entities_webhooks_deal_spec.rb +46 -0
- data/spec/models/v1_entities_webhooks_security_token_spec.rb +34 -0
- data/spec/models/v1_entities_webhooks_subscription_deal_spec.rb +52 -0
- data/spec/models/v1_entities_webhooks_subscription_deals_spec.rb +34 -0
- data/spec/models/v1_entities_webhooks_subscription_spec.rb +64 -0
- data/spec/spec_helper.rb +2 -2
- metadata +180 -12
@@ -0,0 +1,42 @@
|
|
1
|
+
# DealMakerAPI::PatchIndividualProfileRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **us_accredited_category** | **String** | The accredited investor information. | [optional] |
|
8
|
+
| **first_name** | **String** | The first name of the individual investor profile. | [optional] |
|
9
|
+
| **last_name** | **String** | The last name of the individual investor profile. | [optional] |
|
10
|
+
| **suffix** | **String** | The suffix of the individual investor profile. | [optional] |
|
11
|
+
| **date_of_birth** | **String** | The date of birth of the investor profile. | [optional] |
|
12
|
+
| **taxpayer_id** | **String** | The taxpayer identification number of the investor profile. | [optional] |
|
13
|
+
| **phone_number** | **String** | The phone number of the investor profile. | [optional] |
|
14
|
+
| **country** | **String** | The country of the individual investor profile. | [optional] |
|
15
|
+
| **street_address** | **String** | The street address of the individual investor profile. | [optional] |
|
16
|
+
| **unit2** | **String** | The street address line 2 of the individual investor profile. | [optional] |
|
17
|
+
| **city** | **String** | The city of the individual investor profile. | [optional] |
|
18
|
+
| **region** | **String** | The region or state of the individual investor profile. | [optional] |
|
19
|
+
| **postal_code** | **String** | The postal code or zipcode of the individual investor profile. | [optional] |
|
20
|
+
|
21
|
+
## Example
|
22
|
+
|
23
|
+
```ruby
|
24
|
+
require 'DealMakerAPI'
|
25
|
+
|
26
|
+
instance = DealMakerAPI::PatchIndividualProfileRequest.new(
|
27
|
+
us_accredited_category: null,
|
28
|
+
first_name: null,
|
29
|
+
last_name: null,
|
30
|
+
suffix: null,
|
31
|
+
date_of_birth: null,
|
32
|
+
taxpayer_id: null,
|
33
|
+
phone_number: null,
|
34
|
+
country: null,
|
35
|
+
street_address: null,
|
36
|
+
unit2: null,
|
37
|
+
city: null,
|
38
|
+
region: null,
|
39
|
+
postal_code: null
|
40
|
+
)
|
41
|
+
```
|
42
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# DealMakerAPI::PatchInvestorRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **investor_profile_id** | **Integer** | Investor profile id that needs to be set on investor | |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'DealMakerAPI'
|
13
|
+
|
14
|
+
instance = DealMakerAPI::PatchInvestorRequest.new(
|
15
|
+
investor_profile_id: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -0,0 +1,66 @@
|
|
1
|
+
# DealMakerAPI::PatchJointProfileRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **us_accredited_category** | **String** | The accredited investor information. | [optional] |
|
8
|
+
| **joint_type** | **String** | The kind of joint investor. | [optional] |
|
9
|
+
| **first_name** | **String** | The first name of the investor profile. | [optional] |
|
10
|
+
| **last_name** | **String** | The last name of the investor profile. | [optional] |
|
11
|
+
| **suffix** | **String** | The suffix of the investor profile. | [optional] |
|
12
|
+
| **country** | **String** | The country the investor profile. | [optional] |
|
13
|
+
| **street_address** | **String** | The street address of the investor profile. | [optional] |
|
14
|
+
| **unit2** | **String** | The street address line 2 of the investor profile. | [optional] |
|
15
|
+
| **city** | **String** | The city of the investor profile. | [optional] |
|
16
|
+
| **region** | **String** | The region or State of the investor profile. | [optional] |
|
17
|
+
| **postal_code** | **String** | The postal code or zipcode of the investor profile. | [optional] |
|
18
|
+
| **date_of_birth** | **String** | The date of birth of the investor profile. | [optional] |
|
19
|
+
| **taxpayer_id** | **String** | The taxpayer identification number of the investor profile. | [optional] |
|
20
|
+
| **phone_number** | **String** | The phone number of the investor profile. | [optional] |
|
21
|
+
| **joint_holder_first_name** | **String** | The joint holder first name of the investor profile. | [optional] |
|
22
|
+
| **joint_holder_last_name** | **String** | The joint holder last name of the investor profile. | [optional] |
|
23
|
+
| **joint_holder_suffix** | **String** | The suffix of the individual investor profile. | [optional] |
|
24
|
+
| **joint_holder_country** | **String** | The joint holder country of the investor profile. | [optional] |
|
25
|
+
| **joint_holder_street_address** | **String** | The joint holder street address of the investor profile. | [optional] |
|
26
|
+
| **joint_holder_unit2** | **String** | The Joint holder street address line 2 of the investor profile. | [optional] |
|
27
|
+
| **joint_holder_city** | **String** | The Joint holder city of the investor profile. | [optional] |
|
28
|
+
| **joint_holder_region** | **String** | The joint holder region or state of the investor profile. | [optional] |
|
29
|
+
| **joint_holder_postal_code** | **String** | The joint holder postal code or zipcode of the investor profile. | [optional] |
|
30
|
+
| **joint_holder_date_of_birth** | **String** | The joint holder date of birth of the investor profile. | [optional] |
|
31
|
+
| **joint_holder_taxpayer_id** | **String** | The joint holder taxpayer identification number of the investor profile. | [optional] |
|
32
|
+
|
33
|
+
## Example
|
34
|
+
|
35
|
+
```ruby
|
36
|
+
require 'DealMakerAPI'
|
37
|
+
|
38
|
+
instance = DealMakerAPI::PatchJointProfileRequest.new(
|
39
|
+
us_accredited_category: null,
|
40
|
+
joint_type: null,
|
41
|
+
first_name: null,
|
42
|
+
last_name: null,
|
43
|
+
suffix: null,
|
44
|
+
country: null,
|
45
|
+
street_address: null,
|
46
|
+
unit2: null,
|
47
|
+
city: null,
|
48
|
+
region: null,
|
49
|
+
postal_code: null,
|
50
|
+
date_of_birth: null,
|
51
|
+
taxpayer_id: null,
|
52
|
+
phone_number: null,
|
53
|
+
joint_holder_first_name: null,
|
54
|
+
joint_holder_last_name: null,
|
55
|
+
joint_holder_suffix: null,
|
56
|
+
joint_holder_country: null,
|
57
|
+
joint_holder_street_address: null,
|
58
|
+
joint_holder_unit2: null,
|
59
|
+
joint_holder_city: null,
|
60
|
+
joint_holder_region: null,
|
61
|
+
joint_holder_postal_code: null,
|
62
|
+
joint_holder_date_of_birth: null,
|
63
|
+
joint_holder_taxpayer_id: null
|
64
|
+
)
|
65
|
+
```
|
66
|
+
|
@@ -0,0 +1,58 @@
|
|
1
|
+
# DealMakerAPI::PatchTrustProfileRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **us_accredited_category** | **String** | The accredited investor information. | [optional] |
|
8
|
+
| **name** | **String** | The name of the trust. | [optional] |
|
9
|
+
| **date** | **String** | The creation date of the trust. | [optional] |
|
10
|
+
| **phone_number** | **String** | The phone number of the trust. | [optional] |
|
11
|
+
| **country** | **String** | Trust country. | [optional] |
|
12
|
+
| **street_address** | **String** | Trust street address. | [optional] |
|
13
|
+
| **unit2** | **String** | Trust street address line 2. | [optional] |
|
14
|
+
| **city** | **String** | Trust city. | [optional] |
|
15
|
+
| **region** | **String** | Trust region or state. | [optional] |
|
16
|
+
| **postal_code** | **String** | Trust postal code or zipcode. | [optional] |
|
17
|
+
| **trustee_first_name** | **String** | Trustee first name. | [optional] |
|
18
|
+
| **trustee_last_name** | **String** | Trustee last name. | [optional] |
|
19
|
+
| **trustee_suffix** | **String** | Trustee suffix. | [optional] |
|
20
|
+
| **trustee_country** | **String** | Trustee country. | [optional] |
|
21
|
+
| **trustee_street_address** | **String** | Trustee street address. | [optional] |
|
22
|
+
| **trustee_unit2** | **String** | Trustee street address line 2. | [optional] |
|
23
|
+
| **trustee_city** | **String** | Trustee city. | [optional] |
|
24
|
+
| **trustee_region** | **String** | Trustee region or state. | [optional] |
|
25
|
+
| **trustee_postal_code** | **String** | Trustee postal code or zipcode. | [optional] |
|
26
|
+
| **trustee_date_of_birth** | **String** | Trustee date of birth. | [optional] |
|
27
|
+
| **trustee_taxpayer_id** | **String** | The taxpayer identification number of the investor profile. | [optional] |
|
28
|
+
|
29
|
+
## Example
|
30
|
+
|
31
|
+
```ruby
|
32
|
+
require 'DealMakerAPI'
|
33
|
+
|
34
|
+
instance = DealMakerAPI::PatchTrustProfileRequest.new(
|
35
|
+
us_accredited_category: null,
|
36
|
+
name: null,
|
37
|
+
date: null,
|
38
|
+
phone_number: null,
|
39
|
+
country: null,
|
40
|
+
street_address: null,
|
41
|
+
unit2: null,
|
42
|
+
city: null,
|
43
|
+
region: null,
|
44
|
+
postal_code: null,
|
45
|
+
trustee_first_name: null,
|
46
|
+
trustee_last_name: null,
|
47
|
+
trustee_suffix: null,
|
48
|
+
trustee_country: null,
|
49
|
+
trustee_street_address: null,
|
50
|
+
trustee_unit2: null,
|
51
|
+
trustee_city: null,
|
52
|
+
trustee_region: null,
|
53
|
+
trustee_postal_code: null,
|
54
|
+
trustee_date_of_birth: null,
|
55
|
+
trustee_taxpayer_id: null
|
56
|
+
)
|
57
|
+
```
|
58
|
+
|
@@ -0,0 +1,26 @@
|
|
1
|
+
# DealMakerAPI::PostWebhooksRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **name** | **String** | Endpoint name | |
|
8
|
+
| **enabled** | **Boolean** | Endpoint status | |
|
9
|
+
| **url** | **String** | Payload URL | [optional] |
|
10
|
+
| **security_token** | **String** | Secret key | [optional] |
|
11
|
+
| **webhook_subscription_deals_deal_id** | **Array<Integer>** | The id of the deal to link | |
|
12
|
+
|
13
|
+
## Example
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'DealMakerAPI'
|
17
|
+
|
18
|
+
instance = DealMakerAPI::PostWebhooksRequest.new(
|
19
|
+
name: null,
|
20
|
+
enabled: null,
|
21
|
+
url: null,
|
22
|
+
security_token: null,
|
23
|
+
webhook_subscription_deals_deal_id: null
|
24
|
+
)
|
25
|
+
```
|
26
|
+
|
@@ -0,0 +1,30 @@
|
|
1
|
+
# DealMakerAPI::PutWebhooksIdRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **name** | **String** | Endpoint name | [optional] |
|
8
|
+
| **enabled** | **Boolean** | Endpoint status | [optional] |
|
9
|
+
| **url** | **String** | Payload URL | [optional] |
|
10
|
+
| **security_token** | **String** | Secret key | [optional] |
|
11
|
+
| **webhook_subscription_deals_id** | **Array<Integer>** | The id of the webhook subscription deal | [optional] |
|
12
|
+
| **webhook_subscription_deals_deal_id** | **Array<Integer>** | The id of the deal to link | [optional] |
|
13
|
+
| **webhook_subscription_deals__destroy** | **Array<Boolean>** | | [optional] |
|
14
|
+
|
15
|
+
## Example
|
16
|
+
|
17
|
+
```ruby
|
18
|
+
require 'DealMakerAPI'
|
19
|
+
|
20
|
+
instance = DealMakerAPI::PutWebhooksIdRequest.new(
|
21
|
+
name: null,
|
22
|
+
enabled: null,
|
23
|
+
url: null,
|
24
|
+
security_token: null,
|
25
|
+
webhook_subscription_deals_id: null,
|
26
|
+
webhook_subscription_deals_deal_id: null,
|
27
|
+
webhook_subscription_deals__destroy: null
|
28
|
+
)
|
29
|
+
```
|
30
|
+
|
@@ -0,0 +1,24 @@
|
|
1
|
+
# DealMakerAPI::UpdateInvestorRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **warrant_expiry_date** | **Date** | The warrant expiry date of the investor. | [optional] |
|
8
|
+
| **warrant_certificate_number** | **Integer** | The certificate number of the investor. | [optional] |
|
9
|
+
| **allocated_amount** | **Float** | The allocation amount of the investor. | [optional] |
|
10
|
+
| **allocation_unit** | **String** | The allocation unit of the investor. | [optional][default to 'securities'] |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'DealMakerAPI'
|
16
|
+
|
17
|
+
instance = DealMakerAPI::UpdateInvestorRequest.new(
|
18
|
+
warrant_expiry_date: null,
|
19
|
+
warrant_certificate_number: null,
|
20
|
+
allocated_amount: null,
|
21
|
+
allocation_unit: null
|
22
|
+
)
|
23
|
+
```
|
24
|
+
|
@@ -0,0 +1,28 @@
|
|
1
|
+
# DealMakerAPI::V1EntitiesAddress
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **street** | **String** | The street. | [optional] |
|
8
|
+
| **line_2** | **String** | The second line. | [optional] |
|
9
|
+
| **city** | **String** | The city. | [optional] |
|
10
|
+
| **state** | **String** | The state/province. | [optional] |
|
11
|
+
| **postal_code** | **String** | The postal code/zip code. | [optional] |
|
12
|
+
| **country** | **String** | The country. | [optional] |
|
13
|
+
|
14
|
+
## Example
|
15
|
+
|
16
|
+
```ruby
|
17
|
+
require 'DealMakerAPI'
|
18
|
+
|
19
|
+
instance = DealMakerAPI::V1EntitiesAddress.new(
|
20
|
+
street: null,
|
21
|
+
line_2: null,
|
22
|
+
city: null,
|
23
|
+
state: null,
|
24
|
+
postal_code: null,
|
25
|
+
country: null
|
26
|
+
)
|
27
|
+
```
|
28
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# DealMakerAPI::V1EntitiesAddresses
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **items** | [**V1EntitiesAddress**](V1EntitiesAddress.md) | | [optional] |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'DealMakerAPI'
|
13
|
+
|
14
|
+
instance = DealMakerAPI::V1EntitiesAddresses.new(
|
15
|
+
items: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -0,0 +1,34 @@
|
|
1
|
+
# DealMakerAPI::V1EntitiesCompany
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **Integer** | The unique id. | [optional] |
|
8
|
+
| **type** | **Integer** | The entity company. | [optional] |
|
9
|
+
| **name** | **String** | The name of the company. | [optional] |
|
10
|
+
| **description** | **String** | The description of the company. | [optional] |
|
11
|
+
| **reply_email** | **String** | The reply email of the company. | [optional] |
|
12
|
+
| **company_url** | **String** | The url of the company. | [optional] |
|
13
|
+
| **addresses** | [**V1EntitiesAddresses**](V1EntitiesAddresses.md) | | [optional] |
|
14
|
+
| **portals** | [**V1EntitiesCompanyDeals**](V1EntitiesCompanyDeals.md) | | [optional] |
|
15
|
+
| **primary_color** | **String** | The primary color of the company. This should be a hex color code, with the leading \"#\". | [optional] |
|
16
|
+
|
17
|
+
## Example
|
18
|
+
|
19
|
+
```ruby
|
20
|
+
require 'DealMakerAPI'
|
21
|
+
|
22
|
+
instance = DealMakerAPI::V1EntitiesCompany.new(
|
23
|
+
id: null,
|
24
|
+
type: null,
|
25
|
+
name: null,
|
26
|
+
description: null,
|
27
|
+
reply_email: null,
|
28
|
+
company_url: null,
|
29
|
+
addresses: null,
|
30
|
+
portals: null,
|
31
|
+
primary_color: null
|
32
|
+
)
|
33
|
+
```
|
34
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# DealMakerAPI::V1EntitiesCompanyDeal
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **Integer** | The deal's unique id. | [optional] |
|
8
|
+
| **name** | **String** | The deal title. | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'DealMakerAPI'
|
14
|
+
|
15
|
+
instance = DealMakerAPI::V1EntitiesCompanyDeal.new(
|
16
|
+
id: null,
|
17
|
+
name: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# DealMakerAPI::V1EntitiesCompanyDeals
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **items** | [**V1EntitiesCompanyDeal**](V1EntitiesCompanyDeal.md) | | [optional] |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'DealMakerAPI'
|
13
|
+
|
14
|
+
instance = DealMakerAPI::V1EntitiesCompanyDeals.new(
|
15
|
+
items: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -0,0 +1,34 @@
|
|
1
|
+
# DealMakerAPI::V1EntitiesDealSetup
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **Integer** | The deal setup id. | [optional] |
|
8
|
+
| **deal_name** | **String** | The title/name of the deal. | [optional] |
|
9
|
+
| **deal_type** | **Integer** | The type of the deal. | [optional] |
|
10
|
+
| **invoice_contact** | **String** | The invoice email address. | [optional] |
|
11
|
+
| **industry** | **String** | The industry. | [optional] |
|
12
|
+
| **high_risk** | **Boolean** | Determine if the deal is a high risk or not. | [optional] |
|
13
|
+
| **company_id** | **Integer** | The id of the company. | [optional] |
|
14
|
+
| **link** | **String** | Link to the second page of the deal setup | [optional] |
|
15
|
+
| **representative** | [**V1EntitiesDealSetupUser**](V1EntitiesDealSetupUser.md) | | [optional] |
|
16
|
+
|
17
|
+
## Example
|
18
|
+
|
19
|
+
```ruby
|
20
|
+
require 'DealMakerAPI'
|
21
|
+
|
22
|
+
instance = DealMakerAPI::V1EntitiesDealSetup.new(
|
23
|
+
id: null,
|
24
|
+
deal_name: null,
|
25
|
+
deal_type: null,
|
26
|
+
invoice_contact: null,
|
27
|
+
industry: null,
|
28
|
+
high_risk: null,
|
29
|
+
company_id: null,
|
30
|
+
link: null,
|
31
|
+
representative: null
|
32
|
+
)
|
33
|
+
```
|
34
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# DealMakerAPI::V1EntitiesDealSetupUser
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **Integer** | Investor user id. | [optional] |
|
8
|
+
| **email** | **String** | Investor user email address. | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'DealMakerAPI'
|
14
|
+
|
15
|
+
instance = DealMakerAPI::V1EntitiesDealSetupUser.new(
|
16
|
+
id: null,
|
17
|
+
email: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# DealMakerAPI::V1EntitiesDeals
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **items** | [**V1EntitiesDeal**](V1EntitiesDeal.md) | | [optional] |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'DealMakerAPI'
|
13
|
+
|
14
|
+
instance = DealMakerAPI::V1EntitiesDeals.new(
|
15
|
+
items: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
data/docs/V1EntitiesInvestor.md
CHANGED
@@ -11,21 +11,24 @@
|
|
11
11
|
| **name** | **String** | The full name of the investor. | [optional] |
|
12
12
|
| **allocation_unit** | **String** | The allocation unit. | [optional] |
|
13
13
|
| **state** | **String** | The state. | [optional] |
|
14
|
-
| **
|
14
|
+
| **funding_state** | **String** | The funding state. | [optional] |
|
15
15
|
| **funds_pending** | **Boolean** | True if any funds are pending; false otherwise. | [optional] |
|
16
16
|
| **beneficial_address** | **String** | The address. | [optional] |
|
17
|
+
| **phone_number** | **String** | The beneficial phone number associated with the investor. If there is no phone number, this returns the phone number associated with the user profile. | [optional] |
|
17
18
|
| **investor_currency** | **String** | The investor currency. | [optional] |
|
18
19
|
| **investment_value** | **Float** | The current investment value. | [optional] |
|
19
20
|
| **number_of_securities** | **Integer** | The number of securities. | [optional] |
|
20
21
|
| **allocated_amount** | **Float** | The amount allocated. | [optional] |
|
21
22
|
| **funds_value** | **Float** | The current amount that has been funded. | [optional] |
|
22
|
-
| **access_link** | **String** | The access link for the investor. | [optional] |
|
23
|
+
| **access_link** | **String** | The access link for the investor. This is the access link for the specific investment, not the user. If the same user has multiple investments, each one will have a different access link. | [optional] |
|
23
24
|
| **subscription_agreement** | [**V1EntitiesSubscriptionAgreement**](V1EntitiesSubscriptionAgreement.md) | | [optional] |
|
24
25
|
| **attachments** | [**V1EntitiesAttachment**](V1EntitiesAttachment.md) | | [optional] |
|
25
26
|
| **background_check_searches** | [**V1EntitiesBackgroundCheckSearch**](V1EntitiesBackgroundCheckSearch.md) | | [optional] |
|
26
27
|
| **verification_status** | **String** | The current 506c verification state. | [optional] |
|
27
28
|
| **warrant_expiry_date** | **Date** | The warrant expiry date. | [optional] |
|
28
29
|
| **warrant_certificate_number** | **Integer** | The warrant certificate number. | [optional] |
|
30
|
+
| **ranking_score** | **Float** | A value `[0, 1]` that represents the propensity for the investor to complete payment for the investment. A larger value indicates a higher likelihood of payment, as predicted by DealMaker’s machine learning algorithm. This field will only populate if DealMaker Compass is enabled for a deal and the investor `funds_state` value is not `funded` or `overfunded` | [optional] |
|
31
|
+
| **investor_profile** | **String** | | [optional] |
|
29
32
|
|
30
33
|
## Example
|
31
34
|
|
@@ -40,9 +43,10 @@ instance = DealMakerAPI::V1EntitiesInvestor.new(
|
|
40
43
|
name: null,
|
41
44
|
allocation_unit: null,
|
42
45
|
state: null,
|
43
|
-
|
46
|
+
funding_state: null,
|
44
47
|
funds_pending: null,
|
45
48
|
beneficial_address: null,
|
49
|
+
phone_number: null,
|
46
50
|
investor_currency: null,
|
47
51
|
investment_value: null,
|
48
52
|
number_of_securities: null,
|
@@ -54,7 +58,9 @@ instance = DealMakerAPI::V1EntitiesInvestor.new(
|
|
54
58
|
background_check_searches: null,
|
55
59
|
verification_status: null,
|
56
60
|
warrant_expiry_date: null,
|
57
|
-
warrant_certificate_number: null
|
61
|
+
warrant_certificate_number: null,
|
62
|
+
ranking_score: null,
|
63
|
+
investor_profile: null
|
58
64
|
)
|
59
65
|
```
|
60
66
|
|
@@ -0,0 +1,28 @@
|
|
1
|
+
# DealMakerAPI::V1EntitiesInvestorProfileAddress
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **street_address** | **String** | Investor profile street address | [optional] |
|
8
|
+
| **unit2** | **String** | Investor profile street address line 2 | [optional] |
|
9
|
+
| **city** | **String** | Investor profile city | [optional] |
|
10
|
+
| **region** | **String** | Investor profile region or state | [optional] |
|
11
|
+
| **country** | **String** | Investor profile country | [optional] |
|
12
|
+
| **postal_code** | **String** | Investor profile postal code or zipcode | [optional] |
|
13
|
+
|
14
|
+
## Example
|
15
|
+
|
16
|
+
```ruby
|
17
|
+
require 'DealMakerAPI'
|
18
|
+
|
19
|
+
instance = DealMakerAPI::V1EntitiesInvestorProfileAddress.new(
|
20
|
+
street_address: null,
|
21
|
+
unit2: null,
|
22
|
+
city: null,
|
23
|
+
region: null,
|
24
|
+
country: null,
|
25
|
+
postal_code: null
|
26
|
+
)
|
27
|
+
```
|
28
|
+
|
@@ -0,0 +1,34 @@
|
|
1
|
+
# DealMakerAPI::V1EntitiesInvestorProfileCorporation
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **Integer** | Investor Profile id | [optional] |
|
8
|
+
| **user_id** | **Integer** | User id | [optional] |
|
9
|
+
| **email** | **String** | User email | [optional] |
|
10
|
+
| **type** | **String** | Investor Profile type | [optional] |
|
11
|
+
| **us_accredited_category** | **String** | The accredited investor information | [optional] |
|
12
|
+
| **complete** | **Boolean** | To check if the profile is complete or not | [optional] |
|
13
|
+
| **corporation** | [**V1EntitiesInvestorProfileFieldsCorporation**](V1EntitiesInvestorProfileFieldsCorporation.md) | | [optional] |
|
14
|
+
| **signing_officer** | [**V1EntitiesInvestorProfileFieldsAccountHolder**](V1EntitiesInvestorProfileFieldsAccountHolder.md) | | [optional] |
|
15
|
+
| **beneficial_owners** | [**V1EntitiesInvestorProfileFieldsAccountHolder**](V1EntitiesInvestorProfileFieldsAccountHolder.md) | | [optional] |
|
16
|
+
|
17
|
+
## Example
|
18
|
+
|
19
|
+
```ruby
|
20
|
+
require 'DealMakerAPI'
|
21
|
+
|
22
|
+
instance = DealMakerAPI::V1EntitiesInvestorProfileCorporation.new(
|
23
|
+
id: null,
|
24
|
+
user_id: null,
|
25
|
+
email: null,
|
26
|
+
type: null,
|
27
|
+
us_accredited_category: null,
|
28
|
+
complete: null,
|
29
|
+
corporation: null,
|
30
|
+
signing_officer: null,
|
31
|
+
beneficial_owners: null
|
32
|
+
)
|
33
|
+
```
|
34
|
+
|
@@ -0,0 +1,28 @@
|
|
1
|
+
# DealMakerAPI::V1EntitiesInvestorProfileFieldsAccountHolder
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **first_name** | **String** | Investor profile first name | [optional] |
|
8
|
+
| **last_name** | **String** | Investor profile last name | [optional] |
|
9
|
+
| **suffix** | **String** | Investor profile suffix | [optional] |
|
10
|
+
| **date_of_birth** | **String** | The date of birth | [optional] |
|
11
|
+
| **taxpayer_id** | **String** | The taxpayer identification number | [optional] |
|
12
|
+
| **address** | [**V1EntitiesInvestorProfileAddress**](V1EntitiesInvestorProfileAddress.md) | | [optional] |
|
13
|
+
|
14
|
+
## Example
|
15
|
+
|
16
|
+
```ruby
|
17
|
+
require 'DealMakerAPI'
|
18
|
+
|
19
|
+
instance = DealMakerAPI::V1EntitiesInvestorProfileFieldsAccountHolder.new(
|
20
|
+
first_name: null,
|
21
|
+
last_name: null,
|
22
|
+
suffix: null,
|
23
|
+
date_of_birth: null,
|
24
|
+
taxpayer_id: null,
|
25
|
+
address: null
|
26
|
+
)
|
27
|
+
```
|
28
|
+
|
@@ -0,0 +1,24 @@
|
|
1
|
+
# DealMakerAPI::V1EntitiesInvestorProfileFieldsCorporation
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **name** | **String** | The corporation name | [optional] |
|
8
|
+
| **business_number** | **String** | The corporation business number | [optional] |
|
9
|
+
| **phone_number** | **String** | The corporation phone number | [optional] |
|
10
|
+
| **address** | [**V1EntitiesInvestorProfileAddress**](V1EntitiesInvestorProfileAddress.md) | | [optional] |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'DealMakerAPI'
|
16
|
+
|
17
|
+
instance = DealMakerAPI::V1EntitiesInvestorProfileFieldsCorporation.new(
|
18
|
+
name: null,
|
19
|
+
business_number: null,
|
20
|
+
phone_number: null,
|
21
|
+
address: null
|
22
|
+
)
|
23
|
+
```
|
24
|
+
|
@@ -0,0 +1,30 @@
|
|
1
|
+
# DealMakerAPI::V1EntitiesInvestorProfileFieldsPrimaryHolder
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **first_name** | **String** | Investor profile first name | [optional] |
|
8
|
+
| **last_name** | **String** | Investor profile last name | [optional] |
|
9
|
+
| **suffix** | **String** | Investor profile suffix | [optional] |
|
10
|
+
| **date_of_birth** | **String** | The date of birth | [optional] |
|
11
|
+
| **taxpayer_id** | **String** | The taxpayer identification number | [optional] |
|
12
|
+
| **phone_number** | **String** | The phone number of the primary account holder | [optional] |
|
13
|
+
| **address** | [**V1EntitiesInvestorProfileAddress**](V1EntitiesInvestorProfileAddress.md) | | [optional] |
|
14
|
+
|
15
|
+
## Example
|
16
|
+
|
17
|
+
```ruby
|
18
|
+
require 'DealMakerAPI'
|
19
|
+
|
20
|
+
instance = DealMakerAPI::V1EntitiesInvestorProfileFieldsPrimaryHolder.new(
|
21
|
+
first_name: null,
|
22
|
+
last_name: null,
|
23
|
+
suffix: null,
|
24
|
+
date_of_birth: null,
|
25
|
+
taxpayer_id: null,
|
26
|
+
phone_number: null,
|
27
|
+
address: null
|
28
|
+
)
|
29
|
+
```
|
30
|
+
|