DealMakerAPI 0.0.3 → 0.68.6

Sign up to get free protection for your applications and to get access to all the features.
Files changed (169) hide show
  1. checksums.yaml +4 -4
  2. data/DealMakerAPI.gemspec +3 -3
  3. data/README.md +75 -20
  4. data/docs/CompanyApi.md +214 -0
  5. data/docs/CreateCompanyRequest.md +32 -0
  6. data/docs/CreateCorporationProfileRequest.md +82 -0
  7. data/docs/CreateDealSetupRequest.md +30 -0
  8. data/docs/CreateIndividualProfileRequest.md +44 -0
  9. data/docs/CreateInvestorRequest.md +40 -0
  10. data/docs/CreateJointProfileRequest.md +68 -0
  11. data/docs/CreateTrustProfileRequest.md +60 -0
  12. data/docs/DealApi.md +5 -222
  13. data/docs/DealSetupApi.md +74 -0
  14. data/docs/DefaultApi.md +413 -0
  15. data/docs/InvestorApi.md +368 -0
  16. data/docs/InvestorProfileApi.md +573 -15
  17. data/docs/PatchCorporationProfileRequest.md +58 -0
  18. data/docs/PatchIndividualProfileRequest.md +42 -0
  19. data/docs/PatchInvestorRequest.md +18 -0
  20. data/docs/PatchJointProfileRequest.md +66 -0
  21. data/docs/PatchTrustProfileRequest.md +58 -0
  22. data/docs/PostWebhooksRequest.md +26 -0
  23. data/docs/PutWebhooksIdRequest.md +30 -0
  24. data/docs/UpdateInvestorRequest.md +24 -0
  25. data/docs/V1EntitiesAddress.md +28 -0
  26. data/docs/V1EntitiesAddresses.md +18 -0
  27. data/docs/V1EntitiesCompany.md +34 -0
  28. data/docs/V1EntitiesCompanyDeal.md +20 -0
  29. data/docs/V1EntitiesCompanyDeals.md +18 -0
  30. data/docs/V1EntitiesDealSetup.md +34 -0
  31. data/docs/V1EntitiesDealSetupUser.md +20 -0
  32. data/docs/V1EntitiesInvestor.md +10 -4
  33. data/docs/V1EntitiesInvestorProfileAddress.md +28 -0
  34. data/docs/V1EntitiesInvestorProfileCorporation.md +34 -0
  35. data/docs/V1EntitiesInvestorProfileFieldsAccountHolder.md +28 -0
  36. data/docs/V1EntitiesInvestorProfileFieldsCorporation.md +24 -0
  37. data/docs/V1EntitiesInvestorProfileFieldsPrimaryHolder.md +30 -0
  38. data/docs/V1EntitiesInvestorProfileFieldsTrust.md +24 -0
  39. data/docs/V1EntitiesInvestorProfileIndividual.md +6 -16
  40. data/docs/V1EntitiesInvestorProfileItem.md +18 -0
  41. data/docs/V1EntitiesInvestorProfileJoint.md +34 -0
  42. data/docs/V1EntitiesInvestorProfileTrust.md +32 -0
  43. data/docs/V1EntitiesInvestorProfiles.md +18 -0
  44. data/docs/V1EntitiesWebhooksDeal.md +22 -0
  45. data/docs/V1EntitiesWebhooksSecurityToken.md +18 -0
  46. data/docs/V1EntitiesWebhooksSubscription.md +28 -0
  47. data/docs/V1EntitiesWebhooksSubscriptionDeal.md +24 -0
  48. data/docs/V1EntitiesWebhooksSubscriptionDeals.md +18 -0
  49. data/lib/DealMakerAPI/api/company_api.rb +219 -0
  50. data/lib/DealMakerAPI/api/deal_api.rb +9 -226
  51. data/lib/DealMakerAPI/api/deal_setup_api.rb +90 -0
  52. data/lib/DealMakerAPI/api/default_api.rb +403 -0
  53. data/lib/DealMakerAPI/api/investor_api.rb +399 -0
  54. data/lib/DealMakerAPI/api/investor_profile_api.rb +570 -16
  55. data/lib/DealMakerAPI/api_client.rb +5 -3
  56. data/lib/DealMakerAPI/api_error.rb +3 -2
  57. data/lib/DealMakerAPI/configuration.rb +4 -3
  58. data/lib/DealMakerAPI/models/create_company_request.rb +320 -0
  59. data/lib/DealMakerAPI/models/create_corporation_profile_request.rb +601 -0
  60. data/lib/DealMakerAPI/models/create_deal_setup_request.rb +364 -0
  61. data/lib/DealMakerAPI/models/create_individual_profile_request.rb +389 -0
  62. data/lib/DealMakerAPI/models/create_investor_request.rb +386 -0
  63. data/lib/DealMakerAPI/models/create_joint_profile_request.rb +521 -0
  64. data/lib/DealMakerAPI/models/create_trust_profile_request.rb +491 -0
  65. data/lib/DealMakerAPI/models/patch_corporation_profile_request.rb +454 -0
  66. data/lib/DealMakerAPI/models/patch_individual_profile_request.rb +374 -0
  67. data/lib/DealMakerAPI/models/patch_investor_request.rb +225 -0
  68. data/lib/DealMakerAPI/models/patch_joint_profile_request.rb +506 -0
  69. data/lib/DealMakerAPI/models/patch_trust_profile_request.rb +454 -0
  70. data/lib/DealMakerAPI/models/post_webhooks_request.rb +277 -0
  71. data/lib/DealMakerAPI/models/put_webhooks_id_request.rb +286 -0
  72. data/lib/DealMakerAPI/models/update_investor_request.rb +286 -0
  73. data/lib/DealMakerAPI/models/v1_entities_address.rb +270 -0
  74. data/lib/DealMakerAPI/models/v1_entities_addresses.rb +219 -0
  75. data/lib/DealMakerAPI/models/v1_entities_attachment.rb +3 -2
  76. data/lib/DealMakerAPI/models/v1_entities_background_check_search.rb +3 -2
  77. data/lib/DealMakerAPI/models/v1_entities_company.rb +299 -0
  78. data/lib/DealMakerAPI/models/v1_entities_company_deal.rb +230 -0
  79. data/lib/DealMakerAPI/models/v1_entities_company_deals.rb +219 -0
  80. data/lib/DealMakerAPI/models/v1_entities_deal.rb +5 -4
  81. data/lib/DealMakerAPI/models/v1_entities_deal_enterprise.rb +3 -2
  82. data/lib/DealMakerAPI/models/v1_entities_deal_funding_metrics.rb +3 -2
  83. data/lib/DealMakerAPI/models/v1_entities_deal_investor_metrics.rb +3 -2
  84. data/lib/DealMakerAPI/models/v1_entities_deal_issuer.rb +3 -2
  85. data/lib/DealMakerAPI/models/v1_entities_deal_setup.rb +300 -0
  86. data/lib/DealMakerAPI/models/v1_entities_deal_setup_user.rb +230 -0
  87. data/lib/DealMakerAPI/models/v1_entities_deals.rb +3 -2
  88. data/lib/DealMakerAPI/models/v1_entities_investor.rb +50 -20
  89. data/lib/DealMakerAPI/models/v1_entities_investor_profile_address.rb +270 -0
  90. data/lib/DealMakerAPI/models/v1_entities_investor_profile_corporation.rb +332 -0
  91. data/lib/DealMakerAPI/models/v1_entities_investor_profile_fields_account_holder.rb +269 -0
  92. data/lib/DealMakerAPI/models/v1_entities_investor_profile_fields_corporation.rb +249 -0
  93. data/lib/DealMakerAPI/models/v1_entities_investor_profile_fields_primary_holder.rb +279 -0
  94. data/lib/DealMakerAPI/models/v1_entities_investor_profile_fields_trust.rb +249 -0
  95. data/lib/DealMakerAPI/models/v1_entities_investor_profile_individual.rb +26 -76
  96. data/lib/DealMakerAPI/models/v1_entities_investor_profile_item.rb +219 -0
  97. data/lib/DealMakerAPI/models/v1_entities_investor_profile_joint.rb +333 -0
  98. data/lib/DealMakerAPI/models/v1_entities_investor_profile_trust.rb +323 -0
  99. data/lib/DealMakerAPI/models/v1_entities_investor_profiles.rb +220 -0
  100. data/lib/DealMakerAPI/models/v1_entities_investor_user.rb +3 -2
  101. data/lib/DealMakerAPI/models/v1_entities_investors.rb +3 -2
  102. data/lib/DealMakerAPI/models/v1_entities_subscription_agreement.rb +3 -2
  103. data/lib/DealMakerAPI/models/v1_entities_webhooks_deal.rb +241 -0
  104. data/lib/DealMakerAPI/models/v1_entities_webhooks_security_token.rb +221 -0
  105. data/lib/DealMakerAPI/models/v1_entities_webhooks_subscription.rb +270 -0
  106. data/lib/DealMakerAPI/models/v1_entities_webhooks_subscription_deal.rb +250 -0
  107. data/lib/DealMakerAPI/models/v1_entities_webhooks_subscription_deals.rb +219 -0
  108. data/lib/DealMakerAPI/version.rb +3 -3
  109. data/lib/DealMakerAPI.rb +43 -2
  110. data/spec/api/company_api_spec.rb +73 -0
  111. data/spec/api/deal_api_spec.rb +4 -47
  112. data/spec/api/deal_setup_api_spec.rb +47 -0
  113. data/spec/api/default_api_spec.rb +108 -0
  114. data/spec/api/investor_api_spec.rb +106 -0
  115. data/spec/api/investor_profile_api_spec.rb +109 -7
  116. data/spec/api_client_spec.rb +2 -2
  117. data/spec/configuration_spec.rb +2 -2
  118. data/spec/models/create_company_request_spec.rb +76 -0
  119. data/spec/models/create_corporation_profile_request_spec.rb +230 -0
  120. data/spec/models/create_deal_setup_request_spec.rb +82 -0
  121. data/spec/models/create_individual_profile_request_spec.rb +116 -0
  122. data/spec/models/create_investor_request_spec.rb +108 -0
  123. data/spec/models/create_joint_profile_request_spec.rb +192 -0
  124. data/spec/models/create_trust_profile_request_spec.rb +164 -0
  125. data/spec/models/patch_corporation_profile_request_spec.rb +158 -0
  126. data/spec/models/patch_individual_profile_request_spec.rb +110 -0
  127. data/spec/models/patch_investor_request_spec.rb +34 -0
  128. data/spec/models/patch_joint_profile_request_spec.rb +186 -0
  129. data/spec/models/patch_trust_profile_request_spec.rb +158 -0
  130. data/spec/models/post_webhooks_request_spec.rb +58 -0
  131. data/spec/models/put_webhooks_id_request_spec.rb +70 -0
  132. data/spec/models/update_investor_request_spec.rb +56 -0
  133. data/spec/models/v1_entities_address_spec.rb +64 -0
  134. data/spec/models/v1_entities_addresses_spec.rb +34 -0
  135. data/spec/models/v1_entities_attachment_spec.rb +2 -2
  136. data/spec/models/v1_entities_background_check_search_spec.rb +2 -2
  137. data/spec/models/v1_entities_company_deal_spec.rb +40 -0
  138. data/spec/models/v1_entities_company_deals_spec.rb +34 -0
  139. data/spec/models/v1_entities_company_spec.rb +82 -0
  140. data/spec/models/v1_entities_deal_enterprise_spec.rb +2 -2
  141. data/spec/models/v1_entities_deal_funding_metrics_spec.rb +2 -2
  142. data/spec/models/v1_entities_deal_investor_metrics_spec.rb +2 -2
  143. data/spec/models/v1_entities_deal_issuer_spec.rb +2 -2
  144. data/spec/models/v1_entities_deal_setup_spec.rb +82 -0
  145. data/spec/models/v1_entities_deal_setup_user_spec.rb +40 -0
  146. data/spec/models/v1_entities_deal_spec.rb +3 -3
  147. data/spec/models/v1_entities_deals_spec.rb +2 -2
  148. data/spec/models/v1_entities_investor_profile_address_spec.rb +64 -0
  149. data/spec/models/v1_entities_investor_profile_corporation_spec.rb +86 -0
  150. data/spec/models/v1_entities_investor_profile_fields_account_holder_spec.rb +64 -0
  151. data/spec/models/v1_entities_investor_profile_fields_corporation_spec.rb +52 -0
  152. data/spec/models/v1_entities_investor_profile_fields_primary_holder_spec.rb +70 -0
  153. data/spec/models/v1_entities_investor_profile_fields_trust_spec.rb +52 -0
  154. data/spec/models/v1_entities_investor_profile_individual_spec.rb +6 -36
  155. data/spec/models/v1_entities_investor_profile_item_spec.rb +34 -0
  156. data/spec/models/v1_entities_investor_profile_joint_spec.rb +86 -0
  157. data/spec/models/v1_entities_investor_profile_trust_spec.rb +80 -0
  158. data/spec/models/v1_entities_investor_profiles_spec.rb +34 -0
  159. data/spec/models/v1_entities_investor_spec.rb +22 -4
  160. data/spec/models/v1_entities_investor_user_spec.rb +2 -2
  161. data/spec/models/v1_entities_investors_spec.rb +2 -2
  162. data/spec/models/v1_entities_subscription_agreement_spec.rb +2 -2
  163. data/spec/models/v1_entities_webhooks_deal_spec.rb +46 -0
  164. data/spec/models/v1_entities_webhooks_security_token_spec.rb +34 -0
  165. data/spec/models/v1_entities_webhooks_subscription_deal_spec.rb +52 -0
  166. data/spec/models/v1_entities_webhooks_subscription_deals_spec.rb +34 -0
  167. data/spec/models/v1_entities_webhooks_subscription_spec.rb +64 -0
  168. data/spec/spec_helper.rb +2 -2
  169. metadata +176 -12
@@ -0,0 +1,30 @@
1
+ # DealMakerAPI::CreateDealSetupRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **invoicing_email** | **String** | The invoice email address. | |
8
+ | **issuer_industry** | **String** | The industry. | [optional][default to 'other'] |
9
+ | **prohibited_industry** | **String** | Determine if the deal is a high risk or not. | [optional][default to 'prohibited'] |
10
+ | **offering_type** | **String** | The deal kind | [default to 'other'] |
11
+ | **title** | **String** | The name of deal to setup. | |
12
+ | **company_id** | **Integer** | the company id. | |
13
+ | **representative** | **String** | The email of the representative. | [optional] |
14
+
15
+ ## Example
16
+
17
+ ```ruby
18
+ require 'DealMakerAPI'
19
+
20
+ instance = DealMakerAPI::CreateDealSetupRequest.new(
21
+ invoicing_email: null,
22
+ issuer_industry: null,
23
+ prohibited_industry: null,
24
+ offering_type: null,
25
+ title: null,
26
+ company_id: null,
27
+ representative: null
28
+ )
29
+ ```
30
+
@@ -0,0 +1,44 @@
1
+ # DealMakerAPI::CreateIndividualProfileRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **email** | **String** | User email which is associated with individual investor profile. | |
8
+ | **us_accredited_category** | **String** | The accredited investor information. | [optional] |
9
+ | **first_name** | **String** | The first name of the individual investor profile (required). | [optional] |
10
+ | **last_name** | **String** | The last name of the individual investor profile (required) | [optional] |
11
+ | **suffix** | **String** | The suffix of the individual investor profile | [optional] |
12
+ | **date_of_birth** | **String** | The date of birth of the investor profile (required) | [optional] |
13
+ | **taxpayer_id** | **String** | The taxpayer identification number of the investor profile (required) | [optional] |
14
+ | **phone_number** | **String** | The phone number of the investor profile (required) | [optional] |
15
+ | **country** | **String** | The country of the individual investor profile (required) | [optional] |
16
+ | **street_address** | **String** | The street address of the individual investor profile (required) | [optional] |
17
+ | **unit2** | **String** | The street address line 2 of the individual investor profile | [optional] |
18
+ | **city** | **String** | The city of the individual investor profile (required) | [optional] |
19
+ | **region** | **String** | The region or state of the individual investor profile (required) | [optional] |
20
+ | **postal_code** | **String** | The postal code or zipcode of the individual investor profile (required) | [optional] |
21
+
22
+ ## Example
23
+
24
+ ```ruby
25
+ require 'DealMakerAPI'
26
+
27
+ instance = DealMakerAPI::CreateIndividualProfileRequest.new(
28
+ email: null,
29
+ us_accredited_category: null,
30
+ first_name: null,
31
+ last_name: null,
32
+ suffix: null,
33
+ date_of_birth: null,
34
+ taxpayer_id: null,
35
+ phone_number: null,
36
+ country: null,
37
+ street_address: null,
38
+ unit2: null,
39
+ city: null,
40
+ region: null,
41
+ postal_code: null
42
+ )
43
+ ```
44
+
@@ -0,0 +1,40 @@
1
+ # DealMakerAPI::CreateInvestorRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **email** | **String** | The investor email address. | |
8
+ | **investor_profile_id** | **Integer** | The Investor Profile id. | [optional] |
9
+ | **tags** | **Array<String>** | | [optional] |
10
+ | **first_name** | **String** | The first name of the investor. | [optional] |
11
+ | **last_name** | **String** | The last name of the investor. | [optional] |
12
+ | **phone_number** | **String** | The phone number of the investor. | [optional] |
13
+ | **message** | **String** | The reminder email text of the investor. | [optional] |
14
+ | **warrant_expiry_date** | **Date** | The warrant expiry date of the investor. | [optional] |
15
+ | **warrant_certificate_number** | **Integer** | The certificate number of the investor. | [optional] |
16
+ | **allocated_amount** | **Float** | The allocation amount of the investor. | [optional] |
17
+ | **allocation_unit** | **String** | The allocation unit of the investor. | [optional][default to 'securities'] |
18
+ | **state** | **String** | The initial state of the investor. | [optional][default to 'invited'] |
19
+
20
+ ## Example
21
+
22
+ ```ruby
23
+ require 'DealMakerAPI'
24
+
25
+ instance = DealMakerAPI::CreateInvestorRequest.new(
26
+ email: null,
27
+ investor_profile_id: null,
28
+ tags: null,
29
+ first_name: null,
30
+ last_name: null,
31
+ phone_number: null,
32
+ message: null,
33
+ warrant_expiry_date: null,
34
+ warrant_certificate_number: null,
35
+ allocated_amount: null,
36
+ allocation_unit: null,
37
+ state: null
38
+ )
39
+ ```
40
+
@@ -0,0 +1,68 @@
1
+ # DealMakerAPI::CreateJointProfileRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **email** | **String** | User email which is associated with investor profile. | |
8
+ | **us_accredited_category** | **String** | The accredited investor information. | [optional] |
9
+ | **joint_type** | **String** | The types of joint investor. | [optional] |
10
+ | **first_name** | **String** | The first name of the primary holder (required). | [optional] |
11
+ | **last_name** | **String** | The last name of the primary holder (required). | [optional] |
12
+ | **suffix** | **String** | The suffix of the primary holder. | [optional] |
13
+ | **country** | **String** | The country the primary holder (required). | [optional] |
14
+ | **street_address** | **String** | The street address of the primary holder (required). | [optional] |
15
+ | **unit2** | **String** | The street address line 2 of the primary holder. | [optional] |
16
+ | **city** | **String** | The city of the primary holder (required). | [optional] |
17
+ | **region** | **String** | The region or State of the primary holder (required). | [optional] |
18
+ | **postal_code** | **String** | The postal code or zipcode of the primary holder (required). | [optional] |
19
+ | **date_of_birth** | **String** | The date of birth of the primary holder (required). | [optional] |
20
+ | **taxpayer_id** | **String** | The taxpayer identification number of the primary holder (required). | [optional] |
21
+ | **phone_number** | **String** | The phone number of the primary holder (required). | [optional] |
22
+ | **joint_holder_first_name** | **String** | The first name of the joint holder (required). | [optional] |
23
+ | **joint_holder_last_name** | **String** | The last name of the joint holder (required). | [optional] |
24
+ | **joint_holder_suffix** | **String** | The suffix of the joint holder. | [optional] |
25
+ | **joint_holder_country** | **String** | The country of the joint holder (required). | [optional] |
26
+ | **joint_holder_street_address** | **String** | The street address of the joint holder (required). | [optional] |
27
+ | **joint_holder_unit2** | **String** | The street address line 2 of the joint holder. | [optional] |
28
+ | **joint_holder_city** | **String** | The city of the joint holder (required). | [optional] |
29
+ | **joint_holder_region** | **String** | The region or state of the joint holder (required). | [optional] |
30
+ | **joint_holder_postal_code** | **String** | The postal code or zipcode of the joint holder (required). | [optional] |
31
+ | **joint_holder_date_of_birth** | **String** | The date of birth of the joint holder (required). | [optional] |
32
+ | **joint_holder_taxpayer_id** | **String** | The taxpayer identification number of the joint holder (required). | [optional] |
33
+
34
+ ## Example
35
+
36
+ ```ruby
37
+ require 'DealMakerAPI'
38
+
39
+ instance = DealMakerAPI::CreateJointProfileRequest.new(
40
+ email: null,
41
+ us_accredited_category: null,
42
+ joint_type: null,
43
+ first_name: null,
44
+ last_name: null,
45
+ suffix: null,
46
+ country: null,
47
+ street_address: null,
48
+ unit2: null,
49
+ city: null,
50
+ region: null,
51
+ postal_code: null,
52
+ date_of_birth: null,
53
+ taxpayer_id: null,
54
+ phone_number: null,
55
+ joint_holder_first_name: null,
56
+ joint_holder_last_name: null,
57
+ joint_holder_suffix: null,
58
+ joint_holder_country: null,
59
+ joint_holder_street_address: null,
60
+ joint_holder_unit2: null,
61
+ joint_holder_city: null,
62
+ joint_holder_region: null,
63
+ joint_holder_postal_code: null,
64
+ joint_holder_date_of_birth: null,
65
+ joint_holder_taxpayer_id: null
66
+ )
67
+ ```
68
+
@@ -0,0 +1,60 @@
1
+ # DealMakerAPI::CreateTrustProfileRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **email** | **String** | User email which is associated with investor profile (required). | |
8
+ | **us_accredited_category** | **String** | The accredited investor information. | [optional] |
9
+ | **name** | **String** | The name of the trust (required). | [optional] |
10
+ | **date** | **String** | The creation date of the trust (required). | [optional] |
11
+ | **country** | **String** | The country of the trust (required). | [optional] |
12
+ | **street_address** | **String** | Trust street address of the trust (required). | [optional] |
13
+ | **unit2** | **String** | The street address line 2 of the trust. | [optional] |
14
+ | **city** | **String** | The city of the trust (required). | [optional] |
15
+ | **region** | **String** | The region or state of the trust (required). | [optional] |
16
+ | **postal_code** | **String** | The postal code or zipcode of the trust (required). | [optional] |
17
+ | **phone_number** | **String** | The phone number of the trust (required). | [optional] |
18
+ | **trustees_first_name** | **Array<String>** | The list of first names for the trustees (required for trustee 1). | [optional] |
19
+ | **trustees_last_name** | **Array<String>** | The list of last names for the trustees (required for trustee 1). | [optional] |
20
+ | **trustees_suffix** | **Array<String>** | The list of suffixes for the trustees. | [optional] |
21
+ | **trustees_country** | **Array<String>** | The list of countries for the trustees (required for trustee 1). | [optional] |
22
+ | **trustees_street_address** | **Array<String>** | The list of street addresses for the trustees (required for trustee 1). | [optional] |
23
+ | **trustees_unit_2** | **Array<String>** | The list of street address line 2 for the trustees. | [optional] |
24
+ | **trustees_city** | **Array<String>** | The list of cities for the trustees (required for trustee 1). | [optional] |
25
+ | **trustees_region** | **Array<String>** | The list of regions or states for the trustees (required for trustee 1). | [optional] |
26
+ | **trustees_postal_code** | **Array<String>** | The list of postal codes or zipcodes for the trustees (required) for trustee 1. | [optional] |
27
+ | **trustees_date_of_birth** | **Array<String>** | The list of dates of birth for the trustees (required for trustee 1). | [optional] |
28
+ | **trustees_taxpayer_id** | **Array<String>** | The list of taxpayer identification numbers for the trustees (required for trustee 1). | [optional] |
29
+
30
+ ## Example
31
+
32
+ ```ruby
33
+ require 'DealMakerAPI'
34
+
35
+ instance = DealMakerAPI::CreateTrustProfileRequest.new(
36
+ email: null,
37
+ us_accredited_category: null,
38
+ name: null,
39
+ date: null,
40
+ country: null,
41
+ street_address: null,
42
+ unit2: null,
43
+ city: null,
44
+ region: null,
45
+ postal_code: null,
46
+ phone_number: null,
47
+ trustees_first_name: null,
48
+ trustees_last_name: null,
49
+ trustees_suffix: null,
50
+ trustees_country: null,
51
+ trustees_street_address: null,
52
+ trustees_unit_2: null,
53
+ trustees_city: null,
54
+ trustees_region: null,
55
+ trustees_postal_code: null,
56
+ trustees_date_of_birth: null,
57
+ trustees_taxpayer_id: null
58
+ )
59
+ ```
60
+
data/docs/DealApi.md CHANGED
@@ -4,88 +4,17 @@ All URIs are relative to *http://api.dealmaker.tech*
4
4
 
5
5
  | Method | HTTP request | Description |
6
6
  | ------ | ------------ | ----------- |
7
- | [**create_investor**](DealApi.md#create_investor) | **POST** /deals/{id}/investors | Create a deal investor |
8
- | [**get_deal**](DealApi.md#get_deal) | **GET** /deals/{id} | Get a deal by id |
9
- | [**get_investor**](DealApi.md#get_investor) | **GET** /deals/{id}/investors/{investor_id} | Get a deal investor by id |
7
+ | [**get_deal**](DealApi.md#get_deal) | **GET** /deals/{id} | Get deal by Deal ID |
10
8
  | [**list_deals**](DealApi.md#list_deals) | **GET** /deals | List available deals |
11
- | [**list_investors**](DealApi.md#list_investors) | **GET** /deals/{id}/investors | List deal investors |
12
-
13
-
14
- ## create_investor
15
-
16
- > <V1EntitiesInvestor> create_investor(id, unknown_base_type)
17
-
18
- Create a deal investor
19
-
20
- Create a single deal investor.
21
-
22
- ### Examples
23
-
24
- ```ruby
25
- require 'time'
26
- require 'DealMakerAPI'
27
- # setup authorization
28
- DealMakerAPI.configure do |config|end
29
-
30
- api_instance = DealMakerAPI::DealApi.new
31
- id = 56 # Integer | The deal id.
32
- unknown_base_type = TODO # UNKNOWN_BASE_TYPE |
33
-
34
- begin
35
- # Create a deal investor
36
- result = api_instance.create_investor(id, unknown_base_type)
37
- p result
38
- rescue DealMakerAPI::ApiError => e
39
- puts "Error when calling DealApi->create_investor: #{e}"
40
- end
41
- ```
42
-
43
- #### Using the create_investor_with_http_info variant
44
-
45
- This returns an Array which contains the response data, status code and headers.
46
-
47
- > <Array(<V1EntitiesInvestor>, Integer, Hash)> create_investor_with_http_info(id, unknown_base_type)
48
-
49
- ```ruby
50
- begin
51
- # Create a deal investor
52
- data, status_code, headers = api_instance.create_investor_with_http_info(id, unknown_base_type)
53
- p status_code # => 2xx
54
- p headers # => { ... }
55
- p data # => <V1EntitiesInvestor>
56
- rescue DealMakerAPI::ApiError => e
57
- puts "Error when calling DealApi->create_investor_with_http_info: #{e}"
58
- end
59
- ```
60
-
61
- ### Parameters
62
-
63
- | Name | Type | Description | Notes |
64
- | ---- | ---- | ----------- | ----- |
65
- | **id** | **Integer** | The deal id. | |
66
- | **unknown_base_type** | [**UNKNOWN_BASE_TYPE**](UNKNOWN_BASE_TYPE.md) | | |
67
-
68
- ### Return type
69
-
70
- [**V1EntitiesInvestor**](V1EntitiesInvestor.md)
71
-
72
- ### Authorization
73
-
74
- No authorization required
75
-
76
- ### HTTP request headers
77
-
78
- - **Content-Type**: application/json
79
- - **Accept**: application/json
80
9
 
81
10
 
82
11
  ## get_deal
83
12
 
84
13
  > <V1EntitiesDeal> get_deal(id)
85
14
 
86
- Get a deal by id
15
+ Get deal by Deal ID
87
16
 
88
- Get a deal
17
+ Gets a single deal using the Deal ID
89
18
 
90
19
  ### Examples
91
20
 
@@ -99,7 +28,7 @@ api_instance = DealMakerAPI::DealApi.new
99
28
  id = 56 # Integer | The deal id.
100
29
 
101
30
  begin
102
- # Get a deal by id
31
+ # Get deal by Deal ID
103
32
  result = api_instance.get_deal(id)
104
33
  p result
105
34
  rescue DealMakerAPI::ApiError => e
@@ -115,7 +44,7 @@ This returns an Array which contains the response data, status code and headers.
115
44
 
116
45
  ```ruby
117
46
  begin
118
- # Get a deal by id
47
+ # Get deal by Deal ID
119
48
  data, status_code, headers = api_instance.get_deal_with_http_info(id)
120
49
  p status_code # => 2xx
121
50
  p headers # => { ... }
@@ -145,74 +74,6 @@ No authorization required
145
74
  - **Accept**: application/json
146
75
 
147
76
 
148
- ## get_investor
149
-
150
- > <V1EntitiesInvestor> get_investor(id, investor_id)
151
-
152
- Get a deal investor by id
153
-
154
- Gets a single investor by the id.
155
-
156
- ### Examples
157
-
158
- ```ruby
159
- require 'time'
160
- require 'DealMakerAPI'
161
- # setup authorization
162
- DealMakerAPI.configure do |config|end
163
-
164
- api_instance = DealMakerAPI::DealApi.new
165
- id = 56 # Integer | The deal id.
166
- investor_id = 56 # Integer | The investor id.
167
-
168
- begin
169
- # Get a deal investor by id
170
- result = api_instance.get_investor(id, investor_id)
171
- p result
172
- rescue DealMakerAPI::ApiError => e
173
- puts "Error when calling DealApi->get_investor: #{e}"
174
- end
175
- ```
176
-
177
- #### Using the get_investor_with_http_info variant
178
-
179
- This returns an Array which contains the response data, status code and headers.
180
-
181
- > <Array(<V1EntitiesInvestor>, Integer, Hash)> get_investor_with_http_info(id, investor_id)
182
-
183
- ```ruby
184
- begin
185
- # Get a deal investor by id
186
- data, status_code, headers = api_instance.get_investor_with_http_info(id, investor_id)
187
- p status_code # => 2xx
188
- p headers # => { ... }
189
- p data # => <V1EntitiesInvestor>
190
- rescue DealMakerAPI::ApiError => e
191
- puts "Error when calling DealApi->get_investor_with_http_info: #{e}"
192
- end
193
- ```
194
-
195
- ### Parameters
196
-
197
- | Name | Type | Description | Notes |
198
- | ---- | ---- | ----------- | ----- |
199
- | **id** | **Integer** | The deal id. | |
200
- | **investor_id** | **Integer** | The investor id. | |
201
-
202
- ### Return type
203
-
204
- [**V1EntitiesInvestor**](V1EntitiesInvestor.md)
205
-
206
- ### Authorization
207
-
208
- No authorization required
209
-
210
- ### HTTP request headers
211
-
212
- - **Content-Type**: Not defined
213
- - **Accept**: application/json
214
-
215
-
216
77
  ## list_deals
217
78
 
218
79
  > <V1EntitiesDeals> list_deals(opts)
@@ -284,81 +145,3 @@ No authorization required
284
145
  - **Content-Type**: Not defined
285
146
  - **Accept**: application/json
286
147
 
287
-
288
- ## list_investors
289
-
290
- > <V1EntitiesInvestors> list_investors(id, opts)
291
-
292
- List deal investors
293
-
294
- List deal investors according to the specified search criteria.
295
-
296
- ### Examples
297
-
298
- ```ruby
299
- require 'time'
300
- require 'DealMakerAPI'
301
- # setup authorization
302
- DealMakerAPI.configure do |config|end
303
-
304
- api_instance = DealMakerAPI::DealApi.new
305
- id = 56 # Integer | The deal id.
306
- opts = {
307
- page: 56, # Integer | Page offset to fetch.
308
- per_page: 56, # Integer | Number of results to return per page.
309
- offset: 56, # Integer | Pad a number of results.
310
- investor_ids: [37], # Array<Integer> | An array of investor ids.
311
- q: 'q_example' # String | The search query for investors. For additional information on filtering and seach, click [here](#section/Search-and-Filtering-(The-q-parameter)/Keyword-filtering)
312
- }
313
-
314
- begin
315
- # List deal investors
316
- result = api_instance.list_investors(id, opts)
317
- p result
318
- rescue DealMakerAPI::ApiError => e
319
- puts "Error when calling DealApi->list_investors: #{e}"
320
- end
321
- ```
322
-
323
- #### Using the list_investors_with_http_info variant
324
-
325
- This returns an Array which contains the response data, status code and headers.
326
-
327
- > <Array(<V1EntitiesInvestors>, Integer, Hash)> list_investors_with_http_info(id, opts)
328
-
329
- ```ruby
330
- begin
331
- # List deal investors
332
- data, status_code, headers = api_instance.list_investors_with_http_info(id, opts)
333
- p status_code # => 2xx
334
- p headers # => { ... }
335
- p data # => <V1EntitiesInvestors>
336
- rescue DealMakerAPI::ApiError => e
337
- puts "Error when calling DealApi->list_investors_with_http_info: #{e}"
338
- end
339
- ```
340
-
341
- ### Parameters
342
-
343
- | Name | Type | Description | Notes |
344
- | ---- | ---- | ----------- | ----- |
345
- | **id** | **Integer** | The deal id. | |
346
- | **page** | **Integer** | Page offset to fetch. | [optional][default to 1] |
347
- | **per_page** | **Integer** | Number of results to return per page. | [optional][default to 25] |
348
- | **offset** | **Integer** | Pad a number of results. | [optional][default to 0] |
349
- | **investor_ids** | [**Array&lt;Integer&gt;**](Integer.md) | An array of investor ids. | [optional] |
350
- | **q** | **String** | The search query for investors. For additional information on filtering and seach, click [here](#section/Search-and-Filtering-(The-q-parameter)/Keyword-filtering) | [optional] |
351
-
352
- ### Return type
353
-
354
- [**V1EntitiesInvestors**](V1EntitiesInvestors.md)
355
-
356
- ### Authorization
357
-
358
- No authorization required
359
-
360
- ### HTTP request headers
361
-
362
- - **Content-Type**: Not defined
363
- - **Accept**: application/json
364
-
@@ -0,0 +1,74 @@
1
+ # DealMakerAPI::DealSetupApi
2
+
3
+ All URIs are relative to *http://api.dealmaker.tech*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**create_deal_setup**](DealSetupApi.md#create_deal_setup) | **POST** /deal_setups | Create deal setup |
8
+
9
+
10
+ ## create_deal_setup
11
+
12
+ > <V1EntitiesDealSetup> create_deal_setup(create_deal_setup_request)
13
+
14
+ Create deal setup
15
+
16
+ Create deal setup
17
+
18
+ ### Examples
19
+
20
+ ```ruby
21
+ require 'time'
22
+ require 'DealMakerAPI'
23
+ # setup authorization
24
+ DealMakerAPI.configure do |config|end
25
+
26
+ api_instance = DealMakerAPI::DealSetupApi.new
27
+ create_deal_setup_request = DealMakerAPI::CreateDealSetupRequest.new({invoicing_email: 'invoicing_email_example', offering_type: 'other', title: 'title_example', company_id: 37}) # CreateDealSetupRequest |
28
+
29
+ begin
30
+ # Create deal setup
31
+ result = api_instance.create_deal_setup(create_deal_setup_request)
32
+ p result
33
+ rescue DealMakerAPI::ApiError => e
34
+ puts "Error when calling DealSetupApi->create_deal_setup: #{e}"
35
+ end
36
+ ```
37
+
38
+ #### Using the create_deal_setup_with_http_info variant
39
+
40
+ This returns an Array which contains the response data, status code and headers.
41
+
42
+ > <Array(<V1EntitiesDealSetup>, Integer, Hash)> create_deal_setup_with_http_info(create_deal_setup_request)
43
+
44
+ ```ruby
45
+ begin
46
+ # Create deal setup
47
+ data, status_code, headers = api_instance.create_deal_setup_with_http_info(create_deal_setup_request)
48
+ p status_code # => 2xx
49
+ p headers # => { ... }
50
+ p data # => <V1EntitiesDealSetup>
51
+ rescue DealMakerAPI::ApiError => e
52
+ puts "Error when calling DealSetupApi->create_deal_setup_with_http_info: #{e}"
53
+ end
54
+ ```
55
+
56
+ ### Parameters
57
+
58
+ | Name | Type | Description | Notes |
59
+ | ---- | ---- | ----------- | ----- |
60
+ | **create_deal_setup_request** | [**CreateDealSetupRequest**](CreateDealSetupRequest.md) | | |
61
+
62
+ ### Return type
63
+
64
+ [**V1EntitiesDealSetup**](V1EntitiesDealSetup.md)
65
+
66
+ ### Authorization
67
+
68
+ No authorization required
69
+
70
+ ### HTTP request headers
71
+
72
+ - **Content-Type**: application/json
73
+ - **Accept**: application/json
74
+