@lunch-money/developer-docs 2.11.0-preview.14 → 2.11.0-preview.15

package/docs/beta-introduction.md

@@ -1,5 +1,5 @@
 **Beta Preview Portal** — This developer portal previews planned changes including:
-
+- V2 API Mock Service no longer requires authentication
 - Beta versions of new [v2 API](/v2/docs) endpoints:
   - [/crypto/manual](v2/docs#tag/crypto-manual)
   - [/crypto/synced](v2/docs#tag/crypto-synced)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lunch-money/developer-docs",
-  "version": "2.11.0-preview.14",
+  "version": "2.11.0-preview.15",
   "description": "Developer documentation content for Lunch Money APIs",
   "exports": {
     ".": "./package.json",

package/v2/spec/lunch-money-api-v2.yaml

@@ -6,13 +6,21 @@ info:
 
     ### Introduction
 
-    The API is available at `https://lunchmoney.dev/v2`. Get your access token from the [Lunch Money developers page](https://my.lunchmoney.app/developers).
+    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).
 
-    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.
+    
+    **Try it from these docs**
 
-    **Static Mock Server**
+    These docs are interactive — use **Test request** on any endpoint to call the API from this page.
+    Choose a LIVE or MOCK service from the Server dropdown.
+    Requests sent to `https://api.lunchmoney.dev/v2` can <span class="red-text"><strong>change or delete</strong></span> your data and are <span class="red-text"><strong>permanent</strong></span>.
+    See the [Getting Started Guide](https://lunchmoney.dev/v2/getting-started) before using the live API.
+    
+    **Static mock server**
 
-    Explore the API without an access token or risk to real data. Select **"Static Mock v2 Lunch Money API Server"** from the Server dropdown, then set your Bearer token to any string with 11 or more characters.
+    Explore without risk to real data. Select `http://mock.lunchmoney.dev/v2` in the Server dropdown to work with static mock data.
+    POST, PUT, and DELETE requests will return realistic responses, but do not change the mock data.
+    
 
     **Client Libraries & SDKs**
 
@@ -23,7 +31,6 @@ info:
     The v2 API is not backwards compatible with v1. See the [Migration Guide](https://lunchmoney.dev/v2/migration-guide) for details.
 
     **Useful links**
-    - [Developer Portal](https://lunchmoney.dev/v2/introduction)
     - [Getting Started Guide](https://lunchmoney.dev/v2/getting-started)
     - [v2 API Overview](https://lunchmoney.dev/v2/overview)
     - [Version History](https://lunchmoney.dev/v2/version-history)
@@ -39,10 +46,9 @@ info:
 
 servers:
   - url: https://api.lunchmoney.dev/v2
-    description: v2 Lunch Money API Server - changes will affect real data!
-#  - url: https://lunchmoney.dev/v2
-  - url: https://lunchmoney.dev/v2
-    description: Static mock version of the v2 Lunch Money API Server
+    description: ⚠ LIVE — changes real Lunch Money data
+  - url: http://mock.lunchmoney.dev/v2
+    description: MOCK — static demo data, no API key required
 
 tags:
   - name: me
@@ -4444,22 +4450,10 @@ components:
   securitySchemes:
     bearerSecurity:
       type: http
-      # TODO Make this shorter?
-      # description: The Lunch Money API uses API keys to authenticate requests. To use
-      #   the v1 API you can view and manage your API keys on the [developers page
-      #   in the Lunch Money app](https://my.lunchmoney.app/developers). <p> To
-      #   interact with the Static Mock Server simply enter an API key of 11
-      #   characters or more. <p> To interact with the v2 service implemented on
-      #   top of the v1 API paste in a real API token associated with a Lunch
-      #   Money Budget.
-      description: To interact with the Static Mock Server simply enter an API
-        key of 11 characters or more.
+      description: >-
+        Required for the LIVE server. Optional for MOCK.
       scheme: bearer
       bearerFormat: JWT
-    cookieAuth:
-      type: apiKey
-      in: cookie
-      name: _lm_access_token
 
 paths:
   /me:
@@ -5739,12 +5733,9 @@ paths:
       tags:
         - crypto-manual
       summary: Get all supported cryptocurrencies
-      description: >
+      description: |-
         Retrieve the list of cryptocurrencies currently supported for manual tracking.<p>
-
-        When creating a new manual crypto balance via `POST /crypto/manual`, the
-        `symbol` you specify must match the `symbol` of one of the entries
-        returned by this endpoint.
+        When creating a new manual crypto balance via `POST /crypto/manual`, the `symbol` you specify must match the `symbol` of one of the entries returned by this endpoint.
       operationId: getAllCryptocurrencies
       responses:
         "200":
@@ -5782,16 +5773,9 @@ paths:
         - crypto-manual
       summary: Add a new supported cryptocurrency
       operationId: createCryptocurrency
-      description: >-
+      description: |-
         Adds a new cryptocurrency to the supported manual-crypto list.<br><br>
-
-        Lunch Money uses [CoinGecko](https://www.coingecko.com/us/coins/ethereum)
-        to convert crypto balances to the user's primary currency. Users add a
-        new supported cryptocurrency by submitting a CoinGecko coin-page URL.
-        The server validates the URL, extracts the id from `/coins/{id}`,
-        checks for an existing supported `coingecko_id`, validates the id
-        against CoinGecko, then confirms the resolved symbol is not already
-        supported before creating the new entry.
+        Lunch Money uses [CoinGecko](https://www.coingecko.com/us/coins/ethereum) to convert crypto balances to the user's primary currency. Users add a new supported cryptocurrency by submitting a CoinGecko coin-page URL. The server validates the URL, extracts the id from `/coins/{id}`, checks for an existing supported `coingecko_id`, validates the id against CoinGecko, then confirms the resolved symbol is not already supported before creating the new entry.
       requestBody:
         required: true
         content:
@@ -5870,8 +5854,8 @@ paths:
       tags:
         - crypto-manual
       summary: Get all manual crypto balances
-      description: Retrieve all manually managed crypto balances associated with
-        the user's account.
+      description: |-
+        Retrieve all manually managed crypto balances associated with the user's account.
       operationId: getAllCryptoManual
       responses:
         "200":
@@ -5905,11 +5889,9 @@ paths:
       tags:
         - crypto-manual
       summary: Create a manual crypto balance
-      description: >-
+      description: |-
         Create a manually managed crypto asset.<br><br>
-
-        If `display_name` is `null`, clients may derive one from
-        `institution_name` + `name`.
+        If `display_name` is `null`, clients may derive one from `institution_name` + `name`.
       operationId: createCryptoManual
       requestBody:
         required: true
@@ -5994,7 +5976,8 @@ paths:
       tags:
         - crypto-manual
       summary: Get a single manual crypto balance
-      description: Retrieve a single manually managed crypto balance by ID.
+      description: |-
+        Retrieve a single manually managed crypto balance by ID.
       operationId: getCryptoManualById
       parameters:
         - name: id
@@ -6062,11 +6045,9 @@ paths:
       tags:
         - crypto-manual
       summary: Update a manual crypto balance
-      description: >-
+      description: |-
         Modify a manually managed crypto balance.<br><br>
-
-        You may submit the response from `GET /crypto/manual/{id}` as the request body. System-defined properties
-        are accepted according to the `x-updatable` metadata in the update schema.
+        You may submit the response from `GET /crypto/manual/{id}` as the request body. System-defined properties are accepted according to the `x-updatable` metadata in the update schema.
       operationId: updateCryptoManual
       parameters:
         - name: id
@@ -6163,10 +6144,8 @@ paths:
       tags:
         - crypto-manual
       summary: Delete a manual crypto balance
-      description: Delete a single manually managed crypto asset by ID.<p> If
-        this crypto asset has a balance history, and you do not explicitly set
-        the query parameter`keep_history`, a 422 response will be returned
-        requesting you to explicitly set `keep_history` to `true` or `false`.
+      description: |-
+        Delete a single manually managed crypto asset by ID.<p> If this crypto asset has a balance history, and you do not explicitly set the query parameter`keep_history`, a 422 response will be returned requesting you to explicitly set `keep_history` to `true` or `false`.
       operationId: deleteCryptoManual
       parameters:
         - name: id
@@ -6231,8 +6210,8 @@ paths:
       tags:
         - crypto-synced
       summary: Get all synced crypto accounts
-      description: Retrieves all synced crypto accounts
-        associated with the user's account.
+      description: |-
+        Retrieves all synced crypto accounts associated with the user's account.
       operationId: getAllCryptoSynced
       responses:
         "200":
@@ -6294,8 +6273,8 @@ paths:
       tags:
         - crypto-synced
       summary: Get a single synced crypto account
-      description: Retrieves the synced crypto account and all nested balances
-        for the specified synced crypto account ID.
+      description: |-
+        Retrieves the synced crypto account and all nested balances for the specified synced crypto account ID.
       operationId: getCryptoSyncedById
       parameters:
         - name: id
@@ -6375,8 +6354,8 @@ paths:
       tags:
         - crypto-synced
       summary: Get a synced crypto balance by symbol
-      description: Retrieves a single balance from the specified synced crypto
-        account using the crypto symbol.
+      description: |-
+        Retrieves a single balance from the specified synced crypto account using the crypto symbol.
       operationId: getCryptoSyncedBalanceBySymbol
       parameters:
         - name: id
@@ -6455,8 +6434,8 @@ paths:
       tags:
         - crypto-synced
       summary: Refresh balances for a synced crypto account
-      description: Trigger a balance refresh for the specified synced crypto
-        account. Returns the refreshed synced crypto account.
+      description: |-
+        Trigger a balance refresh for the specified synced crypto account. Returns the refreshed synced crypto account.
       operationId: refreshCryptoSynced
       parameters:
         - name: id
@@ -6525,24 +6504,11 @@ paths:
       tags:
         - balance_history
       summary: Get balance history
-      description: >-
+      description: |-
         Retrieve historical balance entries.<br><br>
-
-        Balance history is monthly. When `start_date` and `end_date` are both provided,
-        they must be first-of-month dates. `start_date` must not be in the future,
-        while `end_date` may be in the future. If one of `start_date` or `end_date`
-        is provided, the other is required. If neither is provided, all available
-        balance history is returned.<br><br>
-
-        The response groups entries by source account. Each item in
-        `balance_history` contains a `source` object plus a `balances` array
-        containing one balance entry per month in the requested range, or all
-        stored entries when no range is provided.<br><br>
-
-        Historical entries for accounts that have been deleted may still
-        be returned. These entries use `source.type: deleted` and include
-        `deleted_account_id`, archived display fields, and account metadata on the
-        `source` object.
+        Balance history is monthly. When `start_date` and `end_date` are both provided, they must be first-of-month dates. `start_date` must not be in the future, while `end_date` may be in the future. If one of `start_date` or `end_date` is provided, the other is required. If neither is provided, all available balance history is returned.<br><br>
+        The response groups entries by source account. Each item in `balance_history` contains a `source` object plus a `balances` array containing one balance entry per month in the requested range, or all stored entries when no range is provided.<br><br>
+        Historical entries for accounts that have been deleted may still be returned. These entries use `source.type: deleted` and include `deleted_account_id`, archived display fields, and account metadata on the `source` object.
       operationId: getBalanceHistory
       parameters:
         - name: start_date
@@ -6747,17 +6713,10 @@ paths:
       tags:
         - balance_history
       summary: Get balance history for an account
-      description: >-
-        Retrieve historical balance entries for one manual, Plaid, manual crypto,
-        or deleted account.  Crypto synced accounts require an additional `symbol` path parameter.<br><br>
-
-        The `account_type` path parameter identifies the type of account and the
-        `account_id` path parameter identifies the specific id for that account type.<br><br>
-
-        When `start_date` and `end_date` are both provided, they must be first-of-month
-        dates. `start_date` must not be in the future, while `end_date` may be in the future.
-        If one of `start_date` or `end_date` is provided, the other is required. If neither is
-        provided, all available history for the source is returned.
+      description: |-
+        Retrieve historical balance entries for one manual, Plaid, manual crypto, or deleted account.  Crypto synced accounts require an additional `symbol` path parameter.<br><br>
+        The `account_type` path parameter identifies the type of account and the `account_id` path parameter identifies the specific id for that account type.<br><br>
+        When `start_date` and `end_date` are both provided, they must be first-of-month dates. `start_date` must not be in the future, while `end_date` may be in the future. If one of `start_date` or `end_date` is provided, the other is required. If neither is provided, all available history for the source is returned.
       operationId: getBalanceHistoryForAccount
       parameters:
         - name: account_type
@@ -6879,30 +6838,14 @@ paths:
       tags:
         - balance_history
       summary: Upsert balance history for an account
-      description: >-
-        Upsert one or more historical balance entries for a single manual, Plaid,
-        manual crypto, or deleted account. Crypto synced accounts require an additional `symbol` path parameter.<br><br>
-
-        The `account_type` path parameter identifies the type of account and the
-        `account_id` path parameter identifies the specific id for that account type.<br><br>
-
-        Submit one or more entries in the `balances` array. Each entry must specify
-        a `date` and `balance` value.<br><br>
-
-        Balance history is monthly. Each entry's `date` must be the first day of
-        a month and must be in a past month.<br><br>
-
-        `currency` may be provided for any balance entry. If omitted, it defaults
-        to the account currency for manual/Plaid accounts, or the user's primary
-        currency for crypto/deleted accounts.<br><br>
-
-        `symbol` may only be set when `account_type` is `crypto_manual` or
-        `crypto_synced`. It is optional for `crypto_manual` accounts and tolerated
-        for `deleted` accounts.<br><br>
-
-        `crypto_balance` may be provided for `crypto_manual`, `crypto_synced`, and
-        `deleted` accounts, and is invalid for `manual` or `plaid` accounts.<br><br>
-
+      description: |-
+        Upsert one or more historical balance entries for a single manual, Plaid, manual crypto, or deleted account. Crypto synced accounts require an additional `symbol` path parameter.<br><br>
+        The `account_type` path parameter identifies the type of account and the `account_id` path parameter identifies the specific id for that account type.<br><br>
+        Submit one or more entries in the `balances` array. Each entry must specify a `date` and `balance` value.<br><br>
+        Balance history is monthly. Each entry's `date` must be the first day of a month and must be in a past month.<br><br>
+        `currency` may be provided for any balance entry. If omitted, it defaults to the account currency for manual/Plaid accounts, or the user's primary currency for crypto/deleted accounts.<br><br>
+        `symbol` may only be set when `account_type` is `crypto_manual` or `crypto_synced`. It is optional for `crypto_manual` accounts and tolerated for `deleted` accounts.<br><br>
+        `crypto_balance` may be provided for `crypto_manual`, `crypto_synced`, and `deleted` accounts, and is invalid for `manual` or `plaid` accounts.<br><br>
         The response contains only the balance entries that were submitted in this request. 
       operationId: upsertBalanceHistoryForAccount
       parameters:
@@ -7088,9 +7031,8 @@ paths:
       tags:
         - balance_history
       summary: Delete all balance history for an account
-      description: >-
-        Delete all historical balance entries for a single manual, Plaid,
-        manual crypto, or deleted account. Crypto synced accounts require an additional `symbol` path parameter.
+      description: |-
+        Delete all historical balance entries for a single manual, Plaid, manual crypto, or deleted account. Crypto synced accounts require an additional `symbol` path parameter.
       operationId: deleteBalanceHistoryForAccount
       parameters:
         - name: account_type
@@ -7133,16 +7075,10 @@ paths:
       tags:
         - balance_history
       summary: Get balance history for a synced crypto symbol
-      description: >-
+      description: |-
         Retrieve historical balance entries for a single synced crypto symbol stream.<br><br>
-
-        Use the `crypto_synced` account id together with a `symbol` path parameter
-        to select one balance stream within that synced crypto account.<br><br>
-
-        When `start_date` and `end_date` are both provided, they must be first-of-month
-        dates. `start_date` must not be in the future, while `end_date` may be in the future.
-        If one of `start_date` or `end_date` is provided, the other is required. If neither is
-        provided, all available history for the symbol stream is returned.
+        Use the `crypto_synced` account id together with a `symbol` path parameter to select one balance stream within that synced crypto account.<br><br>
+        When `start_date` and `end_date` are both provided, they must be first-of-month dates. `start_date` must not be in the future, while `end_date` may be in the future. If one of `start_date` or `end_date` is provided, the other is required. If neither is provided, all available history for the symbol stream is returned.
       operationId: getBalanceHistoryForCryptoSynced
       parameters:
         - name: account_id
@@ -7238,27 +7174,14 @@ paths:
       tags:
         - balance_history
       summary: Upsert balance history for a synced crypto symbol
-      description: >-
-        Upsert one or more historical balance entries for a single synced crypto
-        symbol stream.<br><br>
-
+      description: |-
+        Upsert one or more historical balance entries for a single synced crypto symbol stream.<br><br>
         The path identifies both the synced crypto account and the symbol being updated.<br><br>
-
-        Submit one or more entries in the `balances` array. Each entry must specify
-        a `date` and `balance` value.<br><br>
-
-        Balance history is monthly. Each entry's `date` must be the first day of
-        a month and must be in a past month.<br><br>
-
-        The request body may include an optional `symbol` on each balance entry. If
-        provided, it must match the `symbol` path parameter. Omit `symbol` to use
-        the path value.<br><br>
-
-        `currency` may be provided for any balance entry. If omitted, it defaults
-        to the user's primary currency for synced crypto balances.<br><br>
-
+        Submit one or more entries in the `balances` array. Each entry must specify a `date` and `balance` value.<br><br>
+        Balance history is monthly. Each entry's `date` must be the first day of a month and must be in a past month.<br><br>
+        The request body may include an optional `symbol` on each balance entry. If provided, it must match the `symbol` path parameter. Omit `symbol` to use the path value.<br><br>
+        `currency` may be provided for any balance entry. If omitted, it defaults to the user's primary currency for synced crypto balances.<br><br>
         `crypto_balance` may be provided for synced crypto balances.<br><br>
-
         The response contains only the balance entries that were submitted in this request. 
       operationId: upsertBalanceHistoryForCryptoSynced
       parameters:
@@ -7391,11 +7314,9 @@ paths:
       tags:
         - balance_history
       summary: Delete all balance history for a synced crypto symbol
-      description: >-
+      description: |-
         Delete all historical balance entries for a single synced crypto symbol stream.<br><br>
-
-        The path identifies both the synced crypto account and the symbol whose
-        history should be deleted.
+        The path identifies both the synced crypto account and the symbol whose history should be deleted.
       operationId: deleteBalanceHistoryForCryptoSynced
       parameters:
         - name: account_id
@@ -7437,7 +7358,7 @@ paths:
       tags:
         - balance_history
       summary: Delete a balance history entry
-      description: >-
+      description: |-
         Delete a single monthly balance history entry by its id.
       operationId: deleteBalanceHistoryEntry
       parameters:
@@ -7482,12 +7403,9 @@ paths:
       tags:
         - balance_history
       summary: Update details for a deleted account
-      description: >-
+      description: |-
         Update archived metadata for a deleted balance history source.<br><br>
-
-        Pass the `deleted` source id returned on `source.deleted_account_id`.
-        This endpoint updates the stored deleted-source metadata used for all
-        historical entries associated with that deleted source.
+        Pass the `deleted` source id returned on `source.deleted_account_id`. This endpoint updates the stored deleted-source metadata used for all historical entries associated with that deleted source.
       operationId: updateBalanceHistoryDetails
       parameters:
         - name: account_id
@@ -10797,9 +10715,8 @@ paths:
         - transactions (files)
       summary: Attach a file to a transaction
       operationId: attachFileToTransaction
-      description: >-
-        Attaches a file to a transaction. The file must be less than 10MB in size.<br><br>
-        The file will be attached to the transaction and can be downloaded from the link returned by a `GET /transactions/attachments/{file_id}` request.
+      description: |-
+        Attaches a file to a transaction. The file must be less than 10MB in size.<br><br> The file will be attached to the transaction and can be downloaded from the link returned by a `GET /transactions/attachments/{file_id}` request.
       parameters:
         - name: transaction_id
           in: path
@@ -10882,8 +10799,8 @@ paths:
   /transactions/attachments/{file_id}:
     get:
       summary: Get a url to download a file attachment
-      description: Returns a signed url that can be used to download the file
-        attachment.
+      description: |-
+        Returns a signed url that can be used to download the file attachment.
       operationId: getTransactionAttachmentUrl
       tags:
         - transactions (files)
@@ -11776,4 +11693,3 @@ paths:
 
 security:
   - bearerSecurity: []
-  - cookieAuth: []