Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gemini/config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
have_fun: false
code_review:
disable: true
4 changes: 3 additions & 1 deletion .openapi-generator/FILES
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@ docs/PayeesResponseData.md
docs/PostAccountWrapper.md
docs/PostScheduledTransactionWrapper.md
docs/PostTransactionsWrapper.md
docs/PutScheduledTransactionWrapper.md
docs/PutTransactionWrapper.md
docs/SaveAccount.md
docs/SaveCategory.md
Expand Down Expand Up @@ -105,9 +106,9 @@ docs/UserResponse.md
docs/UserResponseData.md
pyproject.toml
requirements.txt
setup.cfg
test-requirements.txt
test/__init__.py
test/test_put_scheduled_transaction_wrapper.py
tox.ini
ynab/__init__.py
ynab/api/__init__.py
Expand Down Expand Up @@ -183,6 +184,7 @@ ynab/models/payees_response_data.py
ynab/models/post_account_wrapper.py
ynab/models/post_scheduled_transaction_wrapper.py
ynab/models/post_transactions_wrapper.py
ynab/models/put_scheduled_transaction_wrapper.py
ynab/models/put_transaction_wrapper.py
ynab/models/save_account.py
ynab/models/save_category.py
Expand Down
2 changes: 1 addition & 1 deletion .openapi-generator/VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
7.10.0
7.12.0
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,8 @@ Class | Method | Description
**ScheduledTransactionsApi** | [**create_scheduled_transaction**](docs/ScheduledTransactionsApi.md#create_scheduled_transaction) | Create a single scheduled transaction
  | [**get_scheduled_transaction_by_id**](docs/ScheduledTransactionsApi.md#get_scheduled_transaction_by_id) | Single scheduled transaction
  | [**get_scheduled_transactions**](docs/ScheduledTransactionsApi.md#get_scheduled_transactions) | List scheduled transactions
  | [**update_scheduled_transaction**](docs/ScheduledTransactionsApi.md#update_scheduled_transaction) | Update an existing scheduled transactions
  | [**delete_scheduled_transaction**](docs/ScheduledTransactionsApi.md#delete_scheduled_transaction) | Delete an existing scheduled transaction
**TransactionsApi** | [**create_transaction**](docs/TransactionsApi.md#create_transaction) | Create a single transaction or multiple transactions
  | [**delete_transaction**](docs/TransactionsApi.md#delete_transaction) | Deletes an existing transaction
  | [**get_transaction_by_id**](docs/TransactionsApi.md#get_transaction_by_id) | Single transaction
Expand Down
29 changes: 29 additions & 0 deletions docs/PutScheduledTransactionWrapper.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# PutScheduledTransactionWrapper


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**scheduled_transaction** | [**SaveScheduledTransaction**](SaveScheduledTransaction.md) | |

## Example

```python
from ynab.models.put_scheduled_transaction_wrapper import PutScheduledTransactionWrapper

# TODO update the JSON string below
json = "{}"
# create an instance of PutScheduledTransactionWrapper from a JSON string
put_scheduled_transaction_wrapper_instance = PutScheduledTransactionWrapper.from_json(json)
# print the JSON string representation of the object
print(PutScheduledTransactionWrapper.to_json())

# convert the object into a dict
put_scheduled_transaction_wrapper_dict = put_scheduled_transaction_wrapper_instance.to_dict()
# create an instance of PutScheduledTransactionWrapper from a dict
put_scheduled_transaction_wrapper_from_dict = PutScheduledTransactionWrapper.from_dict(put_scheduled_transaction_wrapper_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


1 change: 1 addition & 0 deletions docs/SaveCategory.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ Name | Type | Description | Notes
**name** | **str** | | [optional]
**note** | **str** | | [optional]
**category_group_id** | **str** | | [optional]
**goal_target** | **int** | The goal target amount in milliunits format. This amount can only be changed if the category already has a configured goal (goal_type != null). | [optional]

## Example

Expand Down
2 changes: 2 additions & 0 deletions docs/ScheduledSubTransaction.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,9 @@ Name | Type | Description | Notes
**amount** | **int** | The scheduled subtransaction amount in milliunits format |
**memo** | **str** | | [optional]
**payee_id** | **str** | | [optional]
**payee_name** | **str** | | [optional]
**category_id** | **str** | | [optional]
**category_name** | **str** | | [optional]
**transfer_account_id** | **str** | If a transfer, the account_id which the scheduled subtransaction transfers to | [optional]
**deleted** | **bool** | Whether or not the scheduled subtransaction has been deleted. Deleted scheduled subtransactions will only be included in delta requests. |

Expand Down
167 changes: 167 additions & 0 deletions docs/ScheduledTransactionsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,10 @@ All URIs are relative to *https://api.ynab.com/v1*
Method | HTTP request | Description
------------- | ------------- | -------------
[**create_scheduled_transaction**](ScheduledTransactionsApi.md#create_scheduled_transaction) | **POST** /budgets/{budget_id}/scheduled_transactions | Create a single scheduled transaction
[**delete_scheduled_transaction**](ScheduledTransactionsApi.md#delete_scheduled_transaction) | **DELETE** /budgets/{budget_id}/scheduled_transactions | Deletes an existing scheduled transaction
[**get_scheduled_transaction_by_id**](ScheduledTransactionsApi.md#get_scheduled_transaction_by_id) | **GET** /budgets/{budget_id}/scheduled_transactions/{scheduled_transaction_id} | Single scheduled transaction
[**get_scheduled_transactions**](ScheduledTransactionsApi.md#get_scheduled_transactions) | **GET** /budgets/{budget_id}/scheduled_transactions | List scheduled transactions
[**update_scheduled_transaction**](ScheduledTransactionsApi.md#update_scheduled_transaction) | **PUT** /budgets/{budget_id}/scheduled_transactions | Updates an existing scheduled transaction


# **create_scheduled_transaction**
Expand Down Expand Up @@ -91,6 +93,87 @@ Name | Type | Description | Notes

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

# **delete_scheduled_transaction**
> ScheduledTransactionResponse delete_scheduled_transaction(budget_id, scheduled_transaction_id)

Deletes an existing scheduled transaction

Deletes a scheduled transaction

### Example

* Bearer Authentication (bearer):

```python
import ynab
from ynab.models.scheduled_transaction_response import ScheduledTransactionResponse
from ynab.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.ynab.com/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = ynab.Configuration(
host = "https://api.ynab.com/v1"
)

# 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 Bearer authorization: bearer
configuration = ynab.Configuration(
access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with ynab.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = ynab.ScheduledTransactionsApi(api_client)
budget_id = 'budget_id_example' # str | The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.ynab.com/#oauth-default-budget).
scheduled_transaction_id = 'scheduled_transaction_id_example' # str | The id of the scheduled transaction

try:
# Deletes an existing scheduled transaction
api_response = api_instance.delete_scheduled_transaction(budget_id, scheduled_transaction_id)
print("The response of ScheduledTransactionsApi->delete_scheduled_transaction:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ScheduledTransactionsApi->delete_scheduled_transaction: %s\n" % e)
```



### Parameters


Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**budget_id** | **str**| The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.ynab.com/#oauth-default-budget). |
**scheduled_transaction_id** | **str**| The id of the scheduled transaction |

### Return type

[**ScheduledTransactionResponse**](ScheduledTransactionResponse.md)

### Authorization

[bearer](../README.md#bearer)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | The scheduled transaction was successfully deleted | - |
**404** | The scheduled transaction was not found | - |

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

# **get_scheduled_transaction_by_id**
> ScheduledTransactionResponse get_scheduled_transaction_by_id(budget_id, scheduled_transaction_id)

Expand Down Expand Up @@ -255,3 +338,87 @@ Name | Type | Description | Notes

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

# **update_scheduled_transaction**
> ScheduledTransactionResponse update_scheduled_transaction(budget_id, scheduled_transaction_id, put_scheduled_transaction_wrapper)

Updates an existing scheduled transaction

Updates a single scheduled transaction

### Example

* Bearer Authentication (bearer):

```python
import ynab
from ynab.models.put_scheduled_transaction_wrapper import PutScheduledTransactionWrapper
from ynab.models.scheduled_transaction_response import ScheduledTransactionResponse
from ynab.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.ynab.com/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = ynab.Configuration(
host = "https://api.ynab.com/v1"
)

# 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 Bearer authorization: bearer
configuration = ynab.Configuration(
access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with ynab.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = ynab.ScheduledTransactionsApi(api_client)
budget_id = 'budget_id_example' # str | The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.ynab.com/#oauth-default-budget).
scheduled_transaction_id = 'scheduled_transaction_id_example' # str | The id of the scheduled transaction
put_scheduled_transaction_wrapper = ynab.PutScheduledTransactionWrapper() # PutScheduledTransactionWrapper | The scheduled transaction to update

try:
# Updates an existing scheduled transaction
api_response = api_instance.update_scheduled_transaction(budget_id, scheduled_transaction_id, put_scheduled_transaction_wrapper)
print("The response of ScheduledTransactionsApi->update_scheduled_transaction:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling ScheduledTransactionsApi->update_scheduled_transaction: %s\n" % e)
```



### Parameters


Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**budget_id** | **str**| The id of the budget. \"last-used\" can be used to specify the last used budget and \"default\" can be used if default budget selection is enabled (see: https://api.ynab.com/#oauth-default-budget). |
**scheduled_transaction_id** | **str**| The id of the scheduled transaction |
**put_scheduled_transaction_wrapper** | [**PutScheduledTransactionWrapper**](PutScheduledTransactionWrapper.md)| The scheduled transaction to update |

### Return type

[**ScheduledTransactionResponse**](ScheduledTransactionResponse.md)

### Authorization

[bearer](../README.md#bearer)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | The scheduled transaction was successfully updated | - |
**400** | The request could not be understood due to malformed syntax or validation error(s) | - |

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

2 changes: 1 addition & 1 deletion docs/TransactionsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -706,7 +706,7 @@ Name | Type | Description | Notes

Import transactions

Imports available transactions on all linked accounts for the given budget. Linked accounts allow transactions to be imported directly from a specified financial institution and this endpoint initiates that import. Sending a request to this endpoint is the equivalent of clicking \"Import\" on each account in the web application or tapping the \"New Transactions\" banner in the mobile applications. The response for this endpoint contains the transaction ids that have been imported.
Imports available transactions on all linked accounts for the given budget. Linked accounts allow transactions to be imported directly from a specified financial institution and this endpoint initiates that import. Sending a request to this endpoint is the equivalent of clicking "Import" on each account in the web application or tapping the "New Transactions" banner in the mobile applications. The response for this endpoint contains the transaction ids that have been imported.

### Example

Expand Down
Loading