nucleus_api 1.8.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 +7 -0
- data/Gemfile +7 -0
- data/README.md +787 -0
- data/Rakefile +8 -0
- data/docs/Account.md +22 -0
- data/docs/AccountAllocationMapping.md +17 -0
- data/docs/AccountApi.md +1919 -0
- data/docs/AccountMap.md +9 -0
- data/docs/AccountPermissionVO.md +9 -0
- data/docs/AccountPortfolioRebalanceRequest.md +21 -0
- data/docs/AccountStatus.md +16 -0
- data/docs/AccountType.md +23 -0
- data/docs/AclClientPermissionVO.md +10 -0
- data/docs/AdminClient.md +18 -0
- data/docs/AdminClientApi.md +309 -0
- data/docs/AggregationAccount.md +30 -0
- data/docs/AggregationAccountApi.md +1702 -0
- data/docs/AggregationAccountBalance.md +18 -0
- data/docs/AggregationAccountHolding.md +26 -0
- data/docs/AggregationAccountTransaction.md +23 -0
- data/docs/AggregationAccountsMap.md +9 -0
- data/docs/Allocation.md +22 -0
- data/docs/AllocationAggregatedVO.md +13 -0
- data/docs/AllocationApi.md +872 -0
- data/docs/AllocationComposition.md +18 -0
- data/docs/AllocationCompositionAggregatedVO.md +19 -0
- data/docs/AllocationCompositionModelHoldingsVO.md +22 -0
- data/docs/AllocationNodeMap.md +8 -0
- data/docs/Answer.md +18 -0
- data/docs/AnswerMap.md +8 -0
- data/docs/Application.md +15 -0
- data/docs/ApplicationApi.md +309 -0
- data/docs/AuditLog.md +23 -0
- data/docs/AuditLogApi.md +191 -0
- data/docs/AvailableDateDoubleVO.md +14 -0
- data/docs/BankCredit.md +15 -0
- data/docs/BankLink.md +29 -0
- data/docs/BankLinkMap.md +9 -0
- data/docs/Benchmark.md +17 -0
- data/docs/BenchmarkApi.md +375 -0
- data/docs/BenchmarkComposition.md +9 -0
- data/docs/Brokers.md +9 -0
- data/docs/Budget.md +25 -0
- data/docs/BudgetAggregationAccount.md +8 -0
- data/docs/BudgetApi.md +315 -0
- data/docs/BudgetObject.md +10 -0
- data/docs/BulkApi.md +249 -0
- data/docs/BulkTransaction.md +13 -0
- data/docs/BulkTransactionVO.md +12 -0
- data/docs/Business.md +32 -0
- data/docs/BusinessAddress.md +15 -0
- data/docs/BusinessApi.md +523 -0
- data/docs/Card.md +35 -0
- data/docs/CardAddress.md +14 -0
- data/docs/CardApi.md +754 -0
- data/docs/CardProgram.md +23 -0
- data/docs/Cash.md +10 -0
- data/docs/CategoriesMap.md +9 -0
- data/docs/CategoryInternalResponseVO.md +10 -0
- data/docs/CategoryResponseVO.md +9 -0
- data/docs/Check.md +10 -0
- data/docs/CheckImages.md +9 -0
- data/docs/Client.md +39 -0
- data/docs/ClientAccountMapping.md +10 -0
- data/docs/ClientAddress.md +15 -0
- data/docs/ClientApi.md +1008 -0
- data/docs/ClientRelationship.md +10 -0
- data/docs/ClientResponse.md +17 -0
- data/docs/ClientStatus.md +16 -0
- data/docs/ClientViewGoalData.md +21 -0
- data/docs/Country.md +12 -0
- data/docs/Currency.md +11 -0
- data/docs/Customer.md +21 -0
- data/docs/CustomerAddress.md +14 -0
- data/docs/CustomerApi.md +616 -0
- data/docs/CustomerRevenue.md +16 -0
- data/docs/DailyDeposit.md +28 -0
- data/docs/DailyWithdrawal.md +29 -0
- data/docs/DateDoubleVO.md +10 -0
- data/docs/DecisionTree.md +17 -0
- data/docs/DecisionTreeApi.md +971 -0
- data/docs/DecisionTreeCO.md +9 -0
- data/docs/DecisionTreeResultVO.md +9 -0
- data/docs/Document.md +30 -0
- data/docs/DocumentApi.md +309 -0
- data/docs/Employment.md +11 -0
- data/docs/ExternalAccountTransfer.md +28 -0
- data/docs/Feature.md +18 -0
- data/docs/FeatureApi.md +610 -0
- data/docs/FeatureTrack.md +14 -0
- data/docs/FinancialStatement.md +23 -0
- data/docs/FinancialStatementApi.md +315 -0
- data/docs/Funding.md +37 -0
- data/docs/FundingApi.md +1601 -0
- data/docs/FundingRequestMap.md +8 -0
- data/docs/FxRateView.md +11 -0
- data/docs/Goal.md +24 -0
- data/docs/GoalAccountMapping.md +11 -0
- data/docs/GoalApi.md +841 -0
- data/docs/GoalTrack.md +26 -0
- data/docs/GoalTrackAccounts.md +8 -0
- data/docs/Household.md +18 -0
- data/docs/HouseholdApi.md +523 -0
- data/docs/Investment.md +16 -0
- data/docs/Invoice.md +32 -0
- data/docs/InvoiceApi.md +622 -0
- data/docs/InvoicePayment.md +15 -0
- data/docs/JsonNode.md +29 -0
- data/docs/LineItems.md +15 -0
- data/docs/Location.md +15 -0
- data/docs/MXMerchantRes.md +14 -0
- data/docs/Member.md +11 -0
- data/docs/MerchantCategoryCode.md +11 -0
- data/docs/MerchantsMap.md +9 -0
- data/docs/Model.md +29 -0
- data/docs/ModelApi.md +1580 -0
- data/docs/ModelAssetSize.md +16 -0
- data/docs/ModelComment.md +15 -0
- data/docs/ModelHolding.md +25 -0
- data/docs/ModelHoldingVO.md +11 -0
- data/docs/ModelTransaction.md +17 -0
- data/docs/Node.md +15 -0
- data/docs/NodeRelationship.md +18 -0
- data/docs/Notification.md +20 -0
- data/docs/NotificationApi.md +911 -0
- data/docs/NotificationClient.md +19 -0
- data/docs/NotificationSetting.md +19 -0
- data/docs/Order.md +27 -0
- data/docs/OrderApi.md +1764 -0
- data/docs/OrderBulk.md +18 -0
- data/docs/OrderReconcileRequest.md +12 -0
- data/docs/OrderReconcileReturnObject.md +12 -0
- data/docs/OrderStatus.md +14 -0
- data/docs/OrderTrack.md +20 -0
- data/docs/OrderVoClone.md +20 -0
- data/docs/Overflow.md +16 -0
- data/docs/OverflowApi.md +492 -0
- data/docs/OverflowBankLinkMap.md +9 -0
- data/docs/OverflowSettings.md +17 -0
- data/docs/OverflowVO.md +10 -0
- data/docs/Ownership.md +12 -0
- data/docs/PageAccount.md +16 -0
- data/docs/PageAccountAllocationMapping.md +16 -0
- data/docs/PageAccountPermissionVO.md +16 -0
- data/docs/PageAccountStatus.md +16 -0
- data/docs/PageAccountType.md +16 -0
- data/docs/PageAdminClient.md +16 -0
- data/docs/PageAggregationAccount.md +16 -0
- data/docs/PageAggregationAccountBalance.md +16 -0
- data/docs/PageAggregationAccountHolding.md +16 -0
- data/docs/PageAggregationAccountTransaction.md +16 -0
- data/docs/PageAllocation.md +16 -0
- data/docs/PageAllocationComposition.md +16 -0
- data/docs/PageAnswer.md +16 -0
- data/docs/PageApplication.md +16 -0
- data/docs/PageAuditLog.md +16 -0
- data/docs/PageBankLink.md +16 -0
- data/docs/PageBenchmark.md +16 -0
- data/docs/PageBudget.md +16 -0
- data/docs/PageBusiness.md +16 -0
- data/docs/PageCard.md +16 -0
- data/docs/PageCardProgram.md +16 -0
- data/docs/PageClient.md +16 -0
- data/docs/PageClientResponse.md +16 -0
- data/docs/PageClientStatus.md +16 -0
- data/docs/PageCustomer.md +16 -0
- data/docs/PageCustomerRevenue.md +16 -0
- data/docs/PageDailyDeposit.md +16 -0
- data/docs/PageDailyWithdrawal.md +16 -0
- data/docs/PageDecisionTree.md +16 -0
- data/docs/PageDocument.md +16 -0
- data/docs/PageExternalAccountTransfer.md +16 -0
- data/docs/PageFeature.md +16 -0
- data/docs/PageFeatureTrack.md +16 -0
- data/docs/PageFinancialStatement.md +16 -0
- data/docs/PageFunding.md +16 -0
- data/docs/PageGoal.md +16 -0
- data/docs/PageGoalTrack.md +16 -0
- data/docs/PageHousehold.md +16 -0
- data/docs/PageInvoice.md +16 -0
- data/docs/PageInvoicePayment.md +16 -0
- data/docs/PageMXMerchantRes.md +16 -0
- data/docs/PageModel.md +16 -0
- data/docs/PageModelAssetSize.md +16 -0
- data/docs/PageModelComment.md +16 -0
- data/docs/PageModelHolding.md +16 -0
- data/docs/PageModelTransaction.md +16 -0
- data/docs/PageNode.md +16 -0
- data/docs/PageNodeRelationship.md +16 -0
- data/docs/PageNotification.md +16 -0
- data/docs/PageNotificationClient.md +16 -0
- data/docs/PageNotificationSetting.md +16 -0
- data/docs/PageOrder.md +16 -0
- data/docs/PageOrderBulk.md +16 -0
- data/docs/PageOrderStatus.md +16 -0
- data/docs/PageOrderTrack.md +16 -0
- data/docs/PageOverflow.md +16 -0
- data/docs/PageOverflowSettings.md +16 -0
- data/docs/PagePortfolio.md +16 -0
- data/docs/PagePortfolioAssetSizeLog.md +16 -0
- data/docs/PagePortfolioComment.md +16 -0
- data/docs/PagePortfolioGoal.md +16 -0
- data/docs/PagePortfolioHoldingLog.md +16 -0
- data/docs/PagePortfolioTransaction.md +16 -0
- data/docs/PageQuestion.md +16 -0
- data/docs/PageQuestionnaire.md +16 -0
- data/docs/PageReasonCode.md +16 -0
- data/docs/PageRiskProfile.md +16 -0
- data/docs/PageRoundup.md +16 -0
- data/docs/PageRoundupSettings.md +16 -0
- data/docs/PageScore.md +16 -0
- data/docs/PageSecurity.md +16 -0
- data/docs/PageSecurityExclusion.md +16 -0
- data/docs/PageSecurityPrice.md +16 -0
- data/docs/PageSpendingControl.md +16 -0
- data/docs/PageStage.md +16 -0
- data/docs/PageTransactionCode.md +16 -0
- data/docs/PageVAccountAssetSize.md +16 -0
- data/docs/PageWebhook.md +16 -0
- data/docs/PerformanceApi.md +973 -0
- data/docs/PermissionVO.md +9 -0
- data/docs/Portfolio.md +22 -0
- data/docs/PortfolioApi.md +1902 -0
- data/docs/PortfolioAssetSizeLog.md +20 -0
- data/docs/PortfolioComment.md +16 -0
- data/docs/PortfolioGoal.md +14 -0
- data/docs/PortfolioGoalMap.md +9 -0
- data/docs/PortfolioHoldingAgg.md +14 -0
- data/docs/PortfolioHoldingLog.md +21 -0
- data/docs/PortfolioTransaction.md +37 -0
- data/docs/Question.md +23 -0
- data/docs/Questionnaire.md +17 -0
- data/docs/QuestionnaireApi.md +1212 -0
- data/docs/ReasonCode.md +17 -0
- data/docs/ResourceApi.md +534 -0
- data/docs/RiskProfile.md +18 -0
- data/docs/RiskProfileApi.md +309 -0
- data/docs/Roundup.md +15 -0
- data/docs/RoundupApi.md +492 -0
- data/docs/RoundupCO.md +12 -0
- data/docs/RoundupSettings.md +21 -0
- data/docs/Score.md +23 -0
- data/docs/ScoreApi.md +309 -0
- data/docs/SecuritiesApi.md +917 -0
- data/docs/SecuritiesComposition.md +11 -0
- data/docs/SecuritiesCountry.md +9 -0
- data/docs/Security.md +32 -0
- data/docs/SecurityCompositionVO.md +21 -0
- data/docs/SecurityCountryVO.md +9 -0
- data/docs/SecurityExclusion.md +18 -0
- data/docs/SecurityPrice.md +20 -0
- data/docs/Sort.md +13 -0
- data/docs/SpendingControl.md +21 -0
- data/docs/SpendingControlApi.md +309 -0
- data/docs/Stage.md +22 -0
- data/docs/Stat.md +9 -0
- data/docs/State.md +10 -0
- data/docs/StatisticResourceVO.md +11 -0
- data/docs/TokenDateRequest.md +13 -0
- data/docs/TransactionCode.md +20 -0
- data/docs/UtilsApi.md +911 -0
- data/docs/VAccountAssetSize.md +11 -0
- data/docs/VAccountVO.md +13 -0
- data/docs/VClientGoalViewData.md +13 -0
- data/docs/VPortfolioVO.md +11 -0
- data/docs/Webhook.md +15 -0
- data/docs/WebhookApi.md +309 -0
- data/git_push.sh +55 -0
- data/lib/nucleus_api.rb +303 -0
- data/lib/nucleus_api/api/account_api.rb +1794 -0
- data/lib/nucleus_api/api/admin_client_api.rb +301 -0
- data/lib/nucleus_api/api/aggregation_account_api.rb +1587 -0
- data/lib/nucleus_api/api/allocation_api.rb +824 -0
- data/lib/nucleus_api/api/application_api.rb +301 -0
- data/lib/nucleus_api/api/audit_log_api.rb +190 -0
- data/lib/nucleus_api/api/benchmark_api.rb +362 -0
- data/lib/nucleus_api/api/budget_api.rb +307 -0
- data/lib/nucleus_api/api/bulk_api.rb +253 -0
- data/lib/nucleus_api/api/business_api.rb +508 -0
- data/lib/nucleus_api/api/card_api.rb +719 -0
- data/lib/nucleus_api/api/client_api.rb +950 -0
- data/lib/nucleus_api/api/customer_api.rb +585 -0
- data/lib/nucleus_api/api/decision_tree_api.rb +913 -0
- data/lib/nucleus_api/api/document_api.rb +301 -0
- data/lib/nucleus_api/api/feature_api.rb +579 -0
- data/lib/nucleus_api/api/financial_statement_api.rb +307 -0
- data/lib/nucleus_api/api/funding_api.rb +1497 -0
- data/lib/nucleus_api/api/goal_api.rb +819 -0
- data/lib/nucleus_api/api/household_api.rb +508 -0
- data/lib/nucleus_api/api/invoice_api.rb +591 -0
- data/lib/nucleus_api/api/model_api.rb +1479 -0
- data/lib/nucleus_api/api/notification_api.rb +857 -0
- data/lib/nucleus_api/api/order_api.rb +1688 -0
- data/lib/nucleus_api/api/overflow_api.rb +468 -0
- data/lib/nucleus_api/api/performance_api.rb +1131 -0
- data/lib/nucleus_api/api/portfolio_api.rb +1776 -0
- data/lib/nucleus_api/api/questionnaire_api.rb +1135 -0
- data/lib/nucleus_api/api/resource_api.rb +479 -0
- data/lib/nucleus_api/api/risk_profile_api.rb +301 -0
- data/lib/nucleus_api/api/roundup_api.rb +468 -0
- data/lib/nucleus_api/api/score_api.rb +301 -0
- data/lib/nucleus_api/api/securities_api.rb +863 -0
- data/lib/nucleus_api/api/spending_control_api.rb +301 -0
- data/lib/nucleus_api/api/utils_api.rb +857 -0
- data/lib/nucleus_api/api/webhook_api.rb +301 -0
- data/lib/nucleus_api/api_client.rb +428 -0
- data/lib/nucleus_api/api_error.rb +38 -0
- data/lib/nucleus_api/auth_configuration.rb +177 -0
- data/lib/nucleus_api/configuration.rb +224 -0
- data/lib/nucleus_api/models/account.rb +333 -0
- data/lib/nucleus_api/models/account_allocation_mapping.rb +294 -0
- data/lib/nucleus_api/models/account_map.rb +202 -0
- data/lib/nucleus_api/models/account_permission_vo.rb +195 -0
- data/lib/nucleus_api/models/account_portfolio_rebalance_request.rb +313 -0
- data/lib/nucleus_api/models/account_status.rb +275 -0
- data/lib/nucleus_api/models/account_type.rb +335 -0
- data/lib/nucleus_api/models/acl_client_permission_vo.rb +236 -0
- data/lib/nucleus_api/models/admin_client.rb +272 -0
- data/lib/nucleus_api/models/aggregation_account.rb +420 -0
- data/lib/nucleus_api/models/aggregation_account_balance.rb +284 -0
- data/lib/nucleus_api/models/aggregation_account_holding.rb +364 -0
- data/lib/nucleus_api/models/aggregation_account_transaction.rb +382 -0
- data/lib/nucleus_api/models/aggregation_accounts_map.rb +202 -0
- data/lib/nucleus_api/models/allocation.rb +325 -0
- data/lib/nucleus_api/models/allocation_aggregated_vo.rb +228 -0
- data/lib/nucleus_api/models/allocation_composition.rb +304 -0
- data/lib/nucleus_api/models/allocation_composition_aggregated_vo.rb +282 -0
- data/lib/nucleus_api/models/allocation_composition_model_holdings_vo.rb +311 -0
- data/lib/nucleus_api/models/allocation_node_map.rb +187 -0
- data/lib/nucleus_api/models/answer.rb +286 -0
- data/lib/nucleus_api/models/answer_map.rb +181 -0
- data/lib/nucleus_api/models/application.rb +256 -0
- data/lib/nucleus_api/models/audit_log.rb +357 -0
- data/lib/nucleus_api/models/available_date_double_vo.rb +243 -0
- data/lib/nucleus_api/models/bank_credit.rb +262 -0
- data/lib/nucleus_api/models/bank_link.rb +410 -0
- data/lib/nucleus_api/models/bank_link_map.rb +202 -0
- data/lib/nucleus_api/models/benchmark.rb +277 -0
- data/lib/nucleus_api/models/benchmark_composition.rb +202 -0
- data/lib/nucleus_api/models/brokers.rb +203 -0
- data/lib/nucleus_api/models/budget.rb +372 -0
- data/lib/nucleus_api/models/budget_aggregation_account.rb +187 -0
- data/lib/nucleus_api/models/budget_object.rb +213 -0
- data/lib/nucleus_api/models/bulk_transaction.rb +226 -0
- data/lib/nucleus_api/models/bulk_transaction_vo.rb +217 -0
- data/lib/nucleus_api/models/business.rb +430 -0
- data/lib/nucleus_api/models/business_address.rb +278 -0
- data/lib/nucleus_api/models/card.rb +489 -0
- data/lib/nucleus_api/models/card_address.rb +268 -0
- data/lib/nucleus_api/models/card_program.rb +350 -0
- data/lib/nucleus_api/models/cash.rb +213 -0
- data/lib/nucleus_api/models/categories_map.rb +202 -0
- data/lib/nucleus_api/models/category_internal_response_vo.rb +201 -0
- data/lib/nucleus_api/models/category_response_vo.rb +192 -0
- data/lib/nucleus_api/models/check.rb +210 -0
- data/lib/nucleus_api/models/check_images.rb +198 -0
- data/lib/nucleus_api/models/client.rb +523 -0
- data/lib/nucleus_api/models/client_account_mapping.rb +212 -0
- data/lib/nucleus_api/models/client_address.rb +278 -0
- data/lib/nucleus_api/models/client_relationship.rb +209 -0
- data/lib/nucleus_api/models/client_response.rb +280 -0
- data/lib/nucleus_api/models/client_status.rb +275 -0
- data/lib/nucleus_api/models/client_view_goal_data.rb +302 -0
- data/lib/nucleus_api/models/country.rb +233 -0
- data/lib/nucleus_api/models/currency.rb +212 -0
- data/lib/nucleus_api/models/customer.rb +317 -0
- data/lib/nucleus_api/models/customer_address.rb +268 -0
- data/lib/nucleus_api/models/customer_revenue.rb +284 -0
- data/lib/nucleus_api/models/daily_deposit.rb +395 -0
- data/lib/nucleus_api/models/daily_withdrawal.rb +405 -0
- data/lib/nucleus_api/models/date_double_vo.rb +203 -0
- data/lib/nucleus_api/models/decision_tree.rb +275 -0
- data/lib/nucleus_api/models/decision_tree_co.rb +202 -0
- data/lib/nucleus_api/models/decision_tree_result_vo.rb +192 -0
- data/lib/nucleus_api/models/document.rb +409 -0
- data/lib/nucleus_api/models/employment.rb +213 -0
- data/lib/nucleus_api/models/external_account_transfer.rb +412 -0
- data/lib/nucleus_api/models/feature.rb +286 -0
- data/lib/nucleus_api/models/feature_track.rb +251 -0
- data/lib/nucleus_api/models/financial_statement.rb +352 -0
- data/lib/nucleus_api/models/funding.rb +496 -0
- data/lib/nucleus_api/models/funding_request_map.rb +187 -0
- data/lib/nucleus_api/models/fx_rate_view.rb +233 -0
- data/lib/nucleus_api/models/goal.rb +340 -0
- data/lib/nucleus_api/models/goal_account_mapping.rb +218 -0
- data/lib/nucleus_api/models/goal_track.rb +372 -0
- data/lib/nucleus_api/models/goal_track_accounts.rb +187 -0
- data/lib/nucleus_api/models/household.rb +285 -0
- data/lib/nucleus_api/models/investment.rb +283 -0
- data/lib/nucleus_api/models/invoice.rb +452 -0
- data/lib/nucleus_api/models/invoice_payment.rb +269 -0
- data/lib/nucleus_api/models/json_node.rb +404 -0
- data/lib/nucleus_api/models/line_items.rb +278 -0
- data/lib/nucleus_api/models/location.rb +253 -0
- data/lib/nucleus_api/models/member.rb +217 -0
- data/lib/nucleus_api/models/merchant_category_code.rb +213 -0
- data/lib/nucleus_api/models/merchants_map.rb +202 -0
- data/lib/nucleus_api/models/model.rb +396 -0
- data/lib/nucleus_api/models/model_asset_size.rb +274 -0
- data/lib/nucleus_api/models/model_comment.rb +264 -0
- data/lib/nucleus_api/models/model_holding.rb +370 -0
- data/lib/nucleus_api/models/model_holding_vo.rb +208 -0
- data/lib/nucleus_api/models/model_transaction.rb +298 -0
- data/lib/nucleus_api/models/mx_merchant_res.rb +235 -0
- data/lib/nucleus_api/models/node.rb +260 -0
- data/lib/nucleus_api/models/node_relationship.rb +300 -0
- data/lib/nucleus_api/models/notification.rb +313 -0
- data/lib/nucleus_api/models/notification_client.rb +309 -0
- data/lib/nucleus_api/models/notification_setting.rb +300 -0
- data/lib/nucleus_api/models/order.rb +390 -0
- data/lib/nucleus_api/models/order_bulk.rb +309 -0
- data/lib/nucleus_api/models/order_reconcile_request.rb +220 -0
- data/lib/nucleus_api/models/order_reconcile_return_object.rb +227 -0
- data/lib/nucleus_api/models/order_status.rb +250 -0
- data/lib/nucleus_api/models/order_track.rb +316 -0
- data/lib/nucleus_api/models/order_vo_clone.rb +304 -0
- data/lib/nucleus_api/models/overflow.rb +281 -0
- data/lib/nucleus_api/models/overflow_bank_link_map.rb +202 -0
- data/lib/nucleus_api/models/overflow_settings.rb +287 -0
- data/lib/nucleus_api/models/overflow_vo.rb +203 -0
- data/lib/nucleus_api/models/ownership.rb +233 -0
- data/lib/nucleus_api/models/page_account.rb +258 -0
- data/lib/nucleus_api/models/page_account_allocation_mapping.rb +258 -0
- data/lib/nucleus_api/models/page_account_permission_vo.rb +258 -0
- data/lib/nucleus_api/models/page_account_status.rb +258 -0
- data/lib/nucleus_api/models/page_account_type.rb +258 -0
- data/lib/nucleus_api/models/page_admin_client.rb +258 -0
- data/lib/nucleus_api/models/page_aggregation_account.rb +258 -0
- data/lib/nucleus_api/models/page_aggregation_account_balance.rb +258 -0
- data/lib/nucleus_api/models/page_aggregation_account_holding.rb +258 -0
- data/lib/nucleus_api/models/page_aggregation_account_transaction.rb +258 -0
- data/lib/nucleus_api/models/page_allocation.rb +258 -0
- data/lib/nucleus_api/models/page_allocation_composition.rb +258 -0
- data/lib/nucleus_api/models/page_answer.rb +258 -0
- data/lib/nucleus_api/models/page_application.rb +258 -0
- data/lib/nucleus_api/models/page_audit_log.rb +258 -0
- data/lib/nucleus_api/models/page_bank_link.rb +258 -0
- data/lib/nucleus_api/models/page_benchmark.rb +258 -0
- data/lib/nucleus_api/models/page_budget.rb +258 -0
- data/lib/nucleus_api/models/page_business.rb +258 -0
- data/lib/nucleus_api/models/page_card.rb +258 -0
- data/lib/nucleus_api/models/page_card_program.rb +258 -0
- data/lib/nucleus_api/models/page_client.rb +258 -0
- data/lib/nucleus_api/models/page_client_response.rb +258 -0
- data/lib/nucleus_api/models/page_client_status.rb +258 -0
- data/lib/nucleus_api/models/page_customer.rb +258 -0
- data/lib/nucleus_api/models/page_customer_revenue.rb +258 -0
- data/lib/nucleus_api/models/page_daily_deposit.rb +258 -0
- data/lib/nucleus_api/models/page_daily_withdrawal.rb +258 -0
- data/lib/nucleus_api/models/page_decision_tree.rb +258 -0
- data/lib/nucleus_api/models/page_document.rb +258 -0
- data/lib/nucleus_api/models/page_external_account_transfer.rb +258 -0
- data/lib/nucleus_api/models/page_feature.rb +258 -0
- data/lib/nucleus_api/models/page_feature_track.rb +258 -0
- data/lib/nucleus_api/models/page_financial_statement.rb +258 -0
- data/lib/nucleus_api/models/page_funding.rb +258 -0
- data/lib/nucleus_api/models/page_goal.rb +258 -0
- data/lib/nucleus_api/models/page_goal_track.rb +258 -0
- data/lib/nucleus_api/models/page_household.rb +258 -0
- data/lib/nucleus_api/models/page_invoice.rb +258 -0
- data/lib/nucleus_api/models/page_invoice_payment.rb +258 -0
- data/lib/nucleus_api/models/page_model.rb +258 -0
- data/lib/nucleus_api/models/page_model_asset_size.rb +258 -0
- data/lib/nucleus_api/models/page_model_comment.rb +258 -0
- data/lib/nucleus_api/models/page_model_holding.rb +258 -0
- data/lib/nucleus_api/models/page_model_transaction.rb +258 -0
- data/lib/nucleus_api/models/page_mx_merchant_res.rb +255 -0
- data/lib/nucleus_api/models/page_node.rb +258 -0
- data/lib/nucleus_api/models/page_node_relationship.rb +258 -0
- data/lib/nucleus_api/models/page_notification.rb +258 -0
- data/lib/nucleus_api/models/page_notification_client.rb +258 -0
- data/lib/nucleus_api/models/page_notification_setting.rb +258 -0
- data/lib/nucleus_api/models/page_order.rb +258 -0
- data/lib/nucleus_api/models/page_order_bulk.rb +258 -0
- data/lib/nucleus_api/models/page_order_status.rb +258 -0
- data/lib/nucleus_api/models/page_order_track.rb +258 -0
- data/lib/nucleus_api/models/page_overflow.rb +258 -0
- data/lib/nucleus_api/models/page_overflow_settings.rb +258 -0
- data/lib/nucleus_api/models/page_portfolio.rb +258 -0
- data/lib/nucleus_api/models/page_portfolio_asset_size_log.rb +258 -0
- data/lib/nucleus_api/models/page_portfolio_comment.rb +258 -0
- data/lib/nucleus_api/models/page_portfolio_goal.rb +258 -0
- data/lib/nucleus_api/models/page_portfolio_holding_log.rb +258 -0
- data/lib/nucleus_api/models/page_portfolio_transaction.rb +258 -0
- data/lib/nucleus_api/models/page_question.rb +258 -0
- data/lib/nucleus_api/models/page_questionnaire.rb +258 -0
- data/lib/nucleus_api/models/page_reason_code.rb +258 -0
- data/lib/nucleus_api/models/page_risk_profile.rb +258 -0
- data/lib/nucleus_api/models/page_roundup.rb +258 -0
- data/lib/nucleus_api/models/page_roundup_settings.rb +258 -0
- data/lib/nucleus_api/models/page_score.rb +258 -0
- data/lib/nucleus_api/models/page_security.rb +258 -0
- data/lib/nucleus_api/models/page_security_exclusion.rb +258 -0
- data/lib/nucleus_api/models/page_security_price.rb +258 -0
- data/lib/nucleus_api/models/page_spending_control.rb +258 -0
- data/lib/nucleus_api/models/page_stage.rb +258 -0
- data/lib/nucleus_api/models/page_transaction_code.rb +258 -0
- data/lib/nucleus_api/models/page_v_account_asset_size.rb +258 -0
- data/lib/nucleus_api/models/page_webhook.rb +258 -0
- data/lib/nucleus_api/models/permission_vo.rb +226 -0
- data/lib/nucleus_api/models/portfolio.rb +341 -0
- data/lib/nucleus_api/models/portfolio_asset_size_log.rb +329 -0
- data/lib/nucleus_api/models/portfolio_comment.rb +279 -0
- data/lib/nucleus_api/models/portfolio_goal.rb +255 -0
- data/lib/nucleus_api/models/portfolio_goal_map.rb +202 -0
- data/lib/nucleus_api/models/portfolio_holding_agg.rb +243 -0
- data/lib/nucleus_api/models/portfolio_holding_log.rb +339 -0
- data/lib/nucleus_api/models/portfolio_transaction.rb +495 -0
- data/lib/nucleus_api/models/question.rb +334 -0
- data/lib/nucleus_api/models/questionnaire.rb +275 -0
- data/lib/nucleus_api/models/reason_code.rb +274 -0
- data/lib/nucleus_api/models/risk_profile.rb +286 -0
- data/lib/nucleus_api/models/roundup.rb +266 -0
- data/lib/nucleus_api/models/roundup_co.rb +232 -0
- data/lib/nucleus_api/models/roundup_settings.rb +331 -0
- data/lib/nucleus_api/models/score.rb +374 -0
- data/lib/nucleus_api/models/securities_composition.rb +232 -0
- data/lib/nucleus_api/models/securities_country.rb +202 -0
- data/lib/nucleus_api/models/security.rb +434 -0
- data/lib/nucleus_api/models/security_composition_vo.rb +300 -0
- data/lib/nucleus_api/models/security_country_vo.rb +190 -0
- data/lib/nucleus_api/models/security_exclusion.rb +300 -0
- data/lib/nucleus_api/models/security_price.rb +313 -0
- data/lib/nucleus_api/models/sort.rb +233 -0
- data/lib/nucleus_api/models/spending_control.rb +331 -0
- data/lib/nucleus_api/models/stage.rb +325 -0
- data/lib/nucleus_api/models/stat.rb +203 -0
- data/lib/nucleus_api/models/state.rb +202 -0
- data/lib/nucleus_api/models/statistic_resource_vo.rb +208 -0
- data/lib/nucleus_api/models/token_date_request.rb +233 -0
- data/lib/nucleus_api/models/transaction_code.rb +362 -0
- data/lib/nucleus_api/models/v_account_asset_size.rb +212 -0
- data/lib/nucleus_api/models/v_account_vo.rb +226 -0
- data/lib/nucleus_api/models/v_client_goal_view_data.rb +228 -0
- data/lib/nucleus_api/models/v_portfolio_vo.rb +208 -0
- data/lib/nucleus_api/models/webhook.rb +280 -0
- data/lib/nucleus_api/version.rb +15 -0
- data/nucleus_api.gemspec +46 -0
- data/spec/api/account_api_spec.rb +455 -0
- data/spec/api/admin_client_api_spec.rb +100 -0
- data/spec/api/aggregation_account_api_spec.rb +399 -0
- data/spec/api/allocation_api_spec.rb +225 -0
- data/spec/api/application_api_spec.rb +100 -0
- data/spec/api/audit_log_api_spec.rb +75 -0
- data/spec/api/benchmark_api_spec.rb +115 -0
- data/spec/api/budget_api_spec.rb +102 -0
- data/spec/api/bulk_api_spec.rb +86 -0
- data/spec/api/business_api_spec.rb +153 -0
- data/spec/api/card_api_spec.rb +201 -0
- data/spec/api/client_api_spec.rb +256 -0
- data/spec/api/customer_api_spec.rb +167 -0
- data/spec/api/decision_tree_api_spec.rb +242 -0
- data/spec/api/document_api_spec.rb +100 -0
- data/spec/api/feature_api_spec.rb +165 -0
- data/spec/api/financial_statement_api_spec.rb +102 -0
- data/spec/api/funding_api_spec.rb +382 -0
- data/spec/api/goal_api_spec.rb +225 -0
- data/spec/api/household_api_spec.rb +153 -0
- data/spec/api/invoice_api_spec.rb +169 -0
- data/spec/api/model_api_spec.rb +375 -0
- data/spec/api/notification_api_spec.rb +230 -0
- data/spec/api/order_api_spec.rb +412 -0
- data/spec/api/overflow_api_spec.rb +140 -0
- data/spec/api/performance_api_spec.rb +355 -0
- data/spec/api/portfolio_api_spec.rb +448 -0
- data/spec/api/questionnaire_api_spec.rb +295 -0
- data/spec/api/resource_api_spec.rb +148 -0
- data/spec/api/risk_profile_api_spec.rb +100 -0
- data/spec/api/roundup_api_spec.rb +140 -0
- data/spec/api/score_api_spec.rb +100 -0
- data/spec/api/securities_api_spec.rb +232 -0
- data/spec/api/spending_control_api_spec.rb +100 -0
- data/spec/api/utils_api_spec.rb +230 -0
- data/spec/api/webhook_api_spec.rb +100 -0
- data/spec/api_client_spec.rb +243 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/models/account_allocation_mapping_spec.rb +95 -0
- data/spec/models/account_map_spec.rb +47 -0
- data/spec/models/account_permission_vo_spec.rb +47 -0
- data/spec/models/account_portfolio_rebalance_request_spec.rb +119 -0
- data/spec/models/account_spec.rb +125 -0
- data/spec/models/account_status_spec.rb +89 -0
- data/spec/models/account_type_spec.rb +131 -0
- data/spec/models/acl_client_permission_vo_spec.rb +57 -0
- data/spec/models/admin_client_spec.rb +101 -0
- data/spec/models/aggregation_account_balance_spec.rb +101 -0
- data/spec/models/aggregation_account_holding_spec.rb +149 -0
- data/spec/models/aggregation_account_spec.rb +173 -0
- data/spec/models/aggregation_account_transaction_spec.rb +139 -0
- data/spec/models/aggregation_accounts_map_spec.rb +47 -0
- data/spec/models/allocation_aggregated_vo_spec.rb +71 -0
- data/spec/models/allocation_composition_aggregated_vo_spec.rb +107 -0
- data/spec/models/allocation_composition_model_holdings_vo_spec.rb +125 -0
- data/spec/models/allocation_composition_spec.rb +101 -0
- data/spec/models/allocation_node_map_spec.rb +41 -0
- data/spec/models/allocation_spec.rb +125 -0
- data/spec/models/answer_map_spec.rb +41 -0
- data/spec/models/answer_spec.rb +101 -0
- data/spec/models/application_spec.rb +83 -0
- data/spec/models/audit_log_spec.rb +131 -0
- data/spec/models/available_date_double_vo_spec.rb +77 -0
- data/spec/models/bank_credit_spec.rb +83 -0
- data/spec/models/bank_link_map_spec.rb +47 -0
- data/spec/models/bank_link_spec.rb +167 -0
- data/spec/models/benchmark_composition_spec.rb +47 -0
- data/spec/models/benchmark_spec.rb +95 -0
- data/spec/models/brokers_spec.rb +47 -0
- data/spec/models/budget_aggregation_account_spec.rb +41 -0
- data/spec/models/budget_object_spec.rb +53 -0
- data/spec/models/budget_spec.rb +143 -0
- data/spec/models/bulk_transaction_spec.rb +71 -0
- data/spec/models/bulk_transaction_vo_spec.rb +65 -0
- data/spec/models/business_address_spec.rb +83 -0
- data/spec/models/business_spec.rb +185 -0
- data/spec/models/card_address_spec.rb +77 -0
- data/spec/models/card_program_spec.rb +131 -0
- data/spec/models/card_spec.rb +202 -0
- data/spec/models/cash_spec.rb +53 -0
- data/spec/models/categories_map_spec.rb +47 -0
- data/spec/models/category_internal_response_vo_spec.rb +53 -0
- data/spec/models/category_response_vo_spec.rb +47 -0
- data/spec/models/check_images_spec.rb +47 -0
- data/spec/models/check_spec.rb +53 -0
- data/spec/models/client_account_mapping_spec.rb +53 -0
- data/spec/models/client_address_spec.rb +83 -0
- data/spec/models/client_relationship_spec.rb +53 -0
- data/spec/models/client_response_spec.rb +95 -0
- data/spec/models/client_spec.rb +239 -0
- data/spec/models/client_status_spec.rb +89 -0
- data/spec/models/client_view_goal_data_spec.rb +119 -0
- data/spec/models/country_spec.rb +65 -0
- data/spec/models/currency_spec.rb +59 -0
- data/spec/models/customer_address_spec.rb +77 -0
- data/spec/models/customer_revenue_spec.rb +89 -0
- data/spec/models/customer_spec.rb +119 -0
- data/spec/models/daily_deposit_spec.rb +161 -0
- data/spec/models/daily_withdrawal_spec.rb +167 -0
- data/spec/models/date_double_vo_spec.rb +53 -0
- data/spec/models/decision_tree_co_spec.rb +47 -0
- data/spec/models/decision_tree_result_vo_spec.rb +47 -0
- data/spec/models/decision_tree_spec.rb +95 -0
- data/spec/models/document_spec.rb +173 -0
- data/spec/models/employment_spec.rb +59 -0
- data/spec/models/external_account_transfer_spec.rb +161 -0
- data/spec/models/feature_spec.rb +101 -0
- data/spec/models/feature_track_spec.rb +77 -0
- data/spec/models/financial_statement_spec.rb +131 -0
- data/spec/models/funding_request_map_spec.rb +41 -0
- data/spec/models/funding_spec.rb +215 -0
- data/spec/models/fx_rate_view_spec.rb +59 -0
- data/spec/models/goal_account_mapping_spec.rb +59 -0
- data/spec/models/goal_spec.rb +137 -0
- data/spec/models/goal_track_accounts_spec.rb +41 -0
- data/spec/models/goal_track_spec.rb +149 -0
- data/spec/models/household_spec.rb +101 -0
- data/spec/models/investment_spec.rb +89 -0
- data/spec/models/invoice_payment_spec.rb +83 -0
- data/spec/models/invoice_spec.rb +185 -0
- data/spec/models/json_node_spec.rb +171 -0
- data/spec/models/line_items_spec.rb +83 -0
- data/spec/models/location_spec.rb +83 -0
- data/spec/models/member_spec.rb +59 -0
- data/spec/models/merchant_category_code_spec.rb +59 -0
- data/spec/models/merchants_map_spec.rb +47 -0
- data/spec/models/model_asset_size_spec.rb +89 -0
- data/spec/models/model_comment_spec.rb +83 -0
- data/spec/models/model_holding_spec.rb +143 -0
- data/spec/models/model_holding_vo_spec.rb +59 -0
- data/spec/models/model_spec.rb +167 -0
- data/spec/models/model_transaction_spec.rb +95 -0
- data/spec/models/mx_merchant_res_spec.rb +77 -0
- data/spec/models/node_relationship_spec.rb +101 -0
- data/spec/models/node_spec.rb +83 -0
- data/spec/models/notification_client_spec.rb +107 -0
- data/spec/models/notification_setting_spec.rb +107 -0
- data/spec/models/notification_spec.rb +113 -0
- data/spec/models/order_bulk_spec.rb +101 -0
- data/spec/models/order_reconcile_request_spec.rb +65 -0
- data/spec/models/order_reconcile_return_object_spec.rb +65 -0
- data/spec/models/order_spec.rb +155 -0
- data/spec/models/order_status_spec.rb +77 -0
- data/spec/models/order_track_spec.rb +113 -0
- data/spec/models/order_vo_clone_spec.rb +113 -0
- data/spec/models/overflow_bank_link_map_spec.rb +47 -0
- data/spec/models/overflow_settings_spec.rb +95 -0
- data/spec/models/overflow_spec.rb +89 -0
- data/spec/models/overflow_vo_spec.rb +53 -0
- data/spec/models/ownership_spec.rb +65 -0
- data/spec/models/page_account_allocation_mapping_spec.rb +89 -0
- data/spec/models/page_account_permission_vo_spec.rb +89 -0
- data/spec/models/page_account_spec.rb +89 -0
- data/spec/models/page_account_status_spec.rb +89 -0
- data/spec/models/page_account_type_spec.rb +89 -0
- data/spec/models/page_admin_client_spec.rb +89 -0
- data/spec/models/page_aggregation_account_balance_spec.rb +89 -0
- data/spec/models/page_aggregation_account_holding_spec.rb +89 -0
- data/spec/models/page_aggregation_account_spec.rb +89 -0
- data/spec/models/page_aggregation_account_transaction_spec.rb +89 -0
- data/spec/models/page_allocation_composition_spec.rb +89 -0
- data/spec/models/page_allocation_spec.rb +89 -0
- data/spec/models/page_answer_spec.rb +89 -0
- data/spec/models/page_application_spec.rb +89 -0
- data/spec/models/page_audit_log_spec.rb +89 -0
- data/spec/models/page_bank_link_spec.rb +89 -0
- data/spec/models/page_benchmark_spec.rb +89 -0
- data/spec/models/page_budget_spec.rb +89 -0
- data/spec/models/page_business_spec.rb +89 -0
- data/spec/models/page_card_program_spec.rb +89 -0
- data/spec/models/page_card_spec.rb +89 -0
- data/spec/models/page_client_response_spec.rb +89 -0
- data/spec/models/page_client_spec.rb +89 -0
- data/spec/models/page_client_status_spec.rb +89 -0
- data/spec/models/page_customer_revenue_spec.rb +89 -0
- data/spec/models/page_customer_spec.rb +89 -0
- data/spec/models/page_daily_deposit_spec.rb +89 -0
- data/spec/models/page_daily_withdrawal_spec.rb +89 -0
- data/spec/models/page_decision_tree_spec.rb +89 -0
- data/spec/models/page_document_spec.rb +89 -0
- data/spec/models/page_external_account_transfer_spec.rb +89 -0
- data/spec/models/page_feature_spec.rb +89 -0
- data/spec/models/page_feature_track_spec.rb +89 -0
- data/spec/models/page_financial_statement_spec.rb +89 -0
- data/spec/models/page_funding_spec.rb +89 -0
- data/spec/models/page_goal_spec.rb +89 -0
- data/spec/models/page_goal_track_spec.rb +89 -0
- data/spec/models/page_household_spec.rb +89 -0
- data/spec/models/page_invoice_payment_spec.rb +89 -0
- data/spec/models/page_invoice_spec.rb +89 -0
- data/spec/models/page_model_asset_size_spec.rb +89 -0
- data/spec/models/page_model_comment_spec.rb +89 -0
- data/spec/models/page_model_holding_spec.rb +89 -0
- data/spec/models/page_model_spec.rb +89 -0
- data/spec/models/page_model_transaction_spec.rb +89 -0
- data/spec/models/page_mx_merchant_res_spec.rb +89 -0
- data/spec/models/page_node_relationship_spec.rb +89 -0
- data/spec/models/page_node_spec.rb +89 -0
- data/spec/models/page_notification_client_spec.rb +89 -0
- data/spec/models/page_notification_setting_spec.rb +89 -0
- data/spec/models/page_notification_spec.rb +89 -0
- data/spec/models/page_order_bulk_spec.rb +89 -0
- data/spec/models/page_order_spec.rb +89 -0
- data/spec/models/page_order_status_spec.rb +89 -0
- data/spec/models/page_order_track_spec.rb +89 -0
- data/spec/models/page_overflow_settings_spec.rb +89 -0
- data/spec/models/page_overflow_spec.rb +89 -0
- data/spec/models/page_portfolio_asset_size_log_spec.rb +89 -0
- data/spec/models/page_portfolio_comment_spec.rb +89 -0
- data/spec/models/page_portfolio_goal_spec.rb +89 -0
- data/spec/models/page_portfolio_holding_log_spec.rb +89 -0
- data/spec/models/page_portfolio_spec.rb +89 -0
- data/spec/models/page_portfolio_transaction_spec.rb +89 -0
- data/spec/models/page_question_spec.rb +89 -0
- data/spec/models/page_questionnaire_spec.rb +89 -0
- data/spec/models/page_reason_code_spec.rb +89 -0
- data/spec/models/page_risk_profile_spec.rb +89 -0
- data/spec/models/page_roundup_settings_spec.rb +89 -0
- data/spec/models/page_roundup_spec.rb +89 -0
- data/spec/models/page_score_spec.rb +89 -0
- data/spec/models/page_security_exclusion_spec.rb +89 -0
- data/spec/models/page_security_price_spec.rb +89 -0
- data/spec/models/page_security_spec.rb +89 -0
- data/spec/models/page_spending_control_spec.rb +89 -0
- data/spec/models/page_stage_spec.rb +89 -0
- data/spec/models/page_transaction_code_spec.rb +89 -0
- data/spec/models/page_v_account_asset_size_spec.rb +89 -0
- data/spec/models/page_webhook_spec.rb +89 -0
- data/spec/models/permission_vo_spec.rb +51 -0
- data/spec/models/portfolio_asset_size_log_spec.rb +113 -0
- data/spec/models/portfolio_comment_spec.rb +89 -0
- data/spec/models/portfolio_goal_map_spec.rb +47 -0
- data/spec/models/portfolio_goal_spec.rb +77 -0
- data/spec/models/portfolio_holding_agg_spec.rb +77 -0
- data/spec/models/portfolio_holding_log_spec.rb +119 -0
- data/spec/models/portfolio_spec.rb +125 -0
- data/spec/models/portfolio_transaction_spec.rb +215 -0
- data/spec/models/question_spec.rb +131 -0
- data/spec/models/questionnaire_spec.rb +95 -0
- data/spec/models/reason_code_spec.rb +95 -0
- data/spec/models/risk_profile_spec.rb +101 -0
- data/spec/models/roundup_co_spec.rb +65 -0
- data/spec/models/roundup_settings_spec.rb +119 -0
- data/spec/models/roundup_spec.rb +83 -0
- data/spec/models/score_spec.rb +135 -0
- data/spec/models/securities_composition_spec.rb +59 -0
- data/spec/models/securities_country_spec.rb +47 -0
- data/spec/models/security_composition_vo_spec.rb +119 -0
- data/spec/models/security_country_vo_spec.rb +47 -0
- data/spec/models/security_exclusion_spec.rb +101 -0
- data/spec/models/security_price_spec.rb +113 -0
- data/spec/models/security_spec.rb +185 -0
- data/spec/models/sort_spec.rb +71 -0
- data/spec/models/spending_control_spec.rb +119 -0
- data/spec/models/stage_spec.rb +125 -0
- data/spec/models/stat_spec.rb +47 -0
- data/spec/models/state_spec.rb +53 -0
- data/spec/models/statistic_resource_vo_spec.rb +59 -0
- data/spec/models/token_date_request_spec.rb +71 -0
- data/spec/models/transaction_code_spec.rb +125 -0
- data/spec/models/v_account_asset_size_spec.rb +59 -0
- data/spec/models/v_account_vo_spec.rb +71 -0
- data/spec/models/v_client_goal_view_data_spec.rb +71 -0
- data/spec/models/v_portfolio_vo_spec.rb +59 -0
- data/spec/models/webhook_spec.rb +87 -0
- data/spec/spec_helper.rb +111 -0
- metadata +1312 -0
|
@@ -0,0 +1,1702 @@
|
|
|
1
|
+
# NucleusApi::AggregationAccountApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://sandbox.hydrogenplatform.com/nucleus/v1*
|
|
4
|
+
|
|
5
|
+
Method | HTTP request | Description
|
|
6
|
+
------------- | ------------- | -------------
|
|
7
|
+
[**create_aggregation_account_balance_bulk_using_post**](AggregationAccountApi.md#create_aggregation_account_balance_bulk_using_post) | **POST** /bulk_aggregation_account_balance | Create a bulk aggregation account balance
|
|
8
|
+
[**create_aggregation_account_balance_using_post**](AggregationAccountApi.md#create_aggregation_account_balance_using_post) | **POST** /aggregation_account_balance | Create an aggregation account balance
|
|
9
|
+
[**create_aggregation_account_bulk_using_post**](AggregationAccountApi.md#create_aggregation_account_bulk_using_post) | **POST** /bulk_aggregation_account | Create a bulk aggregation account
|
|
10
|
+
[**create_aggregation_account_holding_bulk_using_post**](AggregationAccountApi.md#create_aggregation_account_holding_bulk_using_post) | **POST** /bulk_aggregation_account_holding | Create a bulk aggregation account holding
|
|
11
|
+
[**create_aggregation_account_holding_using_post**](AggregationAccountApi.md#create_aggregation_account_holding_using_post) | **POST** /aggregation_account_holding | Create an aggregation account holding
|
|
12
|
+
[**create_aggregation_account_transaction_bulk_using_post**](AggregationAccountApi.md#create_aggregation_account_transaction_bulk_using_post) | **POST** /bulk_aggregation_account_transaction | Create a bulk aggregation account transaction
|
|
13
|
+
[**create_aggregation_account_transaction_using_post**](AggregationAccountApi.md#create_aggregation_account_transaction_using_post) | **POST** /aggregation_account_transaction | Create an aggregation account transaction
|
|
14
|
+
[**create_aggregation_account_using_post**](AggregationAccountApi.md#create_aggregation_account_using_post) | **POST** /aggregation_account | Create an aggregation account
|
|
15
|
+
[**delete_aggregation_account_balance_using_delete**](AggregationAccountApi.md#delete_aggregation_account_balance_using_delete) | **DELETE** /aggregation_account_balance/{aggregation_account_balance_id} | Delete an aggregation account balance
|
|
16
|
+
[**delete_aggregation_account_holding_using_delete**](AggregationAccountApi.md#delete_aggregation_account_holding_using_delete) | **DELETE** /aggregation_account_holding/{aggregation_account_holding_id} | Delete an aggregation account holding
|
|
17
|
+
[**delete_aggregation_account_transaction_using_delete**](AggregationAccountApi.md#delete_aggregation_account_transaction_using_delete) | **DELETE** /aggregation_account_transaction/{aggregation_account_transaction_id} | Delete an aggregation account transaction
|
|
18
|
+
[**delete_aggregation_account_using_delete**](AggregationAccountApi.md#delete_aggregation_account_using_delete) | **DELETE** /aggregation_account/{aggregation_account_id} | Delete an aggregation account
|
|
19
|
+
[**get_aggregation_account_aggregate_data_using_get**](AggregationAccountApi.md#get_aggregation_account_aggregate_data_using_get) | **GET** /aggregation_account/{aggregation_account_id}/aggregate_data | Retrieve an aggregation account aggregate data
|
|
20
|
+
[**get_aggregation_account_all_using_get**](AggregationAccountApi.md#get_aggregation_account_all_using_get) | **GET** /aggregation_account | List all aggregation accounts
|
|
21
|
+
[**get_aggregation_account_balance_all_using_get**](AggregationAccountApi.md#get_aggregation_account_balance_all_using_get) | **GET** /aggregation_account_balance | List all aggregation account balances
|
|
22
|
+
[**get_aggregation_account_balance_using_get**](AggregationAccountApi.md#get_aggregation_account_balance_using_get) | **GET** /aggregation_account_balance/{aggregation_account_balance_id} | Retrieve an aggregation account balance
|
|
23
|
+
[**get_aggregation_account_holding_all_using_get**](AggregationAccountApi.md#get_aggregation_account_holding_all_using_get) | **GET** /aggregation_account_holding | List all aggregation account holdings
|
|
24
|
+
[**get_aggregation_account_holding_using_get**](AggregationAccountApi.md#get_aggregation_account_holding_using_get) | **GET** /aggregation_account_holding/{aggregation_account_holding_id} | Retrieve an aggregation account holding
|
|
25
|
+
[**get_aggregation_account_overview_using_get**](AggregationAccountApi.md#get_aggregation_account_overview_using_get) | **GET** /client/{client_id}/aggregation_account_overview | Retrieve an aggregation account aggregate data
|
|
26
|
+
[**get_aggregation_account_transaction_all_using_get**](AggregationAccountApi.md#get_aggregation_account_transaction_all_using_get) | **GET** /aggregation_account_transaction | List all aggregation account transactions
|
|
27
|
+
[**get_aggregation_account_transaction_using_get**](AggregationAccountApi.md#get_aggregation_account_transaction_using_get) | **GET** /aggregation_account_transaction/{aggregation_account_transaction_id} | Retrieve an aggregation account transaction
|
|
28
|
+
[**get_aggregation_account_using_get**](AggregationAccountApi.md#get_aggregation_account_using_get) | **GET** /aggregation_account/{aggregation_account_id} | Retrieve an aggregation account
|
|
29
|
+
[**update_aggregation_account_balance_using_put**](AggregationAccountApi.md#update_aggregation_account_balance_using_put) | **PUT** /aggregation_account_balance/{aggregation_account_balance_id} | Update an aggregation account balance
|
|
30
|
+
[**update_aggregation_account_bulk_using_put**](AggregationAccountApi.md#update_aggregation_account_bulk_using_put) | **PUT** /bulk_aggregation_account | Update a bulk aggregation account
|
|
31
|
+
[**update_aggregation_account_holding_bulk_using_put**](AggregationAccountApi.md#update_aggregation_account_holding_bulk_using_put) | **PUT** /bulk_aggregation_account_holding | Update an bulk aggregation account holding
|
|
32
|
+
[**update_aggregation_account_holding_using_put**](AggregationAccountApi.md#update_aggregation_account_holding_using_put) | **PUT** /aggregation_account_holding/{aggregation_account_holding_id} | Update an aggregation account holding
|
|
33
|
+
[**update_aggregation_account_transaction_using_put**](AggregationAccountApi.md#update_aggregation_account_transaction_using_put) | **PUT** /aggregation_account_transaction/{aggregation_account_transaction_id} | Update an aggregation account transaction
|
|
34
|
+
[**update_aggregation_account_using_put**](AggregationAccountApi.md#update_aggregation_account_using_put) | **PUT** /aggregation_account/{aggregation_account_id} | Update an aggregation account
|
|
35
|
+
|
|
36
|
+
|
|
37
|
+
# **create_aggregation_account_balance_bulk_using_post**
|
|
38
|
+
> Array<AggregationAccountBalance> create_aggregation_account_balance_bulk_using_post(aggregation_account_balance)
|
|
39
|
+
|
|
40
|
+
Create a bulk aggregation account balance
|
|
41
|
+
|
|
42
|
+
Create a balance records under an aggregation accounts.
|
|
43
|
+
|
|
44
|
+
### Example
|
|
45
|
+
```ruby
|
|
46
|
+
# load the gem
|
|
47
|
+
require 'nucleus_api'
|
|
48
|
+
# Setup authorization
|
|
49
|
+
NucleusApi.configure do |config|
|
|
50
|
+
# Use one of the below method to generate oauth token
|
|
51
|
+
# Creating a token for grant_type=client_credentials
|
|
52
|
+
config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
|
|
53
|
+
# Creating a token for grant_type=password
|
|
54
|
+
config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
|
|
55
|
+
# Creating a token using client token
|
|
56
|
+
config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
|
|
57
|
+
end
|
|
58
|
+
|
|
59
|
+
api_instance = NucleusApi::AggregationAccountApi.new
|
|
60
|
+
|
|
61
|
+
aggregation_account_balance = [NucleusApi::AggregationAccountBalance.new] # Array<AggregationAccountBalance> | aggregationAccountBalance
|
|
62
|
+
|
|
63
|
+
|
|
64
|
+
begin
|
|
65
|
+
#Create a bulk aggregation account balance
|
|
66
|
+
result = api_instance.create_aggregation_account_balance_bulk_using_post(aggregation_account_balance)
|
|
67
|
+
p result
|
|
68
|
+
rescue NucleusApi::ApiError => e
|
|
69
|
+
puts "Exception when calling AggregationAccountApi->create_aggregation_account_balance_bulk_using_post: #{e}"
|
|
70
|
+
end
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
### Parameters
|
|
74
|
+
|
|
75
|
+
Name | Type | Description | Notes
|
|
76
|
+
------------- | ------------- | ------------- | -------------
|
|
77
|
+
**aggregation_account_balance** | [**Array<AggregationAccountBalance>**](AggregationAccountBalance.md)| aggregationAccountBalance |
|
|
78
|
+
|
|
79
|
+
### Return type
|
|
80
|
+
|
|
81
|
+
[**Array<AggregationAccountBalance>**](AggregationAccountBalance.md)
|
|
82
|
+
|
|
83
|
+
### Authorization
|
|
84
|
+
|
|
85
|
+
[oauth2](../README.md#oauth2)
|
|
86
|
+
|
|
87
|
+
### HTTP request headers
|
|
88
|
+
|
|
89
|
+
- **Content-Type**: application/json
|
|
90
|
+
- **Accept**: */*
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
# **create_aggregation_account_balance_using_post**
|
|
95
|
+
> AggregationAccountBalance create_aggregation_account_balance_using_post(aggregation_account_balance)
|
|
96
|
+
|
|
97
|
+
Create an aggregation account balance
|
|
98
|
+
|
|
99
|
+
Create a balance record under an aggregation account.
|
|
100
|
+
|
|
101
|
+
### Example
|
|
102
|
+
```ruby
|
|
103
|
+
# load the gem
|
|
104
|
+
require 'nucleus_api'
|
|
105
|
+
# Setup authorization
|
|
106
|
+
NucleusApi.configure do |config|
|
|
107
|
+
# Use one of the below method to generate oauth token
|
|
108
|
+
# Creating a token for grant_type=client_credentials
|
|
109
|
+
config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
|
|
110
|
+
# Creating a token for grant_type=password
|
|
111
|
+
config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
|
|
112
|
+
# Creating a token using client token
|
|
113
|
+
config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
|
|
114
|
+
end
|
|
115
|
+
|
|
116
|
+
api_instance = NucleusApi::AggregationAccountApi.new
|
|
117
|
+
|
|
118
|
+
aggregation_account_balance = NucleusApi::AggregationAccountBalance.new # AggregationAccountBalance | aggregationAccountBalance
|
|
119
|
+
|
|
120
|
+
|
|
121
|
+
begin
|
|
122
|
+
#Create an aggregation account balance
|
|
123
|
+
result = api_instance.create_aggregation_account_balance_using_post(aggregation_account_balance)
|
|
124
|
+
p result
|
|
125
|
+
rescue NucleusApi::ApiError => e
|
|
126
|
+
puts "Exception when calling AggregationAccountApi->create_aggregation_account_balance_using_post: #{e}"
|
|
127
|
+
end
|
|
128
|
+
```
|
|
129
|
+
|
|
130
|
+
### Parameters
|
|
131
|
+
|
|
132
|
+
Name | Type | Description | Notes
|
|
133
|
+
------------- | ------------- | ------------- | -------------
|
|
134
|
+
**aggregation_account_balance** | [**AggregationAccountBalance**](AggregationAccountBalance.md)| aggregationAccountBalance |
|
|
135
|
+
|
|
136
|
+
### Return type
|
|
137
|
+
|
|
138
|
+
[**AggregationAccountBalance**](AggregationAccountBalance.md)
|
|
139
|
+
|
|
140
|
+
### Authorization
|
|
141
|
+
|
|
142
|
+
[oauth2](../README.md#oauth2)
|
|
143
|
+
|
|
144
|
+
### HTTP request headers
|
|
145
|
+
|
|
146
|
+
- **Content-Type**: application/json
|
|
147
|
+
- **Accept**: */*
|
|
148
|
+
|
|
149
|
+
|
|
150
|
+
|
|
151
|
+
# **create_aggregation_account_bulk_using_post**
|
|
152
|
+
> Array<AggregationAccount> create_aggregation_account_bulk_using_post(aggregation_account_list)
|
|
153
|
+
|
|
154
|
+
Create a bulk aggregation account
|
|
155
|
+
|
|
156
|
+
Create a bulk aggregation account under a client.
|
|
157
|
+
|
|
158
|
+
### Example
|
|
159
|
+
```ruby
|
|
160
|
+
# load the gem
|
|
161
|
+
require 'nucleus_api'
|
|
162
|
+
# Setup authorization
|
|
163
|
+
NucleusApi.configure do |config|
|
|
164
|
+
# Use one of the below method to generate oauth token
|
|
165
|
+
# Creating a token for grant_type=client_credentials
|
|
166
|
+
config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
|
|
167
|
+
# Creating a token for grant_type=password
|
|
168
|
+
config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
|
|
169
|
+
# Creating a token using client token
|
|
170
|
+
config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
|
|
171
|
+
end
|
|
172
|
+
|
|
173
|
+
api_instance = NucleusApi::AggregationAccountApi.new
|
|
174
|
+
|
|
175
|
+
aggregation_account_list = [NucleusApi::AggregationAccount.new] # Array<AggregationAccount> | aggregationAccountList
|
|
176
|
+
|
|
177
|
+
|
|
178
|
+
begin
|
|
179
|
+
#Create a bulk aggregation account
|
|
180
|
+
result = api_instance.create_aggregation_account_bulk_using_post(aggregation_account_list)
|
|
181
|
+
p result
|
|
182
|
+
rescue NucleusApi::ApiError => e
|
|
183
|
+
puts "Exception when calling AggregationAccountApi->create_aggregation_account_bulk_using_post: #{e}"
|
|
184
|
+
end
|
|
185
|
+
```
|
|
186
|
+
|
|
187
|
+
### Parameters
|
|
188
|
+
|
|
189
|
+
Name | Type | Description | Notes
|
|
190
|
+
------------- | ------------- | ------------- | -------------
|
|
191
|
+
**aggregation_account_list** | [**Array<AggregationAccount>**](AggregationAccount.md)| aggregationAccountList |
|
|
192
|
+
|
|
193
|
+
### Return type
|
|
194
|
+
|
|
195
|
+
[**Array<AggregationAccount>**](AggregationAccount.md)
|
|
196
|
+
|
|
197
|
+
### Authorization
|
|
198
|
+
|
|
199
|
+
[oauth2](../README.md#oauth2)
|
|
200
|
+
|
|
201
|
+
### HTTP request headers
|
|
202
|
+
|
|
203
|
+
- **Content-Type**: application/json
|
|
204
|
+
- **Accept**: */*
|
|
205
|
+
|
|
206
|
+
|
|
207
|
+
|
|
208
|
+
# **create_aggregation_account_holding_bulk_using_post**
|
|
209
|
+
> Array<AggregationAccountHolding> create_aggregation_account_holding_bulk_using_post(aggregation_transaction)
|
|
210
|
+
|
|
211
|
+
Create a bulk aggregation account holding
|
|
212
|
+
|
|
213
|
+
Create a bulk aggregation account holding.
|
|
214
|
+
|
|
215
|
+
### Example
|
|
216
|
+
```ruby
|
|
217
|
+
# load the gem
|
|
218
|
+
require 'nucleus_api'
|
|
219
|
+
# Setup authorization
|
|
220
|
+
NucleusApi.configure do |config|
|
|
221
|
+
# Use one of the below method to generate oauth token
|
|
222
|
+
# Creating a token for grant_type=client_credentials
|
|
223
|
+
config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
|
|
224
|
+
# Creating a token for grant_type=password
|
|
225
|
+
config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
|
|
226
|
+
# Creating a token using client token
|
|
227
|
+
config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
|
|
228
|
+
end
|
|
229
|
+
|
|
230
|
+
api_instance = NucleusApi::AggregationAccountApi.new
|
|
231
|
+
|
|
232
|
+
aggregation_transaction = [NucleusApi::AggregationAccountHolding.new] # Array<AggregationAccountHolding> | aggregationTransaction
|
|
233
|
+
|
|
234
|
+
|
|
235
|
+
begin
|
|
236
|
+
#Create a bulk aggregation account holding
|
|
237
|
+
result = api_instance.create_aggregation_account_holding_bulk_using_post(aggregation_transaction)
|
|
238
|
+
p result
|
|
239
|
+
rescue NucleusApi::ApiError => e
|
|
240
|
+
puts "Exception when calling AggregationAccountApi->create_aggregation_account_holding_bulk_using_post: #{e}"
|
|
241
|
+
end
|
|
242
|
+
```
|
|
243
|
+
|
|
244
|
+
### Parameters
|
|
245
|
+
|
|
246
|
+
Name | Type | Description | Notes
|
|
247
|
+
------------- | ------------- | ------------- | -------------
|
|
248
|
+
**aggregation_transaction** | [**Array<AggregationAccountHolding>**](AggregationAccountHolding.md)| aggregationTransaction |
|
|
249
|
+
|
|
250
|
+
### Return type
|
|
251
|
+
|
|
252
|
+
[**Array<AggregationAccountHolding>**](AggregationAccountHolding.md)
|
|
253
|
+
|
|
254
|
+
### Authorization
|
|
255
|
+
|
|
256
|
+
[oauth2](../README.md#oauth2)
|
|
257
|
+
|
|
258
|
+
### HTTP request headers
|
|
259
|
+
|
|
260
|
+
- **Content-Type**: application/json
|
|
261
|
+
- **Accept**: */*
|
|
262
|
+
|
|
263
|
+
|
|
264
|
+
|
|
265
|
+
# **create_aggregation_account_holding_using_post**
|
|
266
|
+
> AggregationAccountHolding create_aggregation_account_holding_using_post(aggregation_account_holding)
|
|
267
|
+
|
|
268
|
+
Create an aggregation account holding
|
|
269
|
+
|
|
270
|
+
Create a holding record under an aggregation account.
|
|
271
|
+
|
|
272
|
+
### Example
|
|
273
|
+
```ruby
|
|
274
|
+
# load the gem
|
|
275
|
+
require 'nucleus_api'
|
|
276
|
+
# Setup authorization
|
|
277
|
+
NucleusApi.configure do |config|
|
|
278
|
+
# Use one of the below method to generate oauth token
|
|
279
|
+
# Creating a token for grant_type=client_credentials
|
|
280
|
+
config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
|
|
281
|
+
# Creating a token for grant_type=password
|
|
282
|
+
config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
|
|
283
|
+
# Creating a token using client token
|
|
284
|
+
config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
|
|
285
|
+
end
|
|
286
|
+
|
|
287
|
+
api_instance = NucleusApi::AggregationAccountApi.new
|
|
288
|
+
|
|
289
|
+
aggregation_account_holding = NucleusApi::AggregationAccountHolding.new # AggregationAccountHolding | aggregationAccountHolding
|
|
290
|
+
|
|
291
|
+
|
|
292
|
+
begin
|
|
293
|
+
#Create an aggregation account holding
|
|
294
|
+
result = api_instance.create_aggregation_account_holding_using_post(aggregation_account_holding)
|
|
295
|
+
p result
|
|
296
|
+
rescue NucleusApi::ApiError => e
|
|
297
|
+
puts "Exception when calling AggregationAccountApi->create_aggregation_account_holding_using_post: #{e}"
|
|
298
|
+
end
|
|
299
|
+
```
|
|
300
|
+
|
|
301
|
+
### Parameters
|
|
302
|
+
|
|
303
|
+
Name | Type | Description | Notes
|
|
304
|
+
------------- | ------------- | ------------- | -------------
|
|
305
|
+
**aggregation_account_holding** | [**AggregationAccountHolding**](AggregationAccountHolding.md)| aggregationAccountHolding |
|
|
306
|
+
|
|
307
|
+
### Return type
|
|
308
|
+
|
|
309
|
+
[**AggregationAccountHolding**](AggregationAccountHolding.md)
|
|
310
|
+
|
|
311
|
+
### Authorization
|
|
312
|
+
|
|
313
|
+
[oauth2](../README.md#oauth2)
|
|
314
|
+
|
|
315
|
+
### HTTP request headers
|
|
316
|
+
|
|
317
|
+
- **Content-Type**: application/json
|
|
318
|
+
- **Accept**: */*
|
|
319
|
+
|
|
320
|
+
|
|
321
|
+
|
|
322
|
+
# **create_aggregation_account_transaction_bulk_using_post**
|
|
323
|
+
> Array<AggregationAccountTransaction> create_aggregation_account_transaction_bulk_using_post(aggregation_account_transactions)
|
|
324
|
+
|
|
325
|
+
Create a bulk aggregation account transaction
|
|
326
|
+
|
|
327
|
+
Create a bulk transaction record under an aggregation account.
|
|
328
|
+
|
|
329
|
+
### Example
|
|
330
|
+
```ruby
|
|
331
|
+
# load the gem
|
|
332
|
+
require 'nucleus_api'
|
|
333
|
+
# Setup authorization
|
|
334
|
+
NucleusApi.configure do |config|
|
|
335
|
+
# Use one of the below method to generate oauth token
|
|
336
|
+
# Creating a token for grant_type=client_credentials
|
|
337
|
+
config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
|
|
338
|
+
# Creating a token for grant_type=password
|
|
339
|
+
config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
|
|
340
|
+
# Creating a token using client token
|
|
341
|
+
config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
|
|
342
|
+
end
|
|
343
|
+
|
|
344
|
+
api_instance = NucleusApi::AggregationAccountApi.new
|
|
345
|
+
|
|
346
|
+
aggregation_account_transactions = [NucleusApi::AggregationAccountTransaction.new] # Array<AggregationAccountTransaction> | aggregationAccountTransactions
|
|
347
|
+
|
|
348
|
+
|
|
349
|
+
begin
|
|
350
|
+
#Create a bulk aggregation account transaction
|
|
351
|
+
result = api_instance.create_aggregation_account_transaction_bulk_using_post(aggregation_account_transactions)
|
|
352
|
+
p result
|
|
353
|
+
rescue NucleusApi::ApiError => e
|
|
354
|
+
puts "Exception when calling AggregationAccountApi->create_aggregation_account_transaction_bulk_using_post: #{e}"
|
|
355
|
+
end
|
|
356
|
+
```
|
|
357
|
+
|
|
358
|
+
### Parameters
|
|
359
|
+
|
|
360
|
+
Name | Type | Description | Notes
|
|
361
|
+
------------- | ------------- | ------------- | -------------
|
|
362
|
+
**aggregation_account_transactions** | [**Array<AggregationAccountTransaction>**](AggregationAccountTransaction.md)| aggregationAccountTransactions |
|
|
363
|
+
|
|
364
|
+
### Return type
|
|
365
|
+
|
|
366
|
+
[**Array<AggregationAccountTransaction>**](AggregationAccountTransaction.md)
|
|
367
|
+
|
|
368
|
+
### Authorization
|
|
369
|
+
|
|
370
|
+
[oauth2](../README.md#oauth2)
|
|
371
|
+
|
|
372
|
+
### HTTP request headers
|
|
373
|
+
|
|
374
|
+
- **Content-Type**: application/json
|
|
375
|
+
- **Accept**: */*
|
|
376
|
+
|
|
377
|
+
|
|
378
|
+
|
|
379
|
+
# **create_aggregation_account_transaction_using_post**
|
|
380
|
+
> AggregationAccountTransaction create_aggregation_account_transaction_using_post(aggregation_account_transaction)
|
|
381
|
+
|
|
382
|
+
Create an aggregation account transaction
|
|
383
|
+
|
|
384
|
+
Create a transaction record under an aggregation account.
|
|
385
|
+
|
|
386
|
+
### Example
|
|
387
|
+
```ruby
|
|
388
|
+
# load the gem
|
|
389
|
+
require 'nucleus_api'
|
|
390
|
+
# Setup authorization
|
|
391
|
+
NucleusApi.configure do |config|
|
|
392
|
+
# Use one of the below method to generate oauth token
|
|
393
|
+
# Creating a token for grant_type=client_credentials
|
|
394
|
+
config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
|
|
395
|
+
# Creating a token for grant_type=password
|
|
396
|
+
config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
|
|
397
|
+
# Creating a token using client token
|
|
398
|
+
config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
|
|
399
|
+
end
|
|
400
|
+
|
|
401
|
+
api_instance = NucleusApi::AggregationAccountApi.new
|
|
402
|
+
|
|
403
|
+
aggregation_account_transaction = NucleusApi::AggregationAccountTransaction.new # AggregationAccountTransaction | aggregationAccountTransaction
|
|
404
|
+
|
|
405
|
+
|
|
406
|
+
begin
|
|
407
|
+
#Create an aggregation account transaction
|
|
408
|
+
result = api_instance.create_aggregation_account_transaction_using_post(aggregation_account_transaction)
|
|
409
|
+
p result
|
|
410
|
+
rescue NucleusApi::ApiError => e
|
|
411
|
+
puts "Exception when calling AggregationAccountApi->create_aggregation_account_transaction_using_post: #{e}"
|
|
412
|
+
end
|
|
413
|
+
```
|
|
414
|
+
|
|
415
|
+
### Parameters
|
|
416
|
+
|
|
417
|
+
Name | Type | Description | Notes
|
|
418
|
+
------------- | ------------- | ------------- | -------------
|
|
419
|
+
**aggregation_account_transaction** | [**AggregationAccountTransaction**](AggregationAccountTransaction.md)| aggregationAccountTransaction |
|
|
420
|
+
|
|
421
|
+
### Return type
|
|
422
|
+
|
|
423
|
+
[**AggregationAccountTransaction**](AggregationAccountTransaction.md)
|
|
424
|
+
|
|
425
|
+
### Authorization
|
|
426
|
+
|
|
427
|
+
[oauth2](../README.md#oauth2)
|
|
428
|
+
|
|
429
|
+
### HTTP request headers
|
|
430
|
+
|
|
431
|
+
- **Content-Type**: application/json
|
|
432
|
+
- **Accept**: */*
|
|
433
|
+
|
|
434
|
+
|
|
435
|
+
|
|
436
|
+
# **create_aggregation_account_using_post**
|
|
437
|
+
> AggregationAccount create_aggregation_account_using_post(aggregation_account)
|
|
438
|
+
|
|
439
|
+
Create an aggregation account
|
|
440
|
+
|
|
441
|
+
Create an aggregation account under a client.
|
|
442
|
+
|
|
443
|
+
### Example
|
|
444
|
+
```ruby
|
|
445
|
+
# load the gem
|
|
446
|
+
require 'nucleus_api'
|
|
447
|
+
# Setup authorization
|
|
448
|
+
NucleusApi.configure do |config|
|
|
449
|
+
# Use one of the below method to generate oauth token
|
|
450
|
+
# Creating a token for grant_type=client_credentials
|
|
451
|
+
config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
|
|
452
|
+
# Creating a token for grant_type=password
|
|
453
|
+
config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
|
|
454
|
+
# Creating a token using client token
|
|
455
|
+
config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
|
|
456
|
+
end
|
|
457
|
+
|
|
458
|
+
api_instance = NucleusApi::AggregationAccountApi.new
|
|
459
|
+
|
|
460
|
+
aggregation_account = NucleusApi::AggregationAccount.new # AggregationAccount | aggregationAccount
|
|
461
|
+
|
|
462
|
+
|
|
463
|
+
begin
|
|
464
|
+
#Create an aggregation account
|
|
465
|
+
result = api_instance.create_aggregation_account_using_post(aggregation_account)
|
|
466
|
+
p result
|
|
467
|
+
rescue NucleusApi::ApiError => e
|
|
468
|
+
puts "Exception when calling AggregationAccountApi->create_aggregation_account_using_post: #{e}"
|
|
469
|
+
end
|
|
470
|
+
```
|
|
471
|
+
|
|
472
|
+
### Parameters
|
|
473
|
+
|
|
474
|
+
Name | Type | Description | Notes
|
|
475
|
+
------------- | ------------- | ------------- | -------------
|
|
476
|
+
**aggregation_account** | [**AggregationAccount**](AggregationAccount.md)| aggregationAccount |
|
|
477
|
+
|
|
478
|
+
### Return type
|
|
479
|
+
|
|
480
|
+
[**AggregationAccount**](AggregationAccount.md)
|
|
481
|
+
|
|
482
|
+
### Authorization
|
|
483
|
+
|
|
484
|
+
[oauth2](../README.md#oauth2)
|
|
485
|
+
|
|
486
|
+
### HTTP request headers
|
|
487
|
+
|
|
488
|
+
- **Content-Type**: application/json
|
|
489
|
+
- **Accept**: */*
|
|
490
|
+
|
|
491
|
+
|
|
492
|
+
|
|
493
|
+
# **delete_aggregation_account_balance_using_delete**
|
|
494
|
+
> delete_aggregation_account_balance_using_delete(aggregation_account_balance_id)
|
|
495
|
+
|
|
496
|
+
Delete an aggregation account balance
|
|
497
|
+
|
|
498
|
+
Permanently delete a balance record for an aggregation account.
|
|
499
|
+
|
|
500
|
+
### Example
|
|
501
|
+
```ruby
|
|
502
|
+
# load the gem
|
|
503
|
+
require 'nucleus_api'
|
|
504
|
+
# Setup authorization
|
|
505
|
+
NucleusApi.configure do |config|
|
|
506
|
+
# Use one of the below method to generate oauth token
|
|
507
|
+
# Creating a token for grant_type=client_credentials
|
|
508
|
+
config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
|
|
509
|
+
# Creating a token for grant_type=password
|
|
510
|
+
config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
|
|
511
|
+
# Creating a token using client token
|
|
512
|
+
config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
|
|
513
|
+
end
|
|
514
|
+
|
|
515
|
+
api_instance = NucleusApi::AggregationAccountApi.new
|
|
516
|
+
|
|
517
|
+
aggregation_account_balance_id = 'aggregation_account_balance_id_example' # String | UUID aggregation_account_balance_id
|
|
518
|
+
|
|
519
|
+
|
|
520
|
+
begin
|
|
521
|
+
#Delete an aggregation account balance
|
|
522
|
+
api_instance.delete_aggregation_account_balance_using_delete(aggregation_account_balance_id)
|
|
523
|
+
rescue NucleusApi::ApiError => e
|
|
524
|
+
puts "Exception when calling AggregationAccountApi->delete_aggregation_account_balance_using_delete: #{e}"
|
|
525
|
+
end
|
|
526
|
+
```
|
|
527
|
+
|
|
528
|
+
### Parameters
|
|
529
|
+
|
|
530
|
+
Name | Type | Description | Notes
|
|
531
|
+
------------- | ------------- | ------------- | -------------
|
|
532
|
+
**aggregation_account_balance_id** | [**String**](.md)| UUID aggregation_account_balance_id |
|
|
533
|
+
|
|
534
|
+
### Return type
|
|
535
|
+
|
|
536
|
+
nil (empty response body)
|
|
537
|
+
|
|
538
|
+
### Authorization
|
|
539
|
+
|
|
540
|
+
[oauth2](../README.md#oauth2)
|
|
541
|
+
|
|
542
|
+
### HTTP request headers
|
|
543
|
+
|
|
544
|
+
- **Content-Type**: Not defined
|
|
545
|
+
- **Accept**: */*
|
|
546
|
+
|
|
547
|
+
|
|
548
|
+
|
|
549
|
+
# **delete_aggregation_account_holding_using_delete**
|
|
550
|
+
> delete_aggregation_account_holding_using_delete(aggregation_account_holding_id)
|
|
551
|
+
|
|
552
|
+
Delete an aggregation account holding
|
|
553
|
+
|
|
554
|
+
Permanently delete a holding record for an aggregation account.
|
|
555
|
+
|
|
556
|
+
### Example
|
|
557
|
+
```ruby
|
|
558
|
+
# load the gem
|
|
559
|
+
require 'nucleus_api'
|
|
560
|
+
# Setup authorization
|
|
561
|
+
NucleusApi.configure do |config|
|
|
562
|
+
# Use one of the below method to generate oauth token
|
|
563
|
+
# Creating a token for grant_type=client_credentials
|
|
564
|
+
config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
|
|
565
|
+
# Creating a token for grant_type=password
|
|
566
|
+
config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
|
|
567
|
+
# Creating a token using client token
|
|
568
|
+
config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
|
|
569
|
+
end
|
|
570
|
+
|
|
571
|
+
api_instance = NucleusApi::AggregationAccountApi.new
|
|
572
|
+
|
|
573
|
+
aggregation_account_holding_id = 'aggregation_account_holding_id_example' # String | UUID aggregation_account_holding_id
|
|
574
|
+
|
|
575
|
+
|
|
576
|
+
begin
|
|
577
|
+
#Delete an aggregation account holding
|
|
578
|
+
api_instance.delete_aggregation_account_holding_using_delete(aggregation_account_holding_id)
|
|
579
|
+
rescue NucleusApi::ApiError => e
|
|
580
|
+
puts "Exception when calling AggregationAccountApi->delete_aggregation_account_holding_using_delete: #{e}"
|
|
581
|
+
end
|
|
582
|
+
```
|
|
583
|
+
|
|
584
|
+
### Parameters
|
|
585
|
+
|
|
586
|
+
Name | Type | Description | Notes
|
|
587
|
+
------------- | ------------- | ------------- | -------------
|
|
588
|
+
**aggregation_account_holding_id** | [**String**](.md)| UUID aggregation_account_holding_id |
|
|
589
|
+
|
|
590
|
+
### Return type
|
|
591
|
+
|
|
592
|
+
nil (empty response body)
|
|
593
|
+
|
|
594
|
+
### Authorization
|
|
595
|
+
|
|
596
|
+
[oauth2](../README.md#oauth2)
|
|
597
|
+
|
|
598
|
+
### HTTP request headers
|
|
599
|
+
|
|
600
|
+
- **Content-Type**: Not defined
|
|
601
|
+
- **Accept**: */*
|
|
602
|
+
|
|
603
|
+
|
|
604
|
+
|
|
605
|
+
# **delete_aggregation_account_transaction_using_delete**
|
|
606
|
+
> delete_aggregation_account_transaction_using_delete(aggregation_account_transaction_id)
|
|
607
|
+
|
|
608
|
+
Delete an aggregation account transaction
|
|
609
|
+
|
|
610
|
+
Permanently delete a transaction record for an aggregation account.
|
|
611
|
+
|
|
612
|
+
### Example
|
|
613
|
+
```ruby
|
|
614
|
+
# load the gem
|
|
615
|
+
require 'nucleus_api'
|
|
616
|
+
# Setup authorization
|
|
617
|
+
NucleusApi.configure do |config|
|
|
618
|
+
# Use one of the below method to generate oauth token
|
|
619
|
+
# Creating a token for grant_type=client_credentials
|
|
620
|
+
config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
|
|
621
|
+
# Creating a token for grant_type=password
|
|
622
|
+
config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
|
|
623
|
+
# Creating a token using client token
|
|
624
|
+
config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
|
|
625
|
+
end
|
|
626
|
+
|
|
627
|
+
api_instance = NucleusApi::AggregationAccountApi.new
|
|
628
|
+
|
|
629
|
+
aggregation_account_transaction_id = 'aggregation_account_transaction_id_example' # String | UUID aggregation_account_transaction_id
|
|
630
|
+
|
|
631
|
+
|
|
632
|
+
begin
|
|
633
|
+
#Delete an aggregation account transaction
|
|
634
|
+
api_instance.delete_aggregation_account_transaction_using_delete(aggregation_account_transaction_id)
|
|
635
|
+
rescue NucleusApi::ApiError => e
|
|
636
|
+
puts "Exception when calling AggregationAccountApi->delete_aggregation_account_transaction_using_delete: #{e}"
|
|
637
|
+
end
|
|
638
|
+
```
|
|
639
|
+
|
|
640
|
+
### Parameters
|
|
641
|
+
|
|
642
|
+
Name | Type | Description | Notes
|
|
643
|
+
------------- | ------------- | ------------- | -------------
|
|
644
|
+
**aggregation_account_transaction_id** | [**String**](.md)| UUID aggregation_account_transaction_id |
|
|
645
|
+
|
|
646
|
+
### Return type
|
|
647
|
+
|
|
648
|
+
nil (empty response body)
|
|
649
|
+
|
|
650
|
+
### Authorization
|
|
651
|
+
|
|
652
|
+
[oauth2](../README.md#oauth2)
|
|
653
|
+
|
|
654
|
+
### HTTP request headers
|
|
655
|
+
|
|
656
|
+
- **Content-Type**: Not defined
|
|
657
|
+
- **Accept**: */*
|
|
658
|
+
|
|
659
|
+
|
|
660
|
+
|
|
661
|
+
# **delete_aggregation_account_using_delete**
|
|
662
|
+
> delete_aggregation_account_using_delete(aggregation_account_id)
|
|
663
|
+
|
|
664
|
+
Delete an aggregation account
|
|
665
|
+
|
|
666
|
+
Permanently delete an aggregation account under a client.
|
|
667
|
+
|
|
668
|
+
### Example
|
|
669
|
+
```ruby
|
|
670
|
+
# load the gem
|
|
671
|
+
require 'nucleus_api'
|
|
672
|
+
# Setup authorization
|
|
673
|
+
NucleusApi.configure do |config|
|
|
674
|
+
# Use one of the below method to generate oauth token
|
|
675
|
+
# Creating a token for grant_type=client_credentials
|
|
676
|
+
config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
|
|
677
|
+
# Creating a token for grant_type=password
|
|
678
|
+
config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
|
|
679
|
+
# Creating a token using client token
|
|
680
|
+
config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
|
|
681
|
+
end
|
|
682
|
+
|
|
683
|
+
api_instance = NucleusApi::AggregationAccountApi.new
|
|
684
|
+
|
|
685
|
+
aggregation_account_id = 'aggregation_account_id_example' # String | UUID aggregation_account_id
|
|
686
|
+
|
|
687
|
+
|
|
688
|
+
begin
|
|
689
|
+
#Delete an aggregation account
|
|
690
|
+
api_instance.delete_aggregation_account_using_delete(aggregation_account_id)
|
|
691
|
+
rescue NucleusApi::ApiError => e
|
|
692
|
+
puts "Exception when calling AggregationAccountApi->delete_aggregation_account_using_delete: #{e}"
|
|
693
|
+
end
|
|
694
|
+
```
|
|
695
|
+
|
|
696
|
+
### Parameters
|
|
697
|
+
|
|
698
|
+
Name | Type | Description | Notes
|
|
699
|
+
------------- | ------------- | ------------- | -------------
|
|
700
|
+
**aggregation_account_id** | [**String**](.md)| UUID aggregation_account_id |
|
|
701
|
+
|
|
702
|
+
### Return type
|
|
703
|
+
|
|
704
|
+
nil (empty response body)
|
|
705
|
+
|
|
706
|
+
### Authorization
|
|
707
|
+
|
|
708
|
+
[oauth2](../README.md#oauth2)
|
|
709
|
+
|
|
710
|
+
### HTTP request headers
|
|
711
|
+
|
|
712
|
+
- **Content-Type**: Not defined
|
|
713
|
+
- **Accept**: */*
|
|
714
|
+
|
|
715
|
+
|
|
716
|
+
|
|
717
|
+
# **get_aggregation_account_aggregate_data_using_get**
|
|
718
|
+
> Object get_aggregation_account_aggregate_data_using_get(aggregation_account_id, opts)
|
|
719
|
+
|
|
720
|
+
Retrieve an aggregation account aggregate data
|
|
721
|
+
|
|
722
|
+
Retrieve the information for a specific aggregation account associated with a client.
|
|
723
|
+
|
|
724
|
+
### Example
|
|
725
|
+
```ruby
|
|
726
|
+
# load the gem
|
|
727
|
+
require 'nucleus_api'
|
|
728
|
+
# Setup authorization
|
|
729
|
+
NucleusApi.configure do |config|
|
|
730
|
+
# Use one of the below method to generate oauth token
|
|
731
|
+
# Creating a token for grant_type=client_credentials
|
|
732
|
+
config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
|
|
733
|
+
# Creating a token for grant_type=password
|
|
734
|
+
config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
|
|
735
|
+
# Creating a token using client token
|
|
736
|
+
config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
|
|
737
|
+
end
|
|
738
|
+
|
|
739
|
+
api_instance = NucleusApi::AggregationAccountApi.new
|
|
740
|
+
|
|
741
|
+
aggregation_account_id = 'aggregation_account_id_example' # String | UUID aggregation_account_id
|
|
742
|
+
|
|
743
|
+
opts = {
|
|
744
|
+
currency_conversion: 'currency_conversion_example' # String | USD
|
|
745
|
+
}
|
|
746
|
+
|
|
747
|
+
begin
|
|
748
|
+
#Retrieve an aggregation account aggregate data
|
|
749
|
+
result = api_instance.get_aggregation_account_aggregate_data_using_get(aggregation_account_id, opts)
|
|
750
|
+
p result
|
|
751
|
+
rescue NucleusApi::ApiError => e
|
|
752
|
+
puts "Exception when calling AggregationAccountApi->get_aggregation_account_aggregate_data_using_get: #{e}"
|
|
753
|
+
end
|
|
754
|
+
```
|
|
755
|
+
|
|
756
|
+
### Parameters
|
|
757
|
+
|
|
758
|
+
Name | Type | Description | Notes
|
|
759
|
+
------------- | ------------- | ------------- | -------------
|
|
760
|
+
**aggregation_account_id** | [**String**](.md)| UUID aggregation_account_id |
|
|
761
|
+
**currency_conversion** | **String**| USD | [optional]
|
|
762
|
+
|
|
763
|
+
### Return type
|
|
764
|
+
|
|
765
|
+
**Object**
|
|
766
|
+
|
|
767
|
+
### Authorization
|
|
768
|
+
|
|
769
|
+
[oauth2](../README.md#oauth2)
|
|
770
|
+
|
|
771
|
+
### HTTP request headers
|
|
772
|
+
|
|
773
|
+
- **Content-Type**: Not defined
|
|
774
|
+
- **Accept**: */*
|
|
775
|
+
|
|
776
|
+
|
|
777
|
+
|
|
778
|
+
# **get_aggregation_account_all_using_get**
|
|
779
|
+
> PageAggregationAccount get_aggregation_account_all_using_get(opts)
|
|
780
|
+
|
|
781
|
+
List all aggregation accounts
|
|
782
|
+
|
|
783
|
+
Get information for all aggregation accounts for all clients defined for your firm.
|
|
784
|
+
|
|
785
|
+
### Example
|
|
786
|
+
```ruby
|
|
787
|
+
# load the gem
|
|
788
|
+
require 'nucleus_api'
|
|
789
|
+
# Setup authorization
|
|
790
|
+
NucleusApi.configure do |config|
|
|
791
|
+
# Use one of the below method to generate oauth token
|
|
792
|
+
# Creating a token for grant_type=client_credentials
|
|
793
|
+
config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
|
|
794
|
+
# Creating a token for grant_type=password
|
|
795
|
+
config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
|
|
796
|
+
# Creating a token using client token
|
|
797
|
+
config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
|
|
798
|
+
end
|
|
799
|
+
|
|
800
|
+
api_instance = NucleusApi::AggregationAccountApi.new
|
|
801
|
+
|
|
802
|
+
opts = {
|
|
803
|
+
ascending: false, # BOOLEAN | ascending
|
|
804
|
+
filter: 'filter_example', # String | filter
|
|
805
|
+
order_by: 'update_date', # String | order_by
|
|
806
|
+
page: 0, # Integer | page
|
|
807
|
+
size: 25 # Integer | size
|
|
808
|
+
}
|
|
809
|
+
|
|
810
|
+
begin
|
|
811
|
+
#List all aggregation accounts
|
|
812
|
+
result = api_instance.get_aggregation_account_all_using_get(opts)
|
|
813
|
+
p result
|
|
814
|
+
rescue NucleusApi::ApiError => e
|
|
815
|
+
puts "Exception when calling AggregationAccountApi->get_aggregation_account_all_using_get: #{e}"
|
|
816
|
+
end
|
|
817
|
+
```
|
|
818
|
+
|
|
819
|
+
### Parameters
|
|
820
|
+
|
|
821
|
+
Name | Type | Description | Notes
|
|
822
|
+
------------- | ------------- | ------------- | -------------
|
|
823
|
+
**ascending** | **BOOLEAN**| ascending | [optional] [default to false]
|
|
824
|
+
**filter** | **String**| filter | [optional]
|
|
825
|
+
**order_by** | **String**| order_by | [optional] [default to update_date]
|
|
826
|
+
**page** | **Integer**| page | [optional] [default to 0]
|
|
827
|
+
**size** | **Integer**| size | [optional] [default to 25]
|
|
828
|
+
|
|
829
|
+
### Return type
|
|
830
|
+
|
|
831
|
+
[**PageAggregationAccount**](PageAggregationAccount.md)
|
|
832
|
+
|
|
833
|
+
### Authorization
|
|
834
|
+
|
|
835
|
+
[oauth2](../README.md#oauth2)
|
|
836
|
+
|
|
837
|
+
### HTTP request headers
|
|
838
|
+
|
|
839
|
+
- **Content-Type**: Not defined
|
|
840
|
+
- **Accept**: */*
|
|
841
|
+
|
|
842
|
+
|
|
843
|
+
|
|
844
|
+
# **get_aggregation_account_balance_all_using_get**
|
|
845
|
+
> PageAggregationAccountBalance get_aggregation_account_balance_all_using_get(opts)
|
|
846
|
+
|
|
847
|
+
List all aggregation account balances
|
|
848
|
+
|
|
849
|
+
Get all of the balance records for all aggregation accounts defined for your firm.
|
|
850
|
+
|
|
851
|
+
### Example
|
|
852
|
+
```ruby
|
|
853
|
+
# load the gem
|
|
854
|
+
require 'nucleus_api'
|
|
855
|
+
# Setup authorization
|
|
856
|
+
NucleusApi.configure do |config|
|
|
857
|
+
# Use one of the below method to generate oauth token
|
|
858
|
+
# Creating a token for grant_type=client_credentials
|
|
859
|
+
config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
|
|
860
|
+
# Creating a token for grant_type=password
|
|
861
|
+
config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
|
|
862
|
+
# Creating a token using client token
|
|
863
|
+
config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
|
|
864
|
+
end
|
|
865
|
+
|
|
866
|
+
api_instance = NucleusApi::AggregationAccountApi.new
|
|
867
|
+
|
|
868
|
+
opts = {
|
|
869
|
+
ascending: false, # BOOLEAN | ascending
|
|
870
|
+
currency_conversion: 'currency_conversion_example', # String | currency_conversion
|
|
871
|
+
filter: 'filter_example', # String | filter
|
|
872
|
+
order_by: 'update_date', # String | order_by
|
|
873
|
+
page: 0, # Integer | page
|
|
874
|
+
size: 25 # Integer | size
|
|
875
|
+
}
|
|
876
|
+
|
|
877
|
+
begin
|
|
878
|
+
#List all aggregation account balances
|
|
879
|
+
result = api_instance.get_aggregation_account_balance_all_using_get(opts)
|
|
880
|
+
p result
|
|
881
|
+
rescue NucleusApi::ApiError => e
|
|
882
|
+
puts "Exception when calling AggregationAccountApi->get_aggregation_account_balance_all_using_get: #{e}"
|
|
883
|
+
end
|
|
884
|
+
```
|
|
885
|
+
|
|
886
|
+
### Parameters
|
|
887
|
+
|
|
888
|
+
Name | Type | Description | Notes
|
|
889
|
+
------------- | ------------- | ------------- | -------------
|
|
890
|
+
**ascending** | **BOOLEAN**| ascending | [optional] [default to false]
|
|
891
|
+
**currency_conversion** | **String**| currency_conversion | [optional]
|
|
892
|
+
**filter** | **String**| filter | [optional]
|
|
893
|
+
**order_by** | **String**| order_by | [optional] [default to update_date]
|
|
894
|
+
**page** | **Integer**| page | [optional] [default to 0]
|
|
895
|
+
**size** | **Integer**| size | [optional] [default to 25]
|
|
896
|
+
|
|
897
|
+
### Return type
|
|
898
|
+
|
|
899
|
+
[**PageAggregationAccountBalance**](PageAggregationAccountBalance.md)
|
|
900
|
+
|
|
901
|
+
### Authorization
|
|
902
|
+
|
|
903
|
+
[oauth2](../README.md#oauth2)
|
|
904
|
+
|
|
905
|
+
### HTTP request headers
|
|
906
|
+
|
|
907
|
+
- **Content-Type**: Not defined
|
|
908
|
+
- **Accept**: */*
|
|
909
|
+
|
|
910
|
+
|
|
911
|
+
|
|
912
|
+
# **get_aggregation_account_balance_using_get**
|
|
913
|
+
> AggregationAccountBalance get_aggregation_account_balance_using_get(aggregation_account_balance_id, opts)
|
|
914
|
+
|
|
915
|
+
Retrieve an aggregation account balance
|
|
916
|
+
|
|
917
|
+
Retrieve the information for a specific balance record for an aggregation account.
|
|
918
|
+
|
|
919
|
+
### Example
|
|
920
|
+
```ruby
|
|
921
|
+
# load the gem
|
|
922
|
+
require 'nucleus_api'
|
|
923
|
+
# Setup authorization
|
|
924
|
+
NucleusApi.configure do |config|
|
|
925
|
+
# Use one of the below method to generate oauth token
|
|
926
|
+
# Creating a token for grant_type=client_credentials
|
|
927
|
+
config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
|
|
928
|
+
# Creating a token for grant_type=password
|
|
929
|
+
config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
|
|
930
|
+
# Creating a token using client token
|
|
931
|
+
config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
|
|
932
|
+
end
|
|
933
|
+
|
|
934
|
+
api_instance = NucleusApi::AggregationAccountApi.new
|
|
935
|
+
|
|
936
|
+
aggregation_account_balance_id = 'aggregation_account_balance_id_example' # String | UUID aggregation_account_balance_id
|
|
937
|
+
|
|
938
|
+
opts = {
|
|
939
|
+
currency_conversion: 'currency_conversion_example' # String | USD
|
|
940
|
+
}
|
|
941
|
+
|
|
942
|
+
begin
|
|
943
|
+
#Retrieve an aggregation account balance
|
|
944
|
+
result = api_instance.get_aggregation_account_balance_using_get(aggregation_account_balance_id, opts)
|
|
945
|
+
p result
|
|
946
|
+
rescue NucleusApi::ApiError => e
|
|
947
|
+
puts "Exception when calling AggregationAccountApi->get_aggregation_account_balance_using_get: #{e}"
|
|
948
|
+
end
|
|
949
|
+
```
|
|
950
|
+
|
|
951
|
+
### Parameters
|
|
952
|
+
|
|
953
|
+
Name | Type | Description | Notes
|
|
954
|
+
------------- | ------------- | ------------- | -------------
|
|
955
|
+
**aggregation_account_balance_id** | [**String**](.md)| UUID aggregation_account_balance_id |
|
|
956
|
+
**currency_conversion** | **String**| USD | [optional]
|
|
957
|
+
|
|
958
|
+
### Return type
|
|
959
|
+
|
|
960
|
+
[**AggregationAccountBalance**](AggregationAccountBalance.md)
|
|
961
|
+
|
|
962
|
+
### Authorization
|
|
963
|
+
|
|
964
|
+
[oauth2](../README.md#oauth2)
|
|
965
|
+
|
|
966
|
+
### HTTP request headers
|
|
967
|
+
|
|
968
|
+
- **Content-Type**: Not defined
|
|
969
|
+
- **Accept**: */*
|
|
970
|
+
|
|
971
|
+
|
|
972
|
+
|
|
973
|
+
# **get_aggregation_account_holding_all_using_get**
|
|
974
|
+
> PageAggregationAccountHolding get_aggregation_account_holding_all_using_get(opts)
|
|
975
|
+
|
|
976
|
+
List all aggregation account holdings
|
|
977
|
+
|
|
978
|
+
Get all of the holding records for all aggregation accounts defined for your firm.
|
|
979
|
+
|
|
980
|
+
### Example
|
|
981
|
+
```ruby
|
|
982
|
+
# load the gem
|
|
983
|
+
require 'nucleus_api'
|
|
984
|
+
# Setup authorization
|
|
985
|
+
NucleusApi.configure do |config|
|
|
986
|
+
# Use one of the below method to generate oauth token
|
|
987
|
+
# Creating a token for grant_type=client_credentials
|
|
988
|
+
config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
|
|
989
|
+
# Creating a token for grant_type=password
|
|
990
|
+
config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
|
|
991
|
+
# Creating a token using client token
|
|
992
|
+
config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
|
|
993
|
+
end
|
|
994
|
+
|
|
995
|
+
api_instance = NucleusApi::AggregationAccountApi.new
|
|
996
|
+
|
|
997
|
+
opts = {
|
|
998
|
+
ascending: false, # BOOLEAN | ascending
|
|
999
|
+
currency_conversion: 'currency_conversion_example', # String | currency_conversion
|
|
1000
|
+
filter: 'filter_example', # String | filter
|
|
1001
|
+
order_by: 'update_date', # String | order_by
|
|
1002
|
+
page: 0, # Integer | page
|
|
1003
|
+
size: 25 # Integer | size
|
|
1004
|
+
}
|
|
1005
|
+
|
|
1006
|
+
begin
|
|
1007
|
+
#List all aggregation account holdings
|
|
1008
|
+
result = api_instance.get_aggregation_account_holding_all_using_get(opts)
|
|
1009
|
+
p result
|
|
1010
|
+
rescue NucleusApi::ApiError => e
|
|
1011
|
+
puts "Exception when calling AggregationAccountApi->get_aggregation_account_holding_all_using_get: #{e}"
|
|
1012
|
+
end
|
|
1013
|
+
```
|
|
1014
|
+
|
|
1015
|
+
### Parameters
|
|
1016
|
+
|
|
1017
|
+
Name | Type | Description | Notes
|
|
1018
|
+
------------- | ------------- | ------------- | -------------
|
|
1019
|
+
**ascending** | **BOOLEAN**| ascending | [optional] [default to false]
|
|
1020
|
+
**currency_conversion** | **String**| currency_conversion | [optional]
|
|
1021
|
+
**filter** | **String**| filter | [optional]
|
|
1022
|
+
**order_by** | **String**| order_by | [optional] [default to update_date]
|
|
1023
|
+
**page** | **Integer**| page | [optional] [default to 0]
|
|
1024
|
+
**size** | **Integer**| size | [optional] [default to 25]
|
|
1025
|
+
|
|
1026
|
+
### Return type
|
|
1027
|
+
|
|
1028
|
+
[**PageAggregationAccountHolding**](PageAggregationAccountHolding.md)
|
|
1029
|
+
|
|
1030
|
+
### Authorization
|
|
1031
|
+
|
|
1032
|
+
[oauth2](../README.md#oauth2)
|
|
1033
|
+
|
|
1034
|
+
### HTTP request headers
|
|
1035
|
+
|
|
1036
|
+
- **Content-Type**: Not defined
|
|
1037
|
+
- **Accept**: */*
|
|
1038
|
+
|
|
1039
|
+
|
|
1040
|
+
|
|
1041
|
+
# **get_aggregation_account_holding_using_get**
|
|
1042
|
+
> AggregationAccountHolding get_aggregation_account_holding_using_get(aggregation_account_holding_id, opts)
|
|
1043
|
+
|
|
1044
|
+
Retrieve an aggregation account holding
|
|
1045
|
+
|
|
1046
|
+
Retrieve the information for a specific holding record for an aggregation account.
|
|
1047
|
+
|
|
1048
|
+
### Example
|
|
1049
|
+
```ruby
|
|
1050
|
+
# load the gem
|
|
1051
|
+
require 'nucleus_api'
|
|
1052
|
+
# Setup authorization
|
|
1053
|
+
NucleusApi.configure do |config|
|
|
1054
|
+
# Use one of the below method to generate oauth token
|
|
1055
|
+
# Creating a token for grant_type=client_credentials
|
|
1056
|
+
config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
|
|
1057
|
+
# Creating a token for grant_type=password
|
|
1058
|
+
config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
|
|
1059
|
+
# Creating a token using client token
|
|
1060
|
+
config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
|
|
1061
|
+
end
|
|
1062
|
+
|
|
1063
|
+
api_instance = NucleusApi::AggregationAccountApi.new
|
|
1064
|
+
|
|
1065
|
+
aggregation_account_holding_id = 'aggregation_account_holding_id_example' # String | UUID aggregation_account_holding_id
|
|
1066
|
+
|
|
1067
|
+
opts = {
|
|
1068
|
+
currency_conversion: 'currency_conversion_example' # String | USD
|
|
1069
|
+
}
|
|
1070
|
+
|
|
1071
|
+
begin
|
|
1072
|
+
#Retrieve an aggregation account holding
|
|
1073
|
+
result = api_instance.get_aggregation_account_holding_using_get(aggregation_account_holding_id, opts)
|
|
1074
|
+
p result
|
|
1075
|
+
rescue NucleusApi::ApiError => e
|
|
1076
|
+
puts "Exception when calling AggregationAccountApi->get_aggregation_account_holding_using_get: #{e}"
|
|
1077
|
+
end
|
|
1078
|
+
```
|
|
1079
|
+
|
|
1080
|
+
### Parameters
|
|
1081
|
+
|
|
1082
|
+
Name | Type | Description | Notes
|
|
1083
|
+
------------- | ------------- | ------------- | -------------
|
|
1084
|
+
**aggregation_account_holding_id** | [**String**](.md)| UUID aggregation_account_holding_id |
|
|
1085
|
+
**currency_conversion** | **String**| USD | [optional]
|
|
1086
|
+
|
|
1087
|
+
### Return type
|
|
1088
|
+
|
|
1089
|
+
[**AggregationAccountHolding**](AggregationAccountHolding.md)
|
|
1090
|
+
|
|
1091
|
+
### Authorization
|
|
1092
|
+
|
|
1093
|
+
[oauth2](../README.md#oauth2)
|
|
1094
|
+
|
|
1095
|
+
### HTTP request headers
|
|
1096
|
+
|
|
1097
|
+
- **Content-Type**: Not defined
|
|
1098
|
+
- **Accept**: */*
|
|
1099
|
+
|
|
1100
|
+
|
|
1101
|
+
|
|
1102
|
+
# **get_aggregation_account_overview_using_get**
|
|
1103
|
+
> Object get_aggregation_account_overview_using_get(client_id, opts)
|
|
1104
|
+
|
|
1105
|
+
Retrieve an aggregation account aggregate data
|
|
1106
|
+
|
|
1107
|
+
Retrieve the information for a specific aggregation account with aggregate data for a client.
|
|
1108
|
+
|
|
1109
|
+
### Example
|
|
1110
|
+
```ruby
|
|
1111
|
+
# load the gem
|
|
1112
|
+
require 'nucleus_api'
|
|
1113
|
+
# Setup authorization
|
|
1114
|
+
NucleusApi.configure do |config|
|
|
1115
|
+
# Use one of the below method to generate oauth token
|
|
1116
|
+
# Creating a token for grant_type=client_credentials
|
|
1117
|
+
config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
|
|
1118
|
+
# Creating a token for grant_type=password
|
|
1119
|
+
config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
|
|
1120
|
+
# Creating a token using client token
|
|
1121
|
+
config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
|
|
1122
|
+
end
|
|
1123
|
+
|
|
1124
|
+
api_instance = NucleusApi::AggregationAccountApi.new
|
|
1125
|
+
|
|
1126
|
+
client_id = 'client_id_example' # String | UUID client_id
|
|
1127
|
+
|
|
1128
|
+
opts = {
|
|
1129
|
+
currency_conversion: 'currency_conversion_example' # String | USD
|
|
1130
|
+
}
|
|
1131
|
+
|
|
1132
|
+
begin
|
|
1133
|
+
#Retrieve an aggregation account aggregate data
|
|
1134
|
+
result = api_instance.get_aggregation_account_overview_using_get(client_id, opts)
|
|
1135
|
+
p result
|
|
1136
|
+
rescue NucleusApi::ApiError => e
|
|
1137
|
+
puts "Exception when calling AggregationAccountApi->get_aggregation_account_overview_using_get: #{e}"
|
|
1138
|
+
end
|
|
1139
|
+
```
|
|
1140
|
+
|
|
1141
|
+
### Parameters
|
|
1142
|
+
|
|
1143
|
+
Name | Type | Description | Notes
|
|
1144
|
+
------------- | ------------- | ------------- | -------------
|
|
1145
|
+
**client_id** | [**String**](.md)| UUID client_id |
|
|
1146
|
+
**currency_conversion** | **String**| USD | [optional]
|
|
1147
|
+
|
|
1148
|
+
### Return type
|
|
1149
|
+
|
|
1150
|
+
**Object**
|
|
1151
|
+
|
|
1152
|
+
### Authorization
|
|
1153
|
+
|
|
1154
|
+
[oauth2](../README.md#oauth2)
|
|
1155
|
+
|
|
1156
|
+
### HTTP request headers
|
|
1157
|
+
|
|
1158
|
+
- **Content-Type**: Not defined
|
|
1159
|
+
- **Accept**: */*
|
|
1160
|
+
|
|
1161
|
+
|
|
1162
|
+
|
|
1163
|
+
# **get_aggregation_account_transaction_all_using_get**
|
|
1164
|
+
> PageAggregationAccountTransaction get_aggregation_account_transaction_all_using_get(opts)
|
|
1165
|
+
|
|
1166
|
+
List all aggregation account transactions
|
|
1167
|
+
|
|
1168
|
+
Get all of the transaction records for all aggregation accounts defined for your firm.
|
|
1169
|
+
|
|
1170
|
+
### Example
|
|
1171
|
+
```ruby
|
|
1172
|
+
# load the gem
|
|
1173
|
+
require 'nucleus_api'
|
|
1174
|
+
# Setup authorization
|
|
1175
|
+
NucleusApi.configure do |config|
|
|
1176
|
+
# Use one of the below method to generate oauth token
|
|
1177
|
+
# Creating a token for grant_type=client_credentials
|
|
1178
|
+
config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
|
|
1179
|
+
# Creating a token for grant_type=password
|
|
1180
|
+
config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
|
|
1181
|
+
# Creating a token using client token
|
|
1182
|
+
config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
|
|
1183
|
+
end
|
|
1184
|
+
|
|
1185
|
+
api_instance = NucleusApi::AggregationAccountApi.new
|
|
1186
|
+
|
|
1187
|
+
opts = {
|
|
1188
|
+
ascending: false, # BOOLEAN | ascending
|
|
1189
|
+
currency_conversion: 'currency_conversion_example', # String | currency_conversion
|
|
1190
|
+
filter: 'filter_example', # String | filter
|
|
1191
|
+
order_by: 'update_date', # String | order_by
|
|
1192
|
+
page: 0, # Integer | page
|
|
1193
|
+
size: 25 # Integer | size
|
|
1194
|
+
}
|
|
1195
|
+
|
|
1196
|
+
begin
|
|
1197
|
+
#List all aggregation account transactions
|
|
1198
|
+
result = api_instance.get_aggregation_account_transaction_all_using_get(opts)
|
|
1199
|
+
p result
|
|
1200
|
+
rescue NucleusApi::ApiError => e
|
|
1201
|
+
puts "Exception when calling AggregationAccountApi->get_aggregation_account_transaction_all_using_get: #{e}"
|
|
1202
|
+
end
|
|
1203
|
+
```
|
|
1204
|
+
|
|
1205
|
+
### Parameters
|
|
1206
|
+
|
|
1207
|
+
Name | Type | Description | Notes
|
|
1208
|
+
------------- | ------------- | ------------- | -------------
|
|
1209
|
+
**ascending** | **BOOLEAN**| ascending | [optional] [default to false]
|
|
1210
|
+
**currency_conversion** | **String**| currency_conversion | [optional]
|
|
1211
|
+
**filter** | **String**| filter | [optional]
|
|
1212
|
+
**order_by** | **String**| order_by | [optional] [default to update_date]
|
|
1213
|
+
**page** | **Integer**| page | [optional] [default to 0]
|
|
1214
|
+
**size** | **Integer**| size | [optional] [default to 25]
|
|
1215
|
+
|
|
1216
|
+
### Return type
|
|
1217
|
+
|
|
1218
|
+
[**PageAggregationAccountTransaction**](PageAggregationAccountTransaction.md)
|
|
1219
|
+
|
|
1220
|
+
### Authorization
|
|
1221
|
+
|
|
1222
|
+
[oauth2](../README.md#oauth2)
|
|
1223
|
+
|
|
1224
|
+
### HTTP request headers
|
|
1225
|
+
|
|
1226
|
+
- **Content-Type**: Not defined
|
|
1227
|
+
- **Accept**: */*
|
|
1228
|
+
|
|
1229
|
+
|
|
1230
|
+
|
|
1231
|
+
# **get_aggregation_account_transaction_using_get**
|
|
1232
|
+
> AggregationAccountTransaction get_aggregation_account_transaction_using_get(aggregation_account_transaction_id, opts)
|
|
1233
|
+
|
|
1234
|
+
Retrieve an aggregation account transaction
|
|
1235
|
+
|
|
1236
|
+
Retrieve the information for a specific transaction record for an aggregation account.
|
|
1237
|
+
|
|
1238
|
+
### Example
|
|
1239
|
+
```ruby
|
|
1240
|
+
# load the gem
|
|
1241
|
+
require 'nucleus_api'
|
|
1242
|
+
# Setup authorization
|
|
1243
|
+
NucleusApi.configure do |config|
|
|
1244
|
+
# Use one of the below method to generate oauth token
|
|
1245
|
+
# Creating a token for grant_type=client_credentials
|
|
1246
|
+
config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
|
|
1247
|
+
# Creating a token for grant_type=password
|
|
1248
|
+
config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
|
|
1249
|
+
# Creating a token using client token
|
|
1250
|
+
config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
|
|
1251
|
+
end
|
|
1252
|
+
|
|
1253
|
+
api_instance = NucleusApi::AggregationAccountApi.new
|
|
1254
|
+
|
|
1255
|
+
aggregation_account_transaction_id = 'aggregation_account_transaction_id_example' # String | UUID aggregation_account_transaction_id
|
|
1256
|
+
|
|
1257
|
+
opts = {
|
|
1258
|
+
currency_conversion: 'currency_conversion_example' # String | USD
|
|
1259
|
+
}
|
|
1260
|
+
|
|
1261
|
+
begin
|
|
1262
|
+
#Retrieve an aggregation account transaction
|
|
1263
|
+
result = api_instance.get_aggregation_account_transaction_using_get(aggregation_account_transaction_id, opts)
|
|
1264
|
+
p result
|
|
1265
|
+
rescue NucleusApi::ApiError => e
|
|
1266
|
+
puts "Exception when calling AggregationAccountApi->get_aggregation_account_transaction_using_get: #{e}"
|
|
1267
|
+
end
|
|
1268
|
+
```
|
|
1269
|
+
|
|
1270
|
+
### Parameters
|
|
1271
|
+
|
|
1272
|
+
Name | Type | Description | Notes
|
|
1273
|
+
------------- | ------------- | ------------- | -------------
|
|
1274
|
+
**aggregation_account_transaction_id** | [**String**](.md)| UUID aggregation_account_transaction_id |
|
|
1275
|
+
**currency_conversion** | **String**| USD | [optional]
|
|
1276
|
+
|
|
1277
|
+
### Return type
|
|
1278
|
+
|
|
1279
|
+
[**AggregationAccountTransaction**](AggregationAccountTransaction.md)
|
|
1280
|
+
|
|
1281
|
+
### Authorization
|
|
1282
|
+
|
|
1283
|
+
[oauth2](../README.md#oauth2)
|
|
1284
|
+
|
|
1285
|
+
### HTTP request headers
|
|
1286
|
+
|
|
1287
|
+
- **Content-Type**: Not defined
|
|
1288
|
+
- **Accept**: */*
|
|
1289
|
+
|
|
1290
|
+
|
|
1291
|
+
|
|
1292
|
+
# **get_aggregation_account_using_get**
|
|
1293
|
+
> AggregationAccount get_aggregation_account_using_get(aggregation_account_id)
|
|
1294
|
+
|
|
1295
|
+
Retrieve an aggregation account
|
|
1296
|
+
|
|
1297
|
+
Retrieve the information for a specific aggregation account associated with a client.
|
|
1298
|
+
|
|
1299
|
+
### Example
|
|
1300
|
+
```ruby
|
|
1301
|
+
# load the gem
|
|
1302
|
+
require 'nucleus_api'
|
|
1303
|
+
# Setup authorization
|
|
1304
|
+
NucleusApi.configure do |config|
|
|
1305
|
+
# Use one of the below method to generate oauth token
|
|
1306
|
+
# Creating a token for grant_type=client_credentials
|
|
1307
|
+
config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
|
|
1308
|
+
# Creating a token for grant_type=password
|
|
1309
|
+
config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
|
|
1310
|
+
# Creating a token using client token
|
|
1311
|
+
config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
|
|
1312
|
+
end
|
|
1313
|
+
|
|
1314
|
+
api_instance = NucleusApi::AggregationAccountApi.new
|
|
1315
|
+
|
|
1316
|
+
aggregation_account_id = 'aggregation_account_id_example' # String | UUID aggregation_account_id
|
|
1317
|
+
|
|
1318
|
+
|
|
1319
|
+
begin
|
|
1320
|
+
#Retrieve an aggregation account
|
|
1321
|
+
result = api_instance.get_aggregation_account_using_get(aggregation_account_id)
|
|
1322
|
+
p result
|
|
1323
|
+
rescue NucleusApi::ApiError => e
|
|
1324
|
+
puts "Exception when calling AggregationAccountApi->get_aggregation_account_using_get: #{e}"
|
|
1325
|
+
end
|
|
1326
|
+
```
|
|
1327
|
+
|
|
1328
|
+
### Parameters
|
|
1329
|
+
|
|
1330
|
+
Name | Type | Description | Notes
|
|
1331
|
+
------------- | ------------- | ------------- | -------------
|
|
1332
|
+
**aggregation_account_id** | [**String**](.md)| UUID aggregation_account_id |
|
|
1333
|
+
|
|
1334
|
+
### Return type
|
|
1335
|
+
|
|
1336
|
+
[**AggregationAccount**](AggregationAccount.md)
|
|
1337
|
+
|
|
1338
|
+
### Authorization
|
|
1339
|
+
|
|
1340
|
+
[oauth2](../README.md#oauth2)
|
|
1341
|
+
|
|
1342
|
+
### HTTP request headers
|
|
1343
|
+
|
|
1344
|
+
- **Content-Type**: Not defined
|
|
1345
|
+
- **Accept**: */*
|
|
1346
|
+
|
|
1347
|
+
|
|
1348
|
+
|
|
1349
|
+
# **update_aggregation_account_balance_using_put**
|
|
1350
|
+
> AggregationAccountBalance update_aggregation_account_balance_using_put(aggregation_account_balance, aggregation_account_balance_id)
|
|
1351
|
+
|
|
1352
|
+
Update an aggregation account balance
|
|
1353
|
+
|
|
1354
|
+
Update a balance record for an aggregation account.
|
|
1355
|
+
|
|
1356
|
+
### Example
|
|
1357
|
+
```ruby
|
|
1358
|
+
# load the gem
|
|
1359
|
+
require 'nucleus_api'
|
|
1360
|
+
# Setup authorization
|
|
1361
|
+
NucleusApi.configure do |config|
|
|
1362
|
+
# Use one of the below method to generate oauth token
|
|
1363
|
+
# Creating a token for grant_type=client_credentials
|
|
1364
|
+
config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
|
|
1365
|
+
# Creating a token for grant_type=password
|
|
1366
|
+
config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
|
|
1367
|
+
# Creating a token using client token
|
|
1368
|
+
config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
|
|
1369
|
+
end
|
|
1370
|
+
|
|
1371
|
+
api_instance = NucleusApi::AggregationAccountApi.new
|
|
1372
|
+
|
|
1373
|
+
aggregation_account_balance = nil # Object | aggregation_account_balance
|
|
1374
|
+
|
|
1375
|
+
aggregation_account_balance_id = 'aggregation_account_balance_id_example' # String | UUID aggregation_account_balance_id
|
|
1376
|
+
|
|
1377
|
+
|
|
1378
|
+
begin
|
|
1379
|
+
#Update an aggregation account balance
|
|
1380
|
+
result = api_instance.update_aggregation_account_balance_using_put(aggregation_account_balance, aggregation_account_balance_id)
|
|
1381
|
+
p result
|
|
1382
|
+
rescue NucleusApi::ApiError => e
|
|
1383
|
+
puts "Exception when calling AggregationAccountApi->update_aggregation_account_balance_using_put: #{e}"
|
|
1384
|
+
end
|
|
1385
|
+
```
|
|
1386
|
+
|
|
1387
|
+
### Parameters
|
|
1388
|
+
|
|
1389
|
+
Name | Type | Description | Notes
|
|
1390
|
+
------------- | ------------- | ------------- | -------------
|
|
1391
|
+
**aggregation_account_balance** | **Object**| aggregation_account_balance |
|
|
1392
|
+
**aggregation_account_balance_id** | [**String**](.md)| UUID aggregation_account_balance_id |
|
|
1393
|
+
|
|
1394
|
+
### Return type
|
|
1395
|
+
|
|
1396
|
+
[**AggregationAccountBalance**](AggregationAccountBalance.md)
|
|
1397
|
+
|
|
1398
|
+
### Authorization
|
|
1399
|
+
|
|
1400
|
+
[oauth2](../README.md#oauth2)
|
|
1401
|
+
|
|
1402
|
+
### HTTP request headers
|
|
1403
|
+
|
|
1404
|
+
- **Content-Type**: application/json
|
|
1405
|
+
- **Accept**: */*
|
|
1406
|
+
|
|
1407
|
+
|
|
1408
|
+
|
|
1409
|
+
# **update_aggregation_account_bulk_using_put**
|
|
1410
|
+
> Array<AggregationAccount> update_aggregation_account_bulk_using_put(aggregation_account_list)
|
|
1411
|
+
|
|
1412
|
+
Update a bulk aggregation account
|
|
1413
|
+
|
|
1414
|
+
Update a bulk aggregation account under a client.
|
|
1415
|
+
|
|
1416
|
+
### Example
|
|
1417
|
+
```ruby
|
|
1418
|
+
# load the gem
|
|
1419
|
+
require 'nucleus_api'
|
|
1420
|
+
# Setup authorization
|
|
1421
|
+
NucleusApi.configure do |config|
|
|
1422
|
+
# Use one of the below method to generate oauth token
|
|
1423
|
+
# Creating a token for grant_type=client_credentials
|
|
1424
|
+
config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
|
|
1425
|
+
# Creating a token for grant_type=password
|
|
1426
|
+
config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
|
|
1427
|
+
# Creating a token using client token
|
|
1428
|
+
config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
|
|
1429
|
+
end
|
|
1430
|
+
|
|
1431
|
+
api_instance = NucleusApi::AggregationAccountApi.new
|
|
1432
|
+
|
|
1433
|
+
aggregation_account_list = [NucleusApi::Array<Object>.new] # Array<Object> | aggregationAccountList
|
|
1434
|
+
|
|
1435
|
+
|
|
1436
|
+
begin
|
|
1437
|
+
#Update a bulk aggregation account
|
|
1438
|
+
result = api_instance.update_aggregation_account_bulk_using_put(aggregation_account_list)
|
|
1439
|
+
p result
|
|
1440
|
+
rescue NucleusApi::ApiError => e
|
|
1441
|
+
puts "Exception when calling AggregationAccountApi->update_aggregation_account_bulk_using_put: #{e}"
|
|
1442
|
+
end
|
|
1443
|
+
```
|
|
1444
|
+
|
|
1445
|
+
### Parameters
|
|
1446
|
+
|
|
1447
|
+
Name | Type | Description | Notes
|
|
1448
|
+
------------- | ------------- | ------------- | -------------
|
|
1449
|
+
**aggregation_account_list** | **Array<Object>**| aggregationAccountList |
|
|
1450
|
+
|
|
1451
|
+
### Return type
|
|
1452
|
+
|
|
1453
|
+
[**Array<AggregationAccount>**](AggregationAccount.md)
|
|
1454
|
+
|
|
1455
|
+
### Authorization
|
|
1456
|
+
|
|
1457
|
+
[oauth2](../README.md#oauth2)
|
|
1458
|
+
|
|
1459
|
+
### HTTP request headers
|
|
1460
|
+
|
|
1461
|
+
- **Content-Type**: application/json
|
|
1462
|
+
- **Accept**: */*
|
|
1463
|
+
|
|
1464
|
+
|
|
1465
|
+
|
|
1466
|
+
# **update_aggregation_account_holding_bulk_using_put**
|
|
1467
|
+
> Array<AggregationAccountHolding> update_aggregation_account_holding_bulk_using_put(aggregation_account_holding)
|
|
1468
|
+
|
|
1469
|
+
Update an bulk aggregation account holding
|
|
1470
|
+
|
|
1471
|
+
Update a bulk holding record for an aggregation account.
|
|
1472
|
+
|
|
1473
|
+
### Example
|
|
1474
|
+
```ruby
|
|
1475
|
+
# load the gem
|
|
1476
|
+
require 'nucleus_api'
|
|
1477
|
+
# Setup authorization
|
|
1478
|
+
NucleusApi.configure do |config|
|
|
1479
|
+
# Use one of the below method to generate oauth token
|
|
1480
|
+
# Creating a token for grant_type=client_credentials
|
|
1481
|
+
config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
|
|
1482
|
+
# Creating a token for grant_type=password
|
|
1483
|
+
config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
|
|
1484
|
+
# Creating a token using client token
|
|
1485
|
+
config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
|
|
1486
|
+
end
|
|
1487
|
+
|
|
1488
|
+
api_instance = NucleusApi::AggregationAccountApi.new
|
|
1489
|
+
|
|
1490
|
+
aggregation_account_holding = [NucleusApi::Array<Object>.new] # Array<Object> | aggregationAccountHolding
|
|
1491
|
+
|
|
1492
|
+
|
|
1493
|
+
begin
|
|
1494
|
+
#Update an bulk aggregation account holding
|
|
1495
|
+
result = api_instance.update_aggregation_account_holding_bulk_using_put(aggregation_account_holding)
|
|
1496
|
+
p result
|
|
1497
|
+
rescue NucleusApi::ApiError => e
|
|
1498
|
+
puts "Exception when calling AggregationAccountApi->update_aggregation_account_holding_bulk_using_put: #{e}"
|
|
1499
|
+
end
|
|
1500
|
+
```
|
|
1501
|
+
|
|
1502
|
+
### Parameters
|
|
1503
|
+
|
|
1504
|
+
Name | Type | Description | Notes
|
|
1505
|
+
------------- | ------------- | ------------- | -------------
|
|
1506
|
+
**aggregation_account_holding** | **Array<Object>**| aggregationAccountHolding |
|
|
1507
|
+
|
|
1508
|
+
### Return type
|
|
1509
|
+
|
|
1510
|
+
[**Array<AggregationAccountHolding>**](AggregationAccountHolding.md)
|
|
1511
|
+
|
|
1512
|
+
### Authorization
|
|
1513
|
+
|
|
1514
|
+
[oauth2](../README.md#oauth2)
|
|
1515
|
+
|
|
1516
|
+
### HTTP request headers
|
|
1517
|
+
|
|
1518
|
+
- **Content-Type**: application/json
|
|
1519
|
+
- **Accept**: */*
|
|
1520
|
+
|
|
1521
|
+
|
|
1522
|
+
|
|
1523
|
+
# **update_aggregation_account_holding_using_put**
|
|
1524
|
+
> AggregationAccountHolding update_aggregation_account_holding_using_put(aggregation_account_holding, aggregation_account_holding_id)
|
|
1525
|
+
|
|
1526
|
+
Update an aggregation account holding
|
|
1527
|
+
|
|
1528
|
+
Update a holding record for an aggregation account.
|
|
1529
|
+
|
|
1530
|
+
### Example
|
|
1531
|
+
```ruby
|
|
1532
|
+
# load the gem
|
|
1533
|
+
require 'nucleus_api'
|
|
1534
|
+
# Setup authorization
|
|
1535
|
+
NucleusApi.configure do |config|
|
|
1536
|
+
# Use one of the below method to generate oauth token
|
|
1537
|
+
# Creating a token for grant_type=client_credentials
|
|
1538
|
+
config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
|
|
1539
|
+
# Creating a token for grant_type=password
|
|
1540
|
+
config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
|
|
1541
|
+
# Creating a token using client token
|
|
1542
|
+
config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
|
|
1543
|
+
end
|
|
1544
|
+
|
|
1545
|
+
api_instance = NucleusApi::AggregationAccountApi.new
|
|
1546
|
+
|
|
1547
|
+
aggregation_account_holding = nil # Object | aggregation_account_holding
|
|
1548
|
+
|
|
1549
|
+
aggregation_account_holding_id = 'aggregation_account_holding_id_example' # String | UUID aggregation_account_holding_id
|
|
1550
|
+
|
|
1551
|
+
|
|
1552
|
+
begin
|
|
1553
|
+
#Update an aggregation account holding
|
|
1554
|
+
result = api_instance.update_aggregation_account_holding_using_put(aggregation_account_holding, aggregation_account_holding_id)
|
|
1555
|
+
p result
|
|
1556
|
+
rescue NucleusApi::ApiError => e
|
|
1557
|
+
puts "Exception when calling AggregationAccountApi->update_aggregation_account_holding_using_put: #{e}"
|
|
1558
|
+
end
|
|
1559
|
+
```
|
|
1560
|
+
|
|
1561
|
+
### Parameters
|
|
1562
|
+
|
|
1563
|
+
Name | Type | Description | Notes
|
|
1564
|
+
------------- | ------------- | ------------- | -------------
|
|
1565
|
+
**aggregation_account_holding** | **Object**| aggregation_account_holding |
|
|
1566
|
+
**aggregation_account_holding_id** | [**String**](.md)| UUID aggregation_account_holding_id |
|
|
1567
|
+
|
|
1568
|
+
### Return type
|
|
1569
|
+
|
|
1570
|
+
[**AggregationAccountHolding**](AggregationAccountHolding.md)
|
|
1571
|
+
|
|
1572
|
+
### Authorization
|
|
1573
|
+
|
|
1574
|
+
[oauth2](../README.md#oauth2)
|
|
1575
|
+
|
|
1576
|
+
### HTTP request headers
|
|
1577
|
+
|
|
1578
|
+
- **Content-Type**: application/json
|
|
1579
|
+
- **Accept**: */*
|
|
1580
|
+
|
|
1581
|
+
|
|
1582
|
+
|
|
1583
|
+
# **update_aggregation_account_transaction_using_put**
|
|
1584
|
+
> AggregationAccountTransaction update_aggregation_account_transaction_using_put(aggregation_account_transaction, aggregation_account_transaction_id)
|
|
1585
|
+
|
|
1586
|
+
Update an aggregation account transaction
|
|
1587
|
+
|
|
1588
|
+
Update a transaction record for an aggregation account.
|
|
1589
|
+
|
|
1590
|
+
### Example
|
|
1591
|
+
```ruby
|
|
1592
|
+
# load the gem
|
|
1593
|
+
require 'nucleus_api'
|
|
1594
|
+
# Setup authorization
|
|
1595
|
+
NucleusApi.configure do |config|
|
|
1596
|
+
# Use one of the below method to generate oauth token
|
|
1597
|
+
# Creating a token for grant_type=client_credentials
|
|
1598
|
+
config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
|
|
1599
|
+
# Creating a token for grant_type=password
|
|
1600
|
+
config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
|
|
1601
|
+
# Creating a token using client token
|
|
1602
|
+
config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
|
|
1603
|
+
end
|
|
1604
|
+
|
|
1605
|
+
api_instance = NucleusApi::AggregationAccountApi.new
|
|
1606
|
+
|
|
1607
|
+
aggregation_account_transaction = nil # Object | aggregation_account_transaction
|
|
1608
|
+
|
|
1609
|
+
aggregation_account_transaction_id = 'aggregation_account_transaction_id_example' # String | UUID aggregation_account_transaction_id
|
|
1610
|
+
|
|
1611
|
+
|
|
1612
|
+
begin
|
|
1613
|
+
#Update an aggregation account transaction
|
|
1614
|
+
result = api_instance.update_aggregation_account_transaction_using_put(aggregation_account_transaction, aggregation_account_transaction_id)
|
|
1615
|
+
p result
|
|
1616
|
+
rescue NucleusApi::ApiError => e
|
|
1617
|
+
puts "Exception when calling AggregationAccountApi->update_aggregation_account_transaction_using_put: #{e}"
|
|
1618
|
+
end
|
|
1619
|
+
```
|
|
1620
|
+
|
|
1621
|
+
### Parameters
|
|
1622
|
+
|
|
1623
|
+
Name | Type | Description | Notes
|
|
1624
|
+
------------- | ------------- | ------------- | -------------
|
|
1625
|
+
**aggregation_account_transaction** | **Object**| aggregation_account_transaction |
|
|
1626
|
+
**aggregation_account_transaction_id** | [**String**](.md)| UUID aggregation_account_transaction_id |
|
|
1627
|
+
|
|
1628
|
+
### Return type
|
|
1629
|
+
|
|
1630
|
+
[**AggregationAccountTransaction**](AggregationAccountTransaction.md)
|
|
1631
|
+
|
|
1632
|
+
### Authorization
|
|
1633
|
+
|
|
1634
|
+
[oauth2](../README.md#oauth2)
|
|
1635
|
+
|
|
1636
|
+
### HTTP request headers
|
|
1637
|
+
|
|
1638
|
+
- **Content-Type**: application/json
|
|
1639
|
+
- **Accept**: */*
|
|
1640
|
+
|
|
1641
|
+
|
|
1642
|
+
|
|
1643
|
+
# **update_aggregation_account_using_put**
|
|
1644
|
+
> AggregationAccount update_aggregation_account_using_put(aggregation_account, aggregation_account_id)
|
|
1645
|
+
|
|
1646
|
+
Update an aggregation account
|
|
1647
|
+
|
|
1648
|
+
Update the information for an aggregation account.
|
|
1649
|
+
|
|
1650
|
+
### Example
|
|
1651
|
+
```ruby
|
|
1652
|
+
# load the gem
|
|
1653
|
+
require 'nucleus_api'
|
|
1654
|
+
# Setup authorization
|
|
1655
|
+
NucleusApi.configure do |config|
|
|
1656
|
+
# Use one of the below method to generate oauth token
|
|
1657
|
+
# Creating a token for grant_type=client_credentials
|
|
1658
|
+
config.create_client_credential("CLIENT_ID", "CLIENT_SECRET");
|
|
1659
|
+
# Creating a token for grant_type=password
|
|
1660
|
+
config.create_password_credential("CLIENT_ID", "CLIENT_SECRET", "USERNAME", "PASSWORD");
|
|
1661
|
+
# Creating a token using client token
|
|
1662
|
+
config.create_client_token_credential("CLIENT_ID", "CLIENT_SECRET", "CLIENT_TOKEN")
|
|
1663
|
+
end
|
|
1664
|
+
|
|
1665
|
+
api_instance = NucleusApi::AggregationAccountApi.new
|
|
1666
|
+
|
|
1667
|
+
aggregation_account = nil # Object | aggregation_account
|
|
1668
|
+
|
|
1669
|
+
aggregation_account_id = 'aggregation_account_id_example' # String | UUID aggregation_account_id
|
|
1670
|
+
|
|
1671
|
+
|
|
1672
|
+
begin
|
|
1673
|
+
#Update an aggregation account
|
|
1674
|
+
result = api_instance.update_aggregation_account_using_put(aggregation_account, aggregation_account_id)
|
|
1675
|
+
p result
|
|
1676
|
+
rescue NucleusApi::ApiError => e
|
|
1677
|
+
puts "Exception when calling AggregationAccountApi->update_aggregation_account_using_put: #{e}"
|
|
1678
|
+
end
|
|
1679
|
+
```
|
|
1680
|
+
|
|
1681
|
+
### Parameters
|
|
1682
|
+
|
|
1683
|
+
Name | Type | Description | Notes
|
|
1684
|
+
------------- | ------------- | ------------- | -------------
|
|
1685
|
+
**aggregation_account** | **Object**| aggregation_account |
|
|
1686
|
+
**aggregation_account_id** | [**String**](.md)| UUID aggregation_account_id |
|
|
1687
|
+
|
|
1688
|
+
### Return type
|
|
1689
|
+
|
|
1690
|
+
[**AggregationAccount**](AggregationAccount.md)
|
|
1691
|
+
|
|
1692
|
+
### Authorization
|
|
1693
|
+
|
|
1694
|
+
[oauth2](../README.md#oauth2)
|
|
1695
|
+
|
|
1696
|
+
### HTTP request headers
|
|
1697
|
+
|
|
1698
|
+
- **Content-Type**: application/json
|
|
1699
|
+
- **Accept**: */*
|
|
1700
|
+
|
|
1701
|
+
|
|
1702
|
+
|