/// <summary>
/// Update an existing user's information. Update existing user.
/// </summary>
/// <exception cref="FireflyIII.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="id">The user ID.</param>
/// <param name="user">JSON array with updated user information. See the model for the exact specifications.</param>
/// <returns>UserSingle</returns>
public UserSingle UpdateUser(int id, User user)
{
FireflyIII.Client.ApiResponse <UserSingle> localVarResponse = UpdateUserWithHttpInfo(id, user);
return(localVarResponse.Data);
}
/// <summary>
/// Get an exchange rate. Get an exchange rate. If Firefly III doesn't know the rate it will set the rate to 1.0.
/// </summary>
/// <exception cref="FireflyIII.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="from">The source currency code. If omitted, defaults to EUR. (optional)</param>
/// <param name="to">The destination currency code. If omitted, defaults to USD. (optional)</param>
/// <param name="date">The date you want to know the exchange rate on. (optional)</param>
/// <param name="amount">The amount in the source currency. If added, Firefly III will calculate the amount in the destination currency. (optional)</param>
/// <returns>ExchangeRate</returns>
public ExchangeRate GetExchangeRate(string from = default(string), string to = default(string), DateTime?date = default(DateTime?), double?amount = default(double?))
{
FireflyIII.Client.ApiResponse <ExchangeRate> localVarResponse = GetExchangeRateWithHttpInfo(from, to, date, amount);
return(localVarResponse.Data);
}
/// <summary>
/// Get an exchange rate. Get an exchange rate. If Firefly III doesn't know the rate it will set the rate to 1.0.
/// </summary>
/// <exception cref="FireflyIII.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="from">The source currency code. If omitted, defaults to EUR. (optional)</param>
/// <param name="to">The destination currency code. If omitted, defaults to USD. (optional)</param>
/// <param name="date">The date you want to know the exchange rate on. (optional)</param>
/// <param name="amount">The amount in the source currency. If added, Firefly III will calculate the amount in the destination currency. (optional)</param>
/// <returns>Task of ExchangeRate</returns>
public async System.Threading.Tasks.Task <ExchangeRate> GetExchangeRateAsync(string from = default(string), string to = default(string), DateTime?date = default(DateTime?), double?amount = default(double?))
{
FireflyIII.Client.ApiResponse <ExchangeRate> localVarResponse = await GetExchangeRateAsyncWithHttpInfo(from, to, date, amount);
return(localVarResponse.Data);
}
/// <summary>
/// Show info on a single import Show info on single import.
/// </summary>
/// <exception cref="FireflyIII.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="key">The job key of an import job.</param>
/// <returns>Task of ImportJobSingle</returns>
public async System.Threading.Tasks.Task <ImportJobSingle> GetImportAsync(string key)
{
FireflyIII.Client.ApiResponse <ImportJobSingle> localVarResponse = await GetImportAsyncWithHttpInfo(key);
return(localVarResponse.Data);
}
/// <summary>
/// Update configuration Set a single config value.
/// </summary>
/// <exception cref="FireflyIII.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="name">The configuration value name.</param>
/// <param name="value">Can be a number or a boolean. This depends on the actual configuration value.</param>
/// <returns>Task of SystemConfiguration</returns>
public async System.Threading.Tasks.Task <SystemConfiguration> SetConfigurationAsync(string name, string value)
{
FireflyIII.Client.ApiResponse <SystemConfiguration> localVarResponse = await SetConfigurationAsyncWithHttpInfo(name, value);
return(localVarResponse.Data);
}
/// <summary>
/// List all users. List all the users in this instance of Firefly III.
/// </summary>
/// <exception cref="FireflyIII.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="page">The page number, if necessary. The default pagination is 50, so 50 users per page. (optional)</param>
/// <returns>UserArray</returns>
public UserArray ListUser(int?page = default(int?))
{
FireflyIII.Client.ApiResponse <UserArray> localVarResponse = ListUserWithHttpInfo(page);
return(localVarResponse.Data);
}
/// <summary>
/// Store a new user Creates a new user. The data required can be submitted as a JSON body or as a list of parameters. The user will be given a random password, which they can reset using the \"forgot password\" function.
/// </summary>
/// <exception cref="FireflyIII.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="user">JSON array or key=value pairs with the necessary user information. See the model for the exact specifications.</param>
/// <returns>UserSingle</returns>
public UserSingle StoreUser(User user)
{
FireflyIII.Client.ApiResponse <UserSingle> localVarResponse = StoreUserWithHttpInfo(user);
return(localVarResponse.Data);
}
/// <summary>
/// Returns basic sums of the users data. Returns basic sums of the users data, like the net worth, spent and earned amounts. It is multi-currency, and is in Firefly III to populate the dashboard.
/// </summary>
/// <exception cref="FireflyIII.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="start">A date formatted YYYY-MM-DD. </param>
/// <param name="end">A date formatted YYYY-MM-DD. </param>
/// <param name="currencyCode">A currency code like EUR or USD, to filter the result. (optional)</param>
/// <returns>List<BasicSummaryEntry></returns>
public List <BasicSummaryEntry> GetBasicSummary(DateTime start, DateTime end, string currencyCode = default(string))
{
FireflyIII.Client.ApiResponse <List <BasicSummaryEntry> > localVarResponse = GetBasicSummaryWithHttpInfo(start, end, currencyCode);
return(localVarResponse.Data);
}
/// <summary>
/// Returns basic sums of the users data. Returns basic sums of the users data, like the net worth, spent and earned amounts. It is multi-currency, and is in Firefly III to populate the dashboard.
/// </summary>
/// <exception cref="FireflyIII.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="start">A date formatted YYYY-MM-DD. </param>
/// <param name="end">A date formatted YYYY-MM-DD. </param>
/// <param name="currencyCode">A currency code like EUR or USD, to filter the result. (optional)</param>
/// <returns>Task of List<BasicSummaryEntry></returns>
public async System.Threading.Tasks.Task <List <BasicSummaryEntry> > GetBasicSummaryAsync(DateTime start, DateTime end, string currencyCode = default(string))
{
FireflyIII.Client.ApiResponse <List <BasicSummaryEntry> > localVarResponse = await GetBasicSummaryAsyncWithHttpInfo(start, end, currencyCode);
return(localVarResponse.Data);
}
/// <summary>
/// System information end point. Returns general system information and versions of the (supporting) software.
/// </summary>
/// <exception cref="FireflyIII.Client.ApiException">Thrown when fails to make API call</exception>
/// <returns>SystemInfo</returns>
public SystemInfo GetAbout()
{
FireflyIII.Client.ApiResponse <SystemInfo> localVarResponse = GetAboutWithHttpInfo();
return(localVarResponse.Data);
}
/// <summary>
/// System information end point. Returns general system information and versions of the (supporting) software.
/// </summary>
/// <exception cref="FireflyIII.Client.ApiException">Thrown when fails to make API call</exception>
/// <returns>Task of SystemInfo</returns>
public async System.Threading.Tasks.Task <SystemInfo> GetAboutAsync()
{
FireflyIII.Client.ApiResponse <SystemInfo> localVarResponse = await GetAboutAsyncWithHttpInfo();
return(localVarResponse.Data);
}
/// <summary>
/// List all transactions related to the import job. The correlation is made through the tag. See summary
/// </summary>
/// <exception cref="FireflyIII.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="key">The key of the import job</param>
/// <param name="page">Page number. The default pagination is 50. (optional)</param>
/// <param name="start">A date formatted YYYY-MM-DD. This is the start date of the selected range (inclusive). (optional)</param>
/// <param name="end">A date formatted YYYY-MM-DD. This is the end date of the selected range (inclusive). (optional)</param>
/// <param name="type">Optional filter on the transaction type(s) returned. (optional)</param>
/// <returns>Task of TransactionArray</returns>
public async System.Threading.Tasks.Task <TransactionArray> ListTransactionByImportAsync(string key, int?page = default(int?), DateTime?start = default(DateTime?), DateTime?end = default(DateTime?), TransactionTypeFilter type = default(TransactionTypeFilter))
{
FireflyIII.Client.ApiResponse <TransactionArray> localVarResponse = await ListTransactionByImportAsyncWithHttpInfo(key, page, start, end, type);
return(localVarResponse.Data);
}
/// <summary>
/// List all transactions related to the import job. The correlation is made through the tag. See summary
/// </summary>
/// <exception cref="FireflyIII.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="key">The key of the import job</param>
/// <param name="page">Page number. The default pagination is 50. (optional)</param>
/// <param name="start">A date formatted YYYY-MM-DD. This is the start date of the selected range (inclusive). (optional)</param>
/// <param name="end">A date formatted YYYY-MM-DD. This is the end date of the selected range (inclusive). (optional)</param>
/// <param name="type">Optional filter on the transaction type(s) returned. (optional)</param>
/// <returns>TransactionArray</returns>
public TransactionArray ListTransactionByImport(string key, int?page = default(int?), DateTime?start = default(DateTime?), DateTime?end = default(DateTime?), TransactionTypeFilter type = default(TransactionTypeFilter))
{
FireflyIII.Client.ApiResponse <TransactionArray> localVarResponse = ListTransactionByImportWithHttpInfo(key, page, start, end, type);
return(localVarResponse.Data);
}
/// <summary>
/// List al imports List all imports
/// </summary>
/// <exception cref="FireflyIII.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="page">Page number. The default pagination is per 50 items. (optional)</param>
/// <returns>ImportJobArray</returns>
public ImportJobArray ListImport(int?page = default(int?))
{
FireflyIII.Client.ApiResponse <ImportJobArray> localVarResponse = ListImportWithHttpInfo(page);
return(localVarResponse.Data);
}
/// <summary>
/// Get a single user. Gets all info of a single user.
/// </summary>
/// <exception cref="FireflyIII.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="id">The user ID.</param>
/// <returns>UserSingle</returns>
public UserSingle GetUser(int id)
{
FireflyIII.Client.ApiResponse <UserSingle> localVarResponse = GetUserWithHttpInfo(id);
return(localVarResponse.Data);
}
/// <summary>
/// Get Firefly III system configuration. Get system configuration
/// </summary>
/// <exception cref="FireflyIII.Client.ApiException">Thrown when fails to make API call</exception>
/// <returns>SystemConfiguration</returns>
public SystemConfiguration GetConfiguration()
{
FireflyIII.Client.ApiResponse <SystemConfiguration> localVarResponse = GetConfigurationWithHttpInfo();
return(localVarResponse.Data);
}
/// <summary>
/// Get a single user. Gets all info of a single user.
/// </summary>
/// <exception cref="FireflyIII.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="id">The user ID.</param>
/// <returns>Task of UserSingle</returns>
public async System.Threading.Tasks.Task <UserSingle> GetUserAsync(int id)
{
FireflyIII.Client.ApiResponse <UserSingle> localVarResponse = await GetUserAsyncWithHttpInfo(id);
return(localVarResponse.Data);
}
/// <summary>
/// Get Firefly III system configuration. Get system configuration
/// </summary>
/// <exception cref="FireflyIII.Client.ApiException">Thrown when fails to make API call</exception>
/// <returns>Task of SystemConfiguration</returns>
public async System.Threading.Tasks.Task <SystemConfiguration> GetConfigurationAsync()
{
FireflyIII.Client.ApiResponse <SystemConfiguration> localVarResponse = await GetConfigurationAsyncWithHttpInfo();
return(localVarResponse.Data);
}
/// <summary>
/// List all users. List all the users in this instance of Firefly III.
/// </summary>
/// <exception cref="FireflyIII.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="page">The page number, if necessary. The default pagination is 50, so 50 users per page. (optional)</param>
/// <returns>Task of UserArray</returns>
public async System.Threading.Tasks.Task <UserArray> ListUserAsync(int?page = default(int?))
{
FireflyIII.Client.ApiResponse <UserArray> localVarResponse = await ListUserAsyncWithHttpInfo(page);
return(localVarResponse.Data);
}
/// <summary>
/// Update configuration Set a single config value.
/// </summary>
/// <exception cref="FireflyIII.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="name">The configuration value name.</param>
/// <param name="value">Can be a number or a boolean. This depends on the actual configuration value.</param>
/// <returns>SystemConfiguration</returns>
public SystemConfiguration SetConfiguration(string name, string value)
{
FireflyIII.Client.ApiResponse <SystemConfiguration> localVarResponse = SetConfigurationWithHttpInfo(name, value);
return(localVarResponse.Data);
}
/// <summary>
/// Store a new user Creates a new user. The data required can be submitted as a JSON body or as a list of parameters. The user will be given a random password, which they can reset using the \"forgot password\" function.
/// </summary>
/// <exception cref="FireflyIII.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="user">JSON array or key=value pairs with the necessary user information. See the model for the exact specifications.</param>
/// <returns>Task of UserSingle</returns>
public async System.Threading.Tasks.Task <UserSingle> StoreUserAsync(User user)
{
FireflyIII.Client.ApiResponse <UserSingle> localVarResponse = await StoreUserAsyncWithHttpInfo(user);
return(localVarResponse.Data);
}
/// <summary>
/// Show info on a single import Show info on single import.
/// </summary>
/// <exception cref="FireflyIII.Client.ApiException">Thrown when fails to make API call</exception>
/// <param name="key">The job key of an import job.</param>
/// <returns>ImportJobSingle</returns>
public ImportJobSingle GetImport(string key)
{
FireflyIII.Client.ApiResponse <ImportJobSingle> localVarResponse = GetImportWithHttpInfo(key);
return(localVarResponse.Data);
}
