DealMakerAPI 0.90.1 → 0.90.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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: eef65ab76c842d742b22d68316eb7bdc4f4547fd72203625cc9f65cbeb8979f8
4
- data.tar.gz: 77067db4f04aa8e132c969c35b1155d17d22dc1617107a7b323b7b1222c48783
3
+ metadata.gz: 5e83fc9aa0c2728415f62f8337ab105ada337f98e2af45ead70ee3f7e96c732f
4
+ data.tar.gz: edf7cbd3abe6183e7b3e0142f84ecc70ea60925113e16c4857a8876a81a5b357
5
5
  SHA512:
6
- metadata.gz: 6479f29c9548a1f6af6a1cafdca443d3448aee1f3f4b7606b5255d211684a06c8b66f4d6a5674ceb65337af3942fa3efbfc798762a0a4f28a131f5d574f4641f
7
- data.tar.gz: 6c26dcc0eef7ec93d086fc1ca90f9c98bd21e7c76d29d78417b607f5efa112d9cf0be50e53593235a01baff820c1de8b5e68f12d6b39eae80fd6a6dfe6f258ce
6
+ metadata.gz: c041b7d38ae3383e971131eaeae6933cf63e1b3ade220559803fd8168ba9905f954414adac9e35eacddfb244c0b341665b6dd4b0ad48db0d19290c0c7ca30222
7
+ data.tar.gz: 9dd6e2fe481fd2d076ffe0be19cce2f3c886a0f4c3685e1dce40905c571e707d8380135efd758c7ec8e71e6d7207dc333704c8f3318ad9a6ef6c500273df5f21
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.90.1
341
+ - Package version: 0.90.2
342
342
  - Build package: org.openapitools.codegen.languages.RubyClientCodegen
343
343
 
344
344
  ## Installation
@@ -354,16 +354,16 @@ gem build DealMakerAPI.gemspec
354
354
  Then either install the gem locally:
355
355
 
356
356
  ```shell
357
- gem install ./DealMakerAPI-0.90.1.gem
357
+ gem install ./DealMakerAPI-0.90.2.gem
358
358
  ```
359
359
 
360
- (for development, run `gem install --dev ./DealMakerAPI-0.90.1.gem` to install the development dependencies)
360
+ (for development, run `gem install --dev ./DealMakerAPI-0.90.2.gem` to install the development dependencies)
361
361
 
362
362
  or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
363
363
 
364
364
  Finally add this to the Gemfile:
365
365
 
366
- gem 'DealMakerAPI', '~> 0.90.1'
366
+ gem 'DealMakerAPI', '~> 0.90.2'
367
367
 
368
368
  ### Install from Git
369
369
 
@@ -421,12 +421,14 @@ Class | Method | HTTP request | Description
421
421
  *DealMakerAPI::CompanyApi* | [**get_company**](docs/CompanyApi.md#get_company) | **GET** /companies/{id} | Get a Company
422
422
  *DealMakerAPI::CompanyApi* | [**get_details_errors_grouped**](docs/CompanyApi.md#get_details_errors_grouped) | **GET** /companies/{company_id}/documents/bulk_uploads/{bulk_upload_id}/details/grouped_errors | Return bulk upload details grouped by status
423
423
  *DealMakerAPI::CompanyApi* | [**get_dividends**](docs/CompanyApi.md#get_dividends) | **GET** /companies/{company_id}/portal/dividends | Return dividends
424
+ *DealMakerAPI::CompanyApi* | [**get_user_accessible_companies**](docs/CompanyApi.md#get_user_accessible_companies) | **GET** /users/accessible_companies | Get list of all Companies accessible by the user
424
425
  *DealMakerAPI::CompanyApi* | [**send_portal_invite**](docs/CompanyApi.md#send_portal_invite) | **POST** /companies/{id}/shareholders/{shareholder_id}/send_portal_invite | Send portal invite to shareholder
425
426
  *DealMakerAPI::CountryApi* | [**get_country_states**](docs/CountryApi.md#get_country_states) | **GET** /country/states | Returns a list of all valid countries and it states
426
427
  *DealMakerAPI::DealApi* | [**create_deal_setup**](docs/DealApi.md#create_deal_setup) | **POST** /deal_setups | Create deal setup
427
428
  *DealMakerAPI::DealApi* | [**get_deal**](docs/DealApi.md#get_deal) | **GET** /deals/{id} | Get deal by Deal ID
428
429
  *DealMakerAPI::DealApi* | [**list_deals**](docs/DealApi.md#list_deals) | **GET** /deals | List available deals
429
430
  *DealMakerAPI::DealsApi* | [**put_deals_id_script_tag_environment**](docs/DealsApi.md#put_deals_id_script_tag_environment) | **PUT** /deals/{id}/script_tag_environment | Update script tag environment for the deal.
431
+ *DealMakerAPI::DefaultApi* | [**get_deals_deal_id_payment_onboarding_questionnaire_digital_payments_connection_data**](docs/DefaultApi.md#get_deals_deal_id_payment_onboarding_questionnaire_digital_payments_connection_data) | **GET** /deals/{deal_id}/payment_onboarding/questionnaire/digital_payments_connection/data | Load data for the digital payments connection stage
430
432
  *DealMakerAPI::DefaultApi* | [**get_deals_id_investors_investor_id_payments_express_wire_instructions**](docs/DefaultApi.md#get_deals_id_investors_investor_id_payments_express_wire_instructions) | **GET** /deals/{id}/investors/{investor_id}/payments/express_wire/instructions | Displays the express wire instructions for an investor on a deal
431
433
  *DealMakerAPI::DefaultApi* | [**get_deals_id_investors_payments_express_wire_instructions**](docs/DefaultApi.md#get_deals_id_investors_payments_express_wire_instructions) | **GET** /deals/{id}/investors/payments/express_wire/instructions | Displays the express wire instructions for all the investors on a deal
432
434
  *DealMakerAPI::DefaultApi* | [**get_webhooks**](docs/DefaultApi.md#get_webhooks) | **GET** /webhooks | Returns a list of webhook subscription which is associated to the user
@@ -466,6 +468,8 @@ Class | Method | HTTP request | Description
466
468
  *DealMakerAPI::ShareholderApi* | [**get_shareholders**](docs/ShareholderApi.md#get_shareholders) | **GET** /companies/{id}/shareholders | Get a company shareholders list
467
469
  *DealMakerAPI::ShareholderApi* | [**get_shareholders_tags**](docs/ShareholderApi.md#get_shareholders_tags) | **GET** /companies/{id}/shareholders/tags | Get a company shareholders list grouped by tags
468
470
  *DealMakerAPI::UploadApi* | [**generate_url**](docs/UploadApi.md#generate_url) | **POST** /uploads/generate_url | Create a presigned URL for Amazon S3
471
+ *DealMakerAPI::UserApi* | [**get_user**](docs/UserApi.md#get_user) | **GET** /users/{id} | Get user by User ID
472
+ *DealMakerAPI::UserApi* | [**update_user_password**](docs/UserApi.md#update_user_password) | **PUT** /users/{id}/update_password | Update user password
469
473
  *DealMakerAPI::UsersApi* | [**get_users_investments**](docs/UsersApi.md#get_users_investments) | **GET** /users/investments | Gets the investments for a specific user.
470
474
 
471
475
 
@@ -500,6 +504,7 @@ Class | Method | HTTP request | Description
500
504
  - [DealMakerAPI::PutDealsIdScriptTagEnvironmentRequest](docs/PutDealsIdScriptTagEnvironmentRequest.md)
501
505
  - [DealMakerAPI::PutWebhooksIdRequest](docs/PutWebhooksIdRequest.md)
502
506
  - [DealMakerAPI::SendPortalInviteRequest](docs/SendPortalInviteRequest.md)
507
+ - [DealMakerAPI::UpdateUserPasswordRequest](docs/UpdateUserPasswordRequest.md)
503
508
  - [DealMakerAPI::V1EntitiesAddress](docs/V1EntitiesAddress.md)
504
509
  - [DealMakerAPI::V1EntitiesAddresses](docs/V1EntitiesAddresses.md)
505
510
  - [DealMakerAPI::V1EntitiesAttachment](docs/V1EntitiesAttachment.md)
@@ -545,6 +550,7 @@ Class | Method | HTTP request | Description
545
550
  - [DealMakerAPI::V1EntitiesInvestorProfiles](docs/V1EntitiesInvestorProfiles.md)
546
551
  - [DealMakerAPI::V1EntitiesInvestorUser](docs/V1EntitiesInvestorUser.md)
547
552
  - [DealMakerAPI::V1EntitiesInvestors](docs/V1EntitiesInvestors.md)
553
+ - [DealMakerAPI::V1EntitiesPaymentsSelfServeOnboardingDigitalPaymentsConnectionData](docs/V1EntitiesPaymentsSelfServeOnboardingDigitalPaymentsConnectionData.md)
548
554
  - [DealMakerAPI::V1EntitiesPaymentsSelfServeOnboardingPayoutAccountDetailsResult](docs/V1EntitiesPaymentsSelfServeOnboardingPayoutAccountDetailsResult.md)
549
555
  - [DealMakerAPI::V1EntitiesPaymentsSelfServeOnboardingQualificationQuestionnaireResult](docs/V1EntitiesPaymentsSelfServeOnboardingQualificationQuestionnaireResult.md)
550
556
  - [DealMakerAPI::V1EntitiesPresignedUrlResult](docs/V1EntitiesPresignedUrlResult.md)
@@ -553,6 +559,7 @@ Class | Method | HTTP request | Description
553
559
  - [DealMakerAPI::V1EntitiesShareholdersTags](docs/V1EntitiesShareholdersTags.md)
554
560
  - [DealMakerAPI::V1EntitiesState](docs/V1EntitiesState.md)
555
561
  - [DealMakerAPI::V1EntitiesSubscriptionAgreement](docs/V1EntitiesSubscriptionAgreement.md)
562
+ - [DealMakerAPI::V1EntitiesUser](docs/V1EntitiesUser.md)
556
563
  - [DealMakerAPI::V1EntitiesWebhooksDeal](docs/V1EntitiesWebhooksDeal.md)
557
564
  - [DealMakerAPI::V1EntitiesWebhooksSecurityToken](docs/V1EntitiesWebhooksSecurityToken.md)
558
565
  - [DealMakerAPI::V1EntitiesWebhooksSubscription](docs/V1EntitiesWebhooksSubscription.md)
data/docs/CompanyApi.md CHANGED
@@ -15,6 +15,7 @@ All URIs are relative to *http://api.dealmaker.tech*
15
15
  | [**get_company**](CompanyApi.md#get_company) | **GET** /companies/{id} | Get a Company |
16
16
  | [**get_details_errors_grouped**](CompanyApi.md#get_details_errors_grouped) | **GET** /companies/{company_id}/documents/bulk_uploads/{bulk_upload_id}/details/grouped_errors | Return bulk upload details grouped by status |
17
17
  | [**get_dividends**](CompanyApi.md#get_dividends) | **GET** /companies/{company_id}/portal/dividends | Return dividends |
18
+ | [**get_user_accessible_companies**](CompanyApi.md#get_user_accessible_companies) | **GET** /users/accessible_companies | Get list of all Companies accessible by the user |
18
19
  | [**send_portal_invite**](CompanyApi.md#send_portal_invite) | **POST** /companies/{id}/shareholders/{shareholder_id}/send_portal_invite | Send portal invite to shareholder |
19
20
 
20
21
 
@@ -782,6 +783,78 @@ No authorization required
782
783
  - **Accept**: application/json
783
784
 
784
785
 
786
+ ## get_user_accessible_companies
787
+
788
+ > <V1EntitiesCompany> get_user_accessible_companies(opts)
789
+
790
+ Get list of all Companies accessible by the user
791
+
792
+ Get user accessible companies
793
+
794
+ ### Examples
795
+
796
+ ```ruby
797
+ require 'time'
798
+ require 'DealMakerAPI'
799
+ # setup authorization
800
+ DealMakerAPI.configure do |config|end
801
+
802
+ api_instance = DealMakerAPI::CompanyApi.new
803
+ opts = {
804
+ page: 56, # Integer | Page offset to fetch.
805
+ per_page: 56, # Integer | Number of results to return per page.
806
+ offset: 56 # Integer | Pad a number of results.
807
+ }
808
+
809
+ begin
810
+ # Get list of all Companies accessible by the user
811
+ result = api_instance.get_user_accessible_companies(opts)
812
+ p result
813
+ rescue DealMakerAPI::ApiError => e
814
+ puts "Error when calling CompanyApi->get_user_accessible_companies: #{e}"
815
+ end
816
+ ```
817
+
818
+ #### Using the get_user_accessible_companies_with_http_info variant
819
+
820
+ This returns an Array which contains the response data, status code and headers.
821
+
822
+ > <Array(<V1EntitiesCompany>, Integer, Hash)> get_user_accessible_companies_with_http_info(opts)
823
+
824
+ ```ruby
825
+ begin
826
+ # Get list of all Companies accessible by the user
827
+ data, status_code, headers = api_instance.get_user_accessible_companies_with_http_info(opts)
828
+ p status_code # => 2xx
829
+ p headers # => { ... }
830
+ p data # => <V1EntitiesCompany>
831
+ rescue DealMakerAPI::ApiError => e
832
+ puts "Error when calling CompanyApi->get_user_accessible_companies_with_http_info: #{e}"
833
+ end
834
+ ```
835
+
836
+ ### Parameters
837
+
838
+ | Name | Type | Description | Notes |
839
+ | ---- | ---- | ----------- | ----- |
840
+ | **page** | **Integer** | Page offset to fetch. | [optional][default to 1] |
841
+ | **per_page** | **Integer** | Number of results to return per page. | [optional][default to 25] |
842
+ | **offset** | **Integer** | Pad a number of results. | [optional][default to 0] |
843
+
844
+ ### Return type
845
+
846
+ [**V1EntitiesCompany**](V1EntitiesCompany.md)
847
+
848
+ ### Authorization
849
+
850
+ No authorization required
851
+
852
+ ### HTTP request headers
853
+
854
+ - **Content-Type**: Not defined
855
+ - **Accept**: application/json
856
+
857
+
785
858
  ## send_portal_invite
786
859
 
787
860
  > send_portal_invite(id, shareholder_id, opts)
data/docs/DefaultApi.md CHANGED
@@ -4,6 +4,7 @@ All URIs are relative to *http://api.dealmaker.tech*
4
4
 
5
5
  | Method | HTTP request | Description |
6
6
  | ------ | ------------ | ----------- |
7
+ | [**get_deals_deal_id_payment_onboarding_questionnaire_digital_payments_connection_data**](DefaultApi.md#get_deals_deal_id_payment_onboarding_questionnaire_digital_payments_connection_data) | **GET** /deals/{deal_id}/payment_onboarding/questionnaire/digital_payments_connection/data | Load data for the digital payments connection stage |
7
8
  | [**get_deals_id_investors_investor_id_payments_express_wire_instructions**](DefaultApi.md#get_deals_id_investors_investor_id_payments_express_wire_instructions) | **GET** /deals/{id}/investors/{investor_id}/payments/express_wire/instructions | Displays the express wire instructions for an investor on a deal |
8
9
  | [**get_deals_id_investors_payments_express_wire_instructions**](DefaultApi.md#get_deals_id_investors_payments_express_wire_instructions) | **GET** /deals/{id}/investors/payments/express_wire/instructions | Displays the express wire instructions for all the investors on a deal |
9
10
  | [**get_webhooks**](DefaultApi.md#get_webhooks) | **GET** /webhooks | Returns a list of webhook subscription which is associated to the user |
@@ -17,6 +18,72 @@ All URIs are relative to *http://api.dealmaker.tech*
17
18
  | [**put_webhooks_id**](DefaultApi.md#put_webhooks_id) | **PUT** /webhooks/{id} | Updates webhook subscription and webhooks subcription deals |
18
19
 
19
20
 
21
+ ## get_deals_deal_id_payment_onboarding_questionnaire_digital_payments_connection_data
22
+
23
+ > <V1EntitiesPaymentsSelfServeOnboardingDigitalPaymentsConnectionData> get_deals_deal_id_payment_onboarding_questionnaire_digital_payments_connection_data(deal_id)
24
+
25
+ Load data for the digital payments connection stage
26
+
27
+ Load data for the digital payments connection stage
28
+
29
+ ### Examples
30
+
31
+ ```ruby
32
+ require 'time'
33
+ require 'DealMakerAPI'
34
+ # setup authorization
35
+ DealMakerAPI.configure do |config|end
36
+
37
+ api_instance = DealMakerAPI::DefaultApi.new
38
+ deal_id = 56 # Integer |
39
+
40
+ begin
41
+ # Load data for the digital payments connection stage
42
+ result = api_instance.get_deals_deal_id_payment_onboarding_questionnaire_digital_payments_connection_data(deal_id)
43
+ p result
44
+ rescue DealMakerAPI::ApiError => e
45
+ puts "Error when calling DefaultApi->get_deals_deal_id_payment_onboarding_questionnaire_digital_payments_connection_data: #{e}"
46
+ end
47
+ ```
48
+
49
+ #### Using the get_deals_deal_id_payment_onboarding_questionnaire_digital_payments_connection_data_with_http_info variant
50
+
51
+ This returns an Array which contains the response data, status code and headers.
52
+
53
+ > <Array(<V1EntitiesPaymentsSelfServeOnboardingDigitalPaymentsConnectionData>, Integer, Hash)> get_deals_deal_id_payment_onboarding_questionnaire_digital_payments_connection_data_with_http_info(deal_id)
54
+
55
+ ```ruby
56
+ begin
57
+ # Load data for the digital payments connection stage
58
+ data, status_code, headers = api_instance.get_deals_deal_id_payment_onboarding_questionnaire_digital_payments_connection_data_with_http_info(deal_id)
59
+ p status_code # => 2xx
60
+ p headers # => { ... }
61
+ p data # => <V1EntitiesPaymentsSelfServeOnboardingDigitalPaymentsConnectionData>
62
+ rescue DealMakerAPI::ApiError => e
63
+ puts "Error when calling DefaultApi->get_deals_deal_id_payment_onboarding_questionnaire_digital_payments_connection_data_with_http_info: #{e}"
64
+ end
65
+ ```
66
+
67
+ ### Parameters
68
+
69
+ | Name | Type | Description | Notes |
70
+ | ---- | ---- | ----------- | ----- |
71
+ | **deal_id** | **Integer** | | |
72
+
73
+ ### Return type
74
+
75
+ [**V1EntitiesPaymentsSelfServeOnboardingDigitalPaymentsConnectionData**](V1EntitiesPaymentsSelfServeOnboardingDigitalPaymentsConnectionData.md)
76
+
77
+ ### Authorization
78
+
79
+ No authorization required
80
+
81
+ ### HTTP request headers
82
+
83
+ - **Content-Type**: Not defined
84
+ - **Accept**: application/json
85
+
86
+
20
87
  ## get_deals_id_investors_investor_id_payments_express_wire_instructions
21
88
 
22
89
  > <V1EntitiesExpressWireInstruction> get_deals_id_investors_investor_id_payments_express_wire_instructions(id, investor_id)
@@ -0,0 +1,18 @@
1
+ # DealMakerAPI::UpdateUserPasswordRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **password** | **String** | The user password. | |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'DealMakerAPI'
13
+
14
+ instance = DealMakerAPI::UpdateUserPasswordRequest.new(
15
+ password: null
16
+ )
17
+ ```
18
+
data/docs/UserApi.md ADDED
@@ -0,0 +1,143 @@
1
+ # DealMakerAPI::UserApi
2
+
3
+ All URIs are relative to *http://api.dealmaker.tech*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**get_user**](UserApi.md#get_user) | **GET** /users/{id} | Get user by User ID |
8
+ | [**update_user_password**](UserApi.md#update_user_password) | **PUT** /users/{id}/update_password | Update user password |
9
+
10
+
11
+ ## get_user
12
+
13
+ > <V1EntitiesUser> get_user(id)
14
+
15
+ Get user by User ID
16
+
17
+ Get a single user using the User ID
18
+
19
+ ### Examples
20
+
21
+ ```ruby
22
+ require 'time'
23
+ require 'DealMakerAPI'
24
+ # setup authorization
25
+ DealMakerAPI.configure do |config|end
26
+
27
+ api_instance = DealMakerAPI::UserApi.new
28
+ id = 56 # Integer |
29
+
30
+ begin
31
+ # Get user by User ID
32
+ result = api_instance.get_user(id)
33
+ p result
34
+ rescue DealMakerAPI::ApiError => e
35
+ puts "Error when calling UserApi->get_user: #{e}"
36
+ end
37
+ ```
38
+
39
+ #### Using the get_user_with_http_info variant
40
+
41
+ This returns an Array which contains the response data, status code and headers.
42
+
43
+ > <Array(<V1EntitiesUser>, Integer, Hash)> get_user_with_http_info(id)
44
+
45
+ ```ruby
46
+ begin
47
+ # Get user by User ID
48
+ data, status_code, headers = api_instance.get_user_with_http_info(id)
49
+ p status_code # => 2xx
50
+ p headers # => { ... }
51
+ p data # => <V1EntitiesUser>
52
+ rescue DealMakerAPI::ApiError => e
53
+ puts "Error when calling UserApi->get_user_with_http_info: #{e}"
54
+ end
55
+ ```
56
+
57
+ ### Parameters
58
+
59
+ | Name | Type | Description | Notes |
60
+ | ---- | ---- | ----------- | ----- |
61
+ | **id** | **Integer** | | |
62
+
63
+ ### Return type
64
+
65
+ [**V1EntitiesUser**](V1EntitiesUser.md)
66
+
67
+ ### Authorization
68
+
69
+ No authorization required
70
+
71
+ ### HTTP request headers
72
+
73
+ - **Content-Type**: Not defined
74
+ - **Accept**: application/json
75
+
76
+
77
+ ## update_user_password
78
+
79
+ > <V1EntitiesUser> update_user_password(id, update_user_password_request)
80
+
81
+ Update user password
82
+
83
+ Update user password
84
+
85
+ ### Examples
86
+
87
+ ```ruby
88
+ require 'time'
89
+ require 'DealMakerAPI'
90
+ # setup authorization
91
+ DealMakerAPI.configure do |config|end
92
+
93
+ api_instance = DealMakerAPI::UserApi.new
94
+ id = 56 # Integer |
95
+ update_user_password_request = DealMakerAPI::UpdateUserPasswordRequest.new({password: 'password_example'}) # UpdateUserPasswordRequest |
96
+
97
+ begin
98
+ # Update user password
99
+ result = api_instance.update_user_password(id, update_user_password_request)
100
+ p result
101
+ rescue DealMakerAPI::ApiError => e
102
+ puts "Error when calling UserApi->update_user_password: #{e}"
103
+ end
104
+ ```
105
+
106
+ #### Using the update_user_password_with_http_info variant
107
+
108
+ This returns an Array which contains the response data, status code and headers.
109
+
110
+ > <Array(<V1EntitiesUser>, Integer, Hash)> update_user_password_with_http_info(id, update_user_password_request)
111
+
112
+ ```ruby
113
+ begin
114
+ # Update user password
115
+ data, status_code, headers = api_instance.update_user_password_with_http_info(id, update_user_password_request)
116
+ p status_code # => 2xx
117
+ p headers # => { ... }
118
+ p data # => <V1EntitiesUser>
119
+ rescue DealMakerAPI::ApiError => e
120
+ puts "Error when calling UserApi->update_user_password_with_http_info: #{e}"
121
+ end
122
+ ```
123
+
124
+ ### Parameters
125
+
126
+ | Name | Type | Description | Notes |
127
+ | ---- | ---- | ----------- | ----- |
128
+ | **id** | **Integer** | | |
129
+ | **update_user_password_request** | [**UpdateUserPasswordRequest**](UpdateUserPasswordRequest.md) | | |
130
+
131
+ ### Return type
132
+
133
+ [**V1EntitiesUser**](V1EntitiesUser.md)
134
+
135
+ ### Authorization
136
+
137
+ No authorization required
138
+
139
+ ### HTTP request headers
140
+
141
+ - **Content-Type**: application/json
142
+ - **Accept**: application/json
143
+
@@ -30,7 +30,7 @@
30
30
  | **ranking_score** | **Float** | A value &#x60;[0, 1]&#x60; that represents the propensity for the investor to complete payment for the investment. A larger value indicates a higher likelihood of payment, as predicted by DealMaker’s machine learning algorithm. This field will only populate if DealMaker Compass is enabled for a deal and the investor &#x60;funds_state&#x60; value is not &#x60;funded&#x60; or &#x60;overfunded&#x60; | [optional] |
31
31
  | **investor_profile** | **String** | | [optional] |
32
32
  | **investor_profile_id** | **Integer** | The investor profile id. | [optional] |
33
- | **checkout_state** | **String** | Current state on checkout page. | [optional] |
33
+ | **checkout_state** | **String** | Current state on the checkout page. | [optional] |
34
34
  | **legacy_flow_link** | **String** | The legacy link for the investor. If the investor is already on the legacy flow, this link will be null. | [optional] |
35
35
 
36
36
  ## Example
@@ -0,0 +1,18 @@
1
+ # DealMakerAPI::V1EntitiesPaymentsSelfServeOnboardingDigitalPaymentsConnectionData
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **connect_account_link** | **String** | A link to complete the setup for a Stripe connect account | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'DealMakerAPI'
13
+
14
+ instance = DealMakerAPI::V1EntitiesPaymentsSelfServeOnboardingDigitalPaymentsConnectionData.new(
15
+ connect_account_link: null
16
+ )
17
+ ```
18
+
@@ -0,0 +1,22 @@
1
+ # DealMakerAPI::V1EntitiesUser
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | The user id. | [optional] |
8
+ | **full_name** | **String** | The full user name. | [optional] |
9
+ | **email** | **String** | The email. | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'DealMakerAPI'
15
+
16
+ instance = DealMakerAPI::V1EntitiesUser.new(
17
+ id: null,
18
+ full_name: null,
19
+ email: null
20
+ )
21
+ ```
22
+
@@ -801,6 +801,72 @@ module DealMakerAPI
801
801
  return data, status_code, headers
802
802
  end
803
803
 
804
+ # Get list of all Companies accessible by the user
805
+ # Get user accessible companies
806
+ # @param [Hash] opts the optional parameters
807
+ # @option opts [Integer] :page Page offset to fetch. (default to 1)
808
+ # @option opts [Integer] :per_page Number of results to return per page. (default to 25)
809
+ # @option opts [Integer] :offset Pad a number of results. (default to 0)
810
+ # @return [V1EntitiesCompany]
811
+ def get_user_accessible_companies(opts = {})
812
+ data, _status_code, _headers = get_user_accessible_companies_with_http_info(opts)
813
+ data
814
+ end
815
+
816
+ # Get list of all Companies accessible by the user
817
+ # Get user accessible companies
818
+ # @param [Hash] opts the optional parameters
819
+ # @option opts [Integer] :page Page offset to fetch. (default to 1)
820
+ # @option opts [Integer] :per_page Number of results to return per page. (default to 25)
821
+ # @option opts [Integer] :offset Pad a number of results. (default to 0)
822
+ # @return [Array<(V1EntitiesCompany, Integer, Hash)>] V1EntitiesCompany data, response status code and response headers
823
+ def get_user_accessible_companies_with_http_info(opts = {})
824
+ if @api_client.config.debugging
825
+ @api_client.config.logger.debug 'Calling API: CompanyApi.get_user_accessible_companies ...'
826
+ end
827
+ # resource path
828
+ local_var_path = '/users/accessible_companies'
829
+
830
+ # query parameters
831
+ query_params = opts[:query_params] || {}
832
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
833
+ query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
834
+ query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
835
+
836
+ # header parameters
837
+ header_params = opts[:header_params] || {}
838
+ # HTTP header 'Accept' (if needed)
839
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
840
+
841
+ # form parameters
842
+ form_params = opts[:form_params] || {}
843
+
844
+ # http body (model)
845
+ post_body = opts[:debug_body]
846
+
847
+ # return_type
848
+ return_type = opts[:debug_return_type] || 'V1EntitiesCompany'
849
+
850
+ # auth_names
851
+ auth_names = opts[:debug_auth_names] || []
852
+
853
+ new_options = opts.merge(
854
+ :operation => :"CompanyApi.get_user_accessible_companies",
855
+ :header_params => header_params,
856
+ :query_params => query_params,
857
+ :form_params => form_params,
858
+ :body => post_body,
859
+ :auth_names => auth_names,
860
+ :return_type => return_type
861
+ )
862
+
863
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
864
+ if @api_client.config.debugging
865
+ @api_client.config.logger.debug "API called: CompanyApi#get_user_accessible_companies\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
866
+ end
867
+ return data, status_code, headers
868
+ end
869
+
804
870
  # Send portal invite to shareholder
805
871
  # Send portal invite to shareholder.
806
872
  # @param id [Integer]
@@ -19,6 +19,69 @@ module DealMakerAPI
19
19
  def initialize(api_client = ApiClient.default)
20
20
  @api_client = api_client
21
21
  end
22
+ # Load data for the digital payments connection stage
23
+ # Load data for the digital payments connection stage
24
+ # @param deal_id [Integer]
25
+ # @param [Hash] opts the optional parameters
26
+ # @return [V1EntitiesPaymentsSelfServeOnboardingDigitalPaymentsConnectionData]
27
+ def get_deals_deal_id_payment_onboarding_questionnaire_digital_payments_connection_data(deal_id, opts = {})
28
+ data, _status_code, _headers = get_deals_deal_id_payment_onboarding_questionnaire_digital_payments_connection_data_with_http_info(deal_id, opts)
29
+ data
30
+ end
31
+
32
+ # Load data for the digital payments connection stage
33
+ # Load data for the digital payments connection stage
34
+ # @param deal_id [Integer]
35
+ # @param [Hash] opts the optional parameters
36
+ # @return [Array<(V1EntitiesPaymentsSelfServeOnboardingDigitalPaymentsConnectionData, Integer, Hash)>] V1EntitiesPaymentsSelfServeOnboardingDigitalPaymentsConnectionData data, response status code and response headers
37
+ def get_deals_deal_id_payment_onboarding_questionnaire_digital_payments_connection_data_with_http_info(deal_id, opts = {})
38
+ if @api_client.config.debugging
39
+ @api_client.config.logger.debug 'Calling API: DefaultApi.get_deals_deal_id_payment_onboarding_questionnaire_digital_payments_connection_data ...'
40
+ end
41
+ # verify the required parameter 'deal_id' is set
42
+ if @api_client.config.client_side_validation && deal_id.nil?
43
+ fail ArgumentError, "Missing the required parameter 'deal_id' when calling DefaultApi.get_deals_deal_id_payment_onboarding_questionnaire_digital_payments_connection_data"
44
+ end
45
+ # resource path
46
+ local_var_path = '/deals/{deal_id}/payment_onboarding/questionnaire/digital_payments_connection/data'.sub('{' + 'deal_id' + '}', CGI.escape(deal_id.to_s))
47
+
48
+ # query parameters
49
+ query_params = opts[:query_params] || {}
50
+
51
+ # header parameters
52
+ header_params = opts[:header_params] || {}
53
+ # HTTP header 'Accept' (if needed)
54
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
55
+
56
+ # form parameters
57
+ form_params = opts[:form_params] || {}
58
+
59
+ # http body (model)
60
+ post_body = opts[:debug_body]
61
+
62
+ # return_type
63
+ return_type = opts[:debug_return_type] || 'V1EntitiesPaymentsSelfServeOnboardingDigitalPaymentsConnectionData'
64
+
65
+ # auth_names
66
+ auth_names = opts[:debug_auth_names] || []
67
+
68
+ new_options = opts.merge(
69
+ :operation => :"DefaultApi.get_deals_deal_id_payment_onboarding_questionnaire_digital_payments_connection_data",
70
+ :header_params => header_params,
71
+ :query_params => query_params,
72
+ :form_params => form_params,
73
+ :body => post_body,
74
+ :auth_names => auth_names,
75
+ :return_type => return_type
76
+ )
77
+
78
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
79
+ if @api_client.config.debugging
80
+ @api_client.config.logger.debug "API called: DefaultApi#get_deals_deal_id_payment_onboarding_questionnaire_digital_payments_connection_data\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
81
+ end
82
+ return data, status_code, headers
83
+ end
84
+
22
85
  # Displays the express wire instructions for an investor on a deal
23
86
  # Get express wire instructions
24
87
  # @param id [Integer]