@lunch-money/developer-docs 2.11.1-preview.5 → 2.11.1-preview.6

package/docs/README.md

@@ -5,6 +5,7 @@ This directory contains documentation that applies across all API versions.
 ## Current Documents
 
 - `pagination.md` - Pagination guidelines
+- `branding-your-app.md` - Brand assets and usage guidelines for apps built on Lunch Money
 - (To be added) Other version-independent documentation
 
 ## Version-Specific Documentation

package/docs/branding-your-app.md

@@ -0,0 +1,64 @@
+# Branding your App
+
+Building a tool, plugin, or integration on top of Lunch Money? Official brand assets and usage guidelines are available so you can credit Lunch Money clearly without reinventing logos or guessing at naming.
+
+Everything lives in the <a href="https://lunchmoney.app/media-kit/" target="_blank" rel="noopener noreferrer">Lunch Money Media Kit</a>. Use that page as the source of truth for downloads, colors, typography, and the latest guidelines.
+
+## What you'll find in the media kit
+
+For developers, the most useful sections are:
+
+- **Logos** — horizontal, two-row, vertical, and emblem variants (PNG)
+- **Powered by** — a lockup and an embeddable badge for crediting Lunch Money in your app or README
+- **Colors & typography** — brand palette and typefaces (primary: Avenir; monospace: Inconsolata)
+- **Usage guidelines** — clear do's and don'ts for how marks may be used
+- **Product screenshots** — optional visuals if you're writing about or promoting an integration
+
+> [!TIP]
+> Prefer the **Powered by** assets when your project connects to Lunch Money. They make the relationship clear without implying that your app *is* Lunch Money.
+
+## Naming
+
+- Refer to the product as **Lunch Money**
+- Refer to the company as **Lunchbag Labs, Inc.** when a legal or company name is needed
+- Link to <a href="https://lunchmoney.app/" target="_blank" rel="noopener noreferrer">lunchmoney.app</a> when you mention the product
+
+Avoid nicknames, abbreviations, or stylized spellings of the product name in user-facing copy.
+
+## Usage guidelines
+
+### Do
+
+- Use official logos without alteration
+- Use the provided **Powered by** lockup or badge when acknowledging Lunch Money
+- Keep enough clear space around logos so they stay readable
+- Download assets from the media kit rather than cropping screenshots of the logo
+
+### Don't
+
+- Stretch, rotate, or recolor logos
+- Add effects, shadows, or outlines to the logo
+- Modify the smiling coin mascot character
+- Imply endorsement, partnership, or official status without permission
+
+> [!NOTE]
+> The Lunch Money name, logo, and mascot character are trademarks of Lunchbag Labs, Inc. All rights reserved.
+
+## Suggested placements
+
+A few common, low-friction ways to brand an integration:
+
+1. **README or docs** — a short "Built with Lunch Money" line plus the Powered by badge linking to <a href="https://lunchmoney.app/" target="_blank" rel="noopener noreferrer">lunchmoney.app</a>
+2. **App footer or about screen** — the Powered by lockup next to your own branding
+3. **Onboarding or connect flow** — official logo when prompting users to authorize or paste an access token
+4. **Community listings** — consistent naming ("My Tool for Lunch Money") so users can find and trust your project
+
+Keep your own product name primary. Lunch Money branding should signal the connection, not compete with your identity.
+
+## Need help?
+
+If you're unsure whether a use is appropriate, or you need a format that isn't in the media kit:
+
+- Start with the <a href="https://lunchmoney.app/media-kit/" target="_blank" rel="noopener noreferrer">Media Kit</a>
+- Ask in the <a href="https://lunchmoney.app/discord" target="_blank" rel="noopener noreferrer">Lunch Money Discord</a> **#developer-api** channel
+- [Email our developer advocate](mailto:jp@lunchmoney.app)

package/manifest.json

@@ -57,6 +57,14 @@
       "type": "markdown",
       "aliases": ["/v2/using-with-ai"]
     },
+    {
+      "path": "/branding-your-app",
+      "file": "docs/branding-your-app.md",
+      "title": "Branding your App",
+      "section": "GUIDES",
+      "type": "markdown",
+      "aliases": ["/v2/branding-your-app"]
+    },
     {
       "path": "/v2/overview",
       "file": "v2/docs/intro-to-v2.md",
@@ -191,7 +199,8 @@
         { "label": "Pagination", "path": "/pagination" },
         { "label": "Rate Limiting", "path": "/rate-limits" },
         { "label": "Supported Currencies", "path": "/currencies" },
-        { "label": "Using the API with AI", "path": "/using-with-ai" }
+        { "label": "Using the API with AI", "path": "/using-with-ai" },
+        { "label": "Branding your App", "path": "/branding-your-app" }
       ]},
       { "section": "REFERENCE", "items": [
         { "label": "v2 API Overview", "path": "/v2/overview" },

package/package.json

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

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

@@ -6,19 +6,36 @@ info:
 
     Welcome to the Lunch Money v2 API reference. This is the **v2.11.1** spec.
 
-    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).
+    > [!warning]
+    > **Preview endpoints (subject to change)**
+    >
+    > - [`GET /v2/me/account/settings`](#tag/me/GET/me/account/settings)
+    > - [`PUT /v2/me/account/settings`](#tag/me/PUT/me/account/settings)
+    > - [`GET /v2/me/user/settings`](#tag/me/GET/me/user/settings)
+    > - [`PUT /v2/me/user/settings`](#tag/me/PUT/me/user/settings)
+    >
+    > <p class="preview-endpoints-footer" style="margin:0.85em 0 0;padding:0;text-align:left;width:100%;box-sizing:border-box">Do not release production apps using these endpoints. Feedback is welcome. <a href="mailto:dev-support@lunchmoney.app">Email dev-support@lunchmoney.app</a> or join us in the <a href="https://discord.com/channels/842337014556262411/1134594318414389258">developers channel</a> on the <a href="https://lunchmoney.app/discord">Lunch Money Discord</a>.</p>
+
+    The most recent stable version of the API is v2.11.0 and is available at:
+    `https://api.lunchmoney.dev/v2`
+
+    See the [stable Developer Portal](https://lunchmoney.dev/v2).
+
+    ------------------------------------------------------------------------------------------------
+
+    The API is available at `https://api-beta.lunchmoney.app/v2`. Get your access token from the [Lunch Money developers page](https://my.lunchmoney.app/developers).
 
     
     **Try it from these docs**
 
     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.
+    Requests sent to `https://api-beta.lunchmoney.app/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://beta.lunchmoney.dev/v2/getting-started) before using the live API.
     
     **Static mock server**
 
-    Explore without risk to real data. Select `http://mock.lunchmoney.dev/v2` in the Server dropdown to work with static mock data.
+    Explore without risk to real data. Select `https://beta-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.
     
 
@@ -28,14 +45,14 @@ info:
 
     **Migrating from v1**
 
-    The v2 API is not backwards compatible with v1. See the [Migration Guide](https://lunchmoney.dev/v2/migration-guide) for details.
+    The v2 API is not backwards compatible with v1. See the [Migration Guide](https://beta.lunchmoney.dev/v2/migration-guide) for details.
 
     **Useful links**
-    - [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)
-    - [Migration Guide](https://lunchmoney.dev/v2/migration-guide)
-    - [Rate Limits](https://lunchmoney.dev/v2/rate-limits)
+    - [Getting Started Guide](https://beta.lunchmoney.dev/v2/getting-started)
+    - [v2 API Overview](https://beta.lunchmoney.dev/v2/overview)
+    - [Version History](https://beta.lunchmoney.dev/v2/version-history)
+    - [Migration Guide](https://beta.lunchmoney.dev/v2/migration-guide)
+    - [Rate Limits](https://beta.lunchmoney.dev/v2/rate-limits)
   termsOfService: https://lunchmoney.dev/#current-status
   contact:
     email: devsupport@lunchmoney.app
@@ -45,9 +62,9 @@ info:
   version: 2.11.1
 
 servers:
-  - url: https://api.lunchmoney.dev/v2
+  - url: https://api-beta.lunchmoney.app/v2
     description: ⚠ LIVE — changes real Lunch Money data
-  - url: http://mock.lunchmoney.dev/v2
+  - url: https://beta-mock.lunchmoney.dev/v2
     description: MOCK — static demo data, no API key required
 
 tags:
@@ -3056,7 +3073,7 @@ components:
         currency:
           description: Three-letter lowercase currency code of the transaction
             in ISO 4217 format. Must match one of the [supported
-            currencies](https://lunchmoney.dev/v2/currencies). If not set
+            currencies](https://beta.lunchmoney.dev/v2/currencies). If not set
             defaults to the user account's primary currency.
           allOf:
             - $ref: "#/components/schemas/currencyEnum"
@@ -4984,7 +5001,12 @@ paths:
         - me
       summary: Get account settings
       description: |-
-        Returns account-level settings for the budgeting account associated with the authorized API token.
+        > [!warning]
+        > **Preview endpoint** — behavior is subject to change. This endpoint is available in the mock server but not implemented yet on the live api service. Design feedback is welcome. [Email dev-support@lunchmoney.app](mailto:dev-support@lunchmoney.app) or join us in the [developers channel](https://discord.com/channels/842337014556262411/1134594318414389258) on the [Lunch Money Discord](https://lunchmoney.app/discord).
+
+
+        Returns account-level settings for the budgeting account associated with the authorized API token.<p>
+        These settings apply only to this budgeting account; a user with access to multiple budgets has separate account settings for each.
       operationId: getAccountSettings
       responses:
         "200":
@@ -5016,8 +5038,14 @@ paths:
         - me
       summary: Update account settings
       description: |-
+        > [!warning]
+        > **Preview endpoint** — behavior is subject to change. This endpoint is available in the mock server but not implemented yet on the live api service. Design feedback is welcome. [Email dev-support@lunchmoney.app](mailto:dev-support@lunchmoney.app) or join us in the [developers channel](https://discord.com/channels/842337014556262411/1134594318414389258) on the [Lunch Money Discord](https://lunchmoney.app/discord).
+
+
         Updates account-level settings for the budgeting account
-        associated with the authorized API token.<p> You may submit the response from a
+        associated with the authorized API token.<p> 
+        These settings apply only to this budgeting account; a user with access to multiple budgets has separate account settings for each.<p>
+        You may submit the response from a
         `GET /me/account/settings` as the request body; however, only certain
         properties can be updated.<p> It is also possible to provide only the
         properties to be updated in the request body, as long as the request
@@ -5062,7 +5090,12 @@ paths:
         - me
       summary: Get user settings
       description: |-
-        Returns user-level display and formatting preferences for the user associated with the authorized API token.
+        > [!warning]
+        > **Preview endpoint** — behavior is subject to change. This endpoint is available in the mock server but not implemented yet on the live api service. Design feedback is welcome. [Email dev-support@lunchmoney.app](mailto:dev-support@lunchmoney.app) or join us in the [developers channel](https://discord.com/channels/842337014556262411/1134594318414389258) on the [Lunch Money Discord](https://lunchmoney.app/discord).
+
+
+        Returns user-level display and formatting preferences for the user associated with the authorized API token.<p>
+        User settings belong to the user and apply across all budgets they can access.
       operationId: getUserSettings
       responses:
         "200":
@@ -5092,8 +5125,14 @@ paths:
         - me
       summary: Update user settings
       description: |-
+        > [!warning]
+        > **Preview endpoint** — behavior is subject to change. This endpoint is available in the mock server but not implemented yet on the live api service. Design feedback is welcome. [Email dev-support@lunchmoney.app](mailto:dev-support@lunchmoney.app) or join us in the [developers channel](https://discord.com/channels/842337014556262411/1134594318414389258) on the [Lunch Money Discord](https://lunchmoney.app/discord).
+
+
         Updates user-level display and formatting preferences for the user
-        associated with the authorized API token.<p> You may submit the response
+        associated with the authorized API token.<p>
+        User settings belong to the user and apply across all budgets they can access.<p>
+        You may submit the response from a
         from a `GET /me/user/settings` as the request body; however, only
         certain properties can be updated.<p> It is also possible to provide
         only the properties to be updated in the request body, as long as the
@@ -9214,19 +9253,19 @@ paths:
           description: Sets the maximum number of transactions to return. If
             more match the filter criteria, the response will include a
             `has_more` attribute set to `true`. See
-            [Pagination](https://lunchmoney.dev/v2/pagination)
+            [Pagination](https://beta.lunchmoney.dev/v2/pagination)
         - name: offset
           in: query
           schema:
             type: integer
           description: Sets the offset for the records returned. This is
             typically set automatically in the header. See
-            [Pagination](https://lunchmoney.dev/v2/pagination)
+            [Pagination](https://beta.lunchmoney.dev/v2/pagination)
       responses:
         "200":
           description: Returns an array of transactions. <br><br>The `has_more`
             property is set to `true` if more transactions are available. See
-            [Pagination](https://lunchmoney.dev/v2/pagination)
+            [Pagination](https://beta.lunchmoney.dev/v2/pagination)
           content:
             application/json:
               schema: