# hydrogen-atom-api atom_api - JavaScript client for hydrogen-atom-api The Hydrogen Atom API Full documentation: [Nucleus](https://www.hydrogenplatform.com/docs/nucleus/v1/) | [Electron](https://www.hydrogenplatform.com/docs/electron/v1/) | [Proton](https://www.hydrogenplatform.com/docs/proton/v1/) This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project: - API version: 1.0.1 - Package version: 1.0.1 - Build package: io.swagger.codegen.languages.JavascriptClientCodegen - For more information, please visit [https://www.hydrogenplatform.com/contact](https://www.hydrogenplatform.com/contact) ## Installation ### For [Node.js](https://nodejs.org/) #### npm To publish the library as a [npm](https://www.npmjs.com/), please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages). Then install it via: ```shell npm install hydrogen-atom-api --save ``` Optionally, install `client-oauth2` for easier authentication (see Method 1 in Getting Started): ```shell npm install --save client-oauth2 ``` ##### Local development To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing `package.json` (and this README). Let's call this `JAVASCRIPT_CLIENT_DIR`. Then run: ```shell npm install ``` Next, [link](https://docs.npmjs.com/cli/link) it globally in npm with the following, also from `JAVASCRIPT_CLIENT_DIR`: ```shell npm link ``` Finally, switch to the directory you want to use your hydrogen-atom-api from, and run: ```shell npm link /path/to/ ``` You should now be able to `require('hydrogen-atom-api')` in javascript files from the directory you ran the last command above from. #### git # If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via: ```shell npm install GIT_USER_ID/GIT_REPO_ID --save ``` ### For browser The library also works in the browser environment via npm and [browserify](http://browserify.org/). After following the above steps with Node.js and installing browserify with `npm install -g browserify`, perform the following (assuming *main.js* is your entry file, that's to say your javascript file where you actually use this library): ```shell browserify main.js > bundle.js ``` Then include *bundle.js* in the HTML pages. ### Webpack Configuration Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config: ```javascript module: { rules: [ { parser: { amd: false } } ] } ``` ## Getting Started Full usage documentation is available: [Nucleus](https://www.hydrogenplatform.com/docs/nucleus/v1/) | [Electron](https://www.hydrogenplatform.com/docs/electron/v1/) | [Proton](https://www.hydrogenplatform.com/docs/proton/v1/) Please follow the [installation](#installation) instructions and execute the following JS code: ```javascript var atom_api = require('hydrogen-atom-api'); var defaultClient = atom_api.ApiClient.instance; // (Optional) Set the Atom environment you wish to use (defaults to sandbox) // This changes the URL for requests to [environment].hydrogenplatform.com defaultClient.basePath = "https://sandbox.hydrogenplatform.com"; // Configure OAuth2 access token for authorization: oauth // Ensure the token is from the same environment as the defaultClient.basePath above var oauth = defaultClient.authentications['oauth']; oauth.accessToken = "YOUR ACCESS TOKEN"; var api = new atom_api.ElectronApi(); var campaignId = "campaignId_example"; // {String} UUID of a marketing campaign var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully.'); } }; api.deleteCampaign(campaignId, callback); ``` ## Documentation for API Endpoints Full usage documentation is available: [Nucleus](https://www.hydrogenplatform.com/docs/nucleus/v1/) | [Electron](https://www.hydrogenplatform.com/docs/electron/v1/) | [Proton](https://www.hydrogenplatform.com/docs/proton/v1/) All URIs are relative to *https://sandbox.hydrogenplatform.com* Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- *atom_api.ElectronApi* | [**deleteCampaign**](docs/ElectronApi.md#deleteCampaign) | **DELETE** /electron/v1/campaign/{campaign_id} | Delete a marketing campaign *atom_api.ElectronApi* | [**deleteCampaignDataRecord**](docs/ElectronApi.md#deleteCampaignDataRecord) | **DELETE** /electron/v1/campaign_data/{campaign_data_id} | Delete a marketing campaign data record *atom_api.ElectronApi* | [**deleteCampaignPlan**](docs/ElectronApi.md#deleteCampaignPlan) | **DELETE** /electron/v1/campaign_plan/{campaign_plan_id} | Delete a marketing campaign plan *atom_api.ElectronApi* | [**deleteChatLog**](docs/ElectronApi.md#deleteChatLog) | **DELETE** /electron/v1/chat/{chat_id} | Delete a chat log *atom_api.ElectronApi* | [**deleteClientCampaign**](docs/ElectronApi.md#deleteClientCampaign) | **DELETE** /electron/v1/client_campaign/{client_campaign_id} | Remove a client from a campaign *atom_api.ElectronApi* | [**deleteConsultation**](docs/ElectronApi.md#deleteConsultation) | **DELETE** /electron/v1/consultation/{consultation_id} | Delete a consultation *atom_api.ElectronApi* | [**deleteDocument**](docs/ElectronApi.md#deleteDocument) | **DELETE** /electron/v1/document/{document_id} | Delete a document *atom_api.ElectronApi* | [**deleteFaq**](docs/ElectronApi.md#deleteFaq) | **DELETE** /electron/v1/faq/{faq_id} | Delete a FAQ *atom_api.ElectronApi* | [**deleteSalesInquiry**](docs/ElectronApi.md#deleteSalesInquiry) | **DELETE** /electron/v1/sales/{sales_id} | Delete a sales inquiry *atom_api.ElectronApi* | [**deleteSupportTicket**](docs/ElectronApi.md#deleteSupportTicket) | **DELETE** /electron/v1/support_ticket/{support_ticket_id} | Delete a support ticket *atom_api.ElectronApi* | [**deleteSupportTicketComment**](docs/ElectronApi.md#deleteSupportTicketComment) | **DELETE** /electron/v1/support_ticket_comment/{support_ticket_comment_id} | Delete a support ticket comment *atom_api.ElectronApi* | [**getCampaign**](docs/ElectronApi.md#getCampaign) | **GET** /electron/v1/campaign/{campaign_id} | Retrieve a marketing campaign *atom_api.ElectronApi* | [**getCampaignDataRecord**](docs/ElectronApi.md#getCampaignDataRecord) | **GET** /electron/v1/campaign_data/{campaign_data_id} | Retrieve a marketing campaign data record *atom_api.ElectronApi* | [**getCampaignDataRecords**](docs/ElectronApi.md#getCampaignDataRecords) | **GET** /electron/v1/campaign_data | List all marketing campaign data records *atom_api.ElectronApi* | [**getCampaignPlan**](docs/ElectronApi.md#getCampaignPlan) | **GET** /electron/v1/campaign_plan/{campaign_plan_id} | Retrieve a marketing campaign plan *atom_api.ElectronApi* | [**getCampaignPlans**](docs/ElectronApi.md#getCampaignPlans) | **GET** /electron/v1/campaign_plan | List all marketing campaign plans *atom_api.ElectronApi* | [**getCampaigns**](docs/ElectronApi.md#getCampaigns) | **GET** /electron/v1/campaign | List all marketing campaigns *atom_api.ElectronApi* | [**getChatLog**](docs/ElectronApi.md#getChatLog) | **GET** /electron/v1/chat/{chat_id} | Retrieve a chat log *atom_api.ElectronApi* | [**getChatLogs**](docs/ElectronApi.md#getChatLogs) | **GET** /electron/v1/chat | List all chat logs *atom_api.ElectronApi* | [**getClientCampaign**](docs/ElectronApi.md#getClientCampaign) | **GET** /electron/v1/client_campaign/{client_campaign_id} | Retrieve a client assigned to a campaign *atom_api.ElectronApi* | [**getClientCampaigns**](docs/ElectronApi.md#getClientCampaigns) | **GET** /electron/v1/client_campaign | List information for all clients that are assigned to a marketing campaign defined for your firm *atom_api.ElectronApi* | [**getConsultation**](docs/ElectronApi.md#getConsultation) | **GET** /electron/v1/consultation/{consultation_id} | Retrieve a consultation *atom_api.ElectronApi* | [**getConsultations**](docs/ElectronApi.md#getConsultations) | **GET** /electron/v1/consultation | List all consultations *atom_api.ElectronApi* | [**getDocument**](docs/ElectronApi.md#getDocument) | **GET** /electron/v1/document/{document_id} | Retrieve a document *atom_api.ElectronApi* | [**getDocuments**](docs/ElectronApi.md#getDocuments) | **GET** /electron/v1/document | List all documents *atom_api.ElectronApi* | [**getFaq**](docs/ElectronApi.md#getFaq) | **GET** /electron/v1/faq/{faq_id} | Retrieve a FAQ *atom_api.ElectronApi* | [**getFaqs**](docs/ElectronApi.md#getFaqs) | **GET** /electron/v1/faq | List all FAQs *atom_api.ElectronApi* | [**getSalesInquiries**](docs/ElectronApi.md#getSalesInquiries) | **GET** /electron/v1/sales | List all sales inquiries *atom_api.ElectronApi* | [**getSalesInquiry**](docs/ElectronApi.md#getSalesInquiry) | **GET** /electron/v1/sales/{sales_id} | Retrieve a sales inquiry *atom_api.ElectronApi* | [**getSupportTicket**](docs/ElectronApi.md#getSupportTicket) | **GET** /electron/v1/support_ticket/{support_ticket_id} | Retrieve a support ticket *atom_api.ElectronApi* | [**getSupportTicketComment**](docs/ElectronApi.md#getSupportTicketComment) | **GET** /electron/v1/support_ticket_comment/{support_ticket_comment_id} | Retrieve a support ticket comment *atom_api.ElectronApi* | [**getSupportTicketComments**](docs/ElectronApi.md#getSupportTicketComments) | **GET** /electron/v1/support_ticket_comment | List all support ticket comments *atom_api.ElectronApi* | [**getSupportTickets**](docs/ElectronApi.md#getSupportTickets) | **GET** /electron/v1/support_ticket | List all support tickets *atom_api.ElectronApi* | [**postCampaign**](docs/ElectronApi.md#postCampaign) | **POST** /electron/v1/campaign | Create a marketing campaign *atom_api.ElectronApi* | [**postCampaignDataRecord**](docs/ElectronApi.md#postCampaignDataRecord) | **POST** /electron/v1/campaign_data | Create a marketing campaign data record *atom_api.ElectronApi* | [**postCampaignPlan**](docs/ElectronApi.md#postCampaignPlan) | **POST** /electron/v1/campaign_plan | Create a marketing campaign plan *atom_api.ElectronApi* | [**postChatLog**](docs/ElectronApi.md#postChatLog) | **POST** /electron/v1/chat | Create a chat log *atom_api.ElectronApi* | [**postClientCampaign**](docs/ElectronApi.md#postClientCampaign) | **POST** /electron/v1/client_campaign | Assign a client to a campaign to indicate the client has registered through the campaign specified *atom_api.ElectronApi* | [**postConsultation**](docs/ElectronApi.md#postConsultation) | **POST** /electron/v1/consultation | Create a consultation *atom_api.ElectronApi* | [**postDocument**](docs/ElectronApi.md#postDocument) | **POST** /electron/v1/document | Create a document *atom_api.ElectronApi* | [**postFaq**](docs/ElectronApi.md#postFaq) | **POST** /electron/v1/faq | Create a faq *atom_api.ElectronApi* | [**postSalesInquiry**](docs/ElectronApi.md#postSalesInquiry) | **POST** /electron/v1/sales | Create a sales inquiry *atom_api.ElectronApi* | [**postSupportTicket**](docs/ElectronApi.md#postSupportTicket) | **POST** /electron/v1/support_ticket | Create a support ticket *atom_api.ElectronApi* | [**postSupportTicketComment**](docs/ElectronApi.md#postSupportTicketComment) | **POST** /electron/v1/support_ticket_comment | Create a support ticket comment *atom_api.ElectronApi* | [**updateCampaign**](docs/ElectronApi.md#updateCampaign) | **PUT** /electron/v1/campaign/{campaign_id} | Update a marketing campaign *atom_api.ElectronApi* | [**updateCampaignDataRecord**](docs/ElectronApi.md#updateCampaignDataRecord) | **PUT** /electron/v1/campaign_data/{campaign_data_id} | Update a marketing campaign data record *atom_api.ElectronApi* | [**updateCampaignPlan**](docs/ElectronApi.md#updateCampaignPlan) | **PUT** /electron/v1/campaign_plan/{campaign_plan_id} | Update a marketing campaign plan *atom_api.ElectronApi* | [**updateChatLog**](docs/ElectronApi.md#updateChatLog) | **PUT** /electron/v1/chat/{chat_id} | Update a chat log *atom_api.ElectronApi* | [**updateClientCampaign**](docs/ElectronApi.md#updateClientCampaign) | **PUT** /electron/v1/client_campaign/{client_campaign_id} | Update a client assigned to a campaign *atom_api.ElectronApi* | [**updateConsultation**](docs/ElectronApi.md#updateConsultation) | **PUT** /electron/v1/consultation/{consultation_id} | Update a consultation *atom_api.ElectronApi* | [**updateDocument**](docs/ElectronApi.md#updateDocument) | **PUT** /electron/v1/document/{document_id} | Update a document *atom_api.ElectronApi* | [**updateFaq**](docs/ElectronApi.md#updateFaq) | **PUT** /electron/v1/faq/{faq_id} | Update a FAQ *atom_api.ElectronApi* | [**updateSalesInquiry**](docs/ElectronApi.md#updateSalesInquiry) | **PUT** /electron/v1/sales/{sales_id} | Update a sales inquiry *atom_api.ElectronApi* | [**updateSupportTicket**](docs/ElectronApi.md#updateSupportTicket) | **PUT** /electron/v1/support_ticket/{support_ticket_id} | Update a support ticket *atom_api.ElectronApi* | [**updateSupportTicketComment**](docs/ElectronApi.md#updateSupportTicketComment) | **PUT** /electron/v1/support_ticket_comment/{support_ticket_comment_id} | Update a support ticket comment *atom_api.NucleusApi* | [**deleteAccount**](docs/NucleusApi.md#deleteAccount) | **DELETE** /nucleus/v1/account/{account_id}/ | Delete an account *atom_api.NucleusApi* | [**deleteAccountAllocation**](docs/NucleusApi.md#deleteAccountAllocation) | **DELETE** /nucleus/v1/account_allocation/{account_allocation_id} | Delete an account allocation *atom_api.NucleusApi* | [**deleteAccountPermission**](docs/NucleusApi.md#deleteAccountPermission) | **DELETE** /nucleus/v1/account_permission/{account_id} | Delete an account's permissions *atom_api.NucleusApi* | [**deleteAccountStage**](docs/NucleusApi.md#deleteAccountStage) | **DELETE** /nucleus/v1/stage/{stage_id} | Delete an account stage *atom_api.NucleusApi* | [**deleteAccountStatus**](docs/NucleusApi.md#deleteAccountStatus) | **DELETE** /nucleus/v1/account_status/{account_status_id} | Delete an account status *atom_api.NucleusApi* | [**deleteAccountType**](docs/NucleusApi.md#deleteAccountType) | **DELETE** /nucleus/v1/account_type/{account_type_id} | Delete an account type *atom_api.NucleusApi* | [**deleteAggregationAccount**](docs/NucleusApi.md#deleteAggregationAccount) | **DELETE** /nucleus/v1/aggregation_account/{aggregation_account_id} | Delete an aggregation account *atom_api.NucleusApi* | [**deleteAggregationAccountBalance**](docs/NucleusApi.md#deleteAggregationAccountBalance) | **DELETE** /nucleus/v1/aggregation_account_balance/{aggregation_account_balance_id} | Delete an aggregation account balance *atom_api.NucleusApi* | [**deleteAggregationAccountHolding**](docs/NucleusApi.md#deleteAggregationAccountHolding) | **DELETE** /nucleus/v1/aggregation_account_holding/{aggregation_account_holding_id} | Delete an aggregation account holding *atom_api.NucleusApi* | [**deleteAggregationAccountTransaction**](docs/NucleusApi.md#deleteAggregationAccountTransaction) | **DELETE** /nucleus/v1/aggregation_account_transaction/{aggregation_account_transaction_id} | Delete an aggregation account transaction *atom_api.NucleusApi* | [**deleteAllocation**](docs/NucleusApi.md#deleteAllocation) | **DELETE** /nucleus/v1/allocation/{allocation_id} | Delete an allocation *atom_api.NucleusApi* | [**deleteAllocationComposition**](docs/NucleusApi.md#deleteAllocationComposition) | **DELETE** /nucleus/v1/allocation_composition/{allocation_composition_id} | Delete an allocation composition *atom_api.NucleusApi* | [**deleteBankLink**](docs/NucleusApi.md#deleteBankLink) | **DELETE** /nucleus/v1/bank_link/{bank_link_id} | Delete a bank link *atom_api.NucleusApi* | [**deleteBenchmark**](docs/NucleusApi.md#deleteBenchmark) | **DELETE** /nucleus/v1/benchmark/{benchmark_id} | Delete a benchmark *atom_api.NucleusApi* | [**deleteBudget**](docs/NucleusApi.md#deleteBudget) | **DELETE** /nucleus/v1/budget/{budget_id} | Delete a budget *atom_api.NucleusApi* | [**deleteClient**](docs/NucleusApi.md#deleteClient) | **DELETE** /nucleus/v1/client/{client_id} | Delete a client *atom_api.NucleusApi* | [**deleteClientHydro**](docs/NucleusApi.md#deleteClientHydro) | **DELETE** /nucleus/v1/client_hydro/{client_hydro_id} | Delete a client-hydro relationship *atom_api.NucleusApi* | [**deleteClientResponse**](docs/NucleusApi.md#deleteClientResponse) | **DELETE** /nucleus/v1/client_response/{client_response_id} | Delete a client response *atom_api.NucleusApi* | [**deleteDecisionTree**](docs/NucleusApi.md#deleteDecisionTree) | **DELETE** /nucleus/v1/decision_tree/{decision_tree_id} | Delete a decision tree *atom_api.NucleusApi* | [**deleteDepositRequest**](docs/NucleusApi.md#deleteDepositRequest) | **DELETE** /nucleus/v1/deposit/{deposit_id} | Delete a deposit request *atom_api.NucleusApi* | [**deleteFinancialOffer**](docs/NucleusApi.md#deleteFinancialOffer) | **DELETE** /nucleus/v1/financial_offer/{financial_offer_id} | Delete a financial offer *atom_api.NucleusApi* | [**deleteFundingRequest**](docs/NucleusApi.md#deleteFundingRequest) | **DELETE** /nucleus/v1/funding/{funding_id} | Delete a funding request *atom_api.NucleusApi* | [**deleteGoal**](docs/NucleusApi.md#deleteGoal) | **DELETE** /nucleus/v1/goal/{goal_id} | Delete a goal *atom_api.NucleusApi* | [**deleteGoalTrackRecord**](docs/NucleusApi.md#deleteGoalTrackRecord) | **DELETE** /nucleus/v1/goal_track/{goal_track_id} | Delete a goal track record *atom_api.NucleusApi* | [**deleteModel**](docs/NucleusApi.md#deleteModel) | **DELETE** /nucleus/v1/model/{model_id} | Delete a model *atom_api.NucleusApi* | [**deleteModelAssetSize**](docs/NucleusApi.md#deleteModelAssetSize) | **DELETE** /nucleus/v1/model_asset_size/{model_asset_size_id} | Delete a model asset size *atom_api.NucleusApi* | [**deleteModelComment**](docs/NucleusApi.md#deleteModelComment) | **DELETE** /nucleus/v1/model_comment/{model_comment_id} | Delete a model commentary *atom_api.NucleusApi* | [**deleteModelHolding**](docs/NucleusApi.md#deleteModelHolding) | **DELETE** /nucleus/v1/model_holding/{model_holding_id} | Delete a model holding *atom_api.NucleusApi* | [**deleteModelTransaction**](docs/NucleusApi.md#deleteModelTransaction) | **DELETE** /nucleus/v1/model_transaction/{model_transaction_id} | Delete a model transaction *atom_api.NucleusApi* | [**deleteNode**](docs/NucleusApi.md#deleteNode) | **DELETE** /nucleus/v1/node/{node_id} | Delete a node *atom_api.NucleusApi* | [**deleteNodeRelationship**](docs/NucleusApi.md#deleteNodeRelationship) | **DELETE** /nucleus/v1/node_relationship/{node_relationship_id} | Delete a node relationship *atom_api.NucleusApi* | [**deleteOrderRecord**](docs/NucleusApi.md#deleteOrderRecord) | **DELETE** /nucleus/v1/order/{order_id} | Delete an order record *atom_api.NucleusApi* | [**deleteOrderStatus**](docs/NucleusApi.md#deleteOrderStatus) | **DELETE** /nucleus/v1/order_status/{order_status_id} | Delete an order status *atom_api.NucleusApi* | [**deleteOrderTrackingRecord**](docs/NucleusApi.md#deleteOrderTrackingRecord) | **DELETE** /nucleus/v1/order_track/{order_track_id} | Delete an order tracking record *atom_api.NucleusApi* | [**deletePortfolio**](docs/NucleusApi.md#deletePortfolio) | **DELETE** /nucleus/v1/portfolio/{portfolio_id} | Delete a portfolio *atom_api.NucleusApi* | [**deletePortfolioAssetSize**](docs/NucleusApi.md#deletePortfolioAssetSize) | **DELETE** /nucleus/v1/portfolio_asset_size/{portfolio_asset_size_id} | Delete a portfolio asset size *atom_api.NucleusApi* | [**deletePortfolioComment**](docs/NucleusApi.md#deletePortfolioComment) | **DELETE** /nucleus/v1/portfolio_comment/{portfolio_comment_id} | Delete a portfolio commentary *atom_api.NucleusApi* | [**deletePortfolioHolding**](docs/NucleusApi.md#deletePortfolioHolding) | **DELETE** /nucleus/v1/portfolio_holding/{portfolio_holding_id} | Delete a portfolio holding *atom_api.NucleusApi* | [**deletePortfolioTransaction**](docs/NucleusApi.md#deletePortfolioTransaction) | **DELETE** /nucleus/v1/portfolio_transaction/{portfolio_transaction_id} | Delete a portfolio transaction *atom_api.NucleusApi* | [**deleteQuestionnaire**](docs/NucleusApi.md#deleteQuestionnaire) | **DELETE** /nucleus/v1/questionnaire/{questionnaire_id} | Delete a questionnaire *atom_api.NucleusApi* | [**deleteScore**](docs/NucleusApi.md#deleteScore) | **DELETE** /nucleus/v1/score/{score_id} | Delete a score *atom_api.NucleusApi* | [**deleteSecurity**](docs/NucleusApi.md#deleteSecurity) | **DELETE** /nucleus/v1/security/{security_id} | Delete a security *atom_api.NucleusApi* | [**deleteSecurityExclusion**](docs/NucleusApi.md#deleteSecurityExclusion) | **DELETE** /nucleus/v1/security_exclusion/{security_exclusion_id} | Delete a security exclusion *atom_api.NucleusApi* | [**deleteSecurityPrice**](docs/NucleusApi.md#deleteSecurityPrice) | **DELETE** /nucleus/v1/security_price/{security_price_id} | Delete a security price *atom_api.NucleusApi* | [**deleteTransactionCode**](docs/NucleusApi.md#deleteTransactionCode) | **DELETE** /nucleus/v1/transaction_code/{transaction_code_id} | Delete a transaction code *atom_api.NucleusApi* | [**deleteTransferRequest**](docs/NucleusApi.md#deleteTransferRequest) | **DELETE** /nucleus/v1/transfer/{transfer_id} | Delete a transfer request *atom_api.NucleusApi* | [**deleteWithdrawalRequest**](docs/NucleusApi.md#deleteWithdrawalRequest) | **DELETE** /nucleus/v1/withdrawal/{withdrawal_id} | Delete a withdrawal request *atom_api.NucleusApi* | [**getAccount**](docs/NucleusApi.md#getAccount) | **GET** /nucleus/v1/account/{account_id}/ | Retrieve an account *atom_api.NucleusApi* | [**getAccountAllocation**](docs/NucleusApi.md#getAccountAllocation) | **GET** /nucleus/v1/account_allocation/{account_allocation_id} | Retrieve an account allocation *atom_api.NucleusApi* | [**getAccountAllocations**](docs/NucleusApi.md#getAccountAllocations) | **GET** /nucleus/v1/account_allocation | List all account allocations *atom_api.NucleusApi* | [**getAccountAssetSizes**](docs/NucleusApi.md#getAccountAssetSizes) | **GET** /nucleus/v1/account/{account_id}/asset_size | List all account asset sizes *atom_api.NucleusApi* | [**getAccountHoldings**](docs/NucleusApi.md#getAccountHoldings) | **GET** /nucleus/v1/account/{account_id}/holding | List all account holdings *atom_api.NucleusApi* | [**getAccountPerformance**](docs/NucleusApi.md#getAccountPerformance) | **GET** /nucleus/v1/account/{account_id}/performance | Get account performance *atom_api.NucleusApi* | [**getAccountPermission**](docs/NucleusApi.md#getAccountPermission) | **GET** /nucleus/v1/account_permission/{account_id} | Retrieve an account's permission *atom_api.NucleusApi* | [**getAccountPermissions**](docs/NucleusApi.md#getAccountPermissions) | **GET** /nucleus/v1/account_permission | List all account permissions *atom_api.NucleusApi* | [**getAccountStage**](docs/NucleusApi.md#getAccountStage) | **GET** /nucleus/v1/stage/{stage_id} | Retrieve an account stage *atom_api.NucleusApi* | [**getAccountStages**](docs/NucleusApi.md#getAccountStages) | **GET** /nucleus/v1/stage | List all account stages *atom_api.NucleusApi* | [**getAccountStatus**](docs/NucleusApi.md#getAccountStatus) | **GET** /nucleus/v1/account_status/{account_status_id} | Retrieve an account status *atom_api.NucleusApi* | [**getAccountStatuses**](docs/NucleusApi.md#getAccountStatuses) | **GET** /nucleus/v1/account_status | List all account statuses *atom_api.NucleusApi* | [**getAccountTransactions**](docs/NucleusApi.md#getAccountTransactions) | **GET** /nucleus/v1/account/{account_id}/transaction | List all account transactions *atom_api.NucleusApi* | [**getAccountType**](docs/NucleusApi.md#getAccountType) | **GET** /nucleus/v1/account_type/{account_type_id} | Retrieve an account type *atom_api.NucleusApi* | [**getAccountTypes**](docs/NucleusApi.md#getAccountTypes) | **GET** /nucleus/v1/account_type | List all account types *atom_api.NucleusApi* | [**getAccounts**](docs/NucleusApi.md#getAccounts) | **GET** /nucleus/v1/account | Get information for all accounts for all clients defined for your firm *atom_api.NucleusApi* | [**getAggregationAccount**](docs/NucleusApi.md#getAggregationAccount) | **GET** /nucleus/v1/aggregation_account/{aggregation_account_id} | Retrieve an aggregation account *atom_api.NucleusApi* | [**getAggregationAccountBalance**](docs/NucleusApi.md#getAggregationAccountBalance) | **GET** /nucleus/v1/aggregation_account_balance/{aggregation_account_balance_id} | Retrieve an aggregation account balance *atom_api.NucleusApi* | [**getAggregationAccountBalances**](docs/NucleusApi.md#getAggregationAccountBalances) | **GET** /nucleus/v1/aggregation_account_balance | List all aggregation account balances *atom_api.NucleusApi* | [**getAggregationAccountHolding**](docs/NucleusApi.md#getAggregationAccountHolding) | **GET** /nucleus/v1/aggregation_account_holding/{aggregation_account_holding_id} | Retrieve an aggregation account holding *atom_api.NucleusApi* | [**getAggregationAccountHoldings**](docs/NucleusApi.md#getAggregationAccountHoldings) | **GET** /nucleus/v1/aggregation_account_holding | List all aggregation account holdings *atom_api.NucleusApi* | [**getAggregationAccountTransaction**](docs/NucleusApi.md#getAggregationAccountTransaction) | **GET** /nucleus/v1/aggregation_account_transaction/{aggregation_account_transaction_id} | Retrieve an aggregation account transaction *atom_api.NucleusApi* | [**getAggregationAccountTransactions**](docs/NucleusApi.md#getAggregationAccountTransactions) | **GET** /nucleus/v1/aggregation_account_transaction | List all aggregation account transactions *atom_api.NucleusApi* | [**getAggregationAccounts**](docs/NucleusApi.md#getAggregationAccounts) | **GET** /nucleus/v1/aggregation_account | List all aggregation accounts *atom_api.NucleusApi* | [**getAllocation**](docs/NucleusApi.md#getAllocation) | **GET** /nucleus/v1/allocation/{allocation_id} | Retrieve an allocation *atom_api.NucleusApi* | [**getAllocationAssetSizes**](docs/NucleusApi.md#getAllocationAssetSizes) | **GET** /nucleus/v1/allocation/{allocation_id}/asset_size | List all allocation asset sizes *atom_api.NucleusApi* | [**getAllocationComposition**](docs/NucleusApi.md#getAllocationComposition) | **GET** /nucleus/v1/allocation_composition/{allocation_composition_id} | Retrieve an allocation composition *atom_api.NucleusApi* | [**getAllocationCompositions**](docs/NucleusApi.md#getAllocationCompositions) | **GET** /nucleus/v1/allocation_composition | List all allocation compositions *atom_api.NucleusApi* | [**getAllocationHoldings**](docs/NucleusApi.md#getAllocationHoldings) | **GET** /nucleus/v1/allocation/{allocation_id}/holding | List all allocation holdings *atom_api.NucleusApi* | [**getAllocationPerformance**](docs/NucleusApi.md#getAllocationPerformance) | **GET** /nucleus/v1/allocation/{allocation_id}/performance | Get allocation performance *atom_api.NucleusApi* | [**getAllocationTransactions**](docs/NucleusApi.md#getAllocationTransactions) | **GET** /nucleus/v1/allocation/{allocation_id}/transaction | List all allocation transactions *atom_api.NucleusApi* | [**getAllocations**](docs/NucleusApi.md#getAllocations) | **GET** /nucleus/v1/allocation | List all allocations *atom_api.NucleusApi* | [**getBankLink**](docs/NucleusApi.md#getBankLink) | **GET** /nucleus/v1/bank_link/{bank_link_id} | Retrieve a bank link *atom_api.NucleusApi* | [**getBankLinks**](docs/NucleusApi.md#getBankLinks) | **GET** /nucleus/v1/bank_link | List all bank links *atom_api.NucleusApi* | [**getBenchmark**](docs/NucleusApi.md#getBenchmark) | **GET** /nucleus/v1/benchmark/{benchmark_id} | Retrieve a benchmark *atom_api.NucleusApi* | [**getBenchmarkAssetSizes**](docs/NucleusApi.md#getBenchmarkAssetSizes) | **GET** /nucleus/v1/benchmark/{benchmark_id}/asset_size | List all benchmark asset sizes *atom_api.NucleusApi* | [**getBenchmarkPerformance**](docs/NucleusApi.md#getBenchmarkPerformance) | **GET** /nucleus/v1/benchmark/{benchmark_id}/performance | Get benchmark performance *atom_api.NucleusApi* | [**getBenchmarks**](docs/NucleusApi.md#getBenchmarks) | **GET** /nucleus/v1/benchmark | List all benchmarks *atom_api.NucleusApi* | [**getBudget**](docs/NucleusApi.md#getBudget) | **GET** /nucleus/v1/budget/{budget_id} | Retrieve a budget *atom_api.NucleusApi* | [**getBudgets**](docs/NucleusApi.md#getBudgets) | **GET** /nucleus/v1/budget | List all budgets *atom_api.NucleusApi* | [**getBulkOrders**](docs/NucleusApi.md#getBulkOrders) | **GET** /nucleus/v1/order_bulk | List all bulk orders *atom_api.NucleusApi* | [**getClient**](docs/NucleusApi.md#getClient) | **GET** /nucleus/v1/client/{client_id} | Retrieve a client *atom_api.NucleusApi* | [**getClientAssetSizes**](docs/NucleusApi.md#getClientAssetSizes) | **GET** /nucleus/v1/client/{client_id}/asset_size | List all client asset sizes *atom_api.NucleusApi* | [**getClientHoldings**](docs/NucleusApi.md#getClientHoldings) | **GET** /nucleus/v1/client/{client_id}/holding | List all client holdings *atom_api.NucleusApi* | [**getClientHydro**](docs/NucleusApi.md#getClientHydro) | **GET** /nucleus/v1/client_hydro/{client_hydro_id} | Retrieve a client-hydro relationship *atom_api.NucleusApi* | [**getClientHydros**](docs/NucleusApi.md#getClientHydros) | **GET** /nucleus/v1/client_hydro | List all client-hydro relationships *atom_api.NucleusApi* | [**getClientPerformance**](docs/NucleusApi.md#getClientPerformance) | **GET** /nucleus/v1/client/{client_id}/performance | Get client performance *atom_api.NucleusApi* | [**getClientResponse**](docs/NucleusApi.md#getClientResponse) | **GET** /nucleus/v1/client_response/{client_response_id} | Retrieve a client response *atom_api.NucleusApi* | [**getClientResponses**](docs/NucleusApi.md#getClientResponses) | **GET** /nucleus/v1/client_response | List all client responses *atom_api.NucleusApi* | [**getClientTransactions**](docs/NucleusApi.md#getClientTransactions) | **GET** /nucleus/v1/client/{client_id}/transaction | List all client transactions *atom_api.NucleusApi* | [**getClients**](docs/NucleusApi.md#getClients) | **GET** /nucleus/v1/client | List all clients *atom_api.NucleusApi* | [**getDecisionTree**](docs/NucleusApi.md#getDecisionTree) | **GET** /nucleus/v1/decision_tree/{decision_tree_id} | Retrieve a decision tree *atom_api.NucleusApi* | [**getDecisionTrees**](docs/NucleusApi.md#getDecisionTrees) | **GET** /nucleus/v1/decision_tree | List all decision trees *atom_api.NucleusApi* | [**getDepositRequest**](docs/NucleusApi.md#getDepositRequest) | **GET** /nucleus/v1/deposit/{deposit_id} | Retrieve a deposit request *atom_api.NucleusApi* | [**getDepositRequests**](docs/NucleusApi.md#getDepositRequests) | **GET** /nucleus/v1/deposit | List all deposit requests *atom_api.NucleusApi* | [**getFinancialOffer**](docs/NucleusApi.md#getFinancialOffer) | **GET** /nucleus/v1/financial_offer/{financial_offer_id} | Retrieve a financial offer *atom_api.NucleusApi* | [**getFinancialOffers**](docs/NucleusApi.md#getFinancialOffers) | **GET** /nucleus/v1/financial_offer | List all financial offers *atom_api.NucleusApi* | [**getFundingRequest**](docs/NucleusApi.md#getFundingRequest) | **GET** /nucleus/v1/funding/{funding_id} | Retrieve a funding request *atom_api.NucleusApi* | [**getFundingRequests**](docs/NucleusApi.md#getFundingRequests) | **GET** /nucleus/v1/funding | List all funding requests *atom_api.NucleusApi* | [**getGoal**](docs/NucleusApi.md#getGoal) | **GET** /nucleus/v1/goal/{goal_id} | Retrieve a goal *atom_api.NucleusApi* | [**getGoalAssetSizes**](docs/NucleusApi.md#getGoalAssetSizes) | **GET** /nucleus/v1/goal/{goal_id}/asset_size | List goal asset sizes *atom_api.NucleusApi* | [**getGoalHoldings**](docs/NucleusApi.md#getGoalHoldings) | **GET** /goal/{goal_id}/holding | List goal holdings *atom_api.NucleusApi* | [**getGoalPerformance**](docs/NucleusApi.md#getGoalPerformance) | **GET** /nucleus/v1/goal/{goal_id}/performance | Get goal performance *atom_api.NucleusApi* | [**getGoalTrackRecord**](docs/NucleusApi.md#getGoalTrackRecord) | **GET** /nucleus/v1/goal_track/{goal_track_id} | Retrieve a goal track record *atom_api.NucleusApi* | [**getGoalTrackRecords**](docs/NucleusApi.md#getGoalTrackRecords) | **GET** /nucleus/v1/goal_track | List all goal track records *atom_api.NucleusApi* | [**getGoalTransactions**](docs/NucleusApi.md#getGoalTransactions) | **GET** /nucleus/v1/goal/{goal_id}/transaction | List goal transactions *atom_api.NucleusApi* | [**getGoals**](docs/NucleusApi.md#getGoals) | **GET** /nucleus/v1/goal | List all goals *atom_api.NucleusApi* | [**getModel**](docs/NucleusApi.md#getModel) | **GET** /nucleus/v1/model/{model_id} | Retrieve a model *atom_api.NucleusApi* | [**getModelAssetSize**](docs/NucleusApi.md#getModelAssetSize) | **GET** /nucleus/v1/model_asset_size/{model_asset_size_id} | Retrieve a model asset size *atom_api.NucleusApi* | [**getModelAssetSizes**](docs/NucleusApi.md#getModelAssetSizes) | **GET** /nucleus/v1/model_asset_size | List all model asset sizes *atom_api.NucleusApi* | [**getModelComment**](docs/NucleusApi.md#getModelComment) | **GET** /nucleus/v1/model_comment/{model_comment_id} | Retrieve a model commentary *atom_api.NucleusApi* | [**getModelComments**](docs/NucleusApi.md#getModelComments) | **GET** /nucleus/v1/model_comment | List all model commentary *atom_api.NucleusApi* | [**getModelHolding**](docs/NucleusApi.md#getModelHolding) | **GET** /nucleus/v1/model_holding/{model_holding_id} | Retrieve a model holding *atom_api.NucleusApi* | [**getModelHoldings**](docs/NucleusApi.md#getModelHoldings) | **GET** /nucleus/v1/model_holding | List all model holdings *atom_api.NucleusApi* | [**getModelPerformance**](docs/NucleusApi.md#getModelPerformance) | **GET** /nucleus/v1/model/{model_id}/performance | Get model performance *atom_api.NucleusApi* | [**getModelTransaction**](docs/NucleusApi.md#getModelTransaction) | **GET** /nucleus/v1/model_transaction/{model_transaction_id} | Retrieve a model transaction *atom_api.NucleusApi* | [**getModelTransactions**](docs/NucleusApi.md#getModelTransactions) | **GET** /nucleus/v1/model_transaction | List all model transactions *atom_api.NucleusApi* | [**getModels**](docs/NucleusApi.md#getModels) | **GET** /nucleus/v1/model | List all models *atom_api.NucleusApi* | [**getNode**](docs/NucleusApi.md#getNode) | **GET** /nucleus/v1/node/{node_id} | Retrieve a node *atom_api.NucleusApi* | [**getNodeRelationship**](docs/NucleusApi.md#getNodeRelationship) | **GET** /nucleus/v1/node_relationship/{node_relationship_id} | Retrieve a node relationship *atom_api.NucleusApi* | [**getNodeRelationships**](docs/NucleusApi.md#getNodeRelationships) | **GET** /nucleus/v1/node_relationship | List all node relationships *atom_api.NucleusApi* | [**getNodes**](docs/NucleusApi.md#getNodes) | **GET** /nucleus/v1/node | List all nodes *atom_api.NucleusApi* | [**getOrderRecord**](docs/NucleusApi.md#getOrderRecord) | **GET** /nucleus/v1/order/{order_id} | Retrieve an order record *atom_api.NucleusApi* | [**getOrderRecords**](docs/NucleusApi.md#getOrderRecords) | **GET** /nucleus/v1/order | List all order records *atom_api.NucleusApi* | [**getOrderStatus**](docs/NucleusApi.md#getOrderStatus) | **GET** /nucleus/v1/order_status/{order_status_id} | Retrieve an order status *atom_api.NucleusApi* | [**getOrderStatuses**](docs/NucleusApi.md#getOrderStatuses) | **GET** /nucleus/v1/order_status | List all order statuses *atom_api.NucleusApi* | [**getOrderTrackingRecord**](docs/NucleusApi.md#getOrderTrackingRecord) | **GET** /nucleus/v1/order_track/{order_track_id} | Retrieve an order tracking record *atom_api.NucleusApi* | [**getOrderTrackingRecords**](docs/NucleusApi.md#getOrderTrackingRecords) | **GET** /nucleus/v1/order_track | List all order tracking records *atom_api.NucleusApi* | [**getPortfolio**](docs/NucleusApi.md#getPortfolio) | **GET** /nucleus/v1/portfolio/{portfolio_id} | Retrieve a portfolio *atom_api.NucleusApi* | [**getPortfolioAssetSize**](docs/NucleusApi.md#getPortfolioAssetSize) | **GET** /nucleus/v1/portfolio_asset_size/{portfolio_asset_size_id} | Retrieve a portfolio asset size *atom_api.NucleusApi* | [**getPortfolioAssetSizes**](docs/NucleusApi.md#getPortfolioAssetSizes) | **GET** /nucleus/v1/portfolio_asset_size | List all portfolio asset sizes *atom_api.NucleusApi* | [**getPortfolioComment**](docs/NucleusApi.md#getPortfolioComment) | **GET** /nucleus/v1/portfolio_comment/{portfolio_comment_id} | Retrieve a portfolio commentary *atom_api.NucleusApi* | [**getPortfolioComments**](docs/NucleusApi.md#getPortfolioComments) | **GET** /nucleus/v1/portfolio_comment | List all portfolio commentary *atom_api.NucleusApi* | [**getPortfolioHolding**](docs/NucleusApi.md#getPortfolioHolding) | **GET** /nucleus/v1/portfolio_holding/{portfolio_holding_id} | Retrieve a portfolio holding *atom_api.NucleusApi* | [**getPortfolioHoldings**](docs/NucleusApi.md#getPortfolioHoldings) | **GET** /nucleus/v1/portfolio_holding | List all portfolio holdings *atom_api.NucleusApi* | [**getPortfolioPerformance**](docs/NucleusApi.md#getPortfolioPerformance) | **GET** /nucleus/v1/portfolio/{portfolio_id}/performance | Get portfolio performance *atom_api.NucleusApi* | [**getPortfolioTransaction**](docs/NucleusApi.md#getPortfolioTransaction) | **GET** /nucleus/v1/portfolio_transaction/{portfolio_transaction_id} | Retrieve a portfolio transaction *atom_api.NucleusApi* | [**getPortfolioTransactions**](docs/NucleusApi.md#getPortfolioTransactions) | **GET** /nucleus/v1/portfolio_transaction | List all portfolio transactions *atom_api.NucleusApi* | [**getPortfolios**](docs/NucleusApi.md#getPortfolios) | **GET** /nucleus/v1/portfolio | List all portfolios *atom_api.NucleusApi* | [**getQuestionnaire**](docs/NucleusApi.md#getQuestionnaire) | **GET** /nucleus/v1/questionnaire/{questionnaire_id} | Retrieve a questionnaire *atom_api.NucleusApi* | [**getQuestionnaires**](docs/NucleusApi.md#getQuestionnaires) | **GET** /nucleus/v1/questionnaire | List all questionnaires *atom_api.NucleusApi* | [**getScore**](docs/NucleusApi.md#getScore) | **GET** /nucleus/v1/score/{score_id} | Retrieve a score *atom_api.NucleusApi* | [**getScores**](docs/NucleusApi.md#getScores) | **GET** /nucleus/v1/score | List all scores *atom_api.NucleusApi* | [**getSecurities**](docs/NucleusApi.md#getSecurities) | **GET** /nucleus/v1/security | List all securities *atom_api.NucleusApi* | [**getSecurity**](docs/NucleusApi.md#getSecurity) | **GET** /nucleus/v1/security/{security_id} | Retrieve a security *atom_api.NucleusApi* | [**getSecurityExclusion**](docs/NucleusApi.md#getSecurityExclusion) | **GET** /nucleus/v1/security_exclusion/{security_exclusion_id} | Retrieve a security exclusion *atom_api.NucleusApi* | [**getSecurityExclusions**](docs/NucleusApi.md#getSecurityExclusions) | **GET** /nucleus/v1/security_exclusion | List all security exclusions *atom_api.NucleusApi* | [**getSecurityPerformance**](docs/NucleusApi.md#getSecurityPerformance) | **GET** /nucleus/v1/security/{security_id}/performance | Get security performance *atom_api.NucleusApi* | [**getSecurityPrice**](docs/NucleusApi.md#getSecurityPrice) | **GET** /nucleus/v1/security_price/{security_price_id} | Retrieve a security price *atom_api.NucleusApi* | [**getSecurityPrices**](docs/NucleusApi.md#getSecurityPrices) | **GET** /nucleus/v1/security_price | List all security prices *atom_api.NucleusApi* | [**getTransactionCode**](docs/NucleusApi.md#getTransactionCode) | **GET** /nucleus/v1/transaction_code/{transaction_code_id} | Retrieve a transaction code *atom_api.NucleusApi* | [**getTransactionCodes**](docs/NucleusApi.md#getTransactionCodes) | **GET** /nucleus/v1/transaction_code | List all transaction codes *atom_api.NucleusApi* | [**getTransferRequest**](docs/NucleusApi.md#getTransferRequest) | **GET** /nucleus/v1/transfer/{transfer_id} | Retrieve a transfer request *atom_api.NucleusApi* | [**getTransferRequests**](docs/NucleusApi.md#getTransferRequests) | **GET** /nucleus/v1/transfer | List all transfer requests *atom_api.NucleusApi* | [**getWithdrawalRequest**](docs/NucleusApi.md#getWithdrawalRequest) | **GET** /nucleus/v1/withdrawal/{withdrawal_id} | Retrieve a withdrawal request *atom_api.NucleusApi* | [**getWithdrawalRequests**](docs/NucleusApi.md#getWithdrawalRequests) | **GET** /nucleus/v1/withdrawal | List all withdrawal requests *atom_api.NucleusApi* | [**postAccount**](docs/NucleusApi.md#postAccount) | **POST** /nucleus/v1/account | Create an account under a client *atom_api.NucleusApi* | [**postAccountAllocation**](docs/NucleusApi.md#postAccountAllocation) | **POST** /nucleus/v1/account_allocation | Create an account allocation *atom_api.NucleusApi* | [**postAccountBulkOrder**](docs/NucleusApi.md#postAccountBulkOrder) | **POST** /nucleus/v1/account/{account_id}/order_bulk | Bulk orders for an account *atom_api.NucleusApi* | [**postAccountRebalanceBuyOnlyOrder**](docs/NucleusApi.md#postAccountRebalanceBuyOnlyOrder) | **POST** /nucleus/v1/account/{account_id}/order_buy_only | Create buy-only account rebalance orders *atom_api.NucleusApi* | [**postAccountRebalanceOrder**](docs/NucleusApi.md#postAccountRebalanceOrder) | **POST** /nucleus/v1/account/{account_id}/order_rebalance | Create account rebalance orders *atom_api.NucleusApi* | [**postAccountRebalanceSellOnlyOrder**](docs/NucleusApi.md#postAccountRebalanceSellOnlyOrder) | **POST** /nucleus/v1/account/{account_id}/order_sell_only | Create sell-only account rebalance orders *atom_api.NucleusApi* | [**postAccountSellAllOrder**](docs/NucleusApi.md#postAccountSellAllOrder) | **POST** /nucleus/v1/account/{account_id}/order_sell_all | Sell all account order *atom_api.NucleusApi* | [**postAccountStage**](docs/NucleusApi.md#postAccountStage) | **POST** /nucleus/v1/stage | Create an account stage *atom_api.NucleusApi* | [**postAccountStatus**](docs/NucleusApi.md#postAccountStatus) | **POST** /nucleus/v1/account_status | Create an account status *atom_api.NucleusApi* | [**postAccountType**](docs/NucleusApi.md#postAccountType) | **POST** /nucleus/v1/account_type | Create an account type *atom_api.NucleusApi* | [**postAggregationAccount**](docs/NucleusApi.md#postAggregationAccount) | **POST** /nucleus/v1/aggregation_account | Create an aggregation account *atom_api.NucleusApi* | [**postAggregationAccountBalance**](docs/NucleusApi.md#postAggregationAccountBalance) | **POST** /nucleus/v1/aggregation_account_balance | Create an aggregation account balance *atom_api.NucleusApi* | [**postAggregationAccountHolding**](docs/NucleusApi.md#postAggregationAccountHolding) | **POST** /nucleus/v1/aggregation_account_holding | Create an aggregation account holding *atom_api.NucleusApi* | [**postAggregationAccountTransaction**](docs/NucleusApi.md#postAggregationAccountTransaction) | **POST** /nucleus/v1/aggregation_account_transaction | Create an aggregation account transaction *atom_api.NucleusApi* | [**postAllocation**](docs/NucleusApi.md#postAllocation) | **POST** /nucleus/v1/allocation | Create an allocation *atom_api.NucleusApi* | [**postAllocationComposition**](docs/NucleusApi.md#postAllocationComposition) | **POST** /nucleus/v1/allocation_composition | Create an allocation composition *atom_api.NucleusApi* | [**postBankLink**](docs/NucleusApi.md#postBankLink) | **POST** /nucleus/v1/bank_link | Create a bank link *atom_api.NucleusApi* | [**postBenchmark**](docs/NucleusApi.md#postBenchmark) | **POST** /nucleus/v1/benchmark | Create a benchmark *atom_api.NucleusApi* | [**postBudget**](docs/NucleusApi.md#postBudget) | **POST** /nucleus/v1/budget | Create a budget *atom_api.NucleusApi* | [**postBulkOrder**](docs/NucleusApi.md#postBulkOrder) | **POST** /nucleus/v1/order_bulk | Bulk orders for your firm *atom_api.NucleusApi* | [**postClient**](docs/NucleusApi.md#postClient) | **POST** /nucleus/v1/client | Create a client *atom_api.NucleusApi* | [**postClientBulkOrder**](docs/NucleusApi.md#postClientBulkOrder) | **POST** /nucleus/v1/client/{client_id}/order_bulk | Bulk orders for a client *atom_api.NucleusApi* | [**postClientHydro**](docs/NucleusApi.md#postClientHydro) | **POST** /nucleus/v1/client_hydro | Create a client-hydro relationship *atom_api.NucleusApi* | [**postClientResponse**](docs/NucleusApi.md#postClientResponse) | **POST** /nucleus/v1/client_response | Create a client response *atom_api.NucleusApi* | [**postDecisionTree**](docs/NucleusApi.md#postDecisionTree) | **POST** /nucleus/v1/decision_tree | Create a decision tree *atom_api.NucleusApi* | [**postDepositRequest**](docs/NucleusApi.md#postDepositRequest) | **POST** /nucleus/v1/deposit | Create a deposit request *atom_api.NucleusApi* | [**postFinancialOffer**](docs/NucleusApi.md#postFinancialOffer) | **POST** /nucleus/v1/financial_offer | Create a financial offer *atom_api.NucleusApi* | [**postFundingRequest**](docs/NucleusApi.md#postFundingRequest) | **POST** /nucleus/v1/funding | Create a funding request *atom_api.NucleusApi* | [**postGoal**](docs/NucleusApi.md#postGoal) | **POST** /nucleus/v1/goal | Create a goal *atom_api.NucleusApi* | [**postGoalTrackRecord**](docs/NucleusApi.md#postGoalTrackRecord) | **POST** /nucleus/v1/goal_track | Create a goal track record *atom_api.NucleusApi* | [**postModel**](docs/NucleusApi.md#postModel) | **POST** /nucleus/v1/model | Create a model *atom_api.NucleusApi* | [**postModelAssetSize**](docs/NucleusApi.md#postModelAssetSize) | **POST** /nucleus/v1/model_asset_size | Create a model asset size *atom_api.NucleusApi* | [**postModelComment**](docs/NucleusApi.md#postModelComment) | **POST** /nucleus/v1/model_comment | Create a model commentary *atom_api.NucleusApi* | [**postModelHolding**](docs/NucleusApi.md#postModelHolding) | **POST** /nucleus/v1/model_holding | Create a model holding *atom_api.NucleusApi* | [**postModelTransaction**](docs/NucleusApi.md#postModelTransaction) | **POST** /nucleus/v1/model_transaction | Create a model transaction *atom_api.NucleusApi* | [**postNode**](docs/NucleusApi.md#postNode) | **POST** /nucleus/v1/node | Create a node *atom_api.NucleusApi* | [**postNodeRelationship**](docs/NucleusApi.md#postNodeRelationship) | **POST** /nucleus/v1/node_relationship | Create a node relationship *atom_api.NucleusApi* | [**postOrderRecord**](docs/NucleusApi.md#postOrderRecord) | **POST** /nucleus/v1/order | Create an order record *atom_api.NucleusApi* | [**postOrderStatus**](docs/NucleusApi.md#postOrderStatus) | **POST** /nucleus/v1/order_status | Create an order status *atom_api.NucleusApi* | [**postOrderTrackingRecord**](docs/NucleusApi.md#postOrderTrackingRecord) | **POST** /nucleus/v1/order_track | Create an order tracking record *atom_api.NucleusApi* | [**postPortfolio**](docs/NucleusApi.md#postPortfolio) | **POST** /nucleus/v1/portfolio | Create a portfolio *atom_api.NucleusApi* | [**postPortfolioAssetSize**](docs/NucleusApi.md#postPortfolioAssetSize) | **POST** /nucleus/v1/portfolio_asset_size | Create a portfolio asset size *atom_api.NucleusApi* | [**postPortfolioComment**](docs/NucleusApi.md#postPortfolioComment) | **POST** /nucleus/v1/portfolio_comment | Create a portfolio commentary *atom_api.NucleusApi* | [**postPortfolioHolding**](docs/NucleusApi.md#postPortfolioHolding) | **POST** /nucleus/v1/portfolio_holding | Create a portfolio holding *atom_api.NucleusApi* | [**postPortfolioRebalanceBuyOnlyOrder**](docs/NucleusApi.md#postPortfolioRebalanceBuyOnlyOrder) | **POST** /nucleus/v1/portfolio/{portfolio_id}/order_buy_only | Create buy-only portfolio rebalance orders *atom_api.NucleusApi* | [**postPortfolioRebalanceOrder**](docs/NucleusApi.md#postPortfolioRebalanceOrder) | **POST** /nucleus/v1/portfolio/{portfolio_id}/order_rebalance | Create portfolio rebalance orders *atom_api.NucleusApi* | [**postPortfolioRebalanceSellOnlyOrder**](docs/NucleusApi.md#postPortfolioRebalanceSellOnlyOrder) | **POST** /nucleus/v1/portfolio/{portfolio_id}/order_sell_only | Create sell-only portfolio rebalance orders *atom_api.NucleusApi* | [**postPortfolioSellAllOrder**](docs/NucleusApi.md#postPortfolioSellAllOrder) | **POST** /nucleus/v1/portfolio/{portfolio_id}/order_sell_all | Sell all portfolio order *atom_api.NucleusApi* | [**postPortfolioTransaction**](docs/NucleusApi.md#postPortfolioTransaction) | **POST** /nucleus/v1/portfolio_transaction | Create a portfolio transaction *atom_api.NucleusApi* | [**postQuestionnaire**](docs/NucleusApi.md#postQuestionnaire) | **POST** /nucleus/v1/questionnaire | Create a questionnaire *atom_api.NucleusApi* | [**postScore**](docs/NucleusApi.md#postScore) | **POST** /nucleus/v1/score | Create a score *atom_api.NucleusApi* | [**postSecurity**](docs/NucleusApi.md#postSecurity) | **POST** /nucleus/v1/security | Create a security *atom_api.NucleusApi* | [**postSecurityExclusion**](docs/NucleusApi.md#postSecurityExclusion) | **POST** /nucleus/v1/security_exclusion | Create a security exclusion *atom_api.NucleusApi* | [**postSecurityPrice**](docs/NucleusApi.md#postSecurityPrice) | **POST** /nucleus/v1/security_price | Create a security price *atom_api.NucleusApi* | [**postTransactionCode**](docs/NucleusApi.md#postTransactionCode) | **POST** /nucleus/v1/transaction_code | Create a transaction code *atom_api.NucleusApi* | [**postTransferRequest**](docs/NucleusApi.md#postTransferRequest) | **POST** /nucleus/v1/transfer | Create a transfer request *atom_api.NucleusApi* | [**postWithdrawalRequest**](docs/NucleusApi.md#postWithdrawalRequest) | **POST** /nucleus/v1/withdrawal | Create a withdrawal request *atom_api.NucleusApi* | [**subscribeAccount**](docs/NucleusApi.md#subscribeAccount) | **POST** /nucleus/v1/account/{account_id}/subscribe | Subscribe an account *atom_api.NucleusApi* | [**updateAccount**](docs/NucleusApi.md#updateAccount) | **PUT** /nucleus/v1/account/{account_id}/ | Update an account *atom_api.NucleusApi* | [**updateAccountAllocation**](docs/NucleusApi.md#updateAccountAllocation) | **PUT** /nucleus/v1/account_allocation/{account_allocation_id} | Update an account allocation *atom_api.NucleusApi* | [**updateAccountPermission**](docs/NucleusApi.md#updateAccountPermission) | **PUT** /nucleus/v1/account_permission/{account_id} | Update an account's permissions *atom_api.NucleusApi* | [**updateAccountStage**](docs/NucleusApi.md#updateAccountStage) | **PUT** /nucleus/v1/stage/{stage_id} | Update an account stage *atom_api.NucleusApi* | [**updateAccountStatus**](docs/NucleusApi.md#updateAccountStatus) | **PUT** /nucleus/v1/account_status/{account_status_id} | Update an account status *atom_api.NucleusApi* | [**updateAccountType**](docs/NucleusApi.md#updateAccountType) | **PUT** /nucleus/v1/account_type/{account_type_id} | Update an account type *atom_api.NucleusApi* | [**updateAggregationAccount**](docs/NucleusApi.md#updateAggregationAccount) | **PUT** /nucleus/v1/aggregation_account/{aggregation_account_id} | Update an aggregation account *atom_api.NucleusApi* | [**updateAggregationAccountBalance**](docs/NucleusApi.md#updateAggregationAccountBalance) | **PUT** /nucleus/v1/aggregation_account_balance/{aggregation_account_balance_id} | Update an aggregation account balance *atom_api.NucleusApi* | [**updateAggregationAccountHolding**](docs/NucleusApi.md#updateAggregationAccountHolding) | **PUT** /nucleus/v1/aggregation_account_holding/{aggregation_account_holding_id} | Update an aggregation account holding *atom_api.NucleusApi* | [**updateAggregationAccountTransaction**](docs/NucleusApi.md#updateAggregationAccountTransaction) | **PUT** /nucleus/v1/aggregation_account_transaction/{aggregation_account_transaction_id} | Update an aggregation account transaction *atom_api.NucleusApi* | [**updateAllocation**](docs/NucleusApi.md#updateAllocation) | **PUT** /nucleus/v1/allocation/{allocation_id} | Update an allocation *atom_api.NucleusApi* | [**updateAllocationComposition**](docs/NucleusApi.md#updateAllocationComposition) | **PUT** /nucleus/v1/allocation_composition/{allocation_composition_id} | Update an allocation composition *atom_api.NucleusApi* | [**updateBankLink**](docs/NucleusApi.md#updateBankLink) | **PUT** /nucleus/v1/bank_link/{bank_link_id} | Update a bank link *atom_api.NucleusApi* | [**updateBenchmark**](docs/NucleusApi.md#updateBenchmark) | **PUT** /nucleus/v1/benchmark/{benchmark_id} | Update a benchmark *atom_api.NucleusApi* | [**updateBudget**](docs/NucleusApi.md#updateBudget) | **PUT** /nucleus/v1/budget/{budget_id} | Update a budget *atom_api.NucleusApi* | [**updateClient**](docs/NucleusApi.md#updateClient) | **PUT** /nucleus/v1/client/{client_id} | Update a client *atom_api.NucleusApi* | [**updateClientHydro**](docs/NucleusApi.md#updateClientHydro) | **PUT** /nucleus/v1/client_hydro/{client_hydro_id} | Update a client-hydro relationship *atom_api.NucleusApi* | [**updateClientResponse**](docs/NucleusApi.md#updateClientResponse) | **PUT** /nucleus/v1/client_response/{client_response_id} | Update a client response *atom_api.NucleusApi* | [**updateDecisionTree**](docs/NucleusApi.md#updateDecisionTree) | **PUT** /nucleus/v1/decision_tree/{decision_tree_id} | Update a decision tree *atom_api.NucleusApi* | [**updateDepositRequest**](docs/NucleusApi.md#updateDepositRequest) | **PUT** /nucleus/v1/deposit/{deposit_id} | Update a deposit request *atom_api.NucleusApi* | [**updateFinancialOffer**](docs/NucleusApi.md#updateFinancialOffer) | **PUT** /nucleus/v1/financial_offer/{financial_offer_id} | Update a financial offer *atom_api.NucleusApi* | [**updateFundingRequest**](docs/NucleusApi.md#updateFundingRequest) | **PUT** /nucleus/v1/funding/{funding_id} | Update a funding request *atom_api.NucleusApi* | [**updateGoal**](docs/NucleusApi.md#updateGoal) | **PUT** /nucleus/v1/goal/{goal_id} | Update a goal *atom_api.NucleusApi* | [**updateGoalTrackRecord**](docs/NucleusApi.md#updateGoalTrackRecord) | **PUT** /nucleus/v1/goal_track/{goal_track_id} | Update a goal track record *atom_api.NucleusApi* | [**updateModel**](docs/NucleusApi.md#updateModel) | **PUT** /nucleus/v1/model/{model_id} | Update a model *atom_api.NucleusApi* | [**updateModelAssetSize**](docs/NucleusApi.md#updateModelAssetSize) | **PUT** /nucleus/v1/model_asset_size/{model_asset_size_id} | Update a model asset size *atom_api.NucleusApi* | [**updateModelComment**](docs/NucleusApi.md#updateModelComment) | **PUT** /nucleus/v1/model_comment/{model_comment_id} | Update a model commentary *atom_api.NucleusApi* | [**updateModelComposition**](docs/NucleusApi.md#updateModelComposition) | **POST** /nucleus/v1/model/{model_id}/model_change | Change a model composition *atom_api.NucleusApi* | [**updateModelHolding**](docs/NucleusApi.md#updateModelHolding) | **PUT** /nucleus/v1/model_holding/{model_holding_id} | Update a model holding *atom_api.NucleusApi* | [**updateModelTransaction**](docs/NucleusApi.md#updateModelTransaction) | **PUT** /nucleus/v1/model_transaction/{model_transaction_id} | Update a model transaction *atom_api.NucleusApi* | [**updateNode**](docs/NucleusApi.md#updateNode) | **PUT** /nucleus/v1/node/{node_id} | Update a node *atom_api.NucleusApi* | [**updateNodeRelationship**](docs/NucleusApi.md#updateNodeRelationship) | **PUT** /nucleus/v1/node_relationship/{node_relationship_id} | Update a node relationship *atom_api.NucleusApi* | [**updateOrderRecord**](docs/NucleusApi.md#updateOrderRecord) | **PUT** /nucleus/v1/order/{order_id} | Update an order record *atom_api.NucleusApi* | [**updateOrderStatus**](docs/NucleusApi.md#updateOrderStatus) | **PUT** /nucleus/v1/order_status/{order_status_id} | Update an order status *atom_api.NucleusApi* | [**updateOrderTrackingRecord**](docs/NucleusApi.md#updateOrderTrackingRecord) | **PUT** /nucleus/v1/order_track/{order_track_id} | Update an order tracking record *atom_api.NucleusApi* | [**updatePortfolio**](docs/NucleusApi.md#updatePortfolio) | **PUT** /nucleus/v1/portfolio/{portfolio_id} | Update a portfolio *atom_api.NucleusApi* | [**updatePortfolioAssetSize**](docs/NucleusApi.md#updatePortfolioAssetSize) | **PUT** /nucleus/v1/portfolio_asset_size/{portfolio_asset_size_id} | Update a portfolio asset size *atom_api.NucleusApi* | [**updatePortfolioComment**](docs/NucleusApi.md#updatePortfolioComment) | **PUT** /nucleus/v1/portfolio_comment/{portfolio_comment_id} | Update a portfolio commentary *atom_api.NucleusApi* | [**updatePortfolioHolding**](docs/NucleusApi.md#updatePortfolioHolding) | **PUT** /nucleus/v1/portfolio_holding/{portfolio_holding_id} | Update a portfolio holding *atom_api.NucleusApi* | [**updatePortfolioTransaction**](docs/NucleusApi.md#updatePortfolioTransaction) | **PUT** /nucleus/v1/portfolio_transaction/{portfolio_transaction_id} | Update a portfolio transaction *atom_api.NucleusApi* | [**updateQuestionnaire**](docs/NucleusApi.md#updateQuestionnaire) | **PUT** /nucleus/v1/questionnaire/{questionnaire_id} | Update a questionnaire *atom_api.NucleusApi* | [**updateScore**](docs/NucleusApi.md#updateScore) | **PUT** /nucleus/v1/score/{score_id} | Update a score *atom_api.NucleusApi* | [**updateSecurity**](docs/NucleusApi.md#updateSecurity) | **PUT** /nucleus/v1/security/{security_id} | Update a security *atom_api.NucleusApi* | [**updateSecurityExclusion**](docs/NucleusApi.md#updateSecurityExclusion) | **PUT** /nucleus/v1/security_exclusion/{security_exclusion_id} | Update a security exclusion *atom_api.NucleusApi* | [**updateSecurityPrice**](docs/NucleusApi.md#updateSecurityPrice) | **PUT** /nucleus/v1/security_price/{security_price_id} | Update a security price *atom_api.NucleusApi* | [**updateTransactionCode**](docs/NucleusApi.md#updateTransactionCode) | **PUT** /nucleus/v1/transaction_code/{transaction_code_id} | Update a transaction code *atom_api.NucleusApi* | [**updateTransferRequest**](docs/NucleusApi.md#updateTransferRequest) | **PUT** /nucleus/v1/transfer/{transfer_id} | Update a transfer request *atom_api.NucleusApi* | [**updateWithdrawalRequest**](docs/NucleusApi.md#updateWithdrawalRequest) | **PUT** /nucleus/v1/withdrawal/{withdrawal_id} | Update a withdrawal request *atom_api.ProtonApi* | [**annuityCalculatorAccumulationHorizon**](docs/ProtonApi.md#annuityCalculatorAccumulationHorizon) | **POST** /proton/v1/annuity_calculator/accumulation_horizon | Annuity calculator - accumulation horizon *atom_api.ProtonApi* | [**annuityCalculatorAnnuityAmount**](docs/ProtonApi.md#annuityCalculatorAnnuityAmount) | **POST** /proton/v1/annuity_calculator/annuity_amount | Annuity calculator - annuity amount *atom_api.ProtonApi* | [**annuityCalculatorDecumulationHorizon**](docs/ProtonApi.md#annuityCalculatorDecumulationHorizon) | **POST** /proton/v1/annuity_calculator/decumulation_horizon | Annuity calculator - decumulation horizon *atom_api.ProtonApi* | [**annuityCalculatorDepositAmount**](docs/ProtonApi.md#annuityCalculatorDepositAmount) | **POST** /proton/v1/annuity_calculator/deposit_amount | Annuity calculator - deposit amount *atom_api.ProtonApi* | [**annuityCalculatorInitialBalance**](docs/ProtonApi.md#annuityCalculatorInitialBalance) | **POST** /proton/v1/annuity_calculator/initial_balance | Annuity calculator - initial balance *atom_api.ProtonApi* | [**budgetCalculator**](docs/ProtonApi.md#budgetCalculator) | **POST** /proton/v1/budget_calculator | Budget Calculator *atom_api.ProtonApi* | [**cashFlowAnalysis**](docs/ProtonApi.md#cashFlowAnalysis) | **POST** /proton/v1/cash_flow_analysis | Cash Flow Analysis *atom_api.ProtonApi* | [**dimensionalRiskScore**](docs/ProtonApi.md#dimensionalRiskScore) | **POST** /proton/v1/dimensional_risk_score | Dimensional risk score *atom_api.ProtonApi* | [**educationCalculatorAnnualCost**](docs/ProtonApi.md#educationCalculatorAnnualCost) | **POST** /proton/v1/education_calculator/annual_cost | Education calculator - total annual cost *atom_api.ProtonApi* | [**educationCalculatorDepositAmount**](docs/ProtonApi.md#educationCalculatorDepositAmount) | **POST** /proton/v1/education_calculator/deposit_amount | Education calculator - deposit amount *atom_api.ProtonApi* | [**educationCalculatorPercentCovered**](docs/ProtonApi.md#educationCalculatorPercentCovered) | **POST** /proton/v1/education_calculator/percent_covered | Education calculator - percent covered *atom_api.ProtonApi* | [**emergencyFundCalculator**](docs/ProtonApi.md#emergencyFundCalculator) | **POST** /proton/v1/emergency_fund_calculator | Emergency fund calculator *atom_api.ProtonApi* | [**eventStudy**](docs/ProtonApi.md#eventStudy) | **POST** /proton/v1/event_study | Event study *atom_api.ProtonApi* | [**financialHealthCheck**](docs/ProtonApi.md#financialHealthCheck) | **POST** /proton/v1/financial_health_check | Financial health check *atom_api.ProtonApi* | [**financialPicture**](docs/ProtonApi.md#financialPicture) | **POST** /proton/v1/financial_picture | Financial Picture *atom_api.ProtonApi* | [**goalAccumulationAllocation**](docs/ProtonApi.md#goalAccumulationAllocation) | **POST** /proton/v1/goal_accumulation/allocation | Goal accumulation allocation *atom_api.ProtonApi* | [**goalAccumulationRecommendation**](docs/ProtonApi.md#goalAccumulationRecommendation) | **POST** /proton/v1/goal_accumulation/recommendation | Goal accumulation recommendation *atom_api.ProtonApi* | [**goalAccumulationStatus**](docs/ProtonApi.md#goalAccumulationStatus) | **POST** /proton/v1/goal_accumulation/status | Goal accumulation status *atom_api.ProtonApi* | [**goalDecumulationAllocation**](docs/ProtonApi.md#goalDecumulationAllocation) | **POST** /proton/v1/goal_decumulation/allocation | Goal decumulation allocation *atom_api.ProtonApi* | [**goalDecumulationRecommendation**](docs/ProtonApi.md#goalDecumulationRecommendation) | **POST** /proton/v1/goal_decumulation/recommendation | Goal decumulation recommendation *atom_api.ProtonApi* | [**goalDecumulationStatus**](docs/ProtonApi.md#goalDecumulationStatus) | **POST** /proton/v1/goal_decumulation/status | Goal decumulation status *atom_api.ProtonApi* | [**lifeInsuranceNeedsCalculator**](docs/ProtonApi.md#lifeInsuranceNeedsCalculator) | **POST** /proton/v1/life_insurance/needs_calculator | Life insurance needs calculator *atom_api.ProtonApi* | [**modelBacktest**](docs/ProtonApi.md#modelBacktest) | **POST** /proton/v1/backtest | Model backtest *atom_api.ProtonApi* | [**monteCarlo**](docs/ProtonApi.md#monteCarlo) | **POST** /proton/v1/monte_carlo | Monte Carlo *atom_api.ProtonApi* | [**mortgageCalculatorDownPayment**](docs/ProtonApi.md#mortgageCalculatorDownPayment) | **POST** /proton/v1/mortgage_calculator/down_payment | Mortgage calculator - down payment *atom_api.ProtonApi* | [**mortgageCalculatorHomePrice**](docs/ProtonApi.md#mortgageCalculatorHomePrice) | **POST** /proton/v1/mortgage_calculator/home_price | Mortgage calculator - home price *atom_api.ProtonApi* | [**mortgageCalculatorPeriodicPayment**](docs/ProtonApi.md#mortgageCalculatorPeriodicPayment) | **POST** /proton/v1/mortgage_calculator/periodic_payment | Mortgage calculator - periodic payment *atom_api.ProtonApi* | [**mvo**](docs/ProtonApi.md#mvo) | **POST** /proton/v1/mvo | Mean-variance optimization *atom_api.ProtonApi* | [**portfolioDiversificationScore**](docs/ProtonApi.md#portfolioDiversificationScore) | **POST** /proton/v1/diversification_score | Portfolio diversification score *atom_api.ProtonApi* | [**portfolioOptimizationScore**](docs/ProtonApi.md#portfolioOptimizationScore) | **POST** /proton/v1/portfolio_optimization_score | Portfolio optimization score *atom_api.ProtonApi* | [**portfolioWhatIf**](docs/ProtonApi.md#portfolioWhatIf) | **POST** /proton/v1/portfolio_what_if | Portfolio what-if *atom_api.ProtonApi* | [**purchaseCalculatorDepositAmount**](docs/ProtonApi.md#purchaseCalculatorDepositAmount) | **POST** /proton/v1/purchase_calculator/deposit_amount | Purchase calculator - deposit amount *atom_api.ProtonApi* | [**purchaseCalculatorHorizon**](docs/ProtonApi.md#purchaseCalculatorHorizon) | **POST** /proton/v1/purchase_calculator/horizon | Purchase calculator - horizon *atom_api.ProtonApi* | [**purchaseCalculatorPurchaseAmount**](docs/ProtonApi.md#purchaseCalculatorPurchaseAmount) | **POST** /proton/v1/purchase_calculator/amount | Purchase calculator - purchase amount *atom_api.ProtonApi* | [**rebalancingSignal**](docs/ProtonApi.md#rebalancingSignal) | **POST** /proton/v1/rebalancing_signal | Rebalancing *atom_api.ProtonApi* | [**retirementCalculatorDepositAmount**](docs/ProtonApi.md#retirementCalculatorDepositAmount) | **POST** /proton/v1/retirement_calculator/deposit_amount | Retirement calculator - deposit amount *atom_api.ProtonApi* | [**retirementCalculatorExpenses**](docs/ProtonApi.md#retirementCalculatorExpenses) | **POST** /proton/v1/retirement_calculator/expenses | Retirement calculator - expenses *atom_api.ProtonApi* | [**retirementCalculatorPercentCovered**](docs/ProtonApi.md#retirementCalculatorPercentCovered) | **POST** /proton/v1/retirement_calculator/percent_covered | Retirement calculator - percent of costs covered *atom_api.ProtonApi* | [**riskAllocation**](docs/ProtonApi.md#riskAllocation) | **POST** /proton/v1/risk_allocation | Risk allocation *atom_api.ProtonApi* | [**riskScore**](docs/ProtonApi.md#riskScore) | **POST** /proton/v1/risk_score | Risk score *atom_api.ProtonApi* | [**savingsCalculator**](docs/ProtonApi.md#savingsCalculator) | **POST** /proton/v1/savings_calculator | Savings calculator *atom_api.ProtonApi* | [**scenarioAnalysis**](docs/ProtonApi.md#scenarioAnalysis) | **POST** /proton/v1/scenario_analysis | Scenario analysis *atom_api.ProtonApi* | [**sensitivityAnalysis**](docs/ProtonApi.md#sensitivityAnalysis) | **POST** /proton/v1/sensitivity_analysis | Sensitivity analysis *atom_api.ProtonApi* | [**variableAnnuity**](docs/ProtonApi.md#variableAnnuity) | **POST** /proton/v1/variable_annuity | Variable annuity ## Documentation for Models - [atom_api.AccountAllocationPayload](docs/AccountAllocationPayload.md) - [atom_api.AccountCreateClient](docs/AccountCreateClient.md) - [atom_api.AccountCreateGoal](docs/AccountCreateGoal.md) - [atom_api.AccountCreatePayload](docs/AccountCreatePayload.md) - [atom_api.AccountPermissionClientsPayload](docs/AccountPermissionClientsPayload.md) - [atom_api.AccountPermissionPayload](docs/AccountPermissionPayload.md) - [atom_api.AccountRebalanceBuyOnlyOrderPayload](docs/AccountRebalanceBuyOnlyOrderPayload.md) - [atom_api.AccountRebalanceOrderPayload](docs/AccountRebalanceOrderPayload.md) - [atom_api.AccountRebalanceSellOnlyOrderPayload](docs/AccountRebalanceSellOnlyOrderPayload.md) - [atom_api.AccountStagePayload](docs/AccountStagePayload.md) - [atom_api.AccountStatusPayload](docs/AccountStatusPayload.md) - [atom_api.AccountSubscribePayload](docs/AccountSubscribePayload.md) - [atom_api.AccountSubscribePayloadInner](docs/AccountSubscribePayloadInner.md) - [atom_api.AccountTransactionResponseContent](docs/AccountTransactionResponseContent.md) - [atom_api.AccountTypePayload](docs/AccountTypePayload.md) - [atom_api.Address](docs/Address.md) - [atom_api.AggregationAccountBalancePayload](docs/AggregationAccountBalancePayload.md) - [atom_api.AggregationAccountHoldingPayload](docs/AggregationAccountHoldingPayload.md) - [atom_api.AggregationAccountPayload](docs/AggregationAccountPayload.md) - [atom_api.AggregationAccountTransactionPayload](docs/AggregationAccountTransactionPayload.md) - [atom_api.AggregationAccountTransactionPayloadBankCredit](docs/AggregationAccountTransactionPayloadBankCredit.md) - [atom_api.AggregationAccountTransactionPayloadInvestment](docs/AggregationAccountTransactionPayloadInvestment.md) - [atom_api.AllocationAssetSizeResponse](docs/AllocationAssetSizeResponse.md) - [atom_api.AllocationAssetSizeResponseInner](docs/AllocationAssetSizeResponseInner.md) - [atom_api.AllocationCompositionPayload](docs/AllocationCompositionPayload.md) - [atom_api.AllocationHoldingsResponse](docs/AllocationHoldingsResponse.md) - [atom_api.AllocationHoldingsResponseInner](docs/AllocationHoldingsResponseInner.md) - [atom_api.AllocationPayload](docs/AllocationPayload.md) - [atom_api.AllocationTransactionResponseContent](docs/AllocationTransactionResponseContent.md) - [atom_api.AnnuityAccumulationResponse](docs/AnnuityAccumulationResponse.md) - [atom_api.AnnuityAmountResponse](docs/AnnuityAmountResponse.md) - [atom_api.AnnuityCalculatorAccumulationHorizon](docs/AnnuityCalculatorAccumulationHorizon.md) - [atom_api.AnnuityCalculatorAnnuityAmount](docs/AnnuityCalculatorAnnuityAmount.md) - [atom_api.AnnuityCalculatorDecumulationHorizon](docs/AnnuityCalculatorDecumulationHorizon.md) - [atom_api.AnnuityCalculatorDepositAmount](docs/AnnuityCalculatorDepositAmount.md) - [atom_api.AnnuityCalculatorInitialBalance](docs/AnnuityCalculatorInitialBalance.md) - [atom_api.AnnuityDecumulationResponse](docs/AnnuityDecumulationResponse.md) - [atom_api.AnnuityDepositSchedule](docs/AnnuityDepositSchedule.md) - [atom_api.AnnuityDepositamountResponse](docs/AnnuityDepositamountResponse.md) - [atom_api.AnnuityHorizon](docs/AnnuityHorizon.md) - [atom_api.AnnuityInitialbalanceResponse](docs/AnnuityInitialbalanceResponse.md) - [atom_api.AnnuityReturnDetail](docs/AnnuityReturnDetail.md) - [atom_api.Backtest](docs/Backtest.md) - [atom_api.BacktestResponse](docs/BacktestResponse.md) - [atom_api.BankLinkPayload](docs/BankLinkPayload.md) - [atom_api.BenchmarkAssetSizeResponse](docs/BenchmarkAssetSizeResponse.md) - [atom_api.BenchmarkAssetSizeResponseInner](docs/BenchmarkAssetSizeResponseInner.md) - [atom_api.BenchmarkPayload](docs/BenchmarkPayload.md) - [atom_api.BenchmarkPayloadComposition](docs/BenchmarkPayloadComposition.md) - [atom_api.BeneficiaryBequestConfig](docs/BeneficiaryBequestConfig.md) - [atom_api.BudgetCalculatorPayload](docs/BudgetCalculatorPayload.md) - [atom_api.BudgetCalculatorResponse](docs/BudgetCalculatorResponse.md) - [atom_api.BudgetCalculatorResponseBudgetComponents](docs/BudgetCalculatorResponseBudgetComponents.md) - [atom_api.BudgetCalculatorResponseBudgetTrack](docs/BudgetCalculatorResponseBudgetTrack.md) - [atom_api.BudgetPayload](docs/BudgetPayload.md) - [atom_api.BudgetPayloadAggregationAccounts](docs/BudgetPayloadAggregationAccounts.md) - [atom_api.BudgetPayloadBudget](docs/BudgetPayloadBudget.md) - [atom_api.BulkOrderAccountPayload](docs/BulkOrderAccountPayload.md) - [atom_api.BulkOrderClientPayload](docs/BulkOrderClientPayload.md) - [atom_api.BulkOrderFirmPayload](docs/BulkOrderFirmPayload.md) - [atom_api.BulkOrderFirmclientaccountResponse](docs/BulkOrderFirmclientaccountResponse.md) - [atom_api.CampaignDataPayload](docs/CampaignDataPayload.md) - [atom_api.CampaignManagementPayload](docs/CampaignManagementPayload.md) - [atom_api.CampaignPlanPayload](docs/CampaignPlanPayload.md) - [atom_api.CampaignPlanPayloadPlanRates](docs/CampaignPlanPayloadPlanRates.md) - [atom_api.CashFlowAnalysisPayload](docs/CashFlowAnalysisPayload.md) - [atom_api.CashFlowAnalysisResponse](docs/CashFlowAnalysisResponse.md) - [atom_api.CashFlowAnalysisResponseHistory](docs/CashFlowAnalysisResponseHistory.md) - [atom_api.CashFlowAnalysisResponseIncomeSummary](docs/CashFlowAnalysisResponseIncomeSummary.md) - [atom_api.CashFlowAnalysisResponseIncomeSummaryChange](docs/CashFlowAnalysisResponseIncomeSummaryChange.md) - [atom_api.CashFlowAnalysisResponseNetSummary](docs/CashFlowAnalysisResponseNetSummary.md) - [atom_api.CashFlowAnalysisResponseNetSummaryChange](docs/CashFlowAnalysisResponseNetSummaryChange.md) - [atom_api.CashFlowAnalysisResponseSpendingDetails](docs/CashFlowAnalysisResponseSpendingDetails.md) - [atom_api.CashFlowAnalysisResponseSpendingDetailsByCategory](docs/CashFlowAnalysisResponseSpendingDetailsByCategory.md) - [atom_api.CashFlowAnalysisResponseSpendingDetailsByMerchant](docs/CashFlowAnalysisResponseSpendingDetailsByMerchant.md) - [atom_api.CashFlowAnalysisResponseSpendingDetailsChange](docs/CashFlowAnalysisResponseSpendingDetailsChange.md) - [atom_api.CashFlowAnalysisResponseSpendingDetailsChange1](docs/CashFlowAnalysisResponseSpendingDetailsChange1.md) - [atom_api.CashFlowAnalysisResponseSpendingDetailsChange2](docs/CashFlowAnalysisResponseSpendingDetailsChange2.md) - [atom_api.CashFlowAnalysisResponseSpendingDetailsSubcategories](docs/CashFlowAnalysisResponseSpendingDetailsSubcategories.md) - [atom_api.CashFlowAnalysisResponseSpendingSummary](docs/CashFlowAnalysisResponseSpendingSummary.md) - [atom_api.CashFlowAnalysisResponseSpendingSummaryChange](docs/CashFlowAnalysisResponseSpendingSummaryChange.md) - [atom_api.ChangeModelCompositionResponse](docs/ChangeModelCompositionResponse.md) - [atom_api.ChangeModelCompositionResponseInner](docs/ChangeModelCompositionResponseInner.md) - [atom_api.ChatPayload](docs/ChatPayload.md) - [atom_api.ChildrenEducationConfig](docs/ChildrenEducationConfig.md) - [atom_api.ClientAssetSizeResponse](docs/ClientAssetSizeResponse.md) - [atom_api.ClientAssetSizeResponseInner](docs/ClientAssetSizeResponseInner.md) - [atom_api.ClientCampaignPayload](docs/ClientCampaignPayload.md) - [atom_api.ClientHoldingsResponse](docs/ClientHoldingsResponse.md) - [atom_api.ClientHoldingsResponseInner](docs/ClientHoldingsResponseInner.md) - [atom_api.ClientHydroPayload](docs/ClientHydroPayload.md) - [atom_api.ClientPayload](docs/ClientPayload.md) - [atom_api.ClientResponsePayload](docs/ClientResponsePayload.md) - [atom_api.ClientTransactionResponseContent](docs/ClientTransactionResponseContent.md) - [atom_api.ConsultationPayload](docs/ConsultationPayload.md) - [atom_api.CreateAccountRebalanceOrderResponse](docs/CreateAccountRebalanceOrderResponse.md) - [atom_api.CreateAccountStatusResponse](docs/CreateAccountStatusResponse.md) - [atom_api.CreateAggregationAccountBalanceResponse](docs/CreateAggregationAccountBalanceResponse.md) - [atom_api.CreateBuyOnlyAccountRebalanceOrderResponse](docs/CreateBuyOnlyAccountRebalanceOrderResponse.md) - [atom_api.CreateBuyOnlyPortfolioRebalanceOrderResponse](docs/CreateBuyOnlyPortfolioRebalanceOrderResponse.md) - [atom_api.CreatePortfolioRebalanceOrderResponse](docs/CreatePortfolioRebalanceOrderResponse.md) - [atom_api.CreateSellOnlyAccountRebalanceOrderResponse](docs/CreateSellOnlyAccountRebalanceOrderResponse.md) - [atom_api.CreateSellOnlyPortfolioRebalanceOrderResponse](docs/CreateSellOnlyPortfolioRebalanceOrderResponse.md) - [atom_api.DecisionTreePayload](docs/DecisionTreePayload.md) - [atom_api.DepositRequestPayload](docs/DepositRequestPayload.md) - [atom_api.DepositSchedule](docs/DepositSchedule.md) - [atom_api.DepositScheduleMajorPurchaseDepAmt](docs/DepositScheduleMajorPurchaseDepAmt.md) - [atom_api.DepositScheduleMajorPurchaseNoDepAmt](docs/DepositScheduleMajorPurchaseNoDepAmt.md) - [atom_api.DimRiskScoreResponse](docs/DimRiskScoreResponse.md) - [atom_api.DimensionalRiskScore](docs/DimensionalRiskScore.md) - [atom_api.DiversificationScore](docs/DiversificationScore.md) - [atom_api.DocumentPayload](docs/DocumentPayload.md) - [atom_api.EducationCalculatorAnnualCost](docs/EducationCalculatorAnnualCost.md) - [atom_api.EducationCalculatorAnnualcostResponse](docs/EducationCalculatorAnnualcostResponse.md) - [atom_api.EducationCalculatorDepositAmount](docs/EducationCalculatorDepositAmount.md) - [atom_api.EducationCalculatorDepositScheduleDepAmt](docs/EducationCalculatorDepositScheduleDepAmt.md) - [atom_api.EducationCalculatorDepositScheduleNoDepAmt](docs/EducationCalculatorDepositScheduleNoDepAmt.md) - [atom_api.EducationCalculatorDepositamountResponse](docs/EducationCalculatorDepositamountResponse.md) - [atom_api.EducationCalculatorPctcoveredResponse](docs/EducationCalculatorPctcoveredResponse.md) - [atom_api.EducationCalculatorPercentCovered](docs/EducationCalculatorPercentCovered.md) - [atom_api.EducationCalculatorReturnDetail](docs/EducationCalculatorReturnDetail.md) - [atom_api.EducationConfig](docs/EducationConfig.md) - [atom_api.EmergencyFundCalculator](docs/EmergencyFundCalculator.md) - [atom_api.EmergencyFundResponse](docs/EmergencyFundResponse.md) - [atom_api.Event](docs/Event.md) - [atom_api.EventStudy](docs/EventStudy.md) - [atom_api.EventStudyResponse](docs/EventStudyResponse.md) - [atom_api.FaqPayload](docs/FaqPayload.md) - [atom_api.FaqPayloadFaqKeywords](docs/FaqPayloadFaqKeywords.md) - [atom_api.FinancialHealthCheck](docs/FinancialHealthCheck.md) - [atom_api.FinancialOfferPayload](docs/FinancialOfferPayload.md) - [atom_api.FinancialPicturePayload](docs/FinancialPicturePayload.md) - [atom_api.FinancialPictureResponse](docs/FinancialPictureResponse.md) - [atom_api.FinancialPictureResponseByCategory](docs/FinancialPictureResponseByCategory.md) - [atom_api.FinancialPictureResponseChange](docs/FinancialPictureResponseChange.md) - [atom_api.FinancialPictureResponseChangeTotalAssets](docs/FinancialPictureResponseChangeTotalAssets.md) - [atom_api.FinancialPictureResponseChangeTotalAssets180Day](docs/FinancialPictureResponseChangeTotalAssets180Day.md) - [atom_api.FinancialPictureResponseChangeTotalAssets1Day](docs/FinancialPictureResponseChangeTotalAssets1Day.md) - [atom_api.FinancialPictureResponseChangeTotalAssets30Day](docs/FinancialPictureResponseChangeTotalAssets30Day.md) - [atom_api.FinancialPictureResponseChangeTotalAssets365Day](docs/FinancialPictureResponseChangeTotalAssets365Day.md) - [atom_api.FinancialPictureResponseChangeTotalAssets7Day](docs/FinancialPictureResponseChangeTotalAssets7Day.md) - [atom_api.FinancialPictureResponseChangeTotalAssets90Day](docs/FinancialPictureResponseChangeTotalAssets90Day.md) - [atom_api.FinancialPictureResponseChangeTotalAssetsTotal](docs/FinancialPictureResponseChangeTotalAssetsTotal.md) - [atom_api.FinancialPictureResponseHistory](docs/FinancialPictureResponseHistory.md) - [atom_api.FinancialPictureResponseSnapshot](docs/FinancialPictureResponseSnapshot.md) - [atom_api.FinancialPictureResponseSnapshotByCategory](docs/FinancialPictureResponseSnapshotByCategory.md) - [atom_api.FinancialPictureResponseSnapshotNetWorth](docs/FinancialPictureResponseSnapshotNetWorth.md) - [atom_api.FinancialPictureResponseSnapshotSubcategories](docs/FinancialPictureResponseSnapshotSubcategories.md) - [atom_api.FinancialPictureResponseSnapshotTotalAssets](docs/FinancialPictureResponseSnapshotTotalAssets.md) - [atom_api.FinancialPictureResponseSnapshotTotalLiabilities](docs/FinancialPictureResponseSnapshotTotalLiabilities.md) - [atom_api.FinancialPictureResponseSubcategories](docs/FinancialPictureResponseSubcategories.md) - [atom_api.FundingRequestPayload](docs/FundingRequestPayload.md) - [atom_api.GetAccountAssetSizeResponse](docs/GetAccountAssetSizeResponse.md) - [atom_api.GetAccountAssetSizeResponseInner](docs/GetAccountAssetSizeResponseInner.md) - [atom_api.GetAccountHoldingResponse](docs/GetAccountHoldingResponse.md) - [atom_api.GetAccountHoldingResponseInner](docs/GetAccountHoldingResponseInner.md) - [atom_api.GetAccountTypeSubresponse](docs/GetAccountTypeSubresponse.md) - [atom_api.GoalAccumulationAllocation](docs/GoalAccumulationAllocation.md) - [atom_api.GoalAccumulationRecommendation](docs/GoalAccumulationRecommendation.md) - [atom_api.GoalAccumulationStatus](docs/GoalAccumulationStatus.md) - [atom_api.GoalAllocationResponse](docs/GoalAllocationResponse.md) - [atom_api.GoalAllocationSectionResponse](docs/GoalAllocationSectionResponse.md) - [atom_api.GoalAssetSizeResponse](docs/GoalAssetSizeResponse.md) - [atom_api.GoalAssetSizeResponseInner](docs/GoalAssetSizeResponseInner.md) - [atom_api.GoalConfig](docs/GoalConfig.md) - [atom_api.GoalDecumulationAllocation](docs/GoalDecumulationAllocation.md) - [atom_api.GoalDecumulationRecommendation](docs/GoalDecumulationRecommendation.md) - [atom_api.GoalDecumulationStatus](docs/GoalDecumulationStatus.md) - [atom_api.GoalDepositConfig](docs/GoalDepositConfig.md) - [atom_api.GoalHoldingsResponse](docs/GoalHoldingsResponse.md) - [atom_api.GoalHoldingsResponseInner](docs/GoalHoldingsResponseInner.md) - [atom_api.GoalOptConfig](docs/GoalOptConfig.md) - [atom_api.GoalPayload](docs/GoalPayload.md) - [atom_api.GoalRecommendationConfigRec](docs/GoalRecommendationConfigRec.md) - [atom_api.GoalRecommendationConfigStatus](docs/GoalRecommendationConfigStatus.md) - [atom_api.GoalRecommendationResponse](docs/GoalRecommendationResponse.md) - [atom_api.GoalRecommendationResponseAction](docs/GoalRecommendationResponseAction.md) - [atom_api.GoalReturnDetailsPeriodResponse](docs/GoalReturnDetailsPeriodResponse.md) - [atom_api.GoalStatusResponse](docs/GoalStatusResponse.md) - [atom_api.GoalStatusSectionResponse](docs/GoalStatusSectionResponse.md) - [atom_api.GoalTrackPayload](docs/GoalTrackPayload.md) - [atom_api.GoalTransactionsResponseContent](docs/GoalTransactionsResponseContent.md) - [atom_api.GoalWeightConfig](docs/GoalWeightConfig.md) - [atom_api.GoalWithdrawalConfig](docs/GoalWithdrawalConfig.md) - [atom_api.GuaranteedRateBenefitSubpayload](docs/GuaranteedRateBenefitSubpayload.md) - [atom_api.HealthCheckResponse](docs/HealthCheckResponse.md) - [atom_api.HealthCheckResult](docs/HealthCheckResult.md) - [atom_api.HoldingsDetail](docs/HoldingsDetail.md) - [atom_api.IncomeConfig](docs/IncomeConfig.md) - [atom_api.LifeInsuranceCalculator](docs/LifeInsuranceCalculator.md) - [atom_api.LifeInsuranceNeedsBreakdown](docs/LifeInsuranceNeedsBreakdown.md) - [atom_api.LifeInsuranceNeedsResponse](docs/LifeInsuranceNeedsResponse.md) - [atom_api.LifeInsuranceReturnDetail](docs/LifeInsuranceReturnDetail.md) - [atom_api.ModelAssetSizePayload](docs/ModelAssetSizePayload.md) - [atom_api.ModelCommentPayload](docs/ModelCommentPayload.md) - [atom_api.ModelCompositionPayload](docs/ModelCompositionPayload.md) - [atom_api.ModelCompositionPayloadHoldings](docs/ModelCompositionPayloadHoldings.md) - [atom_api.ModelHoldingPayload](docs/ModelHoldingPayload.md) - [atom_api.ModelPayload](docs/ModelPayload.md) - [atom_api.ModelTransactionPayload](docs/ModelTransactionPayload.md) - [atom_api.MonteCarlo](docs/MonteCarlo.md) - [atom_api.MonteCarloResponse](docs/MonteCarloResponse.md) - [atom_api.MortgageCalculatorDownPayment](docs/MortgageCalculatorDownPayment.md) - [atom_api.MortgageCalculatorDownpaymentResponse](docs/MortgageCalculatorDownpaymentResponse.md) - [atom_api.MortgageCalculatorHomePrice](docs/MortgageCalculatorHomePrice.md) - [atom_api.MortgageCalculatorHomepriceResponse](docs/MortgageCalculatorHomepriceResponse.md) - [atom_api.MortgageCalculatorPeriodicPayment](docs/MortgageCalculatorPeriodicPayment.md) - [atom_api.MortgageCalculatorPeriodicpaymentResponse](docs/MortgageCalculatorPeriodicpaymentResponse.md) - [atom_api.MortgageSchedulePeriod](docs/MortgageSchedulePeriod.md) - [atom_api.MvoResponse](docs/MvoResponse.md) - [atom_api.NodePayload](docs/NodePayload.md) - [atom_api.NodeRelationshipPayload](docs/NodeRelationshipPayload.md) - [atom_api.OptConfig](docs/OptConfig.md) - [atom_api.OptConfigPortfolio](docs/OptConfigPortfolio.md) - [atom_api.OptScorePortfolio](docs/OptScorePortfolio.md) - [atom_api.OptimizationScore](docs/OptimizationScore.md) - [atom_api.OrderPayload](docs/OrderPayload.md) - [atom_api.OrderStatusPayload](docs/OrderStatusPayload.md) - [atom_api.OrderTrackPayload](docs/OrderTrackPayload.md) - [atom_api.Pagination](docs/Pagination.md) - [atom_api.PaginationSort](docs/PaginationSort.md) - [atom_api.PerformanceResponse](docs/PerformanceResponse.md) - [atom_api.PfloDiversificationScoreResponse](docs/PfloDiversificationScoreResponse.md) - [atom_api.PfloOptimizationScoreResponse](docs/PfloOptimizationScoreResponse.md) - [atom_api.PortfolioAssetSizePayload](docs/PortfolioAssetSizePayload.md) - [atom_api.PortfolioCommentPayload](docs/PortfolioCommentPayload.md) - [atom_api.PortfolioHoldingPayload](docs/PortfolioHoldingPayload.md) - [atom_api.PortfolioPayload](docs/PortfolioPayload.md) - [atom_api.PortfolioRebalanceBuyOnlyOrderPayload](docs/PortfolioRebalanceBuyOnlyOrderPayload.md) - [atom_api.PortfolioRebalanceOrderPayload](docs/PortfolioRebalanceOrderPayload.md) - [atom_api.PortfolioRebalanceSellOnlyOrderPayload](docs/PortfolioRebalanceSellOnlyOrderPayload.md) - [atom_api.PortfolioTransactionPayload](docs/PortfolioTransactionPayload.md) - [atom_api.PortfolioWhatIfResponse](docs/PortfolioWhatIfResponse.md) - [atom_api.PortfolioWhatIfStat](docs/PortfolioWhatIfStat.md) - [atom_api.PurchaseCalculatorAmount](docs/PurchaseCalculatorAmount.md) - [atom_api.PurchaseCalculatorDepositAmount](docs/PurchaseCalculatorDepositAmount.md) - [atom_api.PurchaseCalculatorDepositamountResponse](docs/PurchaseCalculatorDepositamountResponse.md) - [atom_api.PurchaseCalculatorHorizon](docs/PurchaseCalculatorHorizon.md) - [atom_api.PurchaseCalculatorPurchaseamountResponse](docs/PurchaseCalculatorPurchaseamountResponse.md) - [atom_api.PurchaseCalculatorPurchasehorizonResponse](docs/PurchaseCalculatorPurchasehorizonResponse.md) - [atom_api.PurchaseCalculatorReturnDetail](docs/PurchaseCalculatorReturnDetail.md) - [atom_api.QuestionnairePayload](docs/QuestionnairePayload.md) - [atom_api.QuestionnairePayloadAnswers](docs/QuestionnairePayloadAnswers.md) - [atom_api.QuestionnairePayloadQuestions](docs/QuestionnairePayloadQuestions.md) - [atom_api.RatioTargets](docs/RatioTargets.md) - [atom_api.Rebalance](docs/Rebalance.md) - [atom_api.RebalanceResponse](docs/RebalanceResponse.md) - [atom_api.RebalanceSignal](docs/RebalanceSignal.md) - [atom_api.RebalanceSubresponse](docs/RebalanceSubresponse.md) - [atom_api.RetirementCalculatorDepositAmount](docs/RetirementCalculatorDepositAmount.md) - [atom_api.RetirementCalculatorDepositamountResponse](docs/RetirementCalculatorDepositamountResponse.md) - [atom_api.RetirementCalculatorExpenses](docs/RetirementCalculatorExpenses.md) - [atom_api.RetirementCalculatorExpensesResponse](docs/RetirementCalculatorExpensesResponse.md) - [atom_api.RetirementCalculatorPctcoveredResponse](docs/RetirementCalculatorPctcoveredResponse.md) - [atom_api.RetirementCalculatorPercentCovered](docs/RetirementCalculatorPercentCovered.md) - [atom_api.RetirementReturnDetail](docs/RetirementReturnDetail.md) - [atom_api.RiskAllocation](docs/RiskAllocation.md) - [atom_api.RiskAllocationResponse](docs/RiskAllocationResponse.md) - [atom_api.RiskScore](docs/RiskScore.md) - [atom_api.RiskScoreOptConfigModel](docs/RiskScoreOptConfigModel.md) - [atom_api.RiskScoreOptConfigModelWConfig](docs/RiskScoreOptConfigModelWConfig.md) - [atom_api.RiskScoreResponse](docs/RiskScoreResponse.md) - [atom_api.SalesPayload](docs/SalesPayload.md) - [atom_api.SavingsCalculatorResponse](docs/SavingsCalculatorResponse.md) - [atom_api.SavingsCalculatorReturnDetailsPeriodResponse](docs/SavingsCalculatorReturnDetailsPeriodResponse.md) - [atom_api.ScenarioAnalysis](docs/ScenarioAnalysis.md) - [atom_api.ScenarioAnalysisResponse](docs/ScenarioAnalysisResponse.md) - [atom_api.ScenarioResults](docs/ScenarioResults.md) - [atom_api.ScorePayload](docs/ScorePayload.md) - [atom_api.SecondaryId](docs/SecondaryId.md) - [atom_api.SecurityExclusionPayload](docs/SecurityExclusionPayload.md) - [atom_api.SecurityPayload](docs/SecurityPayload.md) - [atom_api.SecurityPayloadSecurityComposition](docs/SecurityPayloadSecurityComposition.md) - [atom_api.SecurityPayloadSecurityCountry](docs/SecurityPayloadSecurityCountry.md) - [atom_api.SecurityPricePayload](docs/SecurityPricePayload.md) - [atom_api.SellAllAccountPayload](docs/SellAllAccountPayload.md) - [atom_api.SellAllAccountResponse](docs/SellAllAccountResponse.md) - [atom_api.SellAllPortfolioPayload](docs/SellAllPortfolioPayload.md) - [atom_api.SellAllPortfolioResponse](docs/SellAllPortfolioResponse.md) - [atom_api.SensitivityAnalysis](docs/SensitivityAnalysis.md) - [atom_api.SensitivityAnalysisResponse](docs/SensitivityAnalysisResponse.md) - [atom_api.SensitivityFactor](docs/SensitivityFactor.md) - [atom_api.SimpleSavingsCalculator](docs/SimpleSavingsCalculator.md) - [atom_api.SpecificAccountStageResponse](docs/SpecificAccountStageResponse.md) - [atom_api.SpecificAccountStatusResponse](docs/SpecificAccountStatusResponse.md) - [atom_api.StatsDetail](docs/StatsDetail.md) - [atom_api.SubscribeAccountResponse](docs/SubscribeAccountResponse.md) - [atom_api.SubscribeAccountResponseInner](docs/SubscribeAccountResponseInner.md) - [atom_api.SupportTicketCommentPayload](docs/SupportTicketCommentPayload.md) - [atom_api.SupportTicketCommentPayloadSupportTicketDocument](docs/SupportTicketCommentPayloadSupportTicketDocument.md) - [atom_api.SupportTicketPayload](docs/SupportTicketPayload.md) - [atom_api.TargetPortfolioResponse](docs/TargetPortfolioResponse.md) - [atom_api.TransactionCodePayload](docs/TransactionCodePayload.md) - [atom_api.TransferRequestPayload](docs/TransferRequestPayload.md) - [atom_api.VariableAnnuityPayload](docs/VariableAnnuityPayload.md) - [atom_api.VariableAnnuityResponse](docs/VariableAnnuityResponse.md) - [atom_api.VariableAnnuityReturnDetail](docs/VariableAnnuityReturnDetail.md) - [atom_api.WConfigPortfolio](docs/WConfigPortfolio.md) - [atom_api.WhatIfPortfolio](docs/WhatIfPortfolio.md) - [atom_api.WithdrawalPayload](docs/WithdrawalPayload.md) - [atom_api.AccountTransactionResponse](docs/AccountTransactionResponse.md) - [atom_api.AllocationTransactionResponse](docs/AllocationTransactionResponse.md) - [atom_api.BulkOrderSubresponse](docs/BulkOrderSubresponse.md) - [atom_api.ClientTransactionResponse](docs/ClientTransactionResponse.md) - [atom_api.CreateAccountResponse](docs/CreateAccountResponse.md) - [atom_api.CreateAggregationAccountHoldingResponse](docs/CreateAggregationAccountHoldingResponse.md) - [atom_api.CreateAggregationAccountResponse](docs/CreateAggregationAccountResponse.md) - [atom_api.CreateAggregationAccountTransactionResponse](docs/CreateAggregationAccountTransactionResponse.md) - [atom_api.CreateAllocationCompositionResponse](docs/CreateAllocationCompositionResponse.md) - [atom_api.CreateAllocationResponse](docs/CreateAllocationResponse.md) - [atom_api.CreateBankLinkResponse](docs/CreateBankLinkResponse.md) - [atom_api.CreateBenchmarkResponse](docs/CreateBenchmarkResponse.md) - [atom_api.CreateBudgetResponse](docs/CreateBudgetResponse.md) - [atom_api.CreateCampaignDataResponse](docs/CreateCampaignDataResponse.md) - [atom_api.CreateCampaignPlanResponse](docs/CreateCampaignPlanResponse.md) - [atom_api.CreateCampaignResponse](docs/CreateCampaignResponse.md) - [atom_api.CreateChatResponse](docs/CreateChatResponse.md) - [atom_api.CreateClientCampaignResponse](docs/CreateClientCampaignResponse.md) - [atom_api.CreateClientHydroResponse](docs/CreateClientHydroResponse.md) - [atom_api.CreateClientResponse](docs/CreateClientResponse.md) - [atom_api.CreateClientResponseResponse](docs/CreateClientResponseResponse.md) - [atom_api.CreateConsultationResponse](docs/CreateConsultationResponse.md) - [atom_api.CreateDecisionTreeResponse](docs/CreateDecisionTreeResponse.md) - [atom_api.CreateDepositRequestResponse](docs/CreateDepositRequestResponse.md) - [atom_api.CreateDocumentResponse](docs/CreateDocumentResponse.md) - [atom_api.CreateFaqResponse](docs/CreateFaqResponse.md) - [atom_api.CreateFinancialOfferResponse](docs/CreateFinancialOfferResponse.md) - [atom_api.CreateFundingRequestResponse](docs/CreateFundingRequestResponse.md) - [atom_api.CreateGoalResponse](docs/CreateGoalResponse.md) - [atom_api.CreateGoalTrackResponse](docs/CreateGoalTrackResponse.md) - [atom_api.CreateModelAssetSizeResponse](docs/CreateModelAssetSizeResponse.md) - [atom_api.CreateModelCommentResponse](docs/CreateModelCommentResponse.md) - [atom_api.CreateModelHoldingResponse](docs/CreateModelHoldingResponse.md) - [atom_api.CreateModelResponse](docs/CreateModelResponse.md) - [atom_api.CreateModelTransactionResponse](docs/CreateModelTransactionResponse.md) - [atom_api.CreateNodeRelationshipResponse](docs/CreateNodeRelationshipResponse.md) - [atom_api.CreateNodeResponse](docs/CreateNodeResponse.md) - [atom_api.CreateOrderResponse](docs/CreateOrderResponse.md) - [atom_api.CreateOrderStatusResponse](docs/CreateOrderStatusResponse.md) - [atom_api.CreateOrderTrackResponse](docs/CreateOrderTrackResponse.md) - [atom_api.CreatePortfolioAssetSizeResponse](docs/CreatePortfolioAssetSizeResponse.md) - [atom_api.CreatePortfolioCommentResponse](docs/CreatePortfolioCommentResponse.md) - [atom_api.CreatePortfolioHoldingResponse](docs/CreatePortfolioHoldingResponse.md) - [atom_api.CreatePortfolioResponse](docs/CreatePortfolioResponse.md) - [atom_api.CreatePortfolioTransactionResponse](docs/CreatePortfolioTransactionResponse.md) - [atom_api.CreateQuestionnaireResponse](docs/CreateQuestionnaireResponse.md) - [atom_api.CreateSalesResponse](docs/CreateSalesResponse.md) - [atom_api.CreateScoreResponse](docs/CreateScoreResponse.md) - [atom_api.CreateSecurityExclusionResponse](docs/CreateSecurityExclusionResponse.md) - [atom_api.CreateSecurityPriceResponse](docs/CreateSecurityPriceResponse.md) - [atom_api.CreateSecurityResponse](docs/CreateSecurityResponse.md) - [atom_api.CreateSupportTicketCommentResponse](docs/CreateSupportTicketCommentResponse.md) - [atom_api.CreateSupportTicketResponse](docs/CreateSupportTicketResponse.md) - [atom_api.CreateTransactionCodeResponse](docs/CreateTransactionCodeResponse.md) - [atom_api.CreateTransferResponse](docs/CreateTransferResponse.md) - [atom_api.CreateWithdrawalResponse](docs/CreateWithdrawalResponse.md) - [atom_api.GetAccountAllocationResponse](docs/GetAccountAllocationResponse.md) - [atom_api.GetAccountPermissionsResponse](docs/GetAccountPermissionsResponse.md) - [atom_api.GetAccountResponse](docs/GetAccountResponse.md) - [atom_api.GetAccountStageResponse](docs/GetAccountStageResponse.md) - [atom_api.GetAccountStatusResponse](docs/GetAccountStatusResponse.md) - [atom_api.GetAccountTypeResponse](docs/GetAccountTypeResponse.md) - [atom_api.GetAggregationAccountBalanceResponse](docs/GetAggregationAccountBalanceResponse.md) - [atom_api.GetAggregationAccountHoldingsResponse](docs/GetAggregationAccountHoldingsResponse.md) - [atom_api.GetAggregationAccountTransactionResponse](docs/GetAggregationAccountTransactionResponse.md) - [atom_api.GetAggregationAccountsResponse](docs/GetAggregationAccountsResponse.md) - [atom_api.GetAllocationCompositionResponse](docs/GetAllocationCompositionResponse.md) - [atom_api.GetAllocationResponse](docs/GetAllocationResponse.md) - [atom_api.GetBankLinkResponse](docs/GetBankLinkResponse.md) - [atom_api.GetBenchmarkResponse](docs/GetBenchmarkResponse.md) - [atom_api.GetBudgetResponse](docs/GetBudgetResponse.md) - [atom_api.GetBulkOrderResponse](docs/GetBulkOrderResponse.md) - [atom_api.GetCampaignDataResponse](docs/GetCampaignDataResponse.md) - [atom_api.GetCampaignPlanResponse](docs/GetCampaignPlanResponse.md) - [atom_api.GetCampaignResponse](docs/GetCampaignResponse.md) - [atom_api.GetChatResponse](docs/GetChatResponse.md) - [atom_api.GetClientCampaignResponse](docs/GetClientCampaignResponse.md) - [atom_api.GetClientHydroResponse](docs/GetClientHydroResponse.md) - [atom_api.GetClientResponse](docs/GetClientResponse.md) - [atom_api.GetClientResponseResponse](docs/GetClientResponseResponse.md) - [atom_api.GetConsultationResponse](docs/GetConsultationResponse.md) - [atom_api.GetDecisionTreeResponse](docs/GetDecisionTreeResponse.md) - [atom_api.GetDepositRequestResponse](docs/GetDepositRequestResponse.md) - [atom_api.GetDocumentResponse](docs/GetDocumentResponse.md) - [atom_api.GetFaqResponse](docs/GetFaqResponse.md) - [atom_api.GetFinancialOfferResponse](docs/GetFinancialOfferResponse.md) - [atom_api.GetFundingRequestResponse](docs/GetFundingRequestResponse.md) - [atom_api.GetGoalResponse](docs/GetGoalResponse.md) - [atom_api.GetGoalTrackResponse](docs/GetGoalTrackResponse.md) - [atom_api.GetModelAssetSizeResponse](docs/GetModelAssetSizeResponse.md) - [atom_api.GetModelCommentResponse](docs/GetModelCommentResponse.md) - [atom_api.GetModelHoldingResponse](docs/GetModelHoldingResponse.md) - [atom_api.GetModelResponse](docs/GetModelResponse.md) - [atom_api.GetModelTransactionResponse](docs/GetModelTransactionResponse.md) - [atom_api.GetNodeRelationshipResponse](docs/GetNodeRelationshipResponse.md) - [atom_api.GetNodeResponse](docs/GetNodeResponse.md) - [atom_api.GetOrderResponse](docs/GetOrderResponse.md) - [atom_api.GetOrderStatusResponse](docs/GetOrderStatusResponse.md) - [atom_api.GetOrderTrackResponse](docs/GetOrderTrackResponse.md) - [atom_api.GetPortfolioAssetSizeResponse](docs/GetPortfolioAssetSizeResponse.md) - [atom_api.GetPortfolioCommentResponse](docs/GetPortfolioCommentResponse.md) - [atom_api.GetPortfolioHoldingResponse](docs/GetPortfolioHoldingResponse.md) - [atom_api.GetPortfolioResponse](docs/GetPortfolioResponse.md) - [atom_api.GetPortfolioTransactionResponse](docs/GetPortfolioTransactionResponse.md) - [atom_api.GetQuestionnaireResponse](docs/GetQuestionnaireResponse.md) - [atom_api.GetSalesResponse](docs/GetSalesResponse.md) - [atom_api.GetScoreResponse](docs/GetScoreResponse.md) - [atom_api.GetSecurityExclusionResponse](docs/GetSecurityExclusionResponse.md) - [atom_api.GetSecurityPriceResponse](docs/GetSecurityPriceResponse.md) - [atom_api.GetSecurityResponse](docs/GetSecurityResponse.md) - [atom_api.GetSupportTicketCommentResponse](docs/GetSupportTicketCommentResponse.md) - [atom_api.GetSupportTicketResponse](docs/GetSupportTicketResponse.md) - [atom_api.GetTransactionCodeResponse](docs/GetTransactionCodeResponse.md) - [atom_api.GetTransferResponse](docs/GetTransferResponse.md) - [atom_api.GetWithdrawalResponse](docs/GetWithdrawalResponse.md) - [atom_api.GoalTransactionsResponse](docs/GoalTransactionsResponse.md) - [atom_api.SpecificAccountAllocationResponse](docs/SpecificAccountAllocationResponse.md) - [atom_api.SpecificAccountPermissionResponse](docs/SpecificAccountPermissionResponse.md) - [atom_api.SpecificAggregationAccountBalanceResponse](docs/SpecificAggregationAccountBalanceResponse.md) - [atom_api.SpecificTransferResponse](docs/SpecificTransferResponse.md) - [atom_api.SpecificAccountResponse](docs/SpecificAccountResponse.md) - [atom_api.SpecificAggregationAccountHoldingResponse](docs/SpecificAggregationAccountHoldingResponse.md) - [atom_api.SpecificAggregationAccountResponse](docs/SpecificAggregationAccountResponse.md) - [atom_api.SpecificAggregationAccountTransactionResponse](docs/SpecificAggregationAccountTransactionResponse.md) - [atom_api.SpecificAllocationCompositionResponse](docs/SpecificAllocationCompositionResponse.md) - [atom_api.SpecificAllocationResponse](docs/SpecificAllocationResponse.md) - [atom_api.SpecificBankLinkResponse](docs/SpecificBankLinkResponse.md) - [atom_api.SpecificBenchmarkResponse](docs/SpecificBenchmarkResponse.md) - [atom_api.SpecificBudgetResponse](docs/SpecificBudgetResponse.md) - [atom_api.SpecificCampaignDataResponse](docs/SpecificCampaignDataResponse.md) - [atom_api.SpecificCampaignPlanResponse](docs/SpecificCampaignPlanResponse.md) - [atom_api.SpecificCampaignResponse](docs/SpecificCampaignResponse.md) - [atom_api.SpecificChatResponse](docs/SpecificChatResponse.md) - [atom_api.SpecificClientCampaignResponse](docs/SpecificClientCampaignResponse.md) - [atom_api.SpecificClientHydroResponse](docs/SpecificClientHydroResponse.md) - [atom_api.SpecificClientResponse](docs/SpecificClientResponse.md) - [atom_api.SpecificClientResponseResponse](docs/SpecificClientResponseResponse.md) - [atom_api.SpecificConsultationResponse](docs/SpecificConsultationResponse.md) - [atom_api.SpecificDecisionTreeResponse](docs/SpecificDecisionTreeResponse.md) - [atom_api.SpecificDepositRequestResponse](docs/SpecificDepositRequestResponse.md) - [atom_api.SpecificDocumentResponse](docs/SpecificDocumentResponse.md) - [atom_api.SpecificFaqResponse](docs/SpecificFaqResponse.md) - [atom_api.SpecificFinancialOfferResponse](docs/SpecificFinancialOfferResponse.md) - [atom_api.SpecificFundingRequestResponse](docs/SpecificFundingRequestResponse.md) - [atom_api.SpecificGoalResponse](docs/SpecificGoalResponse.md) - [atom_api.SpecificGoalTrackResponse](docs/SpecificGoalTrackResponse.md) - [atom_api.SpecificModelAssetSizeResponse](docs/SpecificModelAssetSizeResponse.md) - [atom_api.SpecificModelCommentResponse](docs/SpecificModelCommentResponse.md) - [atom_api.SpecificModelHoldingResponse](docs/SpecificModelHoldingResponse.md) - [atom_api.SpecificModelResponse](docs/SpecificModelResponse.md) - [atom_api.SpecificModelTransactionResponse](docs/SpecificModelTransactionResponse.md) - [atom_api.SpecificNodeRelationshipResponse](docs/SpecificNodeRelationshipResponse.md) - [atom_api.SpecificNodeResponse](docs/SpecificNodeResponse.md) - [atom_api.SpecificOrderResponse](docs/SpecificOrderResponse.md) - [atom_api.SpecificOrderStatusResponse](docs/SpecificOrderStatusResponse.md) - [atom_api.SpecificOrderTrackResponse](docs/SpecificOrderTrackResponse.md) - [atom_api.SpecificPortfolioAssetSizeResponse](docs/SpecificPortfolioAssetSizeResponse.md) - [atom_api.SpecificPortfolioCommentResponse](docs/SpecificPortfolioCommentResponse.md) - [atom_api.SpecificPortfolioHoldingResponse](docs/SpecificPortfolioHoldingResponse.md) - [atom_api.SpecificPortfolioResponse](docs/SpecificPortfolioResponse.md) - [atom_api.SpecificPortfolioTransactionResponse](docs/SpecificPortfolioTransactionResponse.md) - [atom_api.SpecificQuestionnaireResponse](docs/SpecificQuestionnaireResponse.md) - [atom_api.SpecificSalesResponse](docs/SpecificSalesResponse.md) - [atom_api.SpecificScoreResponse](docs/SpecificScoreResponse.md) - [atom_api.SpecificSecurityExclusionResponse](docs/SpecificSecurityExclusionResponse.md) - [atom_api.SpecificSecurityPriceResponse](docs/SpecificSecurityPriceResponse.md) - [atom_api.SpecificSecurityResponse](docs/SpecificSecurityResponse.md) - [atom_api.SpecificSupportTicketCommentResponse](docs/SpecificSupportTicketCommentResponse.md) - [atom_api.SpecificSupportTicketResponse](docs/SpecificSupportTicketResponse.md) - [atom_api.SpecificTransactionCodeResponse](docs/SpecificTransactionCodeResponse.md) - [atom_api.SpecificWithdrawalResponse](docs/SpecificWithdrawalResponse.md) ## Documentation for Authorization Please see [this page](https://www.hydrogenplatform.com/docs/nucleus/v1/#Authentication) for additional authorization information. ### oauth - **Type**: OAuth - **Flow**: application - **Token URL**: https://sandbox.hydrogenplatform.com/authorization/v1/oauth/token?grant_type=client_credentials ## Author [https://www.hydrogenplatform.com/](https://www.hydrogenplatform.com/)