[WIP] Documentation for Schedule API based on CRUD. #729
Conversation
actual-github-bot
bot
changed the title
✅ Deploy Preview for actualbudget-website ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
| @@ -82,7 +91,8 @@ | |||
| "loadBudget", | |||
| "downloadBudget", | |||
| "batchBudgetUpdates", | |||
| "runQuery" | |||
| "runQuery", | |||
| "getIDByName" | |||
Check failure
Code scanning / check-spelling
Unrecognized Spelling Error documentation
| @@ -617,3 +662,15 @@ | |||
| <Method name="runQuery" args={[{ properties: [{ name: 'query', type: 'ActualQL' }] }]} returns="Promise<unknown>" /> | |||
|
|
|||
| Allows running any arbitrary ActualQL query on the open budget. | |||
|
|
|||
| #### `getIDByName` | |||
Check failure
Code scanning / check-spelling
Unrecognized Spelling Error documentation
|
|
||
| #### `getIDByName` | ||
|
|
||
| <Method name="getIDByName" args={[{ properties: [{ name: 'type', type: 'string' }, { name: 'string', type: 'string'}] }]} returns="Promise<string>" /> |
Check failure
Code scanning / check-spelling
Unrecognized Spelling Error documentation
| type: 'string', | ||
| description: ( | ||
| <span> | ||
| All schedules have an associated underlying rule. Not to be supplied with a new schedule. It will be autocreated. Rules can not updated to another rule. You can however edit the rule with the API above for Rule. |
Check failure
Code scanning / check-spelling
Unrecognized Spelling Error documentation
| type: 'number | { num1: number; num2: number }', | ||
| description: ( | ||
| <span> | ||
| Provide only one number, except if the amount uses a isbetween in amountOp, in this case num1 and 2 should be provided. |
Check failure
Code scanning / check-spelling
Unrecognized Spelling Error documentation
| }, | ||
| { | ||
| name: 'amountOp', | ||
| type: "'is' | 'isapprox' | 'isbetween'", |
Check failure
Code scanning / check-spelling
Unrecognized Spelling Error documentation
| }, | ||
| { | ||
| name: 'amountOp', | ||
| type: "'is' | 'isapprox' | 'isbetween'", |
Check failure
Code scanning / check-spelling
Unrecognized Spelling Error documentation
| required: true, | ||
| description: ( | ||
| <span> | ||
| Mandatory field when creating a schedule. If the schedule is a single occurence just supply the date. otherwise refer to RecurConfig details below. |
Check failure
Code scanning / check-spelling
Unrecognized Spelling Error documentation
@check-spelling-bot Report🔴 Please reviewSee the 📂 files view, the 📜action log, or 📝 job summary for details.Unrecognized words (5)autocreated To accept these unrecognized words as correct, you could run the following commands... in a clone of the [email protected]:karimkodera/docs.git repository curl -s -S -L 'https://raw.githubusercontent.com/check-spelling/check-spelling/main/apply.pl' |
perl - 'https://github.com/actualbudget/docs/actions/runs/15810170424/attempts/1' &&
git commit -m 'Update check-spelling metadata'If the flagged items are 🤯 false positivesIf items relate to a ...
|
This documentation is based on code in PR to be assign. The docs suggests a structure for a schedule entity and recur confirm. It also provides create, get, update and delete functions. 2 unrelated functions have been added to get server version to get the ID of schedules, categories, payees or accounts by name.