DealMakerAPI 0.103.5 → 0.104.0
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 +15 -6
- data/docs/DefaultApi.md +79 -14
- data/docs/PaymentsApi.md +75 -0
- data/docs/UserApi.md +204 -0
- data/docs/V1EntitiesAttachment.md +2 -0
- data/docs/V1EntitiesDealsProgress.md +2 -2
- data/docs/V1EntitiesDealsProgressColumn.md +3 -1
- data/docs/V1EntitiesDealsProgressKinds.md +22 -0
- data/docs/V1EntitiesDealsProgressPageSummary.md +32 -0
- data/docs/V1EntitiesDeleteResult.md +20 -0
- data/docs/V1EntitiesUsersTwoFactorChannel.md +6 -4
- data/docs/VerifySmsVerificationRequest.md +20 -0
- data/lib/DealMakerAPI/api/company_api.rb +1 -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 +1 -1
- data/lib/DealMakerAPI/api/deals_api.rb +1 -1
- data/lib/DealMakerAPI/api/default_api.rb +73 -21
- 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 +205 -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 +1 -1
- data/lib/DealMakerAPI/models/test_document_upload_email_request.rb +1 -1
- data/lib/DealMakerAPI/models/update_user_password_request.rb +1 -1
- 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 +1 -1
- 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 +5 -5
- data/lib/DealMakerAPI/models/v1_entities_deals_progress_column.rb +15 -5
- data/lib/DealMakerAPI/models/v1_entities_deals_progress_kinds.rb +232 -0
- data/lib/DealMakerAPI/models/v1_entities_deals_progress_page_summary.rb +286 -0
- data/lib/DealMakerAPI/models/v1_entities_delete_result.rb +226 -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 +1 -1
- data/lib/DealMakerAPI/models/v1_entities_users_factor.rb +1 -1
- data/lib/DealMakerAPI/models/v1_entities_users_two_factor_channel.rb +32 -22
- data/lib/DealMakerAPI/models/v1_entities_users_two_factor_channels.rb +1 -1
- 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 +1 -1
- data/lib/DealMakerAPI/models/verify_sms_verification_request.rb +239 -0
- data/lib/DealMakerAPI/version.rb +2 -2
- data/lib/DealMakerAPI.rb +6 -1
- data/spec/api/company_api_spec.rb +1 -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 +1 -1
- data/spec/api/deals_api_spec.rb +1 -1
- data/spec/api/default_api_spec.rb +16 -5
- 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 +39 -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 +1 -1
- data/spec/models/test_document_upload_email_request_spec.rb +1 -1
- data/spec/models/update_user_password_request_spec.rb +1 -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 +1 -1
- 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 +7 -1
- data/spec/models/v1_entities_deals_progress_kinds_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 +1 -1
- data/spec/models/v1_entities_deals_spec.rb +1 -1
- data/spec/models/v1_entities_delete_result_spec.rb +42 -0
- 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 +1 -1
- data/spec/models/v1_entities_users_factor_spec.rb +1 -1
- data/spec/models/v1_entities_users_two_factor_channel_spec.rb +11 -5
- data/spec/models/v1_entities_users_two_factor_channels_spec.rb +1 -1
- 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 +1 -1
- data/spec/models/verify_sms_verification_request_spec.rb +42 -0
- data/spec/spec_helper.rb +1 -1
- metadata +22 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 6a17c990890aeb23c1ff125d1c2809af8c500e23ed18deb5d57566d6eb20f602
|
4
|
+
data.tar.gz: b98ad618762c6eb0172449ee3679da5b6c251c5ac64ca7449f788b97db7cee86
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 11f293525eb8501d17744911f51e8798286f0ca3ff884b9d66a6fb1a9eb2fef0964336abe1b30dc64c5d6df87ea06376c1b6d9228677b3fc21cac292b5c529e2
|
7
|
+
data.tar.gz: d0488827d27996352ec35a8ef70712823828786a2b4edc3d19f5d3c6f3b76e2ba8ae2f0e7e7775fc16077c65fde617dae09f338e1b95c928b1d80455bf6c9a6b
|
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.104.0
|
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.104.0.gem
|
359
359
|
```
|
360
360
|
|
361
|
-
(for development, run `gem install --dev ./DealMakerAPI-0.
|
361
|
+
(for development, run `gem install --dev ./DealMakerAPI-0.104.0.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.104.0'
|
368
368
|
|
369
369
|
### Install from Git
|
370
370
|
|
@@ -448,7 +448,8 @@ Class | Method | HTTP request | Description
|
|
448
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
|
449
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
|
450
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* | [**
|
451
|
+
*DealMakerAPI::DefaultApi* | [**get_deals_id_progress_page**](docs/DefaultApi.md#get_deals_id_progress_page) | **GET** /deals/{id}/progress_page | Get deal progress
|
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
|
452
453
|
*DealMakerAPI::DefaultApi* | [**get_deals_id_summary**](docs/DefaultApi.md#get_deals_id_summary) | **GET** /deals/{id}/summary | Get Deal Overview
|
453
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
|
454
455
|
*DealMakerAPI::DefaultApi* | [**get_webhooks**](docs/DefaultApi.md#get_webhooks) | **GET** /webhooks | Returns a list of webhook subscription which is associated to the user
|
@@ -493,15 +494,19 @@ Class | Method | HTTP request | Description
|
|
493
494
|
*DealMakerAPI::InvestorProfileApi* | [**patch_joint_profile**](docs/InvestorProfileApi.md#patch_joint_profile) | **PATCH** /investor_profiles/joints/{investor_profile_id} | Patch a joint investor profile
|
494
495
|
*DealMakerAPI::InvestorProfileApi* | [**patch_managed_profile**](docs/InvestorProfileApi.md#patch_managed_profile) | **PATCH** /investor_profiles/managed/{investor_profile_id} | Patch managed investor profile.
|
495
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.
|
496
498
|
*DealMakerAPI::ShareholderApi* | [**get_shareholders**](docs/ShareholderApi.md#get_shareholders) | **GET** /companies/{id}/shareholders | Get a company shareholders list
|
497
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
|
498
500
|
*DealMakerAPI::UploadApi* | [**generate_url**](docs/UploadApi.md#generate_url) | **POST** /uploads/generate_url | Create a presigned URL for Amazon S3
|
499
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* | [**delete_channel**](docs/UserApi.md#delete_channel) | **DELETE** /users/{id}/two_factor_channels/delete/{channel} | Creates an API endpoint to delete a specific two factor channel\"
|
503
|
+
*DealMakerAPI::UserApi* | [**disable_mfa**](docs/UserApi.md#disable_mfa) | **DELETE** /users/{id}/disable_mfa | Disable all the multi-factor authentication integrations for a user
|
500
504
|
*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
|
501
505
|
*DealMakerAPI::UserApi* | [**get_user**](docs/UserApi.md#get_user) | **GET** /users/{id} | Get user by User ID
|
502
506
|
*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
|
503
507
|
*DealMakerAPI::UserApi* | [**update_user_password**](docs/UserApi.md#update_user_password) | **PUT** /users/{id}/update_password | Update user password
|
504
508
|
*DealMakerAPI::UserApi* | [**verify_factor**](docs/UserApi.md#verify_factor) | **PUT** /users/{id}/verify_factor | Creates an API endpoint to verify an existing TOTP factor
|
509
|
+
*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
|
505
510
|
*DealMakerAPI::UsersApi* | [**get_users_investments**](docs/UsersApi.md#get_users_investments) | **GET** /users/investments | Gets the investments for a specific user.
|
506
511
|
|
507
512
|
|
@@ -577,6 +582,9 @@ Class | Method | HTTP request | Description
|
|
577
582
|
- [DealMakerAPI::V1EntitiesDealsPriceDetails](docs/V1EntitiesDealsPriceDetails.md)
|
578
583
|
- [DealMakerAPI::V1EntitiesDealsProgress](docs/V1EntitiesDealsProgress.md)
|
579
584
|
- [DealMakerAPI::V1EntitiesDealsProgressColumn](docs/V1EntitiesDealsProgressColumn.md)
|
585
|
+
- [DealMakerAPI::V1EntitiesDealsProgressKinds](docs/V1EntitiesDealsProgressKinds.md)
|
586
|
+
- [DealMakerAPI::V1EntitiesDealsProgressPageSummary](docs/V1EntitiesDealsProgressPageSummary.md)
|
587
|
+
- [DealMakerAPI::V1EntitiesDeleteResult](docs/V1EntitiesDeleteResult.md)
|
580
588
|
- [DealMakerAPI::V1EntitiesDividend](docs/V1EntitiesDividend.md)
|
581
589
|
- [DealMakerAPI::V1EntitiesDividends](docs/V1EntitiesDividends.md)
|
582
590
|
- [DealMakerAPI::V1EntitiesEmailEvent](docs/V1EntitiesEmailEvent.md)
|
@@ -635,6 +643,7 @@ Class | Method | HTTP request | Description
|
|
635
643
|
- [DealMakerAPI::V1EntitiesWebhooksSubscriptionDeal](docs/V1EntitiesWebhooksSubscriptionDeal.md)
|
636
644
|
- [DealMakerAPI::V1EntitiesWebhooksSubscriptionDeals](docs/V1EntitiesWebhooksSubscriptionDeals.md)
|
637
645
|
- [DealMakerAPI::VerifyFactorRequest](docs/VerifyFactorRequest.md)
|
646
|
+
- [DealMakerAPI::VerifySmsVerificationRequest](docs/VerifySmsVerificationRequest.md)
|
638
647
|
|
639
648
|
|
640
649
|
## Documentation for Authorization
|
data/docs/DefaultApi.md
CHANGED
@@ -8,7 +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
|
-
| [**
|
11
|
+
| [**get_deals_id_progress_page**](DefaultApi.md#get_deals_id_progress_page) | **GET** /deals/{id}/progress_page | Get deal progress |
|
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 |
|
12
13
|
| [**get_deals_id_summary**](DefaultApi.md#get_deals_id_summary) | **GET** /deals/{id}/summary | Get Deal Overview |
|
13
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 |
|
14
15
|
| [**get_webhooks**](DefaultApi.md#get_webhooks) | **GET** /webhooks | Returns a list of webhook subscription which is associated to the user |
|
@@ -288,11 +289,11 @@ No authorization required
|
|
288
289
|
- **Accept**: application/json
|
289
290
|
|
290
291
|
|
291
|
-
##
|
292
|
+
## get_deals_id_progress_page
|
292
293
|
|
293
|
-
> <V1EntitiesDealsProgress>
|
294
|
+
> <V1EntitiesDealsProgress> get_deals_id_progress_page(id)
|
294
295
|
|
295
|
-
Get deal progress
|
296
|
+
Get deal progress
|
296
297
|
|
297
298
|
Get deal progress
|
298
299
|
|
@@ -306,32 +307,31 @@ DealMakerAPI.configure do |config|end
|
|
306
307
|
|
307
308
|
api_instance = DealMakerAPI::DefaultApi.new
|
308
309
|
id = 56 # Integer | The deal id.
|
309
|
-
kind = 'investment_amount' # String | Kind of progress.
|
310
310
|
|
311
311
|
begin
|
312
|
-
# Get deal progress
|
313
|
-
result = api_instance.
|
312
|
+
# Get deal progress
|
313
|
+
result = api_instance.get_deals_id_progress_page(id)
|
314
314
|
p result
|
315
315
|
rescue DealMakerAPI::ApiError => e
|
316
|
-
puts "Error when calling DefaultApi->
|
316
|
+
puts "Error when calling DefaultApi->get_deals_id_progress_page: #{e}"
|
317
317
|
end
|
318
318
|
```
|
319
319
|
|
320
|
-
#### Using the
|
320
|
+
#### Using the get_deals_id_progress_page_with_http_info variant
|
321
321
|
|
322
322
|
This returns an Array which contains the response data, status code and headers.
|
323
323
|
|
324
|
-
> <Array(<V1EntitiesDealsProgress>, Integer, Hash)>
|
324
|
+
> <Array(<V1EntitiesDealsProgress>, Integer, Hash)> get_deals_id_progress_page_with_http_info(id)
|
325
325
|
|
326
326
|
```ruby
|
327
327
|
begin
|
328
|
-
# Get deal progress
|
329
|
-
data, status_code, headers = api_instance.
|
328
|
+
# Get deal progress
|
329
|
+
data, status_code, headers = api_instance.get_deals_id_progress_page_with_http_info(id)
|
330
330
|
p status_code # => 2xx
|
331
331
|
p headers # => { ... }
|
332
332
|
p data # => <V1EntitiesDealsProgress>
|
333
333
|
rescue DealMakerAPI::ApiError => e
|
334
|
-
puts "Error when calling DefaultApi->
|
334
|
+
puts "Error when calling DefaultApi->get_deals_id_progress_page_with_http_info: #{e}"
|
335
335
|
end
|
336
336
|
```
|
337
337
|
|
@@ -340,7 +340,6 @@ end
|
|
340
340
|
| Name | Type | Description | Notes |
|
341
341
|
| ---- | ---- | ----------- | ----- |
|
342
342
|
| **id** | **Integer** | The deal id. | |
|
343
|
-
| **kind** | **String** | Kind of progress. | |
|
344
343
|
|
345
344
|
### Return type
|
346
345
|
|
@@ -356,6 +355,72 @@ No authorization required
|
|
356
355
|
- **Accept**: application/json
|
357
356
|
|
358
357
|
|
358
|
+
## get_deals_id_progress_page_summary
|
359
|
+
|
360
|
+
> <V1EntitiesDealsProgressPageSummary> get_deals_id_progress_page_summary(id)
|
361
|
+
|
362
|
+
Get the deal progress summary
|
363
|
+
|
364
|
+
Get the deal progress summary
|
365
|
+
|
366
|
+
### Examples
|
367
|
+
|
368
|
+
```ruby
|
369
|
+
require 'time'
|
370
|
+
require 'DealMakerAPI'
|
371
|
+
# setup authorization
|
372
|
+
DealMakerAPI.configure do |config|end
|
373
|
+
|
374
|
+
api_instance = DealMakerAPI::DefaultApi.new
|
375
|
+
id = 56 # Integer | The deal id.
|
376
|
+
|
377
|
+
begin
|
378
|
+
# Get the deal progress summary
|
379
|
+
result = api_instance.get_deals_id_progress_page_summary(id)
|
380
|
+
p result
|
381
|
+
rescue DealMakerAPI::ApiError => e
|
382
|
+
puts "Error when calling DefaultApi->get_deals_id_progress_page_summary: #{e}"
|
383
|
+
end
|
384
|
+
```
|
385
|
+
|
386
|
+
#### Using the get_deals_id_progress_page_summary_with_http_info variant
|
387
|
+
|
388
|
+
This returns an Array which contains the response data, status code and headers.
|
389
|
+
|
390
|
+
> <Array(<V1EntitiesDealsProgressPageSummary>, Integer, Hash)> get_deals_id_progress_page_summary_with_http_info(id)
|
391
|
+
|
392
|
+
```ruby
|
393
|
+
begin
|
394
|
+
# Get the deal progress summary
|
395
|
+
data, status_code, headers = api_instance.get_deals_id_progress_page_summary_with_http_info(id)
|
396
|
+
p status_code # => 2xx
|
397
|
+
p headers # => { ... }
|
398
|
+
p data # => <V1EntitiesDealsProgressPageSummary>
|
399
|
+
rescue DealMakerAPI::ApiError => e
|
400
|
+
puts "Error when calling DefaultApi->get_deals_id_progress_page_summary_with_http_info: #{e}"
|
401
|
+
end
|
402
|
+
```
|
403
|
+
|
404
|
+
### Parameters
|
405
|
+
|
406
|
+
| Name | Type | Description | Notes |
|
407
|
+
| ---- | ---- | ----------- | ----- |
|
408
|
+
| **id** | **Integer** | The deal id. | |
|
409
|
+
|
410
|
+
### Return type
|
411
|
+
|
412
|
+
[**V1EntitiesDealsProgressPageSummary**](V1EntitiesDealsProgressPageSummary.md)
|
413
|
+
|
414
|
+
### Authorization
|
415
|
+
|
416
|
+
No authorization required
|
417
|
+
|
418
|
+
### HTTP request headers
|
419
|
+
|
420
|
+
- **Content-Type**: Not defined
|
421
|
+
- **Accept**: application/json
|
422
|
+
|
423
|
+
|
359
424
|
## get_deals_id_summary
|
360
425
|
|
361
426
|
> 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
|
+
|
data/docs/UserApi.md
CHANGED
@@ -5,11 +5,14 @@ All URIs are relative to *http://api.dealmaker.tech*
|
|
5
5
|
| Method | HTTP request | Description |
|
6
6
|
| ------ | ------------ | ----------- |
|
7
7
|
| [**create_factor**](UserApi.md#create_factor) | **POST** /users/{id}/create_factor | Creates an API endpoint for creating a new TOTP factor |
|
8
|
+
| [**delete_channel**](UserApi.md#delete_channel) | **DELETE** /users/{id}/two_factor_channels/delete/{channel} | Creates an API endpoint to delete a specific two factor channel\" |
|
9
|
+
| [**disable_mfa**](UserApi.md#disable_mfa) | **DELETE** /users/{id}/disable_mfa | Disable all the multi-factor authentication integrations for a user |
|
8
10
|
| [**get_two_factor_channels**](UserApi.md#get_two_factor_channels) | **GET** /users/{id}/two_factor_channels | Creates an API endpoint to return a list of existing TOTP factor |
|
9
11
|
| [**get_user**](UserApi.md#get_user) | **GET** /users/{id} | Get user by User ID |
|
10
12
|
| [**setup_sms_verification**](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 |
|
11
13
|
| [**update_user_password**](UserApi.md#update_user_password) | **PUT** /users/{id}/update_password | Update user password |
|
12
14
|
| [**verify_factor**](UserApi.md#verify_factor) | **PUT** /users/{id}/verify_factor | Creates an API endpoint to verify an existing TOTP factor |
|
15
|
+
| [**verify_sms_verification**](UserApi.md#verify_sms_verification) | **POST** /users/{id}/verify_sms_verification | Verify a SMS Verification by creating a two factor channel of sms type |
|
13
16
|
|
14
17
|
|
15
18
|
## create_factor
|
@@ -78,6 +81,139 @@ No authorization required
|
|
78
81
|
- **Accept**: application/json
|
79
82
|
|
80
83
|
|
84
|
+
## delete_channel
|
85
|
+
|
86
|
+
> <V1EntitiesDeleteResult> delete_channel(id, channel)
|
87
|
+
|
88
|
+
Creates an API endpoint to delete a specific two factor channel\"
|
89
|
+
|
90
|
+
Create an API endpoint to delete a specific two factor channel
|
91
|
+
|
92
|
+
### Examples
|
93
|
+
|
94
|
+
```ruby
|
95
|
+
require 'time'
|
96
|
+
require 'DealMakerAPI'
|
97
|
+
# setup authorization
|
98
|
+
DealMakerAPI.configure do |config|end
|
99
|
+
|
100
|
+
api_instance = DealMakerAPI::UserApi.new
|
101
|
+
id = 56 # Integer |
|
102
|
+
channel = 56 # Integer |
|
103
|
+
|
104
|
+
begin
|
105
|
+
# Creates an API endpoint to delete a specific two factor channel\"
|
106
|
+
result = api_instance.delete_channel(id, channel)
|
107
|
+
p result
|
108
|
+
rescue DealMakerAPI::ApiError => e
|
109
|
+
puts "Error when calling UserApi->delete_channel: #{e}"
|
110
|
+
end
|
111
|
+
```
|
112
|
+
|
113
|
+
#### Using the delete_channel_with_http_info variant
|
114
|
+
|
115
|
+
This returns an Array which contains the response data, status code and headers.
|
116
|
+
|
117
|
+
> <Array(<V1EntitiesDeleteResult>, Integer, Hash)> delete_channel_with_http_info(id, channel)
|
118
|
+
|
119
|
+
```ruby
|
120
|
+
begin
|
121
|
+
# Creates an API endpoint to delete a specific two factor channel\"
|
122
|
+
data, status_code, headers = api_instance.delete_channel_with_http_info(id, channel)
|
123
|
+
p status_code # => 2xx
|
124
|
+
p headers # => { ... }
|
125
|
+
p data # => <V1EntitiesDeleteResult>
|
126
|
+
rescue DealMakerAPI::ApiError => e
|
127
|
+
puts "Error when calling UserApi->delete_channel_with_http_info: #{e}"
|
128
|
+
end
|
129
|
+
```
|
130
|
+
|
131
|
+
### Parameters
|
132
|
+
|
133
|
+
| Name | Type | Description | Notes |
|
134
|
+
| ---- | ---- | ----------- | ----- |
|
135
|
+
| **id** | **Integer** | | |
|
136
|
+
| **channel** | **Integer** | | |
|
137
|
+
|
138
|
+
### Return type
|
139
|
+
|
140
|
+
[**V1EntitiesDeleteResult**](V1EntitiesDeleteResult.md)
|
141
|
+
|
142
|
+
### Authorization
|
143
|
+
|
144
|
+
No authorization required
|
145
|
+
|
146
|
+
### HTTP request headers
|
147
|
+
|
148
|
+
- **Content-Type**: Not defined
|
149
|
+
- **Accept**: application/json
|
150
|
+
|
151
|
+
|
152
|
+
## disable_mfa
|
153
|
+
|
154
|
+
> disable_mfa(id)
|
155
|
+
|
156
|
+
Disable all the multi-factor authentication integrations for a user
|
157
|
+
|
158
|
+
Disable all the multi-factor authentication integrations for a user
|
159
|
+
|
160
|
+
### Examples
|
161
|
+
|
162
|
+
```ruby
|
163
|
+
require 'time'
|
164
|
+
require 'DealMakerAPI'
|
165
|
+
# setup authorization
|
166
|
+
DealMakerAPI.configure do |config|end
|
167
|
+
|
168
|
+
api_instance = DealMakerAPI::UserApi.new
|
169
|
+
id = 56 # Integer |
|
170
|
+
|
171
|
+
begin
|
172
|
+
# Disable all the multi-factor authentication integrations for a user
|
173
|
+
api_instance.disable_mfa(id)
|
174
|
+
rescue DealMakerAPI::ApiError => e
|
175
|
+
puts "Error when calling UserApi->disable_mfa: #{e}"
|
176
|
+
end
|
177
|
+
```
|
178
|
+
|
179
|
+
#### Using the disable_mfa_with_http_info variant
|
180
|
+
|
181
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
182
|
+
|
183
|
+
> <Array(nil, Integer, Hash)> disable_mfa_with_http_info(id)
|
184
|
+
|
185
|
+
```ruby
|
186
|
+
begin
|
187
|
+
# Disable all the multi-factor authentication integrations for a user
|
188
|
+
data, status_code, headers = api_instance.disable_mfa_with_http_info(id)
|
189
|
+
p status_code # => 2xx
|
190
|
+
p headers # => { ... }
|
191
|
+
p data # => nil
|
192
|
+
rescue DealMakerAPI::ApiError => e
|
193
|
+
puts "Error when calling UserApi->disable_mfa_with_http_info: #{e}"
|
194
|
+
end
|
195
|
+
```
|
196
|
+
|
197
|
+
### Parameters
|
198
|
+
|
199
|
+
| Name | Type | Description | Notes |
|
200
|
+
| ---- | ---- | ----------- | ----- |
|
201
|
+
| **id** | **Integer** | | |
|
202
|
+
|
203
|
+
### Return type
|
204
|
+
|
205
|
+
nil (empty response body)
|
206
|
+
|
207
|
+
### Authorization
|
208
|
+
|
209
|
+
No authorization required
|
210
|
+
|
211
|
+
### HTTP request headers
|
212
|
+
|
213
|
+
- **Content-Type**: Not defined
|
214
|
+
- **Accept**: Not defined
|
215
|
+
|
216
|
+
|
81
217
|
## get_two_factor_channels
|
82
218
|
|
83
219
|
> <V1EntitiesUsersTwoFactorChannels> get_two_factor_channels(id)
|
@@ -412,3 +548,71 @@ No authorization required
|
|
412
548
|
- **Content-Type**: application/json
|
413
549
|
- **Accept**: application/json
|
414
550
|
|
551
|
+
|
552
|
+
## verify_sms_verification
|
553
|
+
|
554
|
+
> <V1EntitiesUsersTwoFactorChannel> verify_sms_verification(id, verify_sms_verification_request)
|
555
|
+
|
556
|
+
Verify a SMS Verification by creating a two factor channel of sms type
|
557
|
+
|
558
|
+
Verify a SMS Verification by creating a two factor channel of sms type
|
559
|
+
|
560
|
+
### Examples
|
561
|
+
|
562
|
+
```ruby
|
563
|
+
require 'time'
|
564
|
+
require 'DealMakerAPI'
|
565
|
+
# setup authorization
|
566
|
+
DealMakerAPI.configure do |config|end
|
567
|
+
|
568
|
+
api_instance = DealMakerAPI::UserApi.new
|
569
|
+
id = 56 # Integer |
|
570
|
+
verify_sms_verification_request = DealMakerAPI::VerifySmsVerificationRequest.new({phone_number: 'phone_number_example', code: 'code_example'}) # VerifySmsVerificationRequest |
|
571
|
+
|
572
|
+
begin
|
573
|
+
# Verify a SMS Verification by creating a two factor channel of sms type
|
574
|
+
result = api_instance.verify_sms_verification(id, verify_sms_verification_request)
|
575
|
+
p result
|
576
|
+
rescue DealMakerAPI::ApiError => e
|
577
|
+
puts "Error when calling UserApi->verify_sms_verification: #{e}"
|
578
|
+
end
|
579
|
+
```
|
580
|
+
|
581
|
+
#### Using the verify_sms_verification_with_http_info variant
|
582
|
+
|
583
|
+
This returns an Array which contains the response data, status code and headers.
|
584
|
+
|
585
|
+
> <Array(<V1EntitiesUsersTwoFactorChannel>, Integer, Hash)> verify_sms_verification_with_http_info(id, verify_sms_verification_request)
|
586
|
+
|
587
|
+
```ruby
|
588
|
+
begin
|
589
|
+
# Verify a SMS Verification by creating a two factor channel of sms type
|
590
|
+
data, status_code, headers = api_instance.verify_sms_verification_with_http_info(id, verify_sms_verification_request)
|
591
|
+
p status_code # => 2xx
|
592
|
+
p headers # => { ... }
|
593
|
+
p data # => <V1EntitiesUsersTwoFactorChannel>
|
594
|
+
rescue DealMakerAPI::ApiError => e
|
595
|
+
puts "Error when calling UserApi->verify_sms_verification_with_http_info: #{e}"
|
596
|
+
end
|
597
|
+
```
|
598
|
+
|
599
|
+
### Parameters
|
600
|
+
|
601
|
+
| Name | Type | Description | Notes |
|
602
|
+
| ---- | ---- | ----------- | ----- |
|
603
|
+
| **id** | **Integer** | | |
|
604
|
+
| **verify_sms_verification_request** | [**VerifySmsVerificationRequest**](VerifySmsVerificationRequest.md) | | |
|
605
|
+
|
606
|
+
### Return type
|
607
|
+
|
608
|
+
[**V1EntitiesUsersTwoFactorChannel**](V1EntitiesUsersTwoFactorChannel.md)
|
609
|
+
|
610
|
+
### Authorization
|
611
|
+
|
612
|
+
No authorization required
|
613
|
+
|
614
|
+
### HTTP request headers
|
615
|
+
|
616
|
+
- **Content-Type**: application/json
|
617
|
+
- **Accept**: application/json
|
618
|
+
|
@@ -6,6 +6,7 @@
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **id** | **Integer** | The attachment id. | [optional] |
|
8
8
|
| **url** | **String** | The attachment url. | [optional] |
|
9
|
+
| **status** | **String** | The attachment status. | [optional] |
|
9
10
|
| **file_name** | **String** | The attachment file name. | [optional] |
|
10
11
|
| **original_file_name** | **String** | The attachment original file name. | [optional] |
|
11
12
|
| **file_size** | **Integer** | The size of the file in bytes. | [optional] |
|
@@ -20,6 +21,7 @@ require 'DealMakerAPI'
|
|
20
21
|
instance = DealMakerAPI::V1EntitiesAttachment.new(
|
21
22
|
id: null,
|
22
23
|
url: null,
|
24
|
+
status: null,
|
23
25
|
file_name: null,
|
24
26
|
original_file_name: null,
|
25
27
|
file_size: null,
|
@@ -4,8 +4,8 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **investor_funnel** | [**
|
8
|
-
| **incoming_payments** | [**
|
7
|
+
| **investor_funnel** | [**V1EntitiesDealsProgressKinds**](V1EntitiesDealsProgressKinds.md) | | [optional] |
|
8
|
+
| **incoming_payments** | [**V1EntitiesDealsProgressKinds**](V1EntitiesDealsProgressKinds.md) | | [optional] |
|
9
9
|
|
10
10
|
## Example
|
11
11
|
|
@@ -6,6 +6,7 @@
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **label** | **String** | The label of the column. | [optional] |
|
8
8
|
| **value** | **Integer** | The value for the column. | [optional] |
|
9
|
+
| **description** | **Integer** | The description of the column. | [optional] |
|
9
10
|
|
10
11
|
## Example
|
11
12
|
|
@@ -14,7 +15,8 @@ require 'DealMakerAPI'
|
|
14
15
|
|
15
16
|
instance = DealMakerAPI::V1EntitiesDealsProgressColumn.new(
|
16
17
|
label: null,
|
17
|
-
value: null
|
18
|
+
value: null,
|
19
|
+
description: null
|
18
20
|
)
|
19
21
|
```
|
20
22
|
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# DealMakerAPI::V1EntitiesDealsProgressKinds
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **investment_amount** | [**V1EntitiesDealsProgressColumn**](V1EntitiesDealsProgressColumn.md) | | [optional] |
|
8
|
+
| **number_of_investments** | [**V1EntitiesDealsProgressColumn**](V1EntitiesDealsProgressColumn.md) | | [optional] |
|
9
|
+
| **number_of_securities** | [**V1EntitiesDealsProgressColumn**](V1EntitiesDealsProgressColumn.md) | | [optional] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'DealMakerAPI'
|
15
|
+
|
16
|
+
instance = DealMakerAPI::V1EntitiesDealsProgressKinds.new(
|
17
|
+
investment_amount: null,
|
18
|
+
number_of_investments: null,
|
19
|
+
number_of_securities: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
@@ -0,0 +1,32 @@
|
|
1
|
+
# DealMakerAPI::V1EntitiesDealsProgressPageSummary
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **investment_proceeds** | **Float** | Investment Proceeds | [optional] |
|
8
|
+
| **fees_and_adjustments** | **Float** | Fees and Adjustments | [optional] |
|
9
|
+
| **total_proceeds** | **Float** | Total Proceeds | [optional] |
|
10
|
+
| **processing_fees** | **Float** | Processing Fees | [optional] |
|
11
|
+
| **invoice_deductions** | **Float** | Invoice Deductions | [optional] |
|
12
|
+
| **holdback** | **Float** | Holdback | [optional] |
|
13
|
+
| **paid_out** | **Float** | Paid Out | [optional] |
|
14
|
+
| **available_for_payout** | **Float** | Available for Payout | [optional] |
|
15
|
+
|
16
|
+
## Example
|
17
|
+
|
18
|
+
```ruby
|
19
|
+
require 'DealMakerAPI'
|
20
|
+
|
21
|
+
instance = DealMakerAPI::V1EntitiesDealsProgressPageSummary.new(
|
22
|
+
investment_proceeds: null,
|
23
|
+
fees_and_adjustments: null,
|
24
|
+
total_proceeds: null,
|
25
|
+
processing_fees: null,
|
26
|
+
invoice_deductions: null,
|
27
|
+
holdback: null,
|
28
|
+
paid_out: null,
|
29
|
+
available_for_payout: null
|
30
|
+
)
|
31
|
+
```
|
32
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# DealMakerAPI::V1EntitiesDeleteResult
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **success** | **Boolean** | The status of the request. | [optional] |
|
8
|
+
| **message** | **String** | The message of the request. | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'DealMakerAPI'
|
14
|
+
|
15
|
+
instance = DealMakerAPI::V1EntitiesDeleteResult.new(
|
16
|
+
success: null,
|
17
|
+
message: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|