@lunch-money/developer-docs 2.11.0-preview.10 → 2.11.0-preview.9

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.
@@ -2,6 +2,10 @@
2
2
 
3
3
  Welcome to the Lunch Money developer documentation. This site covers the **v2 API** — the current generation of the Lunch Money API — along with guides, a reference for the legacy v1 API, and tools for exploring the API without touching real data.
4
4
 
5
+ > [!WARNING]
6
+ > Alpha Release
7
+ > The v2 API is in open alpha. It is subject to change during this review period and bugs may exist. We strongly encourage using the [mock service](#trying-the-api-without-real-data) or a test budget with sample data as your first step.
8
+
5
9
  ## Getting Started
6
10
 
7
11
  The v2 API is available at:
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@lunch-money/developer-docs",
3
- "version": "2.11.0-preview.10",
3
+ "version": "2.11.0-preview.9",
4
4
  "description": "Developer documentation content for Lunch Money APIs",
5
5
  "exports": {
6
6
  ".": "./package.json",
@@ -2,13 +2,11 @@ openapi: 3.0.2
2
2
  info:
3
3
  title: Lunch Money API - v2
4
4
  description: |-
5
- Welcome to the Lunch Money v2 API reference. This is the **v2.11.0** spec.
6
-
7
5
  ### Introduction
8
6
 
9
- The API is available at `https://lunchmoney.dev/v2`. Get your access token from the [Lunch Money developers page](https://my.lunchmoney.app/developers).
7
+ The API is available at `https://api.lunchmoney.dev/v2`. Get your access token from the [Lunch Money developers page](https://my.lunchmoney.app/developers).
10
8
 
11
- API calls can <span class="red-text"><strong>change or delete</strong></span> your data. Any changes you make are <span class="red-text"><strong>permanent</strong></span>, just like they would be if you made changes using the web or mobile app. Please refer to the [Getting Started Guide](https://lunchmoney.dev/v2/getting-started) before using the API.
9
+ <span class="red-text"><strong>The v2 API is in open alpha and is still subject to change. Use the mock server or a test budget when getting started.</strong></span>
12
10
 
13
11
  **Static Mock Server**
14
12
 
@@ -20,15 +18,15 @@ info:
20
18
 
21
19
  **Migrating from v1**
22
20
 
23
- The v2 API is not backwards compatible with v1. See the [Migration Guide](https://lunchmoney.dev/v2/migration-guide) for details.
21
+ The v2 API is not backwards compatible with v1. See the [Migration Guide](https://alpha.lunchmoney.dev/v2/migration-guide) for details.
24
22
 
25
23
  **Useful links**
26
- - [Developer Portal](https://lunchmoney.dev/v2/introduction)
27
- - [Getting Started Guide](https://lunchmoney.dev/v2/getting-started)
28
- - [v2 API Overview](https://lunchmoney.dev/v2/overview)
29
- - [Version History](https://lunchmoney.dev/v2/version-history)
30
- - [Migration Guide](https://lunchmoney.dev/v2/migration-guide)
31
- - [Rate Limits](https://lunchmoney.dev/v2/rate-limits)
24
+ - [Developer Portal](https://alpha.lunchmoney.dev/v2/introduction)
25
+ - [Getting Started Guide](https://alpha.lunchmoney.dev/v2/getting-started)
26
+ - [v2 API Overview](https://alpha.lunchmoney.dev/v2/overview)
27
+ - [Version History](https://alpha.lunchmoney.dev/v2/version-history)
28
+ - [Migration Guide](https://alpha.lunchmoney.dev/v2/migration-guide)
29
+ - [Rate Limits](https://alpha.lunchmoney.dev/v2/rate-limits)
32
30
  termsOfService: https://lunchmoney.dev/#current-status
33
31
  contact:
34
32
  email: devsupport@lunchmoney.app
@@ -40,8 +38,8 @@ info:
40
38
  servers:
41
39
  - url: https://api.lunchmoney.dev/v2
42
40
  description: v2 Lunch Money API Server - changes will affect real data!
43
- # - url: https://lunchmoney.dev/v2
44
- - url: https://lunchmoney.dev/v2
41
+ # - url: https://mock.lunchmoney.dev/v2
42
+ - url: https://lm-v2-api-next-a7fabcab8e9a.herokuapp.com/v2/
45
43
  description: Static mock version of the v2 Lunch Money API Server
46
44
 
47
45
  tags:
@@ -2933,7 +2931,7 @@ components:
2933
2931
  currency:
2934
2932
  description: Three-letter lowercase currency code of the transaction
2935
2933
  in ISO 4217 format. Must match one of the [supported
2936
- currencies](https://lunchmoney.dev/v2/currencies). If not set
2934
+ currencies](https://lm-v2-api-next-a7fabcab8e9a.herokuapp.com/v2/currencies). If not set
2937
2935
  defaults to the user account's primary currency.
2938
2936
  allOf:
2939
2937
  - $ref: "#/components/schemas/currencyEnum"
@@ -8561,19 +8559,19 @@ paths:
8561
8559
  description: Sets the maximum number of transactions to return. If
8562
8560
  more match the filter criteria, the response will include a
8563
8561
  `has_more` attribute set to `true`. See
8564
- [Pagination](https://lunchmoney.dev/v2/pagination)
8562
+ [Pagination](https://lm-v2-api-next-a7fabcab8e9a.herokuapp.com/v2/pagination)
8565
8563
  - name: offset
8566
8564
  in: query
8567
8565
  schema:
8568
8566
  type: integer
8569
8567
  description: Sets the offset for the records returned. This is
8570
8568
  typically set automatically in the header. See
8571
- [Pagination](https://lunchmoney.dev/v2/pagination)
8569
+ [Pagination](https://lm-v2-api-next-a7fabcab8e9a.herokuapp.com/v2/pagination)
8572
8570
  responses:
8573
8571
  "200":
8574
8572
  description: Returns an array of transactions. <br><br>The `has_more`
8575
8573
  property is set to `true` if more transactions are available. See
8576
- [Pagination](https://lunchmoney.dev/v2/pagination)
8574
+ [Pagination](https://lm-v2-api-next-a7fabcab8e9a.herokuapp.com/v2/pagination)
8577
8575
  content:
8578
8576
  application/json:
8579
8577
  schema: