DealMakerAPI 0.90.0 → 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.
Files changed (41) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +14 -4
  3. data/docs/CompanyApi.md +145 -0
  4. data/docs/DefaultApi.md +67 -0
  5. data/docs/PatchInvestorProfilesTrustsTrusteesInner.md +3 -1
  6. data/docs/PostInvestorProfilesTrustsTrusteesInner.md +3 -1
  7. data/docs/SendPortalInviteRequest.md +20 -0
  8. data/docs/UpdateUserPasswordRequest.md +18 -0
  9. data/docs/UserApi.md +143 -0
  10. data/docs/V1EntitiesInvestor.md +1 -1
  11. data/docs/V1EntitiesInvestorProfileFieldsTrustee.md +30 -0
  12. data/docs/V1EntitiesInvestorProfileTrust.md +1 -1
  13. data/docs/V1EntitiesPaymentsSelfServeOnboardingDigitalPaymentsConnectionData.md +18 -0
  14. data/docs/V1EntitiesUser.md +22 -0
  15. data/lib/DealMakerAPI/api/company_api.rb +140 -0
  16. data/lib/DealMakerAPI/api/default_api.rb +63 -0
  17. data/lib/DealMakerAPI/api/user_api.rb +159 -0
  18. data/lib/DealMakerAPI/api_client.rb +10 -11
  19. data/lib/DealMakerAPI/models/patch_investor_profiles_trusts_trustees_inner.rb +14 -4
  20. data/lib/DealMakerAPI/models/post_investor_profiles_trusts_trustees_inner.rb +14 -4
  21. data/lib/DealMakerAPI/models/send_portal_invite_request.rb +225 -0
  22. data/lib/DealMakerAPI/models/update_user_password_request.rb +222 -0
  23. data/lib/DealMakerAPI/models/v1_entities_investor.rb +13 -1
  24. data/lib/DealMakerAPI/models/v1_entities_investor_profile_fields_trustee.rb +274 -0
  25. data/lib/DealMakerAPI/models/v1_entities_investor_profile_trust.rb +1 -1
  26. data/lib/DealMakerAPI/models/v1_entities_payments_self_serve_onboarding_digital_payments_connection_data.rb +216 -0
  27. data/lib/DealMakerAPI/models/v1_entities_user.rb +236 -0
  28. data/lib/DealMakerAPI/version.rb +1 -1
  29. data/lib/DealMakerAPI.rb +6 -0
  30. data/spec/api/company_api_spec.rb +28 -0
  31. data/spec/api/default_api_spec.rb +12 -0
  32. data/spec/api/user_api_spec.rb +60 -0
  33. data/spec/models/patch_investor_profiles_trusts_trustees_inner_spec.rb +6 -0
  34. data/spec/models/post_investor_profiles_trusts_trustees_inner_spec.rb +6 -0
  35. data/spec/models/send_portal_invite_request_spec.rb +42 -0
  36. data/spec/models/update_user_password_request_spec.rb +36 -0
  37. data/spec/models/v1_entities_investor_profile_fields_trustee_spec.rb +72 -0
  38. data/spec/models/v1_entities_investor_spec.rb +4 -0
  39. data/spec/models/v1_entities_payments_self_serve_onboarding_digital_payments_connection_data_spec.rb +36 -0
  40. data/spec/models/v1_entities_user_spec.rb +48 -0
  41. metadata +101 -77
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: cb92d124d385e24970df9936695ecb92591692f2ac4e11e457e8eab82c96f68b
4
- data.tar.gz: 36e97971ff8ac0e724b2ad4dd08474f25be1c596e6cb1cbab227185ef6a676c7
3
+ metadata.gz: 5e83fc9aa0c2728415f62f8337ab105ada337f98e2af45ead70ee3f7e96c732f
4
+ data.tar.gz: edf7cbd3abe6183e7b3e0142f84ecc70ea60925113e16c4857a8876a81a5b357
5
5
  SHA512:
6
- metadata.gz: 38863eb19f8fbccab2637f7f691f740f909a96bc8ccfafba8adee26116fd1a688769ea0a0ec41b455d6a072c370d467ce4902b0d32d0d2d4ba50aeb2f7f025a1
7
- data.tar.gz: f8144b715e9018eeec7f3bf3c9e3d9231fb7257a0bb45d8105ae2172feb020d5b436deece94181001fecc9347138b395e9eb165e67b4706520aa1c22e9049fd1
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.0
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.0.gem
357
+ gem install ./DealMakerAPI-0.90.2.gem
358
358
  ```
359
359
 
360
- (for development, run `gem install --dev ./DealMakerAPI-0.90.0.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.0'
366
+ gem 'DealMakerAPI', '~> 0.90.2'
367
367
 
368
368
  ### Install from Git
369
369
 
@@ -421,11 +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
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
424
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
425
427
  *DealMakerAPI::DealApi* | [**create_deal_setup**](docs/DealApi.md#create_deal_setup) | **POST** /deal_setups | Create deal setup
426
428
  *DealMakerAPI::DealApi* | [**get_deal**](docs/DealApi.md#get_deal) | **GET** /deals/{id} | Get deal by Deal ID
427
429
  *DealMakerAPI::DealApi* | [**list_deals**](docs/DealApi.md#list_deals) | **GET** /deals | List available deals
428
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
429
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
430
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
431
434
  *DealMakerAPI::DefaultApi* | [**get_webhooks**](docs/DefaultApi.md#get_webhooks) | **GET** /webhooks | Returns a list of webhook subscription which is associated to the user
@@ -465,6 +468,8 @@ Class | Method | HTTP request | Description
465
468
  *DealMakerAPI::ShareholderApi* | [**get_shareholders**](docs/ShareholderApi.md#get_shareholders) | **GET** /companies/{id}/shareholders | Get a company shareholders list
466
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
467
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
468
473
  *DealMakerAPI::UsersApi* | [**get_users_investments**](docs/UsersApi.md#get_users_investments) | **GET** /users/investments | Gets the investments for a specific user.
469
474
 
470
475
 
@@ -498,6 +503,8 @@ Class | Method | HTTP request | Description
498
503
  - [DealMakerAPI::PutDealsIdInvestors](docs/PutDealsIdInvestors.md)
499
504
  - [DealMakerAPI::PutDealsIdScriptTagEnvironmentRequest](docs/PutDealsIdScriptTagEnvironmentRequest.md)
500
505
  - [DealMakerAPI::PutWebhooksIdRequest](docs/PutWebhooksIdRequest.md)
506
+ - [DealMakerAPI::SendPortalInviteRequest](docs/SendPortalInviteRequest.md)
507
+ - [DealMakerAPI::UpdateUserPasswordRequest](docs/UpdateUserPasswordRequest.md)
501
508
  - [DealMakerAPI::V1EntitiesAddress](docs/V1EntitiesAddress.md)
502
509
  - [DealMakerAPI::V1EntitiesAddresses](docs/V1EntitiesAddresses.md)
503
510
  - [DealMakerAPI::V1EntitiesAttachment](docs/V1EntitiesAttachment.md)
@@ -534,6 +541,7 @@ Class | Method | HTTP request | Description
534
541
  - [DealMakerAPI::V1EntitiesInvestorProfileFieldsPrimaryHolder](docs/V1EntitiesInvestorProfileFieldsPrimaryHolder.md)
535
542
  - [DealMakerAPI::V1EntitiesInvestorProfileFieldsSigningOfficer](docs/V1EntitiesInvestorProfileFieldsSigningOfficer.md)
536
543
  - [DealMakerAPI::V1EntitiesInvestorProfileFieldsTrust](docs/V1EntitiesInvestorProfileFieldsTrust.md)
544
+ - [DealMakerAPI::V1EntitiesInvestorProfileFieldsTrustee](docs/V1EntitiesInvestorProfileFieldsTrustee.md)
537
545
  - [DealMakerAPI::V1EntitiesInvestorProfileIndividual](docs/V1EntitiesInvestorProfileIndividual.md)
538
546
  - [DealMakerAPI::V1EntitiesInvestorProfileItem](docs/V1EntitiesInvestorProfileItem.md)
539
547
  - [DealMakerAPI::V1EntitiesInvestorProfileJoint](docs/V1EntitiesInvestorProfileJoint.md)
@@ -542,6 +550,7 @@ Class | Method | HTTP request | Description
542
550
  - [DealMakerAPI::V1EntitiesInvestorProfiles](docs/V1EntitiesInvestorProfiles.md)
543
551
  - [DealMakerAPI::V1EntitiesInvestorUser](docs/V1EntitiesInvestorUser.md)
544
552
  - [DealMakerAPI::V1EntitiesInvestors](docs/V1EntitiesInvestors.md)
553
+ - [DealMakerAPI::V1EntitiesPaymentsSelfServeOnboardingDigitalPaymentsConnectionData](docs/V1EntitiesPaymentsSelfServeOnboardingDigitalPaymentsConnectionData.md)
545
554
  - [DealMakerAPI::V1EntitiesPaymentsSelfServeOnboardingPayoutAccountDetailsResult](docs/V1EntitiesPaymentsSelfServeOnboardingPayoutAccountDetailsResult.md)
546
555
  - [DealMakerAPI::V1EntitiesPaymentsSelfServeOnboardingQualificationQuestionnaireResult](docs/V1EntitiesPaymentsSelfServeOnboardingQualificationQuestionnaireResult.md)
547
556
  - [DealMakerAPI::V1EntitiesPresignedUrlResult](docs/V1EntitiesPresignedUrlResult.md)
@@ -550,6 +559,7 @@ Class | Method | HTTP request | Description
550
559
  - [DealMakerAPI::V1EntitiesShareholdersTags](docs/V1EntitiesShareholdersTags.md)
551
560
  - [DealMakerAPI::V1EntitiesState](docs/V1EntitiesState.md)
552
561
  - [DealMakerAPI::V1EntitiesSubscriptionAgreement](docs/V1EntitiesSubscriptionAgreement.md)
562
+ - [DealMakerAPI::V1EntitiesUser](docs/V1EntitiesUser.md)
553
563
  - [DealMakerAPI::V1EntitiesWebhooksDeal](docs/V1EntitiesWebhooksDeal.md)
554
564
  - [DealMakerAPI::V1EntitiesWebhooksSecurityToken](docs/V1EntitiesWebhooksSecurityToken.md)
555
565
  - [DealMakerAPI::V1EntitiesWebhooksSubscription](docs/V1EntitiesWebhooksSubscription.md)
data/docs/CompanyApi.md CHANGED
@@ -15,6 +15,8 @@ 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 |
19
+ | [**send_portal_invite**](CompanyApi.md#send_portal_invite) | **POST** /companies/{id}/shareholders/{shareholder_id}/send_portal_invite | Send portal invite to shareholder |
18
20
 
19
21
 
20
22
  ## create_bulk_upload
@@ -780,3 +782,146 @@ No authorization required
780
782
  - **Content-Type**: Not defined
781
783
  - **Accept**: application/json
782
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
+
858
+ ## send_portal_invite
859
+
860
+ > send_portal_invite(id, shareholder_id, opts)
861
+
862
+ Send portal invite to shareholder
863
+
864
+ Send portal invite to shareholder.
865
+
866
+ ### Examples
867
+
868
+ ```ruby
869
+ require 'time'
870
+ require 'DealMakerAPI'
871
+ # setup authorization
872
+ DealMakerAPI.configure do |config|end
873
+
874
+ api_instance = DealMakerAPI::CompanyApi.new
875
+ id = 56 # Integer |
876
+ shareholder_id = 56 # Integer |
877
+ opts = {
878
+ send_portal_invite_request: DealMakerAPI::SendPortalInviteRequest.new # SendPortalInviteRequest |
879
+ }
880
+
881
+ begin
882
+ # Send portal invite to shareholder
883
+ api_instance.send_portal_invite(id, shareholder_id, opts)
884
+ rescue DealMakerAPI::ApiError => e
885
+ puts "Error when calling CompanyApi->send_portal_invite: #{e}"
886
+ end
887
+ ```
888
+
889
+ #### Using the send_portal_invite_with_http_info variant
890
+
891
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
892
+
893
+ > <Array(nil, Integer, Hash)> send_portal_invite_with_http_info(id, shareholder_id, opts)
894
+
895
+ ```ruby
896
+ begin
897
+ # Send portal invite to shareholder
898
+ data, status_code, headers = api_instance.send_portal_invite_with_http_info(id, shareholder_id, opts)
899
+ p status_code # => 2xx
900
+ p headers # => { ... }
901
+ p data # => nil
902
+ rescue DealMakerAPI::ApiError => e
903
+ puts "Error when calling CompanyApi->send_portal_invite_with_http_info: #{e}"
904
+ end
905
+ ```
906
+
907
+ ### Parameters
908
+
909
+ | Name | Type | Description | Notes |
910
+ | ---- | ---- | ----------- | ----- |
911
+ | **id** | **Integer** | | |
912
+ | **shareholder_id** | **Integer** | | |
913
+ | **send_portal_invite_request** | [**SendPortalInviteRequest**](SendPortalInviteRequest.md) | | [optional] |
914
+
915
+ ### Return type
916
+
917
+ nil (empty response body)
918
+
919
+ ### Authorization
920
+
921
+ No authorization required
922
+
923
+ ### HTTP request headers
924
+
925
+ - **Content-Type**: application/json
926
+ - **Accept**: Not defined
927
+
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)
@@ -16,6 +16,7 @@
16
16
  | **postal_code** | **String** | The list of postal codes or zipcodes for the trustees (required for trustee 1). | [optional] |
17
17
  | **date_of_birth** | **String** | The list of dates of birth for the trustees (required for trustee 1). | [optional] |
18
18
  | **taxpayer_id** | **String** | The list of taxpayer identification numbers for the trustees (required for trustee 1). | [optional] |
19
+ | **phone_number** | **String** | The list of phone numbers for the trustees (required for trustee 1). | [optional] |
19
20
 
20
21
  ## Example
21
22
 
@@ -34,7 +35,8 @@ instance = DealMakerAPI::PatchInvestorProfilesTrustsTrusteesInner.new(
34
35
  region: null,
35
36
  postal_code: null,
36
37
  date_of_birth: null,
37
- taxpayer_id: null
38
+ taxpayer_id: null,
39
+ phone_number: null
38
40
  )
39
41
  ```
40
42
 
@@ -14,6 +14,7 @@
14
14
  | **postal_code** | **String** | The list of postal codes or zipcodes for the trustees (required for trustee 1). | [optional] |
15
15
  | **date_of_birth** | **String** | The list of dates of birth for the trustees (required for trustee 1). | [optional] |
16
16
  | **taxpayer_id** | **String** | The list of taxpayer identification numbers for the trustees (required for trustee 1). | [optional] |
17
+ | **phone_number** | **String** | The list of phone numbers for the trustees (required for trustee 1). | [optional] |
17
18
 
18
19
  ## Example
19
20
 
@@ -30,7 +31,8 @@ instance = DealMakerAPI::PostInvestorProfilesTrustsTrusteesInner.new(
30
31
  region: null,
31
32
  postal_code: null,
32
33
  date_of_birth: null,
33
- taxpayer_id: null
34
+ taxpayer_id: null,
35
+ phone_number: null
34
36
  )
35
37
  ```
36
38
 
@@ -0,0 +1,20 @@
1
+ # DealMakerAPI::SendPortalInviteRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **subject** | **String** | The custom subject of the invite email | [optional] |
8
+ | **email_content** | **String** | The custom email content of the invite email | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'DealMakerAPI'
14
+
15
+ instance = DealMakerAPI::SendPortalInviteRequest.new(
16
+ subject: null,
17
+ email_content: null
18
+ )
19
+ ```
20
+
@@ -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,30 @@
1
+ # DealMakerAPI::V1EntitiesInvestorProfileFieldsTrustee
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **first_name** | **String** | Investor profile first name | [optional] |
8
+ | **last_name** | **String** | Investor profile last name | [optional] |
9
+ | **suffix** | **String** | Investor profile suffix | [optional] |
10
+ | **date_of_birth** | **String** | The date of birth | [optional] |
11
+ | **taxpayer_id** | **String** | The taxpayer identification number | [optional] |
12
+ | **address** | [**V1EntitiesInvestorProfileAddress**](V1EntitiesInvestorProfileAddress.md) | | [optional] |
13
+ | **phone_number** | **String** | Trustee phone number | [optional] |
14
+
15
+ ## Example
16
+
17
+ ```ruby
18
+ require 'DealMakerAPI'
19
+
20
+ instance = DealMakerAPI::V1EntitiesInvestorProfileFieldsTrustee.new(
21
+ first_name: null,
22
+ last_name: null,
23
+ suffix: null,
24
+ date_of_birth: null,
25
+ taxpayer_id: null,
26
+ address: null,
27
+ phone_number: null
28
+ )
29
+ ```
30
+
@@ -14,7 +14,7 @@
14
14
  | **owner_type** | **String** | Type of the investor profile owner | [optional] |
15
15
  | **owner** | [**V1EntitiesInvestorProfileOwner**](V1EntitiesInvestorProfileOwner.md) | | [optional] |
16
16
  | **trust_holder** | [**V1EntitiesInvestorProfileFieldsTrust**](V1EntitiesInvestorProfileFieldsTrust.md) | | [optional] |
17
- | **trustees** | [**V1EntitiesInvestorProfileFieldsAccountHolder**](V1EntitiesInvestorProfileFieldsAccountHolder.md) | | [optional] |
17
+ | **trustees** | [**V1EntitiesInvestorProfileFieldsTrustee**](V1EntitiesInvestorProfileFieldsTrustee.md) | | [optional] |
18
18
 
19
19
  ## Example
20
20
 
@@ -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
+