Skip to content

Commit 561ff67

Browse files
committed
Generate from server version 1.74.0
1 parent 6305346 commit 561ff67

File tree

122 files changed

+1273
-179
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

122 files changed

+1273
-179
lines changed

.openapi-generator/FILES

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,7 @@ docs/PayeesResponseData.md
6363
docs/PostAccountWrapper.md
6464
docs/PostScheduledTransactionWrapper.md
6565
docs/PostTransactionsWrapper.md
66+
docs/PutScheduledTransactionWrapper.md
6667
docs/PutTransactionWrapper.md
6768
docs/SaveAccount.md
6869
docs/SaveCategory.md
@@ -105,9 +106,9 @@ docs/UserResponse.md
105106
docs/UserResponseData.md
106107
pyproject.toml
107108
requirements.txt
108-
setup.cfg
109109
test-requirements.txt
110110
test/__init__.py
111+
test/test_put_scheduled_transaction_wrapper.py
111112
tox.ini
112113
ynab/__init__.py
113114
ynab/api/__init__.py
@@ -183,6 +184,7 @@ ynab/models/payees_response_data.py
183184
ynab/models/post_account_wrapper.py
184185
ynab/models/post_scheduled_transaction_wrapper.py
185186
ynab/models/post_transactions_wrapper.py
187+
ynab/models/put_scheduled_transaction_wrapper.py
186188
ynab/models/put_transaction_wrapper.py
187189
ynab/models/save_account.py
188190
ynab/models/save_category.py

.openapi-generator/VERSION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
7.10.0
1+
7.12.0
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# PutScheduledTransactionWrapper
2+
3+
4+
## Properties
5+
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**scheduled_transaction** | [**SaveScheduledTransaction**](SaveScheduledTransaction.md) | |
9+
10+
## Example
11+
12+
```python
13+
from ynab.models.put_scheduled_transaction_wrapper import PutScheduledTransactionWrapper
14+
15+
# TODO update the JSON string below
16+
json = "{}"
17+
# create an instance of PutScheduledTransactionWrapper from a JSON string
18+
put_scheduled_transaction_wrapper_instance = PutScheduledTransactionWrapper.from_json(json)
19+
# print the JSON string representation of the object
20+
print(PutScheduledTransactionWrapper.to_json())
21+
22+
# convert the object into a dict
23+
put_scheduled_transaction_wrapper_dict = put_scheduled_transaction_wrapper_instance.to_dict()
24+
# create an instance of PutScheduledTransactionWrapper from a dict
25+
put_scheduled_transaction_wrapper_from_dict = PutScheduledTransactionWrapper.from_dict(put_scheduled_transaction_wrapper_dict)
26+
```
27+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
28+
29+

docs/SaveCategory.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
88
**name** | **str** | | [optional]
99
**note** | **str** | | [optional]
1010
**category_group_id** | **str** | | [optional]
11+
**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]
1112

1213
## Example
1314

docs/ScheduledSubTransaction.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,9 @@ Name | Type | Description | Notes
1010
**amount** | **int** | The scheduled subtransaction amount in milliunits format |
1111
**memo** | **str** | | [optional]
1212
**payee_id** | **str** | | [optional]
13+
**payee_name** | **str** | | [optional]
1314
**category_id** | **str** | | [optional]
15+
**category_name** | **str** | | [optional]
1416
**transfer_account_id** | **str** | If a transfer, the account_id which the scheduled subtransaction transfers to | [optional]
1517
**deleted** | **bool** | Whether or not the scheduled subtransaction has been deleted. Deleted scheduled subtransactions will only be included in delta requests. |
1618

docs/ScheduledTransactionsApi.md

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

1113

1214
# **create_scheduled_transaction**
@@ -91,6 +93,87 @@ Name | Type | Description | Notes
9193

9294
[[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)
9395

96+
# **delete_scheduled_transaction**
97+
> ScheduledTransactionResponse delete_scheduled_transaction(budget_id, scheduled_transaction_id)
98+
99+
Deletes an existing scheduled transaction
100+
101+
Deletes a scheduled transaction
102+
103+
### Example
104+
105+
* Bearer Authentication (bearer):
106+
107+
```python
108+
import ynab
109+
from ynab.models.scheduled_transaction_response import ScheduledTransactionResponse
110+
from ynab.rest import ApiException
111+
from pprint import pprint
112+
113+
# Defining the host is optional and defaults to https://api.ynab.com/v1
114+
# See configuration.py for a list of all supported configuration parameters.
115+
configuration = ynab.Configuration(
116+
host = "https://api.ynab.com/v1"
117+
)
118+
119+
# The client must configure the authentication and authorization parameters
120+
# in accordance with the API server security policy.
121+
# Examples for each auth method are provided below, use the example that
122+
# satisfies your auth use case.
123+
124+
# Configure Bearer authorization: bearer
125+
configuration = ynab.Configuration(
126+
access_token = os.environ["BEARER_TOKEN"]
127+
)
128+
129+
# Enter a context with an instance of the API client
130+
with ynab.ApiClient(configuration) as api_client:
131+
# Create an instance of the API class
132+
api_instance = ynab.ScheduledTransactionsApi(api_client)
133+
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).
134+
scheduled_transaction_id = 'scheduled_transaction_id_example' # str | The id of the scheduled transaction
135+
136+
try:
137+
# Deletes an existing scheduled transaction
138+
api_response = api_instance.delete_scheduled_transaction(budget_id, scheduled_transaction_id)
139+
print("The response of ScheduledTransactionsApi->delete_scheduled_transaction:\n")
140+
pprint(api_response)
141+
except Exception as e:
142+
print("Exception when calling ScheduledTransactionsApi->delete_scheduled_transaction: %s\n" % e)
143+
```
144+
145+
146+
147+
### Parameters
148+
149+
150+
Name | Type | Description | Notes
151+
------------- | ------------- | ------------- | -------------
152+
**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). |
153+
**scheduled_transaction_id** | **str**| The id of the scheduled transaction |
154+
155+
### Return type
156+
157+
[**ScheduledTransactionResponse**](ScheduledTransactionResponse.md)
158+
159+
### Authorization
160+
161+
[bearer](../README.md#bearer)
162+
163+
### HTTP request headers
164+
165+
- **Content-Type**: Not defined
166+
- **Accept**: application/json
167+
168+
### HTTP response details
169+
170+
| Status code | Description | Response headers |
171+
|-------------|-------------|------------------|
172+
**200** | The scheduled transaction was successfully deleted | - |
173+
**404** | The scheduled transaction was not found | - |
174+
175+
[[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)
176+
94177
# **get_scheduled_transaction_by_id**
95178
> ScheduledTransactionResponse get_scheduled_transaction_by_id(budget_id, scheduled_transaction_id)
96179
@@ -255,3 +338,87 @@ Name | Type | Description | Notes
255338

256339
[[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)
257340

341+
# **update_scheduled_transaction**
342+
> ScheduledTransactionResponse update_scheduled_transaction(budget_id, scheduled_transaction_id, put_scheduled_transaction_wrapper)
343+
344+
Updates an existing scheduled transaction
345+
346+
Updates a single scheduled transaction
347+
348+
### Example
349+
350+
* Bearer Authentication (bearer):
351+
352+
```python
353+
import ynab
354+
from ynab.models.put_scheduled_transaction_wrapper import PutScheduledTransactionWrapper
355+
from ynab.models.scheduled_transaction_response import ScheduledTransactionResponse
356+
from ynab.rest import ApiException
357+
from pprint import pprint
358+
359+
# Defining the host is optional and defaults to https://api.ynab.com/v1
360+
# See configuration.py for a list of all supported configuration parameters.
361+
configuration = ynab.Configuration(
362+
host = "https://api.ynab.com/v1"
363+
)
364+
365+
# The client must configure the authentication and authorization parameters
366+
# in accordance with the API server security policy.
367+
# Examples for each auth method are provided below, use the example that
368+
# satisfies your auth use case.
369+
370+
# Configure Bearer authorization: bearer
371+
configuration = ynab.Configuration(
372+
access_token = os.environ["BEARER_TOKEN"]
373+
)
374+
375+
# Enter a context with an instance of the API client
376+
with ynab.ApiClient(configuration) as api_client:
377+
# Create an instance of the API class
378+
api_instance = ynab.ScheduledTransactionsApi(api_client)
379+
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).
380+
scheduled_transaction_id = 'scheduled_transaction_id_example' # str | The id of the scheduled transaction
381+
put_scheduled_transaction_wrapper = ynab.PutScheduledTransactionWrapper() # PutScheduledTransactionWrapper | The scheduled transaction to update
382+
383+
try:
384+
# Updates an existing scheduled transaction
385+
api_response = api_instance.update_scheduled_transaction(budget_id, scheduled_transaction_id, put_scheduled_transaction_wrapper)
386+
print("The response of ScheduledTransactionsApi->update_scheduled_transaction:\n")
387+
pprint(api_response)
388+
except Exception as e:
389+
print("Exception when calling ScheduledTransactionsApi->update_scheduled_transaction: %s\n" % e)
390+
```
391+
392+
393+
394+
### Parameters
395+
396+
397+
Name | Type | Description | Notes
398+
------------- | ------------- | ------------- | -------------
399+
**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). |
400+
**scheduled_transaction_id** | **str**| The id of the scheduled transaction |
401+
**put_scheduled_transaction_wrapper** | [**PutScheduledTransactionWrapper**](PutScheduledTransactionWrapper.md)| The scheduled transaction to update |
402+
403+
### Return type
404+
405+
[**ScheduledTransactionResponse**](ScheduledTransactionResponse.md)
406+
407+
### Authorization
408+
409+
[bearer](../README.md#bearer)
410+
411+
### HTTP request headers
412+
413+
- **Content-Type**: application/json
414+
- **Accept**: application/json
415+
416+
### HTTP response details
417+
418+
| Status code | Description | Response headers |
419+
|-------------|-------------|------------------|
420+
**200** | The scheduled transaction was successfully updated | - |
421+
**400** | The request could not be understood due to malformed syntax or validation error(s) | - |
422+
423+
[[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)
424+

docs/TransactionsApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -706,7 +706,7 @@ Name | Type | Description | Notes
706706
707707
Import transactions
708708

709-
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.
709+
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.
710710

711711
### Example
712712

0 commit comments

Comments
 (0)