Skip to content

Commit

Permalink
upgrade to api version 1.4.0
Browse files Browse the repository at this point in the history
  • Loading branch information
ms32035 committed Oct 25, 2020
1 parent 4cb169b commit 20f96e3
Show file tree
Hide file tree
Showing 253 changed files with 13,584 additions and 4,136 deletions.
2 changes: 1 addition & 1 deletion .generator/Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,5 @@ docker-compose run firefly_iii_client_generator

This should generate a new package in `target` directory

You can next sync only needed files back to he root of the repo dir
You can next sync only needed files back to the root of the repo dir
with `.generator/postgenerate.sh`
2 changes: 1 addition & 1 deletion .generator/generate.sh
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ then
SPEC_FILE=$1
else
SPEC_FILE=/build/firefly-iii.yaml
wget https://api-docs.firefly-iii.org/firefly-iii-${API_VERSION}.yaml -O ${SPEC_FILE}
curl https://api-docs.firefly-iii.org/firefly-iii-${API_VERSION}.yaml -o ${SPEC_FILE}
fi
checkStatus

Expand Down
2 changes: 1 addition & 1 deletion .openapi-generator/VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
4.0.3
4.3.1
4 changes: 2 additions & 2 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
FROM openapitools/openapi-generator-cli:v4.0.3
FROM openapitools/openapi-generator-cli:v4.3.1

RUN apk add \
--update ca-certificates openssl python3 git && \
--update ca-certificates openssl python3 git curl && \
update-ca-certificates && \
pip3 install pyyaml && \
mkdir /build && \
Expand Down
76 changes: 59 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ This is the Python client for Firefly III API

This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 1.2.0
- Package version: 1.2.0
- API version: 1.4.0
- Package version: 1.4.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
For more information, please visit [https://firefly-iii.org](https://firefly-iii.org)

Expand All @@ -15,7 +15,7 @@ Python 2.7 and 3.4+
## Installation & Usage
### pip install

If the python package is hosted on Github, you can install directly from Github
If the python package is hosted on a repository, you can install directly using:

```sh
pip install firefly-iii-client
Expand All @@ -24,7 +24,7 @@ pip install firefly-iii-client

Then import the package:
```python
import firefly_iii_client
import firefly_iii_client
```

### Setuptools
Expand All @@ -47,28 +47,43 @@ Please follow the [installation procedure](#installation--usage) and then run th

```python
from __future__ import print_function

import time
import firefly_iii_client
from firefly_iii_client.rest import ApiException
from pprint import pprint

configuration = firefly_iii_client.configuration.Configuration()
# Defining the host is optional and defaults to https://demo.firefly-iii.org
# See configuration.py for a list of all supported configuration parameters.
configuration = firefly_iii_client.Configuration(
host = "https://demo.firefly-iii.org"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure OAuth2 access token for authorization: firefly_iii_auth
configuration = firefly_iii_client.Configuration(
host = "https://demo.firefly-iii.org"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'
configuration.host = 'YOUR_HOST_URL'

# Defining host is optional and default to https://demo.firefly-iii.org
configuration.host = "https://demo.firefly-iii.org"
# Create an instance of the API class
api_instance = firefly_iii_client.AboutApi(firefly_iii_client.ApiClient(configuration))

try:
# System information end point.
api_response = api_instance.get_about()
pprint(api_response)
except ApiException as e:
print("Exception when calling AboutApi->get_about: %s\n" % e)

# Enter a context with an instance of the API client
with firefly_iii_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = firefly_iii_client.AboutApi(api_client)

try:
# System information end point.
api_response = api_instance.get_about()
pprint(api_response)
except ApiException as e:
print("Exception when calling AboutApi->get_about: %s\n" % e)

```

## Documentation for API Endpoints
Expand All @@ -94,6 +109,19 @@ Class | Method | HTTP request | Description
*AttachmentsApi* | [**store_attachment**](docs/AttachmentsApi.md#store_attachment) | **POST** /api/v1/attachments | Store a new attachment.
*AttachmentsApi* | [**update_attachment**](docs/AttachmentsApi.md#update_attachment) | **PUT** /api/v1/attachments/{id} | Update existing attachment.
*AttachmentsApi* | [**upload_attachment**](docs/AttachmentsApi.md#upload_attachment) | **POST** /api/v1/attachments/{id}/upload | Upload an attachment.
*AutocompleteApi* | [**get_accounts_ac**](docs/AutocompleteApi.md#get_accounts_ac) | **GET** /api/v1/autocomplete/accounts | All accounts of the user returned in a basic auto-complete array.
*AutocompleteApi* | [**get_bills_ac**](docs/AutocompleteApi.md#get_bills_ac) | **GET** /api/v1/autocomplete/bills | All bills of the user returned in a basic auto-complete array.
*AutocompleteApi* | [**get_budgets_ac**](docs/AutocompleteApi.md#get_budgets_ac) | **GET** /api/v1/autocomplete/budgets | All budgets of the user returned in a basic auto-complete array.
*AutocompleteApi* | [**get_categories_ac**](docs/AutocompleteApi.md#get_categories_ac) | **GET** /api/v1/autocomplete/categories | All categories of the user returned in a basic auto-complete array.
*AutocompleteApi* | [**get_currencies_ac**](docs/AutocompleteApi.md#get_currencies_ac) | **GET** /api/v1/autocomplete/currencies | All currencies of the user returned in a basic auto-complete array.
*AutocompleteApi* | [**get_currencies_code_ac**](docs/AutocompleteApi.md#get_currencies_code_ac) | **GET** /api/v1/autocomplete/currencies-with-code | All currencies of the user returned in a basic auto-complete array.
*AutocompleteApi* | [**get_object_groups_ac**](docs/AutocompleteApi.md#get_object_groups_ac) | **GET** /api/v1/autocomplete/object-groups | All object groups of the user returned in a basic auto-complete array.
*AutocompleteApi* | [**get_rule_groups_ac**](docs/AutocompleteApi.md#get_rule_groups_ac) | **GET** /api/v1/autocomplete/rule-groups | All rule groups of the user returned in a basic auto-complete array.
*AutocompleteApi* | [**get_rules_ac**](docs/AutocompleteApi.md#get_rules_ac) | **GET** /api/v1/autocomplete/rules | All rules of the user returned in a basic auto-complete array.
*AutocompleteApi* | [**get_tag_ac**](docs/AutocompleteApi.md#get_tag_ac) | **GET** /api/v1/autocomplete/tags | All tags of the user returned in a basic auto-complete array.
*AutocompleteApi* | [**get_transaction_types_ac**](docs/AutocompleteApi.md#get_transaction_types_ac) | **GET** /api/v1/autocomplete/transaction-types | All transaction types returned in a basic auto-complete array. English only.
*AutocompleteApi* | [**get_transactions_ac**](docs/AutocompleteApi.md#get_transactions_ac) | **GET** /api/v1/autocomplete/transactions | All transaction descriptions of the user returned in a basic auto-complete array.
*AutocompleteApi* | [**get_transactions_idac**](docs/AutocompleteApi.md#get_transactions_idac) | **GET** /api/v1/autocomplete/transactions-with-id | All transactions, complemented with their ID, of the user returned in a basic auto-complete array.
*AvailableBudgetsApi* | [**delete_available_budget**](docs/AvailableBudgetsApi.md#delete_available_budget) | **DELETE** /api/v1/available_budgets/{id} | Delete an available budget.
*AvailableBudgetsApi* | [**get_available_budget**](docs/AvailableBudgetsApi.md#get_available_budget) | **GET** /api/v1/available_budgets/{id} | Get a single available budget.
*AvailableBudgetsApi* | [**list_available_budget**](docs/AvailableBudgetsApi.md#list_available_budget) | **GET** /api/v1/available_budgets | List all available budget amounts.
Expand Down Expand Up @@ -151,7 +179,7 @@ Class | Method | HTTP request | Description
*CurrenciesApi* | [**list_transaction_by_currency**](docs/CurrenciesApi.md#list_transaction_by_currency) | **GET** /api/v1/currencies/{code}/transactions | List all transactions with this currency.
*CurrenciesApi* | [**store_currency**](docs/CurrenciesApi.md#store_currency) | **POST** /api/v1/currencies | Store a new currency
*CurrenciesApi* | [**update_currency**](docs/CurrenciesApi.md#update_currency) | **PUT** /api/v1/currencies/{code} | Update existing currency.
*CurrencyExchangeRatesApi* | [**get_exchange_rate**](docs/CurrencyExchangeRatesApi.md#get_exchange_rate) | **GET** /api/v1/cer | Get an exchange rate.
*DataApi* | [**destroy_data**](docs/DataApi.md#destroy_data) | **DELETE** /api/v1/data/destroy | Endpoint to destroy user data
*ImportApi* | [**get_import**](docs/ImportApi.md#get_import) | **GET** /api/v1/import/{key} | Show info on a single import
*ImportApi* | [**list_import**](docs/ImportApi.md#list_import) | **GET** /api/v1/import/list | List al imports
*ImportApi* | [**list_transaction_by_import**](docs/ImportApi.md#list_transaction_by_import) | **GET** /api/v1/import/{key}/transactions | List all transactions related to the import job. The correlation is made through the tag.
Expand Down Expand Up @@ -237,6 +265,19 @@ Class | Method | HTTP request | Description
- [AttachmentArray](docs/AttachmentArray.md)
- [AttachmentRead](docs/AttachmentRead.md)
- [AttachmentSingle](docs/AttachmentSingle.md)
- [AutocompleteAccount](docs/AutocompleteAccount.md)
- [AutocompleteBill](docs/AutocompleteBill.md)
- [AutocompleteBudget](docs/AutocompleteBudget.md)
- [AutocompleteCategory](docs/AutocompleteCategory.md)
- [AutocompleteCurrency](docs/AutocompleteCurrency.md)
- [AutocompleteCurrencyCode](docs/AutocompleteCurrencyCode.md)
- [AutocompleteObjectGroup](docs/AutocompleteObjectGroup.md)
- [AutocompleteRule](docs/AutocompleteRule.md)
- [AutocompleteRuleGroup](docs/AutocompleteRuleGroup.md)
- [AutocompleteTag](docs/AutocompleteTag.md)
- [AutocompleteTransaction](docs/AutocompleteTransaction.md)
- [AutocompleteTransactionID](docs/AutocompleteTransactionID.md)
- [AutocompleteTransactionType](docs/AutocompleteTransactionType.md)
- [AvailableBudget](docs/AvailableBudget.md)
- [AvailableBudgetArray](docs/AvailableBudgetArray.md)
- [AvailableBudgetRead](docs/AvailableBudgetRead.md)
Expand Down Expand Up @@ -271,6 +312,7 @@ Class | Method | HTTP request | Description
- [CurrencyArray](docs/CurrencyArray.md)
- [CurrencyRead](docs/CurrencyRead.md)
- [CurrencySingle](docs/CurrencySingle.md)
- [DataDestroyObject](docs/DataDestroyObject.md)
- [ExchangeRate](docs/ExchangeRate.md)
- [ExchangeRateArray](docs/ExchangeRateArray.md)
- [ExchangeRateAttributes](docs/ExchangeRateAttributes.md)
Expand Down
2 changes: 1 addition & 1 deletion docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ services:
- ./target:/build/target
- .:/build/src:ro
environment:
API_VERSION: 1.2.0
API_VERSION: 1.4.0
74 changes: 50 additions & 24 deletions docs/AboutApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,21 +24,34 @@ import time
import firefly_iii_client
from firefly_iii_client.rest import ApiException
from pprint import pprint
configuration = firefly_iii_client.Configuration()
# Defining the host is optional and defaults to https://demo.firefly-iii.org
# See configuration.py for a list of all supported configuration parameters.
configuration = firefly_iii_client.Configuration(
host = "https://demo.firefly-iii.org"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure OAuth2 access token for authorization: firefly_iii_auth
configuration = firefly_iii_client.Configuration(
host = "https://demo.firefly-iii.org"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Defining host is optional and default to https://demo.firefly-iii.org
configuration.host = "https://demo.firefly-iii.org"
# Create an instance of the API class
api_instance = firefly_iii_client.AboutApi(firefly_iii_client.ApiClient(configuration))

try:
# System information end point.
api_response = api_instance.get_about()
pprint(api_response)
except ApiException as e:
print("Exception when calling AboutApi->get_about: %s\n" % e)
# Enter a context with an instance of the API client
with firefly_iii_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = firefly_iii_client.AboutApi(api_client)
try:
# System information end point.
api_response = api_instance.get_about()
pprint(api_response)
except ApiException as e:
print("Exception when calling AboutApi->get_about: %s\n" % e)
```

### Parameters
Expand Down Expand Up @@ -80,21 +93,34 @@ import time
import firefly_iii_client
from firefly_iii_client.rest import ApiException
from pprint import pprint
configuration = firefly_iii_client.Configuration()
# Defining the host is optional and defaults to https://demo.firefly-iii.org
# See configuration.py for a list of all supported configuration parameters.
configuration = firefly_iii_client.Configuration(
host = "https://demo.firefly-iii.org"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure OAuth2 access token for authorization: firefly_iii_auth
configuration = firefly_iii_client.Configuration(
host = "https://demo.firefly-iii.org"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Defining host is optional and default to https://demo.firefly-iii.org
configuration.host = "https://demo.firefly-iii.org"
# Create an instance of the API class
api_instance = firefly_iii_client.AboutApi(firefly_iii_client.ApiClient(configuration))

try:
# Currently authenticated user endpoint.
api_response = api_instance.get_current_user()
pprint(api_response)
except ApiException as e:
print("Exception when calling AboutApi->get_current_user: %s\n" % e)
# Enter a context with an instance of the API client
with firefly_iii_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = firefly_iii_client.AboutApi(api_client)
try:
# Currently authenticated user endpoint.
api_response = api_instance.get_current_user()
pprint(api_response)
except ApiException as e:
print("Exception when calling AboutApi->get_current_user: %s\n" % e)
```

### Parameters
Expand Down
19 changes: 10 additions & 9 deletions docs/Account.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,29 +7,30 @@ Name | Type | Description | Notes
**account_role** | **str** | Is only mandatory when the type is asset. | [optional]
**active** | **bool** | If omitted, defaults to true. | [optional]
**bic** | **str** | | [optional]
**created_at** | **datetime** | | [optional]
**created_at** | **datetime** | | [optional] [readonly]
**credit_card_type** | **str** | Mandatory when the account_role is ccAsset. Can only be monthlyFull. | [optional]
**currency_code** | **str** | Use either currency_id or currency_code. Defaults to the user's default currency. | [optional]
**currency_decimal_places** | **int** | | [optional]
**currency_decimal_places** | **int** | | [optional] [readonly]
**currency_id** | **int** | Use either currency_id or currency_code. Defaults to the user's default currency. | [optional]
**currency_symbol** | **str** | | [optional]
**current_balance** | **float** | | [optional]
**current_balance_date** | **date** | | [optional]
**currency_symbol** | **str** | | [optional] [readonly]
**current_balance** | **str** | | [optional] [readonly]
**current_balance_date** | **date** | | [optional] [readonly]
**iban** | **str** | | [optional]
**include_net_worth** | **bool** | If omitted, defaults to true. | [optional]
**interest** | **str** | Mandatory when type is liability. Interest percentage. | [optional]
**interest_period** | **str** | Mandatory when type is liability. Period over which the interest is calculated. | [optional]
**liability_amount** | **float** | Mandatory when type is liability. Amount of money in the liability. Must be positive. | [optional]
**liability_amount** | **str** | Mandatory when type is liability. Amount of money in the liability. Must be positive. | [optional]
**liability_start_date** | **date** | Mandatory when type is liability. Start date for the liability. | [optional]
**liability_type** | **str** | Mandatory when type is liability. Specifies the exact type. | [optional]
**monthly_payment_date** | **date** | Mandatory when the account_role is ccAsset. Moment at which CC payment installments are asked for by the bank. | [optional]
**name** | **str** | |
**notes** | **str** | | [optional]
**opening_balance** | **float** | | [optional]
**opening_balance** | **str** | | [optional]
**opening_balance_date** | **date** | | [optional]
**order** | **int** | Order of the account | [optional]
**type** | **str** | Can only be one one these account types. import, initial-balance and reconciliation cannot be set manually. |
**updated_at** | **datetime** | | [optional]
**virtual_balance** | **float** | | [optional]
**updated_at** | **datetime** | | [optional] [readonly]
**virtual_balance** | **str** | | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Expand Down
2 changes: 1 addition & 1 deletion docs/AccountRead.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**attributes** | [**Account**](Account.md) | |
**id** | **str** | |
**id** | **int** | |
**type** | **str** | Immutable value |

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
Expand Down
Loading

0 comments on commit 20f96e3

Please sign in to comment.