From 0a392f8861423d5f70537433fe78b6157cdc895a Mon Sep 17 00:00:00 2001 From: DumbergerL Date: Thu, 1 Aug 2024 07:52:20 +0200 Subject: [PATCH] docs(note): fix docs #215 --- docs/out/GroupAPI.md | 46 ++++++++++++++++++++++++++++++--- docs/out/SongAPI.md | 26 ++++++++++++++++++- docs/src/ressources/GroupAPI.md | 8 +++--- docs/src/ressources/SongAPI.md | 2 +- 4 files changed, 72 insertions(+), 10 deletions(-) diff --git a/docs/out/GroupAPI.md b/docs/out/GroupAPI.md index a31076e..a4e85fd 100644 --- a/docs/out/GroupAPI.md +++ b/docs/out/GroupAPI.md @@ -618,16 +618,54 @@ Retrieve all notes: -(EXAMPLE CODE IS MISSING) +```php + use CTApi\Models\Common\Note\NoteRequest; + + $notes = NoteRequest::forGroup(212)->get(); + var_dump( $notes[0]->getText()); + // Output: "Hello new comment!" + + var_dump( $notes[0]->getDomainId()); + // Output: "17" + + var_dump( $notes[0]->getDomainType()); + // Output: "group" + + var_dump( $notes[0]->getId()); + // Output: "212" + + +``` Create new note: -(EXAMPLE CODE IS MISSING) +```php + use CTApi\Models\Common\Note\NoteRequest; + + $note = NoteRequest::forGroup(52)->create("Add new comment."); + var_dump( $note->getText()); + // Output: "Add new comment." + + +``` Update note: -(EXAMPLE CODE IS MISSING) +```php + use CTApi\Models\Common\Note\NoteRequest; + + $note = NoteRequest::forGroup(52)->update(25, "Updated comment."); + var_dump( $note->getText()); + // Output: "Updated comment." + + +``` Delete note: -(EXAMPLE CODE IS MISSING) \ No newline at end of file +```php + use CTApi\Models\Common\Note\NoteRequest; + + NoteRequest::forGroup(52)->delete(25); + +``` \ No newline at end of file diff --git a/docs/out/SongAPI.md b/docs/out/SongAPI.md index 2425f63..9345d75 100644 --- a/docs/out/SongAPI.md +++ b/docs/out/SongAPI.md @@ -203,7 +203,31 @@ ## Create Song-Arrangement Notes -(EXAMPLE CODE IS MISSING) +```php + use CTApi\Models\Common\Note\NoteRequest; + + $notes = NoteRequest::forSongArrangement(21)->get(); + + var_dump( $notes[0]->getText()); + // Output: "Hello new comment!" + + var_dump( $notes[0]->getDomainId()); + // Output: "17" + + var_dump( $notes[0]->getDomainType()); + // Output: "group" + + var_dump( $notes[0]->getId()); + // Output: "212" + + + $securityLevelId = 2; + $note = NoteRequest::forSongArrangement(21)->create("New comment", $securityLevelId); + $note = NoteRequest::forSongArrangement(21)->update(2, "New comment"); + + NoteRequest::forSongArrangement(21)->delete(2); + +``` ## Retrieve Data from CCLI diff --git a/docs/src/ressources/GroupAPI.md b/docs/src/ressources/GroupAPI.md index ac7019c..e4d613a 100644 --- a/docs/src/ressources/GroupAPI.md +++ b/docs/src/ressources/GroupAPI.md @@ -32,16 +32,16 @@ Retrieve all notes: -{{ \CTApi\Test\Unit\Docs\NoteRequest.testRequestNotes }} +{{ \CTApi\Test\Unit\Docs\NoteRequestTest.testRequestNotes }} Create new note: -{{ \CTApi\Test\Unit\Docs\NoteRequest.testCreateNote }} +{{ \CTApi\Test\Unit\Docs\NoteRequestTest.testCreateNote }} Update note: -{{ \CTApi\Test\Unit\Docs\NoteRequest.testUpdateNote }} +{{ \CTApi\Test\Unit\Docs\NoteRequestTest.testUpdateNote }} Delete note: -{{ \CTApi\Test\Unit\Docs\NoteRequest.testDeleteNote }} \ No newline at end of file +{{ \CTApi\Test\Unit\Docs\NoteRequestTest.testDeleteNote }} \ No newline at end of file diff --git a/docs/src/ressources/SongAPI.md b/docs/src/ressources/SongAPI.md index b3f7b42..737a396 100644 --- a/docs/src/ressources/SongAPI.md +++ b/docs/src/ressources/SongAPI.md @@ -18,7 +18,7 @@ ## Create Song-Arrangement Notes -{{ \CTApi\Test\Unit\Docs\NoteRequest.testUpdateSongArrangementNotes }} +{{ \CTApi\Test\Unit\Docs\NoteRequestTest.testUpdateSongArrangementNotes }} ## Retrieve Data from CCLI