Skip to content

A local-first personal finance app

[AI] docs(api): drop the orphaned Payee Rule type (#8698)

Andreaa725cd85fcbf
diff --git a/packages/docs/docs/api/reference.md b/packages/docs/docs/api/reference.md
index f684aee1eb..ce241c5a21 100644
--- a/packages/docs/docs/api/reference.md
+++ b/packages/docs/docs/api/reference.md
@@ -70,7 +70,6 @@ import APIList from './APIList';
<APIList title="Rules" sections={[
"ConditionOrAction",
"Rule",
-"Payee rule",
"getRules",
"getPayeeRules",
"createRule",
@@ -653,10 +652,6 @@ await updateTag(id, { color: '#00ff00' });
<StructType fields={objects.rule} />
-#### Payee Rule
-
-<StructType fields={objects.payeeRule} />
-
#### Methods
#### `getRules`
@@ -669,7 +664,7 @@ Get all rules.
<Method name="getPayeeRules" args={[{ name: 'payeeId', type: "id" }]} returns="Promise<Rule[]>" />
-Get all rules associated with `payeeId`.
+Get all rules associated with `payeeId`. These are ordinary `Rule` objects, in the same shape `getRules` returns. A rule is associated with a payee when one of its conditions or actions has a `payee` field referencing that id, so the returned rules have no `payee_id` property.
#### `createRule`
diff --git a/packages/docs/docs/api/types.jsx b/packages/docs/docs/api/types.jsx
index 7de2e1439c..d158d7ff67 100644
--- a/packages/docs/docs/api/types.jsx
+++ b/packages/docs/docs/api/types.jsx
@@ -458,33 +458,6 @@ export const objects = {
{ name: 'actions', type: 'ConditionOrAction[]' },
],
- payeeRule: [
- { name: 'id', type: types.id },
- { name: 'payee_id', type: types.id, required: true },
- {
- name: 'stage',
- type: 'string',
- required: true,
- description: (
- <span>
- Must be one of <code>pre</code>, <code>default</code>, or{' '}
- <code>post</code>.
- </span>
- ),
- },
- {
- name: 'conditionsOp',
- type: 'string',
- description: (
- <span>
- Must be one of <code>and</code> or <code>or</code>.
- </span>
- ),
- },
- { name: 'conditions', type: 'ConditionOrAction[]' },
- { name: 'actions', type: 'ConditionOrAction[]' },
- ],
-
budgetFile: [
{
name: 'name',