Skip to content

Commit

Permalink
📝 update the API docs information (#414)
Browse files Browse the repository at this point in the history
Removing some outdated information. The API package has been available
for a while already.
  • Loading branch information
MatissJanis authored Jul 26, 2024
1 parent 3e481d2 commit 48c9efb
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 5 deletions.
8 changes: 3 additions & 5 deletions docs/api/reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ title: API Reference
import { types, objects, PrimitiveTypeList, PrimitiveType, StructType, Method, MethodBox } from './types';
import APIList from './APIList';

This is the documentation of all available API methods. The API has not been released yet, but it will be available in the next update. This section is a work in progress.

<APIList title="Budgets" sections={[
"getBudgetMonths",
"getBudgetMonth",
Expand Down Expand Up @@ -311,7 +309,7 @@ Delete an account.

<Method name="getAccountBalance" args={[{ name: 'id', type: 'id' }, { name: 'cutoff', type: 'Date?'}]} returns="Promise<number>" />

Gets the balance for an account. If a cutoff is given, it gives the account balance as of that date. If no cutoff is given, it uses the current date as the cutoff.
Gets the balance for an account. If a cutoff is given, it gives the account balance as of that date. If no cutoff is given, it uses the current date as the cutoff.

#### Examples

Expand Down Expand Up @@ -505,7 +503,7 @@ Create a rule. Returns the new rule, including the `id`.
<Method name="updateRule" args={[{ name: 'id', type: 'id' }, { name: 'fields', type: 'object' }]} returns="Promise<Rule>" />
Update fields of a rule. `fields` can specify any field described in [`Rule`](#rule). Returns the updated rule.
Update fields of a rule. `fields` can specify any field described in [`Rule`](#rule). Returns the updated rule.
#### `deleteRule`
Expand Down Expand Up @@ -582,7 +580,7 @@ Creates a new budget file with the given name, and then runs the custom importer
<Method name="getBudgets" args={[]} returns="Promise<BudgetFile[]>" />
Returns a list of all budget files either locally cached or on the remote server. Remote files have a `state` field and local files have an `id` field.
Returns a list of all budget files either locally cached or on the remote server. Remote files have a `state` field and local files have an `id` field.
#### `loadBudget`
Expand Down
1 change: 1 addition & 0 deletions docs/contributing/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ Here are some initial guidelines for how contributions will be treated:
- @joel-jeremy
- @MatissJanis
- @matt-fidd
- @MikesGlitch
- @teprifer
- @twk3
- @youngcw
Expand Down

0 comments on commit 48c9efb

Please sign in to comment.