Skip to content

Commit a1dc83e

Browse files
StanBarrowsStanBarrows
committed
Updated readme.md
1 parent 52910cf commit a1dc83e

1 file changed

Lines changed: 57 additions & 37 deletions

File tree

‎README.md‎

Lines changed: 57 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -206,16 +206,16 @@ then optimize the processes that power the core of your business.
206206
| FileCabinets/SelectLists | Get Select Lists & Get Filtered Select Lists | ✅ | |
207207
| FileCabinets/Upload | Create Data Record | ✅ | |
208208
| FileCabinets/Upload | Append File(s) to a Data Record | ✅ | |
209-
| FileCabinets/Upload | Upload a Single File for a Data Record | ❌ | - |
210-
| FileCabinets/Upload | Create a Data Record & Upload File | ❌ | - |
209+
| FileCabinets/Upload | Upload a Single File for a Data Record | ✅ | `CreateDataRecord` (multipart `POST …/Documents`) |
210+
| FileCabinets/Upload | Create a Data Record & Upload File | ✅ | `CreateDataRecord` |
211211
| FileCabinets/Upload | Create Data Record & Upload File Using Store Dialog | ✅ | `CreateDataRecord` + `storeDialogId` |
212212
| FileCabinets/Upload | Append a Single PDF to a Document | ✅ | - |
213213
| FileCabinets/Upload | Replace a PDF Document Section | ✅ | |
214214
| FileCabinets/BatchIndexFieldsUpdate | Batch Update Index Fields By Id | ✅ | `BatchDocumentsUpdateFields` |
215215
| FileCabinets/BatchIndexFieldsUpdate | Batch Update Index Fields By Search | ✅ | `BatchDocumentsUpdateFields` |
216216
| FileCabinets/BatchIndexFieldsUpdate | Batch Append/Update Keyword Fields By Id | ✅ | `BatchDocumentsUpdateFields` |
217217
| Documents/UpdateIndexValues | Update Index Values | ✅ | |
218-
| Documents/UpdateIndexValues | Update Table Field Values | ❌ | - ? |
218+
| Documents/UpdateIndexValues | Update Table Field Values | ✅ | `UpdateIndexValues` + `IndexTableDTO` |
219219
| Documents/ModifyDocuments | Transfer Document | ✅ | |
220220
| Documents/ModifyDocuments | Delete Document | ✅ | |
221221
| Documents/ClipUnclip&StapleUnstaple | Clip | ✅ | |
@@ -224,12 +224,12 @@ then optimize the processes that power the core of your business.
224224
| Documents/ClipUnclip&StapleUnstaple | Unstaple | ✅ | |
225225
| Documents/AnnotationsStamps | AddStampWithPosition | ✅ | `AddDocumentAnnotations` |
226226
| Documents/AnnotationsStamps | AddStampWithBestPosition | ✅ | `AddDocumentAnnotations` |
227-
| Documents/AnnotationsStamps | AddTextAnnotation | 🕣 | |
228-
| Documents/AnnotationsStamps | AddRectEntryAnnotation | 🕣 | |
229-
| Documents/AnnotationsStamps | AddLineEntryAnnotation | 🕣 | |
230-
| Documents/AnnotationsStamps | AddPolyLineEntryAnnotation | ❌ | - |
231-
| Documents/AnnotationsStamps | DeleteAnnotation | ❌ | - |
232-
| Documents/AnnotationsStamps | UpdateTextAnnotation | 🕣 | |
227+
| Documents/AnnotationsStamps | AddTextAnnotation | ✅ | `AddDocumentAnnotations` |
228+
| Documents/AnnotationsStamps | AddRectEntryAnnotation | ✅ | `AddDocumentAnnotations` |
229+
| Documents/AnnotationsStamps | AddLineEntryAnnotation | ✅ | `AddDocumentAnnotations` |
230+
| Documents/AnnotationsStamps | AddPolyLineEntryAnnotation | ✅ | `AddDocumentAnnotations` |
231+
| Documents/AnnotationsStamps | DeleteAnnotation | ❌ | — |
232+
| Documents/AnnotationsStamps | UpdateTextAnnotation | ❌ | — |
233233
| Documents/AnnotationsStamps | Get Stamps | ✅ | `GetStamps` |
234234
| Documents/DocumentsTrashBin | Get Documents | ✅ | |
235235
| Documents/DocumentsTrashBin | Delete Documents | ✅ | |
@@ -801,11 +801,11 @@ $paginator = $connector->send($paginatorRequest)->dto();
801801

802802
| Request | Supported |
803803
|-------------------------------------------------------------|-----------|
804-
| Check-out & Download a Document | 🕣 |
805-
| Check-in a Document from the File System | 🕣 |
806-
| Undo Check-out | 🕣 |
804+
| Check-out & Download a Document | ✅ |
805+
| Check-in a Document from the File System | ✅ |
806+
| Undo Check-out | ✅ |
807807

808-
> Not Currently Supported
808+
> Implemented as `CheckoutDocumentToFileSystem`, `CheckInDocumentFromFileSystem`, and `UndoDocumentCheckout`. Your file cabinet must have **version management** enabled; otherwise DocuWare returns HTTP 405.
809809
810810
##### Select Lists
811811
| Request | Supported |
@@ -829,11 +829,13 @@ $types = $this->connector->send(new GetSelectLists(
829829
|-----------------------------------------------------|-----------|
830830
| Create Data Record | ✅ |
831831
| Append File(s) to a Data Record | ✅ |
832-
| Upload a Single File for a Data Record | ❌ |
833-
| Create a Data Record & Upload File | ❌ |
834-
| Create Data Record & Upload File Using Store Dialog | ❌ |
835-
| Append a Single PDF to a Document | ❌ |
836-
| Replace a PDF Document Section | ❌ |
832+
| Upload a Single File for a Data Record | ✅ |
833+
| Create a Data Record & Upload File | ✅ |
834+
| Create Data Record & Upload File Using Store Dialog | ✅ |
835+
| Append a Single PDF to a Document | ✅ |
836+
| Replace a PDF Document Section | ✅ |
837+
838+
> Postman splits some uploads into separate recipes; this package maps them to `CreateDataRecord` (multipart `POST …/Documents`, optional `storeDialogId`), `AppendFilesToADataRecord`, `AppendASinglePDFToADocument`, and `ReplaceAPDFDocumentSection`.
837839
838840
###### Create Data Record
839841
```php
@@ -940,11 +942,11 @@ $response = $this->connector->send(new ReplaceAPDFDocumentSection(
940942
###### Batch Index Fields Update
941943
| Request | Supported |
942944
|------------------------------------------|-----------|
943-
| Batch Update Index Fields By Id | ❌ |
944-
| Batch Update Index Fields By Search | ❌ |
945-
| Batch Append/Update Keyword Fields By Id | ❌ |
945+
| Batch Update Index Fields By Id | ✅ |
946+
| Batch Update Index Fields By Search | ✅ |
947+
| Batch Append/Update Keyword Fields By Id | ✅ |
946948

947-
> Not Currently Supported
949+
> Use `BatchDocumentsUpdateFields` (same class covers these Postman variants).
948950
949951
###### Get Fields
950952
```php
@@ -960,7 +962,9 @@ $fields = $connector->send(new GetFieldsRequest($fileCabinetId))->dto();
960962
|---------------------------|-----------|
961963
| Update Index Values | ✅ |
962964
| Update Table Index Values | ✅ |
963-
| Update Table Field Values | ❌ |
965+
| Update Table Field Values | ✅ |
966+
967+
> Table columns use `IndexTableDTO` in the same `UpdateIndexValues` request as scalar fields (see **Update Table Data Record** below).
964968
965969

966970
```php
@@ -1099,20 +1103,23 @@ $unclip = $connector->send(new Unstaple(
10991103
```
11001104

11011105
##### Annotations/Stamps
1102-
| Request | Supported |
1103-
|----------------------------|-----------|
1104-
| Get Stamps | ✅ |
1105-
| Get Annotations | ✅ |
1106-
| AddStampWithPosition | 🕣 |
1107-
| AddStampWithBestPosition | 🕣 |
1108-
| AddTextAnnotation | 🕣 |
1109-
| AddRectEntryAnnotation | 🕣 |
1110-
| AddLineEntryAnnotation | 🕣 |
1111-
| AddPolyLineEntryAnnotation | ❌ |
1112-
| DeleteAnnotation | ❌ |
1113-
| UpdateTextAnnotation | 🕣 |
1114-
1115-
> Stamp/annotation **POST** variants map to `AddDocumentAnnotations` with the JSON body Postman sends. **GET** annotations use `GetDocumentAnnotations`.
1106+
1107+
DocuWare's Postman collection lists several **add** operations (stamp with position / best position, text, rectangle, line, polyline). They target the same Platform route: `POST /FileCabinets/{id}/Documents/{documentId}/Annotation`, differing only by JSON (`$type`, `Annotations`, `AnnotationsPlacement`, etc.). This package exposes that as **`AddDocumentAnnotations`** with the same payload array you would send from Postman—there are no separate classes per recipe.
1108+
1109+
**Not implemented:** `DeleteAnnotation` and `UpdateTextAnnotation` are separate operations in the API (different HTTP method or path); there is no Saloon request class for them yet—contributions welcome.
1110+
1111+
| Request | Supported | Package class |
1112+
|----------------------------|-----------|---------------|
1113+
| Get Stamps | ✅ | `GetStamps` |
1114+
| Get Annotations | ✅ | `GetDocumentAnnotations` |
1115+
| AddStampWithPosition | ✅ | `AddDocumentAnnotations` |
1116+
| AddStampWithBestPosition | ✅ | `AddDocumentAnnotations` |
1117+
| AddTextAnnotation | ✅ | `AddDocumentAnnotations` |
1118+
| AddRectEntryAnnotation | ✅ | `AddDocumentAnnotations` |
1119+
| AddLineEntryAnnotation | ✅ | `AddDocumentAnnotations` |
1120+
| AddPolyLineEntryAnnotation | ✅ | `AddDocumentAnnotations` |
1121+
| DeleteAnnotation | ❌ | — |
1122+
| UpdateTextAnnotation | ❌ | — |
11161123

11171124
###### Get Stamps
11181125
```php
@@ -1133,6 +1140,19 @@ $annotations = $connector->send(new GetDocumentAnnotations(
11331140
))->dto(); // Collection<int, array<string, mixed>>
11341141
```
11351142

1143+
###### Add stamps / annotations (POST body from Postman)
1144+
```php
1145+
use CodebarAg\DocuWare\Requests\Documents\Stamps\AddDocumentAnnotations;
1146+
1147+
$result = $connector->send(new AddDocumentAnnotations(
1148+
$fileCabinetId,
1149+
$documentId,
1150+
[
1151+
// Same JSON structure as the matching Postman request (e.g. StampPlacement, TextEntry, …).
1152+
],
1153+
))->dto();
1154+
```
1155+
11361156
###### Documents Trash Bin
11371157
| Request | Supported |
11381158
|-------------------|-----------|

0 commit comments

Comments
 (0)