DealMakerAPI 0.85.2 → 0.85.4

Sign up to get free protection for your applications and to get access to all the features.
Files changed (200) hide show
  1. checksums.yaml +4 -4
  2. data/DealMakerAPI.gemspec +1 -1
  3. data/README.md +16 -12
  4. data/docs/InvestorProfileApi.md +48 -54
  5. data/docs/{PatchCorporationProfileRequest.md → PatchInvestorProfilesCorporations.md} +6 -32
  6. data/docs/PatchInvestorProfilesCorporationsBeneficialOwnersInner.md +42 -0
  7. data/docs/{PatchIndividualProfileRequest.md → PatchInvestorProfilesIndividuals.md} +2 -4
  8. data/docs/{PatchJointProfileRequest.md → PatchInvestorProfilesJoints.md} +2 -6
  9. data/docs/{PatchTrustProfileRequest.md → PatchInvestorProfilesTrusts.md} +2 -6
  10. data/docs/{CreateCorporationProfileRequest.md → PostInvestorProfilesCorporations.md} +6 -28
  11. data/docs/PostInvestorProfilesCorporationsBeneficialOwnersInner.md +38 -0
  12. data/docs/{CreateIndividualProfileRequest.md → PostInvestorProfilesIndividuals.md} +2 -4
  13. data/docs/{CreateJointProfileRequest.md → PostInvestorProfilesJoints.md} +2 -6
  14. data/docs/PostInvestorProfilesTrusts.md +46 -0
  15. data/docs/PostInvestorProfilesTrustsTrusteesInner.md +36 -0
  16. data/docs/V1EntitiesInvestorProfileCorporation.md +2 -2
  17. data/docs/V1EntitiesInvestorProfileFieldsSigningOfficer.md +30 -0
  18. data/lib/DealMakerAPI/api/company_api.rb +1 -1
  19. data/lib/DealMakerAPI/api/deal_api.rb +1 -1
  20. data/lib/DealMakerAPI/api/deal_setup_api.rb +1 -1
  21. data/lib/DealMakerAPI/api/deals_api.rb +1 -1
  22. data/lib/DealMakerAPI/api/default_api.rb +1 -1
  23. data/lib/DealMakerAPI/api/investor_api.rb +1 -1
  24. data/lib/DealMakerAPI/api/investor_profile_api.rb +76 -64
  25. data/lib/DealMakerAPI/api/shareholder_api.rb +1 -1
  26. data/lib/DealMakerAPI/api/upload_api.rb +1 -1
  27. data/lib/DealMakerAPI/api_client.rb +1 -1
  28. data/lib/DealMakerAPI/api_error.rb +1 -1
  29. data/lib/DealMakerAPI/configuration.rb +3 -3
  30. data/lib/DealMakerAPI/models/add506c_document_request.rb +1 -1
  31. data/lib/DealMakerAPI/models/add_document_request.rb +1 -1
  32. data/lib/DealMakerAPI/models/bulk_upload_investors_request.rb +1 -1
  33. data/lib/DealMakerAPI/models/create_bulk_upload_detail_request.rb +1 -1
  34. data/lib/DealMakerAPI/models/create_bulk_upload_request.rb +1 -1
  35. data/lib/DealMakerAPI/models/create_company_request.rb +1 -1
  36. data/lib/DealMakerAPI/models/create_deal_setup_request.rb +1 -1
  37. data/lib/DealMakerAPI/models/create_investor_request.rb +1 -1
  38. data/lib/DealMakerAPI/models/create_shareholder_action_request.rb +1 -1
  39. data/lib/DealMakerAPI/models/edit_investor_tags_request.rb +1 -1
  40. data/lib/DealMakerAPI/models/generate_url_request.rb +1 -1
  41. data/lib/DealMakerAPI/models/patch_investor_profiles_corporations.rb +503 -0
  42. data/lib/DealMakerAPI/models/patch_investor_profiles_corporations_beneficial_owners_inner.rb +342 -0
  43. data/lib/DealMakerAPI/models/{patch_individual_profile_request.rb → patch_investor_profiles_individuals.rb} +6 -15
  44. data/lib/DealMakerAPI/models/{patch_joint_profile_request.rb → patch_investor_profiles_joints.rb} +6 -25
  45. data/lib/DealMakerAPI/models/{patch_trust_profile_request.rb → patch_investor_profiles_trusts.rb} +6 -25
  46. data/lib/DealMakerAPI/models/patch_investor_request.rb +1 -1
  47. data/lib/DealMakerAPI/models/{create_corporation_profile_request.rb → post_investor_profiles_corporations.rb} +22 -152
  48. data/lib/DealMakerAPI/models/post_investor_profiles_corporations_beneficial_owners_inner.rb +315 -0
  49. data/lib/DealMakerAPI/models/{create_individual_profile_request.rb → post_investor_profiles_individuals.rb} +6 -15
  50. data/lib/DealMakerAPI/models/{create_joint_profile_request.rb → post_investor_profiles_joints.rb} +6 -25
  51. data/lib/DealMakerAPI/models/{create_trust_profile_request.rb → post_investor_profiles_trusts.rb} +13 -143
  52. data/lib/DealMakerAPI/models/post_investor_profiles_trusts_trustees_inner.rb +305 -0
  53. data/lib/DealMakerAPI/models/post_webhooks_request.rb +1 -1
  54. data/lib/DealMakerAPI/models/put_deals_id_script_tag_environment_request.rb +1 -1
  55. data/lib/DealMakerAPI/models/put_webhooks_id_request.rb +1 -1
  56. data/lib/DealMakerAPI/models/update_investor_request.rb +1 -1
  57. data/lib/DealMakerAPI/models/v1_entities_address.rb +1 -1
  58. data/lib/DealMakerAPI/models/v1_entities_addresses.rb +1 -1
  59. data/lib/DealMakerAPI/models/v1_entities_attachment.rb +1 -1
  60. data/lib/DealMakerAPI/models/v1_entities_background_check_search.rb +1 -1
  61. data/lib/DealMakerAPI/models/v1_entities_bulk_upload.rb +1 -1
  62. data/lib/DealMakerAPI/models/v1_entities_bulk_upload_detail.rb +1 -1
  63. data/lib/DealMakerAPI/models/v1_entities_bulk_upload_details.rb +1 -1
  64. data/lib/DealMakerAPI/models/v1_entities_bulk_uploads.rb +1 -1
  65. data/lib/DealMakerAPI/models/v1_entities_company.rb +1 -1
  66. data/lib/DealMakerAPI/models/v1_entities_company_deal.rb +1 -1
  67. data/lib/DealMakerAPI/models/v1_entities_company_deals.rb +1 -1
  68. data/lib/DealMakerAPI/models/v1_entities_deal.rb +1 -1
  69. data/lib/DealMakerAPI/models/v1_entities_deal_enterprise.rb +1 -1
  70. data/lib/DealMakerAPI/models/v1_entities_deal_funding_metrics.rb +1 -1
  71. data/lib/DealMakerAPI/models/v1_entities_deal_investor_metrics.rb +1 -1
  72. data/lib/DealMakerAPI/models/v1_entities_deal_issuer.rb +1 -1
  73. data/lib/DealMakerAPI/models/v1_entities_deal_setup.rb +1 -1
  74. data/lib/DealMakerAPI/models/v1_entities_deal_setup_user.rb +1 -1
  75. data/lib/DealMakerAPI/models/v1_entities_deals.rb +1 -1
  76. data/lib/DealMakerAPI/models/v1_entities_express_wire_instruction.rb +1 -1
  77. data/lib/DealMakerAPI/models/v1_entities_express_wire_instructions.rb +1 -1
  78. data/lib/DealMakerAPI/models/v1_entities_generic_response.rb +1 -1
  79. data/lib/DealMakerAPI/models/v1_entities_investor.rb +1 -1
  80. data/lib/DealMakerAPI/models/v1_entities_investor_otp_access_link.rb +1 -1
  81. data/lib/DealMakerAPI/models/v1_entities_investor_profile_address.rb +1 -1
  82. data/lib/DealMakerAPI/models/v1_entities_investor_profile_corporation.rb +3 -3
  83. data/lib/DealMakerAPI/models/v1_entities_investor_profile_fields_account_holder.rb +1 -1
  84. data/lib/DealMakerAPI/models/v1_entities_investor_profile_fields_corporation.rb +1 -1
  85. data/lib/DealMakerAPI/models/v1_entities_investor_profile_fields_primary_holder.rb +1 -1
  86. data/lib/DealMakerAPI/models/v1_entities_investor_profile_fields_signing_officer.rb +274 -0
  87. data/lib/DealMakerAPI/models/v1_entities_investor_profile_fields_trust.rb +1 -1
  88. data/lib/DealMakerAPI/models/v1_entities_investor_profile_individual.rb +1 -1
  89. data/lib/DealMakerAPI/models/v1_entities_investor_profile_item.rb +1 -1
  90. data/lib/DealMakerAPI/models/v1_entities_investor_profile_joint.rb +1 -1
  91. data/lib/DealMakerAPI/models/v1_entities_investor_profile_owner.rb +1 -1
  92. data/lib/DealMakerAPI/models/v1_entities_investor_profile_trust.rb +1 -1
  93. data/lib/DealMakerAPI/models/v1_entities_investor_profiles.rb +1 -1
  94. data/lib/DealMakerAPI/models/v1_entities_investor_user.rb +1 -1
  95. data/lib/DealMakerAPI/models/v1_entities_investors.rb +1 -1
  96. data/lib/DealMakerAPI/models/v1_entities_presigned_url_result.rb +1 -1
  97. data/lib/DealMakerAPI/models/v1_entities_shareholder.rb +1 -1
  98. data/lib/DealMakerAPI/models/v1_entities_shareholders.rb +1 -1
  99. data/lib/DealMakerAPI/models/v1_entities_shareholders_tags.rb +1 -1
  100. data/lib/DealMakerAPI/models/v1_entities_subscription_agreement.rb +1 -1
  101. data/lib/DealMakerAPI/models/v1_entities_webhooks_deal.rb +1 -1
  102. data/lib/DealMakerAPI/models/v1_entities_webhooks_security_token.rb +1 -1
  103. data/lib/DealMakerAPI/models/v1_entities_webhooks_subscription.rb +1 -1
  104. data/lib/DealMakerAPI/models/v1_entities_webhooks_subscription_deal.rb +1 -1
  105. data/lib/DealMakerAPI/models/v1_entities_webhooks_subscription_deals.rb +1 -1
  106. data/lib/DealMakerAPI/version.rb +2 -2
  107. data/lib/DealMakerAPI.rb +13 -9
  108. data/spec/api/company_api_spec.rb +1 -1
  109. data/spec/api/deal_api_spec.rb +1 -1
  110. data/spec/api/deal_setup_api_spec.rb +1 -1
  111. data/spec/api/deals_api_spec.rb +1 -1
  112. data/spec/api/default_api_spec.rb +1 -1
  113. data/spec/api/investor_api_spec.rb +1 -1
  114. data/spec/api/investor_profile_api_spec.rb +9 -9
  115. data/spec/api/shareholder_api_spec.rb +1 -1
  116. data/spec/api/upload_api_spec.rb +1 -1
  117. data/spec/api_client_spec.rb +1 -1
  118. data/spec/configuration_spec.rb +1 -1
  119. data/spec/models/add506c_document_request_spec.rb +1 -1
  120. data/spec/models/add_document_request_spec.rb +1 -1
  121. data/spec/models/bulk_upload_investors_request_spec.rb +1 -1
  122. data/spec/models/create_bulk_upload_detail_request_spec.rb +1 -1
  123. data/spec/models/create_bulk_upload_request_spec.rb +1 -1
  124. data/spec/models/create_company_request_spec.rb +1 -1
  125. data/spec/models/create_deal_setup_request_spec.rb +1 -1
  126. data/spec/models/create_investor_request_spec.rb +1 -1
  127. data/spec/models/create_shareholder_action_request_spec.rb +1 -1
  128. data/spec/models/edit_investor_tags_request_spec.rb +1 -1
  129. data/spec/models/generate_url_request_spec.rb +1 -1
  130. data/spec/models/patch_investor_profiles_corporations_beneficial_owners_inner_spec.rb +106 -0
  131. data/spec/models/patch_investor_profiles_corporations_spec.rb +186 -0
  132. data/spec/models/{create_individual_profile_request_spec.rb → patch_investor_profiles_individuals_spec.rb} +7 -19
  133. data/spec/models/{create_joint_profile_request_spec.rb → patch_investor_profiles_joints_spec.rb} +7 -25
  134. data/spec/models/{patch_trust_profile_request_spec.rb → patch_investor_profiles_trusts_spec.rb} +7 -19
  135. data/spec/models/patch_investor_request_spec.rb +1 -1
  136. data/spec/models/post_investor_profiles_corporations_beneficial_owners_inner_spec.rb +94 -0
  137. data/spec/models/{create_trust_profile_request_spec.rb → post_investor_profiles_corporations_spec.rb} +31 -31
  138. data/spec/models/{patch_individual_profile_request_spec.rb → post_investor_profiles_individuals_spec.rb} +13 -13
  139. data/spec/models/{patch_joint_profile_request_spec.rb → post_investor_profiles_joints_spec.rb} +13 -19
  140. data/spec/models/post_investor_profiles_trusts_spec.rb +126 -0
  141. data/spec/models/post_investor_profiles_trusts_trustees_inner_spec.rb +88 -0
  142. data/spec/models/post_webhooks_request_spec.rb +1 -1
  143. data/spec/models/put_deals_id_script_tag_environment_request_spec.rb +1 -1
  144. data/spec/models/put_webhooks_id_request_spec.rb +1 -1
  145. data/spec/models/update_investor_request_spec.rb +1 -1
  146. data/spec/models/v1_entities_address_spec.rb +1 -1
  147. data/spec/models/v1_entities_addresses_spec.rb +1 -1
  148. data/spec/models/v1_entities_attachment_spec.rb +1 -1
  149. data/spec/models/v1_entities_background_check_search_spec.rb +1 -1
  150. data/spec/models/v1_entities_bulk_upload_detail_spec.rb +1 -1
  151. data/spec/models/v1_entities_bulk_upload_details_spec.rb +1 -1
  152. data/spec/models/v1_entities_bulk_upload_spec.rb +1 -1
  153. data/spec/models/v1_entities_bulk_uploads_spec.rb +1 -1
  154. data/spec/models/v1_entities_company_deal_spec.rb +1 -1
  155. data/spec/models/v1_entities_company_deals_spec.rb +1 -1
  156. data/spec/models/v1_entities_company_spec.rb +1 -1
  157. data/spec/models/v1_entities_deal_enterprise_spec.rb +1 -1
  158. data/spec/models/v1_entities_deal_funding_metrics_spec.rb +1 -1
  159. data/spec/models/v1_entities_deal_investor_metrics_spec.rb +1 -1
  160. data/spec/models/v1_entities_deal_issuer_spec.rb +1 -1
  161. data/spec/models/v1_entities_deal_setup_spec.rb +1 -1
  162. data/spec/models/v1_entities_deal_setup_user_spec.rb +1 -1
  163. data/spec/models/v1_entities_deal_spec.rb +1 -1
  164. data/spec/models/v1_entities_deals_spec.rb +1 -1
  165. data/spec/models/v1_entities_express_wire_instruction_spec.rb +1 -1
  166. data/spec/models/v1_entities_express_wire_instructions_spec.rb +1 -1
  167. data/spec/models/v1_entities_generic_response_spec.rb +1 -1
  168. data/spec/models/v1_entities_investor_otp_access_link_spec.rb +1 -1
  169. data/spec/models/v1_entities_investor_profile_address_spec.rb +1 -1
  170. data/spec/models/v1_entities_investor_profile_corporation_spec.rb +1 -1
  171. data/spec/models/v1_entities_investor_profile_fields_account_holder_spec.rb +1 -1
  172. data/spec/models/v1_entities_investor_profile_fields_corporation_spec.rb +1 -1
  173. data/spec/models/v1_entities_investor_profile_fields_primary_holder_spec.rb +1 -1
  174. data/spec/models/v1_entities_investor_profile_fields_signing_officer_spec.rb +70 -0
  175. data/spec/models/v1_entities_investor_profile_fields_trust_spec.rb +1 -1
  176. data/spec/models/v1_entities_investor_profile_individual_spec.rb +1 -1
  177. data/spec/models/v1_entities_investor_profile_item_spec.rb +1 -1
  178. data/spec/models/v1_entities_investor_profile_joint_spec.rb +1 -1
  179. data/spec/models/v1_entities_investor_profile_owner_spec.rb +1 -1
  180. data/spec/models/v1_entities_investor_profile_trust_spec.rb +1 -1
  181. data/spec/models/v1_entities_investor_profiles_spec.rb +1 -1
  182. data/spec/models/v1_entities_investor_spec.rb +1 -1
  183. data/spec/models/v1_entities_investor_user_spec.rb +1 -1
  184. data/spec/models/v1_entities_investors_spec.rb +1 -1
  185. data/spec/models/v1_entities_presigned_url_result_spec.rb +1 -1
  186. data/spec/models/v1_entities_shareholder_spec.rb +1 -1
  187. data/spec/models/v1_entities_shareholders_spec.rb +1 -1
  188. data/spec/models/v1_entities_shareholders_tags_spec.rb +1 -1
  189. data/spec/models/v1_entities_subscription_agreement_spec.rb +1 -1
  190. data/spec/models/v1_entities_webhooks_deal_spec.rb +1 -1
  191. data/spec/models/v1_entities_webhooks_security_token_spec.rb +1 -1
  192. data/spec/models/v1_entities_webhooks_subscription_deal_spec.rb +1 -1
  193. data/spec/models/v1_entities_webhooks_subscription_deals_spec.rb +1 -1
  194. data/spec/models/v1_entities_webhooks_subscription_spec.rb +1 -1
  195. data/spec/spec_helper.rb +1 -1
  196. metadata +50 -34
  197. data/docs/CreateTrustProfileRequest.md +0 -68
  198. data/lib/DealMakerAPI/models/patch_corporation_profile_request.rb +0 -664
  199. data/spec/models/create_corporation_profile_request_spec.rb +0 -258
  200. data/spec/models/patch_corporation_profile_request_spec.rb +0 -264
@@ -6,7 +6,7 @@
6
6
  The version of the OpenAPI document: 1.75.0
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 7.0.0-SNAPSHOT
9
+ OpenAPI Generator version: 7.0.1-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -14,15 +14,15 @@ require 'spec_helper'
14
14
  require 'json'
15
15
  require 'date'
16
16
 
17
- # Unit tests for DealMakerAPI::CreateTrustProfileRequest
17
+ # Unit tests for DealMakerAPI::PostInvestorProfilesCorporations
18
18
  # Automatically generated by openapi-generator (https://openapi-generator.tech)
19
19
  # Please update as you see appropriate
20
- describe DealMakerAPI::CreateTrustProfileRequest do
21
- let(:instance) { DealMakerAPI::CreateTrustProfileRequest.new }
20
+ describe DealMakerAPI::PostInvestorProfilesCorporations do
21
+ let(:instance) { DealMakerAPI::PostInvestorProfilesCorporations.new }
22
22
 
23
- describe 'test an instance of CreateTrustProfileRequest' do
24
- it 'should create an instance of CreateTrustProfileRequest' do
25
- expect(instance).to be_instance_of(DealMakerAPI::CreateTrustProfileRequest)
23
+ describe 'test an instance of PostInvestorProfilesCorporations' do
24
+ it 'should create an instance of PostInvestorProfilesCorporations' do
25
+ expect(instance).to be_instance_of(DealMakerAPI::PostInvestorProfilesCorporations)
26
26
  end
27
27
  end
28
28
  describe 'test attribute "email"' do
@@ -34,7 +34,7 @@ describe DealMakerAPI::CreateTrustProfileRequest do
34
34
  describe 'test attribute "us_accredited_category"' do
35
35
  it 'should work' do
36
36
  # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
37
- # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["entity_owned_by_accredited_investors", "broker_or_dealer", "assets_trust", "not_accredited"])
37
+ # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["entity_owned_by_accredited_investors", "assets_other", "assets_family_office", "assets_benefit_plan", "assets_state_plan", "assets_501_c_3", "assets_corporation", "broker_or_dealer", "bank_3_a_2", "business_development_company", "small_business", "private_business_development_company", "investment_company", "rural_business_investment_company", "insurance_company", "family_client", "not_accredited"])
38
38
  # validator.allowable_values.each do |value|
39
39
  # expect { instance.us_accredited_category = value }.not_to raise_error
40
40
  # end
@@ -44,7 +44,7 @@ describe DealMakerAPI::CreateTrustProfileRequest do
44
44
  describe 'test attribute "ca_accredited_investor"' do
45
45
  it 'should work' do
46
46
  # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
47
- # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["p", "w"])
47
+ # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["a", "b", "c", "d", "f", "g", "h", "i", "m", "n", "o", "p", "q", "r", "s", "t", "u", "v", "x"])
48
48
  # validator.allowable_values.each do |value|
49
49
  # expect { instance.ca_accredited_investor = value }.not_to raise_error
50
50
  # end
@@ -57,133 +57,133 @@ describe DealMakerAPI::CreateTrustProfileRequest do
57
57
  end
58
58
  end
59
59
 
60
- describe 'test attribute "date"' do
60
+ describe 'test attribute "street_address"' do
61
61
  it 'should work' do
62
62
  # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
63
63
  end
64
64
  end
65
65
 
66
- describe 'test attribute "country"' do
66
+ describe 'test attribute "unit2"' do
67
67
  it 'should work' do
68
68
  # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
69
69
  end
70
70
  end
71
71
 
72
- describe 'test attribute "street_address"' do
72
+ describe 'test attribute "city"' do
73
73
  it 'should work' do
74
74
  # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
75
75
  end
76
76
  end
77
77
 
78
- describe 'test attribute "unit2"' do
78
+ describe 'test attribute "region"' do
79
79
  it 'should work' do
80
80
  # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
81
81
  end
82
82
  end
83
83
 
84
- describe 'test attribute "city"' do
84
+ describe 'test attribute "postal_code"' do
85
85
  it 'should work' do
86
86
  # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
87
87
  end
88
88
  end
89
89
 
90
- describe 'test attribute "region"' do
90
+ describe 'test attribute "business_number"' do
91
91
  it 'should work' do
92
92
  # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
93
93
  end
94
94
  end
95
95
 
96
- describe 'test attribute "postal_code"' do
96
+ describe 'test attribute "phone_number"' do
97
97
  it 'should work' do
98
98
  # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
99
99
  end
100
100
  end
101
101
 
102
- describe 'test attribute "phone_number"' do
102
+ describe 'test attribute "income"' do
103
103
  it 'should work' do
104
104
  # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
105
105
  end
106
106
  end
107
107
 
108
- describe 'test attribute "income"' do
108
+ describe 'test attribute "net_worth"' do
109
109
  it 'should work' do
110
110
  # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
111
111
  end
112
112
  end
113
113
 
114
- describe 'test attribute "net_worth"' do
114
+ describe 'test attribute "reg_cf_prior_offerings_amount"' do
115
115
  it 'should work' do
116
116
  # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
117
117
  end
118
118
  end
119
119
 
120
- describe 'test attribute "reg_cf_prior_offerings_amount"' do
120
+ describe 'test attribute "signing_officer_first_name"' do
121
121
  it 'should work' do
122
122
  # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
123
123
  end
124
124
  end
125
125
 
126
- describe 'test attribute "trustees_first_name"' do
126
+ describe 'test attribute "signing_officer_last_name"' do
127
127
  it 'should work' do
128
128
  # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
129
129
  end
130
130
  end
131
131
 
132
- describe 'test attribute "trustees_last_name"' do
132
+ describe 'test attribute "signing_officer_suffix"' do
133
133
  it 'should work' do
134
134
  # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
135
135
  end
136
136
  end
137
137
 
138
- describe 'test attribute "trustees_suffix"' do
138
+ describe 'test attribute "signing_officer_street_address"' do
139
139
  it 'should work' do
140
140
  # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
141
141
  end
142
142
  end
143
143
 
144
- describe 'test attribute "trustees_country"' do
144
+ describe 'test attribute "signing_officer_unit2"' do
145
145
  it 'should work' do
146
146
  # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
147
147
  end
148
148
  end
149
149
 
150
- describe 'test attribute "trustees_street_address"' do
150
+ describe 'test attribute "signing_officer_city"' do
151
151
  it 'should work' do
152
152
  # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
153
153
  end
154
154
  end
155
155
 
156
- describe 'test attribute "trustees_unit2"' do
156
+ describe 'test attribute "signing_officer_region"' do
157
157
  it 'should work' do
158
158
  # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
159
159
  end
160
160
  end
161
161
 
162
- describe 'test attribute "trustees_city"' do
162
+ describe 'test attribute "signing_officer_postal_code"' do
163
163
  it 'should work' do
164
164
  # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
165
165
  end
166
166
  end
167
167
 
168
- describe 'test attribute "trustees_region"' do
168
+ describe 'test attribute "signing_officer_date_of_birth"' do
169
169
  it 'should work' do
170
170
  # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
171
171
  end
172
172
  end
173
173
 
174
- describe 'test attribute "trustees_postal_code"' do
174
+ describe 'test attribute "signing_officer_taxpayer_id"' do
175
175
  it 'should work' do
176
176
  # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
177
177
  end
178
178
  end
179
179
 
180
- describe 'test attribute "trustees_date_of_birth"' do
180
+ describe 'test attribute "signing_officer_phone_number"' do
181
181
  it 'should work' do
182
182
  # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
183
183
  end
184
184
  end
185
185
 
186
- describe 'test attribute "trustees_taxpayer_id"' do
186
+ describe 'test attribute "beneficial_owners"' do
187
187
  it 'should work' do
188
188
  # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
189
189
  end
@@ -6,7 +6,7 @@
6
6
  The version of the OpenAPI document: 1.75.0
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 7.0.0-SNAPSHOT
9
+ OpenAPI Generator version: 7.0.1-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -14,17 +14,23 @@ require 'spec_helper'
14
14
  require 'json'
15
15
  require 'date'
16
16
 
17
- # Unit tests for DealMakerAPI::PatchIndividualProfileRequest
17
+ # Unit tests for DealMakerAPI::PostInvestorProfilesIndividuals
18
18
  # Automatically generated by openapi-generator (https://openapi-generator.tech)
19
19
  # Please update as you see appropriate
20
- describe DealMakerAPI::PatchIndividualProfileRequest do
21
- let(:instance) { DealMakerAPI::PatchIndividualProfileRequest.new }
20
+ describe DealMakerAPI::PostInvestorProfilesIndividuals do
21
+ let(:instance) { DealMakerAPI::PostInvestorProfilesIndividuals.new }
22
22
 
23
- describe 'test an instance of PatchIndividualProfileRequest' do
24
- it 'should create an instance of PatchIndividualProfileRequest' do
25
- expect(instance).to be_instance_of(DealMakerAPI::PatchIndividualProfileRequest)
23
+ describe 'test an instance of PostInvestorProfilesIndividuals' do
24
+ it 'should create an instance of PostInvestorProfilesIndividuals' do
25
+ expect(instance).to be_instance_of(DealMakerAPI::PostInvestorProfilesIndividuals)
26
26
  end
27
27
  end
28
+ describe 'test attribute "email"' do
29
+ it 'should work' do
30
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
31
+ end
32
+ end
33
+
28
34
  describe 'test attribute "us_accredited_category"' do
29
35
  it 'should work' do
30
36
  # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
@@ -81,12 +87,6 @@ describe DealMakerAPI::PatchIndividualProfileRequest do
81
87
  end
82
88
  end
83
89
 
84
- describe 'test attribute "country"' do
85
- it 'should work' do
86
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
87
- end
88
- end
89
-
90
90
  describe 'test attribute "street_address"' do
91
91
  it 'should work' do
92
92
  # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
@@ -6,7 +6,7 @@
6
6
  The version of the OpenAPI document: 1.75.0
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 7.0.0-SNAPSHOT
9
+ OpenAPI Generator version: 7.0.1-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -14,17 +14,23 @@ require 'spec_helper'
14
14
  require 'json'
15
15
  require 'date'
16
16
 
17
- # Unit tests for DealMakerAPI::PatchJointProfileRequest
17
+ # Unit tests for DealMakerAPI::PostInvestorProfilesJoints
18
18
  # Automatically generated by openapi-generator (https://openapi-generator.tech)
19
19
  # Please update as you see appropriate
20
- describe DealMakerAPI::PatchJointProfileRequest do
21
- let(:instance) { DealMakerAPI::PatchJointProfileRequest.new }
20
+ describe DealMakerAPI::PostInvestorProfilesJoints do
21
+ let(:instance) { DealMakerAPI::PostInvestorProfilesJoints.new }
22
22
 
23
- describe 'test an instance of PatchJointProfileRequest' do
24
- it 'should create an instance of PatchJointProfileRequest' do
25
- expect(instance).to be_instance_of(DealMakerAPI::PatchJointProfileRequest)
23
+ describe 'test an instance of PostInvestorProfilesJoints' do
24
+ it 'should create an instance of PostInvestorProfilesJoints' do
25
+ expect(instance).to be_instance_of(DealMakerAPI::PostInvestorProfilesJoints)
26
26
  end
27
27
  end
28
+ describe 'test attribute "email"' do
29
+ it 'should work' do
30
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
31
+ end
32
+ end
33
+
28
34
  describe 'test attribute "us_accredited_category"' do
29
35
  it 'should work' do
30
36
  # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
@@ -73,12 +79,6 @@ describe DealMakerAPI::PatchJointProfileRequest do
73
79
  end
74
80
  end
75
81
 
76
- describe 'test attribute "country"' do
77
- it 'should work' do
78
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
79
- end
80
- end
81
-
82
82
  describe 'test attribute "street_address"' do
83
83
  it 'should work' do
84
84
  # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
@@ -163,12 +163,6 @@ describe DealMakerAPI::PatchJointProfileRequest do
163
163
  end
164
164
  end
165
165
 
166
- describe 'test attribute "joint_holder_country"' do
167
- it 'should work' do
168
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
169
- end
170
- end
171
-
172
166
  describe 'test attribute "joint_holder_street_address"' do
173
167
  it 'should work' do
174
168
  # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
@@ -0,0 +1,126 @@
1
+ =begin
2
+ #DealMaker API
3
+
4
+ ## Introduction Welcome to DealMaker’s Web API v1! This API is RESTful, easy to integrate with, and offers support in 2 different languages. This is the technical documentation for our API. There are tutorials and examples of integrations with our API available on our [knowledge centre](https://help.dealmaker.tech/training-centre) as well. # Libraries - Javascript - Ruby # Authentication To authenticate, add an Authorization header to your API request that contains an access token. Before you [generate an access token](#how-to-generate-an-access-token) your must first [create an application](#create-an-application) on your portal and retrieve the your client ID and secret ## Create an Application DealMaker’s Web API v1 supports the use of OAuth applications. Applications can be generated in your [account](https://app.dealmaker.tech/developer/applications). To create an API Application, click on your user name in the top right corner to open a dropdown menu, and select \"Integrations\". Under the API settings tab, click the `Create New Application` button ![Screenshot](https://s3.ca-central-1.amazonaws.com/docs.dealmaker.tech/images/api-application-1.png) Name your application and assign the level of permissions for this application ![Screenshot](https://s3.ca-central-1.amazonaws.com/docs.dealmaker.tech/images/api-application-2.png) Once your application is created, save in a secure space your client ID and secret. **WARNING**: The secret key will not be visible after you click the close button ![Screenshot](https://s3.ca-central-1.amazonaws.com/docs.dealmaker.tech/images/api-application-3.png) From the developer tab, you will be able to view and manage all the available applications ![Screenshot](https://s3.ca-central-1.amazonaws.com/docs.dealmaker.tech/images/api-application-4.png) Each Application consists of a client id, secret and set of scopes. The scopes define what resources you want to have access to. The client ID and secret are used to generate an access token. You will need to create an application to use API endpoints. ## How to generate an access token After creating an application, you must make a call to obtain a bearer token using the Generate an OAuth token operation. This operation requires the following parameters: `token endpoint` - https://app.dealmaker.tech/oauth/token `grant_type` - must be set to `client_credentials` `client_id` - the Client ID displayed when you created the OAuth application in the previous step `client_secret` - the Client Secret displayed when you created the OAuth application in the previous step `scope` - the scope is established when you created the OAuth application in the previous step Note: The Generate an OAuth token response specifies how long the bearer token is valid for. You should reuse the bearer token until it is expired. When the token is expired, call Generate an OAuth token again to generate a new one. To use the access token, you must set a plain text header named `Authorization` with the contents of the header being “Bearer XXX” where XXX is your generated access token. ### Example #### Postman Here's an example on how to generate the access token with Postman, where `{{CLIENT_ID}}` and `{{CLIENT_SECRET}}` are the values generated after following the steps on [Create an Application](#create-an-application) ![Get access token postman example](https://s3.ca-central-1.amazonaws.com/docs.dealmaker.tech/images/token-postman.png) # Status Codes ## Content-Type Header All responses are returned in JSON format. We specify this by sending the Content-Type header. ## Status Codes Below is a table containing descriptions of the various status codes we currently support against various resources. Sometimes your API call will generate an error. Here you will find additional information about what to expect if you don’t format your request properly, or we fail to properly process your request. | Status Code | Description | | ----------- | ----------- | | `200` | Success | | `403` | Forbidden | | `404` | Not found | # Pagination Pagination is used to divide large responses is smaller portions (pages). By default, all endpoints return a maximum of 25 records per page. You can change the number of records on a per request basis by passing a `per_page` parameter in the request header parameters. The largest supported `per_page` parameter is 100. When the response exceeds the `per_page` parameter, you can paginate through the records by increasing the `offset` parameter. Example: `offset=25` will return 25 records starting from 26th record. You may also paginate using the `page` parameter to indicate the page number you would like to show on the response. Please review the table below for the input parameters ## Inputs | Parameter | Description | | ---------- | ------------------------------------------------------------------------------- | | `per_page` | Amount of records included on each page (Default is 25) | | `page` | Page number | | `offset` | Amount of records offset on the API request where 0 represents the first record | ## Response Headers | Response Header | Description | | --------------- | -------------------------------------------- | | `X-Total` | Total number of records of response | | `X-Total-Pages` | Total number of pages of response | | `X-Per-Page` | Total number of records per page of response | | `X-Page` | Number of current page | | `X-Next-Page` | Number of next page | | `X-Prev-Page` | Number of previous page | | `X-Offset` | Total number of records offset | # Search and Filtering (The q parameter) The q optional parameter accepts a string as input and allows you to filter the request based on that string. Please note that search strings must be encoded according to ASCII. For example, \"john+investor&#64;dealmaker.tech\" should be passed as “john%2Binvestor%40dealmaker.tech”. There are two main ways to filter with it. ## Keyword filtering Some keywords allow you to filter investors based on a specific “scope” of the investors, for example using the string “Invited” will filter all investors with the status invited, and the keyword “Has attachments” will filter investors with attachments. Here’s a list of possible keywords and the “scope” each one of the keywords filters by: | Keywords | Scope | Decoded Example | Encoded Example | | ---------------------------------------------- | --------------------------------------------------------------------------- | -------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | | Signed on \\(date range\\) | Investors who signed in the provided date range | Signed on (date range) [2020-07-01:2020-07-31] | `Signed%20on%20%28date%20range%29%20%5B2020-07-01%3A2020-07-31%5D` | | Enabled for countersignature on \\(date range\\) | Investors who were enabled for counter signature in the provided date range | Enabled for countersignature on (date range) [2022-05-24:2022-05-25] | `Enabled%20for%20countersignature%20on%20(date%20range)%20%5B2022-05-24%3A2022-05-25%5D` | | Accepted on \\(date range\\) | Investors accepted in the provided date rage | Accepted on (date range) [2022-05-24:2022-05-25] | `Accepted%20on%20(date%20range)%20%5B2022-05-24%3A2022-05-25%5D` | | Offline | Investors added to the deal offline | Offline | `Offline` | | Online | Investors added to the deal online | Online | `Online` | | Signed | Investors who signed their agreement | Signed | `Signed` | | Waiting for countersignature | Investors who have signed and are waiting for counter signature | Waiting for countersignature | `Waiting%20for%20countersignature` | | Invited | Investors on the Invited Status | Invited | `Invited` | | Accepted | Investors in the Accepted Status | Accepted | `Accepted` | | Questionnaire in progress | All Investors who have not finished completing the questionnaire | Questionnaire in progress | `Questionnaire%20in%20progress` | | Has attachments | All Investors with attachments | Has attachments | `Has%20attachments` | | Has notes | All Investors with notes | Has notes | `Has%20notes` | | Waiting for co-signature | Investors who have signed and are waiting for co-signature | Waiting for co-signature | `Waiting%20for%20co-signature` | | Background Check Approved | Investors with approved background check | Background Check Approved | `Background%20Check%20Approved` | | Document Review Pending | Investors with pending review | Document Review Pending | `Document%20Review%20Pending` | | Document Upload Pending | Investors with pending documents to upload | Document Upload Pending | `Document%20Upload%20Pending` | | Required adjudicator review | Investors who are required to be review by the adjudicator | Required adjudicator review | `Required%20adjudicator%20review` | --- **NOTE** Filtering keywords are case sensitive and need to be encoded --- ## Search String Any value for the parameter which does not match one of the keywords listed above, will use fields like `first name`, `last name`, `email`, `tags` to search for the investor. For example, if you search “Robert”, because this does not match one of the keywords listed above, it will then return any investors who have the string “Robert” in their name, email, or tags fields. # Versioning The latest version is v1. The version can be updated on the `Accept` header, just set the version as stated on the following example: ``` Accept:application/vnd.dealmaker-v1+json ``` | Version | Accept Header | | ------- | ----------------------------------- | | `v1` | application/vnd.dealmaker-`v1`+json | # SDK’s For instruction on installing SDKs, please view the following links - [Javascript](https://github.com/DealMakerTech/api/tree/main/v1/clients/javascript) - [Ruby](https://github.com/DealMakerTech/api/tree/main/v1/clients/ruby) # Webhooks Our webhooks functionality allows clients to automatically receive updates on a deal's investor data. Some of the data that the webhooks include: - Investor Name - Date created - Email - Phone - Allocation - Attachments - Accredited investor status - Accredited investor category - State (Draft, Invited, Signed, Accepted, Waiting, Inactive) Via webhooks clients can subscribe to the following events as they happen on Dealmaker: - Investor is created - Investor details are updated (any of the investor details above change or are updated) - Investor has signed their agreement - Invertor fully funded their investment - Investor has been accepted - Investor is deleted A URL supplied by the client will receive all the events with the information as part of the payload. Clients are able to add and update the URL within DealMaker. ## Configuration For a comprehensive guide on how to configure Webhooks please visit our support article: [Configuring Webhooks on DealMaker – DealMaker Support](https://help.dealmaker.tech/configuring-webhooks-on-dealmaker). As a developer user on DealMaker, you are able to configure webhooks by following the steps below: 1. Sign into Dealmaker 2. Go to **“Your profile”** in the top right corner 3. Access an **“Integrations”** configuration via the left menu 4. The developer configures webhooks by including: - The HTTPS URL where the request will be sent - Optionally, a security token that we would use to build a SHA1 hash that would be included in the request headers. The name of the header is `X-DealMaker-Signature`. If the secret is not specified, the hash won’t be included in the headers. - The Deal(s) to include in the webhook subscription - An email address that will be used to notify about errors. 5. The developers can disable webhooks temporarily if needed ## Specification ### Events The initial set of events will be related to the investor. The events are: 1. `investor.created` - Triggers every time a new investor is added to a deal 2. `investor.updated` - Triggers on updates to any of the following fields: - Status - Name - Email - (this is a user field so we trigger event for all investors with webhook subscription) - Allocated Amount - Investment Amount - Accredited investor fields - Adding or removing attachments - Tags - When the investor status is signed, the payload also includes a link to the signed document; the link expires after 30 minutes 3. `investor.signed` - Triggers when the investor signs their subscription agreement (terms and conditions) - When this happens the investor.state becomes `signed` - This event includes the same fields as the `investor.updated` event 4. `investor.funded` - Triggers when the investor becomes fully funded - This happens when the investor.funded_state becomes `funded` - This event includes the same fields as the `investor.updated` event 5. `investor.accepted` - Triggers when the investor is countersigned - When this happens the investor.state becomes `accepted` - This event includes the same fields as the `investor.updated` event 6. `investor.deleted` - Triggers when the investor is removed from the deal - The investor key of the payload only includes investor ID - The deal is not included in the payload. Due to our implementation it’s impossible to retrieve the deal the investor was part of ### Requests - The request is a `POST` - The payload’s `content-type` is `application/json` - Only `2XX` responses are considered successful. In the event of a different response, we consider it failed and queue the event for retry - We retry the request five times, after the initial attempt. Doubling the waiting time between intervals with each try. The first retry happens after 30 seconds, then 60 seconds, 2 mins, 4 minutes, and 8 minutes. This timing scheme gives the receiver about 1 hour if all the requests fail - If an event fails all the attempts to be delivered, we send an email to the address that the user configured ### Payload #### Common Properties There will be some properties that are common to all the events on the system. | Key | Type | Description | | ----------------- | ------ | -------------------------------------------------------------------------------------- | | event | String | The event that triggered the call | | event_id | String | A unique identifier for the event | | deal<sup>\\*</sup> | Object | The deal in which the event occurred. please see below for an example on the deal object<sup>\\*\\*</sup> | <sup>\\*</sup>This field is not included when deleting a resource <sup>\\*\\*</sup> Sample Deal Object in the webhook payload ```json \"deal\": { \"id\": 0, \"title\": \"string\", \"created_at\": \"2022-12-06T18:14:44.000Z\", \"updated_at\": \"2022-12-08T12:46:48.000Z\", \"state\": \"string\", \"currency\": \"string\", \"security_type\": \"string\", \"price_per_security\": 0.00, \"deal_type\": \"string\", \"minimum_investment\": 0, \"maximum_investment\": 0, \"issuer\": { \"id\": 0, \"name\": \"string\" }, \"enterprise\": { \"id\": 0, \"name\": \"string\" } } ``` #### Common Properties (investor scope) By design, we have incorporated on the webhooks payload the same investor-related fields included in the Investor model, for reference on the included fields, their types and values please click [here](https://docs.dealmaker.tech/#tag/investor_model). This will allow you to get all the necessary information you need about a particular investor without having to call the Get Investor by ID endpoint. | #### Investor State Here is a brief description of each investor state: - **Draft:** the investor is added to the platform but hasn't been invited yet and cannot access the portal - **Invited:** the investor was added to the platform but hasn’t completed the questionnaire - **Signed:** the investor signed the document (needs approval from Lawyer or Reviewer before countersignature) - **Waiting:** the investor was approved for countersignature by any of the Lawyers or Reviewers in the deal - **Accepted:** the investor's agreement was countersigned by the Signatory - **Inactive** the investor is no longer eligible to participate in the offering. This may be because their warrant expired, they requested a refund, or they opted out of the offering #### Update Delay Given the high number of updates our platform performs on any investor, we’ve added a cool down period on update events that allows us to “group” updates and trigger only one every minute. In consequence, update events will be delivered 1 minute after the initial request was made and will include the latest version of the investor data at delivery time.
5
+
6
+ The version of the OpenAPI document: 1.75.0
7
+
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 7.0.1-SNAPSHOT
10
+
11
+ =end
12
+
13
+ require 'spec_helper'
14
+ require 'json'
15
+ require 'date'
16
+
17
+ # Unit tests for DealMakerAPI::PostInvestorProfilesTrusts
18
+ # Automatically generated by openapi-generator (https://openapi-generator.tech)
19
+ # Please update as you see appropriate
20
+ describe DealMakerAPI::PostInvestorProfilesTrusts do
21
+ let(:instance) { DealMakerAPI::PostInvestorProfilesTrusts.new }
22
+
23
+ describe 'test an instance of PostInvestorProfilesTrusts' do
24
+ it 'should create an instance of PostInvestorProfilesTrusts' do
25
+ expect(instance).to be_instance_of(DealMakerAPI::PostInvestorProfilesTrusts)
26
+ end
27
+ end
28
+ describe 'test attribute "email"' do
29
+ it 'should work' do
30
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
31
+ end
32
+ end
33
+
34
+ describe 'test attribute "us_accredited_category"' do
35
+ it 'should work' do
36
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
37
+ # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["entity_owned_by_accredited_investors", "broker_or_dealer", "assets_trust", "not_accredited"])
38
+ # validator.allowable_values.each do |value|
39
+ # expect { instance.us_accredited_category = value }.not_to raise_error
40
+ # end
41
+ end
42
+ end
43
+
44
+ describe 'test attribute "ca_accredited_investor"' do
45
+ it 'should work' do
46
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
47
+ # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["p", "w"])
48
+ # validator.allowable_values.each do |value|
49
+ # expect { instance.ca_accredited_investor = value }.not_to raise_error
50
+ # end
51
+ end
52
+ end
53
+
54
+ describe 'test attribute "name"' do
55
+ it 'should work' do
56
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
57
+ end
58
+ end
59
+
60
+ describe 'test attribute "date"' do
61
+ it 'should work' do
62
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
63
+ end
64
+ end
65
+
66
+ describe 'test attribute "street_address"' do
67
+ it 'should work' do
68
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
69
+ end
70
+ end
71
+
72
+ describe 'test attribute "unit2"' do
73
+ it 'should work' do
74
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
75
+ end
76
+ end
77
+
78
+ describe 'test attribute "city"' do
79
+ it 'should work' do
80
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
81
+ end
82
+ end
83
+
84
+ describe 'test attribute "region"' do
85
+ it 'should work' do
86
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
87
+ end
88
+ end
89
+
90
+ describe 'test attribute "postal_code"' do
91
+ it 'should work' do
92
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
93
+ end
94
+ end
95
+
96
+ describe 'test attribute "phone_number"' do
97
+ it 'should work' do
98
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
99
+ end
100
+ end
101
+
102
+ describe 'test attribute "income"' do
103
+ it 'should work' do
104
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
105
+ end
106
+ end
107
+
108
+ describe 'test attribute "net_worth"' do
109
+ it 'should work' do
110
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
111
+ end
112
+ end
113
+
114
+ describe 'test attribute "reg_cf_prior_offerings_amount"' do
115
+ it 'should work' do
116
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
117
+ end
118
+ end
119
+
120
+ describe 'test attribute "trustees"' do
121
+ it 'should work' do
122
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
123
+ end
124
+ end
125
+
126
+ end
@@ -0,0 +1,88 @@
1
+ =begin
2
+ #DealMaker API
3
+
4
+ ## Introduction Welcome to DealMaker’s Web API v1! This API is RESTful, easy to integrate with, and offers support in 2 different languages. This is the technical documentation for our API. There are tutorials and examples of integrations with our API available on our [knowledge centre](https://help.dealmaker.tech/training-centre) as well. # Libraries - Javascript - Ruby # Authentication To authenticate, add an Authorization header to your API request that contains an access token. Before you [generate an access token](#how-to-generate-an-access-token) your must first [create an application](#create-an-application) on your portal and retrieve the your client ID and secret ## Create an Application DealMaker’s Web API v1 supports the use of OAuth applications. Applications can be generated in your [account](https://app.dealmaker.tech/developer/applications). To create an API Application, click on your user name in the top right corner to open a dropdown menu, and select \"Integrations\". Under the API settings tab, click the `Create New Application` button ![Screenshot](https://s3.ca-central-1.amazonaws.com/docs.dealmaker.tech/images/api-application-1.png) Name your application and assign the level of permissions for this application ![Screenshot](https://s3.ca-central-1.amazonaws.com/docs.dealmaker.tech/images/api-application-2.png) Once your application is created, save in a secure space your client ID and secret. **WARNING**: The secret key will not be visible after you click the close button ![Screenshot](https://s3.ca-central-1.amazonaws.com/docs.dealmaker.tech/images/api-application-3.png) From the developer tab, you will be able to view and manage all the available applications ![Screenshot](https://s3.ca-central-1.amazonaws.com/docs.dealmaker.tech/images/api-application-4.png) Each Application consists of a client id, secret and set of scopes. The scopes define what resources you want to have access to. The client ID and secret are used to generate an access token. You will need to create an application to use API endpoints. ## How to generate an access token After creating an application, you must make a call to obtain a bearer token using the Generate an OAuth token operation. This operation requires the following parameters: `token endpoint` - https://app.dealmaker.tech/oauth/token `grant_type` - must be set to `client_credentials` `client_id` - the Client ID displayed when you created the OAuth application in the previous step `client_secret` - the Client Secret displayed when you created the OAuth application in the previous step `scope` - the scope is established when you created the OAuth application in the previous step Note: The Generate an OAuth token response specifies how long the bearer token is valid for. You should reuse the bearer token until it is expired. When the token is expired, call Generate an OAuth token again to generate a new one. To use the access token, you must set a plain text header named `Authorization` with the contents of the header being “Bearer XXX” where XXX is your generated access token. ### Example #### Postman Here's an example on how to generate the access token with Postman, where `{{CLIENT_ID}}` and `{{CLIENT_SECRET}}` are the values generated after following the steps on [Create an Application](#create-an-application) ![Get access token postman example](https://s3.ca-central-1.amazonaws.com/docs.dealmaker.tech/images/token-postman.png) # Status Codes ## Content-Type Header All responses are returned in JSON format. We specify this by sending the Content-Type header. ## Status Codes Below is a table containing descriptions of the various status codes we currently support against various resources. Sometimes your API call will generate an error. Here you will find additional information about what to expect if you don’t format your request properly, or we fail to properly process your request. | Status Code | Description | | ----------- | ----------- | | `200` | Success | | `403` | Forbidden | | `404` | Not found | # Pagination Pagination is used to divide large responses is smaller portions (pages). By default, all endpoints return a maximum of 25 records per page. You can change the number of records on a per request basis by passing a `per_page` parameter in the request header parameters. The largest supported `per_page` parameter is 100. When the response exceeds the `per_page` parameter, you can paginate through the records by increasing the `offset` parameter. Example: `offset=25` will return 25 records starting from 26th record. You may also paginate using the `page` parameter to indicate the page number you would like to show on the response. Please review the table below for the input parameters ## Inputs | Parameter | Description | | ---------- | ------------------------------------------------------------------------------- | | `per_page` | Amount of records included on each page (Default is 25) | | `page` | Page number | | `offset` | Amount of records offset on the API request where 0 represents the first record | ## Response Headers | Response Header | Description | | --------------- | -------------------------------------------- | | `X-Total` | Total number of records of response | | `X-Total-Pages` | Total number of pages of response | | `X-Per-Page` | Total number of records per page of response | | `X-Page` | Number of current page | | `X-Next-Page` | Number of next page | | `X-Prev-Page` | Number of previous page | | `X-Offset` | Total number of records offset | # Search and Filtering (The q parameter) The q optional parameter accepts a string as input and allows you to filter the request based on that string. Please note that search strings must be encoded according to ASCII. For example, \"john+investor&#64;dealmaker.tech\" should be passed as “john%2Binvestor%40dealmaker.tech”. There are two main ways to filter with it. ## Keyword filtering Some keywords allow you to filter investors based on a specific “scope” of the investors, for example using the string “Invited” will filter all investors with the status invited, and the keyword “Has attachments” will filter investors with attachments. Here’s a list of possible keywords and the “scope” each one of the keywords filters by: | Keywords | Scope | Decoded Example | Encoded Example | | ---------------------------------------------- | --------------------------------------------------------------------------- | -------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | | Signed on \\(date range\\) | Investors who signed in the provided date range | Signed on (date range) [2020-07-01:2020-07-31] | `Signed%20on%20%28date%20range%29%20%5B2020-07-01%3A2020-07-31%5D` | | Enabled for countersignature on \\(date range\\) | Investors who were enabled for counter signature in the provided date range | Enabled for countersignature on (date range) [2022-05-24:2022-05-25] | `Enabled%20for%20countersignature%20on%20(date%20range)%20%5B2022-05-24%3A2022-05-25%5D` | | Accepted on \\(date range\\) | Investors accepted in the provided date rage | Accepted on (date range) [2022-05-24:2022-05-25] | `Accepted%20on%20(date%20range)%20%5B2022-05-24%3A2022-05-25%5D` | | Offline | Investors added to the deal offline | Offline | `Offline` | | Online | Investors added to the deal online | Online | `Online` | | Signed | Investors who signed their agreement | Signed | `Signed` | | Waiting for countersignature | Investors who have signed and are waiting for counter signature | Waiting for countersignature | `Waiting%20for%20countersignature` | | Invited | Investors on the Invited Status | Invited | `Invited` | | Accepted | Investors in the Accepted Status | Accepted | `Accepted` | | Questionnaire in progress | All Investors who have not finished completing the questionnaire | Questionnaire in progress | `Questionnaire%20in%20progress` | | Has attachments | All Investors with attachments | Has attachments | `Has%20attachments` | | Has notes | All Investors with notes | Has notes | `Has%20notes` | | Waiting for co-signature | Investors who have signed and are waiting for co-signature | Waiting for co-signature | `Waiting%20for%20co-signature` | | Background Check Approved | Investors with approved background check | Background Check Approved | `Background%20Check%20Approved` | | Document Review Pending | Investors with pending review | Document Review Pending | `Document%20Review%20Pending` | | Document Upload Pending | Investors with pending documents to upload | Document Upload Pending | `Document%20Upload%20Pending` | | Required adjudicator review | Investors who are required to be review by the adjudicator | Required adjudicator review | `Required%20adjudicator%20review` | --- **NOTE** Filtering keywords are case sensitive and need to be encoded --- ## Search String Any value for the parameter which does not match one of the keywords listed above, will use fields like `first name`, `last name`, `email`, `tags` to search for the investor. For example, if you search “Robert”, because this does not match one of the keywords listed above, it will then return any investors who have the string “Robert” in their name, email, or tags fields. # Versioning The latest version is v1. The version can be updated on the `Accept` header, just set the version as stated on the following example: ``` Accept:application/vnd.dealmaker-v1+json ``` | Version | Accept Header | | ------- | ----------------------------------- | | `v1` | application/vnd.dealmaker-`v1`+json | # SDK’s For instruction on installing SDKs, please view the following links - [Javascript](https://github.com/DealMakerTech/api/tree/main/v1/clients/javascript) - [Ruby](https://github.com/DealMakerTech/api/tree/main/v1/clients/ruby) # Webhooks Our webhooks functionality allows clients to automatically receive updates on a deal's investor data. Some of the data that the webhooks include: - Investor Name - Date created - Email - Phone - Allocation - Attachments - Accredited investor status - Accredited investor category - State (Draft, Invited, Signed, Accepted, Waiting, Inactive) Via webhooks clients can subscribe to the following events as they happen on Dealmaker: - Investor is created - Investor details are updated (any of the investor details above change or are updated) - Investor has signed their agreement - Invertor fully funded their investment - Investor has been accepted - Investor is deleted A URL supplied by the client will receive all the events with the information as part of the payload. Clients are able to add and update the URL within DealMaker. ## Configuration For a comprehensive guide on how to configure Webhooks please visit our support article: [Configuring Webhooks on DealMaker – DealMaker Support](https://help.dealmaker.tech/configuring-webhooks-on-dealmaker). As a developer user on DealMaker, you are able to configure webhooks by following the steps below: 1. Sign into Dealmaker 2. Go to **“Your profile”** in the top right corner 3. Access an **“Integrations”** configuration via the left menu 4. The developer configures webhooks by including: - The HTTPS URL where the request will be sent - Optionally, a security token that we would use to build a SHA1 hash that would be included in the request headers. The name of the header is `X-DealMaker-Signature`. If the secret is not specified, the hash won’t be included in the headers. - The Deal(s) to include in the webhook subscription - An email address that will be used to notify about errors. 5. The developers can disable webhooks temporarily if needed ## Specification ### Events The initial set of events will be related to the investor. The events are: 1. `investor.created` - Triggers every time a new investor is added to a deal 2. `investor.updated` - Triggers on updates to any of the following fields: - Status - Name - Email - (this is a user field so we trigger event for all investors with webhook subscription) - Allocated Amount - Investment Amount - Accredited investor fields - Adding or removing attachments - Tags - When the investor status is signed, the payload also includes a link to the signed document; the link expires after 30 minutes 3. `investor.signed` - Triggers when the investor signs their subscription agreement (terms and conditions) - When this happens the investor.state becomes `signed` - This event includes the same fields as the `investor.updated` event 4. `investor.funded` - Triggers when the investor becomes fully funded - This happens when the investor.funded_state becomes `funded` - This event includes the same fields as the `investor.updated` event 5. `investor.accepted` - Triggers when the investor is countersigned - When this happens the investor.state becomes `accepted` - This event includes the same fields as the `investor.updated` event 6. `investor.deleted` - Triggers when the investor is removed from the deal - The investor key of the payload only includes investor ID - The deal is not included in the payload. Due to our implementation it’s impossible to retrieve the deal the investor was part of ### Requests - The request is a `POST` - The payload’s `content-type` is `application/json` - Only `2XX` responses are considered successful. In the event of a different response, we consider it failed and queue the event for retry - We retry the request five times, after the initial attempt. Doubling the waiting time between intervals with each try. The first retry happens after 30 seconds, then 60 seconds, 2 mins, 4 minutes, and 8 minutes. This timing scheme gives the receiver about 1 hour if all the requests fail - If an event fails all the attempts to be delivered, we send an email to the address that the user configured ### Payload #### Common Properties There will be some properties that are common to all the events on the system. | Key | Type | Description | | ----------------- | ------ | -------------------------------------------------------------------------------------- | | event | String | The event that triggered the call | | event_id | String | A unique identifier for the event | | deal<sup>\\*</sup> | Object | The deal in which the event occurred. please see below for an example on the deal object<sup>\\*\\*</sup> | <sup>\\*</sup>This field is not included when deleting a resource <sup>\\*\\*</sup> Sample Deal Object in the webhook payload ```json \"deal\": { \"id\": 0, \"title\": \"string\", \"created_at\": \"2022-12-06T18:14:44.000Z\", \"updated_at\": \"2022-12-08T12:46:48.000Z\", \"state\": \"string\", \"currency\": \"string\", \"security_type\": \"string\", \"price_per_security\": 0.00, \"deal_type\": \"string\", \"minimum_investment\": 0, \"maximum_investment\": 0, \"issuer\": { \"id\": 0, \"name\": \"string\" }, \"enterprise\": { \"id\": 0, \"name\": \"string\" } } ``` #### Common Properties (investor scope) By design, we have incorporated on the webhooks payload the same investor-related fields included in the Investor model, for reference on the included fields, their types and values please click [here](https://docs.dealmaker.tech/#tag/investor_model). This will allow you to get all the necessary information you need about a particular investor without having to call the Get Investor by ID endpoint. | #### Investor State Here is a brief description of each investor state: - **Draft:** the investor is added to the platform but hasn't been invited yet and cannot access the portal - **Invited:** the investor was added to the platform but hasn’t completed the questionnaire - **Signed:** the investor signed the document (needs approval from Lawyer or Reviewer before countersignature) - **Waiting:** the investor was approved for countersignature by any of the Lawyers or Reviewers in the deal - **Accepted:** the investor's agreement was countersigned by the Signatory - **Inactive** the investor is no longer eligible to participate in the offering. This may be because their warrant expired, they requested a refund, or they opted out of the offering #### Update Delay Given the high number of updates our platform performs on any investor, we’ve added a cool down period on update events that allows us to “group” updates and trigger only one every minute. In consequence, update events will be delivered 1 minute after the initial request was made and will include the latest version of the investor data at delivery time.
5
+
6
+ The version of the OpenAPI document: 1.75.0
7
+
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 7.0.1-SNAPSHOT
10
+
11
+ =end
12
+
13
+ require 'spec_helper'
14
+ require 'json'
15
+ require 'date'
16
+
17
+ # Unit tests for DealMakerAPI::PostInvestorProfilesTrustsTrusteesInner
18
+ # Automatically generated by openapi-generator (https://openapi-generator.tech)
19
+ # Please update as you see appropriate
20
+ describe DealMakerAPI::PostInvestorProfilesTrustsTrusteesInner do
21
+ let(:instance) { DealMakerAPI::PostInvestorProfilesTrustsTrusteesInner.new }
22
+
23
+ describe 'test an instance of PostInvestorProfilesTrustsTrusteesInner' do
24
+ it 'should create an instance of PostInvestorProfilesTrustsTrusteesInner' do
25
+ expect(instance).to be_instance_of(DealMakerAPI::PostInvestorProfilesTrustsTrusteesInner)
26
+ end
27
+ end
28
+ describe 'test attribute "first_name"' do
29
+ it 'should work' do
30
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
31
+ end
32
+ end
33
+
34
+ describe 'test attribute "last_name"' do
35
+ it 'should work' do
36
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
37
+ end
38
+ end
39
+
40
+ describe 'test attribute "suffix"' do
41
+ it 'should work' do
42
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
43
+ end
44
+ end
45
+
46
+ describe 'test attribute "street_address"' do
47
+ it 'should work' do
48
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
49
+ end
50
+ end
51
+
52
+ describe 'test attribute "unit2"' do
53
+ it 'should work' do
54
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
55
+ end
56
+ end
57
+
58
+ describe 'test attribute "city"' do
59
+ it 'should work' do
60
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
61
+ end
62
+ end
63
+
64
+ describe 'test attribute "region"' do
65
+ it 'should work' do
66
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
67
+ end
68
+ end
69
+
70
+ describe 'test attribute "postal_code"' do
71
+ it 'should work' do
72
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
73
+ end
74
+ end
75
+
76
+ describe 'test attribute "date_of_birth"' do
77
+ it 'should work' do
78
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
79
+ end
80
+ end
81
+
82
+ describe 'test attribute "taxpayer_id"' do
83
+ it 'should work' do
84
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
85
+ end
86
+ end
87
+
88
+ end
@@ -6,7 +6,7 @@
6
6
  The version of the OpenAPI document: 1.75.0
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 7.0.0-SNAPSHOT
9
+ OpenAPI Generator version: 7.0.1-SNAPSHOT
10
10
 
11
11
  =end
12
12
 
@@ -6,7 +6,7 @@
6
6
  The version of the OpenAPI document: 1.75.0
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 7.0.0-SNAPSHOT
9
+ OpenAPI Generator version: 7.0.1-SNAPSHOT
10
10
 
11
11
  =end
12
12