DealMakerAPI 0.101.1 → 0.101.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +6 -4
- data/docs/InvestorProfileApi.md +69 -0
- data/docs/PatchInvestorProfilesManaged.md +68 -0
- data/docs/V1EntitiesAttachment.md +11 -3
- data/docs/V1EntitiesInvestorSearchEntities.md +2 -0
- data/lib/DealMakerAPI/api/investor_profile_api.rb +74 -0
- data/lib/DealMakerAPI/models/patch_investor_profiles_managed.rb +519 -0
- data/lib/DealMakerAPI/models/v1_entities_attachment.rb +46 -6
- data/lib/DealMakerAPI/models/v1_entities_investor_search_entities.rb +10 -1
- data/lib/DealMakerAPI/version.rb +1 -1
- data/lib/DealMakerAPI.rb +1 -0
- data/spec/api/investor_profile_api_spec.rb +13 -0
- data/spec/models/patch_investor_profiles_managed_spec.rb +194 -0
- data/spec/models/v1_entities_attachment_spec.rb +24 -0
- data/spec/models/v1_entities_investor_search_entities_spec.rb +6 -0
- metadata +6 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 06d44a2b58f9ae67797ca8eb37cc069042919731941e9fc8bbb07c66749f50af
|
4
|
+
data.tar.gz: dc94a73f9bd6677b073cbe1868ed0dd4793292c157d5a33e3ff857192228b91e
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 64a1fc23c85681ef8c3b3f6b7911086332668188fb77e0f3270413fe781e18f97e5c1b0afbfa220aef36f70626e8ba9254e90330e98c48c711a7566690a32f00
|
7
|
+
data.tar.gz: 000cc03e5491826be9f2f15f8a9bfe6e7787049b0eb1e739568d2f7f9cdb7b9ff87f4d480272b03196ed9a718916c7b9304fa933a2fa44ae9b401e1ffb7c6b9e
|
data/README.md
CHANGED
@@ -338,7 +338,7 @@ Given the high number of updates our platform performs on any investor, we’ve
|
|
338
338
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
339
339
|
|
340
340
|
- API version: 1.75.0
|
341
|
-
- Package version: 0.101.
|
341
|
+
- Package version: 0.101.2
|
342
342
|
- Generator version: 7.5.0-SNAPSHOT
|
343
343
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
344
344
|
|
@@ -355,16 +355,16 @@ gem build DealMakerAPI.gemspec
|
|
355
355
|
Then either install the gem locally:
|
356
356
|
|
357
357
|
```shell
|
358
|
-
gem install ./DealMakerAPI-0.101.
|
358
|
+
gem install ./DealMakerAPI-0.101.2.gem
|
359
359
|
```
|
360
360
|
|
361
|
-
(for development, run `gem install --dev ./DealMakerAPI-0.101.
|
361
|
+
(for development, run `gem install --dev ./DealMakerAPI-0.101.2.gem` to install the development dependencies)
|
362
362
|
|
363
363
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
364
364
|
|
365
365
|
Finally add this to the Gemfile:
|
366
366
|
|
367
|
-
gem 'DealMakerAPI', '~> 0.101.
|
367
|
+
gem 'DealMakerAPI', '~> 0.101.2'
|
368
368
|
|
369
369
|
### Install from Git
|
370
370
|
|
@@ -486,6 +486,7 @@ Class | Method | HTTP request | Description
|
|
486
486
|
*DealMakerAPI::InvestorProfileApi* | [**patch_corporation_profile**](docs/InvestorProfileApi.md#patch_corporation_profile) | **PATCH** /investor_profiles/corporations/{investor_profile_id} | Patch a corporation investor profile
|
487
487
|
*DealMakerAPI::InvestorProfileApi* | [**patch_individual_profile**](docs/InvestorProfileApi.md#patch_individual_profile) | **PATCH** /investor_profiles/individuals/{investor_profile_id} | Patch an individual investor profile.
|
488
488
|
*DealMakerAPI::InvestorProfileApi* | [**patch_joint_profile**](docs/InvestorProfileApi.md#patch_joint_profile) | **PATCH** /investor_profiles/joints/{investor_profile_id} | Patch a joint investor profile
|
489
|
+
*DealMakerAPI::InvestorProfileApi* | [**patch_managed_profile**](docs/InvestorProfileApi.md#patch_managed_profile) | **PATCH** /investor_profiles/managed/{investor_profile_id} | Patch managed investor profile.
|
489
490
|
*DealMakerAPI::InvestorProfileApi* | [**patch_trust_profile**](docs/InvestorProfileApi.md#patch_trust_profile) | **PATCH** /investor_profiles/trusts/{investor_profile_id} | Patch a trust investor profile
|
490
491
|
*DealMakerAPI::ShareholderApi* | [**get_shareholders**](docs/ShareholderApi.md#get_shareholders) | **GET** /companies/{id}/shareholders | Get a company shareholders list
|
491
492
|
*DealMakerAPI::ShareholderApi* | [**get_shareholders_tags**](docs/ShareholderApi.md#get_shareholders_tags) | **GET** /companies/{id}/shareholders/tags | Get a company shareholders list grouped by tags
|
@@ -515,6 +516,7 @@ Class | Method | HTTP request | Description
|
|
515
516
|
- [DealMakerAPI::PatchInvestorProfilesCorporationsBeneficialOwnersInner](docs/PatchInvestorProfilesCorporationsBeneficialOwnersInner.md)
|
516
517
|
- [DealMakerAPI::PatchInvestorProfilesIndividuals](docs/PatchInvestorProfilesIndividuals.md)
|
517
518
|
- [DealMakerAPI::PatchInvestorProfilesJoints](docs/PatchInvestorProfilesJoints.md)
|
519
|
+
- [DealMakerAPI::PatchInvestorProfilesManaged](docs/PatchInvestorProfilesManaged.md)
|
518
520
|
- [DealMakerAPI::PatchInvestorProfilesTrusts](docs/PatchInvestorProfilesTrusts.md)
|
519
521
|
- [DealMakerAPI::PatchInvestorProfilesTrustsTrusteesInner](docs/PatchInvestorProfilesTrustsTrusteesInner.md)
|
520
522
|
- [DealMakerAPI::PatchInvestorRequest](docs/PatchInvestorRequest.md)
|
data/docs/InvestorProfileApi.md
CHANGED
@@ -15,6 +15,7 @@ All URIs are relative to *http://api.dealmaker.tech*
|
|
15
15
|
| [**patch_corporation_profile**](InvestorProfileApi.md#patch_corporation_profile) | **PATCH** /investor_profiles/corporations/{investor_profile_id} | Patch a corporation investor profile |
|
16
16
|
| [**patch_individual_profile**](InvestorProfileApi.md#patch_individual_profile) | **PATCH** /investor_profiles/individuals/{investor_profile_id} | Patch an individual investor profile. |
|
17
17
|
| [**patch_joint_profile**](InvestorProfileApi.md#patch_joint_profile) | **PATCH** /investor_profiles/joints/{investor_profile_id} | Patch a joint investor profile |
|
18
|
+
| [**patch_managed_profile**](InvestorProfileApi.md#patch_managed_profile) | **PATCH** /investor_profiles/managed/{investor_profile_id} | Patch managed investor profile. |
|
18
19
|
| [**patch_trust_profile**](InvestorProfileApi.md#patch_trust_profile) | **PATCH** /investor_profiles/trusts/{investor_profile_id} | Patch a trust investor profile |
|
19
20
|
|
20
21
|
|
@@ -766,6 +767,74 @@ No authorization required
|
|
766
767
|
- **Accept**: application/json
|
767
768
|
|
768
769
|
|
770
|
+
## patch_managed_profile
|
771
|
+
|
772
|
+
> <V1EntitiesInvestorProfileId> patch_managed_profile(investor_profile_id, investor_profiles_managed)
|
773
|
+
|
774
|
+
Patch managed investor profile.
|
775
|
+
|
776
|
+
Patch managed investor profile associated to the profile id.
|
777
|
+
|
778
|
+
### Examples
|
779
|
+
|
780
|
+
```ruby
|
781
|
+
require 'time'
|
782
|
+
require 'DealMakerAPI'
|
783
|
+
# setup authorization
|
784
|
+
DealMakerAPI.configure do |config|end
|
785
|
+
|
786
|
+
api_instance = DealMakerAPI::InvestorProfileApi.new
|
787
|
+
investor_profile_id = 56 # Integer |
|
788
|
+
investor_profiles_managed = DealMakerAPI::PatchInvestorProfilesManaged.new({email: 'email_example'}) # PatchInvestorProfilesManaged |
|
789
|
+
|
790
|
+
begin
|
791
|
+
# Patch managed investor profile.
|
792
|
+
result = api_instance.patch_managed_profile(investor_profile_id, investor_profiles_managed)
|
793
|
+
p result
|
794
|
+
rescue DealMakerAPI::ApiError => e
|
795
|
+
puts "Error when calling InvestorProfileApi->patch_managed_profile: #{e}"
|
796
|
+
end
|
797
|
+
```
|
798
|
+
|
799
|
+
#### Using the patch_managed_profile_with_http_info variant
|
800
|
+
|
801
|
+
This returns an Array which contains the response data, status code and headers.
|
802
|
+
|
803
|
+
> <Array(<V1EntitiesInvestorProfileId>, Integer, Hash)> patch_managed_profile_with_http_info(investor_profile_id, investor_profiles_managed)
|
804
|
+
|
805
|
+
```ruby
|
806
|
+
begin
|
807
|
+
# Patch managed investor profile.
|
808
|
+
data, status_code, headers = api_instance.patch_managed_profile_with_http_info(investor_profile_id, investor_profiles_managed)
|
809
|
+
p status_code # => 2xx
|
810
|
+
p headers # => { ... }
|
811
|
+
p data # => <V1EntitiesInvestorProfileId>
|
812
|
+
rescue DealMakerAPI::ApiError => e
|
813
|
+
puts "Error when calling InvestorProfileApi->patch_managed_profile_with_http_info: #{e}"
|
814
|
+
end
|
815
|
+
```
|
816
|
+
|
817
|
+
### Parameters
|
818
|
+
|
819
|
+
| Name | Type | Description | Notes |
|
820
|
+
| ---- | ---- | ----------- | ----- |
|
821
|
+
| **investor_profile_id** | **Integer** | | |
|
822
|
+
| **investor_profiles_managed** | [**PatchInvestorProfilesManaged**](PatchInvestorProfilesManaged.md) | | |
|
823
|
+
|
824
|
+
### Return type
|
825
|
+
|
826
|
+
[**V1EntitiesInvestorProfileId**](V1EntitiesInvestorProfileId.md)
|
827
|
+
|
828
|
+
### Authorization
|
829
|
+
|
830
|
+
No authorization required
|
831
|
+
|
832
|
+
### HTTP request headers
|
833
|
+
|
834
|
+
- **Content-Type**: application/json
|
835
|
+
- **Accept**: application/json
|
836
|
+
|
837
|
+
|
769
838
|
## patch_trust_profile
|
770
839
|
|
771
840
|
> <V1EntitiesInvestorProfileId> patch_trust_profile(investor_profile_id, investor_profiles_trusts)
|
@@ -0,0 +1,68 @@
|
|
1
|
+
# DealMakerAPI::PatchInvestorProfilesManaged
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **email** | **String** | User email which is associated with investor profile (required). | |
|
8
|
+
| **us_accredited_category** | **String** | The United States accredited investor information. | [optional] |
|
9
|
+
| **ca_accredited_investor** | **String** | The Canadian accredited investor information. | [optional] |
|
10
|
+
| **name** | **String** | The name of the provider. | [optional] |
|
11
|
+
| **street_address** | **String** | The street address of the provider. | [optional] |
|
12
|
+
| **unit2** | **String** | The street address line 2 of the provider. | [optional] |
|
13
|
+
| **city** | **String** | The city of the provider. | [optional] |
|
14
|
+
| **region** | **String** | The region or state of the provider. | [optional] |
|
15
|
+
| **postal_code** | **String** | The postal code or zipcode of the provider. | [optional] |
|
16
|
+
| **taxpayer_id** | **String** | The taxpayer identification number of the provider. | [optional] |
|
17
|
+
| **confirmation** | **Boolean** | Confirms that the provider is able to custody these securities and release respective funds in order to complete the purchase. | [optional] |
|
18
|
+
| **income** | **Float** | The income of the managed investor profile. | [optional] |
|
19
|
+
| **net_worth** | **Float** | The net worth of the managed investor profile | [optional] |
|
20
|
+
| **reg_cf_prior_offerings_amount** | **Float** | The prior offering amount of the managed investor profile. | [optional] |
|
21
|
+
| **beneficiary_account_number** | **String** | The account number of the beneficiary. | [optional] |
|
22
|
+
| **beneficiary_first_name** | **String** | The first name of the beneficiary. | [optional] |
|
23
|
+
| **beneficiary_last_name** | **String** | The last name of the beneficiary. | [optional] |
|
24
|
+
| **beneficiary_suffix** | **String** | The suffix of the beneficiary. | [optional] |
|
25
|
+
| **beneficiary_street_address** | **String** | The street address of the beneficiary. | [optional] |
|
26
|
+
| **beneficiary_unit2** | **String** | The street address line 2 of the beneficiary. | [optional] |
|
27
|
+
| **beneficiary_city** | **String** | The city of the beneficiary. | [optional] |
|
28
|
+
| **beneficiary_region** | **String** | The region or state of the beneficiary. | [optional] |
|
29
|
+
| **beneficiary_postal_code** | **String** | The postal code or zipcode of the beneficiary. | [optional] |
|
30
|
+
| **beneficiary_date_of_birth** | **String** | The date of birth of the beneficiary. | [optional] |
|
31
|
+
| **beneficiary_taxpayer_id** | **String** | The taxpayer identification number of the beneficiary. | [optional] |
|
32
|
+
| **beneficiary_phone_number** | **String** | The phone number of the beneficiary. | [optional] |
|
33
|
+
|
34
|
+
## Example
|
35
|
+
|
36
|
+
```ruby
|
37
|
+
require 'DealMakerAPI'
|
38
|
+
|
39
|
+
instance = DealMakerAPI::PatchInvestorProfilesManaged.new(
|
40
|
+
email: null,
|
41
|
+
us_accredited_category: null,
|
42
|
+
ca_accredited_investor: null,
|
43
|
+
name: null,
|
44
|
+
street_address: null,
|
45
|
+
unit2: null,
|
46
|
+
city: null,
|
47
|
+
region: null,
|
48
|
+
postal_code: null,
|
49
|
+
taxpayer_id: null,
|
50
|
+
confirmation: null,
|
51
|
+
income: null,
|
52
|
+
net_worth: null,
|
53
|
+
reg_cf_prior_offerings_amount: null,
|
54
|
+
beneficiary_account_number: null,
|
55
|
+
beneficiary_first_name: null,
|
56
|
+
beneficiary_last_name: null,
|
57
|
+
beneficiary_suffix: null,
|
58
|
+
beneficiary_street_address: null,
|
59
|
+
beneficiary_unit2: null,
|
60
|
+
beneficiary_city: null,
|
61
|
+
beneficiary_region: null,
|
62
|
+
beneficiary_postal_code: null,
|
63
|
+
beneficiary_date_of_birth: null,
|
64
|
+
beneficiary_taxpayer_id: null,
|
65
|
+
beneficiary_phone_number: null
|
66
|
+
)
|
67
|
+
```
|
68
|
+
|
@@ -4,9 +4,13 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **id** | **
|
7
|
+
| **id** | **Integer** | The attachment id. | [optional] |
|
8
8
|
| **url** | **String** | The attachment url. | [optional] |
|
9
|
-
| **file_name** | **String** | The attachment
|
9
|
+
| **file_name** | **String** | The attachment file name. | [optional] |
|
10
|
+
| **original_file_name** | **String** | The attachment original file name. | [optional] |
|
11
|
+
| **file_size** | **Integer** | The size of the file in bytes. | [optional] |
|
12
|
+
| **formatted_file_size** | **String** | The size of the file in human readable format. | [optional] |
|
13
|
+
| **created_at** | **Time** | String representation of the date uploaded. | [optional] |
|
10
14
|
|
11
15
|
## Example
|
12
16
|
|
@@ -16,7 +20,11 @@ require 'DealMakerAPI'
|
|
16
20
|
instance = DealMakerAPI::V1EntitiesAttachment.new(
|
17
21
|
id: null,
|
18
22
|
url: null,
|
19
|
-
file_name: null
|
23
|
+
file_name: null,
|
24
|
+
original_file_name: null,
|
25
|
+
file_size: null,
|
26
|
+
formatted_file_size: null,
|
27
|
+
created_at: null
|
20
28
|
)
|
21
29
|
```
|
22
30
|
|
@@ -11,6 +11,7 @@
|
|
11
11
|
| **status** | **String** | Overall status of all entities. | [optional] |
|
12
12
|
| **re_run_performed** | **Boolean** | Whether or not the entity has been re-run. | [optional] |
|
13
13
|
| **email_content** | **String** | The custom message for the entity | [optional] |
|
14
|
+
| **attachments** | [**V1EntitiesAttachment**](V1EntitiesAttachment.md) | | [optional] |
|
14
15
|
| **required_fields** | [**V1EntitiesInvestorSearchEntitiesRequiredFields**](V1EntitiesInvestorSearchEntitiesRequiredFields.md) | | [optional] |
|
15
16
|
|
16
17
|
## Example
|
@@ -26,6 +27,7 @@ instance = DealMakerAPI::V1EntitiesInvestorSearchEntities.new(
|
|
26
27
|
status: null,
|
27
28
|
re_run_performed: null,
|
28
29
|
email_content: null,
|
30
|
+
attachments: null,
|
29
31
|
required_fields: null
|
30
32
|
)
|
31
33
|
```
|
@@ -785,6 +785,80 @@ module DealMakerAPI
|
|
785
785
|
return data, status_code, headers
|
786
786
|
end
|
787
787
|
|
788
|
+
# Patch managed investor profile.
|
789
|
+
# Patch managed investor profile associated to the profile id.
|
790
|
+
# @param investor_profile_id [Integer]
|
791
|
+
# @param investor_profiles_managed [PatchInvestorProfilesManaged]
|
792
|
+
# @param [Hash] opts the optional parameters
|
793
|
+
# @return [V1EntitiesInvestorProfileId]
|
794
|
+
def patch_managed_profile(investor_profile_id, investor_profiles_managed, opts = {})
|
795
|
+
data, _status_code, _headers = patch_managed_profile_with_http_info(investor_profile_id, investor_profiles_managed, opts)
|
796
|
+
data
|
797
|
+
end
|
798
|
+
|
799
|
+
# Patch managed investor profile.
|
800
|
+
# Patch managed investor profile associated to the profile id.
|
801
|
+
# @param investor_profile_id [Integer]
|
802
|
+
# @param investor_profiles_managed [PatchInvestorProfilesManaged]
|
803
|
+
# @param [Hash] opts the optional parameters
|
804
|
+
# @return [Array<(V1EntitiesInvestorProfileId, Integer, Hash)>] V1EntitiesInvestorProfileId data, response status code and response headers
|
805
|
+
def patch_managed_profile_with_http_info(investor_profile_id, investor_profiles_managed, opts = {})
|
806
|
+
if @api_client.config.debugging
|
807
|
+
@api_client.config.logger.debug 'Calling API: InvestorProfileApi.patch_managed_profile ...'
|
808
|
+
end
|
809
|
+
# verify the required parameter 'investor_profile_id' is set
|
810
|
+
if @api_client.config.client_side_validation && investor_profile_id.nil?
|
811
|
+
fail ArgumentError, "Missing the required parameter 'investor_profile_id' when calling InvestorProfileApi.patch_managed_profile"
|
812
|
+
end
|
813
|
+
# verify the required parameter 'investor_profiles_managed' is set
|
814
|
+
if @api_client.config.client_side_validation && investor_profiles_managed.nil?
|
815
|
+
fail ArgumentError, "Missing the required parameter 'investor_profiles_managed' when calling InvestorProfileApi.patch_managed_profile"
|
816
|
+
end
|
817
|
+
# resource path
|
818
|
+
local_var_path = '/investor_profiles/managed/{investor_profile_id}'.sub('{' + 'investor_profile_id' + '}', CGI.escape(investor_profile_id.to_s))
|
819
|
+
|
820
|
+
# query parameters
|
821
|
+
query_params = opts[:query_params] || {}
|
822
|
+
|
823
|
+
# header parameters
|
824
|
+
header_params = opts[:header_params] || {}
|
825
|
+
# HTTP header 'Accept' (if needed)
|
826
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
827
|
+
# HTTP header 'Content-Type'
|
828
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
829
|
+
if !content_type.nil?
|
830
|
+
header_params['Content-Type'] = content_type
|
831
|
+
end
|
832
|
+
|
833
|
+
# form parameters
|
834
|
+
form_params = opts[:form_params] || {}
|
835
|
+
|
836
|
+
# http body (model)
|
837
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(investor_profiles_managed)
|
838
|
+
|
839
|
+
# return_type
|
840
|
+
return_type = opts[:debug_return_type] || 'V1EntitiesInvestorProfileId'
|
841
|
+
|
842
|
+
# auth_names
|
843
|
+
auth_names = opts[:debug_auth_names] || []
|
844
|
+
|
845
|
+
new_options = opts.merge(
|
846
|
+
:operation => :"InvestorProfileApi.patch_managed_profile",
|
847
|
+
:header_params => header_params,
|
848
|
+
:query_params => query_params,
|
849
|
+
:form_params => form_params,
|
850
|
+
:body => post_body,
|
851
|
+
:auth_names => auth_names,
|
852
|
+
:return_type => return_type
|
853
|
+
)
|
854
|
+
|
855
|
+
data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
|
856
|
+
if @api_client.config.debugging
|
857
|
+
@api_client.config.logger.debug "API called: InvestorProfileApi#patch_managed_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
858
|
+
end
|
859
|
+
return data, status_code, headers
|
860
|
+
end
|
861
|
+
|
788
862
|
# Patch a trust investor profile
|
789
863
|
# Patch trust investor profile
|
790
864
|
# @param investor_profile_id [Integer]
|