/// <summary>
/// Get Vault configuration by id This endpoint returns details for a Vault configuration as well as a list of accounts it is used in.
/// </summary>
/// <exception cref="FactSet.AnalyticsAPI.Engines.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="id">Vault configuration id to get the details of</param>
/// <returns>VaultConfiguration</returns>
public VaultConfiguration GetVaultConfigurationById(string id)
{
FactSet.AnalyticsAPI.Engines.Client.ApiResponse <VaultConfiguration> localVarResponse = GetVaultConfigurationByIdWithHttpInfo(id);
return(localVarResponse.Data);
}
/// <summary>
/// Get by Url This function can be used to fetch data from any Get endpoint.
/// </summary>
/// <exception cref="FactSet.AnalyticsAPI.Engines.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="url">Url of the Get endpoint</param>
/// <returns>string</returns>
public string GetByUrl(string url)
{
FactSet.AnalyticsAPI.Engines.Client.ApiResponse <string> localVarResponse = GetByUrlWithHttpInfo(url);
return(localVarResponse.Data);
}
/// <summary>
/// Get PA groups This endpoint lists all the PA groups that can be applied to a PA calculation.
/// </summary>
/// <exception cref="FactSet.AnalyticsAPI.Engines.Client.ApiException">Thrown when fails to make API call</exception>
/// <returns>GroupRoot</returns>
public GroupRoot GetPAGroups()
{
FactSet.AnalyticsAPI.Engines.Client.ApiResponse <GroupRoot> localVarResponse = GetPAGroupsWithHttpInfo();
return(localVarResponse.Data);
}
/// <summary>
/// Get PA column settings This endpoint returns the default settings of a PA column.
/// </summary>
/// <exception cref="FactSet.AnalyticsAPI.Engines.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="id">Unique identifier for a column</param>
/// <returns>Column</returns>
public Column GetPAColumnById(string id)
{
FactSet.AnalyticsAPI.Engines.Client.ApiResponse <Column> localVarResponse = GetPAColumnByIdWithHttpInfo(id);
return(localVarResponse.Data);
}
/// <summary>
/// Get PA columns This endpoint lists all the PA columns that can be applied to a calculation.
/// </summary>
/// <exception cref="FactSet.AnalyticsAPI.Engines.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="name">Column name (optional, default to "")</param>
/// <param name="category">Column category (optional, default to "")</param>
/// <param name="directory">The directory to get the columns in (optional, default to "")</param>
/// <returns>Dictionary<string, ColumnSummary></returns>
public Dictionary <string, ColumnSummary> GetPAColumns(string name = default(string), string category = default(string), string directory = default(string))
{
FactSet.AnalyticsAPI.Engines.Client.ApiResponse <Dictionary <string, ColumnSummary> > localVarResponse = GetPAColumnsWithHttpInfo(name, category, directory);
return(localVarResponse.Data);
}
/// <summary>
/// Get SPAR benchmark details This endpoint returns the details of a given SPAR benchmark identifier.
/// </summary>
/// <exception cref="FactSet.AnalyticsAPI.Engines.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="id">Benchmark Identifier</param>
/// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
/// <returns>Task of SPARBenchmarkRoot</returns>
public async System.Threading.Tasks.Task <SPARBenchmarkRoot> GetSPARBenchmarkByIdAsync(string id, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken))
{
FactSet.AnalyticsAPI.Engines.Client.ApiResponse <SPARBenchmarkRoot> localVarResponse = await GetSPARBenchmarkByIdWithHttpInfoAsync(id, cancellationToken).ConfigureAwait(false);
return(localVarResponse.Data);
}
/// <summary>
/// Get all calculation statuses This endpoints returns all active calculation requests.
/// </summary>
/// <exception cref="FactSet.AnalyticsAPI.Engines.Client.ApiException">Thrown when fails to make API call</exception>
/// <returns>Dictionary<string, CalculationStatusSummary></returns>
public Dictionary <string, CalculationStatusSummary> GetCalculationStatusSummaries()
{
FactSet.AnalyticsAPI.Engines.Client.ApiResponse <Dictionary <string, CalculationStatusSummary> > localVarResponse = GetCalculationStatusSummariesWithHttpInfo();
return(localVarResponse.Data);
}
/// <summary>
/// Convert Vault dates to absolute format This endpoint converts the given start and end dates in FactSet date format to yyyymmdd format for a Vault calculation. For more information on FactSet date format, please refer to the Vault API documentation under the 'API Documentation' section in the developer portal.
/// </summary>
/// <exception cref="FactSet.AnalyticsAPI.Engines.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="enddate">End Date</param>
/// <param name="componentid">Vault Component Id</param>
/// <param name="account">Account</param>
/// <param name="startdate">Start Date (optional)</param>
/// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
/// <returns>Task of DateParametersSummaryRoot</returns>
public async System.Threading.Tasks.Task <DateParametersSummaryRoot> ConvertVaultDatesToAbsoluteFormatAsync(string enddate, string componentid, string account, string startdate = default(string), System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken))
{
FactSet.AnalyticsAPI.Engines.Client.ApiResponse <DateParametersSummaryRoot> localVarResponse = await ConvertVaultDatesToAbsoluteFormatWithHttpInfoAsync(enddate, componentid, account, startdate, cancellationToken).ConfigureAwait(false);
return(localVarResponse.Data);
}
/// <summary>
/// Get accounts and sub-directories in a directory This endpoint looks up all ACCT and ACTM files and sub-directories in a given directory.
/// </summary>
/// <exception cref="FactSet.AnalyticsAPI.Engines.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="path">The directory to get the accounts and sub-directories in</param>
/// <returns>AccountDirectoriesRoot</returns>
public AccountDirectoriesRoot GetAccounts(string path)
{
FactSet.AnalyticsAPI.Engines.Client.ApiResponse <AccountDirectoriesRoot> localVarResponse = GetAccountsWithHttpInfo(path);
return(localVarResponse.Data);
}
/// <summary>
/// Get PA groups This endpoint lists all the PA groups that can be applied to a PA calculation.
/// </summary>
/// <exception cref="FactSet.AnalyticsAPI.Engines.Client.ApiException">Thrown when fails to make API call</exception>
/// <returns>Task of Dictionary<string, Group></returns>
public async System.Threading.Tasks.Task <Dictionary <string, Group> > GetPAGroupsAsync()
{
FactSet.AnalyticsAPI.Engines.Client.ApiResponse <Dictionary <string, Group> > localVarResponse = await GetPAGroupsAsyncWithHttpInfo();
return(localVarResponse.Data);
}
/// <summary>
/// Convert Vault dates to absolute format This endpoint converts the given start and end dates in FactSet date format to yyyymmdd format for a Vault calculation. For more information on FactSet date format, please refer to the Vault API documentation under the 'API Documentation' section in the developer portal.
/// </summary>
/// <exception cref="FactSet.AnalyticsAPI.Engines.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="enddate">End Date</param>
/// <param name="componentid">Vault Component Id</param>
/// <param name="account">Account</param>
/// <param name="startdate">Start Date (optional)</param>
/// <returns>DateParametersSummaryRoot</returns>
public DateParametersSummaryRoot ConvertVaultDatesToAbsoluteFormat(string enddate, string componentid, string account, string startdate = default(string))
{
FactSet.AnalyticsAPI.Engines.Client.ApiResponse <DateParametersSummaryRoot> localVarResponse = ConvertVaultDatesToAbsoluteFormatWithHttpInfo(enddate, componentid, account, startdate);
return(localVarResponse.Data);
}
/// <summary>
/// Get PA groups This endpoint lists all the PA groups that can be applied to a PA calculation.
/// </summary>
/// <exception cref="FactSet.AnalyticsAPI.Engines.Client.ApiException">Thrown when fails to make API call</exception>
/// <returns>Dictionary<string, Group></returns>
public Dictionary <string, Group> GetPAGroups()
{
FactSet.AnalyticsAPI.Engines.Client.ApiResponse <Dictionary <string, Group> > localVarResponse = GetPAGroupsWithHttpInfo();
return(localVarResponse.Data);
}
/// <summary>
/// Get Vault configurations This endpoint returns all the Vault configurations saved in the provided account.
/// </summary>
/// <exception cref="FactSet.AnalyticsAPI.Engines.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="account">Required account query parameter to filter configurations for a specific account</param>
/// <returns>Task of Dictionary<string, VaultConfigurationSummary></returns>
public async System.Threading.Tasks.Task <Dictionary <string, VaultConfigurationSummary> > GetVaultConfigurationsAsync(string account)
{
FactSet.AnalyticsAPI.Engines.Client.ApiResponse <Dictionary <string, VaultConfigurationSummary> > localVarResponse = await GetVaultConfigurationsAsyncWithHttpInfo(account);
return(localVarResponse.Data);
}
/// <summary>
/// Get Vault configurations This endpoint returns all the Vault configurations saved in the provided account.
/// </summary>
/// <exception cref="FactSet.AnalyticsAPI.Engines.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="account">Required account query parameter to filter configurations for a specific account</param>
/// <returns>Dictionary<string, VaultConfigurationSummary></returns>
public Dictionary <string, VaultConfigurationSummary> GetVaultConfigurations(string account)
{
FactSet.AnalyticsAPI.Engines.Client.ApiResponse <Dictionary <string, VaultConfigurationSummary> > localVarResponse = GetVaultConfigurationsWithHttpInfo(account);
return(localVarResponse.Data);
}
/// <summary>
/// Run Vault Calculation This endpoint runs the Vault calculation specified in the POST body parameters. It must be used first before polling or cancelling endpoints. A successful response will contain the URL to poll for the result of the calculation. Remarks: * Start and and end date must be within the configuration's min and max date range
/// </summary>
/// <exception cref="FactSet.AnalyticsAPI.Engines.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="vaultCalculationParameters"> (optional)</param>
/// <returns>Task of Object</returns>
public async System.Threading.Tasks.Task <Object> RunVaultCalculationAsync(VaultCalculationParameters vaultCalculationParameters = default(VaultCalculationParameters))
{
FactSet.AnalyticsAPI.Engines.Client.ApiResponse <Object> localVarResponse = await RunVaultCalculationAsyncWithHttpInfo(vaultCalculationParameters);
return(localVarResponse.Data);
}
/// <summary>
/// Get accounts and sub-directories in a directory This endpoint looks up all ACCT and ACTM files and sub-directories in a given directory.
/// </summary>
/// <exception cref="FactSet.AnalyticsAPI.Engines.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="path">The directory to get the accounts and sub-directories in</param>
/// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
/// <returns>Task of AccountDirectoriesRoot</returns>
public async System.Threading.Tasks.Task <AccountDirectoriesRoot> GetAccountsAsync(string path, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken))
{
FactSet.AnalyticsAPI.Engines.Client.ApiResponse <AccountDirectoriesRoot> localVarResponse = await GetAccountsWithHttpInfoAsync(path, cancellationToken).ConfigureAwait(false);
return(localVarResponse.Data);
}
/// <summary>
/// Get SPAR benchmark details This endpoint returns the details of a given SPAR benchmark identifier.
/// </summary>
/// <exception cref="FactSet.AnalyticsAPI.Engines.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="id">Benchmark Identifier</param>
/// <returns>SPARBenchmarkRoot</returns>
public SPARBenchmarkRoot GetSPARBenchmarkById(string id)
{
FactSet.AnalyticsAPI.Engines.Client.ApiResponse <SPARBenchmarkRoot> localVarResponse = GetSPARBenchmarkByIdWithHttpInfo(id);
return(localVarResponse.Data);
}
/// <summary>
/// Get SPAR account returns type details This endpoint returns the returns type of account associated with SPAR
/// </summary>
/// <exception cref="FactSet.AnalyticsAPI.Engines.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="accountPath">URL encoded account path</param>
/// <returns>SPARAccountsRoot</returns>
public SPARAccountsRoot GetSPARReturnsType(string accountPath)
{
FactSet.AnalyticsAPI.Engines.Client.ApiResponse <SPARAccountsRoot> localVarResponse = GetSPARReturnsTypeWithHttpInfo(accountPath);
return(localVarResponse.Data);
}
/// <summary>
/// Get calculation status by id This is the endpoint to check on the progress of a previous calculation request. Response body contains status information of the entire request and each individual calculation unit.
/// </summary>
/// <exception cref="FactSet.AnalyticsAPI.Engines.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="id">From url, provided from the location header in the Run Multiple Calculations endpoint.</param>
/// <returns>CalculationStatus</returns>
public CalculationStatus GetCalculationStatusById(string id)
{
FactSet.AnalyticsAPI.Engines.Client.ApiResponse <CalculationStatus> localVarResponse = GetCalculationStatusByIdWithHttpInfo(id);
return(localVarResponse.Data);
}
/// <summary>
/// Get SPAR account returns type details This endpoint returns the returns type of account associated with SPAR
/// </summary>
/// <exception cref="FactSet.AnalyticsAPI.Engines.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="accountPath">URL encoded account path</param>
/// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
/// <returns>Task of SPARAccountsRoot</returns>
public async System.Threading.Tasks.Task <SPARAccountsRoot> GetSPARReturnsTypeAsync(string accountPath, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken))
{
FactSet.AnalyticsAPI.Engines.Client.ApiResponse <SPARAccountsRoot> localVarResponse = await GetSPARReturnsTypeWithHttpInfoAsync(accountPath, cancellationToken).ConfigureAwait(false);
return(localVarResponse.Data);
}
/// <summary>
/// Get all calculation statuses This endpoints returns all active calculation requests.
/// </summary>
/// <exception cref="FactSet.AnalyticsAPI.Engines.Client.ApiException">Thrown when fails to make API call</exception>
/// <returns>Task of Dictionary<string, CalculationStatusSummary></returns>
public async System.Threading.Tasks.Task <Dictionary <string, CalculationStatusSummary> > GetCalculationStatusSummariesAsync()
{
FactSet.AnalyticsAPI.Engines.Client.ApiResponse <Dictionary <string, CalculationStatusSummary> > localVarResponse = await GetCalculationStatusSummariesAsyncWithHttpInfo();
return(localVarResponse.Data);
}
/// <summary>
/// Get PA column statistics This endpoint lists all the column statistics that can be applied to a PA column.
/// </summary>
/// <exception cref="FactSet.AnalyticsAPI.Engines.Client.ApiException">Thrown when fails to make API call</exception>
/// <returns>Dictionary<string, ColumnStatistic></returns>
public Dictionary <string, ColumnStatistic> GetPAColumnStatistics()
{
FactSet.AnalyticsAPI.Engines.Client.ApiResponse <Dictionary <string, ColumnStatistic> > localVarResponse = GetPAColumnStatisticsWithHttpInfo();
return(localVarResponse.Data);
}
/// <summary>
/// Get PA column settings This endpoint returns the default settings of a PA column.
/// </summary>
/// <exception cref="FactSet.AnalyticsAPI.Engines.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="id">Unique identifier for a column</param>
/// <returns>Task of Column</returns>
public async System.Threading.Tasks.Task <Column> GetPAColumnByIdAsync(string id)
{
FactSet.AnalyticsAPI.Engines.Client.ApiResponse <Column> localVarResponse = await GetPAColumnByIdAsyncWithHttpInfo(id);
return(localVarResponse.Data);
}
/// <summary>
/// Get Vault calculation by id This is the endpoint to check on the progress of a previously requested calculation. If the calculation has finished computing, the body of the response will contain the requested document in JSON.
/// </summary>
/// <exception cref="FactSet.AnalyticsAPI.Engines.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="id">from url, provided from the location header in the Run Calculation endpoint</param>
/// <returns>Object</returns>
public Object GetVaultCalculationById(string id)
{
FactSet.AnalyticsAPI.Engines.Client.ApiResponse <Object> localVarResponse = GetVaultCalculationByIdWithHttpInfo(id);
return(localVarResponse.Data);
}
/// <summary>
/// Get PA columns This endpoint lists all the PA columns that can be applied to a calculation.
/// </summary>
/// <exception cref="FactSet.AnalyticsAPI.Engines.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="name">Column name (optional, default to "")</param>
/// <param name="category">Column category (optional, default to "")</param>
/// <param name="directory">The directory to get the columns in (optional, default to "")</param>
/// <returns>Task of Dictionary<string, ColumnSummary></returns>
public async System.Threading.Tasks.Task <Dictionary <string, ColumnSummary> > GetPAColumnsAsync(string name = default(string), string category = default(string), string directory = default(string))
{
FactSet.AnalyticsAPI.Engines.Client.ApiResponse <Dictionary <string, ColumnSummary> > localVarResponse = await GetPAColumnsAsyncWithHttpInfo(name, category, directory);
return(localVarResponse.Data);
}
/// <summary>
/// Get Vault calculation by id This is the endpoint to check on the progress of a previously requested calculation. If the calculation has finished computing, the body of the response will contain the requested document in JSON.
/// </summary>
/// <exception cref="FactSet.AnalyticsAPI.Engines.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="id">from url, provided from the location header in the Run Calculation endpoint</param>
/// <returns>Task of Object</returns>
public async System.Threading.Tasks.Task <Object> GetVaultCalculationByIdAsync(string id)
{
FactSet.AnalyticsAPI.Engines.Client.ApiResponse <Object> localVarResponse = await GetVaultCalculationByIdAsyncWithHttpInfo(id);
return(localVarResponse.Data);
}
/// <summary>
/// Get by Url This function can be used to fetch data from any GET endpoint.
/// </summary>
/// <exception cref="FactSet.AnalyticsAPI.Engines.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="url">Url of the GET endpoint</param>
/// <returns>Task of string</returns>
public async System.Threading.Tasks.Task <string> GetByUrlAsync(string url)
{
FactSet.AnalyticsAPI.Engines.Client.ApiResponse <string> localVarResponse = await GetByUrlAsyncWithHttpInfo(url);
return(localVarResponse.Data);
}
/// <summary>
/// Run Vault Calculation This endpoint runs the Vault calculation specified in the POST body parameters. It must be used first before polling or cancelling endpoints. A successful response will contain the URL to poll for the result of the calculation. Remarks: * Start and and end date must be within the configuration's min and max date range
/// </summary>
/// <exception cref="FactSet.AnalyticsAPI.Engines.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="vaultCalculationParameters"> (optional)</param>
/// <returns>Object</returns>
public Object RunVaultCalculation(VaultCalculationParameters vaultCalculationParameters = default(VaultCalculationParameters))
{
FactSet.AnalyticsAPI.Engines.Client.ApiResponse <Object> localVarResponse = RunVaultCalculationWithHttpInfo(vaultCalculationParameters);
return(localVarResponse.Data);
}
/// <summary>
/// Get PA groups This endpoint lists all the PA groups that can be applied to a PA calculation.
/// </summary>
/// <exception cref="FactSet.AnalyticsAPI.Engines.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
/// <returns>Task of GroupRoot</returns>
public async System.Threading.Tasks.Task <GroupRoot> GetPAGroupsAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken))
{
FactSet.AnalyticsAPI.Engines.Client.ApiResponse <GroupRoot> localVarResponse = await GetPAGroupsWithHttpInfoAsync(cancellationToken).ConfigureAwait(false);
return(localVarResponse.Data);
}
/// <summary>
/// Get PA currencies This endpoint lists all the PA currencies that can be applied to a calculation.
/// </summary>
/// <exception cref="FactSet.AnalyticsAPI.Engines.Client.ApiException">Thrown when fails to make API call</exception>
/// <returns>Dictionary<string, Currency></returns>
public Dictionary <string, Currency> GetPACurrencies()
{
FactSet.AnalyticsAPI.Engines.Client.ApiResponse <Dictionary <string, Currency> > localVarResponse = GetPACurrenciesWithHttpInfo();
return(localVarResponse.Data);
}