seb/dashlibstorage
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: expand input and output object types in API signatures

Browse Source
This commit is contained in:
seb
2026-09-16 17:45:46 +02:00
parent 9b1b7615e2
commit 5a7773df79
22 changed files with 128 additions and 89 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
API.entityaddress.md
View File

@@ -27,7 +27,7 @@ Creates a new address for an entity.
**Returns**
`Promise<object>` — The created address.
`Promise<{id: number, entityId: number, firstName: string|null, name: string|null, street: string|null, streetNumber: string|null, zip: string|null, city: string|null, county: string|null, addressType: string, sort: number}>` — The created address.
**Throws**
@@ -83,7 +83,7 @@ Lists the addresses of an entity.
**Returns**
`Promise<Array<object>>` — The addresses.
`Promise<Array<{id: number, entityId: number, firstName: string|null, name: string|null, street: string|null, streetNumber: string|null, zip: string|null, city: string|null, county: string|null, addressType: string, sort: number}>>` — The addresses.
**Example**
@@ -106,10 +106,19 @@ Updates an address of an entity.
| `entityId` | `number` | The id of the entity. |
| `id` | `number` | The id of the address to update. |
| `patch` | `object` | The update patch (any subset of address fields). |
| `[patch.addressType]` | `string` | The address type. |
| `[patch.firstName]` | `string` | The first name. |
| `[patch.name]` | `string` | The name. |
| `[patch.street]` | `string` | The street. |
| `[patch.streetNumber]` | `string` | The street number. |
| `[patch.zip]` | `string` | The zip code. |
| `[patch.city]` | `string` | The city. |
| `[patch.county]` | `string` | The county. |
| `[patch.sort]` | `number` | The sort order. |
**Returns**
`Promise<object>` — The updated address.
`Promise<{id: number, entityId: number, firstName: string|null, name: string|null, street: string|null, streetNumber: string|null, zip: string|null, city: string|null, county: string|null, addressType: string, sort: number}>` — The updated address.
**Throws**