93 changed files with 0 additions and 3866 deletions
@ -1,19 +0,0 @@
|
||||
# openapi.model.OCSMeta |
||||
|
||||
## Load the model package |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
``` |
||||
|
||||
## Properties |
||||
Name | Type | Description | Notes |
||||
------------ | ------------- | ------------- | ------------- |
||||
**status** | **String** | | [optional] |
||||
**statuscode** | **int** | | [optional] |
||||
**message** | **String** | | [optional] |
||||
**totalitems** | **int** | | [optional] |
||||
**itemsperpage** | **int** | | [optional] |
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
||||
|
||||
|
@ -1,16 +0,0 @@
|
||||
# openapi.model.CoreLoginFlowInit |
||||
|
||||
## Load the model package |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
``` |
||||
|
||||
## Properties |
||||
Name | Type | Description | Notes |
||||
------------ | ------------- | ------------- | ------------- |
||||
**poll** | [**CoreLoginFlowInitPoll**](CoreLoginFlowInitPoll.md) | | [optional] |
||||
**login** | **String** | | [optional] |
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
||||
|
||||
|
@ -1,16 +0,0 @@
|
||||
# openapi.model.CoreLoginFlowInitPoll |
||||
|
||||
## Load the model package |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
``` |
||||
|
||||
## Properties |
||||
Name | Type | Description | Notes |
||||
------------ | ------------- | ------------- | ------------- |
||||
**token** | **String** | | [optional] |
||||
**endpoint** | **String** | | [optional] |
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
||||
|
||||
|
@ -1,17 +0,0 @@
|
||||
# openapi.model.CoreLoginFlowResult |
||||
|
||||
## Load the model package |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
``` |
||||
|
||||
## Properties |
||||
Name | Type | Description | Notes |
||||
------------ | ------------- | ------------- | ------------- |
||||
**server** | **String** | | [optional] |
||||
**loginName** | **String** | | [optional] |
||||
**appPassword** | **String** | | [optional] |
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
||||
|
||||
|
@ -1,15 +0,0 @@
|
||||
# openapi.model.CoreNavigationApps |
||||
|
||||
## Load the model package |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
``` |
||||
|
||||
## Properties |
||||
Name | Type | Description | Notes |
||||
------------ | ------------- | ------------- | ------------- |
||||
**ocs** | [**CoreNavigationAppsOcs**](CoreNavigationAppsOcs.md) | | [optional] |
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
||||
|
||||
|
@ -1,16 +0,0 @@
|
||||
# openapi.model.CoreNavigationAppsOcs |
||||
|
||||
## Load the model package |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
``` |
||||
|
||||
## Properties |
||||
Name | Type | Description | Notes |
||||
------------ | ------------- | ------------- | ------------- |
||||
**meta** | [**Object**](.md) | Stub | [optional] |
||||
**data** | [**List<CoreNavigationAppsOcsDataInner>**](CoreNavigationAppsOcsDataInner.md) | | [optional] [default to const []] |
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
||||
|
||||
|
@ -1,23 +0,0 @@
|
||||
# openapi.model.CoreNavigationAppsOcsDataInner |
||||
|
||||
## Load the model package |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
``` |
||||
|
||||
## Properties |
||||
Name | Type | Description | Notes |
||||
------------ | ------------- | ------------- | ------------- |
||||
**id** | **String** | | [optional] |
||||
**order** | [**Object**](.md) | Can either be a string or integer, see bug report https://github.com/nextcloud/server/issues/32828 | [optional] |
||||
**href** | **String** | | [optional] |
||||
**icon** | **String** | | [optional] |
||||
**type** | **String** | | [optional] |
||||
**name** | **String** | | [optional] |
||||
**active** | **bool** | | [optional] |
||||
**classes** | **String** | | [optional] |
||||
**unread** | **int** | | [optional] |
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
||||
|
||||
|
@ -1,15 +0,0 @@
|
||||
# openapi.model.CoreServerCapabilities |
||||
|
||||
## Load the model package |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
``` |
||||
|
||||
## Properties |
||||
Name | Type | Description | Notes |
||||
------------ | ------------- | ------------- | ------------- |
||||
**ocs** | [**CoreServerCapabilitiesOcs**](CoreServerCapabilitiesOcs.md) | | [optional] |
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
||||
|
||||
|
@ -1,16 +0,0 @@
|
||||
# openapi.model.CoreServerCapabilitiesOcs |
||||
|
||||
## Load the model package |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
``` |
||||
|
||||
## Properties |
||||
Name | Type | Description | Notes |
||||
------------ | ------------- | ------------- | ------------- |
||||
**meta** | [**Object**](.md) | Stub | [optional] |
||||
**data** | [**CoreServerCapabilitiesOcsData**](CoreServerCapabilitiesOcsData.md) | | [optional] |
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
||||
|
||||
|
@ -1,16 +0,0 @@
|
||||
# openapi.model.CoreServerCapabilitiesOcsData |
||||
|
||||
## Load the model package |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
``` |
||||
|
||||
## Properties |
||||
Name | Type | Description | Notes |
||||
------------ | ------------- | ------------- | ------------- |
||||
**version** | [**CoreServerCapabilitiesOcsDataVersion**](CoreServerCapabilitiesOcsDataVersion.md) | | [optional] |
||||
**capabilities** | [**CoreServerCapabilitiesOcsDataCapabilities**](CoreServerCapabilitiesOcsDataCapabilities.md) | | [optional] |
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
||||
|
||||
|
@ -1,30 +0,0 @@
|
||||
# openapi.model.CoreServerCapabilitiesOcsDataCapabilities |
||||
|
||||
## Load the model package |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
``` |
||||
|
||||
## Properties |
||||
Name | Type | Description | Notes |
||||
------------ | ------------- | ------------- | ------------- |
||||
**core** | [**CoreServerCapabilitiesOcsDataCapabilitiesCore**](CoreServerCapabilitiesOcsDataCapabilitiesCore.md) | | [optional] |
||||
**bruteforce** | [**CoreServerCapabilitiesOcsDataCapabilitiesBruteforce**](CoreServerCapabilitiesOcsDataCapabilitiesBruteforce.md) | | [optional] |
||||
**metadataAvailable** | [**CoreServerCapabilitiesOcsDataCapabilitiesMetadataAvailable**](CoreServerCapabilitiesOcsDataCapabilitiesMetadataAvailable.md) | | [optional] |
||||
**files** | [**CoreServerCapabilitiesOcsDataCapabilitiesFiles**](CoreServerCapabilitiesOcsDataCapabilitiesFiles.md) | | [optional] |
||||
**activity** | [**CoreServerCapabilitiesOcsDataCapabilitiesActivity**](CoreServerCapabilitiesOcsDataCapabilitiesActivity.md) | | [optional] |
||||
**circles** | [**CoreServerCapabilitiesOcsDataCapabilitiesCircles**](CoreServerCapabilitiesOcsDataCapabilitiesCircles.md) | | [optional] |
||||
**ocm** | [**CoreServerCapabilitiesOcsDataCapabilitiesOcm**](CoreServerCapabilitiesOcsDataCapabilitiesOcm.md) | | [optional] |
||||
**dav** | [**CoreServerCapabilitiesOcsDataCapabilitiesDav**](CoreServerCapabilitiesOcsDataCapabilitiesDav.md) | | [optional] |
||||
**filesSharing** | [**CoreServerCapabilitiesOcsDataCapabilitiesFilesSharing**](CoreServerCapabilitiesOcsDataCapabilitiesFilesSharing.md) | | [optional] |
||||
**notes** | [**CoreServerCapabilitiesOcsDataCapabilitiesNotes**](CoreServerCapabilitiesOcsDataCapabilitiesNotes.md) | | [optional] |
||||
**notifications** | [**CoreServerCapabilitiesOcsDataCapabilitiesNotifications**](CoreServerCapabilitiesOcsDataCapabilitiesNotifications.md) | | [optional] |
||||
**passwordPolicy** | [**CoreServerCapabilitiesOcsDataCapabilitiesPasswordPolicy**](CoreServerCapabilitiesOcsDataCapabilitiesPasswordPolicy.md) | | [optional] |
||||
**provisioningApi** | [**CoreServerCapabilitiesOcsDataCapabilitiesProvisioningApi**](CoreServerCapabilitiesOcsDataCapabilitiesProvisioningApi.md) | | [optional] |
||||
**theming** | [**CoreServerCapabilitiesOcsDataCapabilitiesTheming**](CoreServerCapabilitiesOcsDataCapabilitiesTheming.md) | | [optional] |
||||
**userStatus** | [**CoreServerCapabilitiesOcsDataCapabilitiesUserStatus**](CoreServerCapabilitiesOcsDataCapabilitiesUserStatus.md) | | [optional] |
||||
**weatherStatus** | [**CoreServerCapabilitiesOcsDataCapabilitiesFilesSharingPublicExpireDate**](CoreServerCapabilitiesOcsDataCapabilitiesFilesSharingPublicExpireDate.md) | | [optional] |
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
||||
|
||||
|
@ -1,15 +0,0 @@
|
||||
# openapi.model.CoreServerCapabilitiesOcsDataCapabilitiesActivity |
||||
|
||||
## Load the model package |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
``` |
||||
|
||||
## Properties |
||||
Name | Type | Description | Notes |
||||
------------ | ------------- | ------------- | ------------- |
||||
**apiv2** | **List<String>** | | [optional] [default to const []] |
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
||||
|
||||
|
@ -1,15 +0,0 @@
|
||||
# openapi.model.CoreServerCapabilitiesOcsDataCapabilitiesBruteforce |
||||
|
||||
## Load the model package |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
``` |
||||
|
||||
## Properties |
||||
Name | Type | Description | Notes |
||||
------------ | ------------- | ------------- | ------------- |
||||
**delay** | **int** | | [optional] |
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
||||
|
||||
|
@ -1,19 +0,0 @@
|
||||
# openapi.model.CoreServerCapabilitiesOcsDataCapabilitiesCircles |
||||
|
||||
## Load the model package |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
``` |
||||
|
||||
## Properties |
||||
Name | Type | Description | Notes |
||||
------------ | ------------- | ------------- | ------------- |
||||
**version** | **String** | | [optional] |
||||
**status** | [**CoreServerCapabilitiesOcsDataCapabilitiesCirclesStatus**](CoreServerCapabilitiesOcsDataCapabilitiesCirclesStatus.md) | | [optional] |
||||
**settings** | [**CoreServerCapabilitiesOcsDataCapabilitiesCirclesSettings**](CoreServerCapabilitiesOcsDataCapabilitiesCirclesSettings.md) | | [optional] |
||||
**circle** | [**CoreServerCapabilitiesOcsDataCapabilitiesCirclesCircle**](CoreServerCapabilitiesOcsDataCapabilitiesCirclesCircle.md) | | [optional] |
||||
**member** | [**CoreServerCapabilitiesOcsDataCapabilitiesCirclesMember**](CoreServerCapabilitiesOcsDataCapabilitiesCirclesMember.md) | | [optional] |
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
||||
|
||||
|
@ -1,16 +0,0 @@
|
||||
# openapi.model.CoreServerCapabilitiesOcsDataCapabilitiesCirclesCircle |
||||
|
||||
## Load the model package |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
``` |
||||
|
||||
## Properties |
||||
Name | Type | Description | Notes |
||||
------------ | ------------- | ------------- | ------------- |
||||
**constants** | [**CoreServerCapabilitiesOcsDataCapabilitiesCirclesCircleConstants**](CoreServerCapabilitiesOcsDataCapabilitiesCirclesCircleConstants.md) | | [optional] |
||||
**config** | [**CoreServerCapabilitiesOcsDataCapabilitiesCirclesCircleConfig**](CoreServerCapabilitiesOcsDataCapabilitiesCirclesCircleConfig.md) | | [optional] |
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
||||
|
||||
|
@ -1,16 +0,0 @@
|
||||
# openapi.model.CoreServerCapabilitiesOcsDataCapabilitiesCirclesCircleConfig |
||||
|
||||
## Load the model package |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
``` |
||||
|
||||
## Properties |
||||
Name | Type | Description | Notes |
||||
------------ | ------------- | ------------- | ------------- |
||||
**coreFlags** | **List<int>** | | [optional] [default to const []] |
||||
**systemFlags** | **List<int>** | | [optional] [default to const []] |
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
||||
|
||||
|
@ -1,16 +0,0 @@
|
||||
# openapi.model.CoreServerCapabilitiesOcsDataCapabilitiesCirclesCircleConstants |
||||
|
||||
## Load the model package |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
``` |
||||
|
||||
## Properties |
||||
Name | Type | Description | Notes |
||||
------------ | ------------- | ------------- | ------------- |
||||
**flags** | [**Object**](.md) | | [optional] |
||||
**source_** | [**CoreServerCapabilitiesOcsDataCapabilitiesCirclesCircleConstantsSource**](CoreServerCapabilitiesOcsDataCapabilitiesCirclesCircleConstantsSource.md) | | [optional] |
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
||||
|
||||
|
@ -1,16 +0,0 @@
|
||||
# openapi.model.CoreServerCapabilitiesOcsDataCapabilitiesCirclesCircleConstantsSource |
||||
|
||||
## Load the model package |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
``` |
||||
|
||||
## Properties |
||||
Name | Type | Description | Notes |
||||
------------ | ------------- | ------------- | ------------- |
||||
**core** | [**Object**](.md) | | [optional] |
||||
**extra** | [**Object**](.md) | | [optional] |
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
||||
|
||||
|
@ -1,16 +0,0 @@
|
||||
# openapi.model.CoreServerCapabilitiesOcsDataCapabilitiesCirclesMember |
||||
|
||||
## Load the model package |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
``` |
||||
|
||||
## Properties |
||||
Name | Type | Description | Notes |
||||
------------ | ------------- | ------------- | ------------- |
||||
**constants** | [**CoreServerCapabilitiesOcsDataCapabilitiesCirclesMemberConstants**](CoreServerCapabilitiesOcsDataCapabilitiesCirclesMemberConstants.md) | | [optional] |
||||
**type** | [**Object**](.md) | | [optional] |
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
||||
|
||||
|
@ -1,15 +0,0 @@
|
||||
# openapi.model.CoreServerCapabilitiesOcsDataCapabilitiesCirclesMemberConstants |
||||
|
||||
## Load the model package |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
``` |
||||
|
||||
## Properties |
||||
Name | Type | Description | Notes |
||||
------------ | ------------- | ------------- | ------------- |
||||
**level** | [**Object**](.md) | | [optional] |
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
||||
|
||||
|
@ -1,18 +0,0 @@
|
||||
# openapi.model.CoreServerCapabilitiesOcsDataCapabilitiesCirclesSettings |
||||
|
||||
## Load the model package |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
``` |
||||
|
||||
## Properties |
||||
Name | Type | Description | Notes |
||||
------------ | ------------- | ------------- | ------------- |
||||
**frontendEnabled** | **bool** | | [optional] |
||||
**allowedCircles** | **int** | | [optional] |
||||
**allowedUserTypes** | **int** | | [optional] |
||||
**membersLimit** | **int** | | [optional] |
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
||||
|
||||
|
@ -1,15 +0,0 @@
|
||||
# openapi.model.CoreServerCapabilitiesOcsDataCapabilitiesCirclesStatus |
||||
|
||||
## Load the model package |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
``` |
||||
|
||||
## Properties |
||||
Name | Type | Description | Notes |
||||
------------ | ------------- | ------------- | ------------- |
||||
**globalScale** | **bool** | | [optional] |
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
||||
|
||||
|
@ -1,16 +0,0 @@
|
||||
# openapi.model.CoreServerCapabilitiesOcsDataCapabilitiesCore |
||||
|
||||
## Load the model package |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
``` |
||||
|
||||
## Properties |
||||
Name | Type | Description | Notes |
||||
------------ | ------------- | ------------- | ------------- |
||||
**pollinterval** | **int** | | [optional] |
||||
**webdavRoot** | **String** | | [optional] |
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
||||
|
||||
|
@ -1,15 +0,0 @@
|
||||
# openapi.model.CoreServerCapabilitiesOcsDataCapabilitiesDav |
||||
|
||||
## Load the model package |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
``` |
||||
|
||||
## Properties |
||||
Name | Type | Description | Notes |
||||
------------ | ------------- | ------------- | ------------- |
||||
**chunking** | **String** | | [optional] |
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
||||
|
||||
|
@ -1,20 +0,0 @@
|
||||
# openapi.model.CoreServerCapabilitiesOcsDataCapabilitiesFiles |
||||
|
||||
## Load the model package |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
``` |
||||
|
||||
## Properties |
||||
Name | Type | Description | Notes |
||||
------------ | ------------- | ------------- | ------------- |
||||
**bigfilechunking** | **bool** | | [optional] |
||||
**blacklistedFiles** | **List<String>** | | [optional] [default to const []] |
||||
**directEditing** | [**CoreServerCapabilitiesOcsDataCapabilitiesFilesDirectEditing**](CoreServerCapabilitiesOcsDataCapabilitiesFilesDirectEditing.md) | | [optional] |
||||
**comments** | **bool** | | [optional] |
||||
**undelete** | **bool** | | [optional] |
||||
**versioning** | **bool** | | [optional] |
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
||||
|
||||
|
@ -1,16 +0,0 @@
|
||||
# openapi.model.CoreServerCapabilitiesOcsDataCapabilitiesFilesDirectEditing |
||||
|
||||
## Load the model package |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
``` |
||||
|
||||
## Properties |
||||
Name | Type | Description | Notes |
||||
------------ | ------------- | ------------- | ------------- |
||||
**url** | **String** | | [optional] |
||||
**etag** | **String** | | [optional] |
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
||||
|
||||
|
@ -1,24 +0,0 @@
|
||||
# openapi.model.CoreServerCapabilitiesOcsDataCapabilitiesFilesSharing |
||||
|
||||
## Load the model package |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
``` |
||||
|
||||
## Properties |
||||
Name | Type | Description | Notes |
||||
------------ | ------------- | ------------- | ------------- |
||||
**apiEnabled** | **bool** | | [optional] |
||||
**public** | [**CoreServerCapabilitiesOcsDataCapabilitiesFilesSharingPublic**](CoreServerCapabilitiesOcsDataCapabilitiesFilesSharingPublic.md) | | [optional] |
||||
**resharing** | **bool** | | [optional] |
||||
**user** | [**CoreServerCapabilitiesOcsDataCapabilitiesFilesSharingUser**](CoreServerCapabilitiesOcsDataCapabilitiesFilesSharingUser.md) | | [optional] |
||||
**groupSharing** | **bool** | | [optional] |
||||
**group** | [**CoreServerCapabilitiesOcsDataCapabilitiesFilesSharingGroup**](CoreServerCapabilitiesOcsDataCapabilitiesFilesSharingGroup.md) | | [optional] |
||||
**defaultPermissions** | **int** | | [optional] |
||||
**federation** | [**CoreServerCapabilitiesOcsDataCapabilitiesFilesSharingFederation**](CoreServerCapabilitiesOcsDataCapabilitiesFilesSharingFederation.md) | | [optional] |
||||
**sharee** | [**CoreServerCapabilitiesOcsDataCapabilitiesFilesSharingSharee**](CoreServerCapabilitiesOcsDataCapabilitiesFilesSharingSharee.md) | | [optional] |
||||
**sharebymail** | [**CoreServerCapabilitiesOcsDataCapabilitiesFilesSharingSharebymail**](CoreServerCapabilitiesOcsDataCapabilitiesFilesSharingSharebymail.md) | | [optional] |
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
||||
|
||||
|
@ -1,18 +0,0 @@
|
||||
# openapi.model.CoreServerCapabilitiesOcsDataCapabilitiesFilesSharingFederation |
||||
|
||||
## Load the model package |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
``` |
||||
|
||||
## Properties |
||||
Name | Type | Description | Notes |
||||
------------ | ------------- | ------------- | ------------- |
||||
**outgoing** | **bool** | | [optional] |
||||
**incoming** | **bool** | | [optional] |
||||
**expireDate** | [**CoreServerCapabilitiesOcsDataCapabilitiesFilesSharingPublicExpireDate**](CoreServerCapabilitiesOcsDataCapabilitiesFilesSharingPublicExpireDate.md) | | [optional] |
||||
**expireDateSupported** | [**CoreServerCapabilitiesOcsDataCapabilitiesFilesSharingPublicExpireDate**](CoreServerCapabilitiesOcsDataCapabilitiesFilesSharingPublicExpireDate.md) | | [optional] |
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
||||
|
||||
|
@ -1,16 +0,0 @@
|
||||
# openapi.model.CoreServerCapabilitiesOcsDataCapabilitiesFilesSharingGroup |
||||
|
||||
## Load the model package |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
``` |
||||
|
||||
## Properties |
||||
Name | Type | Description | Notes |
||||
------------ | ------------- | ------------- | ------------- |
||||
**enabled** | **bool** | | [optional] |
||||
**expireDate** | [**CoreServerCapabilitiesOcsDataCapabilitiesFilesSharingPublicExpireDate**](CoreServerCapabilitiesOcsDataCapabilitiesFilesSharingPublicExpireDate.md) | | [optional] |
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
||||
|
||||
|
@ -1,23 +0,0 @@
|
||||
# openapi.model.CoreServerCapabilitiesOcsDataCapabilitiesFilesSharingPublic |
||||
|
||||
## Load the model package |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
``` |
||||
|
||||
## Properties |
||||
Name | Type | Description | Notes |
||||
------------ | ------------- | ------------- | ------------- |
||||
**enabled** | **bool** | | [optional] |
||||
**password** | [**CoreServerCapabilitiesOcsDataCapabilitiesFilesSharingPublicPassword**](CoreServerCapabilitiesOcsDataCapabilitiesFilesSharingPublicPassword.md) | | [optional] |
||||
**expireDate** | [**CoreServerCapabilitiesOcsDataCapabilitiesFilesSharingPublicExpireDate**](CoreServerCapabilitiesOcsDataCapabilitiesFilesSharingPublicExpireDate.md) | | [optional] |
||||
**multipleLinks** | **bool** | | [optional] |
||||
**expireDateInternal** | [**CoreServerCapabilitiesOcsDataCapabilitiesFilesSharingPublicExpireDate**](CoreServerCapabilitiesOcsDataCapabilitiesFilesSharingPublicExpireDate.md) | | [optional] |
||||
**expireDateRemote** | [**CoreServerCapabilitiesOcsDataCapabilitiesFilesSharingPublicExpireDate**](CoreServerCapabilitiesOcsDataCapabilitiesFilesSharingPublicExpireDate.md) | | [optional] |
||||
**sendMail** | **bool** | | [optional] |
||||
**upload** | **bool** | | [optional] |
||||
**uploadFilesDrop** | **bool** | | [optional] |
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
||||
|
||||
|
@ -1,15 +0,0 @@
|
||||
# openapi.model.CoreServerCapabilitiesOcsDataCapabilitiesFilesSharingPublicExpireDate |
||||
|
||||
## Load the model package |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
``` |
||||
|
||||
## Properties |
||||
Name | Type | Description | Notes |
||||
------------ | ------------- | ------------- | ------------- |
||||
**enabled** | **bool** | | [optional] |
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
||||
|
||||
|
@ -1,16 +0,0 @@
|
||||
# openapi.model.CoreServerCapabilitiesOcsDataCapabilitiesFilesSharingPublicPassword |
||||
|
||||
## Load the model package |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
``` |
||||
|
||||
## Properties |
||||
Name | Type | Description | Notes |
||||
------------ | ------------- | ------------- | ------------- |
||||
**enforced** | **bool** | | [optional] |
||||
**askForOptionalPassword** | **bool** | | [optional] |
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
||||
|
||||
|
@ -1,19 +0,0 @@
|
||||
# openapi.model.CoreServerCapabilitiesOcsDataCapabilitiesFilesSharingSharebymail |
||||
|
||||
## Load the model package |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
``` |
||||
|
||||
## Properties |
||||
Name | Type | Description | Notes |
||||
------------ | ------------- | ------------- | ------------- |
||||
**enabled** | **bool** | | [optional] |
||||
**sendPasswordByMail** | **bool** | | [optional] |
||||
**uploadFilesDrop** | [**CoreServerCapabilitiesOcsDataCapabilitiesFilesSharingPublicExpireDate**](CoreServerCapabilitiesOcsDataCapabilitiesFilesSharingPublicExpireDate.md) | | [optional] |
||||
**password** | [**CoreServerCapabilitiesOcsDataCapabilitiesFilesSharingSharebymailPassword**](CoreServerCapabilitiesOcsDataCapabilitiesFilesSharingSharebymailPassword.md) | | [optional] |
||||
**expireDate** | [**CoreServerCapabilitiesOcsDataCapabilitiesFilesSharingSharebymailPassword**](CoreServerCapabilitiesOcsDataCapabilitiesFilesSharingSharebymailPassword.md) | | [optional] |
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
||||
|
||||
|
@ -1,16 +0,0 @@
|
||||
# openapi.model.CoreServerCapabilitiesOcsDataCapabilitiesFilesSharingSharebymailPassword |
||||
|
||||
## Load the model package |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
``` |
||||
|
||||
## Properties |
||||
Name | Type | Description | Notes |
||||
------------ | ------------- | ------------- | ------------- |
||||
**enabled** | **bool** | | [optional] |
||||
**enforced** | **bool** | | [optional] |
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
||||
|
||||
|
@ -1,16 +0,0 @@
|
||||
# openapi.model.CoreServerCapabilitiesOcsDataCapabilitiesFilesSharingSharee |
||||
|
||||
## Load the model package |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
``` |
||||
|
||||
## Properties |
||||
Name | Type | Description | Notes |
||||
------------ | ------------- | ------------- | ------------- |
||||
**queryLookupDefault** | **bool** | | [optional] |
||||
**alwaysShowUnique** | **bool** | | [optional] |
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
||||
|
||||
|
@ -1,16 +0,0 @@
|
||||
# openapi.model.CoreServerCapabilitiesOcsDataCapabilitiesFilesSharingUser |
||||
|
||||
## Load the model package |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
``` |
||||
|
||||
## Properties |
||||
Name | Type | Description | Notes |
||||
------------ | ------------- | ------------- | ------------- |
||||
**sendMail** | **bool** | | [optional] |
||||
**expireDate** | [**CoreServerCapabilitiesOcsDataCapabilitiesFilesSharingPublicExpireDate**](CoreServerCapabilitiesOcsDataCapabilitiesFilesSharingPublicExpireDate.md) | | [optional] |
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
||||
|
||||
|
@ -1,15 +0,0 @@
|
||||
# openapi.model.CoreServerCapabilitiesOcsDataCapabilitiesMetadataAvailable |
||||
|
||||
## Load the model package |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
``` |
||||
|
||||
## Properties |
||||
Name | Type | Description | Notes |
||||
------------ | ------------- | ------------- | ------------- |
||||
**size** | **List<String>** | | [optional] [default to const []] |
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
||||
|
||||
|
@ -1,16 +0,0 @@
|
||||
# openapi.model.CoreServerCapabilitiesOcsDataCapabilitiesNotes |
||||
|
||||
## Load the model package |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
``` |
||||
|
||||
## Properties |
||||
Name | Type | Description | Notes |
||||
------------ | ------------- | ------------- | ------------- |
||||
**apiVersion** | **List<String>** | | [optional] [default to const []] |
||||
**version** | **String** | | [optional] |
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
||||
|
||||
|
@ -1,17 +0,0 @@
|
||||
# openapi.model.CoreServerCapabilitiesOcsDataCapabilitiesNotifications |
||||
|
||||
## Load the model package |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
``` |
||||
|
||||
## Properties |
||||
Name | Type | Description | Notes |
||||
------------ | ------------- | ------------- | ------------- |
||||
**ocsEndpoints** | **List<String>** | | [optional] [default to const []] |
||||
**push** | **List<String>** | | [optional] [default to const []] |
||||
**adminNotifications** | **List<String>** | | [optional] [default to const []] |
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
||||
|
||||
|
@ -1,18 +0,0 @@
|
||||
# openapi.model.CoreServerCapabilitiesOcsDataCapabilitiesOcm |
||||
|
||||
## Load the model package |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
``` |
||||
|
||||
## Properties |
||||
Name | Type | Description | Notes |
||||
------------ | ------------- | ------------- | ------------- |
||||
**enabled** | **bool** | | [optional] |
||||
**apiVersion** | **String** | | [optional] |
||||
**endPoint** | **String** | | [optional] |
||||
**resourceTypes** | [**List<CoreServerCapabilitiesOcsDataCapabilitiesOcmResourceTypesInner>**](CoreServerCapabilitiesOcsDataCapabilitiesOcmResourceTypesInner.md) | | [optional] [default to const []] |
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
||||
|
||||
|
@ -1,17 +0,0 @@
|
||||
# openapi.model.CoreServerCapabilitiesOcsDataCapabilitiesOcmResourceTypesInner |
||||
|
||||
## Load the model package |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
``` |
||||
|
||||
## Properties |
||||
Name | Type | Description | Notes |
||||
------------ | ------------- | ------------- | ------------- |
||||
**name** | **String** | | [optional] |
||||
**shareTypes** | **List<String>** | | [optional] [default to const []] |
||||
**protocols** | [**CoreServerCapabilitiesOcsDataCapabilitiesOcmResourceTypesInnerProtocols**](CoreServerCapabilitiesOcsDataCapabilitiesOcmResourceTypesInnerProtocols.md) | | [optional] |
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
||||
|
||||
|
@ -1,15 +0,0 @@
|
||||
# openapi.model.CoreServerCapabilitiesOcsDataCapabilitiesOcmResourceTypesInnerProtocols |
||||
|
||||
## Load the model package |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
``` |
||||
|
||||
## Properties |
||||
Name | Type | Description | Notes |
||||
------------ | ------------- | ------------- | ------------- |
||||
**webdav** | **String** | | [optional] |
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
||||
|
||||
|
@ -1,20 +0,0 @@
|
||||
# openapi.model.CoreServerCapabilitiesOcsDataCapabilitiesPasswordPolicy |
||||
|
||||
## Load the model package |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
``` |
||||
|
||||
## Properties |
||||
Name | Type | Description | Notes |
||||
------------ | ------------- | ------------- | ------------- |
||||
**minLength** | **int** | | [optional] |
||||
**enforceNonCommonPassword** | **bool** | | [optional] |
||||
**enforceNumericCharacters** | **bool** | | [optional] |
||||
**enforceSpecialCharacters** | **bool** | | [optional] |
||||
**enforceUpperLowerCase** | **bool** | | [optional] |
||||
**api** | [**CoreServerCapabilitiesOcsDataCapabilitiesPasswordPolicyApi**](CoreServerCapabilitiesOcsDataCapabilitiesPasswordPolicyApi.md) | | [optional] |
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
||||
|
||||
|
@ -1,16 +0,0 @@
|
||||
# openapi.model.CoreServerCapabilitiesOcsDataCapabilitiesPasswordPolicyApi |
||||
|
||||
## Load the model package |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
``` |
||||
|
||||
## Properties |
||||
Name | Type | Description | Notes |
||||
------------ | ------------- | ------------- | ------------- |
||||
**generate** | **String** | | [optional] |
||||
**validate** | **String** | | [optional] |
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
||||
|
||||
|
@ -1,18 +0,0 @@
|
||||
# openapi.model.CoreServerCapabilitiesOcsDataCapabilitiesProvisioningApi |
||||
|
||||
## Load the model package |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
``` |
||||
|
||||
## Properties |
||||
Name | Type | Description | Notes |
||||
------------ | ------------- | ------------- | ------------- |
||||
**version** | **String** | | [optional] |
||||
**accountPropertyScopesVersion** | **int** | | [optional] |
||||
**accountPropertyScopesFederatedEnabled** | **bool** | | [optional] |
||||
**accountPropertyScopesPublishedEnabled** | **bool** | | [optional] |
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
||||
|
||||
|
@ -1,28 +0,0 @@
|
||||
# openapi.model.CoreServerCapabilitiesOcsDataCapabilitiesTheming |
||||
|
||||
## Load the model package |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
``` |
||||
|
||||
## Properties |
||||
Name | Type | Description | Notes |
||||
------------ | ------------- | ------------- | ------------- |
||||
**name** | **String** | | [optional] |
||||
**url** | **String** | | [optional] |
||||
**slogan** | **String** | | [optional] |
||||
**color** | **String** | | [optional] |
||||
**colorText** | **String** | | [optional] |
||||
**colorElement** | **String** | | [optional] |
||||
**colorElementBright** | **String** | | [optional] |
||||
**colorElementDark** | **String** | | [optional] |
||||
**logo** | **String** | | [optional] |
||||
**background** | **String** | | [optional] |
||||
**backgroundPlain** | **bool** | | [optional] |
||||
**backgroundDefault** | **bool** | | [optional] |
||||
**logoheader** | **String** | | [optional] |
||||
**favicon** | **String** | | [optional] |
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
||||
|
||||
|
@ -1,16 +0,0 @@
|
||||
# openapi.model.CoreServerCapabilitiesOcsDataCapabilitiesUserStatus |
||||
|
||||
## Load the model package |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
``` |
||||
|
||||
## Properties |
||||
Name | Type | Description | Notes |
||||
------------ | ------------- | ------------- | ------------- |
||||
**enabled** | **bool** | | [optional] |
||||
**supportsEmoji** | **bool** | | [optional] |
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
||||
|
||||
|
@ -1,20 +0,0 @@
|
||||
# openapi.model.CoreServerCapabilitiesOcsDataVersion |
||||
|
||||
## Load the model package |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
``` |
||||
|
||||
## Properties |
||||
Name | Type | Description | Notes |
||||
------------ | ------------- | ------------- | ------------- |
||||
**major** | **int** | | [optional] |
||||
**minor** | **int** | | [optional] |
||||
**micro** | **int** | | [optional] |
||||
**string** | **String** | | [optional] |
||||
**edition** | **String** | | [optional] |
||||
**extendedSupport** | **bool** | | [optional] |
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
||||
|
||||
|
@ -1,22 +0,0 @@
|
||||
# openapi.model.CoreServerStatus |
||||
|
||||
## Load the model package |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
``` |
||||
|
||||
## Properties |
||||
Name | Type | Description | Notes |
||||
------------ | ------------- | ------------- | ------------- |
||||
**installed** | **bool** | | [optional] |
||||
**maintenance** | **bool** | | [optional] |
||||
**needsDbUpgrade** | **bool** | | [optional] |
||||
**version** | **String** | | [optional] |
||||
**versionstring** | **String** | | [optional] |
||||
**edition** | **String** | | [optional] |
||||
**productname** | **String** | | [optional] |
||||
**extendedSupport** | **bool** | | [optional] |
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
||||
|
||||
|
@ -1,324 +0,0 @@
|
||||
# openapi.api.DefaultApi |
||||
|
||||
## Load the API package |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
``` |
||||
|
||||
All URIs are relative to *https://localhost:8080* |
||||
|
||||
Method | HTTP request | Description |
||||
------------- | ------------- | ------------- |
||||
[**getAvatar**](DefaultApi.md#getavatar) | **GET** /avatar/{userId}/{size} | |
||||
[**getCapabilities**](DefaultApi.md#getcapabilities) | **GET** /ocs/v1.php/cloud/capabilities | |
||||
[**getLoginFlowResult**](DefaultApi.md#getloginflowresult) | **POST** /login/v2/poll | |
||||
[**getNavigationApps**](DefaultApi.md#getnavigationapps) | **GET** /ocs/v1.php/core/navigation/apps | |
||||
[**getPreview**](DefaultApi.md#getpreview) | **GET** /core/preview.png | |
||||
[**getStatus**](DefaultApi.md#getstatus) | **GET** /status.php | |
||||
[**initLoginFlow**](DefaultApi.md#initloginflow) | **POST** /login/v2 | |
||||
|
||||
|
||||
# **getAvatar** |
||||
> String getAvatar(userId, size) |
||||
|
||||
|
||||
|
||||
### Example |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
// TODO Configure HTTP basic authorization: basic_auth |
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').username = 'YOUR_USERNAME' |
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').password = 'YOUR_PASSWORD'; |
||||
|
||||
final api_instance = DefaultApi(); |
||||
final userId = userId_example; // String | |
||||
final size = 56; // int | |
||||
|
||||
try { |
||||
final result = api_instance.getAvatar(userId, size); |
||||
print(result); |
||||
} catch (e) { |
||||
print('Exception when calling DefaultApi->getAvatar: $e\n'); |
||||
} |
||||
``` |
||||
|
||||
### Parameters |
||||
|
||||
Name | Type | Description | Notes |
||||
------------- | ------------- | ------------- | ------------- |
||||
**userId** | **String**| | |
||||
**size** | **int**| | |
||||
|
||||
### Return type |
||||
|
||||
**String** |
||||
|
||||
### Authorization |
||||
|
||||
[basic_auth](../README.md#basic_auth) |
||||
|
||||
### HTTP request headers |
||||
|
||||
- **Content-Type**: Not defined |
||||
- **Accept**: application/json |
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) |
||||
|
||||
# **getCapabilities** |
||||
> CoreServerCapabilities getCapabilities() |
||||
|
||||
|
||||
|
||||
### Example |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
// TODO Configure HTTP basic authorization: basic_auth |
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').username = 'YOUR_USERNAME' |
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').password = 'YOUR_PASSWORD'; |
||||
|
||||
final api_instance = DefaultApi(); |
||||
|
||||
try { |
||||
final result = api_instance.getCapabilities(); |
||||
print(result); |
||||
} catch (e) { |
||||
print('Exception when calling DefaultApi->getCapabilities: $e\n'); |
||||
} |
||||
``` |
||||
|
||||
### Parameters |
||||
This endpoint does not need any parameter. |
||||
|
||||
### Return type |
||||
|
||||
[**CoreServerCapabilities**](CoreServerCapabilities.md) |
||||
|
||||
### Authorization |
||||
|
||||
[basic_auth](../README.md#basic_auth) |
||||
|
||||
### HTTP request headers |
||||
|
||||
- **Content-Type**: Not defined |
||||
- **Accept**: application/json |
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) |
||||
|
||||
# **getLoginFlowResult** |
||||
> CoreLoginFlowResult getLoginFlowResult(token) |
||||
|
||||
|
||||
|
||||
### Example |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
// TODO Configure HTTP basic authorization: basic_auth |
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').username = 'YOUR_USERNAME' |
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').password = 'YOUR_PASSWORD'; |
||||
|
||||
final api_instance = DefaultApi(); |
||||
final token = token_example; // String | |
||||
|
||||
try { |
||||
final result = api_instance.getLoginFlowResult(token); |
||||
print(result); |
||||
} catch (e) { |
||||
print('Exception when calling DefaultApi->getLoginFlowResult: $e\n'); |
||||
} |
||||
``` |
||||
|
||||
### Parameters |
||||
|
||||
Name | Type | Description | Notes |
||||
------------- | ------------- | ------------- | ------------- |
||||
**token** | **String**| | |
||||
|
||||
### Return type |
||||
|
||||
[**CoreLoginFlowResult**](CoreLoginFlowResult.md) |
||||
|
||||
### Authorization |
||||
|
||||
[basic_auth](../README.md#basic_auth) |
||||
|
||||
### HTTP request headers |
||||
|
||||
- **Content-Type**: Not defined |
||||
- **Accept**: application/json |
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) |
||||
|
||||
# **getNavigationApps** |
||||
> CoreNavigationApps getNavigationApps() |
||||
|
||||
|
||||
|
||||
### Example |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
// TODO Configure HTTP basic authorization: basic_auth |
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').username = 'YOUR_USERNAME' |
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').password = 'YOUR_PASSWORD'; |
||||
|
||||
final api_instance = DefaultApi(); |
||||
|
||||
try { |
||||
final result = api_instance.getNavigationApps(); |
||||
print(result); |
||||
} catch (e) { |
||||
print('Exception when calling DefaultApi->getNavigationApps: $e\n'); |
||||
} |
||||
``` |
||||
|
||||
### Parameters |
||||
This endpoint does not need any parameter. |
||||
|
||||
### Return type |
||||
|
||||
[**CoreNavigationApps**](CoreNavigationApps.md) |
||||
|
||||
### Authorization |
||||
|
||||
[basic_auth](../README.md#basic_auth) |
||||
|
||||
### HTTP request headers |
||||
|
||||
- **Content-Type**: Not defined |
||||
- **Accept**: application/json |
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) |
||||
|
||||
# **getPreview** |
||||
> String getPreview(file, x, y, a, forceIcon, mode) |
||||
|
||||
|
||||
|
||||
### Example |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
// TODO Configure HTTP basic authorization: basic_auth |
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').username = 'YOUR_USERNAME' |
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').password = 'YOUR_PASSWORD'; |
||||
|
||||
final api_instance = DefaultApi(); |
||||
final file = file_example; // String | |
||||
final x = 56; // int | |
||||
final y = 56; // int | |
||||
final a = true; // bool | |
||||
final forceIcon = true; // bool | |
||||
final mode = mode_example; // String | |
||||
|
||||
try { |
||||
final result = api_instance.getPreview(file, x, y, a, forceIcon, mode); |
||||
print(result); |
||||
} catch (e) { |
||||
print('Exception when calling DefaultApi->getPreview: $e\n'); |
||||
} |
||||
``` |
||||
|
||||
### Parameters |
||||
|
||||
Name | Type | Description | Notes |
||||
------------- | ------------- | ------------- | ------------- |
||||
**file** | **String**| | [optional] [default to ''] |
||||
**x** | **int**| | [optional] [default to 32] |
||||
**y** | **int**| | [optional] [default to 32] |
||||
**a** | **bool**| | [optional] [default to false] |
||||
**forceIcon** | **bool**| | [optional] [default to true] |
||||
**mode** | **String**| | [optional] [default to 'fill'] |
||||
|
||||
### Return type |
||||
|
||||
**String** |
||||
|
||||
### Authorization |
||||
|
||||
[basic_auth](../README.md#basic_auth) |
||||
|
||||
### HTTP request headers |
||||
|
||||
- **Content-Type**: Not defined |
||||
- **Accept**: image/png |
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) |
||||
|
||||
# **getStatus** |
||||
> CoreServerStatus getStatus() |
||||
|
||||
|
||||
|
||||
### Example |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
// TODO Configure HTTP basic authorization: basic_auth |
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').username = 'YOUR_USERNAME' |
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').password = 'YOUR_PASSWORD'; |
||||
|
||||
final api_instance = DefaultApi(); |
||||
|
||||
try { |
||||
final result = api_instance.getStatus(); |
||||
print(result); |
||||
} catch (e) { |
||||
print('Exception when calling DefaultApi->getStatus: $e\n'); |
||||
} |
||||
``` |
||||
|
||||
### Parameters |
||||
This endpoint does not need any parameter. |
||||
|
||||
### Return type |
||||
|
||||
[**CoreServerStatus**](CoreServerStatus.md) |
||||
|
||||
### Authorization |
||||
|
||||
[basic_auth](../README.md#basic_auth) |
||||
|
||||
### HTTP request headers |
||||
|
||||
- **Content-Type**: Not defined |
||||
- **Accept**: application/json |
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) |
||||
|
||||
# **initLoginFlow** |
||||
> CoreLoginFlowInit initLoginFlow() |
||||
|
||||
|
||||
|
||||
### Example |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
// TODO Configure HTTP basic authorization: basic_auth |
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').username = 'YOUR_USERNAME' |
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').password = 'YOUR_PASSWORD'; |
||||
|
||||
final api_instance = DefaultApi(); |
||||
|
||||
try { |
||||
final result = api_instance.initLoginFlow(); |
||||
print(result); |
||||
} catch (e) { |
||||
print('Exception when calling DefaultApi->initLoginFlow: $e\n'); |
||||
} |
||||
``` |
||||
|
||||
### Parameters |
||||
This endpoint does not need any parameter. |
||||
|
||||
### Return type |
||||
|
||||
[**CoreLoginFlowInit**](CoreLoginFlowInit.md) |
||||
|
||||
### Authorization |
||||
|
||||
[basic_auth](../README.md#basic_auth) |
||||
|
||||
### HTTP request headers |
||||
|
||||
- **Content-Type**: Not defined |
||||
- **Accept**: application/json |
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) |
||||
|
@ -1,789 +0,0 @@
|
||||
# openapi.api.DefaultApi |
||||
|
||||
## Load the API package |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
``` |
||||
|
||||
All URIs are relative to *https://localhost:8080/apps/news* |
||||
|
||||
Method | HTTP request | Description |
||||
------------- | ------------- | ------------- |
||||
[**addFeed**](DefaultApi.md#addfeed) | **POST** /api/v1-2/feeds | |
||||
[**createFolder**](DefaultApi.md#createfolder) | **POST** /api/v1-2/folders | |
||||
[**deleteFeed**](DefaultApi.md#deletefeed) | **DELETE** /api/v1-2/feeds/{feedId} | |
||||
[**deleteFolder**](DefaultApi.md#deletefolder) | **DELETE** /api/v1-2/folders/{folderId} | |
||||
[**listArticles**](DefaultApi.md#listarticles) | **GET** /api/v1-2/items | |
||||
[**listFeeds**](DefaultApi.md#listfeeds) | **GET** /api/v1-2/feeds | |
||||
[**listFolders**](DefaultApi.md#listfolders) | **GET** /api/v1-2/folders | |
||||
[**listUpdatedArticles**](DefaultApi.md#listupdatedarticles) | **GET** /api/v1-2/items/updated | |
||||
[**markArticleAsRead**](DefaultApi.md#markarticleasread) | **PUT** /api/v1-2/items/{itemId}/read | |
||||
[**markArticleAsUnread**](DefaultApi.md#markarticleasunread) | **PUT** /api/v1-2/items/{itemId}/unread | |
||||
[**markFeedAsRead**](DefaultApi.md#markfeedasread) | **PUT** /api/v1-2/feeds/{feedId}/read | |
||||
[**markFolderAsRead**](DefaultApi.md#markfolderasread) | **PUT** /api/v1-2/folders/{folderId}/read | |
||||
[**moveFeed**](DefaultApi.md#movefeed) | **PUT** /api/v1-2/feeds/{feedId}/move | |
||||
[**renameFeed**](DefaultApi.md#renamefeed) | **PUT** /api/v1-2/feeds/{feedId}/rename | |
||||
[**renameFolder**](DefaultApi.md#renamefolder) | **PUT** /api/v1-2/folders/{folderId} | |
||||
[**starArticle**](DefaultApi.md#stararticle) | **PUT** /api/v1-2/items/{feedId}/{guidHash}/star | |
||||
[**unstarArticle**](DefaultApi.md#unstararticle) | **PUT** /api/v1-2/items/{feedId}/{guidHash}/unstar | |
||||
|
||||
|
||||
# **addFeed** |
||||
> NewsListFeeds addFeed(url, folderId) |
||||
|
||||
|
||||
|
||||
### Example |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
// TODO Configure HTTP basic authorization: basic_auth |
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').username = 'YOUR_USERNAME' |
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').password = 'YOUR_PASSWORD'; |
||||
|
||||
final api_instance = DefaultApi(); |
||||
final url = url_example; // String | |
||||
final folderId = 56; // int | |
||||
|
||||
try { |
||||
final result = api_instance.addFeed(url, folderId); |
||||
print(result); |
||||
} catch (e) { |
||||
print('Exception when calling DefaultApi->addFeed: $e\n'); |
||||
} |
||||
``` |
||||
|
||||
### Parameters |
||||
|
||||
Name | Type | Description | Notes |
||||
------------- | ------------- | ------------- | ------------- |
||||
**url** | **String**| | |
||||
**folderId** | **int**| | [optional] |
||||
|
||||
### Return type |
||||
|
||||
[**NewsListFeeds**](NewsListFeeds.md) |
||||
|
||||
### Authorization |
||||
|
||||
[basic_auth](../README.md#basic_auth) |
||||
|
||||
### HTTP request headers |
||||
|
||||
- **Content-Type**: Not defined |
||||
- **Accept**: application/json |
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) |
||||
|
||||
# **createFolder** |
||||
> NewsListFolders createFolder(name) |
||||
|
||||
|
||||
|
||||
### Example |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
// TODO Configure HTTP basic authorization: basic_auth |
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').username = 'YOUR_USERNAME' |
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').password = 'YOUR_PASSWORD'; |
||||
|
||||
final api_instance = DefaultApi(); |
||||
final name = name_example; // String | |
||||
|
||||
try { |
||||
final result = api_instance.createFolder(name); |
||||
print(result); |
||||
} catch (e) { |
||||
print('Exception when calling DefaultApi->createFolder: $e\n'); |
||||
} |
||||
``` |
||||
|
||||
### Parameters |
||||
|
||||
Name | Type | Description | Notes |
||||
------------- | ------------- | ------------- | ------------- |
||||
**name** | **String**| | |
||||
|
||||
### Return type |
||||
|
||||
[**NewsListFolders**](NewsListFolders.md) |
||||
|
||||
### Authorization |
||||
|
||||
[basic_auth](../README.md#basic_auth) |
||||
|
||||
### HTTP request headers |
||||
|
||||
- **Content-Type**: Not defined |
||||
- **Accept**: application/json |
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) |
||||
|
||||
# **deleteFeed** |
||||
> deleteFeed(feedId) |
||||
|
||||
|
||||
|
||||
### Example |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
// TODO Configure HTTP basic authorization: basic_auth |
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').username = 'YOUR_USERNAME' |
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').password = 'YOUR_PASSWORD'; |
||||
|
||||
final api_instance = DefaultApi(); |
||||
final feedId = 56; // int | |
||||
|
||||
try { |
||||
api_instance.deleteFeed(feedId); |
||||
} catch (e) { |
||||
print('Exception when calling DefaultApi->deleteFeed: $e\n'); |
||||
} |
||||
``` |
||||
|
||||
### Parameters |
||||
|
||||
Name | Type | Description | Notes |
||||
------------- | ------------- | ------------- | ------------- |
||||
**feedId** | **int**| | |
||||
|
||||
### Return type |
||||
|
||||
void (empty response body) |
||||
|
||||
### Authorization |
||||
|
||||
[basic_auth](../README.md#basic_auth) |
||||
|
||||
### HTTP request headers |
||||
|
||||
- **Content-Type**: Not defined |
||||
- **Accept**: Not defined |
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) |
||||
|
||||
# **deleteFolder** |
||||
> deleteFolder(folderId) |
||||
|
||||
|
||||
|
||||
### Example |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
// TODO Configure HTTP basic authorization: basic_auth |
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').username = 'YOUR_USERNAME' |
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').password = 'YOUR_PASSWORD'; |
||||
|
||||
final api_instance = DefaultApi(); |
||||
final folderId = 56; // int | |
||||
|
||||
try { |
||||
api_instance.deleteFolder(folderId); |
||||
} catch (e) { |
||||
print('Exception when calling DefaultApi->deleteFolder: $e\n'); |
||||
} |
||||
``` |
||||
|
||||
### Parameters |
||||
|
||||
Name | Type | Description | Notes |
||||
------------- | ------------- | ------------- | ------------- |
||||
**folderId** | **int**| | |
||||
|
||||
### Return type |
||||
|
||||
void (empty response body) |
||||
|
||||
### Authorization |
||||
|
||||
[basic_auth](../README.md#basic_auth) |
||||
|
||||
### HTTP request headers |
||||
|
||||
- **Content-Type**: Not defined |
||||
- **Accept**: Not defined |
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) |
||||
|
||||
# **listArticles** |
||||
> NewsListArticles listArticles(type, id, getRead, batchSize, offset, oldestFirst) |
||||
|
||||
|
||||
|
||||
### Example |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
// TODO Configure HTTP basic authorization: basic_auth |
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').username = 'YOUR_USERNAME' |
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').password = 'YOUR_PASSWORD'; |
||||
|
||||
final api_instance = DefaultApi(); |
||||
final type = 56; // int | |
||||
final id = 56; // int | |
||||
final getRead = true; // bool | |
||||
final batchSize = 56; // int | |
||||
final offset = 56; // int | |
||||
final oldestFirst = true; // bool | |
||||
|
||||
try { |
||||
final result = api_instance.listArticles(type, id, getRead, batchSize, offset, oldestFirst); |
||||
print(result); |
||||
} catch (e) { |
||||
print('Exception when calling DefaultApi->listArticles: $e\n'); |
||||
} |
||||
``` |
||||
|
||||
### Parameters |
||||
|
||||
Name | Type | Description | Notes |
||||
------------- | ------------- | ------------- | ------------- |
||||
**type** | **int**| | [optional] [default to 3] |
||||
**id** | **int**| | [optional] [default to 0] |
||||
**getRead** | **bool**| | [optional] [default to true] |
||||
**batchSize** | **int**| | [optional] [default to -1] |
||||
**offset** | **int**| | [optional] [default to 0] |
||||
**oldestFirst** | **bool**| | [optional] [default to false] |
||||
|
||||
### Return type |
||||
|
||||
[**NewsListArticles**](NewsListArticles.md) |
||||
|
||||
### Authorization |
||||
|
||||
[basic_auth](../README.md#basic_auth) |
||||
|
||||
### HTTP request headers |
||||
|
||||
- **Content-Type**: Not defined |
||||
- **Accept**: application/json |
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) |
||||
|
||||
# **listFeeds** |
||||
> NewsListFeeds listFeeds() |
||||
|
||||
|
||||
|
||||
### Example |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
// TODO Configure HTTP basic authorization: basic_auth |
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').username = 'YOUR_USERNAME' |
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').password = 'YOUR_PASSWORD'; |
||||
|
||||
final api_instance = DefaultApi(); |
||||
|
||||
try { |
||||
final result = api_instance.listFeeds(); |
||||
print(result); |
||||
} catch (e) { |
||||
print('Exception when calling DefaultApi->listFeeds: $e\n'); |
||||
} |
||||
``` |
||||
|
||||
### Parameters |
||||
This endpoint does not need any parameter. |
||||
|
||||
### Return type |
||||
|
||||
[**NewsListFeeds**](NewsListFeeds.md) |
||||
|
||||
### Authorization |
||||
|
||||
[basic_auth](../README.md#basic_auth) |
||||
|
||||
### HTTP request headers |
||||
|
||||
- **Content-Type**: Not defined |
||||
- **Accept**: application/json |
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) |
||||
|
||||
# **listFolders** |
||||
> NewsListFolders listFolders() |
||||
|
||||
|
||||
|
||||
### Example |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
// TODO Configure HTTP basic authorization: basic_auth |
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').username = 'YOUR_USERNAME' |
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').password = 'YOUR_PASSWORD'; |
||||
|
||||
final api_instance = DefaultApi(); |
||||
|
||||
try { |
||||
final result = api_instance.listFolders(); |
||||
print(result); |
||||
} catch (e) { |
||||
print('Exception when calling DefaultApi->listFolders: $e\n'); |
||||
} |
||||
``` |
||||
|
||||
### Parameters |
||||
This endpoint does not need any parameter. |
||||
|
||||
### Return type |
||||
|
||||
[**NewsListFolders**](NewsListFolders.md) |
||||
|
||||
### Authorization |
||||
|
||||
[basic_auth](../README.md#basic_auth) |
||||
|
||||
### HTTP request headers |
||||
|
||||
- **Content-Type**: Not defined |
||||
- **Accept**: application/json |
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) |
||||
|
||||
# **listUpdatedArticles** |
||||
> NewsListArticles listUpdatedArticles(type, id, lastModified) |
||||
|
||||
|
||||
|
||||
### Example |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
// TODO Configure HTTP basic authorization: basic_auth |
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').username = 'YOUR_USERNAME' |
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').password = 'YOUR_PASSWORD'; |
||||
|
||||
final api_instance = DefaultApi(); |
||||
final type = 56; // int | |
||||
final id = 56; // int | |
||||
final lastModified = 56; // int | |
||||
|
||||
try { |
||||
final result = api_instance.listUpdatedArticles(type, id, lastModified); |
||||
print(result); |
||||
} catch (e) { |
||||
print('Exception when calling DefaultApi->listUpdatedArticles: $e\n'); |
||||
} |
||||
``` |
||||
|
||||
### Parameters |
||||
|
||||
Name | Type | Description | Notes |
||||
------------- | ------------- | ------------- | ------------- |
||||
**type** | **int**| | [optional] [default to 3] |
||||
**id** | **int**| | [optional] [default to 0] |
||||
**lastModified** | **int**| | [optional] [default to 0] |
||||
|
||||
### Return type |
||||
|
||||
[**NewsListArticles**](NewsListArticles.md) |
||||
|
||||
### Authorization |
||||
|
||||
[basic_auth](../README.md#basic_auth) |
||||
|
||||
### HTTP request headers |
||||
|
||||
- **Content-Type**: Not defined |
||||
- **Accept**: application/json |
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) |
||||
|
||||
# **markArticleAsRead** |
||||
> markArticleAsRead(itemId) |
||||
|
||||
|
||||
|
||||
### Example |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
// TODO Configure HTTP basic authorization: basic_auth |
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').username = 'YOUR_USERNAME' |
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').password = 'YOUR_PASSWORD'; |
||||
|
||||
final api_instance = DefaultApi(); |
||||
final itemId = 56; // int | |
||||
|
||||
try { |
||||
api_instance.markArticleAsRead(itemId); |
||||
} catch (e) { |
||||
print('Exception when calling DefaultApi->markArticleAsRead: $e\n'); |
||||
} |
||||
``` |
||||
|
||||
### Parameters |
||||
|
||||
Name | Type | Description | Notes |
||||
------------- | ------------- | ------------- | ------------- |
||||
**itemId** | **int**| | |
||||
|
||||
### Return type |
||||
|
||||
void (empty response body) |
||||
|
||||
### Authorization |
||||
|
||||
[basic_auth](../README.md#basic_auth) |
||||
|
||||
### HTTP request headers |
||||
|
||||
- **Content-Type**: Not defined |
||||
- **Accept**: Not defined |
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) |
||||
|
||||
# **markArticleAsUnread** |
||||
> markArticleAsUnread(itemId) |
||||
|
||||
|
||||
|
||||
### Example |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
// TODO Configure HTTP basic authorization: basic_auth |
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').username = 'YOUR_USERNAME' |
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').password = 'YOUR_PASSWORD'; |
||||
|
||||
final api_instance = DefaultApi(); |
||||
final itemId = 56; // int | |
||||
|
||||
try { |
||||
api_instance.markArticleAsUnread(itemId); |
||||
} catch (e) { |
||||
print('Exception when calling DefaultApi->markArticleAsUnread: $e\n'); |
||||
} |
||||
``` |
||||
|
||||
### Parameters |
||||
|
||||
Name | Type | Description | Notes |
||||
------------- | ------------- | ------------- | ------------- |
||||
**itemId** | **int**| | |
||||
|
||||
### Return type |
||||
|
||||
void (empty response body) |
||||
|
||||
### Authorization |
||||
|
||||
[basic_auth](../README.md#basic_auth) |
||||
|
||||
### HTTP request headers |
||||
|
||||
- **Content-Type**: Not defined |
||||
- **Accept**: Not defined |
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) |
||||
|
||||
# **markFeedAsRead** |
||||
> markFeedAsRead(feedId, newestItemId) |
||||
|
||||
|
||||
|
||||
### Example |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
// TODO Configure HTTP basic authorization: basic_auth |
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').username = 'YOUR_USERNAME' |
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').password = 'YOUR_PASSWORD'; |
||||
|
||||
final api_instance = DefaultApi(); |
||||
final feedId = 56; // int | |
||||
final newestItemId = 56; // int | |
||||
|
||||
try { |
||||
api_instance.markFeedAsRead(feedId, newestItemId); |
||||
} catch (e) { |
||||
print('Exception when calling DefaultApi->markFeedAsRead: $e\n'); |
||||
} |
||||
``` |
||||
|
||||
### Parameters |
||||
|
||||
Name | Type | Description | Notes |
||||
------------- | ------------- | ------------- | ------------- |
||||
**feedId** | **int**| | |
||||
**newestItemId** | **int**| | |
||||
|
||||
### Return type |
||||
|
||||
void (empty response body) |
||||
|
||||
### Authorization |
||||
|
||||
[basic_auth](../README.md#basic_auth) |
||||
|
||||
### HTTP request headers |
||||
|
||||
- **Content-Type**: Not defined |
||||
- **Accept**: Not defined |
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) |
||||
|
||||
# **markFolderAsRead** |
||||
> markFolderAsRead(folderId, newestItemId) |
||||
|
||||
|
||||
|
||||
### Example |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
// TODO Configure HTTP basic authorization: basic_auth |
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').username = 'YOUR_USERNAME' |
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').password = 'YOUR_PASSWORD'; |
||||
|
||||
final api_instance = DefaultApi(); |
||||
final folderId = 56; // int | ID of the folder |
||||
final newestItemId = 56; // int | The newest read item |
||||
|
||||
try { |
||||
api_instance.markFolderAsRead(folderId, newestItemId); |
||||
} catch (e) { |
||||
print('Exception when calling DefaultApi->markFolderAsRead: $e\n'); |
||||
} |
||||
``` |
||||
|
||||
### Parameters |
||||
|
||||
Name | Type | Description | Notes |
||||
------------- | ------------- | ------------- | ------------- |
||||
**folderId** | **int**| ID of the folder | |
||||
**newestItemId** | **int**| The newest read item | |
||||
|
||||
### Return type |
||||
|
||||
void (empty response body) |
||||
|
||||
### Authorization |
||||
|
||||
[basic_auth](../README.md#basic_auth) |
||||
|
||||
### HTTP request headers |
||||
|
||||
- **Content-Type**: Not defined |
||||
- **Accept**: Not defined |
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) |
||||
|
||||
# **moveFeed** |
||||
> moveFeed(feedId, folderId) |
||||
|
||||
|
||||
|
||||
### Example |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
// TODO Configure HTTP basic authorization: basic_auth |
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').username = 'YOUR_USERNAME' |
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').password = 'YOUR_PASSWORD'; |
||||
|
||||
final api_instance = DefaultApi(); |
||||
final feedId = 56; // int | |
||||
final folderId = 56; // int | |
||||
|
||||
try { |
||||
api_instance.moveFeed(feedId, folderId); |
||||
} catch (e) { |
||||
print('Exception when calling DefaultApi->moveFeed: $e\n'); |
||||
} |
||||
``` |
||||
|
||||
### Parameters |
||||
|
||||
Name | Type | Description | Notes |
||||
------------- | ------------- | ------------- | ------------- |
||||
**feedId** | **int**| | |
||||
**folderId** | **int**| | [optional] |
||||
|
||||
### Return type |
||||
|
||||
void (empty response body) |
||||
|
||||
### Authorization |
||||
|
||||
[basic_auth](../README.md#basic_auth) |
||||
|
||||
### HTTP request headers |
||||
|
||||
- **Content-Type**: Not defined |
||||
- **Accept**: Not defined |
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) |
||||
|
||||
# **renameFeed** |
||||
> renameFeed(feedId, feedTitle) |
||||
|
||||
|
||||
|
||||
### Example |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
// TODO Configure HTTP basic authorization: basic_auth |
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').username = 'YOUR_USERNAME' |
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').password = 'YOUR_PASSWORD'; |
||||
|
||||
final api_instance = DefaultApi(); |
||||
final feedId = 56; // int | |
||||
final feedTitle = feedTitle_example; // String | |
||||
|
||||
try { |
||||
api_instance.renameFeed(feedId, feedTitle); |
||||
} catch (e) { |
||||
print('Exception when calling DefaultApi->renameFeed: $e\n'); |
||||
} |
||||
``` |
||||
|
||||
### Parameters |
||||
|
||||
Name | Type | Description | Notes |
||||
------------- | ------------- | ------------- | ------------- |
||||
**feedId** | **int**| | |
||||
**feedTitle** | **String**| | |
||||
|
||||
### Return type |
||||
|
||||
void (empty response body) |
||||
|
||||
### Authorization |
||||
|
||||
[basic_auth](../README.md#basic_auth) |
||||
|
||||
### HTTP request headers |
||||
|
||||
- **Content-Type**: Not defined |
||||
- **Accept**: Not defined |
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) |
||||
|
||||
# **renameFolder** |
||||
> renameFolder(folderId, name) |
||||
|
||||
|
||||
|
||||
### Example |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
// TODO Configure HTTP basic authorization: basic_auth |
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').username = 'YOUR_USERNAME' |
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').password = 'YOUR_PASSWORD'; |
||||
|
||||
final api_instance = DefaultApi(); |
||||
final folderId = 56; // int | |
||||
final name = name_example; // String | |
||||
|
||||
try { |
||||
api_instance.renameFolder(folderId, name); |
||||
} catch (e) { |
||||
print('Exception when calling DefaultApi->renameFolder: $e\n'); |
||||
} |
||||
``` |
||||
|
||||
### Parameters |
||||
|
||||
Name | Type | Description | Notes |
||||
------------- | ------------- | ------------- | ------------- |
||||
**folderId** | **int**| | |
||||
**name** | **String**| | |
||||
|
||||
### Return type |
||||
|
||||
void (empty response body) |
||||
|
||||
### Authorization |
||||
|
||||
[basic_auth](../README.md#basic_auth) |
||||
|
||||
### HTTP request headers |
||||
|
||||
- **Content-Type**: Not defined |
||||
- **Accept**: Not defined |
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) |
||||
|
||||
# **starArticle** |
||||
> starArticle(feedId, guidHash) |
||||
|
||||
|
||||
|
||||
### Example |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
// TODO Configure HTTP basic authorization: basic_auth |
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').username = 'YOUR_USERNAME' |
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').password = 'YOUR_PASSWORD'; |
||||
|
||||
final api_instance = DefaultApi(); |
||||
final feedId = 56; // int | |
||||
final guidHash = guidHash_example; // String | |
||||
|
||||
try { |
||||
api_instance.starArticle(feedId, guidHash); |
||||
} catch (e) { |
||||
print('Exception when calling DefaultApi->starArticle: $e\n'); |
||||
} |
||||
``` |
||||
|
||||
### Parameters |
||||
|
||||
Name | Type | Description | Notes |
||||
------------- | ------------- | ------------- | ------------- |
||||
**feedId** | **int**| | |
||||
**guidHash** | **String**| | |
||||
|
||||
### Return type |
||||
|
||||
void (empty response body) |
||||
|
||||
### Authorization |
||||
|
||||
[basic_auth](../README.md#basic_auth) |
||||
|
||||
### HTTP request headers |
||||
|
||||
- **Content-Type**: Not defined |
||||
- **Accept**: Not defined |
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) |
||||
|
||||
# **unstarArticle** |
||||
> unstarArticle(feedId, guidHash) |
||||
|
||||
|
||||
|
||||
### Example |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
// TODO Configure HTTP basic authorization: basic_auth |
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').username = 'YOUR_USERNAME' |
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').password = 'YOUR_PASSWORD'; |
||||
|
||||
final api_instance = DefaultApi(); |
||||
final feedId = 56; // int | |
||||
final guidHash = guidHash_example; // String | |
||||
|
||||
try { |
||||
api_instance.unstarArticle(feedId, guidHash); |
||||
} catch (e) { |
||||
print('Exception when calling DefaultApi->unstarArticle: $e\n'); |
||||
} |
||||
``` |
||||
|
||||
### Parameters |
||||
|
||||
Name | Type | Description | Notes |
||||
------------- | ------------- | ------------- | ------------- |
||||
**feedId** | **int**| | |
||||
**guidHash** | **String**| | |
||||
|
||||
### Return type |
||||
|
||||
void (empty response body) |
||||
|
||||
### Authorization |
||||
|
||||
[basic_auth](../README.md#basic_auth) |
||||
|
||||
### HTTP request headers |
||||
|
||||
- **Content-Type**: Not defined |
||||
- **Accept**: Not defined |
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) |
||||
|
@ -1,34 +0,0 @@
|
||||
# openapi.model.NewsArticle |
||||
|
||||
## Load the model package |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
``` |
||||
|
||||
## Properties |
||||
Name | Type | Description | Notes |
||||
------------ | ------------- | ------------- | ------------- |
||||
**id** | **int** | | [optional] |
||||
**guid** | **String** | | [optional] |
||||
**guidHash** | **String** | | [optional] |
||||
**url** | **String** | | [optional] |
||||
**title** | **String** | | [optional] |
||||
**author** | **String** | | [optional] |
||||
**pubDate** | **int** | | [optional] |
||||
**updatedDate** | **int** | | [optional] |
||||
**body** | **String** | | [optional] |
||||
**enclosureMime** | **String** | | [optional] |
||||
**enclosureLink** | **String** | | [optional] |
||||
**mediaThumbnail** | **String** | | [optional] |
||||
**mediaDescription** | **String** | | [optional] |
||||
**feedId** | **int** | | [optional] |
||||
**unread** | **bool** | | [optional] |
||||
**starred** | **bool** | | [optional] |
||||
**lastModified** | **int** | | [optional] |
||||
**rtl** | **bool** | | [optional] |
||||
**fingerprint** | **String** | | [optional] |
||||
**contentHash** | **String** | | [optional] |
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
||||
|
||||
|
@ -1,27 +0,0 @@
|
||||
# openapi.model.NewsFeed |
||||
|
||||
## Load the model package |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
``` |
||||
|
||||
## Properties |
||||
Name | Type | Description | Notes |
||||
------------ | ------------- | ------------- | ------------- |
||||
**id** | **int** | | [optional] |
||||
**url** | **String** | | [optional] |
||||
**title** | **String** | | [optional] |
||||
**faviconLink** | **String** | | [optional] |
||||
**added** | **int** | | [optional] |
||||
**folderId** | **int** | | [optional] |
||||
**unreadCount** | **int** | | [optional] |
||||
**ordering** | **int** | | [optional] |
||||
**link** | **String** | | [optional] |
||||
**pinned** | **bool** | | [optional] |
||||
**updateErrorCount** | **int** | | [optional] |
||||
**lastUpdateError** | **String** | | [optional] |
||||
**items** | [**List<NewsArticle>**](NewsArticle.md) | | [optional] [default to const []] |
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
||||
|
||||
|
@ -1,18 +0,0 @@
|
||||
# openapi.model.NewsFolder |
||||
|
||||
## Load the model package |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
``` |
||||
|
||||
## Properties |
||||
Name | Type | Description | Notes |
||||
------------ | ------------- | ------------- | ------------- |
||||
**id** | **int** | | [optional] |
||||
**name** | **String** | | [optional] |
||||
**opened** | **bool** | | [optional] |
||||
**feeds** | [**List<NewsFeed>**](NewsFeed.md) | This seems to be broken. In testing it is always empty | [optional] [default to const []] |
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
||||
|
||||
|
@ -1,15 +0,0 @@
|
||||
# openapi.model.NewsListArticles |
||||
|
||||
## Load the model package |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
``` |
||||
|
||||
## Properties |
||||
Name | Type | Description | Notes |
||||
------------ | ------------- | ------------- | ------------- |
||||
**items** | [**List<NewsArticle>**](NewsArticle.md) | | [optional] [default to const []] |
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
||||
|
||||
|
@ -1,17 +0,0 @@
|
||||
# openapi.model.NewsListFeeds |
||||
|
||||
## Load the model package |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
``` |
||||
|
||||
## Properties |
||||
Name | Type | Description | Notes |
||||
------------ | ------------- | ------------- | ------------- |
||||
**starredCount** | **int** | | [optional] |
||||
**newestItemId** | **int** | | [optional] |
||||
**feeds** | [**List<NewsFeed>**](NewsFeed.md) | | [optional] [default to const []] |
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
||||
|
||||
|
@ -1,15 +0,0 @@
|
||||
# openapi.model.NewsListFolders |
||||
|
||||
## Load the model package |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
``` |
||||
|
||||
## Properties |
||||
Name | Type | Description | Notes |
||||
------------ | ------------- | ------------- | ------------- |
||||
**folders** | [**List<NewsFolder>**](NewsFolder.md) | | [optional] [default to const []] |
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
||||
|
||||
|
@ -1,358 +0,0 @@
|
||||
# openapi.api.DefaultApi |
||||
|
||||
## Load the API package |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
``` |
||||
|
||||
All URIs are relative to *https://localhost:8080/apps/notes* |
||||
|
||||
Method | HTTP request | Description |
||||
------------- | ------------- | ------------- |
||||
[**createNote**](DefaultApi.md#createnote) | **POST** /api/v1/notes | |
||||
[**deleteNote**](DefaultApi.md#deletenote) | **DELETE** /api/v1/notes/{id} | |
||||
[**getNote**](DefaultApi.md#getnote) | **GET** /api/v1/notes/{id} | |
||||
[**getNotes**](DefaultApi.md#getnotes) | **GET** /api/v1/notes | |
||||
[**getSettings**](DefaultApi.md#getsettings) | **GET** /api/v1/settings | |
||||
[**updateNote**](DefaultApi.md#updatenote) | **PUT** /api/v1/notes/{id} | |
||||
[**updateSettings**](DefaultApi.md#updatesettings) | **PUT** /api/v1/settings | |
||||
|
||||
|
||||
# **createNote** |
||||
> NotesNote createNote(category, title, content, modified, favorite) |
||||
|
||||
|
||||
|
||||
### Example |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
// TODO Configure HTTP basic authorization: basic_auth |
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').username = 'YOUR_USERNAME' |
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').password = 'YOUR_PASSWORD'; |
||||
|
||||
final api_instance = DefaultApi(); |
||||
final category = category_example; // String | |
||||
final title = title_example; // String | |
||||
final content = content_example; // String | |
||||
final modified = 56; // int | |
||||
final favorite = true; // bool | |
||||
|
||||
try { |
||||
final result = api_instance.createNote(category, title, content, modified, favorite); |
||||
print(result); |
||||
} catch (e) { |
||||
print('Exception when calling DefaultApi->createNote: $e\n'); |
||||
} |
||||
``` |
||||
|
||||
### Parameters |
||||
|
||||
Name | Type | Description | Notes |
||||
------------- | ------------- | ------------- | ------------- |
||||
**category** | **String**| | [optional] [default to ''] |
||||
**title** | **String**| | [optional] [default to ''] |
||||
**content** | **String**| | [optional] [default to ''] |
||||
**modified** | **int**| | [optional] [default to 0] |
||||
**favorite** | **bool**| | [optional] [default to false] |
||||
|
||||
### Return type |
||||
|
||||
[**NotesNote**](NotesNote.md) |
||||
|
||||
### Authorization |
||||
|
||||
[basic_auth](../README.md#basic_auth) |
||||
|
||||
### HTTP request headers |
||||
|
||||
- **Content-Type**: Not defined |
||||
- **Accept**: application/json |
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) |
||||
|
||||
# **deleteNote** |
||||
> String deleteNote(id) |
||||
|
||||
|
||||
|
||||
### Example |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
// TODO Configure HTTP basic authorization: basic_auth |
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').username = 'YOUR_USERNAME' |
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').password = 'YOUR_PASSWORD'; |
||||
|
||||
final api_instance = DefaultApi(); |
||||
final id = 56; // int | |
||||
|
||||
try { |
||||
final result = api_instance.deleteNote(id); |
||||
print(result); |
||||
} catch (e) { |
||||
print('Exception when calling DefaultApi->deleteNote: $e\n'); |
||||
} |
||||
``` |
||||
|
||||
### Parameters |
||||
|
||||
Name | Type | Description | Notes |
||||
------------- | ------------- | ------------- | ------------- |
||||
**id** | **int**| | |
||||
|
||||
### Return type |
||||
|
||||
**String** |
||||
|
||||
### Authorization |
||||
|
||||
[basic_auth](../README.md#basic_auth) |
||||
|
||||
### HTTP request headers |
||||
|
||||
- **Content-Type**: Not defined |
||||
- **Accept**: application/json |
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) |
||||
|
||||
# **getNote** |
||||
> NotesNote getNote(id, exclude, ifNoneMatch) |
||||
|
||||
|
||||
|
||||
### Example |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
// TODO Configure HTTP basic authorization: basic_auth |
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').username = 'YOUR_USERNAME' |
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').password = 'YOUR_PASSWORD'; |
||||
|
||||
final api_instance = DefaultApi(); |
||||
final id = 56; // int | |
||||
final exclude = exclude_example; // String | |
||||
final ifNoneMatch = ifNoneMatch_example; // String | |
||||
|
||||
try { |
||||
final result = api_instance.getNote(id, exclude, ifNoneMatch); |
||||
print(result); |
||||
} catch (e) { |
||||
print('Exception when calling DefaultApi->getNote: $e\n'); |
||||
} |
||||
``` |
||||
|
||||
### Parameters |
||||
|
||||
Name | Type | Description | Notes |
||||
------------- | ------------- | ------------- | ------------- |
||||
**id** | **int**| | |
||||
**exclude** | **String**| | [optional] [default to ''] |
||||
**ifNoneMatch** | **String**| | [optional] |
||||
|
||||
### Return type |
||||
|
||||
[**NotesNote**](NotesNote.md) |
||||
|
||||
### Authorization |
||||
|
||||
[basic_auth](../README.md#basic_auth) |
||||
|
||||
### HTTP request headers |
||||
|
||||
- **Content-Type**: Not defined |
||||
- **Accept**: application/json |
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) |
||||
|
||||
# **getNotes** |
||||
> List<NotesNote> getNotes(category, exclude, pruneBefore, chunkSize, chunkCursor, ifNoneMatch) |
||||
|
||||
|
||||
|
||||
### Example |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
// TODO Configure HTTP basic authorization: basic_auth |
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').username = 'YOUR_USERNAME' |
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').password = 'YOUR_PASSWORD'; |
||||
|
||||
final api_instance = DefaultApi(); |
||||
final category = category_example; // String | |
||||
final exclude = exclude_example; // String | |
||||
final pruneBefore = 56; // int | |
||||
final chunkSize = 56; // int | |
||||
final chunkCursor = chunkCursor_example; // String | |
||||
final ifNoneMatch = ifNoneMatch_example; // String | |
||||
|
||||
try { |
||||
final result = api_instance.getNotes(category, exclude, pruneBefore, chunkSize, chunkCursor, ifNoneMatch); |
||||
print(result); |
||||
} catch (e) { |
||||
print('Exception when calling DefaultApi->getNotes: $e\n'); |
||||
} |
||||
``` |
||||
|
||||
### Parameters |
||||
|
||||
Name | Type | Description | Notes |
||||
------------- | ------------- | ------------- | ------------- |
||||
**category** | **String**| | [optional] |
||||
**exclude** | **String**| | [optional] [default to ''] |
||||
**pruneBefore** | **int**| | [optional] [default to 0] |
||||
**chunkSize** | **int**| | [optional] [default to 0] |
||||
**chunkCursor** | **String**| | [optional] |
||||
**ifNoneMatch** | **String**| | [optional] |
||||
|
||||
### Return type |
||||
|
||||
[**List<NotesNote>**](NotesNote.md) |
||||
|
||||
### Authorization |
||||
|
||||
[basic_auth](../README.md#basic_auth) |
||||
|
||||
### HTTP request headers |
||||
|
||||
- **Content-Type**: Not defined |
||||
- **Accept**: application/json |
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) |
||||
|
||||
# **getSettings** |
||||
> NotesSettings getSettings() |
||||
|
||||
|
||||
|
||||
### Example |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
// TODO Configure HTTP basic authorization: basic_auth |
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').username = 'YOUR_USERNAME' |
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').password = 'YOUR_PASSWORD'; |
||||
|
||||
final api_instance = DefaultApi(); |
||||
|
||||
try { |
||||
final result = api_instance.getSettings(); |
||||
print(result); |
||||
} catch (e) { |
||||
print('Exception when calling DefaultApi->getSettings: $e\n'); |
||||
} |
||||
``` |
||||
|
||||
### Parameters |
||||
This endpoint does not need any parameter. |
||||
|
||||
### Return type |
||||
|
||||
[**NotesSettings**](NotesSettings.md) |
||||
|
||||
### Authorization |
||||
|
||||
[basic_auth](../README.md#basic_auth) |
||||
|
||||
### HTTP request headers |
||||
|
||||
- **Content-Type**: Not defined |
||||
- **Accept**: application/json |
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) |
||||
|
||||
# **updateNote** |
||||
> NotesNote updateNote(id, content, modified, title, category, favorite, ifMatch) |
||||
|
||||
|
||||
|
||||
### Example |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
// TODO Configure HTTP basic authorization: basic_auth |
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').username = 'YOUR_USERNAME' |
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').password = 'YOUR_PASSWORD'; |
||||
|
||||
final api_instance = DefaultApi(); |
||||
final id = 56; // int | |
||||
final content = content_example; // String | |
||||
final modified = 56; // int | |
||||
final title = title_example; // String | |
||||
final category = category_example; // String | |
||||
final favorite = true; // bool | |
||||
final ifMatch = ifMatch_example; // String | |
||||
|
||||
try { |
||||
final result = api_instance.updateNote(id, content, modified, title, category, favorite, ifMatch); |
||||
print(result); |
||||
} catch (e) { |
||||
print('Exception when calling DefaultApi->updateNote: $e\n'); |
||||
} |
||||
``` |
||||
|
||||
### Parameters |
||||
|
||||
Name | Type | Description | Notes |
||||
------------- | ------------- | ------------- | ------------- |
||||
**id** | **int**| | |
||||
**content** | **String**| | [optional] |
||||
**modified** | **int**| | [optional] |
||||
**title** | **String**| | [optional] |
||||
**category** | **String**| | [optional] |
||||
**favorite** | **bool**| | [optional] |
||||
**ifMatch** | **String**| | [optional] |
||||
|
||||
### Return type |
||||
|
||||
[**NotesNote**](NotesNote.md) |
||||
|
||||
### Authorization |
||||
|
||||
[basic_auth](../README.md#basic_auth) |
||||
|
||||
### HTTP request headers |
||||
|
||||
- **Content-Type**: Not defined |
||||
- **Accept**: application/json |
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) |
||||
|
||||
# **updateSettings** |
||||
> NotesSettings updateSettings(notesSettings) |
||||
|
||||
|
||||
|
||||
### Example |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
// TODO Configure HTTP basic authorization: basic_auth |
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').username = 'YOUR_USERNAME' |
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').password = 'YOUR_PASSWORD'; |
||||
|
||||
final api_instance = DefaultApi(); |
||||
final notesSettings = NotesSettings(); // NotesSettings | |
||||
|
||||
try { |
||||
final result = api_instance.updateSettings(notesSettings); |
||||
print(result); |
||||
} catch (e) { |
||||
print('Exception when calling DefaultApi->updateSettings: $e\n'); |
||||
} |
||||
``` |
||||
|
||||
### Parameters |
||||
|
||||
Name | Type | Description | Notes |
||||
------------- | ------------- | ------------- | ------------- |
||||
**notesSettings** | [**NotesSettings**](NotesSettings.md)| | |
||||
|
||||
### Return type |
||||
|
||||
[**NotesSettings**](NotesSettings.md) |
||||
|
||||
### Authorization |
||||
|
||||
[basic_auth](../README.md#basic_auth) |
||||
|
||||
### HTTP request headers |
||||
|
||||
- **Content-Type**: application/json |
||||
- **Accept**: application/json |
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) |
||||
|
@ -1,24 +0,0 @@
|
||||
# openapi.model.NotesNote |
||||
|
||||
## Load the model package |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
``` |
||||
|
||||
## Properties |
||||
Name | Type | Description | Notes |
||||
------------ | ------------- | ------------- | ------------- |
||||
**id** | **int** | | [optional] |
||||
**etag** | **String** | | [optional] |
||||
**readonly** | **bool** | | [optional] |
||||
**content** | **String** | | [optional] |
||||
**title** | **String** | | [optional] |
||||
**category** | **String** | | [optional] |
||||
**favorite** | **bool** | | [optional] |
||||
**modified** | **int** | | [optional] |
||||
**error** | **bool** | | [optional] |
||||
**errorType** | **String** | | [optional] |
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
||||
|
||||
|
@ -1,17 +0,0 @@
|
||||
# openapi.model.NotesSettings |
||||
|
||||
## Load the model package |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
``` |
||||
|
||||
## Properties |
||||
Name | Type | Description | Notes |
||||
------------ | ------------- | ------------- | ------------- |
||||
**notesPath** | **String** | | [optional] |
||||
**fileSuffix** | **String** | | [optional] |
||||
**noteMode** | **String** | | [optional] |
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
||||
|
||||
|
@ -1,324 +0,0 @@
|
||||
# openapi.api.DefaultApi |
||||
|
||||
## Load the API package |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
``` |
||||
|
||||
All URIs are relative to *https://localhost:8080/ocs/v1.php/apps/notifications* |
||||
|
||||
Method | HTTP request | Description |
||||
------------- | ------------- | ------------- |
||||
[**deleteAllNotifications**](DefaultApi.md#deleteallnotifications) | **DELETE** /api/v2/notifications | |
||||
[**deleteNotification**](DefaultApi.md#deletenotification) | **DELETE** /api/v2/notifications/{id} | |
||||
[**getNotification**](DefaultApi.md#getnotification) | **GET** /api/v2/notifications/{id} | |
||||
[**listNotifications**](DefaultApi.md#listnotifications) | **GET** /api/v2/notifications | |
||||
[**registerDevice**](DefaultApi.md#registerdevice) | **POST** /api/v2/push | |
||||
[**removeDevice**](DefaultApi.md#removedevice) | **DELETE** /api/v2/push | |
||||
[**sendAdminNotification**](DefaultApi.md#sendadminnotification) | **POST** /api/v2/admin_notifications/{userId} | |
||||
|
||||
|
||||
# **deleteAllNotifications** |
||||
> String deleteAllNotifications() |
||||
|
||||
|
||||
|
||||
### Example |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
// TODO Configure HTTP basic authorization: basic_auth |
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').username = 'YOUR_USERNAME' |
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').password = 'YOUR_PASSWORD'; |
||||
|
||||
final api_instance = DefaultApi(); |
||||
|
||||
try { |
||||
final result = api_instance.deleteAllNotifications(); |
||||
print(result); |
||||
} catch (e) { |
||||
print('Exception when calling DefaultApi->deleteAllNotifications: $e\n'); |
||||
} |
||||
``` |
||||
|
||||
### Parameters |
||||
This endpoint does not need any parameter. |
||||
|
||||
### Return type |
||||
|
||||
**String** |
||||
|
||||
### Authorization |
||||
|
||||
[basic_auth](../README.md#basic_auth) |
||||
|
||||
### HTTP request headers |
||||
|
||||
- **Content-Type**: Not defined |
||||
- **Accept**: application/json |
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) |
||||
|
||||
# **deleteNotification** |
||||
> NotificationsEmpty deleteNotification(id) |
||||
|
||||
|
||||
|
||||
### Example |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
// TODO Configure HTTP basic authorization: basic_auth |
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').username = 'YOUR_USERNAME' |
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').password = 'YOUR_PASSWORD'; |
||||
|
||||
final api_instance = DefaultApi(); |
||||
final id = 56; // int | |
||||
|
||||
try { |
||||
final result = api_instance.deleteNotification(id); |
||||
print(result); |
||||
} catch (e) { |
||||
print('Exception when calling DefaultApi->deleteNotification: $e\n'); |
||||
} |
||||
``` |
||||
|
||||
### Parameters |
||||
|
||||
Name | Type | Description | Notes |
||||
------------- | ------------- | ------------- | ------------- |
||||
**id** | **int**| | |
||||
|
||||
### Return type |
||||
|
||||
[**NotificationsEmpty**](NotificationsEmpty.md) |
||||
|
||||
### Authorization |
||||
|
||||
[basic_auth](../README.md#basic_auth) |
||||
|
||||
### HTTP request headers |
||||
|
||||
- **Content-Type**: Not defined |
||||
- **Accept**: application/json |
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) |
||||
|
||||
# **getNotification** |
||||
> NotificationsGetNotification getNotification(id) |
||||
|
||||
|
||||
|
||||
### Example |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
// TODO Configure HTTP basic authorization: basic_auth |
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').username = 'YOUR_USERNAME' |
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').password = 'YOUR_PASSWORD'; |
||||
|
||||
final api_instance = DefaultApi(); |
||||
final id = 56; // int | |
||||
|
||||
try { |
||||
final result = api_instance.getNotification(id); |
||||
print(result); |
||||
} catch (e) { |
||||
print('Exception when calling DefaultApi->getNotification: $e\n'); |
||||
} |
||||
``` |
||||
|
||||
### Parameters |
||||
|
||||
Name | Type | Description | Notes |
||||
------------- | ------------- | ------------- | ------------- |
||||
**id** | **int**| | |
||||
|
||||
### Return type |
||||
|
||||
[**NotificationsGetNotification**](NotificationsGetNotification.md) |
||||
|
||||
### Authorization |
||||
|
||||
[basic_auth](../README.md#basic_auth) |
||||
|
||||
### HTTP request headers |
||||
|
||||
- **Content-Type**: Not defined |
||||
- **Accept**: application/json |
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) |
||||
|
||||
# **listNotifications** |
||||
> NotificationsListNotifications listNotifications() |
||||
|
||||
|
||||
|
||||
### Example |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
// TODO Configure HTTP basic authorization: basic_auth |
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').username = 'YOUR_USERNAME' |
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').password = 'YOUR_PASSWORD'; |
||||
|
||||
final api_instance = DefaultApi(); |
||||
|
||||
try { |
||||
final result = api_instance.listNotifications(); |
||||
print(result); |
||||
} catch (e) { |
||||
print('Exception when calling DefaultApi->listNotifications: $e\n'); |
||||
} |
||||
``` |
||||
|
||||
### Parameters |
||||
This endpoint does not need any parameter. |
||||
|
||||
### Return type |
||||
|
||||
[**NotificationsListNotifications**](NotificationsListNotifications.md) |
||||
|
||||
### Authorization |
||||
|
||||
[basic_auth](../README.md#basic_auth) |
||||
|
||||
### HTTP request headers |
||||
|
||||
- **Content-Type**: Not defined |
||||
- **Accept**: application/json |
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) |
||||
|
||||
# **registerDevice** |
||||
> NotificationsPushServerRegistration registerDevice(pushTokenHash, devicePublicKey, proxyServer) |
||||
|
||||
|
||||
|
||||
### Example |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
// TODO Configure HTTP basic authorization: basic_auth |
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').username = 'YOUR_USERNAME' |
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').password = 'YOUR_PASSWORD'; |
||||
|
||||
final api_instance = DefaultApi(); |
||||
final pushTokenHash = pushTokenHash_example; // String | |
||||
final devicePublicKey = devicePublicKey_example; // String | |
||||
final proxyServer = proxyServer_example; // String | |
||||
|
||||
try { |
||||
final result = api_instance.registerDevice(pushTokenHash, devicePublicKey, proxyServer); |
||||
print(result); |
||||
} catch (e) { |
||||
print('Exception when calling DefaultApi->registerDevice: $e\n'); |
||||
} |
||||
``` |
||||
|
||||
### Parameters |
||||
|
||||
Name | Type | Description | Notes |
||||
------------- | ------------- | ------------- | ------------- |
||||
**pushTokenHash** | **String**| | |
||||
**devicePublicKey** | **String**| | |
||||
**proxyServer** | **String**| | |
||||
|
||||
### Return type |
||||
|
||||
[**NotificationsPushServerRegistration**](NotificationsPushServerRegistration.md) |
||||
|
||||
### Authorization |
||||
|
||||
[basic_auth](../README.md#basic_auth) |
||||
|
||||
### HTTP request headers |
||||
|
||||
- **Content-Type**: Not defined |
||||
- **Accept**: application/json |
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) |
||||
|
||||
# **removeDevice** |
||||
> String removeDevice() |
||||
|
||||
|
||||
|
||||
### Example |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
// TODO Configure HTTP basic authorization: basic_auth |
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').username = 'YOUR_USERNAME' |
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').password = 'YOUR_PASSWORD'; |
||||
|
||||
final api_instance = DefaultApi(); |
||||
|
||||
try { |
||||
final result = api_instance.removeDevice(); |
||||
print(result); |
||||
} catch (e) { |
||||
print('Exception when calling DefaultApi->removeDevice: $e\n'); |
||||
} |
||||
``` |
||||
|
||||
### Parameters |
||||
This endpoint does not need any parameter. |
||||
|
||||
### Return type |
||||
|
||||
**String** |
||||
|
||||
### Authorization |
||||
|
||||
[basic_auth](../README.md#basic_auth) |
||||
|
||||
### HTTP request headers |
||||
|
||||
- **Content-Type**: Not defined |
||||
- **Accept**: application/json |
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) |
||||
|
||||
# **sendAdminNotification** |
||||
> NotificationsEmpty sendAdminNotification(userId, shortMessage, longMessage) |
||||
|
||||
|
||||
|
||||
### Example |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
// TODO Configure HTTP basic authorization: basic_auth |
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').username = 'YOUR_USERNAME' |
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').password = 'YOUR_PASSWORD'; |
||||
|
||||
final api_instance = DefaultApi(); |
||||
final userId = userId_example; // String | |
||||
final shortMessage = shortMessage_example; // String | |
||||
final longMessage = longMessage_example; // String | |
||||
|
||||
try { |
||||
final result = api_instance.sendAdminNotification(userId, shortMessage, longMessage); |
||||
print(result); |
||||
} catch (e) { |
||||
print('Exception when calling DefaultApi->sendAdminNotification: $e\n'); |
||||
} |
||||
``` |
||||
|
||||
### Parameters |
||||
|
||||
Name | Type | Description | Notes |
||||
------------- | ------------- | ------------- | ------------- |
||||
**userId** | **String**| | |
||||
**shortMessage** | **String**| | |
||||
**longMessage** | **String**| | [optional] [default to ''] |
||||
|
||||
### Return type |
||||
|
||||
[**NotificationsEmpty**](NotificationsEmpty.md) |
||||
|
||||
### Authorization |
||||
|
||||
[basic_auth](../README.md#basic_auth) |
||||
|
||||
### HTTP request headers |
||||
|
||||
- **Content-Type**: Not defined |
||||
- **Accept**: application/json |
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) |
||||
|
@ -1,15 +0,0 @@
|
||||
# openapi.model.NotificationsEmpty |
||||
|
||||
## Load the model package |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
``` |
||||
|
||||
## Properties |
||||
Name | Type | Description | Notes |
||||
------------ | ------------- | ------------- | ------------- |
||||
**ocs** | [**NotificationsEmptyOcs**](NotificationsEmptyOcs.md) | | [optional] |
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
||||
|
||||
|
@ -1,16 +0,0 @@
|
||||
# openapi.model.NotificationsEmptyOcs |
||||
|
||||
## Load the model package |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
``` |
||||
|
||||
## Properties |
||||
Name | Type | Description | Notes |
||||
------------ | ------------- | ------------- | ------------- |
||||
**meta** | [**Object**](.md) | Stub | [optional] |
||||
**data** | **List<String>** | | [optional] [default to const []] |
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
||||
|
||||
|
@ -1,15 +0,0 @@
|
||||
# openapi.model.NotificationsGetNotification |
||||
|
||||
## Load the model package |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
``` |
||||
|
||||
## Properties |
||||
Name | Type | Description | Notes |
||||
------------ | ------------- | ------------- | ------------- |
||||
**ocs** | [**NotificationsGetNotificationOcs**](NotificationsGetNotificationOcs.md) | | [optional] |
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
||||
|
||||
|
@ -1,16 +0,0 @@
|
||||
# openapi.model.NotificationsGetNotificationOcs |
||||
|
||||
## Load the model package |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
``` |
||||
|
||||
## Properties |
||||
Name | Type | Description | Notes |
||||
------------ | ------------- | ------------- | ------------- |
||||
**meta** | [**Object**](.md) | Stub | [optional] |
||||
**data** | [**NotificationsNotification**](NotificationsNotification.md) | | [optional] |
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
||||
|
||||
|
@ -1,15 +0,0 @@
|
||||
# openapi.model.NotificationsListNotifications |
||||
|
||||
## Load the model package |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
``` |
||||
|
||||
## Properties |
||||
Name | Type | Description | Notes |
||||
------------ | ------------- | ------------- | ------------- |
||||
**ocs** | [**NotificationsListNotificationsOcs**](NotificationsListNotificationsOcs.md) | | [optional] |
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
||||
|
||||
|
@ -1,16 +0,0 @@
|
||||
# openapi.model.NotificationsListNotificationsOcs |
||||
|
||||
## Load the model package |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
``` |
||||
|
||||
## Properties |
||||
Name | Type | Description | Notes |
||||
------------ | ------------- | ------------- | ------------- |
||||
**meta** | [**Object**](.md) | Stub | [optional] |
||||
**data** | [**List<NotificationsNotification>**](NotificationsNotification.md) | | [optional] [default to const []] |
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
||||
|
||||
|
@ -1,29 +0,0 @@
|
||||
# openapi.model.NotificationsNotification |
||||
|
||||
## Load the model package |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
``` |
||||
|
||||
## Properties |
||||
Name | Type | Description | Notes |
||||
------------ | ------------- | ------------- | ------------- |
||||
**notificationId** | **int** | | [optional] |
||||
**app** | **String** | | [optional] |
||||
**user** | **String** | | [optional] |
||||
**datetime** | **String** | | [optional] |
||||
**objectType** | **String** | | [optional] |
||||
**objectId** | **String** | | [optional] |
||||
**subject** | **String** | | [optional] |
||||
**message** | **String** | | [optional] |
||||
**link** | **String** | | [optional] |
||||
**subjectRich** | **String** | | [optional] |
||||
**subjectRichParameters** | **List<String>** | | [optional] [default to const []] |
||||
**messageRich** | **String** | | [optional] |
||||
**messageRichParameters** | **List<String>** | | [optional] [default to const []] |
||||
**icon** | **String** | | [optional] |
||||
**actions** | [**List<NotificationsNotificationAction>**](NotificationsNotificationAction.md) | | [optional] [default to const []] |
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
||||
|
||||
|
@ -1,18 +0,0 @@
|
||||
# openapi.model.NotificationsNotificationAction |
||||
|
||||
## Load the model package |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
``` |
||||
|
||||
## Properties |
||||
Name | Type | Description | Notes |
||||
------------ | ------------- | ------------- | ------------- |
||||
**label** | **String** | | [optional] |
||||
**link** | **String** | | [optional] |
||||
**type** | **String** | | [optional] |
||||
**primary** | **bool** | | [optional] |
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
||||
|
||||
|
@ -1,21 +0,0 @@
|
||||
# openapi.model.NotificationsPushNotificationDecryptedSubject |
||||
|
||||
## Load the model package |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
``` |
||||
|
||||
## Properties |
||||
Name | Type | Description | Notes |
||||
------------ | ------------- | ------------- | ------------- |
||||
**nid** | **int** | | [optional] |
||||
**app** | **String** | | [optional] |
||||
**subject** | **String** | | [optional] |
||||
**type** | **String** | | [optional] |
||||
**id** | **String** | | [optional] |
||||
**delete** | **bool** | | [optional] |
||||
**deleteAll** | **bool** | | [optional] |
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
||||
|
||||
|
@ -1,15 +0,0 @@
|
||||
# openapi.model.NotificationsPushServerRegistration |
||||
|
||||
## Load the model package |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
``` |
||||
|
||||
## Properties |
||||
Name | Type | Description | Notes |
||||
------------ | ------------- | ------------- | ------------- |
||||
**ocs** | [**NotificationsPushServerRegistrationOcs**](NotificationsPushServerRegistrationOcs.md) | | [optional] |
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
||||
|
||||
|
@ -1,16 +0,0 @@
|
||||
# openapi.model.NotificationsPushServerRegistrationOcs |
||||
|
||||
## Load the model package |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
``` |
||||
|
||||
## Properties |
||||
Name | Type | Description | Notes |
||||
------------ | ------------- | ------------- | ------------- |
||||
**meta** | [**Object**](.md) | Stub | [optional] |
||||
**data** | [**NotificationsPushServerSubscription**](NotificationsPushServerSubscription.md) | | [optional] |
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
||||
|
||||
|
@ -1,17 +0,0 @@
|
||||
# openapi.model.NotificationsPushServerSubscription |
||||
|
||||
## Load the model package |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
``` |
||||
|
||||
## Properties |
||||
Name | Type | Description | Notes |
||||
------------ | ------------- | ------------- | ------------- |
||||
**publicKey** | **String** | | [optional] |
||||
**deviceIdentifier** | **String** | | [optional] |
||||
**signature** | **String** | | [optional] |
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
||||
|
||||
|
@ -1,99 +0,0 @@
|
||||
# openapi.api.DefaultApi |
||||
|
||||
## Load the API package |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
``` |
||||
|
||||
All URIs are relative to *https://localhost:8080/ocs/v1.php/cloud* |
||||
|
||||
Method | HTTP request | Description |
||||
------------- | ------------- | ------------- |
||||
[**getCurrentUser**](DefaultApi.md#getcurrentuser) | **GET** /user | |
||||
[**getUser**](DefaultApi.md#getuser) | **GET** /users/{userId} | |
||||
|
||||
|
||||
# **getCurrentUser** |
||||
> ProvisioningApiUser getCurrentUser() |
||||
|
||||
|
||||
|
||||
### Example |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
// TODO Configure HTTP basic authorization: basic_auth |
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').username = 'YOUR_USERNAME' |
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').password = 'YOUR_PASSWORD'; |
||||
|
||||
final api_instance = DefaultApi(); |
||||
|
||||
try { |
||||
final result = api_instance.getCurrentUser(); |
||||
print(result); |
||||
} catch (e) { |
||||
print('Exception when calling DefaultApi->getCurrentUser: $e\n'); |
||||
} |
||||
``` |
||||
|
||||
### Parameters |
||||
This endpoint does not need any parameter. |
||||
|
||||
### Return type |
||||
|
||||
[**ProvisioningApiUser**](ProvisioningApiUser.md) |
||||
|
||||
### Authorization |
||||
|
||||
[basic_auth](../README.md#basic_auth) |
||||
|
||||
### HTTP request headers |
||||
|
||||
- **Content-Type**: Not defined |
||||
- **Accept**: application/json |
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) |
||||
|
||||
# **getUser** |
||||
> ProvisioningApiUser getUser(userId) |
||||
|
||||
|
||||
|
||||
### Example |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
// TODO Configure HTTP basic authorization: basic_auth |
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').username = 'YOUR_USERNAME' |
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').password = 'YOUR_PASSWORD'; |
||||
|
||||
final api_instance = DefaultApi(); |
||||
final userId = userId_example; // String | |
||||
|
||||
try { |
||||
final result = api_instance.getUser(userId); |
||||
print(result); |
||||
} catch (e) { |
||||
print('Exception when calling DefaultApi->getUser: $e\n'); |
||||
} |
||||
``` |
||||
|
||||
### Parameters |
||||
|
||||
Name | Type | Description | Notes |
||||
------------- | ------------- | ------------- | ------------- |
||||
**userId** | **String**| | |
||||
|
||||
### Return type |
||||
|
||||
[**ProvisioningApiUser**](ProvisioningApiUser.md) |
||||
|
||||
### Authorization |
||||
|
||||
[basic_auth](../README.md#basic_auth) |
||||
|
||||
### HTTP request headers |
||||
|
||||
- **Content-Type**: Not defined |
||||
- **Accept**: application/json |
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) |
||||
|
@ -1,15 +0,0 @@
|
||||
# openapi.model.ProvisioningApiUser |
||||
|
||||
## Load the model package |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
``` |
||||
|
||||
## Properties |
||||
Name | Type | Description | Notes |
||||
------------ | ------------- | ------------- | ------------- |
||||
**ocs** | [**ProvisioningApiUserOcs**](ProvisioningApiUserOcs.md) | | [optional] |
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
||||
|
||||
|
@ -1,51 +0,0 @@
|
||||
# openapi.model.ProvisioningApiUserDetails |
||||
|
||||
## Load the model package |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
``` |
||||
|
||||
## Properties |
||||
Name | Type | Description | Notes |
||||
------------ | ------------- | ------------- | ------------- |
||||
**storageLocation** | **String** | | [optional] |
||||
**id** | **String** | | [optional] |
||||
**lastLogin** | **int** | | [optional] |
||||
**backend** | **String** | | [optional] |
||||
**subadmin** | **List<String>** | | [optional] [default to const []] |
||||
**quota** | [**ProvisioningApiUserDetailsQuota**](ProvisioningApiUserDetailsQuota.md) | | [optional] |
||||
**avatarScope** | **String** | | [optional] |
||||
**email** | **String** | | [optional] |
||||
**emailScope** | **String** | | [optional] |
||||
**additionalMail** | **List<String>** | | [optional] [default to const []] |
||||
**additionalMailScope** | **List<String>** | | [optional] [default to const []] |
||||
**displayname** | **String** | | [optional] |
||||
**displaynameScope** | **String** | | [optional] |
||||
**phone** | **String** | | [optional] |
||||
**phoneScope** | **String** | | [optional] |
||||
**address** | **String** | | [optional] |
||||
**addressScope** | **String** | | [optional] |
||||
**website** | **String** | | [optional] |
||||
**websiteScope** | **String** | | [optional] |
||||
**twitter** | **String** | | [optional] |
||||
**twitterScope** | **String** | | [optional] |
||||
**organisation** | **String** | | [optional] |
||||
**organisationScope** | **String** | | [optional] |
||||
**role** | **String** | | [optional] |
||||
**roleScope** | **String** | | [optional] |
||||
**headline** | **String** | | [optional] |
||||
**headlineScope** | **String** | | [optional] |
||||
**biography** | **String** | | [optional] |
||||
**biographyScope** | **String** | | [optional] |
||||
**profileEnabled** | **String** | | [optional] |
||||
**profileEnabledScope** | **String** | | [optional] |
||||
**groups** | **List<String>** | | [optional] [default to const []] |
||||
**language** | **String** | | [optional] |
||||
**locale** | **String** | | [optional] |
||||
**notifyEmail** | **String** | | [optional] |
||||
**backendCapabilities** | [**ProvisioningApiUserDetailsBackendCapabilities**](ProvisioningApiUserDetailsBackendCapabilities.md) | | [optional] |
||||
**displayName** | **String** | | [optional] |
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
||||
|
||||
|
@ -1,16 +0,0 @@
|
||||
# openapi.model.ProvisioningApiUserDetailsBackendCapabilities |
||||
|
||||
## Load the model package |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
``` |
||||
|
||||
## Properties |
||||
Name | Type | Description | Notes |
||||
------------ | ------------- | ------------- | ------------- |
||||
**setDisplayName** | **bool** | | [optional] |
||||
**setPassword** | **bool** | | [optional] |
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
||||
|
||||
|
@ -1,19 +0,0 @@
|
||||
# openapi.model.ProvisioningApiUserDetailsQuota |
||||
|
||||
## Load the model package |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
``` |
||||
|
||||
## Properties |
||||
Name | Type | Description | Notes |
||||
------------ | ------------- | ------------- | ------------- |
||||
**free** | **int** | | [optional] |
||||
**used** | **int** | | [optional] |
||||
**total** | **int** | | [optional] |
||||
**relative** | **num** | | [optional] |
||||
**quota** | **int** | | [optional] |
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
||||
|
||||
|
@ -1,16 +0,0 @@
|
||||
# openapi.model.ProvisioningApiUserOcs |
||||
|
||||
## Load the model package |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
``` |
||||
|
||||
## Properties |
||||
Name | Type | Description | Notes |
||||
------------ | ------------- | ------------- | ------------- |
||||
**meta** | [**Object**](.md) | Stub | [optional] |
||||
**data** | [**ProvisioningApiUserDetails**](ProvisioningApiUserDetails.md) | | [optional] |
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
||||
|
||||
|
@ -1,406 +0,0 @@
|
||||
# openapi.api.DefaultApi |
||||
|
||||
## Load the API package |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
``` |
||||
|
||||
All URIs are relative to *https://localhost:8080/ocs/v1.php/apps/user_status* |
||||
|
||||
Method | HTTP request | Description |
||||
------------- | ------------- | ------------- |
||||
[**clearMessage**](DefaultApi.md#clearmessage) | **DELETE** /api/v1/user_status/message | |
||||
[**findAllPredefinedStatuses**](DefaultApi.md#findallpredefinedstatuses) | **GET** /api/v1/predefined_statuses | |
||||
[**findAllStatuses**](DefaultApi.md#findallstatuses) | **GET** /api/v1/statuses | |
||||
[**findStatus**](DefaultApi.md#findstatus) | **GET** /api/v1/statuses/{userId} | |
||||
[**getStatus**](DefaultApi.md#getstatus) | **GET** /api/v1/user_status | |
||||
[**heartbeat**](DefaultApi.md#heartbeat) | **PUT** /api/v1/heartbeat | |
||||
[**setCustomMessage**](DefaultApi.md#setcustommessage) | **PUT** /api/v1/user_status/message/custom | |
||||
[**setPredefinedMessage**](DefaultApi.md#setpredefinedmessage) | **PUT** /api/v1/user_status/message/predefined | |
||||
[**setStatus**](DefaultApi.md#setstatus) | **PUT** /api/v1/user_status/status | |
||||
|
||||
|
||||
# **clearMessage** |
||||
> clearMessage() |
||||
|
||||
|
||||
|
||||
### Example |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
// TODO Configure HTTP basic authorization: basic_auth |
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').username = 'YOUR_USERNAME' |
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').password = 'YOUR_PASSWORD'; |
||||
|
||||
final api_instance = DefaultApi(); |
||||
|
||||
try { |
||||
api_instance.clearMessage(); |
||||
} catch (e) { |
||||
print('Exception when calling DefaultApi->clearMessage: $e\n'); |
||||
} |
||||
``` |
||||
|
||||
### Parameters |
||||
This endpoint does not need any parameter. |
||||
|
||||
### Return type |
||||
|
||||
void (empty response body) |
||||
|
||||
### Authorization |
||||
|
||||
[basic_auth](../README.md#basic_auth) |
||||
|
||||
### HTTP request headers |
||||
|
||||
- **Content-Type**: Not defined |
||||
- **Accept**: Not defined |
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) |
||||
|
||||
# **findAllPredefinedStatuses** |
||||
> UserStatusPredefinedStatuses findAllPredefinedStatuses() |
||||
|
||||
|
||||
|
||||
### Example |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
// TODO Configure HTTP basic authorization: basic_auth |
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').username = 'YOUR_USERNAME' |
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').password = 'YOUR_PASSWORD'; |
||||
|
||||
final api_instance = DefaultApi(); |
||||
|
||||
try { |
||||
final result = api_instance.findAllPredefinedStatuses(); |
||||
print(result); |
||||
} catch (e) { |
||||
print('Exception when calling DefaultApi->findAllPredefinedStatuses: $e\n'); |
||||
} |
||||
``` |
||||
|
||||
### Parameters |
||||
This endpoint does not need any parameter. |
||||
|
||||
### Return type |
||||
|
||||
[**UserStatusPredefinedStatuses**](UserStatusPredefinedStatuses.md) |
||||
|
||||
### Authorization |
||||
|
||||
[basic_auth](../README.md#basic_auth) |
||||
|
||||
### HTTP request headers |
||||
|
||||
- **Content-Type**: Not defined |
||||
- **Accept**: application/json |
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) |
||||
|
||||
# **findAllStatuses** |
||||
> UserStatusFindAllStatuses findAllStatuses() |
||||
|
||||
|
||||
|
||||
### Example |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
// TODO Configure HTTP basic authorization: basic_auth |
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').username = 'YOUR_USERNAME' |
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').password = 'YOUR_PASSWORD'; |
||||
|
||||
final api_instance = DefaultApi(); |
||||
|
||||
try { |
||||
final result = api_instance.findAllStatuses(); |
||||
print(result); |
||||
} catch (e) { |
||||
print('Exception when calling DefaultApi->findAllStatuses: $e\n'); |
||||
} |
||||
``` |
||||
|
||||
### Parameters |
||||
This endpoint does not need any parameter. |
||||
|
||||
### Return type |
||||
|
||||
[**UserStatusFindAllStatuses**](UserStatusFindAllStatuses.md) |
||||
|
||||
### Authorization |
||||
|
||||
[basic_auth](../README.md#basic_auth) |
||||
|
||||
### HTTP request headers |
||||
|
||||
- **Content-Type**: Not defined |
||||
- **Accept**: application/json |
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) |
||||
|
||||
# **findStatus** |
||||
> UserStatusFindStatus findStatus(userId) |
||||
|
||||
|
||||
|
||||
### Example |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
// TODO Configure HTTP basic authorization: basic_auth |
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').username = 'YOUR_USERNAME' |
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').password = 'YOUR_PASSWORD'; |
||||
|
||||
final api_instance = DefaultApi(); |
||||
final userId = userId_example; // String | |
||||
|
||||
try { |
||||
final result = api_instance.findStatus(userId); |
||||
print(result); |
||||
} catch (e) { |
||||
print('Exception when calling DefaultApi->findStatus: $e\n'); |
||||
} |
||||
``` |
||||
|
||||
### Parameters |
||||
|
||||
Name | Type | Description | Notes |
||||
------------- | ------------- | ------------- | ------------- |
||||
**userId** | **String**| | |
||||
|
||||
### Return type |
||||
|
||||
[**UserStatusFindStatus**](UserStatusFindStatus.md) |
||||
|
||||
### Authorization |
||||
|
||||
[basic_auth](../README.md#basic_auth) |
||||
|
||||
### HTTP request headers |
||||
|
||||
- **Content-Type**: Not defined |
||||
- **Accept**: application/json |
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) |
||||
|
||||
# **getStatus** |
||||
> UserStatusGetUserStatus getStatus() |
||||
|
||||
|
||||
|
||||
### Example |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
// TODO Configure HTTP basic authorization: basic_auth |
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').username = 'YOUR_USERNAME' |
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').password = 'YOUR_PASSWORD'; |
||||
|
||||
final api_instance = DefaultApi(); |
||||
|
||||
try { |
||||
final result = api_instance.getStatus(); |
||||
print(result); |
||||
} catch (e) { |
||||
print('Exception when calling DefaultApi->getStatus: $e\n'); |
||||
} |
||||
``` |
||||
|
||||
### Parameters |
||||
This endpoint does not need any parameter. |
||||
|
||||
### Return type |
||||
|
||||
[**UserStatusGetUserStatus**](UserStatusGetUserStatus.md) |
||||
|
||||
### Authorization |
||||
|
||||
[basic_auth](../README.md#basic_auth) |
||||
|
||||
### HTTP request headers |
||||
|
||||
- **Content-Type**: Not defined |
||||
- **Accept**: application/json |
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) |
||||
|
||||
# **heartbeat** |
||||
> heartbeat(status) |
||||
|
||||
|
||||
|
||||
### Example |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
// TODO Configure HTTP basic authorization: basic_auth |
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').username = 'YOUR_USERNAME' |
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').password = 'YOUR_PASSWORD'; |
||||
|
||||
final api_instance = DefaultApi(); |
||||
final status = ; // UserStatusTypeEnum | |
||||
|
||||
try { |
||||
api_instance.heartbeat(status); |
||||
} catch (e) { |
||||
print('Exception when calling DefaultApi->heartbeat: $e\n'); |
||||
} |
||||
``` |
||||
|
||||
### Parameters |
||||
|
||||
Name | Type | Description | Notes |
||||
------------- | ------------- | ------------- | ------------- |
||||
**status** | [**UserStatusTypeEnum**](.md)| | |
||||
|
||||
### Return type |
||||
|
||||
void (empty response body) |
||||
|
||||
### Authorization |
||||
|
||||
[basic_auth](../README.md#basic_auth) |
||||
|
||||
### HTTP request headers |
||||
|
||||
- **Content-Type**: Not defined |
||||
- **Accept**: Not defined |
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) |
||||
|
||||
# **setCustomMessage** |
||||
> UserStatusGetUserStatus setCustomMessage(statusIcon, message, clearAt) |
||||
|
||||
|
||||
|
||||
### Example |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
// TODO Configure HTTP basic authorization: basic_auth |
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').username = 'YOUR_USERNAME' |
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').password = 'YOUR_PASSWORD'; |
||||
|
||||
final api_instance = DefaultApi(); |
||||
final statusIcon = statusIcon_example; // String | |
||||
final message = message_example; // String | |
||||
final clearAt = 56; // int | |
||||
|
||||
try { |
||||
final result = api_instance.setCustomMessage(statusIcon, message, clearAt); |
||||
print(result); |
||||
} catch (e) { |
||||
print('Exception when calling DefaultApi->setCustomMessage: $e\n'); |
||||
} |
||||
``` |
||||
|
||||
### Parameters |
||||
|
||||
Name | Type | Description | Notes |
||||
------------- | ------------- | ------------- | ------------- |
||||
**statusIcon** | **String**| | [optional] |
||||
**message** | **String**| | [optional] |
||||
**clearAt** | **int**| | [optional] |
||||
|
||||
### Return type |
||||
|
||||
[**UserStatusGetUserStatus**](UserStatusGetUserStatus.md) |
||||
|
||||
### Authorization |
||||
|
||||
[basic_auth](../README.md#basic_auth) |
||||
|
||||
### HTTP request headers |
||||
|
||||
- **Content-Type**: Not defined |
||||
- **Accept**: application/json |
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) |
||||
|
||||
# **setPredefinedMessage** |
||||
> UserStatusGetUserStatus setPredefinedMessage(messageId, clearAt) |
||||
|
||||
|
||||
|
||||
### Example |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
// TODO Configure HTTP basic authorization: basic_auth |
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').username = 'YOUR_USERNAME' |
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').password = 'YOUR_PASSWORD'; |
||||
|
||||
final api_instance = DefaultApi(); |
||||
final messageId = messageId_example; // String | |
||||
final clearAt = 56; // int | |
||||
|
||||
try { |
||||
final result = api_instance.setPredefinedMessage(messageId, clearAt); |
||||
print(result); |
||||
} catch (e) { |
||||
print('Exception when calling DefaultApi->setPredefinedMessage: $e\n'); |
||||
} |
||||
``` |
||||
|
||||
### Parameters |
||||
|
||||
Name | Type | Description | Notes |
||||
------------- | ------------- | ------------- | ------------- |
||||
**messageId** | **String**| | |
||||
**clearAt** | **int**| | [optional] |
||||
|
||||
### Return type |
||||
|
||||
[**UserStatusGetUserStatus**](UserStatusGetUserStatus.md) |
||||
|
||||
### Authorization |
||||
|
||||
[basic_auth](../README.md#basic_auth) |
||||
|
||||
### HTTP request headers |
||||
|
||||
- **Content-Type**: Not defined |
||||
- **Accept**: application/json |
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) |
||||
|
||||
# **setStatus** |
||||
> UserStatusGetUserStatus setStatus(statusType) |
||||
|
||||
|
||||
|
||||
### Example |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
// TODO Configure HTTP basic authorization: basic_auth |
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').username = 'YOUR_USERNAME' |
||||
//defaultApiClient.getAuthentication<HttpBasicAuth>('basic_auth').password = 'YOUR_PASSWORD'; |
||||
|
||||
final api_instance = DefaultApi(); |
||||
final statusType = ; // UserStatusTypeEnum | |
||||
|
||||
try { |
||||
final result = api_instance.setStatus(statusType); |
||||
print(result); |
||||
} catch (e) { |
||||
print('Exception when calling DefaultApi->setStatus: $e\n'); |
||||
} |
||||
``` |
||||
|
||||
### Parameters |
||||
|
||||
Name | Type | Description | Notes |
||||
------------- | ------------- | ------------- | ------------- |
||||
**statusType** | [**UserStatusTypeEnum**](.md)| | |
||||
|
||||
### Return type |
||||
|
||||
[**UserStatusGetUserStatus**](UserStatusGetUserStatus.md) |
||||
|
||||
### Authorization |
||||
|
||||
[basic_auth](../README.md#basic_auth) |
||||
|
||||
### HTTP request headers |
||||
|
||||
- **Content-Type**: Not defined |
||||
- **Accept**: application/json |
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) |
||||
|
@ -1,22 +0,0 @@
|
||||
# openapi.model.UserStatus |
||||
|
||||
## Load the model package |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
``` |
||||
|
||||
## Properties |
||||
Name | Type | Description | Notes |
||||
------------ | ------------- | ------------- | ------------- |
||||
**userId** | **String** | | [optional] |
||||
**message** | **String** | | [optional] |
||||
**messageId** | **String** | | [optional] |
||||
**messageIsPredefined** | **bool** | | [optional] |
||||
**icon** | **String** | | [optional] |
||||
**clearAt** | [**Object**](.md) | | [optional] |
||||
**status** | [**UserStatusTypeEnum**](UserStatusTypeEnum.md) | | [optional] |
||||
**statusIsUserDefined** | **bool** | | [optional] |
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
||||
|
||||
|
@ -1,16 +0,0 @@
|
||||
# openapi.model.UserStatusClearAt |
||||
|
||||
## Load the model package |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
``` |
||||
|
||||
## Properties |
||||
Name | Type | Description | Notes |
||||
------------ | ------------- | ------------- | ------------- |
||||
**type** | **String** | | [optional] |
||||
**time** | **int** | | [optional] |
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
||||
|
||||
|
@ -1,15 +0,0 @@
|
||||
# openapi.model.UserStatusFindAllStatuses |
||||
|
||||
## Load the model package |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
``` |
||||
|
||||
## Properties |
||||
Name | Type | Description | Notes |
||||
------------ | ------------- | ------------- | ------------- |
||||
**ocs** | [**UserStatusFindAllStatusesOcs**](UserStatusFindAllStatusesOcs.md) | | [optional] |
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
||||
|
||||
|
@ -1,16 +0,0 @@
|
||||
# openapi.model.UserStatusFindAllStatusesOcs |
||||
|
||||
## Load the model package |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
``` |
||||
|
||||
## Properties |
||||
Name | Type | Description | Notes |
||||
------------ | ------------- | ------------- | ------------- |
||||
**meta** | [**Object**](.md) | Stub | [optional] |
||||
**data** | [**List<UserStatusPublicUserStatus>**](UserStatusPublicUserStatus.md) | | [optional] [default to const []] |
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
||||
|
||||
|
@ -1,15 +0,0 @@
|
||||
# openapi.model.UserStatusFindStatus |
||||
|
||||
## Load the model package |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
``` |
||||
|
||||
## Properties |
||||
Name | Type | Description | Notes |
||||
------------ | ------------- | ------------- | ------------- |
||||
**ocs** | [**UserStatusFindStatusOcs**](UserStatusFindStatusOcs.md) | | [optional] |
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
||||
|
||||
|
@ -1,16 +0,0 @@
|
||||
# openapi.model.UserStatusFindStatusOcs |
||||
|
||||
## Load the model package |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
``` |
||||
|
||||
## Properties |
||||
Name | Type | Description | Notes |
||||
------------ | ------------- | ------------- | ------------- |
||||
**meta** | [**Object**](.md) | Stub | [optional] |
||||
**data** | [**UserStatusPublicUserStatus**](UserStatusPublicUserStatus.md) | | [optional] |
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
||||
|
||||
|
@ -1,15 +0,0 @@
|
||||
# openapi.model.UserStatusGetUserStatus |
||||
|
||||
## Load the model package |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
``` |
||||
|
||||
## Properties |
||||
Name | Type | Description | Notes |
||||
------------ | ------------- | ------------- | ------------- |
||||
**ocs** | [**UserStatusGetUserStatusOcs**](UserStatusGetUserStatusOcs.md) | | [optional] |
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
||||
|
||||
|
@ -1,16 +0,0 @@
|
||||
# openapi.model.UserStatusGetUserStatusOcs |
||||
|
||||
## Load the model package |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
``` |
||||
|
||||
## Properties |
||||
Name | Type | Description | Notes |
||||
------------ | ------------- | ------------- | ------------- |
||||
**meta** | [**Object**](.md) | Stub | [optional] |
||||
**data** | [**UserStatus**](UserStatus.md) | | [optional] |
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
||||
|
||||
|
@ -1,18 +0,0 @@
|
||||
# openapi.model.UserStatusPredefinedStatus |
||||
|
||||
## Load the model package |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
``` |
||||
|
||||
## Properties |
||||
Name | Type | Description | Notes |
||||
------------ | ------------- | ------------- | ------------- |
||||
**id** | **String** | | [optional] |
||||
**icon** | **String** | | [optional] |
||||
**message** | **String** | | [optional] |
||||
**clearAt** | [**Object**](.md) | | [optional] |
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
||||
|
||||
|
@ -1,15 +0,0 @@
|
||||
# openapi.model.UserStatusPredefinedStatuses |
||||
|
||||
## Load the model package |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
``` |
||||
|
||||
## Properties |
||||
Name | Type | Description | Notes |
||||
------------ | ------------- | ------------- | ------------- |
||||
**ocs** | [**UserStatusPredefinedStatusesOcs**](UserStatusPredefinedStatusesOcs.md) | | [optional] |
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
||||
|
||||
|
@ -1,16 +0,0 @@
|
||||
# openapi.model.UserStatusPredefinedStatusesOcs |
||||
|
||||
## Load the model package |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
``` |
||||
|
||||
## Properties |
||||
Name | Type | Description | Notes |
||||
------------ | ------------- | ------------- | ------------- |
||||
**meta** | [**Object**](.md) | Stub | [optional] |
||||
**data** | [**List<UserStatusPredefinedStatus>**](UserStatusPredefinedStatus.md) | | [optional] [default to const []] |
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
||||
|
||||
|
@ -1,19 +0,0 @@
|
||||
# openapi.model.UserStatusPublicUserStatus |
||||
|
||||
## Load the model package |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
``` |
||||
|
||||
## Properties |
||||
Name | Type | Description | Notes |
||||
------------ | ------------- | ------------- | ------------- |
||||
**userId** | **String** | | [optional] |
||||
**message** | **String** | | [optional] |
||||
**icon** | **String** | | [optional] |
||||
**clearAt** | [**Object**](.md) | | [optional] |
||||
**status** | [**UserStatusTypeEnum**](UserStatusTypeEnum.md) | | [optional] |
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
||||
|
||||
|
@ -1,14 +0,0 @@
|
||||
# openapi.model.UserStatusTypeEnum |
||||
|
||||
## Load the model package |
||||
```dart |
||||
import 'package:openapi/api.dart'; |
||||
``` |
||||
|
||||
## Properties |
||||
Name | Type | Description | Notes |
||||
------------ | ------------- | ------------- | ------------- |
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
||||
|
||||
|
Loading…
Reference in new issue