ynab 1.47.0 → 1.49.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +6 -6
- package/package.json +5 -3
package/README.md
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
[](https://github.com/ynab/ynab-sdk-js/actions/workflows/ci.yml)
|
|
4
4
|
[](https://badge.fury.io/js/ynab)
|
|
5
5
|
|
|
6
|
-
Please read the [YNAB API documentation](https://api.
|
|
6
|
+
Please read the [YNAB API documentation](https://api.ynab.com) for an overview of using the API and a complete list of available resources.
|
|
7
7
|
|
|
8
8
|
This client is generated using the [Swagger Code Generator](https://github.com/swagger-api/swagger-codegen).
|
|
9
9
|
|
|
@@ -59,8 +59,8 @@ Using the "latest" tag will result in a 302 redirect to the latest version tag s
|
|
|
59
59
|
## Usage
|
|
60
60
|
|
|
61
61
|
To use this client, you must
|
|
62
|
-
[obtain an access token](https://api.
|
|
63
|
-
the [Account Settings](https://app.
|
|
62
|
+
[obtain an access token](https://api.ynab.com/#authentication-overview) from
|
|
63
|
+
the [Account Settings](https://app.ynab.com/settings) area of the YNAB web
|
|
64
64
|
application.
|
|
65
65
|
|
|
66
66
|
```typescript
|
|
@@ -106,9 +106,9 @@ const budgetsResponse = ynabAPI.budgets
|
|
|
106
106
|
|
|
107
107
|
### Rate Limiting
|
|
108
108
|
|
|
109
|
-
The API enforces [Rate Limiting](https://api.
|
|
109
|
+
The API enforces [Rate Limiting](https://api.ynab.com/#rate-limiting).
|
|
110
110
|
|
|
111
|
-
If the rate limit is exceeded, a `429` [Error Response](https://api.
|
|
111
|
+
If the rate limit is exceeded, a `429` [Error Response](https://api.ynab.com/#errors) will be returned from the API which will result in an [error being thrown](https://github.com/ynab/ynab-sdk-js#error-handling) in this library.
|
|
112
112
|
|
|
113
113
|
You can access the rate limiting info through the `rateLimit` property on a response object. It will contain the value from the `X-Rate-Limit` response header.
|
|
114
114
|
|
|
@@ -163,7 +163,7 @@ The following methods are available in this library. For more details on paramet
|
|
|
163
163
|
### Utilities
|
|
164
164
|
|
|
165
165
|
There are several utilities available on the `utils` export to make working
|
|
166
|
-
with [ISO dates and milliunits](https://api.
|
|
166
|
+
with [ISO dates and milliunits](https://api.ynab.com/#formats) a bit
|
|
167
167
|
easier.
|
|
168
168
|
|
|
169
169
|
```typescript
|
package/package.json
CHANGED
|
@@ -1,8 +1,10 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "ynab",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.49.0",
|
|
4
4
|
"description": "YNAB API Javascript (Node) Library",
|
|
5
|
-
"author": "
|
|
5
|
+
"author": "YNAB",
|
|
6
|
+
"email": "api@ynab.com",
|
|
7
|
+
"url": "https://api.ynab.com",
|
|
6
8
|
"keywords": [
|
|
7
9
|
"typescript",
|
|
8
10
|
"swagger-client",
|
|
@@ -23,7 +25,7 @@
|
|
|
23
25
|
"url": "https://github.com/ynab/ynab-sdk-js.git"
|
|
24
26
|
},
|
|
25
27
|
"engines": {
|
|
26
|
-
"node": "
|
|
28
|
+
"node": "<=18"
|
|
27
29
|
},
|
|
28
30
|
"scripts": {
|
|
29
31
|
"generate": "npx jsh ./.swagger-codegen/generate.js",
|