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,368 @@
1
+ # DealMakerAPI::InvestorApi
2
+
3
+ All URIs are relative to *http://api.dealmaker.tech*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**create_investor**](InvestorApi.md#create_investor) | **POST** /deals/{id}/investors | Create a deal investor |
8
+ | [**get_investor**](InvestorApi.md#get_investor) | **GET** /deals/{id}/investors/{investor_id} | Get a deal investor by id |
9
+ | [**list_investors**](InvestorApi.md#list_investors) | **GET** /deals/{id}/investors | List deal investors |
10
+ | [**patch_investor**](InvestorApi.md#patch_investor) | **PATCH** /deals/{id}/investors/{investor_id} | Patch a deal investor |
11
+ | [**update_investor**](InvestorApi.md#update_investor) | **PUT** /deals/{id}/investors/{investor_id} | Update a deal investor |
12
+
13
+
14
+ ## create_investor
15
+
16
+ > <V1EntitiesInvestor> create_investor(id, create_investor_request)
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::InvestorApi.new
31
+ id = 56 # Integer | The deal id.
32
+ create_investor_request = DealMakerAPI::CreateInvestorRequest.new({email: 'email_example'}) # CreateInvestorRequest |
33
+
34
+ begin
35
+ # Create a deal investor
36
+ result = api_instance.create_investor(id, create_investor_request)
37
+ p result
38
+ rescue DealMakerAPI::ApiError => e
39
+ puts "Error when calling InvestorApi->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, create_investor_request)
48
+
49
+ ```ruby
50
+ begin
51
+ # Create a deal investor
52
+ data, status_code, headers = api_instance.create_investor_with_http_info(id, create_investor_request)
53
+ p status_code # => 2xx
54
+ p headers # => { ... }
55
+ p data # => <V1EntitiesInvestor>
56
+ rescue DealMakerAPI::ApiError => e
57
+ puts "Error when calling InvestorApi->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
+ | **create_investor_request** | [**CreateInvestorRequest**](CreateInvestorRequest.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
+
81
+
82
+ ## get_investor
83
+
84
+ > <V1EntitiesInvestor> get_investor(id, investor_id)
85
+
86
+ Get a deal investor by id
87
+
88
+ Gets a single investor by the id.
89
+
90
+ ### Examples
91
+
92
+ ```ruby
93
+ require 'time'
94
+ require 'DealMakerAPI'
95
+ # setup authorization
96
+ DealMakerAPI.configure do |config|end
97
+
98
+ api_instance = DealMakerAPI::InvestorApi.new
99
+ id = 56 # Integer | The deal id.
100
+ investor_id = 56 # Integer | The investor id.
101
+
102
+ begin
103
+ # Get a deal investor by id
104
+ result = api_instance.get_investor(id, investor_id)
105
+ p result
106
+ rescue DealMakerAPI::ApiError => e
107
+ puts "Error when calling InvestorApi->get_investor: #{e}"
108
+ end
109
+ ```
110
+
111
+ #### Using the get_investor_with_http_info variant
112
+
113
+ This returns an Array which contains the response data, status code and headers.
114
+
115
+ > <Array(<V1EntitiesInvestor>, Integer, Hash)> get_investor_with_http_info(id, investor_id)
116
+
117
+ ```ruby
118
+ begin
119
+ # Get a deal investor by id
120
+ data, status_code, headers = api_instance.get_investor_with_http_info(id, investor_id)
121
+ p status_code # => 2xx
122
+ p headers # => { ... }
123
+ p data # => <V1EntitiesInvestor>
124
+ rescue DealMakerAPI::ApiError => e
125
+ puts "Error when calling InvestorApi->get_investor_with_http_info: #{e}"
126
+ end
127
+ ```
128
+
129
+ ### Parameters
130
+
131
+ | Name | Type | Description | Notes |
132
+ | ---- | ---- | ----------- | ----- |
133
+ | **id** | **Integer** | The deal id. | |
134
+ | **investor_id** | **Integer** | The investor id. | |
135
+
136
+ ### Return type
137
+
138
+ [**V1EntitiesInvestor**](V1EntitiesInvestor.md)
139
+
140
+ ### Authorization
141
+
142
+ No authorization required
143
+
144
+ ### HTTP request headers
145
+
146
+ - **Content-Type**: Not defined
147
+ - **Accept**: application/json
148
+
149
+
150
+ ## list_investors
151
+
152
+ > <V1EntitiesInvestors> list_investors(id, opts)
153
+
154
+ List deal investors
155
+
156
+ List deal investors according to the specified search criteria.
157
+
158
+ ### Examples
159
+
160
+ ```ruby
161
+ require 'time'
162
+ require 'DealMakerAPI'
163
+ # setup authorization
164
+ DealMakerAPI.configure do |config|end
165
+
166
+ api_instance = DealMakerAPI::InvestorApi.new
167
+ id = 56 # Integer | The deal id.
168
+ opts = {
169
+ page: 56, # Integer | Page offset to fetch.
170
+ per_page: 56, # Integer | Number of results to return per page.
171
+ offset: 56, # Integer | Pad a number of results.
172
+ investor_ids: [37], # Array<Integer> | An array of investor ids.
173
+ 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)
174
+ }
175
+
176
+ begin
177
+ # List deal investors
178
+ result = api_instance.list_investors(id, opts)
179
+ p result
180
+ rescue DealMakerAPI::ApiError => e
181
+ puts "Error when calling InvestorApi->list_investors: #{e}"
182
+ end
183
+ ```
184
+
185
+ #### Using the list_investors_with_http_info variant
186
+
187
+ This returns an Array which contains the response data, status code and headers.
188
+
189
+ > <Array(<V1EntitiesInvestors>, Integer, Hash)> list_investors_with_http_info(id, opts)
190
+
191
+ ```ruby
192
+ begin
193
+ # List deal investors
194
+ data, status_code, headers = api_instance.list_investors_with_http_info(id, opts)
195
+ p status_code # => 2xx
196
+ p headers # => { ... }
197
+ p data # => <V1EntitiesInvestors>
198
+ rescue DealMakerAPI::ApiError => e
199
+ puts "Error when calling InvestorApi->list_investors_with_http_info: #{e}"
200
+ end
201
+ ```
202
+
203
+ ### Parameters
204
+
205
+ | Name | Type | Description | Notes |
206
+ | ---- | ---- | ----------- | ----- |
207
+ | **id** | **Integer** | The deal id. | |
208
+ | **page** | **Integer** | Page offset to fetch. | [optional][default to 1] |
209
+ | **per_page** | **Integer** | Number of results to return per page. | [optional][default to 25] |
210
+ | **offset** | **Integer** | Pad a number of results. | [optional][default to 0] |
211
+ | **investor_ids** | [**Array&lt;Integer&gt;**](Integer.md) | An array of investor ids. | [optional] |
212
+ | **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] |
213
+
214
+ ### Return type
215
+
216
+ [**V1EntitiesInvestors**](V1EntitiesInvestors.md)
217
+
218
+ ### Authorization
219
+
220
+ No authorization required
221
+
222
+ ### HTTP request headers
223
+
224
+ - **Content-Type**: Not defined
225
+ - **Accept**: application/json
226
+
227
+
228
+ ## patch_investor
229
+
230
+ > <V1EntitiesInvestor> patch_investor(id, investor_id, patch_investor_request)
231
+
232
+ Patch a deal investor
233
+
234
+ Patch deal investor
235
+
236
+ ### Examples
237
+
238
+ ```ruby
239
+ require 'time'
240
+ require 'DealMakerAPI'
241
+ # setup authorization
242
+ DealMakerAPI.configure do |config|end
243
+
244
+ api_instance = DealMakerAPI::InvestorApi.new
245
+ id = 56 # Integer | The deal id.
246
+ investor_id = 56 # Integer | The investor id.
247
+ patch_investor_request = DealMakerAPI::PatchInvestorRequest.new({investor_profile_id: 37}) # PatchInvestorRequest |
248
+
249
+ begin
250
+ # Patch a deal investor
251
+ result = api_instance.patch_investor(id, investor_id, patch_investor_request)
252
+ p result
253
+ rescue DealMakerAPI::ApiError => e
254
+ puts "Error when calling InvestorApi->patch_investor: #{e}"
255
+ end
256
+ ```
257
+
258
+ #### Using the patch_investor_with_http_info variant
259
+
260
+ This returns an Array which contains the response data, status code and headers.
261
+
262
+ > <Array(<V1EntitiesInvestor>, Integer, Hash)> patch_investor_with_http_info(id, investor_id, patch_investor_request)
263
+
264
+ ```ruby
265
+ begin
266
+ # Patch a deal investor
267
+ data, status_code, headers = api_instance.patch_investor_with_http_info(id, investor_id, patch_investor_request)
268
+ p status_code # => 2xx
269
+ p headers # => { ... }
270
+ p data # => <V1EntitiesInvestor>
271
+ rescue DealMakerAPI::ApiError => e
272
+ puts "Error when calling InvestorApi->patch_investor_with_http_info: #{e}"
273
+ end
274
+ ```
275
+
276
+ ### Parameters
277
+
278
+ | Name | Type | Description | Notes |
279
+ | ---- | ---- | ----------- | ----- |
280
+ | **id** | **Integer** | The deal id. | |
281
+ | **investor_id** | **Integer** | The investor id. | |
282
+ | **patch_investor_request** | [**PatchInvestorRequest**](PatchInvestorRequest.md) | | |
283
+
284
+ ### Return type
285
+
286
+ [**V1EntitiesInvestor**](V1EntitiesInvestor.md)
287
+
288
+ ### Authorization
289
+
290
+ No authorization required
291
+
292
+ ### HTTP request headers
293
+
294
+ - **Content-Type**: application/json
295
+ - **Accept**: application/json
296
+
297
+
298
+ ## update_investor
299
+
300
+ > <V1EntitiesInvestor> update_investor(id, investor_id, opts)
301
+
302
+ Update a deal investor
303
+
304
+ Update deal investor
305
+
306
+ ### Examples
307
+
308
+ ```ruby
309
+ require 'time'
310
+ require 'DealMakerAPI'
311
+ # setup authorization
312
+ DealMakerAPI.configure do |config|end
313
+
314
+ api_instance = DealMakerAPI::InvestorApi.new
315
+ id = 56 # Integer | The deal id.
316
+ investor_id = 56 # Integer | The investor id.
317
+ opts = {
318
+ update_investor_request: DealMakerAPI::UpdateInvestorRequest.new # UpdateInvestorRequest |
319
+ }
320
+
321
+ begin
322
+ # Update a deal investor
323
+ result = api_instance.update_investor(id, investor_id, opts)
324
+ p result
325
+ rescue DealMakerAPI::ApiError => e
326
+ puts "Error when calling InvestorApi->update_investor: #{e}"
327
+ end
328
+ ```
329
+
330
+ #### Using the update_investor_with_http_info variant
331
+
332
+ This returns an Array which contains the response data, status code and headers.
333
+
334
+ > <Array(<V1EntitiesInvestor>, Integer, Hash)> update_investor_with_http_info(id, investor_id, opts)
335
+
336
+ ```ruby
337
+ begin
338
+ # Update a deal investor
339
+ data, status_code, headers = api_instance.update_investor_with_http_info(id, investor_id, opts)
340
+ p status_code # => 2xx
341
+ p headers # => { ... }
342
+ p data # => <V1EntitiesInvestor>
343
+ rescue DealMakerAPI::ApiError => e
344
+ puts "Error when calling InvestorApi->update_investor_with_http_info: #{e}"
345
+ end
346
+ ```
347
+
348
+ ### Parameters
349
+
350
+ | Name | Type | Description | Notes |
351
+ | ---- | ---- | ----------- | ----- |
352
+ | **id** | **Integer** | The deal id. | |
353
+ | **investor_id** | **Integer** | The investor id. | |
354
+ | **update_investor_request** | [**UpdateInvestorRequest**](UpdateInvestorRequest.md) | | [optional] |
355
+
356
+ ### Return type
357
+
358
+ [**V1EntitiesInvestor**](V1EntitiesInvestor.md)
359
+
360
+ ### Authorization
361
+
362
+ No authorization required
363
+
364
+ ### HTTP request headers
365
+
366
+ - **Content-Type**: application/json
367
+ - **Accept**: application/json
368
+