Skip to content

Commit 714c81e

Browse files
RhysLeesRhysLees
committed
WIP
1 parent eb3c3fe commit 714c81e

25 files changed

+1184
-0
lines changed

‎docs/Documents/annotations-stamps.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Annotations/Stamps
2+
| Request | Supported |
3+
|----------------------------|-----------|
4+
| AddStampWithPosition | 🕣 |
5+
| AddStampWithBestPosition | 🕣 |
6+
| AddTextAnnotation | 🕣 |
7+
| AddRectEntryAnnotation | 🕣 |
8+
| AddLineEntryAnnotation | 🕣 |
9+
| AddPolyLineEntryAnnotation | ❌ |
10+
| DeleteAnnotation | ❌ |
11+
| UpdateTextAnnotation | 🕣 |
12+
| Get Stamps | ❌ |
13+
14+
> Not Currently Supported

‎docs/Documents/application_properties.md

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
# Application Properties
2+
| Request | Supported |
3+
|-------------------------------|-----------|
4+
| Get Application Properties | ✅ |
5+
| Add Application Properties | ✅ |
6+
| Delete Application Properties | ✅ |
7+
| Update Application Properties | ✅ |
8+
9+
10+
### Add Application Properties
11+
```php
12+
use CodebarAg\DocuWare\Requests\Documents\ApplicationProperties\AddApplicationProperties;
13+
14+
$addProperties = $connector->send(new AddApplicationProperties(
15+
$fileCabinetId,
16+
$documentId,
17+
[
18+
[
19+
'Name' => 'Key1',
20+
'Value' => 'Key1 Value',
21+
],
22+
[
23+
'Name' => 'Key2',
24+
'Value' => 'Key2 Value',
25+
],
26+
],
27+
))->dto();
28+
```
29+
30+
### Update Application Properties
31+
```php
32+
use CodebarAg\DocuWare\Requests\Documents\ApplicationProperties\UpdateApplicationProperties;
33+
34+
$updateProperties = $connector->send(new UpdateApplicationProperties(
35+
$fileCabinetId,
36+
$documentId,
37+
[
38+
[
39+
'Name' => 'Key1',
40+
'Value' => 'Key1 Value Updated',
41+
],
42+
],
43+
))->dto()->sortBy('Name');
44+
```
45+
46+
### Delete Application Properties
47+
```php
48+
use CodebarAg\DocuWare\Requests\Documents\ApplicationProperties\DeleteApplicationProperties;
49+
50+
$deleteProperties = $connector->send(new DeleteApplicationProperties(
51+
$fileCabinetId,
52+
$document->id,
53+
[
54+
'Key1',
55+
],
56+
))->dto();
57+
```
58+
59+
### Get Application Properties
60+
```php
61+
use CodebarAg\DocuWare\Requests\Documents\ApplicationProperties\GetApplicationProperties;
62+
63+
$properties = $connector->send(new GetApplicationProperties(
64+
$fileCabinetId,
65+
$document->id,
66+
))->dto();
67+
```

‎docs/Documents/clip-unclicp_and_staple-unstaple.md

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# Clip/Unclip & Staple/Unstaple
2+
| Request | Supported |
3+
|----------|-----------|
4+
| Clip | ✅ |
5+
| Unclip | ✅ |
6+
| Staple | ✅ |
7+
| Unstaple | ✅ |
8+
9+
### Clip
10+
```php
11+
use CodebarAg\DocuWare\Requests\Documents\ClipUnclipStapleUnstaple\Clip;
12+
13+
$clip = $connector->send(new Clip(
14+
$fileCabinetId,
15+
[
16+
$documentId,
17+
$document2Id,
18+
]
19+
))->dto();
20+
```
21+
22+
### Unclip
23+
```php
24+
use CodebarAg\DocuWare\Requests\Documents\ClipUnclipStapleUnstaple\Unclip;
25+
26+
$unclip = $connector->send(new Unclip(
27+
$fileCabinetId,
28+
$clipId
29+
))->dto();
30+
```
31+
32+
### Staple
33+
```php
34+
use CodebarAg\DocuWare\Requests\Documents\ClipUnclipStapleUnstaple\Staple;
35+
36+
$staple = $connector->send(new Staple(
37+
$fileCabinetId,
38+
[
39+
$documentId,
40+
$document2Id,
41+
]
42+
))->dto();
43+
```
44+
45+
### Unstaple
46+
```php
47+
use CodebarAg\DocuWare\Requests\Documents\ClipUnclipStapleUnstaple\Unstaple;
48+
49+
$unclip = $connector->send(new Unstaple(
50+
$fileCabinetId,
51+
$stapleId
52+
))->dto();
53+
```

‎docs/Documents/documents-trash-bin.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Documents Trash Bin
2+
| Request | Supported |
3+
|-------------------|-----------|
4+
| Get Documents | ✅ |
5+
| Delete Documents | ✅ |
6+
| Restore Documents | ✅ |
7+
8+
9+
### Get Documents
10+
> You can use the same methods as in the search usage. The only difference is that you have to use the `trashBin` method after the `searchRequestBuilder` method.
11+
```php
12+
13+
14+
```php
15+
use CodebarAg\DocuWare\DocuWare;
16+
17+
$paginatorRequest = (new DocuWare())
18+
->searchRequestBuilder()
19+
->trashBin()
20+
```
21+
22+
#### Delete Documents
23+
```php
24+
use CodebarAg\DocuWare\Requests\Documents\DocumentsTrashBin\DeleteDocuments;
25+
26+
$delete = $connector->send(new DeleteDocuments([$documentID, $document2ID]))->dto();
27+
```
28+
29+
#### Restore Documents
30+
```php
31+
use CodebarAg\DocuWare\Requests\Documents\DocumentsTrashBin\RestoreDocuments;
32+
33+
$delete = $connector->send(new RestoreDocuments([$documentID, $document2ID]))->dto();
34+
```

‎docs/Documents/download.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Download
2+
| Request | Supported |
3+
|--------------------|-----------|
4+
| Download Document | ✅ |
5+
| Download Section | ✅ |
6+
| Download Thumbnail | ✅ |
7+
8+
9+
### Download Document
10+
```php
11+
use CodebarAg\DocuWare\Requests\Documents\Download\DownloadDocument;
12+
13+
$contents = $connector->send(new DownloadDocument(
14+
$fileCabinetId,
15+
$documentId
16+
))->dto();
17+
```
18+
19+
### Download Section
20+
```php
21+
use CodebarAg\DocuWare\Requests\Documents\Download\DownloadSection;
22+
23+
$contents = $connector->send(new DownloadSection(
24+
$fileCabinetId,
25+
$sectionId
26+
))->dto();
27+
```
28+
29+
### Download Thumbnail
30+
```php
31+
use CodebarAg\DocuWare\Requests\Documents\Download\DownloadThumbnail;
32+
33+
$contents = $connector->send(new DownloadThumbnail(
34+
$fileCabinetId,
35+
$sectionId
36+
))->dto();
37+
```

‎docs/Documents/modify_documents.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Modify Documents
2+
| Request | Supported |
3+
|-------------------|-----------|
4+
| Transfer Document | ✅ |
5+
| Delete Document | ✅ |
6+
7+
8+
### Transfer Document
9+
```php
10+
use CodebarAg\DocuWare\Requests\Documents\ModifyDocuments\TransferDocument;
11+
12+
$response = $connector->send(new TransferDocument(
13+
$fileCabinetId,
14+
$destinationFileCabinetId,
15+
$storeDialogId,
16+
$documentId,
17+
$fields,
18+
))->dto();
19+
```
20+
21+
### Delete Documents
22+
```php
23+
use CodebarAg\DocuWare\Requests\Documents\ModifyDocuments\DeleteDocument;
24+
25+
$connector->send(new DeleteDocument(
26+
$fileCabinetId
27+
$documentId,
28+
))->dto();
29+
```

‎docs/Documents/sections.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Sections
2+
| Request | Supported |
3+
|----------------------------------|-----------|
4+
| Get All Sections from a Document | ✅ |
5+
| Get a Specific Section | ✅ |
6+
| Delete Section | ✅ |
7+
8+
9+
### Get All Sections
10+
```php
11+
use CodebarAg\DocuWare\Requests\Documents\Sections\GetAllSectionsFromADocument;
12+
13+
$sections = $connector->send(new GetAllSectionsFromADocument(
14+
$fileCabinetId,
15+
$documentId
16+
))->dto();
17+
```
18+
19+
### Get Specific Section
20+
```php
21+
use CodebarAg\DocuWare\Requests\Documents\Sections\GetASpecificSection;
22+
23+
$section = $connector->send(new GetASpecificSection(
24+
$fileCabinetId,
25+
$sectionsId
26+
))->dto();
27+
```
28+
29+
### Delete Section
30+
```php
31+
use CodebarAg\DocuWare\Requests\Documents\Sections\DeleteSection;
32+
33+
$deleted = $connector->send(new DeleteSection(
34+
$fileCabinetId,
35+
$sectionId
36+
))->dto();
37+
```

‎docs/Documents/update_index_values.md

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
# Update Index Values
2+
| Request | Supported |
3+
|---------------------------|-----------|
4+
| Update Index Values | ✅ |
5+
| Update Table Index Values | ✅ |
6+
| Update Table Field Values | ❌ |
7+
8+
9+
### Update Index Values
10+
```php
11+
use CodebarAg\DocuWare\Requests\Documents\UpdateIndexValues\UpdateIndexValues;
12+
use CodebarAg\DocuWare\DTO\Documents\DocumentIndex\IndexDateDTO;
13+
14+
$response = $connector->send(new UpdateIndexValues(
15+
$fileCabinetId,
16+
$documentId,
17+
collect([
18+
IndexTextDTO::make('DOCUMENT_LABEL', '::new-data-entry::'),
19+
])
20+
))->dto();
21+
```
22+
23+
### Update Table Data Record
24+
```php
25+
use CodebarAg\DocuWare\Requests\Documents\UpdateIndexValues\UpdateIndexValues;
26+
use CodebarAg\DocuWare\DTO\Documents\DocumentIndex\IndexDateDTO;
27+
use CodebarAg\DocuWare\DTO\Documents\DocumentIndex\IndexDateTimeDTO;
28+
use CodebarAg\DocuWare\DTO\Documents\DocumentIndex\IndexDecimalDTO;
29+
use CodebarAg\DocuWare\DTO\Documents\DocumentIndex\IndexNumericDTO;
30+
use CodebarAg\DocuWare\DTO\Documents\DocumentIndex\IndexTableDTO;
31+
use CodebarAg\DocuWare\DTO\Documents\DocumentIndex\IndexTextDTO;
32+
33+
$tableRows = collect([
34+
collect([
35+
IndexTextDTO::make('TEXT', 'project_1'),
36+
IndexNumericDTO::make('INT', 1),
37+
IndexDecimalDTO::make('DECIMAL', 1.1),
38+
IndexDateDTO::make('DATE', $now),
39+
IndexDateTimeDTO::make('DATETIME', $now),
40+
]),
41+
collect([
42+
IndexTextDTO::make('TEXT', 'project_2'),
43+
IndexNumericDTO::make('INT', 2),
44+
IndexDecimalDTO::make('DECIMAL', 2.2),
45+
IndexDateDTO::make('DATE', $now),
46+
IndexDateTimeDTO::make('DATETIME', $now),
47+
]),
48+
]);
49+
50+
51+
$document = $connector->send(new UpdateIndexValues(
52+
$fileCabinetId,
53+
null,
54+
null,
55+
collect([
56+
IndexTableDTO::make('TABLE_NAME', $tableRows)
57+
]),
58+
))->dto();
59+
```

‎docs/File Cabinets/batch_index_fields_update.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# General
2+
| Request | Supported |
3+
|------------------------------------------|-----------|
4+
| Batch Update Index Fields By Id | ❌ |
5+
| Batch Update Index Fields By Search | ❌ |
6+
| Batch Append/Update Keyword Fields By Id | ❌ |
7+
8+
> Not Currently Supported
9+
10+
#### Get Fields
11+
```php
12+
use CodebarAg\DocuWare\Requests\Fields\GetFieldsRequest;
13+
14+
$fields = $connector->send(new GetFieldsRequest($fileCabinetId))->dto();
15+
```

‎docs/File Cabinets/check-in_check-out.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# General
2+
| Request | Supported |
3+
|-------------------------------------------------------------|-----------|
4+
| Check-out & Download a Document | 🕣 |
5+
| Check-in a Document from the File System | 🕣 |
6+
| Undo Check-out | 🕣 |
7+
8+
> Not Currently Supported

‎docs/File Cabinets/dialogs.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Dialogs
2+
3+
| Request | Supported |
4+
|--------------------------------|-----------|
5+
| Get All Dialogs | ✅ |
6+
| Get a Specific Dialog | ✅ |
7+
| Get Dialogs of a Specific Type | ✅ |
8+
9+
### Get All Dialogs
10+
```php
11+
use CodebarAg\DocuWare\Requests\FileCabinets\Dialogs\GetAllDialogs;
12+
13+
$dialogs = $connector->send(new GetAllDialogs($fileCabinetId))->dto();
14+
```
15+
16+
### Get Dialogs of a Specific Type
17+
```php
18+
use CodebarAg\DocuWare\Requests\FileCabinets\Dialogs\GetASpecificDialog;
19+
20+
$dialog = $connector->send(new GetASpecificDialog($fileCabinetId, $dialogId))->dto();
21+
```
22+
23+
### Get Dialogs Of A Specific Type
24+
```php
25+
use CodebarAg\DocuWare\Enums\DialogType;
26+
use CodebarAg\DocuWare\Requests\FileCabinets\Dialogs\GetDialogsOfASpecificType;
27+
28+
$dialogs = $connector->send(new GetDialogsOfASpecificType($fileCabinetId, DialogType::SEARCH))->dto();
29+
```
30+

0 commit comments

Comments
 (0)