go-firefly3/api_configuration.go

446 lines
16 KiB
Go
Raw Normal View History

2024-04-10 12:14:55 +03:00
/*
2024-05-11 14:43:57 +03:00
* Firefly III API v2.0.14
2024-04-10 12:14:55 +03:00
*
2024-05-11 15:15:59 +03:00
* This is the documentation of the Firefly III API. You can find accompanying documentation on the website of Firefly III itself (see below). Please report any bugs or issues. You may use the \"Authorize\" button to try the API below. This file was last generated on 2024-04-20T05:28:29+00:00 Please keep in mind that the demo site does not accept requests from curl, colly, wget, etc. You must use a browser or a tool like Postman to make requests. Too many script kiddies out there, sorry about that.
2024-04-10 12:14:55 +03:00
*
2024-05-11 14:43:57 +03:00
* API version: 2.0.14
2024-04-10 12:14:55 +03:00
* Contact: james@firefly-iii.org
* Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)
*/
2024-05-11 15:26:56 +03:00
package firefly3
2024-04-10 12:14:55 +03:00
import (
"context"
2024-05-11 15:15:59 +03:00
"fmt"
"github.com/antihax/optional"
2024-04-10 12:14:55 +03:00
"io/ioutil"
"net/http"
"net/url"
"strings"
)
// Linger please
var (
_ context.Context
)
type ConfigurationApiService service
2024-05-11 15:15:59 +03:00
2024-04-10 12:14:55 +03:00
/*
ConfigurationApiService Get Firefly III system configuration values.
Returns all editable and not-editable configuration values for this Firefly III installation
* @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
* @param optional nil or *ConfigurationApiGetConfigurationOpts - Optional Parameters:
* @param "XTraceId" (optional.Interface of string) - Unique identifier associated with this request.
@return []Configuration
*/
type ConfigurationApiGetConfigurationOpts struct {
2024-05-11 15:15:59 +03:00
XTraceId optional.Interface
2024-04-10 12:14:55 +03:00
}
func (a *ConfigurationApiService) GetConfiguration(ctx context.Context, localVarOptionals *ConfigurationApiGetConfigurationOpts) ([]Configuration, *http.Response, error) {
var (
2024-05-11 15:15:59 +03:00
localVarHttpMethod = strings.ToUpper("Get")
localVarPostBody interface{}
localVarFileName string
localVarFileBytes []byte
2024-04-10 12:14:55 +03:00
localVarReturnValue []Configuration
)
// create path and map variables
localVarPath := a.client.cfg.BasePath + "/v1/configuration"
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
// to determine the Content-Type header
localVarHttpContentTypes := []string{}
// set Content-Type header
localVarHttpContentType := selectHeaderContentType(localVarHttpContentTypes)
if localVarHttpContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHttpContentType
}
// to determine the Accept header
localVarHttpHeaderAccepts := []string{"application/json", "application/x-www-form-urlencoded"}
// set Accept header
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
if localVarHttpHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHttpHeaderAccept
}
if localVarOptionals != nil && localVarOptionals.XTraceId.IsSet() {
localVarHeaderParams["X-Trace-Id"] = parameterToString(localVarOptionals.XTraceId.Value(), "")
}
r, err := a.client.prepareRequest(ctx, localVarPath, localVarHttpMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFileName, localVarFileBytes)
if err != nil {
return localVarReturnValue, nil, err
}
localVarHttpResponse, err := a.client.callAPI(r)
if err != nil || localVarHttpResponse == nil {
return localVarReturnValue, localVarHttpResponse, err
}
localVarBody, err := ioutil.ReadAll(localVarHttpResponse.Body)
localVarHttpResponse.Body.Close()
if err != nil {
return localVarReturnValue, localVarHttpResponse, err
}
if localVarHttpResponse.StatusCode < 300 {
// If we succeed, return the data, otherwise pass on to decode error.
2024-05-11 15:15:59 +03:00
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHttpResponse.Header.Get("Content-Type"))
if err == nil {
2024-04-10 12:14:55 +03:00
return localVarReturnValue, localVarHttpResponse, err
}
}
if localVarHttpResponse.StatusCode >= 300 {
newErr := GenericSwaggerError{
2024-05-11 15:15:59 +03:00
body: localVarBody,
2024-04-10 12:14:55 +03:00
error: localVarHttpResponse.Status,
}
if localVarHttpResponse.StatusCode == 401 {
var v UnauthenticatedResponse
2024-05-11 15:15:59 +03:00
err = a.client.decode(&v, localVarBody, localVarHttpResponse.Header.Get("Content-Type"))
if err != nil {
newErr.error = err.Error()
2024-04-10 12:14:55 +03:00
return localVarReturnValue, localVarHttpResponse, newErr
2024-05-11 15:15:59 +03:00
}
newErr.model = v
return localVarReturnValue, localVarHttpResponse, newErr
2024-04-10 12:14:55 +03:00
}
if localVarHttpResponse.StatusCode == 404 {
var v NotFoundResponse
2024-05-11 15:15:59 +03:00
err = a.client.decode(&v, localVarBody, localVarHttpResponse.Header.Get("Content-Type"))
if err != nil {
newErr.error = err.Error()
2024-04-10 12:14:55 +03:00
return localVarReturnValue, localVarHttpResponse, newErr
2024-05-11 15:15:59 +03:00
}
newErr.model = v
return localVarReturnValue, localVarHttpResponse, newErr
2024-04-10 12:14:55 +03:00
}
if localVarHttpResponse.StatusCode == 400 {
var v BadRequestResponse
2024-05-11 15:15:59 +03:00
err = a.client.decode(&v, localVarBody, localVarHttpResponse.Header.Get("Content-Type"))
if err != nil {
newErr.error = err.Error()
2024-04-10 12:14:55 +03:00
return localVarReturnValue, localVarHttpResponse, newErr
2024-05-11 15:15:59 +03:00
}
newErr.model = v
return localVarReturnValue, localVarHttpResponse, newErr
2024-04-10 12:14:55 +03:00
}
if localVarHttpResponse.StatusCode == 500 {
var v InternalExceptionResponse
2024-05-11 15:15:59 +03:00
err = a.client.decode(&v, localVarBody, localVarHttpResponse.Header.Get("Content-Type"))
if err != nil {
newErr.error = err.Error()
2024-04-10 12:14:55 +03:00
return localVarReturnValue, localVarHttpResponse, newErr
2024-05-11 15:15:59 +03:00
}
newErr.model = v
return localVarReturnValue, localVarHttpResponse, newErr
2024-04-10 12:14:55 +03:00
}
if localVarHttpResponse.StatusCode == 200 {
var v []Configuration
2024-05-11 15:15:59 +03:00
err = a.client.decode(&v, localVarBody, localVarHttpResponse.Header.Get("Content-Type"))
if err != nil {
newErr.error = err.Error()
2024-04-10 12:14:55 +03:00
return localVarReturnValue, localVarHttpResponse, newErr
2024-05-11 15:15:59 +03:00
}
newErr.model = v
return localVarReturnValue, localVarHttpResponse, newErr
2024-04-10 12:14:55 +03:00
}
return localVarReturnValue, localVarHttpResponse, newErr
}
return localVarReturnValue, localVarHttpResponse, nil
}
2024-05-11 15:15:59 +03:00
2024-04-10 12:14:55 +03:00
/*
ConfigurationApiService Get a single Firefly III system configuration value
Returns one configuration variable for this Firefly III installation
* @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
* @param name The name of the configuration value you want to know.
* @param optional nil or *ConfigurationApiGetSingleConfigurationOpts - Optional Parameters:
* @param "XTraceId" (optional.Interface of string) - Unique identifier associated with this request.
@return ConfigurationSingle
*/
type ConfigurationApiGetSingleConfigurationOpts struct {
2024-05-11 15:15:59 +03:00
XTraceId optional.Interface
2024-04-10 12:14:55 +03:00
}
func (a *ConfigurationApiService) GetSingleConfiguration(ctx context.Context, name ConfigValueFilter, localVarOptionals *ConfigurationApiGetSingleConfigurationOpts) (ConfigurationSingle, *http.Response, error) {
var (
2024-05-11 15:15:59 +03:00
localVarHttpMethod = strings.ToUpper("Get")
localVarPostBody interface{}
localVarFileName string
localVarFileBytes []byte
2024-04-10 12:14:55 +03:00
localVarReturnValue ConfigurationSingle
)
// create path and map variables
localVarPath := a.client.cfg.BasePath + "/v1/configuration/{name}"
localVarPath = strings.Replace(localVarPath, "{"+"name"+"}", fmt.Sprintf("%v", name), -1)
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
// to determine the Content-Type header
localVarHttpContentTypes := []string{}
// set Content-Type header
localVarHttpContentType := selectHeaderContentType(localVarHttpContentTypes)
if localVarHttpContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHttpContentType
}
// to determine the Accept header
localVarHttpHeaderAccepts := []string{"application/json"}
// set Accept header
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
if localVarHttpHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHttpHeaderAccept
}
if localVarOptionals != nil && localVarOptionals.XTraceId.IsSet() {
localVarHeaderParams["X-Trace-Id"] = parameterToString(localVarOptionals.XTraceId.Value(), "")
}
r, err := a.client.prepareRequest(ctx, localVarPath, localVarHttpMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFileName, localVarFileBytes)
if err != nil {
return localVarReturnValue, nil, err
}
localVarHttpResponse, err := a.client.callAPI(r)
if err != nil || localVarHttpResponse == nil {
return localVarReturnValue, localVarHttpResponse, err
}
localVarBody, err := ioutil.ReadAll(localVarHttpResponse.Body)
localVarHttpResponse.Body.Close()
if err != nil {
return localVarReturnValue, localVarHttpResponse, err
}
if localVarHttpResponse.StatusCode < 300 {
// If we succeed, return the data, otherwise pass on to decode error.
2024-05-11 15:15:59 +03:00
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHttpResponse.Header.Get("Content-Type"))
if err == nil {
2024-04-10 12:14:55 +03:00
return localVarReturnValue, localVarHttpResponse, err
}
}
if localVarHttpResponse.StatusCode >= 300 {
newErr := GenericSwaggerError{
2024-05-11 15:15:59 +03:00
body: localVarBody,
2024-04-10 12:14:55 +03:00
error: localVarHttpResponse.Status,
}
if localVarHttpResponse.StatusCode == 401 {
var v UnauthenticatedResponse
2024-05-11 15:15:59 +03:00
err = a.client.decode(&v, localVarBody, localVarHttpResponse.Header.Get("Content-Type"))
if err != nil {
newErr.error = err.Error()
2024-04-10 12:14:55 +03:00
return localVarReturnValue, localVarHttpResponse, newErr
2024-05-11 15:15:59 +03:00
}
newErr.model = v
return localVarReturnValue, localVarHttpResponse, newErr
2024-04-10 12:14:55 +03:00
}
if localVarHttpResponse.StatusCode == 404 {
var v NotFoundResponse
2024-05-11 15:15:59 +03:00
err = a.client.decode(&v, localVarBody, localVarHttpResponse.Header.Get("Content-Type"))
if err != nil {
newErr.error = err.Error()
2024-04-10 12:14:55 +03:00
return localVarReturnValue, localVarHttpResponse, newErr
2024-05-11 15:15:59 +03:00
}
newErr.model = v
return localVarReturnValue, localVarHttpResponse, newErr
2024-04-10 12:14:55 +03:00
}
if localVarHttpResponse.StatusCode == 400 {
var v BadRequestResponse
2024-05-11 15:15:59 +03:00
err = a.client.decode(&v, localVarBody, localVarHttpResponse.Header.Get("Content-Type"))
if err != nil {
newErr.error = err.Error()
2024-04-10 12:14:55 +03:00
return localVarReturnValue, localVarHttpResponse, newErr
2024-05-11 15:15:59 +03:00
}
newErr.model = v
return localVarReturnValue, localVarHttpResponse, newErr
2024-04-10 12:14:55 +03:00
}
if localVarHttpResponse.StatusCode == 500 {
var v InternalExceptionResponse
2024-05-11 15:15:59 +03:00
err = a.client.decode(&v, localVarBody, localVarHttpResponse.Header.Get("Content-Type"))
if err != nil {
newErr.error = err.Error()
2024-04-10 12:14:55 +03:00
return localVarReturnValue, localVarHttpResponse, newErr
2024-05-11 15:15:59 +03:00
}
newErr.model = v
return localVarReturnValue, localVarHttpResponse, newErr
2024-04-10 12:14:55 +03:00
}
if localVarHttpResponse.StatusCode == 200 {
var v ConfigurationSingle
2024-05-11 15:15:59 +03:00
err = a.client.decode(&v, localVarBody, localVarHttpResponse.Header.Get("Content-Type"))
if err != nil {
newErr.error = err.Error()
2024-04-10 12:14:55 +03:00
return localVarReturnValue, localVarHttpResponse, newErr
2024-05-11 15:15:59 +03:00
}
newErr.model = v
return localVarReturnValue, localVarHttpResponse, newErr
2024-04-10 12:14:55 +03:00
}
return localVarReturnValue, localVarHttpResponse, newErr
}
return localVarReturnValue, localVarHttpResponse, nil
}
2024-05-11 15:15:59 +03:00
2024-04-10 12:14:55 +03:00
/*
ConfigurationApiService Update configuration value
Set a single configuration value. Not all configuration values can be updated so the list of accepted configuration variables is small.
* @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
* @param value
* @param name The name of the configuration value you want to update.
* @param optional nil or *ConfigurationApiSetConfigurationOpts - Optional Parameters:
* @param "XTraceId" (optional.Interface of string) - Unique identifier associated with this request.
@return ConfigurationSingle
*/
type ConfigurationApiSetConfigurationOpts struct {
2024-05-11 15:15:59 +03:00
XTraceId optional.Interface
2024-04-10 12:14:55 +03:00
}
func (a *ConfigurationApiService) SetConfiguration(ctx context.Context, value PolymorphicProperty, name ConfigValueUpdateFilter, localVarOptionals *ConfigurationApiSetConfigurationOpts) (ConfigurationSingle, *http.Response, error) {
var (
2024-05-11 15:15:59 +03:00
localVarHttpMethod = strings.ToUpper("Put")
localVarPostBody interface{}
localVarFileName string
localVarFileBytes []byte
2024-04-10 12:14:55 +03:00
localVarReturnValue ConfigurationSingle
)
// create path and map variables
localVarPath := a.client.cfg.BasePath + "/v1/configuration/{name}"
localVarPath = strings.Replace(localVarPath, "{"+"name"+"}", fmt.Sprintf("%v", name), -1)
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
// to determine the Content-Type header
localVarHttpContentTypes := []string{"application/x-www-form-urlencoded", "application/json"}
// set Content-Type header
localVarHttpContentType := selectHeaderContentType(localVarHttpContentTypes)
if localVarHttpContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHttpContentType
}
// to determine the Accept header
localVarHttpHeaderAccepts := []string{"application/json"}
// set Accept header
localVarHttpHeaderAccept := selectHeaderAccept(localVarHttpHeaderAccepts)
if localVarHttpHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHttpHeaderAccept
}
if localVarOptionals != nil && localVarOptionals.XTraceId.IsSet() {
localVarHeaderParams["X-Trace-Id"] = parameterToString(localVarOptionals.XTraceId.Value(), "")
}
// body params
r, err := a.client.prepareRequest(ctx, localVarPath, localVarHttpMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFileName, localVarFileBytes)
if err != nil {
return localVarReturnValue, nil, err
}
localVarHttpResponse, err := a.client.callAPI(r)
if err != nil || localVarHttpResponse == nil {
return localVarReturnValue, localVarHttpResponse, err
}
localVarBody, err := ioutil.ReadAll(localVarHttpResponse.Body)
localVarHttpResponse.Body.Close()
if err != nil {
return localVarReturnValue, localVarHttpResponse, err
}
if localVarHttpResponse.StatusCode < 300 {
// If we succeed, return the data, otherwise pass on to decode error.
2024-05-11 15:15:59 +03:00
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHttpResponse.Header.Get("Content-Type"))
if err == nil {
2024-04-10 12:14:55 +03:00
return localVarReturnValue, localVarHttpResponse, err
}
}
if localVarHttpResponse.StatusCode >= 300 {
newErr := GenericSwaggerError{
2024-05-11 15:15:59 +03:00
body: localVarBody,
2024-04-10 12:14:55 +03:00
error: localVarHttpResponse.Status,
}
if localVarHttpResponse.StatusCode == 200 {
var v ConfigurationSingle
2024-05-11 15:15:59 +03:00
err = a.client.decode(&v, localVarBody, localVarHttpResponse.Header.Get("Content-Type"))
if err != nil {
newErr.error = err.Error()
2024-04-10 12:14:55 +03:00
return localVarReturnValue, localVarHttpResponse, newErr
2024-05-11 15:15:59 +03:00
}
newErr.model = v
return localVarReturnValue, localVarHttpResponse, newErr
2024-04-10 12:14:55 +03:00
}
if localVarHttpResponse.StatusCode == 422 {
var v ValidationErrorResponse
2024-05-11 15:15:59 +03:00
err = a.client.decode(&v, localVarBody, localVarHttpResponse.Header.Get("Content-Type"))
if err != nil {
newErr.error = err.Error()
2024-04-10 12:14:55 +03:00
return localVarReturnValue, localVarHttpResponse, newErr
2024-05-11 15:15:59 +03:00
}
newErr.model = v
return localVarReturnValue, localVarHttpResponse, newErr
2024-04-10 12:14:55 +03:00
}
if localVarHttpResponse.StatusCode == 401 {
var v UnauthenticatedResponse
2024-05-11 15:15:59 +03:00
err = a.client.decode(&v, localVarBody, localVarHttpResponse.Header.Get("Content-Type"))
if err != nil {
newErr.error = err.Error()
2024-04-10 12:14:55 +03:00
return localVarReturnValue, localVarHttpResponse, newErr
2024-05-11 15:15:59 +03:00
}
newErr.model = v
return localVarReturnValue, localVarHttpResponse, newErr
2024-04-10 12:14:55 +03:00
}
if localVarHttpResponse.StatusCode == 404 {
var v NotFoundResponse
2024-05-11 15:15:59 +03:00
err = a.client.decode(&v, localVarBody, localVarHttpResponse.Header.Get("Content-Type"))
if err != nil {
newErr.error = err.Error()
2024-04-10 12:14:55 +03:00
return localVarReturnValue, localVarHttpResponse, newErr
2024-05-11 15:15:59 +03:00
}
newErr.model = v
return localVarReturnValue, localVarHttpResponse, newErr
2024-04-10 12:14:55 +03:00
}
if localVarHttpResponse.StatusCode == 400 {
var v BadRequestResponse
2024-05-11 15:15:59 +03:00
err = a.client.decode(&v, localVarBody, localVarHttpResponse.Header.Get("Content-Type"))
if err != nil {
newErr.error = err.Error()
2024-04-10 12:14:55 +03:00
return localVarReturnValue, localVarHttpResponse, newErr
2024-05-11 15:15:59 +03:00
}
newErr.model = v
return localVarReturnValue, localVarHttpResponse, newErr
2024-04-10 12:14:55 +03:00
}
if localVarHttpResponse.StatusCode == 500 {
var v InternalExceptionResponse
2024-05-11 15:15:59 +03:00
err = a.client.decode(&v, localVarBody, localVarHttpResponse.Header.Get("Content-Type"))
if err != nil {
newErr.error = err.Error()
2024-04-10 12:14:55 +03:00
return localVarReturnValue, localVarHttpResponse, newErr
2024-05-11 15:15:59 +03:00
}
newErr.model = v
return localVarReturnValue, localVarHttpResponse, newErr
2024-04-10 12:14:55 +03:00
}
return localVarReturnValue, localVarHttpResponse, newErr
}
return localVarReturnValue, localVarHttpResponse, nil
}