DealMakerAPI 0.89.5 → 0.90.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (122) hide show
  1. checksums.yaml +4 -4
  2. data/DealMakerAPI.gemspec +1 -0
  3. data/README.md +13 -5
  4. data/docs/CompanyApi.md +72 -0
  5. data/docs/DealApi.md +67 -0
  6. data/docs/DefaultApi.md +200 -0
  7. data/docs/InvestorApi.md +1 -1
  8. data/docs/PatchInvestorProfilesTrustsTrusteesInner.md +3 -1
  9. data/docs/PostInvestorProfilesTrustsTrusteesInner.md +3 -1
  10. data/docs/SendPortalInviteRequest.md +20 -0
  11. data/docs/V1EntitiesInvestor.md +3 -1
  12. data/docs/V1EntitiesInvestorProfileFieldsTrustee.md +30 -0
  13. data/docs/V1EntitiesInvestorProfileTrust.md +1 -1
  14. data/docs/V1EntitiesPaymentsSelfServeOnboardingPayoutAccountDetailsResult.md +20 -0
  15. data/docs/V1EntitiesPaymentsSelfServeOnboardingQualificationQuestionnaireResult.md +20 -0
  16. data/lib/DealMakerAPI/api/company_api.rb +74 -0
  17. data/lib/DealMakerAPI/api/deal_api.rb +68 -0
  18. data/lib/DealMakerAPI/api/default_api.rb +187 -0
  19. data/lib/DealMakerAPI/api/investor_api.rb +2 -2
  20. data/lib/DealMakerAPI/api_client.rb +10 -11
  21. data/lib/DealMakerAPI/models/add506c_document_request.rb +1 -1
  22. data/lib/DealMakerAPI/models/add_document_request.rb +1 -1
  23. data/lib/DealMakerAPI/models/bulk_upload_investors_request.rb +1 -1
  24. data/lib/DealMakerAPI/models/create_bulk_upload_detail_request.rb +1 -1
  25. data/lib/DealMakerAPI/models/create_bulk_upload_request.rb +1 -1
  26. data/lib/DealMakerAPI/models/create_company_request.rb +1 -1
  27. data/lib/DealMakerAPI/models/create_deal_setup_request.rb +1 -1
  28. data/lib/DealMakerAPI/models/create_shareholder_action_request.rb +1 -1
  29. data/lib/DealMakerAPI/models/edit_investor_tags_request.rb +1 -1
  30. data/lib/DealMakerAPI/models/generate_url_request.rb +1 -1
  31. data/lib/DealMakerAPI/models/patch_investor_profiles_corporations.rb +1 -1
  32. data/lib/DealMakerAPI/models/patch_investor_profiles_corporations_beneficial_owners_inner.rb +1 -1
  33. data/lib/DealMakerAPI/models/patch_investor_profiles_individuals.rb +1 -1
  34. data/lib/DealMakerAPI/models/patch_investor_profiles_joints.rb +1 -1
  35. data/lib/DealMakerAPI/models/patch_investor_profiles_trusts.rb +1 -1
  36. data/lib/DealMakerAPI/models/patch_investor_profiles_trusts_trustees_inner.rb +15 -5
  37. data/lib/DealMakerAPI/models/patch_investor_request.rb +1 -1
  38. data/lib/DealMakerAPI/models/post_deals_id_investors.rb +1 -1
  39. data/lib/DealMakerAPI/models/post_investor_profiles_corporations.rb +1 -1
  40. data/lib/DealMakerAPI/models/post_investor_profiles_corporations_beneficial_owners_inner.rb +1 -1
  41. data/lib/DealMakerAPI/models/post_investor_profiles_individuals.rb +1 -1
  42. data/lib/DealMakerAPI/models/post_investor_profiles_joints.rb +1 -1
  43. data/lib/DealMakerAPI/models/post_investor_profiles_trusts.rb +1 -1
  44. data/lib/DealMakerAPI/models/post_investor_profiles_trusts_trustees_inner.rb +15 -5
  45. data/lib/DealMakerAPI/models/post_webhooks_request.rb +1 -1
  46. data/lib/DealMakerAPI/models/put_deals_id_investors.rb +1 -1
  47. data/lib/DealMakerAPI/models/put_deals_id_script_tag_environment_request.rb +1 -1
  48. data/lib/DealMakerAPI/models/put_webhooks_id_request.rb +1 -1
  49. data/lib/DealMakerAPI/models/send_portal_invite_request.rb +225 -0
  50. data/lib/DealMakerAPI/models/v1_entities_address.rb +1 -1
  51. data/lib/DealMakerAPI/models/v1_entities_addresses.rb +1 -1
  52. data/lib/DealMakerAPI/models/v1_entities_attachment.rb +1 -1
  53. data/lib/DealMakerAPI/models/v1_entities_background_check_search.rb +1 -1
  54. data/lib/DealMakerAPI/models/v1_entities_bulk_upload.rb +1 -1
  55. data/lib/DealMakerAPI/models/v1_entities_bulk_upload_detail.rb +1 -1
  56. data/lib/DealMakerAPI/models/v1_entities_bulk_upload_details.rb +1 -1
  57. data/lib/DealMakerAPI/models/v1_entities_bulk_uploads.rb +1 -1
  58. data/lib/DealMakerAPI/models/v1_entities_company.rb +1 -1
  59. data/lib/DealMakerAPI/models/v1_entities_company_deal.rb +1 -1
  60. data/lib/DealMakerAPI/models/v1_entities_company_deals.rb +1 -1
  61. data/lib/DealMakerAPI/models/v1_entities_countries.rb +1 -1
  62. data/lib/DealMakerAPI/models/v1_entities_country.rb +1 -1
  63. data/lib/DealMakerAPI/models/v1_entities_deal.rb +1 -1
  64. data/lib/DealMakerAPI/models/v1_entities_deal_enterprise.rb +1 -1
  65. data/lib/DealMakerAPI/models/v1_entities_deal_funding_metrics.rb +1 -1
  66. data/lib/DealMakerAPI/models/v1_entities_deal_investor_metrics.rb +1 -1
  67. data/lib/DealMakerAPI/models/v1_entities_deal_issuer.rb +1 -1
  68. data/lib/DealMakerAPI/models/v1_entities_deal_setup.rb +1 -1
  69. data/lib/DealMakerAPI/models/v1_entities_deal_setup_user.rb +1 -1
  70. data/lib/DealMakerAPI/models/v1_entities_deals.rb +1 -1
  71. data/lib/DealMakerAPI/models/v1_entities_dividend.rb +1 -1
  72. data/lib/DealMakerAPI/models/v1_entities_dividends.rb +1 -1
  73. data/lib/DealMakerAPI/models/v1_entities_express_wire_instruction.rb +1 -1
  74. data/lib/DealMakerAPI/models/v1_entities_express_wire_instructions.rb +1 -1
  75. data/lib/DealMakerAPI/models/v1_entities_generic_response.rb +1 -1
  76. data/lib/DealMakerAPI/models/v1_entities_investor.rb +15 -5
  77. data/lib/DealMakerAPI/models/v1_entities_investor_otp_access_link.rb +1 -1
  78. data/lib/DealMakerAPI/models/v1_entities_investor_profile_address.rb +1 -1
  79. data/lib/DealMakerAPI/models/v1_entities_investor_profile_corporation.rb +1 -1
  80. data/lib/DealMakerAPI/models/v1_entities_investor_profile_fields_account_holder.rb +1 -1
  81. data/lib/DealMakerAPI/models/v1_entities_investor_profile_fields_beneficial_owner.rb +1 -1
  82. data/lib/DealMakerAPI/models/v1_entities_investor_profile_fields_corporation.rb +1 -1
  83. data/lib/DealMakerAPI/models/v1_entities_investor_profile_fields_primary_holder.rb +1 -1
  84. data/lib/DealMakerAPI/models/v1_entities_investor_profile_fields_signing_officer.rb +1 -1
  85. data/lib/DealMakerAPI/models/v1_entities_investor_profile_fields_trust.rb +1 -1
  86. data/lib/DealMakerAPI/models/v1_entities_investor_profile_fields_trustee.rb +274 -0
  87. data/lib/DealMakerAPI/models/v1_entities_investor_profile_individual.rb +1 -1
  88. data/lib/DealMakerAPI/models/v1_entities_investor_profile_item.rb +1 -1
  89. data/lib/DealMakerAPI/models/v1_entities_investor_profile_joint.rb +1 -1
  90. data/lib/DealMakerAPI/models/v1_entities_investor_profile_owner.rb +1 -1
  91. data/lib/DealMakerAPI/models/v1_entities_investor_profile_trust.rb +2 -2
  92. data/lib/DealMakerAPI/models/v1_entities_investor_profiles.rb +1 -1
  93. data/lib/DealMakerAPI/models/v1_entities_investor_user.rb +1 -1
  94. data/lib/DealMakerAPI/models/v1_entities_investors.rb +1 -1
  95. data/lib/DealMakerAPI/models/v1_entities_payments_self_serve_onboarding_payout_account_details_result.rb +226 -0
  96. data/lib/DealMakerAPI/models/v1_entities_payments_self_serve_onboarding_qualification_questionnaire_result.rb +226 -0
  97. data/lib/DealMakerAPI/models/v1_entities_presigned_url_result.rb +1 -1
  98. data/lib/DealMakerAPI/models/v1_entities_shareholder.rb +1 -1
  99. data/lib/DealMakerAPI/models/v1_entities_shareholders.rb +1 -1
  100. data/lib/DealMakerAPI/models/v1_entities_shareholders_tags.rb +1 -1
  101. data/lib/DealMakerAPI/models/v1_entities_state.rb +1 -1
  102. data/lib/DealMakerAPI/models/v1_entities_subscription_agreement.rb +1 -1
  103. data/lib/DealMakerAPI/models/v1_entities_webhooks_deal.rb +1 -1
  104. data/lib/DealMakerAPI/models/v1_entities_webhooks_security_token.rb +1 -1
  105. data/lib/DealMakerAPI/models/v1_entities_webhooks_subscription.rb +1 -1
  106. data/lib/DealMakerAPI/models/v1_entities_webhooks_subscription_deal.rb +1 -1
  107. data/lib/DealMakerAPI/models/v1_entities_webhooks_subscription_deals.rb +1 -1
  108. data/lib/DealMakerAPI/version.rb +1 -1
  109. data/lib/DealMakerAPI.rb +4 -1
  110. data/spec/api/company_api_spec.rb +14 -0
  111. data/spec/api/deal_api_spec.rb +12 -0
  112. data/spec/api/default_api_spec.rb +36 -0
  113. data/spec/api/investor_api_spec.rb +1 -1
  114. data/spec/models/patch_investor_profiles_trusts_trustees_inner_spec.rb +6 -0
  115. data/spec/models/post_investor_profiles_trusts_trustees_inner_spec.rb +6 -0
  116. data/spec/{api/deal_setup_api_spec.rb → models/send_portal_invite_request_spec.rb} +13 -18
  117. data/{lib/DealMakerAPI/api/deal_setup_api.rb → spec/models/v1_entities_investor_profile_fields_trustee_spec.rb} +49 -67
  118. data/spec/models/v1_entities_investor_spec.rb +6 -0
  119. data/spec/models/v1_entities_payments_self_serve_onboarding_payout_account_details_result_spec.rb +42 -0
  120. data/spec/models/v1_entities_payments_self_serve_onboarding_qualification_questionnaire_result_spec.rb +42 -0
  121. metadata +92 -80
  122. data/docs/DealSetupApi.md +0 -74
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: fbf6611ed7663c8cdd83c2e554a0df5acef49862b7abdbb3dd5e6c7ba1970339
4
- data.tar.gz: f71a80255820527088c1ca102e025aa7226f862347761020d1005fc93b335507
3
+ metadata.gz: eef65ab76c842d742b22d68316eb7bdc4f4547fd72203625cc9f65cbeb8979f8
4
+ data.tar.gz: 77067db4f04aa8e132c969c35b1155d17d22dc1617107a7b323b7b1222c48783
5
5
  SHA512:
6
- metadata.gz: 1e1b507ae45d0c23393c0cac2f02631b06a944e4a16f8bd5c2b0bcaead315e20a05755a7c92245e2a3b742406790afeaa610af68e08f2d6019b5dd7928987c82
7
- data.tar.gz: 360d60a402cad34c3e06e266cbdd84c5e8f7afac95d077b4f54bd5e8ec8bc34f8768479aaa642dfd0c8269234701f3c5b55aa8a40651c54e3e01348d1af0f9a0
6
+ metadata.gz: 6479f29c9548a1f6af6a1cafdca443d3448aee1f3f4b7606b5255d211684a06c8b66f4d6a5674ceb65337af3942fa3efbfc798762a0a4f28a131f5d574f4641f
7
+ data.tar.gz: 6c26dcc0eef7ec93d086fc1ca90f9c98bd21e7c76d29d78417b607f5efa112d9cf0be50e53593235a01baff820c1de8b5e68f12d6b39eae80fd6a6dfe6f258ce
data/DealMakerAPI.gemspec CHANGED
@@ -26,6 +26,7 @@ Gem::Specification.new do |s|
26
26
  s.description = "A ruby wrapper for the DealMaker API"
27
27
  s.license = "MIT"
28
28
  s.required_ruby_version = ">= 2.7"
29
+ s.metadata = {}
29
30
 
30
31
  s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
31
32
 
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.89.5
341
+ - Package version: 0.90.1
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.89.5.gem
357
+ gem install ./DealMakerAPI-0.90.1.gem
358
358
  ```
359
359
 
360
- (for development, run `gem install --dev ./DealMakerAPI-0.89.5.gem` to install the development dependencies)
360
+ (for development, run `gem install --dev ./DealMakerAPI-0.90.1.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.89.5'
366
+ gem 'DealMakerAPI', '~> 0.90.1'
367
367
 
368
368
  ### Install from Git
369
369
 
@@ -421,10 +421,11 @@ 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* | [**send_portal_invite**](docs/CompanyApi.md#send_portal_invite) | **POST** /companies/{id}/shareholders/{shareholder_id}/send_portal_invite | Send portal invite to shareholder
424
425
  *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
+ *DealMakerAPI::DealApi* | [**create_deal_setup**](docs/DealApi.md#create_deal_setup) | **POST** /deal_setups | Create deal setup
425
427
  *DealMakerAPI::DealApi* | [**get_deal**](docs/DealApi.md#get_deal) | **GET** /deals/{id} | Get deal by Deal ID
426
428
  *DealMakerAPI::DealApi* | [**list_deals**](docs/DealApi.md#list_deals) | **GET** /deals | List available deals
427
- *DealMakerAPI::DealSetupApi* | [**create_deal_setup**](docs/DealSetupApi.md#create_deal_setup) | **POST** /deal_setups | Create deal setup
428
429
  *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.
429
430
  *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
431
  *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,6 +433,9 @@ Class | Method | HTTP request | Description
432
433
  *DealMakerAPI::DefaultApi* | [**get_webhooks_deal_id**](docs/DefaultApi.md#get_webhooks_deal_id) | **GET** /webhooks/deal/{id} | Finds a deal using the id
433
434
  *DealMakerAPI::DefaultApi* | [**get_webhooks_deals_search**](docs/DefaultApi.md#get_webhooks_deals_search) | **GET** /webhooks/deals/search | Searches for deals for a given user
434
435
  *DealMakerAPI::DefaultApi* | [**get_webhooks_security_token**](docs/DefaultApi.md#get_webhooks_security_token) | **GET** /webhooks/security_token | Creates a new security token for webhook subscription
436
+ *DealMakerAPI::DefaultApi* | [**post_deals_deal_id_payment_onboarding_questionnaire_payout_account_details_submit**](docs/DefaultApi.md#post_deals_deal_id_payment_onboarding_questionnaire_payout_account_details_submit) | **POST** /deals/{deal_id}/payment_onboarding/questionnaire/payout_account_details/submit | Submit a payout account details form
437
+ *DealMakerAPI::DefaultApi* | [**post_deals_deal_id_payment_onboarding_questionnaire_qualification_questionnaire_response_submit**](docs/DefaultApi.md#post_deals_deal_id_payment_onboarding_questionnaire_qualification_questionnaire_response_submit) | **POST** /deals/{deal_id}/payment_onboarding/questionnaire/qualification_questionnaire/response/submit | Submit a qualification questionnaire response
438
+ *DealMakerAPI::DefaultApi* | [**post_deals_deal_id_payment_onboarding_questionnaire_qualification_questionnaire_submit**](docs/DefaultApi.md#post_deals_deal_id_payment_onboarding_questionnaire_qualification_questionnaire_submit) | **POST** /deals/{deal_id}/payment_onboarding/questionnaire/qualification_questionnaire/submit | Submit a qualification questionnaire form
435
439
  *DealMakerAPI::DefaultApi* | [**post_webhooks**](docs/DefaultApi.md#post_webhooks) | **POST** /webhooks | Creates a webhook subscription which is associated to the user
436
440
  *DealMakerAPI::DefaultApi* | [**put_webhooks_id**](docs/DefaultApi.md#put_webhooks_id) | **PUT** /webhooks/{id} | Updates webhook subscription and webhooks subcription deals
437
441
  *DealMakerAPI::InvestorApi* | [**add506c_document**](docs/InvestorApi.md#add506c_document) | **POST** /deals/{id}/investors/{investor_id}/add_506c_document | Add 506c document for deal investor
@@ -495,6 +499,7 @@ Class | Method | HTTP request | Description
495
499
  - [DealMakerAPI::PutDealsIdInvestors](docs/PutDealsIdInvestors.md)
496
500
  - [DealMakerAPI::PutDealsIdScriptTagEnvironmentRequest](docs/PutDealsIdScriptTagEnvironmentRequest.md)
497
501
  - [DealMakerAPI::PutWebhooksIdRequest](docs/PutWebhooksIdRequest.md)
502
+ - [DealMakerAPI::SendPortalInviteRequest](docs/SendPortalInviteRequest.md)
498
503
  - [DealMakerAPI::V1EntitiesAddress](docs/V1EntitiesAddress.md)
499
504
  - [DealMakerAPI::V1EntitiesAddresses](docs/V1EntitiesAddresses.md)
500
505
  - [DealMakerAPI::V1EntitiesAttachment](docs/V1EntitiesAttachment.md)
@@ -531,6 +536,7 @@ Class | Method | HTTP request | Description
531
536
  - [DealMakerAPI::V1EntitiesInvestorProfileFieldsPrimaryHolder](docs/V1EntitiesInvestorProfileFieldsPrimaryHolder.md)
532
537
  - [DealMakerAPI::V1EntitiesInvestorProfileFieldsSigningOfficer](docs/V1EntitiesInvestorProfileFieldsSigningOfficer.md)
533
538
  - [DealMakerAPI::V1EntitiesInvestorProfileFieldsTrust](docs/V1EntitiesInvestorProfileFieldsTrust.md)
539
+ - [DealMakerAPI::V1EntitiesInvestorProfileFieldsTrustee](docs/V1EntitiesInvestorProfileFieldsTrustee.md)
534
540
  - [DealMakerAPI::V1EntitiesInvestorProfileIndividual](docs/V1EntitiesInvestorProfileIndividual.md)
535
541
  - [DealMakerAPI::V1EntitiesInvestorProfileItem](docs/V1EntitiesInvestorProfileItem.md)
536
542
  - [DealMakerAPI::V1EntitiesInvestorProfileJoint](docs/V1EntitiesInvestorProfileJoint.md)
@@ -539,6 +545,8 @@ Class | Method | HTTP request | Description
539
545
  - [DealMakerAPI::V1EntitiesInvestorProfiles](docs/V1EntitiesInvestorProfiles.md)
540
546
  - [DealMakerAPI::V1EntitiesInvestorUser](docs/V1EntitiesInvestorUser.md)
541
547
  - [DealMakerAPI::V1EntitiesInvestors](docs/V1EntitiesInvestors.md)
548
+ - [DealMakerAPI::V1EntitiesPaymentsSelfServeOnboardingPayoutAccountDetailsResult](docs/V1EntitiesPaymentsSelfServeOnboardingPayoutAccountDetailsResult.md)
549
+ - [DealMakerAPI::V1EntitiesPaymentsSelfServeOnboardingQualificationQuestionnaireResult](docs/V1EntitiesPaymentsSelfServeOnboardingQualificationQuestionnaireResult.md)
542
550
  - [DealMakerAPI::V1EntitiesPresignedUrlResult](docs/V1EntitiesPresignedUrlResult.md)
543
551
  - [DealMakerAPI::V1EntitiesShareholder](docs/V1EntitiesShareholder.md)
544
552
  - [DealMakerAPI::V1EntitiesShareholders](docs/V1EntitiesShareholders.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
+ | [**send_portal_invite**](CompanyApi.md#send_portal_invite) | **POST** /companies/{id}/shareholders/{shareholder_id}/send_portal_invite | Send portal invite to shareholder |
18
19
 
19
20
 
20
21
  ## create_bulk_upload
@@ -780,3 +781,74 @@ No authorization required
780
781
  - **Content-Type**: Not defined
781
782
  - **Accept**: application/json
782
783
 
784
+
785
+ ## send_portal_invite
786
+
787
+ > send_portal_invite(id, shareholder_id, opts)
788
+
789
+ Send portal invite to shareholder
790
+
791
+ Send portal invite to shareholder.
792
+
793
+ ### Examples
794
+
795
+ ```ruby
796
+ require 'time'
797
+ require 'DealMakerAPI'
798
+ # setup authorization
799
+ DealMakerAPI.configure do |config|end
800
+
801
+ api_instance = DealMakerAPI::CompanyApi.new
802
+ id = 56 # Integer |
803
+ shareholder_id = 56 # Integer |
804
+ opts = {
805
+ send_portal_invite_request: DealMakerAPI::SendPortalInviteRequest.new # SendPortalInviteRequest |
806
+ }
807
+
808
+ begin
809
+ # Send portal invite to shareholder
810
+ api_instance.send_portal_invite(id, shareholder_id, opts)
811
+ rescue DealMakerAPI::ApiError => e
812
+ puts "Error when calling CompanyApi->send_portal_invite: #{e}"
813
+ end
814
+ ```
815
+
816
+ #### Using the send_portal_invite_with_http_info variant
817
+
818
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
819
+
820
+ > <Array(nil, Integer, Hash)> send_portal_invite_with_http_info(id, shareholder_id, opts)
821
+
822
+ ```ruby
823
+ begin
824
+ # Send portal invite to shareholder
825
+ data, status_code, headers = api_instance.send_portal_invite_with_http_info(id, shareholder_id, opts)
826
+ p status_code # => 2xx
827
+ p headers # => { ... }
828
+ p data # => nil
829
+ rescue DealMakerAPI::ApiError => e
830
+ puts "Error when calling CompanyApi->send_portal_invite_with_http_info: #{e}"
831
+ end
832
+ ```
833
+
834
+ ### Parameters
835
+
836
+ | Name | Type | Description | Notes |
837
+ | ---- | ---- | ----------- | ----- |
838
+ | **id** | **Integer** | | |
839
+ | **shareholder_id** | **Integer** | | |
840
+ | **send_portal_invite_request** | [**SendPortalInviteRequest**](SendPortalInviteRequest.md) | | [optional] |
841
+
842
+ ### Return type
843
+
844
+ nil (empty response body)
845
+
846
+ ### Authorization
847
+
848
+ No authorization required
849
+
850
+ ### HTTP request headers
851
+
852
+ - **Content-Type**: application/json
853
+ - **Accept**: Not defined
854
+
data/docs/DealApi.md CHANGED
@@ -4,10 +4,77 @@ All URIs are relative to *http://api.dealmaker.tech*
4
4
 
5
5
  | Method | HTTP request | Description |
6
6
  | ------ | ------------ | ----------- |
7
+ | [**create_deal_setup**](DealApi.md#create_deal_setup) | **POST** /deal_setups | Create deal setup |
7
8
  | [**get_deal**](DealApi.md#get_deal) | **GET** /deals/{id} | Get deal by Deal ID |
8
9
  | [**list_deals**](DealApi.md#list_deals) | **GET** /deals | List available deals |
9
10
 
10
11
 
12
+ ## create_deal_setup
13
+
14
+ > <V1EntitiesDealSetup> create_deal_setup(create_deal_setup_request)
15
+
16
+ Create deal setup
17
+
18
+ Create deal setup
19
+
20
+ ### Examples
21
+
22
+ ```ruby
23
+ require 'time'
24
+ require 'DealMakerAPI'
25
+ # setup authorization
26
+ DealMakerAPI.configure do |config|end
27
+
28
+ api_instance = DealMakerAPI::DealApi.new
29
+ create_deal_setup_request = DealMakerAPI::CreateDealSetupRequest.new({invoicing_email: 'invoicing_email_example', offering_type: 'other', title: 'title_example', company_id: 37}) # CreateDealSetupRequest |
30
+
31
+ begin
32
+ # Create deal setup
33
+ result = api_instance.create_deal_setup(create_deal_setup_request)
34
+ p result
35
+ rescue DealMakerAPI::ApiError => e
36
+ puts "Error when calling DealApi->create_deal_setup: #{e}"
37
+ end
38
+ ```
39
+
40
+ #### Using the create_deal_setup_with_http_info variant
41
+
42
+ This returns an Array which contains the response data, status code and headers.
43
+
44
+ > <Array(<V1EntitiesDealSetup>, Integer, Hash)> create_deal_setup_with_http_info(create_deal_setup_request)
45
+
46
+ ```ruby
47
+ begin
48
+ # Create deal setup
49
+ data, status_code, headers = api_instance.create_deal_setup_with_http_info(create_deal_setup_request)
50
+ p status_code # => 2xx
51
+ p headers # => { ... }
52
+ p data # => <V1EntitiesDealSetup>
53
+ rescue DealMakerAPI::ApiError => e
54
+ puts "Error when calling DealApi->create_deal_setup_with_http_info: #{e}"
55
+ end
56
+ ```
57
+
58
+ ### Parameters
59
+
60
+ | Name | Type | Description | Notes |
61
+ | ---- | ---- | ----------- | ----- |
62
+ | **create_deal_setup_request** | [**CreateDealSetupRequest**](CreateDealSetupRequest.md) | | |
63
+
64
+ ### Return type
65
+
66
+ [**V1EntitiesDealSetup**](V1EntitiesDealSetup.md)
67
+
68
+ ### Authorization
69
+
70
+ No authorization required
71
+
72
+ ### HTTP request headers
73
+
74
+ - **Content-Type**: application/json
75
+ - **Accept**: application/json
76
+
77
+
11
78
  ## get_deal
12
79
 
13
80
  > <V1EntitiesDeal> get_deal(id)
data/docs/DefaultApi.md CHANGED
@@ -10,6 +10,9 @@ All URIs are relative to *http://api.dealmaker.tech*
10
10
  | [**get_webhooks_deal_id**](DefaultApi.md#get_webhooks_deal_id) | **GET** /webhooks/deal/{id} | Finds a deal using the id |
11
11
  | [**get_webhooks_deals_search**](DefaultApi.md#get_webhooks_deals_search) | **GET** /webhooks/deals/search | Searches for deals for a given user |
12
12
  | [**get_webhooks_security_token**](DefaultApi.md#get_webhooks_security_token) | **GET** /webhooks/security_token | Creates a new security token for webhook subscription |
13
+ | [**post_deals_deal_id_payment_onboarding_questionnaire_payout_account_details_submit**](DefaultApi.md#post_deals_deal_id_payment_onboarding_questionnaire_payout_account_details_submit) | **POST** /deals/{deal_id}/payment_onboarding/questionnaire/payout_account_details/submit | Submit a payout account details form |
14
+ | [**post_deals_deal_id_payment_onboarding_questionnaire_qualification_questionnaire_response_submit**](DefaultApi.md#post_deals_deal_id_payment_onboarding_questionnaire_qualification_questionnaire_response_submit) | **POST** /deals/{deal_id}/payment_onboarding/questionnaire/qualification_questionnaire/response/submit | Submit a qualification questionnaire response |
15
+ | [**post_deals_deal_id_payment_onboarding_questionnaire_qualification_questionnaire_submit**](DefaultApi.md#post_deals_deal_id_payment_onboarding_questionnaire_qualification_questionnaire_submit) | **POST** /deals/{deal_id}/payment_onboarding/questionnaire/qualification_questionnaire/submit | Submit a qualification questionnaire form |
13
16
  | [**post_webhooks**](DefaultApi.md#post_webhooks) | **POST** /webhooks | Creates a webhook subscription which is associated to the user |
14
17
  | [**put_webhooks_id**](DefaultApi.md#put_webhooks_id) | **PUT** /webhooks/{id} | Updates webhook subscription and webhooks subcription deals |
15
18
 
@@ -412,6 +415,203 @@ No authorization required
412
415
  - **Accept**: application/json
413
416
 
414
417
 
418
+ ## post_deals_deal_id_payment_onboarding_questionnaire_payout_account_details_submit
419
+
420
+ > <V1EntitiesPaymentsSelfServeOnboardingPayoutAccountDetailsResult> post_deals_deal_id_payment_onboarding_questionnaire_payout_account_details_submit(deal_id)
421
+
422
+ Submit a payout account details form
423
+
424
+ Submit a payout account details form
425
+
426
+ ### Examples
427
+
428
+ ```ruby
429
+ require 'time'
430
+ require 'DealMakerAPI'
431
+ # setup authorization
432
+ DealMakerAPI.configure do |config|end
433
+
434
+ api_instance = DealMakerAPI::DefaultApi.new
435
+ deal_id = 56 # Integer |
436
+
437
+ begin
438
+ # Submit a payout account details form
439
+ result = api_instance.post_deals_deal_id_payment_onboarding_questionnaire_payout_account_details_submit(deal_id)
440
+ p result
441
+ rescue DealMakerAPI::ApiError => e
442
+ puts "Error when calling DefaultApi->post_deals_deal_id_payment_onboarding_questionnaire_payout_account_details_submit: #{e}"
443
+ end
444
+ ```
445
+
446
+ #### Using the post_deals_deal_id_payment_onboarding_questionnaire_payout_account_details_submit_with_http_info variant
447
+
448
+ This returns an Array which contains the response data, status code and headers.
449
+
450
+ > <Array(<V1EntitiesPaymentsSelfServeOnboardingPayoutAccountDetailsResult>, Integer, Hash)> post_deals_deal_id_payment_onboarding_questionnaire_payout_account_details_submit_with_http_info(deal_id)
451
+
452
+ ```ruby
453
+ begin
454
+ # Submit a payout account details form
455
+ data, status_code, headers = api_instance.post_deals_deal_id_payment_onboarding_questionnaire_payout_account_details_submit_with_http_info(deal_id)
456
+ p status_code # => 2xx
457
+ p headers # => { ... }
458
+ p data # => <V1EntitiesPaymentsSelfServeOnboardingPayoutAccountDetailsResult>
459
+ rescue DealMakerAPI::ApiError => e
460
+ puts "Error when calling DefaultApi->post_deals_deal_id_payment_onboarding_questionnaire_payout_account_details_submit_with_http_info: #{e}"
461
+ end
462
+ ```
463
+
464
+ ### Parameters
465
+
466
+ | Name | Type | Description | Notes |
467
+ | ---- | ---- | ----------- | ----- |
468
+ | **deal_id** | **Integer** | | |
469
+
470
+ ### Return type
471
+
472
+ [**V1EntitiesPaymentsSelfServeOnboardingPayoutAccountDetailsResult**](V1EntitiesPaymentsSelfServeOnboardingPayoutAccountDetailsResult.md)
473
+
474
+ ### Authorization
475
+
476
+ No authorization required
477
+
478
+ ### HTTP request headers
479
+
480
+ - **Content-Type**: Not defined
481
+ - **Accept**: application/json
482
+
483
+
484
+ ## post_deals_deal_id_payment_onboarding_questionnaire_qualification_questionnaire_response_submit
485
+
486
+ > post_deals_deal_id_payment_onboarding_questionnaire_qualification_questionnaire_response_submit(deal_id)
487
+
488
+ Submit a qualification questionnaire response
489
+
490
+ Submit a qualification questionnaire response
491
+
492
+ ### Examples
493
+
494
+ ```ruby
495
+ require 'time'
496
+ require 'DealMakerAPI'
497
+ # setup authorization
498
+ DealMakerAPI.configure do |config|end
499
+
500
+ api_instance = DealMakerAPI::DefaultApi.new
501
+ deal_id = 56 # Integer |
502
+
503
+ begin
504
+ # Submit a qualification questionnaire response
505
+ api_instance.post_deals_deal_id_payment_onboarding_questionnaire_qualification_questionnaire_response_submit(deal_id)
506
+ rescue DealMakerAPI::ApiError => e
507
+ puts "Error when calling DefaultApi->post_deals_deal_id_payment_onboarding_questionnaire_qualification_questionnaire_response_submit: #{e}"
508
+ end
509
+ ```
510
+
511
+ #### Using the post_deals_deal_id_payment_onboarding_questionnaire_qualification_questionnaire_response_submit_with_http_info variant
512
+
513
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
514
+
515
+ > <Array(nil, Integer, Hash)> post_deals_deal_id_payment_onboarding_questionnaire_qualification_questionnaire_response_submit_with_http_info(deal_id)
516
+
517
+ ```ruby
518
+ begin
519
+ # Submit a qualification questionnaire response
520
+ data, status_code, headers = api_instance.post_deals_deal_id_payment_onboarding_questionnaire_qualification_questionnaire_response_submit_with_http_info(deal_id)
521
+ p status_code # => 2xx
522
+ p headers # => { ... }
523
+ p data # => nil
524
+ rescue DealMakerAPI::ApiError => e
525
+ puts "Error when calling DefaultApi->post_deals_deal_id_payment_onboarding_questionnaire_qualification_questionnaire_response_submit_with_http_info: #{e}"
526
+ end
527
+ ```
528
+
529
+ ### Parameters
530
+
531
+ | Name | Type | Description | Notes |
532
+ | ---- | ---- | ----------- | ----- |
533
+ | **deal_id** | **Integer** | | |
534
+
535
+ ### Return type
536
+
537
+ nil (empty response body)
538
+
539
+ ### Authorization
540
+
541
+ No authorization required
542
+
543
+ ### HTTP request headers
544
+
545
+ - **Content-Type**: Not defined
546
+ - **Accept**: Not defined
547
+
548
+
549
+ ## post_deals_deal_id_payment_onboarding_questionnaire_qualification_questionnaire_submit
550
+
551
+ > <V1EntitiesPaymentsSelfServeOnboardingQualificationQuestionnaireResult> post_deals_deal_id_payment_onboarding_questionnaire_qualification_questionnaire_submit(deal_id)
552
+
553
+ Submit a qualification questionnaire form
554
+
555
+ Submit a qualification questionnaire form
556
+
557
+ ### Examples
558
+
559
+ ```ruby
560
+ require 'time'
561
+ require 'DealMakerAPI'
562
+ # setup authorization
563
+ DealMakerAPI.configure do |config|end
564
+
565
+ api_instance = DealMakerAPI::DefaultApi.new
566
+ deal_id = 56 # Integer |
567
+
568
+ begin
569
+ # Submit a qualification questionnaire form
570
+ result = api_instance.post_deals_deal_id_payment_onboarding_questionnaire_qualification_questionnaire_submit(deal_id)
571
+ p result
572
+ rescue DealMakerAPI::ApiError => e
573
+ puts "Error when calling DefaultApi->post_deals_deal_id_payment_onboarding_questionnaire_qualification_questionnaire_submit: #{e}"
574
+ end
575
+ ```
576
+
577
+ #### Using the post_deals_deal_id_payment_onboarding_questionnaire_qualification_questionnaire_submit_with_http_info variant
578
+
579
+ This returns an Array which contains the response data, status code and headers.
580
+
581
+ > <Array(<V1EntitiesPaymentsSelfServeOnboardingQualificationQuestionnaireResult>, Integer, Hash)> post_deals_deal_id_payment_onboarding_questionnaire_qualification_questionnaire_submit_with_http_info(deal_id)
582
+
583
+ ```ruby
584
+ begin
585
+ # Submit a qualification questionnaire form
586
+ data, status_code, headers = api_instance.post_deals_deal_id_payment_onboarding_questionnaire_qualification_questionnaire_submit_with_http_info(deal_id)
587
+ p status_code # => 2xx
588
+ p headers # => { ... }
589
+ p data # => <V1EntitiesPaymentsSelfServeOnboardingQualificationQuestionnaireResult>
590
+ rescue DealMakerAPI::ApiError => e
591
+ puts "Error when calling DefaultApi->post_deals_deal_id_payment_onboarding_questionnaire_qualification_questionnaire_submit_with_http_info: #{e}"
592
+ end
593
+ ```
594
+
595
+ ### Parameters
596
+
597
+ | Name | Type | Description | Notes |
598
+ | ---- | ---- | ----------- | ----- |
599
+ | **deal_id** | **Integer** | | |
600
+
601
+ ### Return type
602
+
603
+ [**V1EntitiesPaymentsSelfServeOnboardingQualificationQuestionnaireResult**](V1EntitiesPaymentsSelfServeOnboardingQualificationQuestionnaireResult.md)
604
+
605
+ ### Authorization
606
+
607
+ No authorization required
608
+
609
+ ### HTTP request headers
610
+
611
+ - **Content-Type**: Not defined
612
+ - **Accept**: application/json
613
+
614
+
415
615
  ## post_webhooks
416
616
 
417
617
  > <V1EntitiesWebhooksSubscription> post_webhooks(post_webhooks_request)
data/docs/InvestorApi.md CHANGED
@@ -646,7 +646,7 @@ No authorization required
646
646
 
647
647
  Get OTP access link for deal investor
648
648
 
649
- Get OTP access link for deal investor by id
649
+ The access link for the investor. This is the access link for the specific investment, not the user. If the same user has multiple investments, each one will have a different access link. Please note that this access link expires every hour. In order to redirect the investor into their authentication screen, use the https://app.dealmaker.tech/deals/{{deal_id}}/investors/{{investor_id}}/otp_access url.
650
650
 
651
651
  ### Examples
652
652
 
@@ -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
+
@@ -31,6 +31,7 @@
31
31
  | **investor_profile** | **String** | | [optional] |
32
32
  | **investor_profile_id** | **Integer** | The investor profile id. | [optional] |
33
33
  | **checkout_state** | **String** | Current state on checkout page. | [optional] |
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] |
34
35
 
35
36
  ## Example
36
37
 
@@ -64,7 +65,8 @@ instance = DealMakerAPI::V1EntitiesInvestor.new(
64
65
  ranking_score: null,
65
66
  investor_profile: null,
66
67
  investor_profile_id: null,
67
- checkout_state: null
68
+ checkout_state: null,
69
+ legacy_flow_link: null
68
70
  )
69
71
  ```
70
72
 
@@ -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,20 @@
1
+ # DealMakerAPI::V1EntitiesPaymentsSelfServeOnboardingPayoutAccountDetailsResult
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **data** | **Object** | Data after successful payout account updating | [optional] |
8
+ | **error** | **Object** | Error after failed payout account updating | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'DealMakerAPI'
14
+
15
+ instance = DealMakerAPI::V1EntitiesPaymentsSelfServeOnboardingPayoutAccountDetailsResult.new(
16
+ data: null,
17
+ error: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,20 @@
1
+ # DealMakerAPI::V1EntitiesPaymentsSelfServeOnboardingQualificationQuestionnaireResult
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **onboarding_stage** | **String** | Onboarding stage | [optional] |
8
+ | **payout_account_country** | **String** | Payout account country | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'DealMakerAPI'
14
+
15
+ instance = DealMakerAPI::V1EntitiesPaymentsSelfServeOnboardingQualificationQuestionnaireResult.new(
16
+ onboarding_stage: null,
17
+ payout_account_country: null
18
+ )
19
+ ```
20
+