@lunch-money/v2-api-spec 2.11.0-preview.8 → 2.11.1-preview.1

package/README.md

@@ -21,12 +21,8 @@ After installation, the package provides:
 
 ```javascript
 const fs = require('fs');
-const path = require('path');
 
-const specPath = path.join(
-  __dirname,
-  'node_modules/@lunch-money/v2-api-spec/lunch-money-api-v2.yaml'
-);
+const specPath = require.resolve('@lunch-money/v2-api-spec/lunch-money-api-v2.yaml');
 const spec = fs.readFileSync(specPath, 'utf8');
 ```
 
@@ -123,14 +119,17 @@ For example, version `2.8.2` means:
 - 8 main endpoint groups
 - 2 updates since the 8th endpoint was added
 
+## Related Packages
+
+This package is the canonical v2 OpenAPI specification artifact. The `@lunch-money/developer-docs` package ships the public documentation content and may include a convenience copy of the spec under `v2/spec/`, but API tooling should consume the YAML from `@lunch-money/v2-api-spec`.
+
 ## Resources
 
 - [Lunch Money Website](https://lunchmoney.app)
 - [Interactive API Documentation](https://alpha.lunchmoney.dev/v2/docs)
-- [GitHub Repository](https://github.com/lunch-money/api-specs)
+- [GitHub Repository](https://github.com/lunch-money/developer-docs)
 - [API Status](https://status.lunchmoney.app)
 
 ## License
 
 ISC
-

package/lunch-money-api-v2.yaml

@@ -2,7 +2,7 @@ openapi: 3.0.2
 info:
   title: Lunch Money API - v2
   description: |-
-    Welcome to the Lunch Money v2 API reference. This is the **v2.11.0** spec. It includes previews of the proposed `/crypto` and `/balance_history` endpoints. Only the mock service works with these endpoints.<br><br>
+    Welcome to the Lunch Money v2 API reference. This is the **v2.11.1** spec. It includes previews of the proposed `/crypto` and `/balance_history` endpoints. Only the mock service works with these endpoints.<br><br>
     The most recent stable version of the API is v2.9.4 and is available at:
     `https://api.lunchmoney.dev/v2`
 
@@ -39,7 +39,7 @@ info:
   license:
     name: Apache 2.0
     url: http://www.apache.org/licenses/LICENSE-2.0.html
-  version: 2.11.0
+  version: 2.11.1
 
 servers:
   - url: https://api.lunchmoney.dev/v2
@@ -50,7 +50,10 @@ servers:
 
 tags:
   - name: me
-    description: View details and settings for the current user and account
+    description: View details and settings for the current user and account.<p>
+      Use [/me/account/settings](#tag/me/GET/me/account/settings) and
+      [/me/user/settings](#tag/me/GET/me/user/settings) for account- and
+      user-level preferences.
   - name: categories
     description: Work with categories
     externalDocs:
@@ -113,8 +116,10 @@ tags:
       description: Learn more about transactions
       url: https://support.lunchmoney.app/finances/transactions
   - name: budgets
-    description: View settings and modify budget amounts.<p> Use the
-      [/summary](#tag/summary) endpoint to view the budget details performance.
+    description: View settings and modify budget amounts.<p> Use
+      [/budgets/settings](#tag/budgets/GET/budgets/settings) to view budget
+      period settings.<p> Use the [/summary](#tag/summary) endpoint to view
+      the budget details performance.
     externalDocs:
       description: Learn more about budgets
       url: https://support.lunchmoney.app/finances/budgets
@@ -142,12 +147,18 @@ components:
         account_id:
           type: integer
           format: int64
-          description: Unique ID for the linked budgeting account
+          description: Unique ID for the current budgeting account
         budget_name:
           type: string
-          description: Name of the linked budgeting account
+          description: Name of the current budgeting account.<p> Also available
+            as `display_name` on
+            [/me/account/settings](#tag/me/GET/me/account/settings), which is
+            the preferred endpoint for reading and updating account settings.
         primary_currency:
-          description: Primary currency set in the user's settings
+          description: Primary currency for the current budgeting account.<p>
+            Also available on [/me/account/settings](#tag/me/GET/me/account/settings),
+            which is the preferred endpoint for reading and updating account
+            settings.
           allOf:
             - $ref: "#/components/schemas/currencyEnum"
         api_key_label:
@@ -3612,10 +3623,11 @@ components:
 
     # Response body for GET /budgets/settings (200)
     budgetSettingsResponseObject:
-      x-internal: true
       type: object
+      title: budget settings object
       additionalProperties: false
-      description: Budget period and display settings
+      description: Budget period and display settings for the current budgeting
+        account.
       properties:
         budget_period_granularity:
           type: string
@@ -3627,8 +3639,8 @@ components:
           - twice a month
           description: Budget period granularity
         budget_period_quantity:
-          type: number
-          format: double
+          type: integer
+          format: int32
           description: The number of `granularity` units that make up a single
             budgeting period.
         budget_period_anchor_date:
@@ -3670,6 +3682,371 @@ components:
         - budget_income_option
         - budget_rollover_left_to_budget
 
+    weekStartsOnEnum:
+      type: string
+      title: week starts on enum
+      enum:
+        - sunday
+        - monday
+      description: The day on which a calendar week begins.
+
+    monthYearFormatEnum:
+      type: string
+      title: month and year format enum
+      description: Format string for displaying month and year values
+        in the Lunch Money app.
+      enum:
+        - "MMMM YYYY"
+        - "MMM YYYY"
+        - "YYYY MMM"
+        - "MM YYYY"
+        - "MM-YYYY"
+        - "MM.YYYY"
+        - "MM/YYYY"
+        - "M YYYY"
+        - "M-YYYY"
+        - "M.YYYY"
+        - "M/YYYY"
+        - "YYYY M"
+        - "YYYY-M"
+        - "YYYY.M"
+        - "YYYY/M"
+        - "YYYY MM"
+        - "YYYY-MM"
+        - "YYYY.MM"
+        - "YYYY/MM"
+
+    monthDayYearFormatEnum:
+      type: string
+      title: month, day and year format enum
+      description: Format string for displaying full dates in the
+        Lunch Money app.
+      enum:
+        - "MMM D, YYYY"
+        - "D MMM YYYY"
+        - "YYYY MM DD"
+        - "YYYY-MM-DD"
+        - "YYYY.MM.DD"
+        - "YYYY/MM/DD"
+        - "YYYY M DD"
+        - "YYYY-M-DD"
+        - "YYYY.M.DD"
+        - "YYYY/M/DD"
+        - "YYYY MM D"
+        - "YYYY-MM-D"
+        - "YYYY.MM.D"
+        - "YYYY/MM/D"
+        - "YYYY M D"
+        - "YYYY-M-D"
+        - "YYYY.M.D"
+        - "YYYY/M/D"
+        - "DD MM YYYY"
+        - "DD-MM-YYYY"
+        - "DD.MM.YYYY"
+        - "DD/MM/YYYY"
+        - "DD M YYYY"
+        - "DD-M-YYYY"
+        - "DD.M.YYYY"
+        - "DD/M/YYYY"
+        - "D MM YYYY"
+        - "D-MM-YYYY"
+        - "D.MM.YYYY"
+        - "D/MM/YYYY"
+        - "D M YYYY"
+        - "D-M-YYYY"
+        - "D.M.YYYY"
+        - "D/M/YYYY"
+        - "M D YYYY"
+        - "M-D-YYYY"
+        - "M.D.YYYY"
+        - "M/D/YYYY"
+        - "MM D YYYY"
+        - "MM-D-YYYY"
+        - "MM.D.YYYY"
+        - "MM/D/YYYY"
+        - "MM DD YYYY"
+        - "MM-DD-YYYY"
+        - "MM.DD.YYYY"
+        - "MM/DD/YYYY"
+        - "M DD YYYY"
+        - "M-DD-YYYY"
+        - "M.DD.YYYY"
+        - "M/DD/YYYY"
+
+    monthDayFormatEnum:
+      type: string
+      title: month and day format enum
+      description: Format string for displaying month and day values
+        without a year.
+      enum:
+        - "MMM D"
+        - "MMM DD"
+        - "D MMM"
+        - "DD MMM"
+        - "MM D"
+        - "MM-D"
+        - "MM.D"
+        - "MM/D"
+        - "MM DD"
+        - "MM-DD"
+        - "MM.DD"
+        - "MM/DD"
+        - "M D"
+        - "M-D"
+        - "M.D"
+        - "M/D"
+        - "M DD"
+        - "M-DD"
+        - "M.DD"
+        - "M/DD"
+        - "D MM"
+        - "D-MM"
+        - "D.MM"
+        - "D/MM"
+        - "DD MM"
+        - "DD-MM"
+        - "DD.MM"
+        - "DD/MM"
+        - "D M"
+        - "D-M"
+        - "D.M"
+        - "D/M"
+        - "DD M"
+        - "DD-M"
+        - "DD.M"
+        - "DD/M"
+
+    accountSettingsObject:
+      type: object
+      title: account settings object
+      additionalProperties: false
+      description: Account-level settings for the budgeting account
+        associated with the authorized API token.
+      properties:
+        primary_currency:
+          description: Primary currency for the account.
+          allOf:
+            - $ref: "#/components/schemas/currencyEnum"
+        supported_currencies:
+          type: array
+          items:
+            $ref: "#/components/schemas/currencyEnum"
+          description: Currencies available when creating or editing transactions,
+            balances, and other amounts in the Lunch Money app.
+        display_name:
+          type: string
+          nullable: true
+          description: Display name of the budgeting account in the Lunch Money
+            app.
+        locale:
+          type: string
+          description: Locale used for formatting dates and numbers in the
+            Lunch Money app (for example, `en-US`). When no locale is explicitly
+            stored for the account, the effective locale is derived from the
+            `default_locale` associated with `primary_currency` in the
+            currencies table (for example, `usd` → `en-US`, `cad` → `en-CA`,
+            `gbp` → `en-GB`).
+        auto_create_category_rules:
+          type: boolean
+          default: true
+          description: If `true`, category rules are created automatically when
+            categorizing transactions.
+        auto_create_suggested_transaction_rules:
+          type: boolean
+          default: true
+          description: If `true`, suggested transaction rules are created
+            automatically.
+        auto_review_transaction_on_update:
+          type: boolean
+          default: true
+          description: If `true`, transactions are marked as reviewed when
+            updated.
+        auto_review_transaction_on_creation:
+          type: boolean
+          default: true
+          description: If `true`, transactions are marked as reviewed when
+            created.
+      required:
+        - primary_currency
+        - supported_currencies
+        - display_name
+        - locale
+        - auto_create_category_rules
+        - auto_create_suggested_transaction_rules
+        - auto_review_transaction_on_update
+        - auto_review_transaction_on_creation
+
+    updateAccountSettingsRequestObject:
+      x-internal: true
+      type: object
+      additionalProperties: false
+      description: Request body for updating account settings. Include at least
+        one property to update.
+      properties:
+        primary_currency:
+          allOf:
+            - $ref: "#/components/schemas/currencyEnum"
+          description: If set, updates the account's primary currency.
+          x-updatable: true
+        supported_currencies:
+          type: array
+          items:
+            $ref: "#/components/schemas/currencyEnum"
+          description: If set, replaces the list of supported currencies for the
+            account.
+          x-updatable: true
+        display_name:
+          type: string
+          nullable: true
+          description: If set, updates the display name of the budgeting account.
+          x-updatable: true
+        locale:
+          type: string
+          description: If set, updates the locale used for formatting dates and
+            numbers in the Lunch Money app.
+          x-updatable: true
+        auto_create_category_rules:
+          type: boolean
+          description: If set, updates whether category rules are created
+            automatically.
+          x-updatable: true
+        auto_create_suggested_transaction_rules:
+          type: boolean
+          description: If set, updates whether suggested transaction rules are
+            created automatically.
+          x-updatable: true
+        auto_review_transaction_on_update:
+          type: boolean
+          description: If set, updates whether transactions are marked as reviewed
+            when updated.
+          x-updatable: true
+        auto_review_transaction_on_creation:
+          type: boolean
+          description: If set, updates whether transactions are marked as reviewed
+            when created.
+          x-updatable: true
+
+    userSettingsObject:
+      type: object
+      title: user settings object
+      additionalProperties: false
+      description: User-level display and formatting preferences for the user
+        associated with the authorized API token.
+      properties:
+        show_debits_as_negative:
+          type: boolean
+          default: true
+          description: Display preference for how amounts are shown in the Lunch
+            Money app. When `true`, debits are shown as negative values and
+            credits as positive values.<p> This setting does **not** change
+            amount sign conventions in API responses. Amount fields such as
+            `amount` and `to_base` on transaction objects always use positive
+            values for debits and negative values for credits.
+        auto_suggest_payee:
+          type: boolean
+          default: true
+          description: If `true`, payee suggestions are shown when entering
+            transactions in the Lunch Money app.
+        month_year_format:
+          allOf:
+            - $ref: "#/components/schemas/monthYearFormatEnum"
+          default: "MMM YYYY"
+          description: Format string used when displaying month and year values.
+        month_day_year_format:
+          allOf:
+            - $ref: "#/components/schemas/monthDayYearFormatEnum"
+          default: "MMM D, YYYY"
+          description: Format string used when displaying full dates (month, day,
+            and year).
+        month_day_format:
+          allOf:
+            - $ref: "#/components/schemas/monthDayFormatEnum"
+          default: "MMM D"
+          description: Format string used when displaying month and day values
+            without a year.
+        show_am_pm:
+          type: boolean
+          default: true
+          description: If `true`, times are displayed using a 12-hour clock with
+            AM/PM. If `false`, times are displayed using a 24-hour clock.
+        week_starts_on:
+          allOf:
+            - $ref: "#/components/schemas/weekStartsOnEnum"
+          default: sunday
+          description: The day on which a calendar week begins.
+        always_display_year:
+          type: boolean
+          default: false
+          description: If `true`, dates always include the year and
+            `month_day_format` is not used.
+        always_display_weekday:
+          type: boolean
+          default: true
+          description: If `true`, weekday names are included when displaying
+            dates.
+      required:
+        - show_debits_as_negative
+        - auto_suggest_payee
+        - month_year_format
+        - month_day_year_format
+        - month_day_format
+        - show_am_pm
+        - week_starts_on
+        - always_display_year
+        - always_display_weekday
+
+    updateUserSettingsRequestObject:
+      x-internal: true
+      type: object
+      additionalProperties: false
+      description: Request body for updating user settings. Include at least one
+        property to update.
+      properties:
+        show_debits_as_negative:
+          type: boolean
+          description: If set, updates the display preference for amount signs in
+            the Lunch Money app. Does not affect amount sign conventions in API
+            responses.
+          x-updatable: true
+        auto_suggest_payee:
+          type: boolean
+          description: If set, updates whether payee suggestions are shown.
+          x-updatable: true
+        month_year_format:
+          allOf:
+            - $ref: "#/components/schemas/monthYearFormatEnum"
+          description: If set, updates the month and year display format.
+          x-updatable: true
+        month_day_year_format:
+          allOf:
+            - $ref: "#/components/schemas/monthDayYearFormatEnum"
+          description: If set, updates the full date display format.
+          x-updatable: true
+        month_day_format:
+          allOf:
+            - $ref: "#/components/schemas/monthDayFormatEnum"
+          description: If set, updates the month and day display format.
+          x-updatable: true
+        show_am_pm:
+          type: boolean
+          description: If set, updates whether times use a 12-hour (AM/PM) or
+            24-hour clock.
+          x-updatable: true
+        week_starts_on:
+          allOf:
+            - $ref: "#/components/schemas/weekStartsOnEnum"
+          description: If set, updates the day on which a calendar week begins.
+          x-updatable: true
+        always_display_year:
+          type: boolean
+          description: If set, updates whether dates always include the year.
+          x-updatable: true
+        always_display_weekday:
+          type: boolean
+          description: If set, updates whether weekday names are shown when
+            displaying dates.
+          x-updatable: true
+
     # Summary endpoint response schemas
     summaryResponseObject:
       type: object
@@ -4468,8 +4845,13 @@ paths:
       tags:
         - me
       summary: Get current user
-      description: Get details about the user associated with the supplied
-        authorization token.
+      description: |-
+        Get details about the user associated with the supplied authorization
+        token.<p> For account- and user-level preferences, prefer
+        [/me/account/settings](#tag/me/GET/me/account/settings) and
+        [/me/user/settings](#tag/me/GET/me/user/settings). Properties such as
+        `primary_currency` and `budget_name` remain on this response for
+        backwards compatibility.
       operationId: getMe
       parameters: []
       responses:
@@ -4493,6 +4875,165 @@ paths:
           $ref: "#/components/responses/rateLimited"
         "500":
           $ref: "#/components/responses/serverError"
+  /me/account/settings:
+    get:
+      tags:
+        - me
+      summary: Get account settings
+      description: Returns account-level settings for the budgeting
+        account associated with the authorized API token.
+      operationId: getAccountSettings
+      responses:
+        "200":
+          description: Account settings for the current budgeting account
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/accountSettingsObject"
+              example:
+                primary_currency: usd
+                supported_currencies:
+                  - usd
+                  - cad
+                  - jpy
+                display_name: "\U0001F3E0 Family budget"
+                locale: en-US
+                auto_create_category_rules: true
+                auto_create_suggested_transaction_rules: true
+                auto_review_transaction_on_update: true
+                auto_review_transaction_on_creation: true
+        "401":
+          $ref: "#/components/responses/unauthorizedToken"
+        "429":
+          $ref: "#/components/responses/rateLimited"
+        "500":
+          $ref: "#/components/responses/serverError"
+    put:
+      tags:
+        - me
+      summary: Update account settings
+      description: |-
+        Updates account-level settings for the budgeting account
+        associated with the authorized API token.<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
+        includes at least one updatable property.
+      operationId: updateAccountSettings
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/updateAccountSettingsRequestObject"
+            examples:
+              Update display name:
+                value:
+                  display_name: "Travel budget"
+              Update automation preferences:
+                value:
+                  auto_create_category_rules: false
+                  auto_review_transaction_on_creation: false
+      responses:
+        "200":
+          description: Account settings updated successfully
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/accountSettingsObject"
+        "400":
+          description: Invalid request body
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/errorResponseObject"
+        "401":
+          $ref: "#/components/responses/unauthorizedToken"
+        "429":
+          $ref: "#/components/responses/rateLimited"
+        "500":
+          $ref: "#/components/responses/serverError"
+  /me/user/settings:
+    get:
+      tags:
+        - me
+      summary: Get user settings
+      description: Returns user-level display and formatting preferences for the
+        user associated with the authorized API token.
+      operationId: getUserSettings
+      responses:
+        "200":
+          description: User settings for the authorized user
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/userSettingsObject"
+              example:
+                show_debits_as_negative: true
+                auto_suggest_payee: true
+                month_year_format: "MMM YYYY"
+                month_day_year_format: "MMM D, YYYY"
+                month_day_format: "MMM D"
+                show_am_pm: true
+                week_starts_on: sunday
+                always_display_year: false
+                always_display_weekday: true
+        "401":
+          $ref: "#/components/responses/unauthorizedToken"
+        "429":
+          $ref: "#/components/responses/rateLimited"
+        "500":
+          $ref: "#/components/responses/serverError"
+    put:
+      tags:
+        - me
+      summary: Update user settings
+      description: |-
+        Updates user-level display and formatting preferences for the user
+        associated with the authorized API token.<p> You may submit the response
+        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
+        request includes at least one updatable property.<p> Updating
+        `show_debits_as_negative` affects display in the Lunch Money app only.
+        Amount fields in API responses always use positive values for debits and
+        negative values for credits.
+      operationId: updateUserSettings
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/updateUserSettingsRequestObject"
+            examples:
+              Update date formats:
+                value:
+                  month_year_format: "YYYY-MM"
+                  month_day_year_format: "YYYY-MM-DD"
+                  month_day_format: "MM-DD"
+              Use 24-hour time and Monday week start:
+                value:
+                  show_am_pm: false
+                  week_starts_on: monday
+      responses:
+        "200":
+          description: User settings updated successfully
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/userSettingsObject"
+        "400":
+          description: Invalid request body
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/errorResponseObject"
+        "401":
+          $ref: "#/components/responses/unauthorizedToken"
+        "429":
+          $ref: "#/components/responses/rateLimited"
+        "500":
+          $ref: "#/components/responses/serverError"
   /summary:
     get:
       tags:
@@ -11617,12 +12158,17 @@ paths:
     get:
       tags:
         - budgets
-      summary: Get budget settings
-      description: Returns the budget-related settings for the user's account.
+      summary: Get budget period settings
+      description: |-
+        Returns budget period and display settings for the budget
+        associated with this API token.<p> These control how budget **periods** are calculated
+        (granularity, anchor date, rollover, and related options). For general
+        budget preferences such as currency and locale, see
+        [/me/account/settings](#tag/me/GET/me/account/settings).
       operationId: getBudgetSettings
       responses:
         "200":
-          description: Budget settings for the account
+          description: Budget period settings for the current budget
           content:
             application/json:
               schema:
@@ -11645,7 +12191,7 @@ paths:
         Note that `start_date` **must** be a valid budget period start for the account (based on the account's
         budget period settings). If an invalid `start_date` is provided, the request will fail with an error that indicates what the previous and next valid start dates are.<p>
 
-        Use the [budgets/settings](#tag/budgets/GET/budgets/settings) endpoint to view the account's budget settings.<br>
+        Use the [/budgets/settings](#tag/budgets/GET/budgets/settings) endpoint to view the budget period settings for the account.<br>
         To view details for existing budgets, use the [summary](#tag/summary) endpoint.
       operationId: upsertBudget
       requestBody:
@@ -11716,7 +12262,7 @@ paths:
         period settings). If an invalid `start_date` is provided, the request
         will fail with an error that indicates what the previous and next valid
         start dates are.<p> Use the
-        [budgets/settings](#tag/budgets/GET/budgets/settings) endpoint to view
+        [/budgets/settings](#tag/budgets/GET/budgets/settings) endpoint to view
         the account's budget settings.<br> To view details for existing budgets,
         use the [summary](#tag/summary) endpoint.
       operationId: deleteBudget

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lunch-money/v2-api-spec",
-  "version": "2.11.0-preview.8",
+  "version": "2.11.1-preview.1",
   "description": "OpenAPI specification and version history for the Lunch Money v2 API",
   "main": "lunch-money-api-v2.yaml",
   "files": [
@@ -12,7 +12,15 @@
   "scripts": {
     "prepare": "husky install",
     "prepublishOnly": "node scripts/prep-for-publish.js",
-    "postpublish": "node scripts/restore-readme.js"
+    "postpublish": "node scripts/restore-readme.js",
+    "publish:docs": "npm --prefix packages/developer-docs publish --tag preview",
+    "publish:spec": "npm publish --tag preview",
+    "publish:all": "npm run publish:docs && npm run publish:spec",
+    "publish:docs:latest": "npm --prefix packages/developer-docs publish",
+    "publish:spec:latest": "npm publish",
+    "publish:all:latest": "npm run publish:docs:latest && npm run publish:spec:latest",
+    "pack:docs": "node scripts/pack-docs.js",
+    "pack:spec": "node scripts/pack-spec.js"
   },
   "keywords": [
     "lunchmoney",
@@ -26,4 +34,3 @@
     "husky": "^8.0.3"
   }
 }
-

package/version-history.md

@@ -5,6 +5,11 @@ The Lunch Money API spec uses a modified version of SEMVER for its versioning me
 - The minor version represents the number of main endpoints the current version of the spec supports.  For example, a version of the API that supports the /me, /categories, and /transactions endpoints would have a minor version of 3.
 - The revision number represents the number of updates since the last endpoint was added.  For example, each time changes are made to one of the existing three APIs as described above, the revision number will be bumped.
 
+## v2.11.1 - TBD
+- Add `GET /me/account/settings` and `PUT /me/account/settings` for account-level settings
+- Add `GET /me/user/settings` and `PUT /me/user/settings` for user-level display and formatting preferences
+- Document `GET /budgets/settings` response schema publicly; change `budget_period_quantity` to integer
+
 ## v2.11.0 - TBD
 - Add `GET /balance_history`
 - Add `GET /balance_history/{account_type}/{account_id}`

package/README.md.backup

@@ -1,217 +0,0 @@
-# Lunch Money API Specifications and Documentation
-
-This repository contains the official API specifications and documentation for the [Lunch Money](https://lunchmoney.app) API. Lunch Money is a delightfully simple personal finance and budgeting tool with a comprehensive developer API.
-
-## Repository Structure
-
-This repository is organized in a multi-version structure to support current and future API versions:
-
-```
-.
-├── v2/                    # Version 2 API specific content
-│   ├── spec/              # OpenAPI specification (YAML)
-│   ├── docs/              # Version-specific documentation guides
-│   └── images/            # Images used in documentation
-├── docs/                  # Version-independent documentation
-├── scripts/               # Build and publishing scripts
-└── spec/                  # Generated directory (created during npm publish)
-```
-
-### Directory Details
-
-#### `v2/spec/` - OpenAPI Specification
-The OpenAPI 3.0 specification file (`lunch-money-api-v2.yaml`) defines the complete API contract:
-- All available endpoints
-- Request/response schemas
-- Authentication requirements
-- Error responses
-- Example requests and responses
-
-**This is the source of truth for the API.** Changes to the specification automatically update the interactive API documentation.
-
-#### `v2/docs/` - Version-Specific Documentation Guides
-Markdown files containing detailed guides and reference material specific to v2:
-- `intro-to-v2.md` - Overview of the v2 API and key features
-- `migration-guide.md` - Guide for migrating from v1 to v2
-- `version-history.md` - Changelog of all API versions
-
-These guides are written in Markdown and support custom rendering features (see below).
-
-#### `v2/images/` - Documentation Assets
-Images and screenshots used in the documentation guides.
-
-#### `docs/` - Version-Independent Documentation
-Shared documentation that applies across all API versions:
-- `getting-started.md` - Quick start guide for new developers (applies to all API versions)
-- `rate-limiting.md` - Rate limiting policies and best practices (applies to all API versions)
-- Additional version-independent guides (e.g., pagination guidelines, general API concepts)
-
-## OpenAPI Specification vs Documentation Guides
-
-There are two types of content in this repository, each serving a different purpose:
-
-### OpenAPI Specification (`v2/spec/lunch-money-api-v2.yaml`)
-- **Purpose**: Machine-readable API contract
-- **Format**: YAML (OpenAPI 3.0)
-- **Used for**: 
-  - Generating interactive API documentation
-  - Code generation for SDKs and client libraries
-  - API validation and testing
-  - IDE autocomplete and type checking
-- **Editable**: Yes - changes here automatically update the docs
-
-The OpenAPI spec is the authoritative source for:
-- Endpoint definitions (paths, methods, parameters)
-- Request/response schemas
-- Authentication requirements
-- Status codes and error formats
-
-### Documentation Guides (`v2/docs/*.md`)
-- **Purpose**: Human-readable guides and tutorials
-- **Format**: Markdown with custom extensions
-- **Used for**:
-  - Developer onboarding and tutorials
-  - Best practices and patterns
-  - Migration guides and changelogs
-  - Conceptual explanations
-- **Editable**: Yes - written in Markdown with support for custom features
-
-The guides provide context, examples, and explanations that complement the technical specification.
-
-## Custom Markdown Features
-
-The documentation system supports custom rendering features that enhance Markdown files. These features are processed when the documentation is served and can be used in any Markdown file in the `v2/docs/` directory.
-
-### Callouts
-
-Callouts are styled information boxes for highlighting important information, warnings, or tips.
-
-**Syntax:**
-```markdown
-> [!TYPE]
-> Title (optional)
-> 
-> Content goes here. This can span multiple lines
-> and include **markdown formatting**.
-```
-
-**Supported Types:**
-- `[!NOTE]` - General information or notes (blue styling)
-- `[!TIP]` - Helpful tips or best practices (green styling)
-- `[!WARNING]` - Warnings or important cautions (yellow/orange styling)
-
-**Example:**
-```markdown
-> [!NOTE]
-> API Rate Limits
-> 
-> The API has a rate limit of 1000 requests per 5 minutes per IP address.
-```
-
-### Tabs
-
-Tabs organize content into multiple tabbed sections, useful for showing different code examples, API versions, or alternative approaches.
-
-**Syntax:**
-```markdown
-:::tabs
-@tab Tab Label 1
-Content for the first tab. This can include **markdown** and code blocks.
-
-@tab Tab Label 2
-Content for the second tab. You can have as many tabs as needed.
-:::
-```
-
-**Example: Code Examples in Multiple Languages**
-```markdown
-:::tabs
-@tab cURL
-```bash
-curl -X GET "https://api.lunchmoney.app/v2/transactions" \
-  -H "Authorization: Bearer YOUR_API_TOKEN"
-```
-
-@tab JavaScript
-```javascript
-const response = await fetch('https://api.lunchmoney.app/v2/transactions', {
-  headers: {
-    'Authorization': 'Bearer YOUR_API_TOKEN'
-  }
-});
-```
-:::
-```
-
-**Usage Notes:**
-- Each tab must start with `@tab` followed by the tab label
-- The first tab is active by default when the page loads
-- Tab content can include any markdown, including code blocks, lists, callouts, tables, and links
-- You can combine callouts and tabs in various ways
-
-## Versioning
-
-The Lunch Money API uses a modified version of SEMVER:
-
-- **Major version**: The API version (currently 2)
-- **Minor version**: The number of main endpoints (OpenAPI tags) the spec supports
-- **Revision number**: The number of updates since the last endpoint was added
-
-For example, version `2.8.2` means:
-- API version 2
-- 8 main endpoint groups
-- 2 updates since the 8th endpoint was added
-
-Details of each version can be found in [`v2/docs/version-history.md`](./v2/docs/version-history.md).
-
-### Branch Naming Convention
-
-Each API version is maintained on a branch named after the version number (e.g., `v2.8.2`). The `main` branch typically tracks the most recent version.
-
-## Using This Repository
-
-### As an npm Package
-
-This repository is published as `@lunchmoney/v2-api-spec` on npm for lightweight consumption:
-
-```bash
-npm install @lunchmoney/v2-api-spec
-```
-
-After installation, you can access:
-- OpenAPI spec: `node_modules/@lunchmoney/v2-api-spec/spec/lunch-money-api-v2.yaml`
-- Version history: `node_modules/@lunchmoney/v2-api-spec/spec/version-history.md`
-
-### As a Git Repository
-
-You can clone this repository directly:
-
-```bash
-git clone https://github.com/lunch-money/api-specs.git
-cd api-specs
-```
-
-Or add it as a submodule to your project:
-
-```bash
-git submodule add https://github.com/lunch-money/api-specs.git specs/v2
-```
-
-## Contributing
-
-We welcome contributions to improve the API documentation! When contributing:
-
-1. **For API reference changes**: Update the OpenAPI specification in `v2/spec/lunch-money-api-v2.yaml`
-2. **For documentation**: Update the relevant Markdown files in `v2/docs/`
-3. **Version updates**: Update `v2/docs/version-history.md` with your changes
-4. Create a pull request with a clear description of your changes
-
-Please ensure that:
-- OpenAPI spec changes are valid YAML and conform to OpenAPI 3.0
-- Documentation follows the existing style and uses the custom Markdown features appropriately
-
-## Resources
-
-- [Lunch Money Website](https://lunchmoney.app)
-- [Interactive API Documentation](https://alpha.lunchmoney.dev/v2/docs)
-- [API Status](https://status.lunchmoney.app)