DealMakerAPI 0.102.1 → 0.103.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/DealMakerAPI.gemspec +1 -1
- data/README.md +28 -6
- data/docs/CompanyApi.md +68 -0
- data/docs/DealApi.md +80 -9
- data/docs/DefaultApi.md +136 -0
- data/docs/PaymentsApi.md +75 -0
- data/docs/SetupSmsVerificationRequest.md +18 -0
- data/docs/TestDocumentUploadEmailRequest.md +22 -0
- data/docs/UpdateUserPasswordRequest.md +4 -2
- data/docs/UserApi.md +340 -0
- data/docs/V1EntitiesAttachment.md +2 -0
- data/docs/V1EntitiesDealsInvestorsPaymentAchBankAccountSetupIntent.md +20 -0
- data/docs/V1EntitiesDealsProgress.md +20 -0
- data/docs/V1EntitiesDealsProgressColumn.md +22 -0
- data/docs/V1EntitiesDealsProgressPageSummary.md +32 -0
- data/docs/V1EntitiesUsersBinding.md +20 -0
- data/docs/V1EntitiesUsersFactor.md +22 -0
- data/docs/V1EntitiesUsersTwoFactorChannel.md +32 -0
- data/docs/V1EntitiesUsersTwoFactorChannels.md +18 -0
- data/docs/VerifyFactorRequest.md +18 -0
- data/docs/VerifySmsVerificationRequest.md +20 -0
- data/lib/DealMakerAPI/api/company_api.rb +73 -1
- data/lib/DealMakerAPI/api/country_api.rb +1 -1
- data/lib/DealMakerAPI/api/custom_emails_api.rb +1 -1
- data/lib/DealMakerAPI/api/deal_api.rb +85 -10
- data/lib/DealMakerAPI/api/deals_api.rb +1 -1
- data/lib/DealMakerAPI/api/default_api.rb +138 -1
- data/lib/DealMakerAPI/api/incentive_plan_api.rb +1 -1
- data/lib/DealMakerAPI/api/investor_api.rb +1 -1
- data/lib/DealMakerAPI/api/investor_profile_api.rb +1 -1
- data/lib/DealMakerAPI/api/payments_api.rb +89 -0
- data/lib/DealMakerAPI/api/shareholder_api.rb +1 -1
- data/lib/DealMakerAPI/api/upload_api.rb +1 -1
- data/lib/DealMakerAPI/api/user_api.rb +347 -1
- data/lib/DealMakerAPI/api/users_api.rb +1 -1
- data/lib/DealMakerAPI/api_client.rb +3 -3
- data/lib/DealMakerAPI/api_error.rb +1 -1
- data/lib/DealMakerAPI/configuration.rb +1 -1
- data/lib/DealMakerAPI/models/add506c_document_request.rb +1 -1
- data/lib/DealMakerAPI/models/add_document_request.rb +1 -1
- data/lib/DealMakerAPI/models/bulk_upload_investors_request.rb +1 -1
- data/lib/DealMakerAPI/models/create_bulk_upload_detail_request.rb +1 -1
- data/lib/DealMakerAPI/models/create_bulk_upload_request.rb +1 -1
- data/lib/DealMakerAPI/models/create_company_request.rb +1 -1
- data/lib/DealMakerAPI/models/create_deal_setup_request.rb +1 -1
- data/lib/DealMakerAPI/models/create_email_template_request.rb +1 -1
- data/lib/DealMakerAPI/models/create_members_bulk_upload_request.rb +1 -1
- data/lib/DealMakerAPI/models/create_shareholder_action_request.rb +1 -1
- data/lib/DealMakerAPI/models/edit_investor_tags_request.rb +1 -1
- data/lib/DealMakerAPI/models/generate_url_request.rb +1 -1
- data/lib/DealMakerAPI/models/get_access_token_request.rb +1 -1
- data/lib/DealMakerAPI/models/patch_deal_incentive_plan_request.rb +1 -1
- data/lib/DealMakerAPI/models/patch_investor_profiles_corporations.rb +1 -1
- data/lib/DealMakerAPI/models/patch_investor_profiles_corporations_beneficial_owners_inner.rb +1 -1
- data/lib/DealMakerAPI/models/patch_investor_profiles_individuals.rb +1 -1
- data/lib/DealMakerAPI/models/patch_investor_profiles_joints.rb +1 -1
- data/lib/DealMakerAPI/models/patch_investor_profiles_managed.rb +1 -1
- data/lib/DealMakerAPI/models/patch_investor_profiles_trusts.rb +1 -1
- data/lib/DealMakerAPI/models/patch_investor_profiles_trusts_trustees_inner.rb +1 -1
- data/lib/DealMakerAPI/models/patch_investor_request.rb +1 -1
- data/lib/DealMakerAPI/models/post_deal_incentive_plan_request.rb +1 -1
- data/lib/DealMakerAPI/models/post_deals_id_investors.rb +1 -1
- data/lib/DealMakerAPI/models/post_investor_profiles_corporations.rb +1 -1
- data/lib/DealMakerAPI/models/post_investor_profiles_corporations_beneficial_owners_inner.rb +1 -1
- data/lib/DealMakerAPI/models/post_investor_profiles_individuals.rb +1 -1
- data/lib/DealMakerAPI/models/post_investor_profiles_joints.rb +1 -1
- data/lib/DealMakerAPI/models/post_investor_profiles_managed.rb +1 -1
- data/lib/DealMakerAPI/models/post_investor_profiles_trusts.rb +1 -1
- data/lib/DealMakerAPI/models/post_investor_profiles_trusts_trustees_inner.rb +1 -1
- data/lib/DealMakerAPI/models/post_webhooks_request.rb +1 -1
- data/lib/DealMakerAPI/models/put_deals_id_investors.rb +1 -1
- data/lib/DealMakerAPI/models/put_deals_id_script_tag_environment_request.rb +1 -1
- data/lib/DealMakerAPI/models/put_webhooks_id_request.rb +1 -1
- data/lib/DealMakerAPI/models/request_new_document_request.rb +1 -1
- data/lib/DealMakerAPI/models/run_background_search_request.rb +1 -1
- data/lib/DealMakerAPI/models/send_portal_invite_request.rb +1 -1
- data/lib/DealMakerAPI/models/setup_sms_verification_request.rb +222 -0
- data/lib/DealMakerAPI/models/test_document_upload_email_request.rb +256 -0
- data/lib/DealMakerAPI/models/update_user_password_request.rb +16 -6
- data/lib/DealMakerAPI/models/v1_entities_address.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_addresses.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_attachment.rb +12 -2
- data/lib/DealMakerAPI/models/v1_entities_background_check_search.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_beefree_access_token.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_bulk_upload.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_bulk_upload_detail.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_bulk_upload_details.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_bulk_uploads.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_company.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_company_deal.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_company_deals.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_countries.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_country.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_deal.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_deal_enterprise.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_deal_funding_metrics.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_deal_investor_metrics.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_deal_issuer.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_deal_setup.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_deal_setup_user.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_deals.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_deals_incentive_plan.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_deals_incentive_plans_incentive_tier.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_deals_investors_payment_ach_bank_account_setup_intent.rb +226 -0
- data/lib/DealMakerAPI/models/v1_entities_deals_investors_payment_acss_bank_account_setup_intent.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_deals_price_details.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_deals_progress.rb +224 -0
- data/lib/DealMakerAPI/models/v1_entities_deals_progress_column.rb +235 -0
- data/lib/DealMakerAPI/models/v1_entities_deals_progress_page_summary.rb +286 -0
- data/lib/DealMakerAPI/models/v1_entities_dividend.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_dividends.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_email_event.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_email_events.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_email_template.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_express_wire_instruction.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_express_wire_instructions.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_generic_response.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_investor.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_investor_otp_access_link.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_investor_profile_address.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_investor_profile_corporation.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_investor_profile_fields_account_holder.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_investor_profile_fields_beneficial_owner.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_investor_profile_fields_beneficiary.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_investor_profile_fields_corporation.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_investor_profile_fields_primary_holder.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_investor_profile_fields_provider.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_investor_profile_fields_signing_officer.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_investor_profile_fields_trust.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_investor_profile_fields_trustee.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_investor_profile_id.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_investor_profile_individual.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_investor_profile_item.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_investor_profile_joint.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_investor_profile_managed.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_investor_profile_owner.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_investor_profile_trust.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_investor_profiles.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_investor_search_entities.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_investor_search_entities_required_fields.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_investor_user.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_investors.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_members_bulk_upload.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_members_bulk_uploads.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_money_entity.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_payments_self_serve_onboarding_digital_payments_connection_data.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_payments_self_serve_onboarding_payout_account_details_data.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_payments_self_serve_onboarding_payout_account_details_result.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_payments_self_serve_onboarding_qualification_questionnaire_result.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_presigned_url_result.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_shareholder.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_shareholder_ledger.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_shareholders.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_shareholders_tags.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_state.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_subscription_agreement.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_user.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_users_binding.rb +225 -0
- data/lib/DealMakerAPI/models/v1_entities_users_factor.rb +235 -0
- data/lib/DealMakerAPI/models/v1_entities_users_two_factor_channel.rb +286 -0
- data/lib/DealMakerAPI/models/v1_entities_users_two_factor_channels.rb +215 -0
- data/lib/DealMakerAPI/models/v1_entities_webhooks_deal.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_webhooks_security_token.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_webhooks_subscription.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_webhooks_subscription_deal.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_webhooks_subscription_deals.rb +1 -1
- data/lib/DealMakerAPI/models/verify_factor_request.rb +222 -0
- data/lib/DealMakerAPI/models/verify_sms_verification_request.rb +239 -0
- data/lib/DealMakerAPI/version.rb +2 -2
- data/lib/DealMakerAPI.rb +14 -1
- data/spec/api/company_api_spec.rb +14 -1
- data/spec/api/country_api_spec.rb +1 -1
- data/spec/api/custom_emails_api_spec.rb +1 -1
- data/spec/api/deal_api_spec.rb +17 -3
- data/spec/api/deals_api_spec.rb +1 -1
- data/spec/api/default_api_spec.rb +26 -1
- data/spec/api/incentive_plan_api_spec.rb +1 -1
- data/spec/api/investor_api_spec.rb +1 -1
- data/spec/api/investor_profile_api_spec.rb +1 -1
- data/spec/api/payments_api_spec.rb +48 -0
- data/spec/api/shareholder_api_spec.rb +1 -1
- data/spec/api/upload_api_spec.rb +1 -1
- data/spec/api/user_api_spec.rb +64 -1
- data/spec/api/users_api_spec.rb +1 -1
- data/spec/models/add506c_document_request_spec.rb +1 -1
- data/spec/models/add_document_request_spec.rb +1 -1
- data/spec/models/bulk_upload_investors_request_spec.rb +1 -1
- data/spec/models/create_bulk_upload_detail_request_spec.rb +1 -1
- data/spec/models/create_bulk_upload_request_spec.rb +1 -1
- data/spec/models/create_company_request_spec.rb +1 -1
- data/spec/models/create_deal_setup_request_spec.rb +1 -1
- data/spec/models/create_email_template_request_spec.rb +1 -1
- data/spec/models/create_members_bulk_upload_request_spec.rb +1 -1
- data/spec/models/create_shareholder_action_request_spec.rb +1 -1
- data/spec/models/edit_investor_tags_request_spec.rb +1 -1
- data/spec/models/generate_url_request_spec.rb +1 -1
- data/spec/models/get_access_token_request_spec.rb +1 -1
- data/spec/models/patch_deal_incentive_plan_request_spec.rb +1 -1
- data/spec/models/patch_investor_profiles_corporations_beneficial_owners_inner_spec.rb +1 -1
- data/spec/models/patch_investor_profiles_corporations_spec.rb +1 -1
- data/spec/models/patch_investor_profiles_individuals_spec.rb +1 -1
- data/spec/models/patch_investor_profiles_joints_spec.rb +1 -1
- data/spec/models/patch_investor_profiles_managed_spec.rb +1 -1
- data/spec/models/patch_investor_profiles_trusts_spec.rb +1 -1
- data/spec/models/patch_investor_profiles_trusts_trustees_inner_spec.rb +1 -1
- data/spec/models/patch_investor_request_spec.rb +1 -1
- data/spec/models/post_deal_incentive_plan_request_spec.rb +1 -1
- data/spec/models/post_deals_id_investors_spec.rb +1 -1
- data/spec/models/post_investor_profiles_corporations_beneficial_owners_inner_spec.rb +1 -1
- data/spec/models/post_investor_profiles_corporations_spec.rb +1 -1
- data/spec/models/post_investor_profiles_individuals_spec.rb +1 -1
- data/spec/models/post_investor_profiles_joints_spec.rb +1 -1
- data/spec/models/post_investor_profiles_managed_spec.rb +1 -1
- data/spec/models/post_investor_profiles_trusts_spec.rb +1 -1
- data/spec/models/post_investor_profiles_trusts_trustees_inner_spec.rb +1 -1
- data/spec/models/post_webhooks_request_spec.rb +1 -1
- data/spec/models/put_deals_id_investors_spec.rb +1 -1
- data/spec/models/put_deals_id_script_tag_environment_request_spec.rb +1 -1
- data/spec/models/put_webhooks_id_request_spec.rb +1 -1
- data/spec/models/request_new_document_request_spec.rb +1 -1
- data/spec/models/run_background_search_request_spec.rb +1 -1
- data/spec/models/send_portal_invite_request_spec.rb +1 -1
- data/spec/models/setup_sms_verification_request_spec.rb +36 -0
- data/spec/models/test_document_upload_email_request_spec.rb +48 -0
- data/spec/models/update_user_password_request_spec.rb +7 -1
- data/spec/models/v1_entities_address_spec.rb +1 -1
- data/spec/models/v1_entities_addresses_spec.rb +1 -1
- data/spec/models/v1_entities_attachment_spec.rb +7 -1
- data/spec/models/v1_entities_background_check_search_spec.rb +1 -1
- data/spec/models/v1_entities_beefree_access_token_spec.rb +1 -1
- data/spec/models/v1_entities_bulk_upload_detail_spec.rb +1 -1
- data/spec/models/v1_entities_bulk_upload_details_spec.rb +1 -1
- data/spec/models/v1_entities_bulk_upload_spec.rb +1 -1
- data/spec/models/v1_entities_bulk_uploads_spec.rb +1 -1
- data/spec/models/v1_entities_company_deal_spec.rb +1 -1
- data/spec/models/v1_entities_company_deals_spec.rb +1 -1
- data/spec/models/v1_entities_company_spec.rb +1 -1
- data/spec/models/v1_entities_countries_spec.rb +1 -1
- data/spec/models/v1_entities_country_spec.rb +1 -1
- data/spec/models/v1_entities_deal_enterprise_spec.rb +1 -1
- data/spec/models/v1_entities_deal_funding_metrics_spec.rb +1 -1
- data/spec/models/v1_entities_deal_investor_metrics_spec.rb +1 -1
- data/spec/models/v1_entities_deal_issuer_spec.rb +1 -1
- data/spec/models/v1_entities_deal_setup_spec.rb +1 -1
- data/spec/models/v1_entities_deal_setup_user_spec.rb +1 -1
- data/spec/models/v1_entities_deal_spec.rb +1 -1
- data/spec/models/v1_entities_deals_incentive_plan_spec.rb +1 -1
- data/spec/models/v1_entities_deals_incentive_plans_incentive_tier_spec.rb +1 -1
- data/spec/models/v1_entities_deals_investors_payment_ach_bank_account_setup_intent_spec.rb +42 -0
- data/spec/models/v1_entities_deals_investors_payment_acss_bank_account_setup_intent_spec.rb +1 -1
- data/spec/models/v1_entities_deals_price_details_spec.rb +1 -1
- data/spec/models/v1_entities_deals_progress_column_spec.rb +48 -0
- data/spec/models/v1_entities_deals_progress_page_summary_spec.rb +78 -0
- data/spec/models/v1_entities_deals_progress_spec.rb +42 -0
- data/spec/models/v1_entities_deals_spec.rb +1 -1
- data/spec/models/v1_entities_dividend_spec.rb +1 -1
- data/spec/models/v1_entities_dividends_spec.rb +1 -1
- data/spec/models/v1_entities_email_event_spec.rb +1 -1
- data/spec/models/v1_entities_email_events_spec.rb +1 -1
- data/spec/models/v1_entities_email_template_spec.rb +1 -1
- data/spec/models/v1_entities_express_wire_instruction_spec.rb +1 -1
- data/spec/models/v1_entities_express_wire_instructions_spec.rb +1 -1
- data/spec/models/v1_entities_generic_response_spec.rb +1 -1
- data/spec/models/v1_entities_investor_otp_access_link_spec.rb +1 -1
- data/spec/models/v1_entities_investor_profile_address_spec.rb +1 -1
- data/spec/models/v1_entities_investor_profile_corporation_spec.rb +1 -1
- data/spec/models/v1_entities_investor_profile_fields_account_holder_spec.rb +1 -1
- data/spec/models/v1_entities_investor_profile_fields_beneficial_owner_spec.rb +1 -1
- data/spec/models/v1_entities_investor_profile_fields_beneficiary_spec.rb +1 -1
- data/spec/models/v1_entities_investor_profile_fields_corporation_spec.rb +1 -1
- data/spec/models/v1_entities_investor_profile_fields_primary_holder_spec.rb +1 -1
- data/spec/models/v1_entities_investor_profile_fields_provider_spec.rb +1 -1
- data/spec/models/v1_entities_investor_profile_fields_signing_officer_spec.rb +1 -1
- data/spec/models/v1_entities_investor_profile_fields_trust_spec.rb +1 -1
- data/spec/models/v1_entities_investor_profile_fields_trustee_spec.rb +1 -1
- data/spec/models/v1_entities_investor_profile_id_spec.rb +1 -1
- data/spec/models/v1_entities_investor_profile_individual_spec.rb +1 -1
- data/spec/models/v1_entities_investor_profile_item_spec.rb +1 -1
- data/spec/models/v1_entities_investor_profile_joint_spec.rb +1 -1
- data/spec/models/v1_entities_investor_profile_managed_spec.rb +1 -1
- data/spec/models/v1_entities_investor_profile_owner_spec.rb +1 -1
- data/spec/models/v1_entities_investor_profile_trust_spec.rb +1 -1
- data/spec/models/v1_entities_investor_profiles_spec.rb +1 -1
- data/spec/models/v1_entities_investor_search_entities_required_fields_spec.rb +1 -1
- data/spec/models/v1_entities_investor_search_entities_spec.rb +1 -1
- data/spec/models/v1_entities_investor_spec.rb +1 -1
- data/spec/models/v1_entities_investor_user_spec.rb +1 -1
- data/spec/models/v1_entities_investors_spec.rb +1 -1
- data/spec/models/v1_entities_members_bulk_upload_spec.rb +1 -1
- data/spec/models/v1_entities_members_bulk_uploads_spec.rb +1 -1
- data/spec/models/v1_entities_money_entity_spec.rb +1 -1
- data/spec/models/v1_entities_payments_self_serve_onboarding_digital_payments_connection_data_spec.rb +1 -1
- data/spec/models/v1_entities_payments_self_serve_onboarding_payout_account_details_data_spec.rb +1 -1
- data/spec/models/v1_entities_payments_self_serve_onboarding_payout_account_details_result_spec.rb +1 -1
- data/spec/models/v1_entities_payments_self_serve_onboarding_qualification_questionnaire_result_spec.rb +1 -1
- data/spec/models/v1_entities_presigned_url_result_spec.rb +1 -1
- data/spec/models/v1_entities_shareholder_ledger_spec.rb +1 -1
- data/spec/models/v1_entities_shareholder_spec.rb +1 -1
- data/spec/models/v1_entities_shareholders_spec.rb +1 -1
- data/spec/models/v1_entities_shareholders_tags_spec.rb +1 -1
- data/spec/models/v1_entities_state_spec.rb +1 -1
- data/spec/models/v1_entities_subscription_agreement_spec.rb +1 -1
- data/spec/models/v1_entities_user_spec.rb +1 -1
- data/spec/models/v1_entities_users_binding_spec.rb +42 -0
- data/spec/models/v1_entities_users_factor_spec.rb +48 -0
- data/spec/models/v1_entities_users_two_factor_channel_spec.rb +78 -0
- data/spec/models/v1_entities_users_two_factor_channels_spec.rb +36 -0
- data/spec/models/v1_entities_webhooks_deal_spec.rb +1 -1
- data/spec/models/v1_entities_webhooks_security_token_spec.rb +1 -1
- data/spec/models/v1_entities_webhooks_subscription_deal_spec.rb +1 -1
- data/spec/models/v1_entities_webhooks_subscription_deals_spec.rb +1 -1
- data/spec/models/v1_entities_webhooks_subscription_spec.rb +1 -1
- data/spec/models/verify_factor_request_spec.rb +36 -0
- data/spec/models/verify_sms_verification_request_spec.rb +42 -0
- data/spec/spec_helper.rb +1 -1
- metadata +163 -111
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: b596224e869194cac47cd79fc95d206ce00a22c0adc104dd21dc27bb2cb73927
|
|
4
|
+
data.tar.gz: 2bade916e5d343f27ead86bc5b9367cb542d96e113d41e17f158a7d3d3d057b1
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 67c091899d5eb68be62f0ef59dab839db01f0537894caa8c2a647a2310b6c394b6d3a2deffa625f07bbe87b68ffb34d6aabc45f6d550beb8cbb287ad1a6044d0
|
|
7
|
+
data.tar.gz: 3f63e8053936f54f04853585a113f0410c4cff20050b6d17d57b57674cb86179df802c34b653c79dee0d69835ea10ca48c71bcfcb78c2c593940b0123bd6dad2
|
data/DealMakerAPI.gemspec
CHANGED
data/README.md
CHANGED
|
@@ -338,8 +338,8 @@ 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.
|
|
342
|
-
- Generator version: 7.
|
|
341
|
+
- Package version: 0.103.6
|
|
342
|
+
- Generator version: 7.7.0-SNAPSHOT
|
|
343
343
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
|
344
344
|
|
|
345
345
|
## Installation
|
|
@@ -355,16 +355,16 @@ gem build DealMakerAPI.gemspec
|
|
|
355
355
|
Then either install the gem locally:
|
|
356
356
|
|
|
357
357
|
```shell
|
|
358
|
-
gem install ./DealMakerAPI-0.
|
|
358
|
+
gem install ./DealMakerAPI-0.103.6.gem
|
|
359
359
|
```
|
|
360
360
|
|
|
361
|
-
(for development, run `gem install --dev ./DealMakerAPI-0.
|
|
361
|
+
(for development, run `gem install --dev ./DealMakerAPI-0.103.6.gem` to install the development dependencies)
|
|
362
362
|
|
|
363
363
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
|
364
364
|
|
|
365
365
|
Finally add this to the Gemfile:
|
|
366
366
|
|
|
367
|
-
gem 'DealMakerAPI', '~> 0.
|
|
367
|
+
gem 'DealMakerAPI', '~> 0.103.6'
|
|
368
368
|
|
|
369
369
|
### Install from Git
|
|
370
370
|
|
|
@@ -433,9 +433,11 @@ Class | Method | HTTP request | Description
|
|
|
433
433
|
*DealMakerAPI::CompanyApi* | [**get_shareholder_ledger**](docs/CompanyApi.md#get_shareholder_ledger) | **GET** /companies/{id}/shareholder_ledger | Get shareholder ledger by company
|
|
434
434
|
*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
|
|
435
435
|
*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
|
|
436
|
+
*DealMakerAPI::CompanyApi* | [**test_document_upload_email**](docs/CompanyApi.md#test_document_upload_email) | **POST** /companies/{id}/documents/test_upload_email | Send document upload test email to given user
|
|
436
437
|
*DealMakerAPI::CountryApi* | [**get_country_states**](docs/CountryApi.md#get_country_states) | **GET** /country/states | Returns a list of all valid countries and it states
|
|
437
438
|
*DealMakerAPI::CustomEmailsApi* | [**get_access_token**](docs/CustomEmailsApi.md#get_access_token) | **POST** /custom_emails/get_access_token | Generate authorization token information for initializing Beefree editor
|
|
438
|
-
*DealMakerAPI::DealApi* | [**
|
|
439
|
+
*DealMakerAPI::DealApi* | [**ach_bank_account_setup_intent**](docs/DealApi.md#ach_bank_account_setup_intent) | **GET** /deals/{id}/investor/{investor_id}/subscription/{subscription_id}/payments/ach/bank_account_setup_intent | Prepares an investor for payment
|
|
440
|
+
*DealMakerAPI::DealApi* | [**acss_bank_account_setup_intent**](docs/DealApi.md#acss_bank_account_setup_intent) | **GET** /deals/{id}/investor/{investor_id}/subscription/{subscription_id}/payments/acss/bank_account_setup_intent | Prepares an investor for payment
|
|
439
441
|
*DealMakerAPI::DealApi* | [**create_deal_setup**](docs/DealApi.md#create_deal_setup) | **POST** /deal_setups | Create deal setup
|
|
440
442
|
*DealMakerAPI::DealApi* | [**get_deal**](docs/DealApi.md#get_deal) | **GET** /deals/{id} | Get deal by Deal ID
|
|
441
443
|
*DealMakerAPI::DealApi* | [**get_deal_incentive_plan**](docs/DealApi.md#get_deal_incentive_plan) | **GET** /deals/{id}/incentive_plan | Get incentive plan by deal id
|
|
@@ -446,6 +448,8 @@ Class | Method | HTTP request | Description
|
|
|
446
448
|
*DealMakerAPI::DefaultApi* | [**get_deals_deal_id_payment_onboarding_questionnaire_payout_account_details_data**](docs/DefaultApi.md#get_deals_deal_id_payment_onboarding_questionnaire_payout_account_details_data) | **GET** /deals/{deal_id}/payment_onboarding/questionnaire/payout_account_details/data | Get payout account data
|
|
447
449
|
*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
|
|
448
450
|
*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
|
|
451
|
+
*DealMakerAPI::DefaultApi* | [**get_deals_id_progress_page_kind**](docs/DefaultApi.md#get_deals_id_progress_page_kind) | **GET** /deals/{id}/progress_page/{kind} | Get deal progress for a specific kind
|
|
452
|
+
*DealMakerAPI::DefaultApi* | [**get_deals_id_progress_page_summary**](docs/DefaultApi.md#get_deals_id_progress_page_summary) | **GET** /deals/{id}/progress_page/summary | Get the deal progress summary
|
|
449
453
|
*DealMakerAPI::DefaultApi* | [**get_deals_id_summary**](docs/DefaultApi.md#get_deals_id_summary) | **GET** /deals/{id}/summary | Get Deal Overview
|
|
450
454
|
*DealMakerAPI::DefaultApi* | [**get_deals_payment_onboarding_questionnaire_initial_questions**](docs/DefaultApi.md#get_deals_payment_onboarding_questionnaire_initial_questions) | **GET** /deals/payment_onboarding/questionnaire/initial_questions | Get initial questions
|
|
451
455
|
*DealMakerAPI::DefaultApi* | [**get_webhooks**](docs/DefaultApi.md#get_webhooks) | **GET** /webhooks | Returns a list of webhook subscription which is associated to the user
|
|
@@ -490,11 +494,17 @@ Class | Method | HTTP request | Description
|
|
|
490
494
|
*DealMakerAPI::InvestorProfileApi* | [**patch_joint_profile**](docs/InvestorProfileApi.md#patch_joint_profile) | **PATCH** /investor_profiles/joints/{investor_profile_id} | Patch a joint investor profile
|
|
491
495
|
*DealMakerAPI::InvestorProfileApi* | [**patch_managed_profile**](docs/InvestorProfileApi.md#patch_managed_profile) | **PATCH** /investor_profiles/managed/{investor_profile_id} | Patch managed investor profile.
|
|
492
496
|
*DealMakerAPI::InvestorProfileApi* | [**patch_trust_profile**](docs/InvestorProfileApi.md#patch_trust_profile) | **PATCH** /investor_profiles/trusts/{investor_profile_id} | Patch a trust investor profile
|
|
497
|
+
*DealMakerAPI::PaymentsApi* | [**post_deal_investor_payments_ira**](docs/PaymentsApi.md#post_deal_investor_payments_ira) | **POST** /deals/{id}/investors/{investor_id}/payments/ira | Creates a payment intent for express wire and mail its instructions.
|
|
493
498
|
*DealMakerAPI::ShareholderApi* | [**get_shareholders**](docs/ShareholderApi.md#get_shareholders) | **GET** /companies/{id}/shareholders | Get a company shareholders list
|
|
494
499
|
*DealMakerAPI::ShareholderApi* | [**get_shareholders_tags**](docs/ShareholderApi.md#get_shareholders_tags) | **GET** /companies/{id}/shareholders/tags | Get a company shareholders list grouped by tags
|
|
495
500
|
*DealMakerAPI::UploadApi* | [**generate_url**](docs/UploadApi.md#generate_url) | **POST** /uploads/generate_url | Create a presigned URL for Amazon S3
|
|
501
|
+
*DealMakerAPI::UserApi* | [**create_factor**](docs/UserApi.md#create_factor) | **POST** /users/{id}/create_factor | Creates an API endpoint for creating a new TOTP factor
|
|
502
|
+
*DealMakerAPI::UserApi* | [**get_two_factor_channels**](docs/UserApi.md#get_two_factor_channels) | **GET** /users/{id}/two_factor_channels | Creates an API endpoint to return a list of existing TOTP factor
|
|
496
503
|
*DealMakerAPI::UserApi* | [**get_user**](docs/UserApi.md#get_user) | **GET** /users/{id} | Get user by User ID
|
|
504
|
+
*DealMakerAPI::UserApi* | [**setup_sms_verification**](docs/UserApi.md#setup_sms_verification) | **POST** /users/{id}/setup_sms_verification | Start a setup for a SMS Verification by creating a two factor channel of sms type
|
|
497
505
|
*DealMakerAPI::UserApi* | [**update_user_password**](docs/UserApi.md#update_user_password) | **PUT** /users/{id}/update_password | Update user password
|
|
506
|
+
*DealMakerAPI::UserApi* | [**verify_factor**](docs/UserApi.md#verify_factor) | **PUT** /users/{id}/verify_factor | Creates an API endpoint to verify an existing TOTP factor
|
|
507
|
+
*DealMakerAPI::UserApi* | [**verify_sms_verification**](docs/UserApi.md#verify_sms_verification) | **POST** /users/{id}/verify_sms_verification | Verify a SMS Verification by creating a two factor channel of sms type
|
|
498
508
|
*DealMakerAPI::UsersApi* | [**get_users_investments**](docs/UsersApi.md#get_users_investments) | **GET** /users/investments | Gets the investments for a specific user.
|
|
499
509
|
|
|
500
510
|
|
|
@@ -538,6 +548,8 @@ Class | Method | HTTP request | Description
|
|
|
538
548
|
- [DealMakerAPI::RequestNewDocumentRequest](docs/RequestNewDocumentRequest.md)
|
|
539
549
|
- [DealMakerAPI::RunBackgroundSearchRequest](docs/RunBackgroundSearchRequest.md)
|
|
540
550
|
- [DealMakerAPI::SendPortalInviteRequest](docs/SendPortalInviteRequest.md)
|
|
551
|
+
- [DealMakerAPI::SetupSmsVerificationRequest](docs/SetupSmsVerificationRequest.md)
|
|
552
|
+
- [DealMakerAPI::TestDocumentUploadEmailRequest](docs/TestDocumentUploadEmailRequest.md)
|
|
541
553
|
- [DealMakerAPI::UpdateUserPasswordRequest](docs/UpdateUserPasswordRequest.md)
|
|
542
554
|
- [DealMakerAPI::V1EntitiesAddress](docs/V1EntitiesAddress.md)
|
|
543
555
|
- [DealMakerAPI::V1EntitiesAddresses](docs/V1EntitiesAddresses.md)
|
|
@@ -563,8 +575,12 @@ Class | Method | HTTP request | Description
|
|
|
563
575
|
- [DealMakerAPI::V1EntitiesDeals](docs/V1EntitiesDeals.md)
|
|
564
576
|
- [DealMakerAPI::V1EntitiesDealsIncentivePlan](docs/V1EntitiesDealsIncentivePlan.md)
|
|
565
577
|
- [DealMakerAPI::V1EntitiesDealsIncentivePlansIncentiveTier](docs/V1EntitiesDealsIncentivePlansIncentiveTier.md)
|
|
578
|
+
- [DealMakerAPI::V1EntitiesDealsInvestorsPaymentAchBankAccountSetupIntent](docs/V1EntitiesDealsInvestorsPaymentAchBankAccountSetupIntent.md)
|
|
566
579
|
- [DealMakerAPI::V1EntitiesDealsInvestorsPaymentAcssBankAccountSetupIntent](docs/V1EntitiesDealsInvestorsPaymentAcssBankAccountSetupIntent.md)
|
|
567
580
|
- [DealMakerAPI::V1EntitiesDealsPriceDetails](docs/V1EntitiesDealsPriceDetails.md)
|
|
581
|
+
- [DealMakerAPI::V1EntitiesDealsProgress](docs/V1EntitiesDealsProgress.md)
|
|
582
|
+
- [DealMakerAPI::V1EntitiesDealsProgressColumn](docs/V1EntitiesDealsProgressColumn.md)
|
|
583
|
+
- [DealMakerAPI::V1EntitiesDealsProgressPageSummary](docs/V1EntitiesDealsProgressPageSummary.md)
|
|
568
584
|
- [DealMakerAPI::V1EntitiesDividend](docs/V1EntitiesDividend.md)
|
|
569
585
|
- [DealMakerAPI::V1EntitiesDividends](docs/V1EntitiesDividends.md)
|
|
570
586
|
- [DealMakerAPI::V1EntitiesEmailEvent](docs/V1EntitiesEmailEvent.md)
|
|
@@ -613,11 +629,17 @@ Class | Method | HTTP request | Description
|
|
|
613
629
|
- [DealMakerAPI::V1EntitiesState](docs/V1EntitiesState.md)
|
|
614
630
|
- [DealMakerAPI::V1EntitiesSubscriptionAgreement](docs/V1EntitiesSubscriptionAgreement.md)
|
|
615
631
|
- [DealMakerAPI::V1EntitiesUser](docs/V1EntitiesUser.md)
|
|
632
|
+
- [DealMakerAPI::V1EntitiesUsersBinding](docs/V1EntitiesUsersBinding.md)
|
|
633
|
+
- [DealMakerAPI::V1EntitiesUsersFactor](docs/V1EntitiesUsersFactor.md)
|
|
634
|
+
- [DealMakerAPI::V1EntitiesUsersTwoFactorChannel](docs/V1EntitiesUsersTwoFactorChannel.md)
|
|
635
|
+
- [DealMakerAPI::V1EntitiesUsersTwoFactorChannels](docs/V1EntitiesUsersTwoFactorChannels.md)
|
|
616
636
|
- [DealMakerAPI::V1EntitiesWebhooksDeal](docs/V1EntitiesWebhooksDeal.md)
|
|
617
637
|
- [DealMakerAPI::V1EntitiesWebhooksSecurityToken](docs/V1EntitiesWebhooksSecurityToken.md)
|
|
618
638
|
- [DealMakerAPI::V1EntitiesWebhooksSubscription](docs/V1EntitiesWebhooksSubscription.md)
|
|
619
639
|
- [DealMakerAPI::V1EntitiesWebhooksSubscriptionDeal](docs/V1EntitiesWebhooksSubscriptionDeal.md)
|
|
620
640
|
- [DealMakerAPI::V1EntitiesWebhooksSubscriptionDeals](docs/V1EntitiesWebhooksSubscriptionDeals.md)
|
|
641
|
+
- [DealMakerAPI::VerifyFactorRequest](docs/VerifyFactorRequest.md)
|
|
642
|
+
- [DealMakerAPI::VerifySmsVerificationRequest](docs/VerifySmsVerificationRequest.md)
|
|
621
643
|
|
|
622
644
|
|
|
623
645
|
## Documentation for Authorization
|
data/docs/CompanyApi.md
CHANGED
|
@@ -26,6 +26,7 @@ All URIs are relative to *http://api.dealmaker.tech*
|
|
|
26
26
|
| [**get_shareholder_ledger**](CompanyApi.md#get_shareholder_ledger) | **GET** /companies/{id}/shareholder_ledger | Get shareholder ledger by company |
|
|
27
27
|
| [**get_user_accessible_companies**](CompanyApi.md#get_user_accessible_companies) | **GET** /users/accessible_companies | Get list of all Companies accessible by the user |
|
|
28
28
|
| [**send_portal_invite**](CompanyApi.md#send_portal_invite) | **POST** /companies/{id}/shareholders/{shareholder_id}/send_portal_invite | Send portal invite to shareholder |
|
|
29
|
+
| [**test_document_upload_email**](CompanyApi.md#test_document_upload_email) | **POST** /companies/{id}/documents/test_upload_email | Send document upload test email to given user |
|
|
29
30
|
|
|
30
31
|
|
|
31
32
|
## create_bulk_upload
|
|
@@ -1545,3 +1546,70 @@ No authorization required
|
|
|
1545
1546
|
- **Content-Type**: application/json
|
|
1546
1547
|
- **Accept**: Not defined
|
|
1547
1548
|
|
|
1549
|
+
|
|
1550
|
+
## test_document_upload_email
|
|
1551
|
+
|
|
1552
|
+
> test_document_upload_email(id, test_document_upload_email_request)
|
|
1553
|
+
|
|
1554
|
+
Send document upload test email to given user
|
|
1555
|
+
|
|
1556
|
+
Send document upload test email to given user
|
|
1557
|
+
|
|
1558
|
+
### Examples
|
|
1559
|
+
|
|
1560
|
+
```ruby
|
|
1561
|
+
require 'time'
|
|
1562
|
+
require 'DealMakerAPI'
|
|
1563
|
+
# setup authorization
|
|
1564
|
+
DealMakerAPI.configure do |config|end
|
|
1565
|
+
|
|
1566
|
+
api_instance = DealMakerAPI::CompanyApi.new
|
|
1567
|
+
id = 56 # Integer |
|
|
1568
|
+
test_document_upload_email_request = DealMakerAPI::TestDocumentUploadEmailRequest.new({user_id: 37, send_confidential_email: false, json_email: 'json_email_example'}) # TestDocumentUploadEmailRequest |
|
|
1569
|
+
|
|
1570
|
+
begin
|
|
1571
|
+
# Send document upload test email to given user
|
|
1572
|
+
api_instance.test_document_upload_email(id, test_document_upload_email_request)
|
|
1573
|
+
rescue DealMakerAPI::ApiError => e
|
|
1574
|
+
puts "Error when calling CompanyApi->test_document_upload_email: #{e}"
|
|
1575
|
+
end
|
|
1576
|
+
```
|
|
1577
|
+
|
|
1578
|
+
#### Using the test_document_upload_email_with_http_info variant
|
|
1579
|
+
|
|
1580
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
1581
|
+
|
|
1582
|
+
> <Array(nil, Integer, Hash)> test_document_upload_email_with_http_info(id, test_document_upload_email_request)
|
|
1583
|
+
|
|
1584
|
+
```ruby
|
|
1585
|
+
begin
|
|
1586
|
+
# Send document upload test email to given user
|
|
1587
|
+
data, status_code, headers = api_instance.test_document_upload_email_with_http_info(id, test_document_upload_email_request)
|
|
1588
|
+
p status_code # => 2xx
|
|
1589
|
+
p headers # => { ... }
|
|
1590
|
+
p data # => nil
|
|
1591
|
+
rescue DealMakerAPI::ApiError => e
|
|
1592
|
+
puts "Error when calling CompanyApi->test_document_upload_email_with_http_info: #{e}"
|
|
1593
|
+
end
|
|
1594
|
+
```
|
|
1595
|
+
|
|
1596
|
+
### Parameters
|
|
1597
|
+
|
|
1598
|
+
| Name | Type | Description | Notes |
|
|
1599
|
+
| ---- | ---- | ----------- | ----- |
|
|
1600
|
+
| **id** | **Integer** | | |
|
|
1601
|
+
| **test_document_upload_email_request** | [**TestDocumentUploadEmailRequest**](TestDocumentUploadEmailRequest.md) | | |
|
|
1602
|
+
|
|
1603
|
+
### Return type
|
|
1604
|
+
|
|
1605
|
+
nil (empty response body)
|
|
1606
|
+
|
|
1607
|
+
### Authorization
|
|
1608
|
+
|
|
1609
|
+
No authorization required
|
|
1610
|
+
|
|
1611
|
+
### HTTP request headers
|
|
1612
|
+
|
|
1613
|
+
- **Content-Type**: application/json
|
|
1614
|
+
- **Accept**: Not defined
|
|
1615
|
+
|
data/docs/DealApi.md
CHANGED
|
@@ -4,16 +4,17 @@ All URIs are relative to *http://api.dealmaker.tech*
|
|
|
4
4
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
| ------ | ------------ | ----------- |
|
|
7
|
-
| [**
|
|
7
|
+
| [**ach_bank_account_setup_intent**](DealApi.md#ach_bank_account_setup_intent) | **GET** /deals/{id}/investor/{investor_id}/subscription/{subscription_id}/payments/ach/bank_account_setup_intent | Prepares an investor for payment |
|
|
8
|
+
| [**acss_bank_account_setup_intent**](DealApi.md#acss_bank_account_setup_intent) | **GET** /deals/{id}/investor/{investor_id}/subscription/{subscription_id}/payments/acss/bank_account_setup_intent | Prepares an investor for payment |
|
|
8
9
|
| [**create_deal_setup**](DealApi.md#create_deal_setup) | **POST** /deal_setups | Create deal setup |
|
|
9
10
|
| [**get_deal**](DealApi.md#get_deal) | **GET** /deals/{id} | Get deal by Deal ID |
|
|
10
11
|
| [**get_deal_incentive_plan**](DealApi.md#get_deal_incentive_plan) | **GET** /deals/{id}/incentive_plan | Get incentive plan by deal id |
|
|
11
12
|
| [**list_deals**](DealApi.md#list_deals) | **GET** /deals | List available deals |
|
|
12
13
|
|
|
13
14
|
|
|
14
|
-
##
|
|
15
|
+
## ach_bank_account_setup_intent
|
|
15
16
|
|
|
16
|
-
> <
|
|
17
|
+
> <V1EntitiesDealsInvestorsPaymentAchBankAccountSetupIntent> ach_bank_account_setup_intent(id, investor_id, subscription_id)
|
|
17
18
|
|
|
18
19
|
Prepares an investor for payment
|
|
19
20
|
|
|
@@ -34,28 +35,98 @@ subscription_id = 56 # Integer | The subscription id
|
|
|
34
35
|
|
|
35
36
|
begin
|
|
36
37
|
# Prepares an investor for payment
|
|
37
|
-
result = api_instance.
|
|
38
|
+
result = api_instance.ach_bank_account_setup_intent(id, investor_id, subscription_id)
|
|
38
39
|
p result
|
|
39
40
|
rescue DealMakerAPI::ApiError => e
|
|
40
|
-
puts "Error when calling DealApi->
|
|
41
|
+
puts "Error when calling DealApi->ach_bank_account_setup_intent: #{e}"
|
|
41
42
|
end
|
|
42
43
|
```
|
|
43
44
|
|
|
44
|
-
#### Using the
|
|
45
|
+
#### Using the ach_bank_account_setup_intent_with_http_info variant
|
|
45
46
|
|
|
46
47
|
This returns an Array which contains the response data, status code and headers.
|
|
47
48
|
|
|
48
|
-
> <Array(<
|
|
49
|
+
> <Array(<V1EntitiesDealsInvestorsPaymentAchBankAccountSetupIntent>, Integer, Hash)> ach_bank_account_setup_intent_with_http_info(id, investor_id, subscription_id)
|
|
49
50
|
|
|
50
51
|
```ruby
|
|
51
52
|
begin
|
|
52
53
|
# Prepares an investor for payment
|
|
53
|
-
data, status_code, headers = api_instance.
|
|
54
|
+
data, status_code, headers = api_instance.ach_bank_account_setup_intent_with_http_info(id, investor_id, subscription_id)
|
|
55
|
+
p status_code # => 2xx
|
|
56
|
+
p headers # => { ... }
|
|
57
|
+
p data # => <V1EntitiesDealsInvestorsPaymentAchBankAccountSetupIntent>
|
|
58
|
+
rescue DealMakerAPI::ApiError => e
|
|
59
|
+
puts "Error when calling DealApi->ach_bank_account_setup_intent_with_http_info: #{e}"
|
|
60
|
+
end
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
### Parameters
|
|
64
|
+
|
|
65
|
+
| Name | Type | Description | Notes |
|
|
66
|
+
| ---- | ---- | ----------- | ----- |
|
|
67
|
+
| **id** | **String** | The deal id | |
|
|
68
|
+
| **investor_id** | **Integer** | The investor id | |
|
|
69
|
+
| **subscription_id** | **Integer** | The subscription id | |
|
|
70
|
+
|
|
71
|
+
### Return type
|
|
72
|
+
|
|
73
|
+
[**V1EntitiesDealsInvestorsPaymentAchBankAccountSetupIntent**](V1EntitiesDealsInvestorsPaymentAchBankAccountSetupIntent.md)
|
|
74
|
+
|
|
75
|
+
### Authorization
|
|
76
|
+
|
|
77
|
+
No authorization required
|
|
78
|
+
|
|
79
|
+
### HTTP request headers
|
|
80
|
+
|
|
81
|
+
- **Content-Type**: Not defined
|
|
82
|
+
- **Accept**: application/json
|
|
83
|
+
|
|
84
|
+
|
|
85
|
+
## acss_bank_account_setup_intent
|
|
86
|
+
|
|
87
|
+
> <V1EntitiesDealsInvestorsPaymentAcssBankAccountSetupIntent> acss_bank_account_setup_intent(id, investor_id, subscription_id)
|
|
88
|
+
|
|
89
|
+
Prepares an investor for payment
|
|
90
|
+
|
|
91
|
+
Prepare investor for payment
|
|
92
|
+
|
|
93
|
+
### Examples
|
|
94
|
+
|
|
95
|
+
```ruby
|
|
96
|
+
require 'time'
|
|
97
|
+
require 'DealMakerAPI'
|
|
98
|
+
# setup authorization
|
|
99
|
+
DealMakerAPI.configure do |config|end
|
|
100
|
+
|
|
101
|
+
api_instance = DealMakerAPI::DealApi.new
|
|
102
|
+
id = 'id_example' # String | The deal id
|
|
103
|
+
investor_id = 56 # Integer | The investor id
|
|
104
|
+
subscription_id = 56 # Integer | The subscription id
|
|
105
|
+
|
|
106
|
+
begin
|
|
107
|
+
# Prepares an investor for payment
|
|
108
|
+
result = api_instance.acss_bank_account_setup_intent(id, investor_id, subscription_id)
|
|
109
|
+
p result
|
|
110
|
+
rescue DealMakerAPI::ApiError => e
|
|
111
|
+
puts "Error when calling DealApi->acss_bank_account_setup_intent: #{e}"
|
|
112
|
+
end
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
#### Using the acss_bank_account_setup_intent_with_http_info variant
|
|
116
|
+
|
|
117
|
+
This returns an Array which contains the response data, status code and headers.
|
|
118
|
+
|
|
119
|
+
> <Array(<V1EntitiesDealsInvestorsPaymentAcssBankAccountSetupIntent>, Integer, Hash)> acss_bank_account_setup_intent_with_http_info(id, investor_id, subscription_id)
|
|
120
|
+
|
|
121
|
+
```ruby
|
|
122
|
+
begin
|
|
123
|
+
# Prepares an investor for payment
|
|
124
|
+
data, status_code, headers = api_instance.acss_bank_account_setup_intent_with_http_info(id, investor_id, subscription_id)
|
|
54
125
|
p status_code # => 2xx
|
|
55
126
|
p headers # => { ... }
|
|
56
127
|
p data # => <V1EntitiesDealsInvestorsPaymentAcssBankAccountSetupIntent>
|
|
57
128
|
rescue DealMakerAPI::ApiError => e
|
|
58
|
-
puts "Error when calling DealApi->
|
|
129
|
+
puts "Error when calling DealApi->acss_bank_account_setup_intent_with_http_info: #{e}"
|
|
59
130
|
end
|
|
60
131
|
```
|
|
61
132
|
|
data/docs/DefaultApi.md
CHANGED
|
@@ -8,6 +8,8 @@ All URIs are relative to *http://api.dealmaker.tech*
|
|
|
8
8
|
| [**get_deals_deal_id_payment_onboarding_questionnaire_payout_account_details_data**](DefaultApi.md#get_deals_deal_id_payment_onboarding_questionnaire_payout_account_details_data) | **GET** /deals/{deal_id}/payment_onboarding/questionnaire/payout_account_details/data | Get payout account data |
|
|
9
9
|
| [**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 |
|
|
10
10
|
| [**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 |
|
|
11
|
+
| [**get_deals_id_progress_page_kind**](DefaultApi.md#get_deals_id_progress_page_kind) | **GET** /deals/{id}/progress_page/{kind} | Get deal progress for a specific kind |
|
|
12
|
+
| [**get_deals_id_progress_page_summary**](DefaultApi.md#get_deals_id_progress_page_summary) | **GET** /deals/{id}/progress_page/summary | Get the deal progress summary |
|
|
11
13
|
| [**get_deals_id_summary**](DefaultApi.md#get_deals_id_summary) | **GET** /deals/{id}/summary | Get Deal Overview |
|
|
12
14
|
| [**get_deals_payment_onboarding_questionnaire_initial_questions**](DefaultApi.md#get_deals_payment_onboarding_questionnaire_initial_questions) | **GET** /deals/payment_onboarding/questionnaire/initial_questions | Get initial questions |
|
|
13
15
|
| [**get_webhooks**](DefaultApi.md#get_webhooks) | **GET** /webhooks | Returns a list of webhook subscription which is associated to the user |
|
|
@@ -287,6 +289,140 @@ No authorization required
|
|
|
287
289
|
- **Accept**: application/json
|
|
288
290
|
|
|
289
291
|
|
|
292
|
+
## get_deals_id_progress_page_kind
|
|
293
|
+
|
|
294
|
+
> <V1EntitiesDealsProgress> get_deals_id_progress_page_kind(id, kind)
|
|
295
|
+
|
|
296
|
+
Get deal progress for a specific kind
|
|
297
|
+
|
|
298
|
+
Get deal progress
|
|
299
|
+
|
|
300
|
+
### Examples
|
|
301
|
+
|
|
302
|
+
```ruby
|
|
303
|
+
require 'time'
|
|
304
|
+
require 'DealMakerAPI'
|
|
305
|
+
# setup authorization
|
|
306
|
+
DealMakerAPI.configure do |config|end
|
|
307
|
+
|
|
308
|
+
api_instance = DealMakerAPI::DefaultApi.new
|
|
309
|
+
id = 56 # Integer | The deal id.
|
|
310
|
+
kind = 'investment_amount' # String | Kind of progress.
|
|
311
|
+
|
|
312
|
+
begin
|
|
313
|
+
# Get deal progress for a specific kind
|
|
314
|
+
result = api_instance.get_deals_id_progress_page_kind(id, kind)
|
|
315
|
+
p result
|
|
316
|
+
rescue DealMakerAPI::ApiError => e
|
|
317
|
+
puts "Error when calling DefaultApi->get_deals_id_progress_page_kind: #{e}"
|
|
318
|
+
end
|
|
319
|
+
```
|
|
320
|
+
|
|
321
|
+
#### Using the get_deals_id_progress_page_kind_with_http_info variant
|
|
322
|
+
|
|
323
|
+
This returns an Array which contains the response data, status code and headers.
|
|
324
|
+
|
|
325
|
+
> <Array(<V1EntitiesDealsProgress>, Integer, Hash)> get_deals_id_progress_page_kind_with_http_info(id, kind)
|
|
326
|
+
|
|
327
|
+
```ruby
|
|
328
|
+
begin
|
|
329
|
+
# Get deal progress for a specific kind
|
|
330
|
+
data, status_code, headers = api_instance.get_deals_id_progress_page_kind_with_http_info(id, kind)
|
|
331
|
+
p status_code # => 2xx
|
|
332
|
+
p headers # => { ... }
|
|
333
|
+
p data # => <V1EntitiesDealsProgress>
|
|
334
|
+
rescue DealMakerAPI::ApiError => e
|
|
335
|
+
puts "Error when calling DefaultApi->get_deals_id_progress_page_kind_with_http_info: #{e}"
|
|
336
|
+
end
|
|
337
|
+
```
|
|
338
|
+
|
|
339
|
+
### Parameters
|
|
340
|
+
|
|
341
|
+
| Name | Type | Description | Notes |
|
|
342
|
+
| ---- | ---- | ----------- | ----- |
|
|
343
|
+
| **id** | **Integer** | The deal id. | |
|
|
344
|
+
| **kind** | **String** | Kind of progress. | |
|
|
345
|
+
|
|
346
|
+
### Return type
|
|
347
|
+
|
|
348
|
+
[**V1EntitiesDealsProgress**](V1EntitiesDealsProgress.md)
|
|
349
|
+
|
|
350
|
+
### Authorization
|
|
351
|
+
|
|
352
|
+
No authorization required
|
|
353
|
+
|
|
354
|
+
### HTTP request headers
|
|
355
|
+
|
|
356
|
+
- **Content-Type**: Not defined
|
|
357
|
+
- **Accept**: application/json
|
|
358
|
+
|
|
359
|
+
|
|
360
|
+
## get_deals_id_progress_page_summary
|
|
361
|
+
|
|
362
|
+
> <V1EntitiesDealsProgressPageSummary> get_deals_id_progress_page_summary(id)
|
|
363
|
+
|
|
364
|
+
Get the deal progress summary
|
|
365
|
+
|
|
366
|
+
Get the deal progress summary
|
|
367
|
+
|
|
368
|
+
### Examples
|
|
369
|
+
|
|
370
|
+
```ruby
|
|
371
|
+
require 'time'
|
|
372
|
+
require 'DealMakerAPI'
|
|
373
|
+
# setup authorization
|
|
374
|
+
DealMakerAPI.configure do |config|end
|
|
375
|
+
|
|
376
|
+
api_instance = DealMakerAPI::DefaultApi.new
|
|
377
|
+
id = 56 # Integer | The deal id.
|
|
378
|
+
|
|
379
|
+
begin
|
|
380
|
+
# Get the deal progress summary
|
|
381
|
+
result = api_instance.get_deals_id_progress_page_summary(id)
|
|
382
|
+
p result
|
|
383
|
+
rescue DealMakerAPI::ApiError => e
|
|
384
|
+
puts "Error when calling DefaultApi->get_deals_id_progress_page_summary: #{e}"
|
|
385
|
+
end
|
|
386
|
+
```
|
|
387
|
+
|
|
388
|
+
#### Using the get_deals_id_progress_page_summary_with_http_info variant
|
|
389
|
+
|
|
390
|
+
This returns an Array which contains the response data, status code and headers.
|
|
391
|
+
|
|
392
|
+
> <Array(<V1EntitiesDealsProgressPageSummary>, Integer, Hash)> get_deals_id_progress_page_summary_with_http_info(id)
|
|
393
|
+
|
|
394
|
+
```ruby
|
|
395
|
+
begin
|
|
396
|
+
# Get the deal progress summary
|
|
397
|
+
data, status_code, headers = api_instance.get_deals_id_progress_page_summary_with_http_info(id)
|
|
398
|
+
p status_code # => 2xx
|
|
399
|
+
p headers # => { ... }
|
|
400
|
+
p data # => <V1EntitiesDealsProgressPageSummary>
|
|
401
|
+
rescue DealMakerAPI::ApiError => e
|
|
402
|
+
puts "Error when calling DefaultApi->get_deals_id_progress_page_summary_with_http_info: #{e}"
|
|
403
|
+
end
|
|
404
|
+
```
|
|
405
|
+
|
|
406
|
+
### Parameters
|
|
407
|
+
|
|
408
|
+
| Name | Type | Description | Notes |
|
|
409
|
+
| ---- | ---- | ----------- | ----- |
|
|
410
|
+
| **id** | **Integer** | The deal id. | |
|
|
411
|
+
|
|
412
|
+
### Return type
|
|
413
|
+
|
|
414
|
+
[**V1EntitiesDealsProgressPageSummary**](V1EntitiesDealsProgressPageSummary.md)
|
|
415
|
+
|
|
416
|
+
### Authorization
|
|
417
|
+
|
|
418
|
+
No authorization required
|
|
419
|
+
|
|
420
|
+
### HTTP request headers
|
|
421
|
+
|
|
422
|
+
- **Content-Type**: Not defined
|
|
423
|
+
- **Accept**: application/json
|
|
424
|
+
|
|
425
|
+
|
|
290
426
|
## get_deals_id_summary
|
|
291
427
|
|
|
292
428
|
> get_deals_id_summary(id)
|
data/docs/PaymentsApi.md
ADDED
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
# DealMakerAPI::PaymentsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *http://api.dealmaker.tech*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**post_deal_investor_payments_ira**](PaymentsApi.md#post_deal_investor_payments_ira) | **POST** /deals/{id}/investors/{investor_id}/payments/ira | Creates a payment intent for express wire and mail its instructions. |
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
## post_deal_investor_payments_ira
|
|
11
|
+
|
|
12
|
+
> post_deal_investor_payments_ira(id, investor_id)
|
|
13
|
+
|
|
14
|
+
Creates a payment intent for express wire and mail its instructions.
|
|
15
|
+
|
|
16
|
+
Creates a payment intent for express wire
|
|
17
|
+
|
|
18
|
+
### Examples
|
|
19
|
+
|
|
20
|
+
```ruby
|
|
21
|
+
require 'time'
|
|
22
|
+
require 'DealMakerAPI'
|
|
23
|
+
# setup authorization
|
|
24
|
+
DealMakerAPI.configure do |config|end
|
|
25
|
+
|
|
26
|
+
api_instance = DealMakerAPI::PaymentsApi.new
|
|
27
|
+
id = 56 # Integer | The deal id.
|
|
28
|
+
investor_id = 56 # Integer | The investor id.
|
|
29
|
+
|
|
30
|
+
begin
|
|
31
|
+
# Creates a payment intent for express wire and mail its instructions.
|
|
32
|
+
api_instance.post_deal_investor_payments_ira(id, investor_id)
|
|
33
|
+
rescue DealMakerAPI::ApiError => e
|
|
34
|
+
puts "Error when calling PaymentsApi->post_deal_investor_payments_ira: #{e}"
|
|
35
|
+
end
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
#### Using the post_deal_investor_payments_ira_with_http_info variant
|
|
39
|
+
|
|
40
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
41
|
+
|
|
42
|
+
> <Array(nil, Integer, Hash)> post_deal_investor_payments_ira_with_http_info(id, investor_id)
|
|
43
|
+
|
|
44
|
+
```ruby
|
|
45
|
+
begin
|
|
46
|
+
# Creates a payment intent for express wire and mail its instructions.
|
|
47
|
+
data, status_code, headers = api_instance.post_deal_investor_payments_ira_with_http_info(id, investor_id)
|
|
48
|
+
p status_code # => 2xx
|
|
49
|
+
p headers # => { ... }
|
|
50
|
+
p data # => nil
|
|
51
|
+
rescue DealMakerAPI::ApiError => e
|
|
52
|
+
puts "Error when calling PaymentsApi->post_deal_investor_payments_ira_with_http_info: #{e}"
|
|
53
|
+
end
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
### Parameters
|
|
57
|
+
|
|
58
|
+
| Name | Type | Description | Notes |
|
|
59
|
+
| ---- | ---- | ----------- | ----- |
|
|
60
|
+
| **id** | **Integer** | The deal id. | |
|
|
61
|
+
| **investor_id** | **Integer** | The investor id. | |
|
|
62
|
+
|
|
63
|
+
### Return type
|
|
64
|
+
|
|
65
|
+
nil (empty response body)
|
|
66
|
+
|
|
67
|
+
### Authorization
|
|
68
|
+
|
|
69
|
+
No authorization required
|
|
70
|
+
|
|
71
|
+
### HTTP request headers
|
|
72
|
+
|
|
73
|
+
- **Content-Type**: Not defined
|
|
74
|
+
- **Accept**: Not defined
|
|
75
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# DealMakerAPI::SetupSmsVerificationRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **phone_number** | **String** | The phone number of the given user | |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'DealMakerAPI'
|
|
13
|
+
|
|
14
|
+
instance = DealMakerAPI::SetupSmsVerificationRequest.new(
|
|
15
|
+
phone_number: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# DealMakerAPI::TestDocumentUploadEmailRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **user_id** | **Integer** | The user that will receive the email. | |
|
|
8
|
+
| **send_confidential_email** | **Boolean** | The send_confidential_email flag | |
|
|
9
|
+
| **json_email** | **String** | The json content email | |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'DealMakerAPI'
|
|
15
|
+
|
|
16
|
+
instance = DealMakerAPI::TestDocumentUploadEmailRequest.new(
|
|
17
|
+
user_id: null,
|
|
18
|
+
send_confidential_email: null,
|
|
19
|
+
json_email: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -4,7 +4,8 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **password** | **String** | The
|
|
7
|
+
| **password** | **String** | The new password for the user. | |
|
|
8
|
+
| **current_password** | **String** | The current password for the user. | [optional] |
|
|
8
9
|
|
|
9
10
|
## Example
|
|
10
11
|
|
|
@@ -12,7 +13,8 @@
|
|
|
12
13
|
require 'DealMakerAPI'
|
|
13
14
|
|
|
14
15
|
instance = DealMakerAPI::UpdateUserPasswordRequest.new(
|
|
15
|
-
password: null
|
|
16
|
+
password: null,
|
|
17
|
+
current_password: null
|
|
16
18
|
)
|
|
17
19
|
```
|
|
18
20
|
|