Module: NucleusApi

Defined in:

lib/nucleus_api/version.rb,
lib/nucleus_api.rb,
lib/nucleus_api/api_error.rb,
lib/nucleus_api/api_client.rb,
lib/nucleus_api/models/card.rb,
lib/nucleus_api/models/cash.rb,
lib/nucleus_api/models/goal.rb,
lib/nucleus_api/models/node.rb,
lib/nucleus_api/models/sort.rb,
lib/nucleus_api/models/stat.rb,
lib/nucleus_api/api/bulk_api.rb,
lib/nucleus_api/api/card_api.rb,
lib/nucleus_api/models/check.rb,
lib/nucleus_api/models/model.rb,
lib/nucleus_api/models/order.rb,
lib/nucleus_api/models/score.rb,
lib/nucleus_api/models/stage.rb,
lib/nucleus_api/models/state.rb,
lib/nucleus_api/api/model_api.rb,
lib/nucleus_api/api/order_api.rb,
lib/nucleus_api/api/score_api.rb,
lib/nucleus_api/api/utils_api.rb,
lib/nucleus_api/configuration.rb,
lib/nucleus_api/models/answer.rb,
lib/nucleus_api/models/budget.rb,
lib/nucleus_api/models/client.rb,
lib/nucleus_api/models/member.rb,
lib/nucleus_api/api/budget_api.rb,
lib/nucleus_api/models/brokers.rb,
lib/nucleus_api/models/contact.rb,
lib/nucleus_api/models/feature.rb,
lib/nucleus_api/models/fx_rate.rb,
lib/nucleus_api/models/invoice.rb,
lib/nucleus_api/models/roundup.rb,
lib/nucleus_api/models/webhook.rb,
lib/nucleus_api/api/contact_api.rb,
lib/nucleus_api/api/funding_api.rb,
lib/nucleus_api/api/invoice_api.rb,
lib/nucleus_api/api/roundup_api.rb,
lib/nucleus_api/api/webhook_api.rb,
lib/nucleus_api/models/balances.rb,
lib/nucleus_api/models/business.rb,
lib/nucleus_api/models/currency.rb,
lib/nucleus_api/models/document.rb,
lib/nucleus_api/models/location.rb,
lib/nucleus_api/models/overflow.rb,
lib/nucleus_api/models/pageable.rb,
lib/nucleus_api/models/question.rb,
lib/nucleus_api/models/security.rb,
lib/nucleus_api/api/document_api.rb,
lib/nucleus_api/api/overflow_api.rb,
lib/nucleus_api/api/resource_api.rb,
lib/nucleus_api/models/audit_log.rb,
lib/nucleus_api/models/bank_link.rb,
lib/nucleus_api/models/benchmark.rb,
lib/nucleus_api/models/household.rb,
lib/nucleus_api/models/json_node.rb,
lib/nucleus_api/models/ownership.rb,
lib/nucleus_api/models/page_card.rb,
lib/nucleus_api/models/page_goal.rb,
lib/nucleus_api/models/page_node.rb,
lib/nucleus_api/models/portfolio.rb,
lib/nucleus_api/api/portfolio_api.rb,
lib/nucleus_api/models/allocation.rb,
lib/nucleus_api/models/answer_map.rb,
lib/nucleus_api/models/employment.rb,
lib/nucleus_api/models/goal_track.rb,
lib/nucleus_api/models/investment.rb,
lib/nucleus_api/models/line_items.rb,
lib/nucleus_api/models/order_bulk.rb,
lib/nucleus_api/models/page_model.rb,
lib/nucleus_api/models/page_order.rb,
lib/nucleus_api/models/page_score.rb,
lib/nucleus_api/models/page_stage.rb,
lib/nucleus_api/models/roundup_co.rb,
lib/nucleus_api/api/allocation_api.rb,
lib/nucleus_api/api/securities_api.rb,
lib/nucleus_api/auth_configuration.rb,
lib/nucleus_api/models/account_map.rb,
lib/nucleus_api/models/application.rb,
lib/nucleus_api/models/bank_credit.rb,
lib/nucleus_api/models/institution.rb,
lib/nucleus_api/models/order_track.rb,
lib/nucleus_api/models/overflow_vo.rb,
lib/nucleus_api/models/page_answer.rb,
lib/nucleus_api/models/page_budget.rb,
lib/nucleus_api/models/page_client.rb,
lib/nucleus_api/models/reason_code.rb,
lib/nucleus_api/models/account_type.rb,
lib/nucleus_api/models/admin_client.rb,
lib/nucleus_api/models/card_address.rb,
lib/nucleus_api/models/card_program.rb,
lib/nucleus_api/models/check_images.rb,
lib/nucleus_api/models/fx_rate_view.rb,
lib/nucleus_api/models/notification.rb,
lib/nucleus_api/models/order_status.rb,
lib/nucleus_api/models/page_account.rb,
lib/nucleus_api/models/page_contact.rb,
lib/nucleus_api/models/page_feature.rb,
lib/nucleus_api/models/page_funding.rb,
lib/nucleus_api/models/page_invoice.rb,
lib/nucleus_api/models/page_roundup.rb,
lib/nucleus_api/models/page_webhook.rb,
lib/nucleus_api/models/risk_profile.rb,
lib/nucleus_api/models/v_account_vo.rb,
lib/nucleus_api/api/admin_client_api.rb,
lib/nucleus_api/api/risk_profile_api.rb,
lib/nucleus_api/models/bank_link_map.rb,
lib/nucleus_api/models/budget_object.rb,
lib/nucleus_api/models/client_status.rb,
lib/nucleus_api/models/decision_tree.rb,
lib/nucleus_api/models/feature_track.rb,
lib/nucleus_api/models/merchants_map.rb,
lib/nucleus_api/models/model_comment.rb,
lib/nucleus_api/models/model_holding.rb,
lib/nucleus_api/models/page_business.rb,
lib/nucleus_api/models/page_document.rb,
lib/nucleus_api/models/page_overflow.rb,
lib/nucleus_api/models/page_question.rb,
lib/nucleus_api/models/page_security.rb,
lib/nucleus_api/models/permission_vo.rb,
lib/nucleus_api/models/questionnaire.rb,
lib/nucleus_api/api/questionnaire_api.rb,
lib/nucleus_api/models/account_status.rb,
lib/nucleus_api/models/categories_map.rb,
lib/nucleus_api/models/client_address.rb,
lib/nucleus_api/models/client_card_vo.rb,
lib/nucleus_api/models/date_double_vo.rb,
lib/nucleus_api/models/order_vo_clone.rb,
lib/nucleus_api/models/page_audit_log.rb,
lib/nucleus_api/models/page_bank_link.rb,
lib/nucleus_api/models/page_benchmark.rb,
lib/nucleus_api/models/page_household.rb,
lib/nucleus_api/models/page_portfolio.rb,
lib/nucleus_api/models/portfolio_goal.rb,
lib/nucleus_api/models/security_price.rb,
lib/nucleus_api/models/v_portfolio_vo.rb,
lib/nucleus_api/models/card_balance_vo.rb,
lib/nucleus_api/models/card_details_vo.rb,
lib/nucleus_api/models/client_response.rb,
lib/nucleus_api/models/contact_address.rb,
lib/nucleus_api/models/invoice_payment.rb,
lib/nucleus_api/models/mx_merchant_res.rb,
lib/nucleus_api/models/page_allocation.rb,
lib/nucleus_api/models/page_goal_track.rb,
lib/nucleus_api/models/page_order_bulk.rb,
lib/nucleus_api/models/bulk_transaction.rb,
lib/nucleus_api/models/business_address.rb,
lib/nucleus_api/models/customer_revenue.rb,
lib/nucleus_api/models/decision_tree_co.rb,
lib/nucleus_api/models/model_asset_size.rb,
lib/nucleus_api/models/model_holding_vo.rb,
lib/nucleus_api/models/page_application.rb,
lib/nucleus_api/models/page_institution.rb,
lib/nucleus_api/models/page_order_track.rb,
lib/nucleus_api/models/page_reason_code.rb,
lib/nucleus_api/models/roundup_settings.rb,
lib/nucleus_api/models/spending_control.rb,
lib/nucleus_api/api/spending_control_api.rb,
lib/nucleus_api/models/model_transaction.rb,
lib/nucleus_api/models/node_relationship.rb,
lib/nucleus_api/models/overflow_settings.rb,
lib/nucleus_api/models/page_account_type.rb,
lib/nucleus_api/models/page_admin_client.rb,
lib/nucleus_api/models/page_card_program.rb,
lib/nucleus_api/models/page_notification.rb,
lib/nucleus_api/models/page_order_status.rb,
lib/nucleus_api/models/page_risk_profile.rb,
lib/nucleus_api/models/portfolio_comment.rb,
lib/nucleus_api/models/client_credentials.rb,
lib/nucleus_api/models/page_client_status.rb,
lib/nucleus_api/models/page_decision_tree.rb,
lib/nucleus_api/models/page_feature_track.rb,
lib/nucleus_api/models/page_model_comment.rb,
lib/nucleus_api/models/page_model_holding.rb,
lib/nucleus_api/models/page_questionnaire.rb,
lib/nucleus_api/models/portfolio_goal_map.rb,
lib/nucleus_api/models/securities_country.rb,
lib/nucleus_api/models/security_exclusion.rb,
lib/nucleus_api/models/token_date_request.rb,
lib/nucleus_api/models/aggregation_account.rb,
lib/nucleus_api/models/allocation_node_map.rb,
lib/nucleus_api/models/bulk_transaction_vo.rb,
lib/nucleus_api/models/business_details_vo.rb,
lib/nucleus_api/models/client_relationship.rb,
lib/nucleus_api/models/financial_statement.rb,
lib/nucleus_api/models/funding_request_map.rb,
lib/nucleus_api/models/funding_transaction.rb,
lib/nucleus_api/models/goal_track_accounts.rb,
lib/nucleus_api/models/notification_client.rb,
lib/nucleus_api/models/page_account_status.rb,
lib/nucleus_api/models/page_portfolio_goal.rb,
lib/nucleus_api/models/page_security_price.rb,
lib/nucleus_api/models/security_country_vo.rb,
lib/nucleus_api/api/aggregation_account_api.rb,
lib/nucleus_api/api/financial_statement_api.rb,
lib/nucleus_api/models/goal_account_mapping.rb,
lib/nucleus_api/models/notification_setting.rb,
lib/nucleus_api/models/page_client_response.rb,
lib/nucleus_api/models/page_invoice_payment.rb,
lib/nucleus_api/models/page_mx_merchant_res.rb,
lib/nucleus_api/models/account_permission_vo.rb,
lib/nucleus_api/models/benchmark_composition.rb,
lib/nucleus_api/models/client_view_goal_data.rb,
lib/nucleus_api/models/page_customer_revenue.rb,
lib/nucleus_api/models/page_model_asset_size.rb,
lib/nucleus_api/models/page_roundup_settings.rb,
lib/nucleus_api/models/page_spending_control.rb,
lib/nucleus_api/models/page_transaction_code.rb,
lib/nucleus_api/models/portfolio_holding_agg.rb,
lib/nucleus_api/models/portfolio_holding_log.rb,
lib/nucleus_api/models/portfolio_transaction.rb,
lib/nucleus_api/models/statistic_resource_vo.rb,
lib/nucleus_api/models/allocation_composition.rb,
lib/nucleus_api/models/client_account_mapping.rb,
lib/nucleus_api/models/merchant_category_code.rb,
lib/nucleus_api/models/overflow_bank_link_map.rb,
lib/nucleus_api/models/page_model_transaction.rb,
lib/nucleus_api/models/page_node_relationship.rb,
lib/nucleus_api/models/page_overflow_settings.rb,
lib/nucleus_api/models/page_portfolio_comment.rb,
lib/nucleus_api/models/securities_composition.rb,
lib/nucleus_api/models/client_business_card_vo.rb,
lib/nucleus_api/models/decision_tree_result_vo.rb,
lib/nucleus_api/models/order_reconcile_request.rb,
lib/nucleus_api/models/page_security_exclusion.rb,
lib/nucleus_api/models/security_composition_vo.rb,
lib/nucleus_api/models/v_client_goal_view_data.rb,
lib/nucleus_api/models/acl_client_permission_vo.rb,
lib/nucleus_api/models/aggregation_accounts_map.rb,
lib/nucleus_api/models/allocation_aggregated_vo.rb,
lib/nucleus_api/models/available_date_double_vo.rb,
lib/nucleus_api/models/page_aggregation_account.rb,
lib/nucleus_api/models/page_financial_statement.rb,
lib/nucleus_api/models/page_funding_transaction.rb,
lib/nucleus_api/models/page_notification_client.rb,
lib/nucleus_api/models/portfolio_asset_size_log.rb,
lib/nucleus_api/models/external_account_transfer.rb,
lib/nucleus_api/models/page_notification_setting.rb,
lib/nucleus_api/models/account_allocation_mapping.rb,
lib/nucleus_api/models/budget_aggregation_account.rb,
lib/nucleus_api/models/page_account_permission_vo.rb,
lib/nucleus_api/models/page_portfolio_holding_agg.rb,
lib/nucleus_api/models/page_portfolio_holding_log.rb,
lib/nucleus_api/models/page_portfolio_transaction.rb,
lib/nucleus_api/models/aggregation_account_balance.rb,
lib/nucleus_api/models/aggregation_account_holding.rb,
lib/nucleus_api/models/page_allocation_composition.rb,
lib/nucleus_api/models/page_client_business_card_vo.rb,
lib/nucleus_api/models/order_reconcile_return_object.rb,
lib/nucleus_api/models/page_portfolio_asset_size_log.rb,
lib/nucleus_api/models/page_external_account_transfer.rb,
lib/nucleus_api/models/page_account_allocation_mapping.rb,
lib/nucleus_api/models/page_aggregation_account_balance.rb,
lib/nucleus_api/models/page_aggregation_account_holding.rb,
lib/nucleus_api/models/account_portfolio_rebalance_request.rb,
lib/nucleus_api/models/allocation_composition_aggregated_vo.rb,
lib/nucleus_api/models/page_aggregation_account_transaction.rb,
lib/nucleus_api/models/client_business_total_card_balance_vo.rb,
lib/nucleus_api/models/allocation_composition_model_holdings_vo.rb

Overview

#Hydrogen Nucleus API

#The Hydrogen Nucleus API

OpenAPI spec version: 1.9.0 Contact: info@hydrogenplatform.com Generated by: github.com/swagger-api/swagger-codegen.git Swagger Codegen version: 2.4.19

Defined Under Namespace

Classes: AccountAllocationMapping, AccountMap, AccountPermissionVO, AccountPortfolioRebalanceRequest, AccountStatus, AccountType, AclClientPermissionVO, AdminClient, AdminClientApi, AggregationAccount, AggregationAccountApi, AggregationAccountBalance, AggregationAccountHolding, AggregationAccountsMap, Allocation, AllocationAggregatedVO, AllocationApi, AllocationComposition, AllocationCompositionAggregatedVO, AllocationCompositionModelHoldingsVO, AllocationNodeMap, Answer, AnswerMap, ApiClient, ApiError, Application, AuditLog, AuthConfiguration, AvailableDateDoubleVO, Balances, BankCredit, BankLink, BankLinkMap, Benchmark, BenchmarkComposition, Brokers, Budget, BudgetAggregationAccount, BudgetApi, BudgetObject, BulkApi, BulkTransaction, BulkTransactionVO, Business, BusinessAddress, BusinessDetailsVO, Card, CardAddress, CardApi, CardBalanceVO, CardDetailsVO, CardProgram, Cash, CategoriesMap, Check, CheckImages, Client, ClientAccountMapping, ClientAddress, ClientBusinessCardVO, ClientBusinessTotalCardBalanceVO, ClientCardVO, ClientCredentials, ClientRelationship, ClientResponse, ClientStatus, ClientViewGoalData, Configuration, Contact, ContactAddress, ContactApi, Currency, CustomerRevenue, DateDoubleVO, DecisionTree, DecisionTreeCO, DecisionTreeResultVO, Document, DocumentApi, Employment, ExternalAccountTransfer, Feature, FeatureTrack, FinancialStatement, FinancialStatementApi, FundingApi, FundingRequestMap, FundingTransaction, FxRate, FxRateView, Goal, GoalAccountMapping, GoalTrack, GoalTrackAccounts, Household, Institution, Investment, Invoice, InvoiceApi, InvoicePayment, JsonNode, LineItems, Location, MXMerchantRes, Member, MerchantCategoryCode, MerchantsMap, Model, ModelApi, ModelAssetSize, ModelComment, ModelHolding, ModelHoldingVO, ModelTransaction, Node, NodeRelationship, Notification, NotificationClient, NotificationSetting, Order, OrderApi, OrderBulk, OrderReconcileRequest, OrderReconcileReturnObject, OrderStatus, OrderTrack, OrderVoClone, Overflow, OverflowApi, OverflowBankLinkMap, OverflowSettings, OverflowVO, Ownership, PageAccount, PageAccountAllocationMapping, PageAccountPermissionVO, PageAccountStatus, PageAccountType, PageAdminClient, PageAggregationAccount, PageAggregationAccountBalance, PageAggregationAccountHolding, PageAggregationAccountTransaction, PageAllocation, PageAllocationComposition, PageAnswer, PageApplication, PageAuditLog, PageBankLink, PageBenchmark, PageBudget, PageBusiness, PageCard, PageCardProgram, PageClient, PageClientBusinessCardVO, PageClientResponse, PageClientStatus, PageContact, PageCustomerRevenue, PageDecisionTree, PageDocument, PageExternalAccountTransfer, PageFeature, PageFeatureTrack, PageFinancialStatement, PageFunding, PageFundingTransaction, PageGoal, PageGoalTrack, PageHousehold, PageInstitution, PageInvoice, PageInvoicePayment, PageMXMerchantRes, PageModel, PageModelAssetSize, PageModelComment, PageModelHolding, PageModelTransaction, PageNode, PageNodeRelationship, PageNotification, PageNotificationClient, PageNotificationSetting, PageOrder, PageOrderBulk, PageOrderStatus, PageOrderTrack, PageOverflow, PageOverflowSettings, PagePortfolio, PagePortfolioAssetSizeLog, PagePortfolioComment, PagePortfolioGoal, PagePortfolioHoldingAgg, PagePortfolioHoldingLog, PagePortfolioTransaction, PageQuestion, PageQuestionnaire, PageReasonCode, PageRiskProfile, PageRoundup, PageRoundupSettings, PageScore, PageSecurity, PageSecurityExclusion, PageSecurityPrice, PageSpendingControl, PageStage, PageTransactionCode, PageWebhook, Pageable, PermissionVO, Portfolio, PortfolioApi, PortfolioAssetSizeLog, PortfolioComment, PortfolioGoal, PortfolioGoalMap, PortfolioHoldingAgg, PortfolioHoldingLog, PortfolioTransaction, Question, Questionnaire, QuestionnaireApi, ReasonCode, ResourceApi, RiskProfile, RiskProfileApi, Roundup, RoundupApi, RoundupCO, RoundupSettings, Score, ScoreApi, SecuritiesApi, SecuritiesComposition, SecuritiesCountry, Security, SecurityCompositionVO, SecurityCountryVO, SecurityExclusion, SecurityPrice, Sort, SpendingControl, SpendingControlApi, Stage, Stat, State, StatisticResourceVO, TokenDateRequest, UtilsApi, VAccountVO, VClientGoalViewData, VPortfolioVO, Webhook, WebhookApi

Constant Summary

VERSION =

'1.9.1'

Class Method Summary

• .configure ⇒ Object

  Customize default settings for the SDK using block.

Class Method Details

.configure ⇒ Object

Customize default settings for the SDK using block.

NucleusApi.configure do |config|
  config.username = "xxx"
  config.password = "xxx"
end

If no block given, return the default Configuration object.

# File 'lib/nucleus_api.rb', line 297

def configure
  if block_given?
    yield(AuthConfiguration.default)
  else
    AuthConfiguration.default
  end
end