diff --git a/DEVELOPING.md b/DEVELOPING.md
index ef738c054c..1d46c0a318 100644
--- a/DEVELOPING.md
+++ b/DEVELOPING.md
@@ -35,10 +35,11 @@ Our monorepo comes with few preconfigured
1. Open root folder of this repo in VS Code.
2. Install lerna globally `npm i -g lerna`
3. Run `lerna bootstrap`
-4. Create .env files for all the micro service packages.
-5. Run DB migrations using `lerna run db:migrate`.
-6. Build all microservices in one go - `lerna run build`.
-7. Run `lerna run start` to start all the micro services in one go.
+4. Run `npm i`
+5. Create .env files for all the micro service packages.
+6. Run DB migrations using `lerna run db:migrate`.
+7. Build all microservices in one go - `lerna run build`.
+8. Run `lerna run start` to start all the micro services in one go.
## Building the project
@@ -234,19 +235,7 @@ this.component(CoreComponent);
this.sequence(ServiceSequence);
```
-10. **Add Rakuten core** - Add rakuten-core as dependency to the module
-
- ```sh
- lerna add rakuten-core --scope={service name}
- ```
-
-In application.ts,
-
- ```ts
- this.component(RakutenCoreComponent);
- ```
-
-11. **Bearer Verifier** - Add bearer verifier to your service
+10. **Bearer Verifier** - Add bearer verifier to your service
```sh
lerna add loopback4-authentication --scope={service name}
@@ -288,7 +277,7 @@ Add below to application.ts
Use BearerVerifierType.facade for facades.
-12. **Setup project for test coverage** -
+11. **Setup project for test coverage** -
Create a file named .nycrc and copy this data in it
@@ -313,8 +302,8 @@ Use BearerVerifierType.facade for facades.
"coverage": "nyc npm run test",
```
-13. **Setup sequence** - Remove auto-generated sequence.ts and change to ServiceSequence in application.ts.
-14. **Fix api explorer** - Update base path in index.html for facades.
+12. **Setup sequence** - Remove auto-generated sequence.ts and change to ServiceSequence in application.ts.
+13. **Fix api explorer** - Update base path in index.html for facades.
```html
diff --git a/README.md b/README.md
index 55505d52d9..70d9b10c52 100644
--- a/README.md
+++ b/README.md
@@ -1,11 +1,11 @@
-# loopback4-microservice-catalog
+# Sourceloop
[-@2x.png)](http://loopback.io/)
[](https://lerna.js.org/)
[](http://commitizen.github.io/cz-cli/)
-The `loopback4-microservice-catalog` is a collection of pre-built microservices that aim to reduce time to market for Enterprise projects. Large enterprises usually face a similar set of challenges when developing cloud native platforms as part of digital transformation efforts or the creation of new products. The services are implemented as [LoopBack Extensions](https://loopback.io/doc/en/lb4/Extending-LoopBack-4.html), allowing you to install them into existing LoopBack applications or use the [LoopBack Command-line interface](https://loopback.io/doc/en/lb4/Command-line-interface.html) to generate standalone services. Our recommended approach is to deploy these services as standalone micro-services in Docker.
+The `Sourceloop` is a collection of pre-built microservices that aim to reduce time to market for Enterprise projects. Large enterprises usually face a similar set of challenges when developing cloud native platforms as part of digital transformation efforts or the creation of new products. The services are implemented as [LoopBack Extensions](https://loopback.io/doc/en/lb4/Extending-LoopBack-4.html), allowing you to install them into existing LoopBack applications or use the [LoopBack Command-line interface](https://loopback.io/doc/en/lb4/Command-line-interface.html) to generate standalone services. Our recommended approach is to deploy these services as standalone micro-services in Docker.
The current catalog consists of the following services:
@@ -28,7 +28,7 @@ This repository also contains a set of example projects in the [sandbox](sandbox
## Table of Contents
-- [loopback4-microservice-catalog](#loopback4-microservice-catalog)
+- [Sourceloop](#Sourceloop)
* [Table of Contents](#table-of-contents)
+ [Long Term Support](#long-term-support)
+ [Documentation](#documentation)
@@ -212,15 +212,15 @@ You can now run the example service with `npm start`.
### DataSources and Migrations
-The `loopback4-microservice-catalog` can support any Loopback 4 [DataSource](https://loopback.io/doc/en/lb4/DataSource.html). While you may see existing `DataSource`s and [Database Migrations](https://loopback.io/doc/en/lb4/Database-migrations.html#overview), it is not mandatory to use them.
+The `Sourceloop` can support any Loopback 4 [DataSource](https://loopback.io/doc/en/lb4/DataSource.html). While you may see existing `DataSource`s and [Database Migrations](https://loopback.io/doc/en/lb4/Database-migrations.html#overview), it is not mandatory to use them.
### Production Deployment
-Inside of the `sandbox` folder, you will find example applications and Dockerfiles for each application. The `loopback4-microservice-catalog` is agnostic of the Docker deployment strategy. Deploy the services into the platform of your choice.
+Inside of the `sandbox` folder, you will find example applications and Dockerfiles for each application. The `Sourceloop` is agnostic of the Docker deployment strategy. Deploy the services into the platform of your choice.
### Related Projects
-The `loopback4-microservice-catalog` utilizes many extensions created by SourceFuse.
+The `Sourceloop` utilizes many extensions created by SourceFuse.
* [sourcefuse/loopback4-ratelimiter: A rate limiting extension for loopback4 applications (github.com)](https://github.com/sourcefuse/loopback4-ratelimiter)
* [sourcefuse/loopback4-notifications: An extension for setting up various notification mechanisms in loopback4 application, vis-a-vis, Push notification, SMS notification, Email notification (github.com)](https://github.com/sourcefuse/loopback4-notifications)
@@ -234,7 +234,7 @@ The `loopback4-microservice-catalog` utilizes many extensions created by SourceF
### Feedback
-If you've noticed a bug or have a question or have a feature request, [search the issue tracker]([Issues · sourcefuse/loopback4-microservice-catalog · GitHub](https://github.com/sourcefuse/loopback4-microservice-catalog/issues)) to see if someone else in the community has already created a ticket. If not, go ahead and [make one](https://github.com/sourcefuse/loopback4-microservice-catalog/issues/new/choose)! All feature requests are welcome. Implementation time may vary. Feel free to contribute the same, if you can. If you think this extension is useful, please [star](https://help.github.com/en/articles/about-stars) it. Appreciation really helps in keeping this project alive.
+If you've noticed a bug or have a question or have a feature request, [search the issue tracker]([Issues · sourcefuse/loopback4-microservices-catalog · GitHub](https://github.com/sourcefuse/loopback4-microservice-catalog/issues)) to see if someone else in the community has already created a ticket. If not, go ahead and [make one](https://github.com/sourcefuse/loopback4-microservice-catalog/issues/new/choose)! All feature requests are welcome. Implementation time may vary. Feel free to contribute the same, if you can. If you think this extension is useful, please [star](https://help.github.com/en/articles/about-stars) it. Appreciation really helps in keeping this project alive.
### Contributing
diff --git a/sandbox/audit-ms-example/Dockerfile b/sandbox/audit-ms-example/Dockerfile
index bca90e201a..8c48fdb4a4 100644
--- a/sandbox/audit-ms-example/Dockerfile
+++ b/sandbox/audit-ms-example/Dockerfile
@@ -1,5 +1,5 @@
# Check out https://hub.docker.com/_/node to select a new base image
-FROM node:10-slim
+FROM node:14-slim
# Set to a non-root built-in user `node`
USER node
diff --git a/sandbox/audit-ms-example/README.md b/sandbox/audit-ms-example/README.md
index 29cbee5a13..3acf7d04ba 100644
--- a/sandbox/audit-ms-example/README.md
+++ b/sandbox/audit-ms-example/README.md
@@ -1,3 +1,7 @@
# auth-multitenant-example
[-@2x.png)](http://loopback.io/)
+
+#### API Details
+
+Visit the [OpenAPI spec docs](./openapi.md)
\ No newline at end of file
diff --git a/sandbox/audit-ms-example/openapi.md b/sandbox/audit-ms-example/openapi.md
new file mode 100644
index 0000000000..c11eb415a9
--- /dev/null
+++ b/sandbox/audit-ms-example/openapi.md
@@ -0,0 +1,1477 @@
+---
+title: Audit Service v1.0.0
+language_tabs:
+ - "'javascript": JavaScript
+ - "'javascript--nodejs": Node.JS'
+language_clients:
+ - "'javascript": request'
+ - "'javascript--nodejs": ""
+toc_footers: []
+includes: []
+search: false
+highlight_theme: darkula
+headingLevel: 2
+
+---
+
+
+
+Audit Service v1.0.0
+
+> Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
+
+An audit microservice example
+
+Base URLs:
+
+* http://localhost:3000
+
+# Authentication
+
+- HTTP Authentication, scheme: bearer
+
+AuditController
+
+## AuditController.count
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|where|query|object|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "count": 0
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|AuditLog model count|[loopback.Count](#schemaloopback.count)|
+
+
+To perform this operation, you must be authenticated by means of one of the following methods:
+HTTPBearer
+
+
+## AuditController.findById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|filter|query|[audit_logs.Filter](#schemaaudit_logs.filter)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "id": "string",
+ "action": "string",
+ "actedAt": "2019-08-24T14:15:22Z",
+ "actedOn": "string",
+ "actionKey": "string",
+ "entityId": "string",
+ "actor": "string",
+ "before": {},
+ "after": {},
+ "actionGroup": "string"
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|AuditLog model instance|[AuditLogWithRelations](#schemaauditlogwithrelations)|
+
+
+To perform this operation, you must be authenticated by means of one of the following methods:
+HTTPBearer
+
+
+## AuditController.create
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|body|body|[NewAuditLog](#schemanewauditlog)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "id": "string",
+ "action": "string",
+ "actedAt": "2019-08-24T14:15:22Z",
+ "actedOn": "string",
+ "actionKey": "string",
+ "entityId": "string",
+ "actor": "string",
+ "before": {},
+ "after": {},
+ "actionGroup": "string"
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|AuditLog model instance|[AuditLog](#schemaauditlog)|
+
+
+To perform this operation, you must be authenticated by means of one of the following methods:
+HTTPBearer
+
+
+## AuditController.find
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|filter|query|[audit_logs.Filter1](#schemaaudit_logs.filter1)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+[
+ {
+ "id": "string",
+ "action": "string",
+ "actedAt": "2019-08-24T14:15:22Z",
+ "actedOn": "string",
+ "actionKey": "string",
+ "entityId": "string",
+ "actor": "string",
+ "before": {},
+ "after": {},
+ "actionGroup": "string"
+ }
+]
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Array of AuditLog model instances|Inline|
+
+Response Schema
+
+Status Code **200**
+
+|Name|Type|Required|Restrictions|Description|
+|---|---|---|---|---|
+|*anonymous*|[[AuditLogWithRelations](#schemaauditlogwithrelations)]|false|none|[(tsType: AuditLogWithRelations, schemaOptions: { includeRelations: true })]|
+|» AuditLogWithRelations|[AuditLogWithRelations](#schemaauditlogwithrelations)|false|none|(tsType: AuditLogWithRelations, schemaOptions: { includeRelations: true })|
+|»» id|string|false|none|none|
+|»» action|string|true|none|none|
+|»» actedAt|string(date-time)|true|none|none|
+|»» actedOn|string|false|none|none|
+|»» actionKey|string|true|none|none|
+|»» entityId|string|true|none|none|
+|»» actor|string|true|none|none|
+|»» before|object|false|none|none|
+|»» after|object|false|none|none|
+|»» actionGroup|string|false|none|none|
+
+
+To perform this operation, you must be authenticated by means of one of the following methods:
+HTTPBearer
+
+
+ToDoController
+
+## ToDoController.count
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|where|query|object|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "count": 0
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|ToDo model count|[loopback.Count](#schemaloopback.count)|
+
+
+This operation does not require authentication
+
+
+## ToDoController.replaceById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|body|body|[ToDo](#schematodo)|false|none|
+
+> Example responses
+
+> 204 Response
+
+```json
+null
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|No Content|Inline|
+
+Response Schema
+
+Status Code **204**
+
+*ToDo PUT success*
+
+|Name|Type|Required|Restrictions|Description|
+|---|---|---|---|---|
+
+
+This operation does not require authentication
+
+
+## ToDoController.updateById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|body|body|[ToDoPartial](#schematodopartial)|false|none|
+
+> Example responses
+
+> 204 Response
+
+```json
+null
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|No Content|Inline|
+
+Response Schema
+
+Status Code **204**
+
+*ToDo PATCH success*
+
+|Name|Type|Required|Restrictions|Description|
+|---|---|---|---|---|
+
+
+This operation does not require authentication
+
+
+## ToDoController.findById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|filter|query|[ToDo.Filter](#schematodo.filter)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "id": "string",
+ "title": "string",
+ "description": "string",
+ "items": [
+ "string"
+ ]
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|ToDo model instance|[ToDoWithRelations](#schematodowithrelations)|
+
+
+This operation does not require authentication
+
+
+## ToDoController.deleteById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+
+> Example responses
+
+> 204 Response
+
+```json
+null
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|No Content|Inline|
+
+Response Schema
+
+Status Code **204**
+
+*ToDo DELETE success*
+
+|Name|Type|Required|Restrictions|Description|
+|---|---|---|---|---|
+
+
+This operation does not require authentication
+
+
+## ToDoController.create
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|body|body|[NewToDo](#schemanewtodo)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "id": "string",
+ "title": "string",
+ "description": "string",
+ "items": [
+ "string"
+ ]
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|ToDo model instance|[ToDo](#schematodo)|
+
+
+This operation does not require authentication
+
+
+## ToDoController.updateAll
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|where|query|object|false|none|
+|body|body|[ToDoPartial](#schematodopartial)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "count": 0
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|ToDo PATCH success count|[loopback.Count](#schemaloopback.count)|
+
+
+This operation does not require authentication
+
+
+## ToDoController.find
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|filter|query|[ToDo.Filter1](#schematodo.filter1)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+[
+ {
+ "id": "string",
+ "title": "string",
+ "description": "string",
+ "items": [
+ "string"
+ ]
+ }
+]
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Array of ToDo model instances|Inline|
+
+Response Schema
+
+Status Code **200**
+
+|Name|Type|Required|Restrictions|Description|
+|---|---|---|---|---|
+|*anonymous*|[[ToDoWithRelations](#schematodowithrelations)]|false|none|[(tsType: ToDoWithRelations, schemaOptions: { includeRelations: true })]|
+|» ToDoWithRelations|[ToDoWithRelations](#schematodowithrelations)|false|none|(tsType: ToDoWithRelations, schemaOptions: { includeRelations: true })|
+|»» id|string|false|none|none|
+|»» title|string|true|none|none|
+|»» description|string|true|none|none|
+|»» items|[string]|false|none|none|
+
+
+This operation does not require authentication
+
+
+# Schemas
+
+AuditLog
+
+NewAuditLog
+
+AuditLogWithRelations
+
+ToDo
+
+NewToDo
+
+ToDoWithRelations
+
+ToDoPartial
+
+loopback.Count
+
+audit_logs.Filter
+
+audit_logs.Filter1
+
+ToDo.Filter
+
+ToDo.Filter1
+
+Authentication Service v1.0.0
+
+> Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
+
+Auth microservice basic example
+
+Base URLs:
+
+* http://localhost:3000
+
+# Authentication
+
+- HTTP Authentication, scheme: bearer
+
+LoginController
+
+## LoginController.resetPassword
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|Authorization|header|string|false|none|
+|body|body|[ResetPasswordPartial](#schemaresetpasswordpartial)|false|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|If User password successfully changed.|None|
+
+
+To perform this operation, you must be authenticated by means of one of the following methods:
+HTTPBearer
+
+
+## LoginController.postLoginViaGoogle
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|body|body|[ClientAuthRequest](#schemaclientauthrequest)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "accessToken": "string",
+ "refreshToken": "string",
+ "expires": 0,
+ "pubnubToken": "string"
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|POST Call for Google based login|[TokenResponse](#schematokenresponse)|
+
+
+This operation does not require authentication
+
+
+## LoginController.loginViaGoogle
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|client_id|query|string|false|none|
+|client_secret|query|string|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "accessToken": "string",
+ "refreshToken": "string",
+ "expires": 0,
+ "pubnubToken": "string"
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Google Token Response (Deprecated: Possible security issue if secret is passed via query params, please use the post endpoint)|[TokenResponse](#schematokenresponse)|
+
+
+This operation does not require authentication
+
+
+## LoginController.googleCallback
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|code|query|string|false|none|
+|state|query|string|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "accessToken": "string",
+ "refreshToken": "string",
+ "expires": 0,
+ "pubnubToken": "string"
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Google Redirect Token Response|[TokenResponse](#schematokenresponse)|
+
+
+This operation does not require authentication
+
+
+## LoginController.postLoginViaInstagram
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|body|body|[ClientAuthRequest](#schemaclientauthrequest)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "accessToken": "string",
+ "refreshToken": "string",
+ "expires": 0,
+ "pubnubToken": "string"
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|POST Call for Instagram based login|[TokenResponse](#schematokenresponse)|
+
+
+This operation does not require authentication
+
+
+## LoginController.instagramCallback
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|code|query|string|false|none|
+|state|query|string|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "accessToken": "string",
+ "refreshToken": "string",
+ "expires": 0,
+ "pubnubToken": "string"
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Instagram Redirect Token Response|[TokenResponse](#schematokenresponse)|
+
+
+This operation does not require authentication
+
+
+## LoginController.postLoginViaKeycloak
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|body|body|[ClientAuthRequest](#schemaclientauthrequest)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "accessToken": "string",
+ "refreshToken": "string",
+ "expires": 0,
+ "pubnubToken": "string"
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Keycloak Token Response|[TokenResponse](#schematokenresponse)|
+
+
+This operation does not require authentication
+
+
+## LoginController.loginViaKeycloak
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|client_id|query|string|false|none|
+|client_secret|query|string|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "accessToken": "string",
+ "refreshToken": "string",
+ "expires": 0,
+ "pubnubToken": "string"
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Keycloak Token Response (Deprecated: Possible security issue if secret is passed via query params, please use the post endpoint)|[TokenResponse](#schematokenresponse)|
+
+
+This operation does not require authentication
+
+
+## LoginController.keycloakCallback
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|code|query|string|false|none|
+|state|query|string|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "accessToken": "string",
+ "refreshToken": "string",
+ "expires": 0,
+ "pubnubToken": "string"
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Keycloak Redirect Token Response|[TokenResponse](#schematokenresponse)|
+
+
+This operation does not require authentication
+
+
+## LoginController.login
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|body|body|[LoginRequest](#schemaloginrequest)|false|none|
+
+> Example responses
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Auth Code|None|
+|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|The syntax of the request entity is incorrect.|None|
+|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Invalid Credentials.|None|
+|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|The entity requested does not exist.|None|
+|422|[Unprocessable Entity](https://tools.ietf.org/html/rfc2518#section-10.3)|The syntax of the request entity is incorrect|None|
+
+Response Schema
+
+
+This operation does not require authentication
+
+
+## LoginController.loginWithClientUser
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|device_id|header|string|false|none|
+|body|body|[LoginRequest](#schemaloginrequest)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "accessToken": "string",
+ "refreshToken": "string",
+ "expires": 0,
+ "pubnubToken": "string"
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Token Response Model|[TokenResponse](#schematokenresponse)|
+|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|The syntax of the request entity is incorrect.|None|
+|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Invalid Credentials.|None|
+|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|The entity requested does not exist.|None|
+|422|[Unprocessable Entity](https://tools.ietf.org/html/rfc2518#section-10.3)|The syntax of the request entity is incorrect|None|
+
+
+This operation does not require authentication
+
+
+## LoginController.me
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|User Object|None|
+|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|The syntax of the request entity is incorrect.|None|
+|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Invalid Credentials.|None|
+|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|The entity requested does not exist.|None|
+|422|[Unprocessable Entity](https://tools.ietf.org/html/rfc2518#section-10.3)|The syntax of the request entity is incorrect|None|
+
+Response Schema
+
+
+To perform this operation, you must be authenticated by means of one of the following methods:
+HTTPBearer
+
+
+## LoginController.getToken
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|device_id|header|string|false|none|
+|body|body|[AuthTokenRequest](#schemaauthtokenrequest)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "accessToken": "string",
+ "refreshToken": "string",
+ "expires": 0,
+ "pubnubToken": "string"
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Token Response|[TokenResponse](#schematokenresponse)|
+|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|The syntax of the request entity is incorrect.|None|
+|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Invalid Credentials.|None|
+|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|The entity requested does not exist.|None|
+|422|[Unprocessable Entity](https://tools.ietf.org/html/rfc2518#section-10.3)|The syntax of the request entity is incorrect|None|
+
+
+This operation does not require authentication
+
+
+## LoginController.exchangeToken
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|device_id|header|string|false|none|
+|body|body|[AuthRefreshTokenRequest](#schemaauthrefreshtokenrequest)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "accessToken": "string",
+ "refreshToken": "string",
+ "expires": 0,
+ "pubnubToken": "string"
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|New Token Response|[TokenResponse](#schematokenresponse)|
+|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|The syntax of the request entity is incorrect.|None|
+|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Invalid Credentials.|None|
+|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|The entity requested does not exist.|None|
+|422|[Unprocessable Entity](https://tools.ietf.org/html/rfc2518#section-10.3)|The syntax of the request entity is incorrect|None|
+
+
+This operation does not require authentication
+
+
+ForgetPasswordController
+
+## ForgetPasswordController.forgetPassword
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|body|body|[ForgetPasswordDto](#schemaforgetpassworddto)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "code": "string",
+ "expiry": 0,
+ "email": "string",
+ "user": {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "firstName": "string",
+ "lastName": "string",
+ "middleName": "string",
+ "username": "string",
+ "email": "string",
+ "phone": "string",
+ "authClientIds": "string",
+ "lastLogin": "2019-08-24T14:15:22Z",
+ "dob": "2019-08-24T14:15:22Z",
+ "gender": "M",
+ "defaultTenantId": "string"
+ }
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Success Response.|[ForgetPasswordResponseDto](#schemaforgetpasswordresponsedto)|
+|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|The syntax of the request entity is incorrect.|None|
+|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Invalid Credentials.|None|
+|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|The entity requested does not exist.|None|
+|422|[Unprocessable Entity](https://tools.ietf.org/html/rfc2518#section-10.3)|The syntax of the request entity is incorrect|None|
+
+
+This operation does not require authentication
+
+
+## ForgetPasswordController.resetPassword
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|body|body|[ResetPasswordWithClient](#schemaresetpasswordwithclient)|false|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|If User password successfully changed.|None|
+
+
+This operation does not require authentication
+
+
+## ForgetPasswordController.verifyResetPasswordLink
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|token|query|string|true|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Check if Token Is Valid and not Expired.|None|
+
+
+This operation does not require authentication
+
+
+SignupRequestController
+
+## SignupRequestController.requestSignup
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|body|body|[SignupRequestDto](#schemasignuprequestdto)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "code": "string",
+ "expiry": 0,
+ "email": "string"
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Sucess Response.|[SignupRequestResponseDto](#schemasignuprequestresponsedto)|
+|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|The syntax of the request entity is incorrect.|None|
+|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Invalid Credentials.|None|
+|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|The entity requested does not exist.|None|
+|422|[Unprocessable Entity](https://tools.ietf.org/html/rfc2518#section-10.3)|The syntax of the request entity is incorrect|None|
+
+
+This operation does not require authentication
+
+
+## SignupRequestController.signupWithToken
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|body|body|[LocalUserProfileDto](#schemalocaluserprofiledto)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "email": "string",
+ "password": "string"
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Sucess Response.|[LocalUserProfileDto](#schemalocaluserprofiledto)|
+|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|The syntax of the request entity is incorrect.|None|
+|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Invalid Credentials.|None|
+|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|The entity requested does not exist.|None|
+|422|[Unprocessable Entity](https://tools.ietf.org/html/rfc2518#section-10.3)|The syntax of the request entity is incorrect|None|
+
+
+This operation does not require authentication
+
+
+## SignupRequestController.verifyInviteToken
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Sucess Response.|None|
+|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|The syntax of the request entity is incorrect.|None|
+|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Invalid Credentials.|None|
+|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|The entity requested does not exist.|None|
+|422|[Unprocessable Entity](https://tools.ietf.org/html/rfc2518#section-10.3)|The syntax of the request entity is incorrect|None|
+
+
+This operation does not require authentication
+
+
+AuthClientController
+
+## AuthClientController.count
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|where|query|object|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "count": 0
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|AuthClient model count|[loopback.Count](#schemaloopback.count)|
+
+
+To perform this operation, you must be authenticated by means of one of the following methods:
+HTTPBearer
+
+
+## AuthClientController.replaceById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|number|true|none|
+|body|body|[AuthClient](#schemaauthclient)|false|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|AuthClient PUT success|None|
+
+
+To perform this operation, you must be authenticated by means of one of the following methods:
+HTTPBearer
+
+
+## AuthClientController.updateById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|number|true|none|
+|body|body|[AuthClientPartial](#schemaauthclientpartial)|false|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|AuthClient PATCH success|None|
+
+
+To perform this operation, you must be authenticated by means of one of the following methods:
+HTTPBearer
+
+
+## AuthClientController.findById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|number|true|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "id": 0,
+ "clientId": "string",
+ "clientSecret": "string",
+ "secret": "string",
+ "redirectUrl": "string",
+ "accessTokenExpiration": 0,
+ "refreshTokenExpiration": 0,
+ "authCodeExpiration": 0
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|AuthClient model instance|[AuthClient](#schemaauthclient)|
+
+
+To perform this operation, you must be authenticated by means of one of the following methods:
+HTTPBearer
+
+
+## AuthClientController.deleteById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|number|true|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|AuthClient DELETE success|None|
+
+
+To perform this operation, you must be authenticated by means of one of the following methods:
+HTTPBearer
+
+
+## AuthClientController.create
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|body|body|[AuthClientExcluding_id_](#schemaauthclientexcluding_id_)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "id": 0,
+ "clientId": "string",
+ "clientSecret": "string",
+ "secret": "string",
+ "redirectUrl": "string",
+ "accessTokenExpiration": 0,
+ "refreshTokenExpiration": 0,
+ "authCodeExpiration": 0
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|AuthClient model instance|[AuthClient](#schemaauthclient)|
+
+
+To perform this operation, you must be authenticated by means of one of the following methods:
+HTTPBearer
+
+
+## AuthClientController.updateAll
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|where|query|object|false|none|
+|body|body|[AuthClientPartial](#schemaauthclientpartial)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "count": 0
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|AuthClient PATCH success count|[loopback.Count](#schemaloopback.count)|
+
+
+To perform this operation, you must be authenticated by means of one of the following methods:
+HTTPBearer
+
+
+## AuthClientController.find
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|filter|query|[auth_clients.Filter](#schemaauth_clients.filter)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+[
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "id": 0,
+ "clientId": "string",
+ "clientSecret": "string",
+ "secret": "string",
+ "redirectUrl": "string",
+ "accessTokenExpiration": 0,
+ "refreshTokenExpiration": 0,
+ "authCodeExpiration": 0
+ }
+]
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Array of AuthClient model instances|Inline|
+
+Response Schema
+
+Status Code **200**
+
+|Name|Type|Required|Restrictions|Description|
+|---|---|---|---|---|
+|*anonymous*|[[AuthClient](#schemaauthclient)]|false|none|none|
+|» AuthClient|[AuthClient](#schemaauthclient)|false|none|none|
+|»» deleted|boolean|false|none|none|
+|»» deletedOn|string(date-time)¦null|false|none|none|
+|»» deletedBy|string¦null|false|none|none|
+|»» createdOn|string(date-time)|false|none|none|
+|»» modifiedOn|string(date-time)|false|none|none|
+|»» id|number|false|none|none|
+|»» clientId|string|true|none|none|
+|»» clientSecret|string|true|none|none|
+|»» secret|string|true|none|none|
+|»» redirectUrl|string|false|none|none|
+|»» accessTokenExpiration|number|true|none|none|
+|»» refreshTokenExpiration|number|true|none|none|
+|»» authCodeExpiration|number|true|none|none|
+
+
+To perform this operation, you must be authenticated by means of one of the following methods:
+HTTPBearer
+
+
+LogoutController
+
+## LogoutController.keycloakLogout
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|Authorization|header|string|false|This is the access token which is required to authenticate user.|
+|body|body|[RefreshTokenRequestPartial](#schemarefreshtokenrequestpartial)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "success": true
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Success Response|[SuccessResponse](#schemasuccessresponse)|
+|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|The syntax of the request entity is incorrect.|None|
+|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Invalid Credentials.|None|
+|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|The entity requested does not exist.|None|
+|422|[Unprocessable Entity](https://tools.ietf.org/html/rfc2518#section-10.3)|The syntax of the request entity is incorrect|None|
+
+
+To perform this operation, you must be authenticated by means of one of the following methods:
+HTTPBearer
+
+
+## LogoutController.logout
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|Authorization|header|string|false|This is the access token which is required to authenticate user.|
+|body|body|[RefreshTokenRequestPartial](#schemarefreshtokenrequestpartial)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "success": true
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Success Response|[SuccessResponse](#schemasuccessresponse)|
+|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|The syntax of the request entity is incorrect.|None|
+|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Invalid Credentials.|None|
+|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|The entity requested does not exist.|None|
+|422|[Unprocessable Entity](https://tools.ietf.org/html/rfc2518#section-10.3)|The syntax of the request entity is incorrect|None|
+
+
+To perform this operation, you must be authenticated by means of one of the following methods:
+HTTPBearer
+
+
+OtpController
+
+## OtpController.findById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "otp": "string",
+ "username": "string"
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Otp model instance|[Otp](#schemaotp)|
+
+
+This operation does not require authentication
+
+
+## OtpController.deleteById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|Otp DELETE success|None|
+
+
+This operation does not require authentication
+
+
+## OtpController.create
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|body|body|[Otp](#schemaotp)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "otp": "string",
+ "username": "string"
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Otp model instance|[Otp](#schemaotp)|
+
+
+This operation does not require authentication
+
+
+ToDoController
+
+## ToDoController.count
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|where|query|object|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "count": 0
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|ToDo model count|[loopback.Count](#schemaloopback.count)|
+
+
+This operation does not require authentication
+
+
+## ToDoController.replaceById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|body|body|[ToDo](#schematodo)|false|none|
+
+> Example responses
+
+> 204 Response
+
+```json
+null
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|No Content|Inline|
+
+Response Schema
+
+Status Code **204**
+
+*ToDo PUT success*
+
+|Name|Type|Required|Restrictions|Description|
+|---|---|---|---|---|
+
+
+This operation does not require authentication
+
+
+## ToDoController.updateById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|body|body|[ToDoPartial](#schematodopartial)|false|none|
+
+> Example responses
+
+> 204 Response
+
+```json
+null
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|No Content|Inline|
+
+Response Schema
+
+Status Code **204**
+
+*ToDo PATCH success*
+
+|Name|Type|Required|Restrictions|Description|
+|---|---|---|---|---|
+
+
+This operation does not require authentication
+
+
+## ToDoController.findById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|filter|query|[ToDo.Filter](#schematodo.filter)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "id": "string",
+ "title": "string",
+ "description": "string",
+ "items": [
+ "string"
+ ]
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|ToDo model instance|[ToDoWithRelations](#schematodowithrelations)|
+
+
+This operation does not require authentication
+
+
+## ToDoController.deleteById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+
+> Example responses
+
+> 204 Response
+
+```json
+null
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|No Content|Inline|
+
+Response Schema
+
+Status Code **204**
+
+*ToDo DELETE success*
+
+|Name|Type|Required|Restrictions|Description|
+|---|---|---|---|---|
+
+
+This operation does not require authentication
+
+
+## ToDoController.create
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|body|body|[NewToDo](#schemanewtodo)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "id": "string",
+ "title": "string",
+ "description": "string",
+ "items": [
+ "string"
+ ]
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|ToDo model instance|[ToDo](#schematodo)|
+
+
+This operation does not require authentication
+
+
+## ToDoController.updateAll
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|where|query|object|false|none|
+|body|body|[ToDoPartial](#schematodopartial)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "count": 0
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|ToDo PATCH success count|[loopback.Count](#schemaloopback.count)|
+
+
+This operation does not require authentication
+
+
+## ToDoController.find
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|filter|query|[ToDo.Filter1](#schematodo.filter1)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+[
+ {
+ "id": "string",
+ "title": "string",
+ "description": "string",
+ "items": [
+ "string"
+ ]
+ }
+]
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Array of ToDo model instances|Inline|
+
+Response Schema
+
+Status Code **200**
+
+|Name|Type|Required|Restrictions|Description|
+|---|---|---|---|---|
+|*anonymous*|[[ToDoWithRelations](#schematodowithrelations)]|false|none|[(tsType: ToDoWithRelations, schemaOptions: { includeRelations: true })]|
+|» ToDoWithRelations|[ToDoWithRelations](#schematodowithrelations)|false|none|(tsType: ToDoWithRelations, schemaOptions: { includeRelations: true })|
+|»» id|string|false|none|none|
+|»» title|string|true|none|none|
+|»» description|string|true|none|none|
+|»» items|[string]|false|none|none|
+
+
+This operation does not require authentication
+
+
+# Schemas
+
+LoginRequest
+
+TokenResponse
+
+AuthTokenRequest
+
+Function
+
+AuthRefreshTokenRequest
+
+ClientAuthRequest
+
+ResetPasswordPartial
+
+ResetPassword
+
+SuccessResponse
+
+RefreshTokenRequestPartial
+
+RefreshTokenRequest
+
+Otp
+
+AuthClient
+
+AuthClientExcluding_id_
+
+AuthClientPartial
+
+User
+
+ForgetPasswordResponseDto
+
+ForgetPasswordDto
+
+ResetPasswordWithClient
+
+SignupRequestResponseDto
+
+SignupRequestDto
+
+LocalUserProfileDto
+
+SignupRequest
+
+ToDo
+
+NewToDo
+
+ToDoWithRelations
+
+ToDoPartial
+
+loopback.Count
+
+auth_clients.Filter
+
+ToDo.Filter
+
+ToDo.Filter1
+
+Authentication Service v1.0.0
+
+> Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
+
+This is a sample application for sandbox testing of auth microservice components.
+
+Base URLs:
+
+* http://localhost:3000
+
+# Authentication
+
+- HTTP Authentication, scheme: bearer
+
+LoginController
+
+## LoginController.resetPassword
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|Authorization|header|string|false|none|
+|body|body|[ResetPasswordPartial](#schemaresetpasswordpartial)|false|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|If User password successfully changed.|None|
+
+
+To perform this operation, you must be authenticated by means of one of the following methods:
+HTTPBearer
+
+
+## LoginController.postLoginViaGoogle
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|body|body|[ClientAuthRequest](#schemaclientauthrequest)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "accessToken": "string",
+ "refreshToken": "string",
+ "expires": 0,
+ "pubnubToken": "string"
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|POST Call for Google based login|[TokenResponse](#schematokenresponse)|
+
+
+This operation does not require authentication
+
+
+## LoginController.loginViaGoogle
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|client_id|query|string|false|none|
+|client_secret|query|string|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "accessToken": "string",
+ "refreshToken": "string",
+ "expires": 0,
+ "pubnubToken": "string"
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Google Token Response (Deprecated: Possible security issue if secret is passed via query params, please use the post endpoint)|[TokenResponse](#schematokenresponse)|
+
+
+This operation does not require authentication
+
+
+## LoginController.googleCallback
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|code|query|string|false|none|
+|state|query|string|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "accessToken": "string",
+ "refreshToken": "string",
+ "expires": 0,
+ "pubnubToken": "string"
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Google Redirect Token Response|[TokenResponse](#schematokenresponse)|
+
+
+This operation does not require authentication
+
+
+## LoginController.postLoginViaInstagram
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|body|body|[ClientAuthRequest](#schemaclientauthrequest)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "accessToken": "string",
+ "refreshToken": "string",
+ "expires": 0,
+ "pubnubToken": "string"
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|POST Call for Instagram based login|[TokenResponse](#schematokenresponse)|
+
+
+This operation does not require authentication
+
+
+## LoginController.instagramCallback
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|code|query|string|false|none|
+|state|query|string|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "accessToken": "string",
+ "refreshToken": "string",
+ "expires": 0,
+ "pubnubToken": "string"
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Instagram Redirect Token Response|[TokenResponse](#schematokenresponse)|
+
+
+This operation does not require authentication
+
+
+## LoginController.postLoginViaKeycloak
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|body|body|[ClientAuthRequest](#schemaclientauthrequest)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "accessToken": "string",
+ "refreshToken": "string",
+ "expires": 0,
+ "pubnubToken": "string"
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Keycloak Token Response|[TokenResponse](#schematokenresponse)|
+
+
+This operation does not require authentication
+
+
+## LoginController.loginViaKeycloak
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|client_id|query|string|false|none|
+|client_secret|query|string|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "accessToken": "string",
+ "refreshToken": "string",
+ "expires": 0,
+ "pubnubToken": "string"
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Keycloak Token Response (Deprecated: Possible security issue if secret is passed via query params, please use the post endpoint)|[TokenResponse](#schematokenresponse)|
+
+
+This operation does not require authentication
+
+
+## LoginController.keycloakCallback
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|code|query|string|false|none|
+|state|query|string|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "accessToken": "string",
+ "refreshToken": "string",
+ "expires": 0,
+ "pubnubToken": "string"
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Keycloak Redirect Token Response|[TokenResponse](#schematokenresponse)|
+
+
+This operation does not require authentication
+
+
+## LoginController.login
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|body|body|[LoginRequest](#schemaloginrequest)|false|none|
+
+> Example responses
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Auth Code|None|
+|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|The syntax of the request entity is incorrect.|None|
+|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Invalid Credentials.|None|
+|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|The entity requested does not exist.|None|
+|422|[Unprocessable Entity](https://tools.ietf.org/html/rfc2518#section-10.3)|The syntax of the request entity is incorrect|None|
+
+Response Schema
+
+
+This operation does not require authentication
+
+
+## LoginController.loginWithClientUser
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|device_id|header|string|false|none|
+|body|body|[LoginRequest](#schemaloginrequest)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "accessToken": "string",
+ "refreshToken": "string",
+ "expires": 0,
+ "pubnubToken": "string"
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Token Response Model|[TokenResponse](#schematokenresponse)|
+|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|The syntax of the request entity is incorrect.|None|
+|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Invalid Credentials.|None|
+|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|The entity requested does not exist.|None|
+|422|[Unprocessable Entity](https://tools.ietf.org/html/rfc2518#section-10.3)|The syntax of the request entity is incorrect|None|
+
+
+This operation does not require authentication
+
+
+## LoginController.me
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|User Object|None|
+|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|The syntax of the request entity is incorrect.|None|
+|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Invalid Credentials.|None|
+|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|The entity requested does not exist.|None|
+|422|[Unprocessable Entity](https://tools.ietf.org/html/rfc2518#section-10.3)|The syntax of the request entity is incorrect|None|
+
+Response Schema
+
+
+To perform this operation, you must be authenticated by means of one of the following methods:
+HTTPBearer
+
+
+## LoginController.getToken
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|device_id|header|string|false|none|
+|body|body|[AuthTokenRequest](#schemaauthtokenrequest)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "accessToken": "string",
+ "refreshToken": "string",
+ "expires": 0,
+ "pubnubToken": "string"
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Token Response|[TokenResponse](#schematokenresponse)|
+|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|The syntax of the request entity is incorrect.|None|
+|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Invalid Credentials.|None|
+|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|The entity requested does not exist.|None|
+|422|[Unprocessable Entity](https://tools.ietf.org/html/rfc2518#section-10.3)|The syntax of the request entity is incorrect|None|
+
+
+This operation does not require authentication
+
+
+## LoginController.exchangeToken
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|device_id|header|string|false|none|
+|body|body|[AuthRefreshTokenRequest](#schemaauthrefreshtokenrequest)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "accessToken": "string",
+ "refreshToken": "string",
+ "expires": 0,
+ "pubnubToken": "string"
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|New Token Response|[TokenResponse](#schematokenresponse)|
+|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|The syntax of the request entity is incorrect.|None|
+|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Invalid Credentials.|None|
+|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|The entity requested does not exist.|None|
+|422|[Unprocessable Entity](https://tools.ietf.org/html/rfc2518#section-10.3)|The syntax of the request entity is incorrect|None|
+
+
+This operation does not require authentication
+
+
+ForgetPasswordController
+
+## ForgetPasswordController.forgetPassword
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|body|body|[ForgetPasswordDto](#schemaforgetpassworddto)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "code": "string",
+ "expiry": 0,
+ "email": "string",
+ "user": {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "firstName": "string",
+ "lastName": "string",
+ "middleName": "string",
+ "username": "string",
+ "email": "string",
+ "phone": "string",
+ "authClientIds": "string",
+ "lastLogin": "2019-08-24T14:15:22Z",
+ "dob": "2019-08-24T14:15:22Z",
+ "gender": "M",
+ "defaultTenantId": "string"
+ }
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Success Response.|[ForgetPasswordResponseDto](#schemaforgetpasswordresponsedto)|
+|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|The syntax of the request entity is incorrect.|None|
+|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Invalid Credentials.|None|
+|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|The entity requested does not exist.|None|
+|422|[Unprocessable Entity](https://tools.ietf.org/html/rfc2518#section-10.3)|The syntax of the request entity is incorrect|None|
+
+
+This operation does not require authentication
+
+
+## ForgetPasswordController.resetPassword
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|body|body|[ResetPasswordWithClient](#schemaresetpasswordwithclient)|false|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|If User password successfully changed.|None|
+
+
+This operation does not require authentication
+
+
+## ForgetPasswordController.verifyResetPasswordLink
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|token|query|string|true|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Check if Token Is Valid and not Expired.|None|
+
+
+This operation does not require authentication
+
+
+SignupRequestController
+
+## SignupRequestController.requestSignup
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|body|body|[SignupRequestDto](#schemasignuprequestdto)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "code": "string",
+ "expiry": 0,
+ "email": "string"
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Sucess Response.|[SignupRequestResponseDto](#schemasignuprequestresponsedto)|
+|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|The syntax of the request entity is incorrect.|None|
+|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Invalid Credentials.|None|
+|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|The entity requested does not exist.|None|
+|422|[Unprocessable Entity](https://tools.ietf.org/html/rfc2518#section-10.3)|The syntax of the request entity is incorrect|None|
+
+
+This operation does not require authentication
+
+
+## SignupRequestController.signupWithToken
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|body|body|[LocalUserProfileDto](#schemalocaluserprofiledto)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "email": "string",
+ "password": "string"
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Sucess Response.|[LocalUserProfileDto](#schemalocaluserprofiledto)|
+|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|The syntax of the request entity is incorrect.|None|
+|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Invalid Credentials.|None|
+|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|The entity requested does not exist.|None|
+|422|[Unprocessable Entity](https://tools.ietf.org/html/rfc2518#section-10.3)|The syntax of the request entity is incorrect|None|
+
+
+This operation does not require authentication
+
+
+## SignupRequestController.verifyInviteToken
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Sucess Response.|None|
+|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|The syntax of the request entity is incorrect.|None|
+|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Invalid Credentials.|None|
+|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|The entity requested does not exist.|None|
+|422|[Unprocessable Entity](https://tools.ietf.org/html/rfc2518#section-10.3)|The syntax of the request entity is incorrect|None|
+
+
+This operation does not require authentication
+
+
+AuthClientController
+
+## AuthClientController.count
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|where|query|object|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "count": 0
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|AuthClient model count|[loopback.Count](#schemaloopback.count)|
+
+
+To perform this operation, you must be authenticated by means of one of the following methods:
+HTTPBearer
+
+
+## AuthClientController.replaceById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|number|true|none|
+|body|body|[AuthClient](#schemaauthclient)|false|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|AuthClient PUT success|None|
+
+
+To perform this operation, you must be authenticated by means of one of the following methods:
+HTTPBearer
+
+
+## AuthClientController.updateById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|number|true|none|
+|body|body|[AuthClientPartial](#schemaauthclientpartial)|false|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|AuthClient PATCH success|None|
+
+
+To perform this operation, you must be authenticated by means of one of the following methods:
+HTTPBearer
+
+
+## AuthClientController.findById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|number|true|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "id": 0,
+ "clientId": "string",
+ "clientSecret": "string",
+ "secret": "string",
+ "redirectUrl": "string",
+ "accessTokenExpiration": 0,
+ "refreshTokenExpiration": 0,
+ "authCodeExpiration": 0
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|AuthClient model instance|[AuthClient](#schemaauthclient)|
+
+
+To perform this operation, you must be authenticated by means of one of the following methods:
+HTTPBearer
+
+
+## AuthClientController.deleteById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|number|true|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|AuthClient DELETE success|None|
+
+
+To perform this operation, you must be authenticated by means of one of the following methods:
+HTTPBearer
+
+
+## AuthClientController.create
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|body|body|[AuthClientExcluding_id_](#schemaauthclientexcluding_id_)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "id": 0,
+ "clientId": "string",
+ "clientSecret": "string",
+ "secret": "string",
+ "redirectUrl": "string",
+ "accessTokenExpiration": 0,
+ "refreshTokenExpiration": 0,
+ "authCodeExpiration": 0
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|AuthClient model instance|[AuthClient](#schemaauthclient)|
+
+
+To perform this operation, you must be authenticated by means of one of the following methods:
+HTTPBearer
+
+
+## AuthClientController.updateAll
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|where|query|object|false|none|
+|body|body|[AuthClientPartial](#schemaauthclientpartial)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "count": 0
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|AuthClient PATCH success count|[loopback.Count](#schemaloopback.count)|
+
+
+To perform this operation, you must be authenticated by means of one of the following methods:
+HTTPBearer
+
+
+## AuthClientController.find
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|filter|query|[auth_clients.Filter](#schemaauth_clients.filter)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+[
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "id": 0,
+ "clientId": "string",
+ "clientSecret": "string",
+ "secret": "string",
+ "redirectUrl": "string",
+ "accessTokenExpiration": 0,
+ "refreshTokenExpiration": 0,
+ "authCodeExpiration": 0
+ }
+]
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Array of AuthClient model instances|Inline|
+
+Response Schema
+
+Status Code **200**
+
+|Name|Type|Required|Restrictions|Description|
+|---|---|---|---|---|
+|*anonymous*|[[AuthClient](#schemaauthclient)]|false|none|none|
+|» AuthClient|[AuthClient](#schemaauthclient)|false|none|none|
+|»» deleted|boolean|false|none|none|
+|»» deletedOn|string(date-time)¦null|false|none|none|
+|»» deletedBy|string¦null|false|none|none|
+|»» createdOn|string(date-time)|false|none|none|
+|»» modifiedOn|string(date-time)|false|none|none|
+|»» id|number|false|none|none|
+|»» clientId|string|true|none|none|
+|»» clientSecret|string|true|none|none|
+|»» secret|string|true|none|none|
+|»» redirectUrl|string|false|none|none|
+|»» accessTokenExpiration|number|true|none|none|
+|»» refreshTokenExpiration|number|true|none|none|
+|»» authCodeExpiration|number|true|none|none|
+
+
+To perform this operation, you must be authenticated by means of one of the following methods:
+HTTPBearer
+
+
+LogoutController
+
+## LogoutController.keycloakLogout
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|Authorization|header|string|false|This is the access token which is required to authenticate user.|
+|body|body|[RefreshTokenRequestPartial](#schemarefreshtokenrequestpartial)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "success": true
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Success Response|[SuccessResponse](#schemasuccessresponse)|
+|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|The syntax of the request entity is incorrect.|None|
+|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Invalid Credentials.|None|
+|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|The entity requested does not exist.|None|
+|422|[Unprocessable Entity](https://tools.ietf.org/html/rfc2518#section-10.3)|The syntax of the request entity is incorrect|None|
+
+
+To perform this operation, you must be authenticated by means of one of the following methods:
+HTTPBearer
+
+
+## LogoutController.logout
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|Authorization|header|string|false|This is the access token which is required to authenticate user.|
+|body|body|[RefreshTokenRequestPartial](#schemarefreshtokenrequestpartial)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "success": true
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Success Response|[SuccessResponse](#schemasuccessresponse)|
+|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|The syntax of the request entity is incorrect.|None|
+|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Invalid Credentials.|None|
+|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|The entity requested does not exist.|None|
+|422|[Unprocessable Entity](https://tools.ietf.org/html/rfc2518#section-10.3)|The syntax of the request entity is incorrect|None|
+
+
+To perform this operation, you must be authenticated by means of one of the following methods:
+HTTPBearer
+
+
+OtpController
+
+## OtpController.findById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "otp": "string",
+ "username": "string"
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Otp model instance|[Otp](#schemaotp)|
+
+
+This operation does not require authentication
+
+
+## OtpController.deleteById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|Otp DELETE success|None|
+
+
+This operation does not require authentication
+
+
+## OtpController.create
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|body|body|[Otp](#schemaotp)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "otp": "string",
+ "username": "string"
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Otp model instance|[Otp](#schemaotp)|
+
+
+This operation does not require authentication
+
+
+PingController
+
+## PingController.ping
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Ping Response|Inline|
+
+Response Schema
+
+Status Code **200**
+
+|Name|Type|Required|Restrictions|Description|
+|---|---|---|---|---|
+|» greeting|string|false|none|none|
+|» date|string|false|none|none|
+|» url|string|false|none|none|
+|» headers|object|false|none|none|
+|»» Content-Type|string|false|none|none|
+
+
+This operation does not require authentication
+
+
+TodoController
+
+## TodoController.count
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|where|query|object|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "count": 0
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|ToDo model count|[loopback.Count](#schemaloopback.count)|
+
+
+This operation does not require authentication
+
+
+## TodoController.updateById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|body|body|[ToDoPartial](#schematodopartial)|false|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|ToDo PATCH success|None|
+
+
+This operation does not require authentication
+
+
+## TodoController.findById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|filter|query|[todos.Filter](#schematodos.filter)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "title": "string",
+ "description": "string",
+ "items": [
+ "string"
+ ]
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|ToDo model instance|[ToDoWithRelations](#schematodowithrelations)|
+
+
+This operation does not require authentication
+
+
+## TodoController.deleteById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|ToDo DELETE success|None|
+
+
+This operation does not require authentication
+
+
+## TodoController.create
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|body|body|[NewToDo](#schemanewtodo)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "title": "string",
+ "description": "string",
+ "items": [
+ "string"
+ ]
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|ToDo model instance|[ToDo](#schematodo)|
+
+
+This operation does not require authentication
+
+
+## TodoController.find
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|filter|query|[todos.Filter1](#schematodos.filter1)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+[
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "title": "string",
+ "description": "string",
+ "items": [
+ "string"
+ ]
+ }
+]
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Array of ToDo model instances|Inline|
+
+Response Schema
+
+Status Code **200**
+
+|Name|Type|Required|Restrictions|Description|
+|---|---|---|---|---|
+|*anonymous*|[[ToDoWithRelations](#schematodowithrelations)]|false|none|[(tsType: ToDoWithRelations, schemaOptions: { includeRelations: true })]|
+|» ToDoWithRelations|[ToDoWithRelations](#schematodowithrelations)|false|none|(tsType: ToDoWithRelations, schemaOptions: { includeRelations: true })|
+|»» deleted|boolean|false|none|none|
+|»» deletedOn|string(date-time)¦null|false|none|none|
+|»» deletedBy|string¦null|false|none|none|
+|»» createdOn|string(date-time)|false|none|none|
+|»» modifiedOn|string(date-time)|false|none|none|
+|»» createdBy|string|false|none|none|
+|»» modifiedBy|string|false|none|none|
+|»» id|string|false|none|none|
+|»» title|string|true|none|none|
+|»» description|string|true|none|none|
+|»» items|[string]|false|none|none|
+
+
+This operation does not require authentication
+
+
+HomePageController
+
+## HomePageController.homePage
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Home Page|string|
+
+
+This operation does not require authentication
+
+
+# Schemas
+
+LoginRequest
+
+TokenResponse
+
+AuthTokenRequest
+
+Function
+
+AuthRefreshTokenRequest
+
+ClientAuthRequest
+
+ResetPasswordPartial
+
+ResetPassword
+
+SuccessResponse
+
+RefreshTokenRequestPartial
+
+RefreshTokenRequest
+
+Otp
+
+AuthClient
+
+AuthClientExcluding_id_
+
+AuthClientPartial
+
+User
+
+ForgetPasswordResponseDto
+
+ForgetPasswordDto
+
+ResetPasswordWithClient
+
+SignupRequestResponseDto
+
+SignupRequestDto
+
+LocalUserProfileDto
+
+SignupRequest
+
+ToDo
+
+NewToDo
+
+ToDoWithRelations
+
+ToDoPartial
+
+loopback.Count
+
+auth_clients.Filter
+
+todos.Filter
+
+todos.Filter1
+
+ {
+ implements UserPermission
+{
@property({
type: 'string',
id: true,
diff --git a/sandbox/auth-multitenant-example/src/models/user-level-resource.model.ts b/sandbox/auth-multitenant-example/src/models/user-level-resource.model.ts
index d5d0eb32e2..cb9428b2f5 100644
--- a/sandbox/auth-multitenant-example/src/models/user-level-resource.model.ts
+++ b/sandbox/auth-multitenant-example/src/models/user-level-resource.model.ts
@@ -7,7 +7,8 @@ import {IUserResource} from 'loopback4-authorization';
})
export class UserLevelResource
extends UserModifiableEntity
- implements IUserResource {
+ implements IUserResource
+{
@property({
type: 'string',
id: true,
diff --git a/sandbox/auth-multitenant-example/src/providers/casbin-authorization-action.provider.ts b/sandbox/auth-multitenant-example/src/providers/casbin-authorization-action.provider.ts
index a319fab7b8..1676b49a5a 100644
--- a/sandbox/auth-multitenant-example/src/providers/casbin-authorization-action.provider.ts
+++ b/sandbox/auth-multitenant-example/src/providers/casbin-authorization-action.provider.ts
@@ -14,7 +14,8 @@ import {
import * as casbin from 'casbin';
export class CasbinAuthorizationProvider
- implements Provider {
+ implements Provider
+{
constructor(
@inject.getter(AuthorizationBindings.METADATA)
private readonly getCasbinMetadata: Getter,
diff --git a/sandbox/auth-multitenant-example/src/providers/casbin-enforcer-config.provider.ts b/sandbox/auth-multitenant-example/src/providers/casbin-enforcer-config.provider.ts
index 915463a55b..2aa2e9ec5f 100644
--- a/sandbox/auth-multitenant-example/src/providers/casbin-enforcer-config.provider.ts
+++ b/sandbox/auth-multitenant-example/src/providers/casbin-enforcer-config.provider.ts
@@ -13,7 +13,8 @@ import {
import {UserLevelResourceRepository} from '../repositories';
export class CasbinEnforcerConfigProvider
- implements Provider {
+ implements Provider
+{
constructor(
@inject.getter(AuthorizationBindings.METADATA)
private readonly getCasbinMetadata: Getter,
diff --git a/sandbox/auth-multitenant-example/src/providers/casbin-resource-val-modifier.provider.ts b/sandbox/auth-multitenant-example/src/providers/casbin-resource-val-modifier.provider.ts
index dd078bce78..ada275f62a 100644
--- a/sandbox/auth-multitenant-example/src/providers/casbin-resource-val-modifier.provider.ts
+++ b/sandbox/auth-multitenant-example/src/providers/casbin-resource-val-modifier.provider.ts
@@ -9,7 +9,8 @@ import {
} from 'loopback4-authorization';
export class CasbinResValModifierProvider
- implements Provider {
+ implements Provider
+{
constructor(
@inject.getter(AuthorizationBindings.METADATA)
private readonly getCasbinMetadata: Getter,
diff --git a/sandbox/auth-multitenant-example/src/repositories/user-ext.repository.ts b/sandbox/auth-multitenant-example/src/repositories/user-ext.repository.ts
index b786d50bc2..1440dbe650 100644
--- a/sandbox/auth-multitenant-example/src/repositories/user-ext.repository.ts
+++ b/sandbox/auth-multitenant-example/src/repositories/user-ext.repository.ts
@@ -125,7 +125,6 @@ export class UserExtRepository extends DefaultSoftCrudRepository<
}
await this.credentials(user.id).create(creds, options);
} catch (err) {
- // eslint-disable-next-line @typescript-eslint/no-floating-promises
super.deleteByIdHard(user.id);
throw new HttpErrors.UnprocessableEntity('Error while hashing password');
}
diff --git a/sandbox/in-mail-example/Dockerfile b/sandbox/in-mail-example/Dockerfile
index 5fcdd67bad..2618207377 100644
--- a/sandbox/in-mail-example/Dockerfile
+++ b/sandbox/in-mail-example/Dockerfile
@@ -1,5 +1,5 @@
# Check out https://hub.docker.com/_/node to select a new base image
-FROM node:10-slim
+FROM node:14-slim
# Set to a non-root built-in user `node`
USER node
diff --git a/sandbox/in-mail-example/README.md b/sandbox/in-mail-example/README.md
index 518030e403..129b20bfc3 100644
--- a/sandbox/in-mail-example/README.md
+++ b/sandbox/in-mail-example/README.md
@@ -28,6 +28,10 @@ You can also run `node .` to skip the build step.
Open http://127.0.0.1:3000 in your browser.
+#### API Details
+
+Visit the [OpenAPI spec docs](./openapi.md)
+
## Rebuild the project
To incrementally build the project:
diff --git a/sandbox/in-mail-example/openapi.md b/sandbox/in-mail-example/openapi.md
new file mode 100644
index 0000000000..5f34490faa
--- /dev/null
+++ b/sandbox/in-mail-example/openapi.md
@@ -0,0 +1,3891 @@
+---
+title: In-mail Service v1.0.0
+language_tabs:
+ - "'javascript": JavaScript
+ - "'javascript--nodejs": Node.JS'
+language_clients:
+ - "'javascript": request'
+ - "'javascript--nodejs": ""
+toc_footers: []
+includes: []
+search: false
+highlight_theme: darkula
+headingLevel: 2
+
+---
+
+
+
+In-mail Service v1.0.0
+
+> Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
+
+in mail example
+
+Base URLs:
+
+* http://localhost:3000
+
+
+# Authentication
+
+- HTTP Authentication, scheme: bearer
+
+OriginatorController
+
+## API provides an interface for restore message from trash.
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|filter|query|object|false|none|
+|body|body|[IdArraysPartial](#schemaidarrayspartial)|false|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Restore Message Successful!|None|
+|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|Message identity does not exist.|None|
+|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden request due to unauthorized token in header.|None|
+
+
+This operation does not require authentication
+
+
+## API for moving mails to trash and then delete
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|storage|path|string|true|none|
+|action|path|string|true|none|
+|filter|query|object|false|none|
+|body|body|[IdArraysPartial](#schemaidarrayspartial)|false|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Trash/Deletion of Mail(s) sucessful!|None|
+|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden request due to unauthorized token in header.|None|
+|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Message identity does not exist.|None|
+
+
+This operation does not require authentication
+
+
+## API provides interface to mark read, unread and important
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|markType|path|string|true|none|
+|body|body|[IdArraysPartial](#schemaidarrayspartial)|false|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Message is marked read/unread/important|None|
+
+
+This operation does not require authentication
+
+
+## API provides an interface for removing attachment before message is sent
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|messageId|path|string|true|none|
+|attachmentId|path|string|true|none|
+|filter|query|object|false|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Deletetion of Attachment Successful!|None|
+|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden request due to unauthorized token in header.|None|
+|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Message identity does not exist.|None|
+
+
+This operation does not require authentication
+
+
+## API provides an interface for adding attachment before message is sent.
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|messageId|path|string|true|none|
+|filter|query|object|false|none|
+|body|body|object|false|none|
+|» attachments|body|[[AttachmentPartial](#schemaattachmentpartial)]|false|[(tsType: Partial, schemaOptions: { partial: true })]|
+|»» AttachmentPartial|body|[AttachmentPartial](#schemaattachmentpartial)|false|(tsType: Partial, schemaOptions: { partial: true })|
+|»»» deleted|body|boolean|false|none|
+|»»» deletedOn|body|string(date-time)¦null|false|none|
+|»»» deletedBy|body|string¦null|false|none|
+|»»» createdOn|body|string(date-time)|false|none|
+|»»» modifiedOn|body|string(date-time)|false|none|
+|»»» createdBy|body|string|false|none|
+|»»» modifiedBy|body|string|false|none|
+|»»» id|body|string|false|none|
+|»»» name|body|string|false|none|
+|»»» path|body|string|false|none|
+|»»» thumbnail|body|string|false|none|
+|»»» mime|body|string|false|none|
+|»»» extId|body|string|false|none|
+|»»» extMetadata|body|object|false|none|
+|»»» messageId|body|string|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "items": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "name": "string",
+ "path": "string",
+ "thumbnail": "string",
+ "mime": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "messageId": "string"
+ }
+ ]
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|collect single attachment for user by message identifier|[Attachment add response schema](#schemaattachment add response schema)|
+|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|Message identity does not exist.|None|
+|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden request due to unauthorized token in header.|None|
+
+
+This operation does not require authentication
+
+
+## API for sending a drafted message.
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|messageId|path|string|true|none|
+|filter|query|object|false|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Mail is Successfully sent!|None|
+|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|Message identity does not exist.|None|
+|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden request due to unauthorized token in header.|None|
+
+
+This operation does not require authentication
+
+
+## Update API. Update draft messages.
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|messageId|path|string|true|none|
+|body|body|[composeMailBody](#schemacomposemailbody)|false|none|
+
+> Example responses
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|Message identity does not exist.|None|
+|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden request due to unauthorized token in header.|None|
+|application/json|Unknown|collect single message for user by message identifier|None|
+
+Response Schema
+
+
+To perform this operation, you must be authenticated by means of one of the following methods:
+None
+
+
+## ComposeAPI. For drafting, reply on and create new message
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|body|body|[composeMailBody](#schemacomposemailbody)|false|none|
+
+> Example responses
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|201|[Created](https://tools.ietf.org/html/rfc7231#section-6.3.2)|collect single message for user by message identifier|None|
+|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden request due to unauthorized token in header.|None|
+|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Message identity does not exist.|None|
+
+Response Schema
+
+
+This operation does not require authentication
+
+
+CollectorController
+
+## GET Message API. Collect a single message based on message identity.
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|messageId|path|string|true|none|
+|filter|query|object|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "item": "string"
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Gets mail details based on unique message id|Inline|
+|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden request due to unauthrized token in header.|None|
+|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Message identity does not exist|None|
+
+Response Schema
+
+Status Code **200**
+
+|Name|Type|Required|Restrictions|Description|
+|---|---|---|---|---|
+|» item|string|false|none|none|
+
+
+This operation does not require authentication
+
+
+## Collect a list of all messages.
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|messageFilter|query|object|false|none|
+|groupFilter|query|object|false|none|
+
+> Example responses
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|fetch mails|None|
+|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden request due to unauthrized token in header.|None|
+
+Response Schema
+
+
+This operation does not require authentication
+
+
+## GET Thread Message API. Collect complete single message thread based on thread identity.
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|threadId|path|string|true|none|
+|filter|query|object|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "item": {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "subject": "string",
+ "messageCounts": 0,
+ "extId": "string",
+ "extMetadata": {}
+ }
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Fetches a thread along with message, group, attachment(s) etc based on unique thread Id|Inline|
+|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|Message identity does not exist|None|
+|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden request due to unauthorized token in header.|None|
+
+Response Schema
+
+Status Code **200**
+
+|Name|Type|Required|Restrictions|Description|
+|---|---|---|---|---|
+|» item|[Thread](#schemathread)|false|none|none|
+|»» deleted|boolean|false|none|none|
+|»» deletedOn|string(date-time)¦null|false|none|none|
+|»» deletedBy|string¦null|false|none|none|
+|»» createdOn|string(date-time)|false|none|none|
+|»» modifiedOn|string(date-time)|false|none|none|
+|»» createdBy|string|false|none|none|
+|»» modifiedBy|string|false|none|none|
+|»» id|string|false|none|none|
+|»» subject|string|true|none|none|
+|»» messageCounts|number|false|none|none|
+|»» extId|string|false|none|none|
+|»» extMetadata|object|false|none|none|
+
+
+This operation does not require authentication
+
+
+## Thread List API. Collect a list of all threads.
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|threadFilter|query|object|false|none|
+|groupFilter|query|object|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "version": "string",
+ "items": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "subject": "string",
+ "messageCounts": 0,
+ "extId": "string",
+ "extMetadata": {}
+ }
+ ]
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|fetch threads|Inline|
+
+Response Schema
+
+Status Code **200**
+
+|Name|Type|Required|Restrictions|Description|
+|---|---|---|---|---|
+|» version|string|false|none|none|
+|» items|[[Thread](#schemathread)]|false|none|none|
+|»» Thread|[Thread](#schemathread)|false|none|none|
+|»»» deleted|boolean|false|none|none|
+|»»» deletedOn|string(date-time)¦null|false|none|none|
+|»»» deletedBy|string¦null|false|none|none|
+|»»» createdOn|string(date-time)|false|none|none|
+|»»» modifiedOn|string(date-time)|false|none|none|
+|»»» createdBy|string|false|none|none|
+|»»» modifiedBy|string|false|none|none|
+|»»» id|string|false|none|none|
+|»»» subject|string|true|none|none|
+|»»» messageCounts|number|false|none|none|
+|»»» extId|string|false|none|none|
+|»»» extMetadata|object|false|none|none|
+
+
+This operation does not require authentication
+
+
+PingController
+
+## PingController.ping
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Ping Response|[PingResponse](#schemapingresponse)|
+
+
+This operation does not require authentication
+
+
+ReplyAndForwardController
+
+## API provides interface to forward single message.
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|threadId|path|string|true|none|
+|body|body|object|false|none|
+|» groups|body|[[GroupPartial](#schemagrouppartial)]|true|[(tsType: Partial, schemaOptions: { partial: true })]|
+|»» GroupPartial|body|[GroupPartial](#schemagrouppartial)|false|(tsType: Partial, schemaOptions: { partial: true })|
+|»»» deleted|body|boolean|false|none|
+|»»» deletedOn|body|string(date-time)¦null|false|none|
+|»»» deletedBy|body|string¦null|false|none|
+|»»» createdOn|body|string(date-time)|false|none|
+|»»» modifiedOn|body|string(date-time)|false|none|
+|»»» createdBy|body|string|false|none|
+|»»» modifiedBy|body|string|false|none|
+|»»» id|body|string|false|none|
+|»»» party|body|string|false|none|
+|»»» type|body|string|false|none|
+|»»» isImportant|body|boolean|false|none|
+|»»» storage|body|string|false|none|
+|»»» visibility|body|string|false|none|
+|»»» extId|body|string|false|none|
+|»»» extMetadata|body|object|false|none|
+|»»» messageId|body|string|false|none|
+|»»» threadId|body|string|false|none|
+|» subject|body|string|false|none|
+|» body|body|string|false|none|
+|» attachments|body|[[AttachmentPartial](#schemaattachmentpartial)]|false|[(tsType: Partial, schemaOptions: { partial: true })]|
+|»» AttachmentPartial|body|[AttachmentPartial](#schemaattachmentpartial)|false|(tsType: Partial, schemaOptions: { partial: true })|
+|»»» deleted|body|boolean|false|none|
+|»»» deletedOn|body|string(date-time)¦null|false|none|
+|»»» deletedBy|body|string¦null|false|none|
+|»»» createdOn|body|string(date-time)|false|none|
+|»»» modifiedOn|body|string(date-time)|false|none|
+|»»» createdBy|body|string|false|none|
+|»»» modifiedBy|body|string|false|none|
+|»»» id|body|string|false|none|
+|»»» name|body|string|false|none|
+|»»» path|body|string|false|none|
+|»»» thumbnail|body|string|false|none|
+|»»» mime|body|string|false|none|
+|»»» extId|body|string|false|none|
+|»»» extMetadata|body|object|false|none|
+|»»» messageId|body|string|false|none|
+|» meta|body|[[MetaPartial](#schemametapartial)]|false|[(tsType: PartialResponses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|Message is forwarded to another recipient|None|
+|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|Message identity does not exist.|None|
+|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden request due to unauthorized token in header.|None|
+
+Response Schema
+
+
+This operation does not require authentication
+
+
+## API provides interface to reply to a single message
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|threadId|path|string|true|none|
+|messageId|path|string|true|none|
+|replyAll|query|boolean|false|none|
+|body|body|object|false|none|
+|» attachments|body|[[AttachmentPartial](#schemaattachmentpartial)]|false|[(tsType: Partial, schemaOptions: { partial: true })]|
+|»» AttachmentPartial|body|[AttachmentPartial](#schemaattachmentpartial)|false|(tsType: Partial, schemaOptions: { partial: true })|
+|»»» deleted|body|boolean|false|none|
+|»»» deletedOn|body|string(date-time)¦null|false|none|
+|»»» deletedBy|body|string¦null|false|none|
+|»»» createdOn|body|string(date-time)|false|none|
+|»»» modifiedOn|body|string(date-time)|false|none|
+|»»» createdBy|body|string|false|none|
+|»»» modifiedBy|body|string|false|none|
+|»»» id|body|string|false|none|
+|»»» name|body|string|false|none|
+|»»» path|body|string|false|none|
+|»»» thumbnail|body|string|false|none|
+|»»» mime|body|string|false|none|
+|»»» extId|body|string|false|none|
+|»»» extMetadata|body|object|false|none|
+|»»» messageId|body|string|false|none|
+|» meta|body|[[MetaPartial](#schemametapartial)]|false|[(tsType: PartialResponses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Message is replied back to the sender|None|
+
+
+This operation does not require authentication
+
+
+# Schemas
+
+idResponse
+
+composeMailBody
+
+, schemaOptions: { partial: true })]|
+|attachments|[[AttachmentPartial](#schemaattachmentpartial)]|false|none|[(tsType: Partial, schemaOptions: { partial: true })]|
+|meta|[[MetaPartial](#schemametapartial)]|false|none|[(tsType: PartialAttachment
+
+AttachmentPartial
+
+IdArraysPartial
+
+IdArrays
+
+GroupPartial
+
+Attachment add response schema
+
+AttachmentExcluding_deleted_WithRelations
+
+, schemaOptions: { exclude: [ 'deleted' ], includeRelations: true })|
+
+ThreadExcluding_deleted_WithRelations
+
+, schemaOptions: { exclude: [ 'deleted' ], includeRelations: true })]|
+|group|[[GroupExcluding_deleted_WithRelations](#schemagroupexcluding_deleted_withrelations)]|false|none|[(tsType: Omit, schemaOptions: { exclude: [ 'deleted' ], includeRelations: true })]|
+
+GroupExcluding_deleted_WithRelations
+
+, schemaOptions: { exclude: [ 'deleted' ], includeRelations: true })|
+|thread|[ThreadExcluding_deleted_WithRelations](#schemathreadexcluding_deleted_withrelations)|false|none|(tsType: Omit, schemaOptions: { exclude: [ 'deleted' ], includeRelations: true })|
+
+#### Enumerated Values
+
+|Property|Value|
+|---|---|
+|type|from|
+|type|to|
+|type|cc|
+|type|bcc|
+|storage|draft|
+|storage|send|
+|storage|inbox|
+|storage|trash|
+|visibility|read|
+|visibility|new|
+|visibility|unread|
+|visibility|important|
+|visibility|not-important|
+
+
+
+, schemaOptions: { exclude: [ 'deleted' ], includeRelations: true })|
+
+MessageExcluding_deleted_WithRelations
+
+, schemaOptions: { exclude: [ 'deleted' ], includeRelations: true })]|
+|group|[[GroupExcluding_deleted_WithRelations](#schemagroupexcluding_deleted_withrelations)]|false|none|[(tsType: Omit, schemaOptions: { exclude: [ 'deleted' ], includeRelations: true })]|
+|meta|[[MetaExcluding_deleted_WithRelations](#schemametaexcluding_deleted_withrelations)]|false|none|[(tsType: Omit, schemaOptions: { exclude: [ 'deleted' ], includeRelations: true })]|
+|thread|[ThreadExcluding_deleted_WithRelations](#schemathreadexcluding_deleted_withrelations)|false|none|(tsType: Omit, schemaOptions: { exclude: [ 'deleted' ], includeRelations: true })|
+
+#### Enumerated Values
+
+|Property|Value|
+|---|---|
+|status|draft|
+|status|send|
+
+Message
+
+PingResponse
+
+Thread
+
+Notification Service v1.0.0
+
+> Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
+
+sandbox
+
+Base URLs:
+
+* http://localhost:3000
+
+# Authentication
+
+- HTTP Authentication, scheme: bearer
+
+NotificationUserController
+
+## NotificationUserController.createAll
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|body|body|[NewNotificationUser](#schemanewnotificationuser)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "id": "string",
+ "notificationId": "string",
+ "userId": "string",
+ "isRead": true,
+ "actionMeta": {}
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Notification User model instance|[NotificationUser](#schemanotificationuser)|
+
+
+This operation does not require authentication
+
+
+## NotificationUserController.count
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|where|query|object|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "count": 0
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|NotificationUser model count|[loopback.Count](#schemaloopback.count)|
+
+
+This operation does not require authentication
+
+
+## NotificationUserController.deleteAllHard
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|where|query|object|false|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|Notification DELETE success|None|
+
+
+This operation does not require authentication
+
+
+## NotificationUserController.replaceById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|body|body|[NotificationUser](#schemanotificationuser)|false|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|NotificationUser PUT success|None|
+
+
+This operation does not require authentication
+
+
+## NotificationUserController.updateById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|body|body|[NotificationUserPartial](#schemanotificationuserpartial)|false|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|NotificationUser PATCH success|None|
+
+
+This operation does not require authentication
+
+
+## NotificationUserController.findById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "id": "string",
+ "notificationId": "string",
+ "userId": "string",
+ "isRead": true,
+ "actionMeta": {}
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|NotificationUser instance|[NotificationUser](#schemanotificationuser)|
+
+
+This operation does not require authentication
+
+
+## NotificationUserController.deleteById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|NotificationUser DELETE success|None|
+
+
+This operation does not require authentication
+
+
+## NotificationUserController.create
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|body|body|[NewNotificationUser](#schemanewnotificationuser)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "id": "string",
+ "notificationId": "string",
+ "userId": "string",
+ "isRead": true,
+ "actionMeta": {}
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|NotificationUser model instance|[NotificationUser](#schemanotificationuser)|
+
+
+This operation does not require authentication
+
+
+## NotificationUserController.updateAll
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|where|query|object|false|none|
+|body|body|[NotificationUserPartial](#schemanotificationuserpartial)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "count": 0
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|NotificationUser PATCH success count|[loopback.Count](#schemaloopback.count)|
+
+
+This operation does not require authentication
+
+
+## NotificationUserController.find
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|filter|query|[notification_users.Filter](#schemanotification_users.filter)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+[
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "id": "string",
+ "notificationId": "string",
+ "userId": "string",
+ "isRead": true,
+ "actionMeta": {}
+ }
+]
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Array of NotificationUser model instances|Inline|
+
+Response Schema
+
+Status Code **200**
+
+|Name|Type|Required|Restrictions|Description|
+|---|---|---|---|---|
+|*anonymous*|[[NotificationUser](#schemanotificationuser)]|false|none|none|
+|» NotificationUser|[NotificationUser](#schemanotificationuser)|false|none|none|
+|»» deleted|boolean|false|none|none|
+|»» deletedOn|string(date-time)¦null|false|none|none|
+|»» deletedBy|string¦null|false|none|none|
+|»» createdOn|string(date-time)|false|none|none|
+|»» modifiedOn|string(date-time)|false|none|none|
+|»» id|string|false|none|none|
+|»» notificationId|string|true|none|none|
+|»» userId|string|true|none|none|
+|»» isRead|boolean|false|none|none|
+|»» actionMeta|object|false|none|none|
+
+
+This operation does not require authentication
+
+
+## NotificationUserController.deleteAll
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|where|query|object|false|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|Notification DELETE success|None|
+
+
+This operation does not require authentication
+
+
+NotificationUserNotificationController
+
+## NotificationUserNotificationController.getNotification
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+[
+ {
+ "id": "string",
+ "subject": "string",
+ "body": "string",
+ "receiver": {},
+ "type": 0,
+ "sentDate": "2019-08-24T14:15:22Z",
+ "options": {}
+ }
+]
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Notification belonging to NotificationUser|Inline|
+
+Response Schema
+
+Status Code **200**
+
+|Name|Type|Required|Restrictions|Description|
+|---|---|---|---|---|
+|*anonymous*|[[Notification](#schemanotification)]|false|none|none|
+|» Notification|[Notification](#schemanotification)|false|none|none|
+|»» id|string|false|none|none|
+|»» subject|string¦null|false|none|none|
+|»» body|string|true|none|none|
+|»» receiver|object|true|none|none|
+|»» type|number|true|none|none|
+|»» sentDate|string(date-time)|false|none|none|
+|»» options|object|false|none|none|
+
+
+This operation does not require authentication
+
+
+PubnubNotificationController
+
+## PubnubNotificationController.grantAccess
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|Authorization|header|string|false|none|
+|pubnubToken|header|string|true|none|
+|body|body|[NotificationAccess](#schemanotificationaccess)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "ttl": 0,
+ "cipherKey": "string"
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Access response|[AccessResponseDto](#schemaaccessresponsedto)|
+
+
+This operation does not require authentication
+
+
+## PubnubNotificationController.revokeAccess
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Object with success|None|
+
+
+This operation does not require authentication
+
+
+NotificationController
+
+## NotificationController.createBulkNotificaitions
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|body|body|[NotificationExcluding_id_](#schemanotificationexcluding_id_)|false|none|
+
+> Example responses
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Array of Notifications|None|
+
+Response Schema
+
+
+This operation does not require authentication
+
+
+## NotificationController.count
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|where|query|object|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "count": 0
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Notification model count|[loopback.Count](#schemaloopback.count)|
+
+
+This operation does not require authentication
+
+
+## NotificationController.findById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "id": "string",
+ "subject": "string",
+ "body": "string",
+ "receiver": {},
+ "type": 0,
+ "sentDate": "2019-08-24T14:15:22Z",
+ "options": {}
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Notification model instance|[Notification](#schemanotification)|
+
+
+This operation does not require authentication
+
+
+## NotificationController.create
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|body|body|[NotificationExcluding_id_](#schemanotificationexcluding_id_)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "id": "string",
+ "subject": "string",
+ "body": "string",
+ "receiver": {},
+ "type": 0,
+ "sentDate": "2019-08-24T14:15:22Z",
+ "options": {}
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Notification model instance|[Notification](#schemanotification)|
+
+
+This operation does not require authentication
+
+
+## NotificationController.find
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|filter|query|[notifications.Filter](#schemanotifications.filter)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+[
+ {
+ "id": "string",
+ "subject": "string",
+ "body": "string",
+ "receiver": {},
+ "type": 0,
+ "sentDate": "2019-08-24T14:15:22Z",
+ "options": {}
+ }
+]
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Array of Notification model instances|Inline|
+
+Response Schema
+
+Status Code **200**
+
+|Name|Type|Required|Restrictions|Description|
+|---|---|---|---|---|
+|*anonymous*|[[Notification](#schemanotification)]|false|none|none|
+|» Notification|[Notification](#schemanotification)|false|none|none|
+|»» id|string|false|none|none|
+|»» subject|string¦null|false|none|none|
+|»» body|string|true|none|none|
+|»» receiver|object|true|none|none|
+|»» type|number|true|none|none|
+|»» sentDate|string(date-time)|false|none|none|
+|»» options|object|false|none|none|
+
+
+This operation does not require authentication
+
+
+## NotificationController.deleteAll
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|where|query|object|false|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|Notification DELETE success|None|
+
+
+This operation does not require authentication
+
+
+NotificationNotificationUserController
+
+## NotificationNotificationUserController.create
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|body|body|[NewNotificationUserInNotification](#schemanewnotificationuserinnotification)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "id": "string",
+ "notificationId": "string",
+ "userId": "string",
+ "isRead": true,
+ "actionMeta": {}
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Notification model instance|[NotificationUser](#schemanotificationuser)|
+
+
+This operation does not require authentication
+
+
+## NotificationNotificationUserController.patch
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|where|query|object|false|none|
+|body|body|[NotificationUserPartial](#schemanotificationuserpartial)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "count": 0
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Notification.NotificationUser PATCH success count|[loopback.Count](#schemaloopback.count)|
+
+
+This operation does not require authentication
+
+
+## NotificationNotificationUserController.find
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|filter|query|object|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+[
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "id": "string",
+ "notificationId": "string",
+ "userId": "string",
+ "isRead": true,
+ "actionMeta": {}
+ }
+]
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Array of Notification has many NotificationUser|Inline|
+
+Response Schema
+
+Status Code **200**
+
+|Name|Type|Required|Restrictions|Description|
+|---|---|---|---|---|
+|*anonymous*|[[NotificationUser](#schemanotificationuser)]|false|none|none|
+|» NotificationUser|[NotificationUser](#schemanotificationuser)|false|none|none|
+|»» deleted|boolean|false|none|none|
+|»» deletedOn|string(date-time)¦null|false|none|none|
+|»» deletedBy|string¦null|false|none|none|
+|»» createdOn|string(date-time)|false|none|none|
+|»» modifiedOn|string(date-time)|false|none|none|
+|»» id|string|false|none|none|
+|»» notificationId|string|true|none|none|
+|»» userId|string|true|none|none|
+|»» isRead|boolean|false|none|none|
+|»» actionMeta|object|false|none|none|
+
+
+This operation does not require authentication
+
+
+## NotificationNotificationUserController.delete
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|where|query|object|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "count": 0
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Notification.NotificationUser DELETE success count|[loopback.Count](#schemaloopback.count)|
+
+
+This operation does not require authentication
+
+
+PingController
+
+## PingController.ping
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Ping Response|[PingResponse](#schemapingresponse)|
+
+
+This operation does not require authentication
+
+
+HomePageController
+
+## HomePageController.homePage
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Home Page|string|
+
+
+This operation does not require authentication
+
+
+# Schemas
+
+Notification
+
+NotificationExcluding_id_
+
+NotificationUser
+
+NewNotificationUser
+
+NotificationUserPartial
+
+AccessResponseDto
+
+NotificationAccess
+
+NewNotificationUserInNotification
+
+loopback.Count
+
+notification_users.ScopeFilter
+
+notification_users.IncludeFilter.Items
+
+notification_users.Filter
+
+notifications.ScopeFilter
+
+notifications.IncludeFilter.Items
+
+notifications.Filter
+
+PingResponse
+
+Scheduler Service v1.0.0
+
+> Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
+
+scheduler-example
+
+Base URLs:
+
+* http://localhost:3000
+
+
+# Authentication
+
+- HTTP Authentication, scheme: bearer
+
+AttachmentController
+
+## AttachmentController.count
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|where|query|object|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "count": 0
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Attachment model count|[loopback.Count](#schemaloopback.count)|
+
+
+This operation does not require authentication
+
+
+## AttachmentController.replaceById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|body|body|[Attachment](#schemaattachment)|false|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|Attachment PUT success|None|
+
+
+This operation does not require authentication
+
+
+## AttachmentController.updateById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|body|body|[AttachmentPartial](#schemaattachmentpartial)|false|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|Attachment PATCH success|None|
+
+
+This operation does not require authentication
+
+
+## AttachmentController.findById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|filter|query|[attachments.Filter](#schemaattachments.filter)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "fileUrl": "string",
+ "iconLink": "string",
+ "mimeType": "string",
+ "title": "string",
+ "eventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "event": {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "bgColor": "string",
+ "description": "string",
+ "endDateTime": "2019-08-24T14:15:22Z",
+ "fgColor": "string",
+ "iCalUid": "string",
+ "isFullDayEvent": true,
+ "isLocked": true,
+ "link": "string",
+ "location": "string",
+ "meetingLink": "string",
+ "identifier": "string",
+ "startDateTime": "2019-08-24T14:15:22Z",
+ "status": "confirmed",
+ "summary": "string",
+ "timezone": "string",
+ "calendarId": "string",
+ "parentEventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "source": "string",
+ "enableWorkingHours": true,
+ "location": "string",
+ "identifier": "string",
+ "summary": "string",
+ "timezone": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "events": [
+ {}
+ ],
+ "workingHours": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "dayOfWeek": 0,
+ "end": "string",
+ "start": "string",
+ "calendarId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {}
+ }
+ ],
+ "subscriptions": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "accessRole": "freeBusyReader",
+ "bgColor": "string",
+ "fgColor": "string",
+ "isHidden": true,
+ "isPrimary": true,
+ "identifier": "string",
+ "defaultReminders": {},
+ "notificationSettings": {},
+ "calendarId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {}
+ }
+ ]
+ },
+ "parentEvent": {},
+ "attendees": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "identifier": "string",
+ "isOptional": true,
+ "isOrganizer": true,
+ "messages": "string",
+ "responseStatus": "needsAction",
+ "eventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "event": {}
+ }
+ ],
+ "attachments": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "fileUrl": "string",
+ "iconLink": "string",
+ "mimeType": "string",
+ "title": "string",
+ "eventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "event": {}
+ }
+ ]
+ }
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Attachment model instance|[AttachmentWithRelations](#schemaattachmentwithrelations)|
+
+
+This operation does not require authentication
+
+
+## AttachmentController.deleteById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|Attachment DELETE success|None|
+
+
+This operation does not require authentication
+
+
+## AttachmentController.create
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|body|body|[NewAttachment](#schemanewattachment)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "fileUrl": "string",
+ "iconLink": "string",
+ "mimeType": "string",
+ "title": "string",
+ "eventId": "string",
+ "extId": "string",
+ "extMetadata": {}
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Attachment model instance|[Attachment](#schemaattachment)|
+
+
+This operation does not require authentication
+
+
+## AttachmentController.updateAll
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|where|query|object|false|none|
+|body|body|[AttachmentPartial](#schemaattachmentpartial)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "count": 0
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Attachment PATCH success count|[loopback.Count](#schemaloopback.count)|
+
+
+This operation does not require authentication
+
+
+## AttachmentController.find
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|filter|query|[attachments.Filter1](#schemaattachments.filter1)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+[
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "fileUrl": "string",
+ "iconLink": "string",
+ "mimeType": "string",
+ "title": "string",
+ "eventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "event": {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "bgColor": "string",
+ "description": "string",
+ "endDateTime": "2019-08-24T14:15:22Z",
+ "fgColor": "string",
+ "iCalUid": "string",
+ "isFullDayEvent": true,
+ "isLocked": true,
+ "link": "string",
+ "location": "string",
+ "meetingLink": "string",
+ "identifier": "string",
+ "startDateTime": "2019-08-24T14:15:22Z",
+ "status": "confirmed",
+ "summary": "string",
+ "timezone": "string",
+ "calendarId": "string",
+ "parentEventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "source": "string",
+ "enableWorkingHours": true,
+ "location": "string",
+ "identifier": "string",
+ "summary": "string",
+ "timezone": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "events": [
+ {}
+ ],
+ "workingHours": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "dayOfWeek": 0,
+ "end": "string",
+ "start": "string",
+ "calendarId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {}
+ }
+ ],
+ "subscriptions": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "accessRole": "freeBusyReader",
+ "bgColor": "string",
+ "fgColor": "string",
+ "isHidden": true,
+ "isPrimary": true,
+ "identifier": "string",
+ "defaultReminders": {},
+ "notificationSettings": {},
+ "calendarId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {}
+ }
+ ]
+ },
+ "parentEvent": {},
+ "attendees": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "identifier": "string",
+ "isOptional": true,
+ "isOrganizer": true,
+ "messages": "string",
+ "responseStatus": "needsAction",
+ "eventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "event": {}
+ }
+ ],
+ "attachments": [
+ {}
+ ]
+ }
+ }
+]
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Array of Attachment model instances|Inline|
+
+Response Schema
+
+Status Code **200**
+
+|Name|Type|Required|Restrictions|Description|
+|---|---|---|---|---|
+|*anonymous*|[[AttachmentWithRelations](#schemaattachmentwithrelations)]|false|none|[(tsType: AttachmentWithRelations, schemaOptions: { includeRelations: true })]|
+|» AttachmentWithRelations|[AttachmentWithRelations](#schemaattachmentwithrelations)|false|none|(tsType: AttachmentWithRelations, schemaOptions: { includeRelations: true })|
+|»» deleted|boolean|false|none|none|
+|»» deletedOn|string(date-time)¦null|false|none|none|
+|»» deletedBy|string¦null|false|none|none|
+|»» createdOn|string(date-time)|false|none|none|
+|»» modifiedOn|string(date-time)|false|none|none|
+|»» createdBy|string|false|none|none|
+|»» modifiedBy|string|false|none|none|
+|»» id|string|false|none|none|
+|»» fileUrl|string|true|none|none|
+|»» iconLink|string|false|none|none|
+|»» mimeType|string|false|none|none|
+|»» title|string|false|none|none|
+|»» eventId|string|true|none|none|
+|»» extId|string|false|none|none|
+|»» extMetadata|object|false|none|none|
+|»» event|[EventWithRelations](#schemaeventwithrelations)|false|none|(tsType: EventWithRelations, schemaOptions: { includeRelations: true })|
+|»»» deleted|boolean|false|none|none|
+|»»» deletedOn|string(date-time)¦null|false|none|none|
+|»»» deletedBy|string¦null|false|none|none|
+|»»» createdOn|string(date-time)|false|none|none|
+|»»» modifiedOn|string(date-time)|false|none|none|
+|»»» createdBy|string|false|none|none|
+|»»» modifiedBy|string|false|none|none|
+|»»» id|string|false|none|none|
+|»»» bgColor|string|false|none|none|
+|»»» description|string|false|none|none|
+|»»» endDateTime|string(date-time)|false|none|none|
+|»»» fgColor|string|false|none|none|
+|»»» iCalUid|string|false|none|none|
+|»»» isFullDayEvent|boolean|false|none|none|
+|»»» isLocked|boolean|false|none|none|
+|»»» link|string|false|none|none|
+|»»» location|string|false|none|none|
+|»»» meetingLink|string|false|none|none|
+|»»» identifier|string|false|none|none|
+|»»» startDateTime|string(date-time)|false|none|none|
+|»»» status|string|false|none|none|
+|»»» summary|string|false|none|none|
+|»»» timezone|string|false|none|none|
+|»»» calendarId|string|true|none|none|
+|»»» parentEventId|string|false|none|none|
+|»»» extId|string|false|none|none|
+|»»» extMetadata|object|false|none|none|
+|»»» calendar|[CalendarWithRelations](#schemacalendarwithrelations)|false|none|(tsType: CalendarWithRelations, schemaOptions: { includeRelations: true })|
+|»»»» deleted|boolean|false|none|none|
+|»»»» deletedOn|string(date-time)¦null|false|none|none|
+|»»»» deletedBy|string¦null|false|none|none|
+|»»»» createdOn|string(date-time)|false|none|none|
+|»»»» modifiedOn|string(date-time)|false|none|none|
+|»»»» createdBy|string|false|none|none|
+|»»»» modifiedBy|string|false|none|none|
+|»»»» id|string|false|none|none|
+|»»»» source|string|false|none|none|
+|»»»» enableWorkingHours|boolean|false|none|none|
+|»»»» location|string|false|none|none|
+|»»»» identifier|string|true|none|none|
+|»»»» summary|string|false|none|none|
+|»»»» timezone|string|false|none|none|
+|»»»» extId|string|false|none|none|
+|»»»» extMetadata|object|false|none|none|
+|»»»» events|[[EventWithRelations](#schemaeventwithrelations)]|false|none|(tsType: EventWithRelations, schemaOptions: { includeRelations: true })|
+|»»»»» EventWithRelations|[EventWithRelations](#schemaeventwithrelations)|false|none|(tsType: EventWithRelations, schemaOptions: { includeRelations: true })|
+|»»»» workingHours|[[WorkingHourWithRelations](#schemaworkinghourwithrelations)]|false|none|(tsType: WorkingHourWithRelations, schemaOptions: { includeRelations: true })|
+|»»»»» WorkingHourWithRelations|[WorkingHourWithRelations](#schemaworkinghourwithrelations)|false|none|(tsType: WorkingHourWithRelations, schemaOptions: { includeRelations: true })|
+|»»»»»» deleted|boolean|false|none|none|
+|»»»»»» deletedOn|string(date-time)¦null|false|none|none|
+|»»»»»» deletedBy|string¦null|false|none|none|
+|»»»»»» createdOn|string(date-time)|false|none|none|
+|»»»»»» modifiedOn|string(date-time)|false|none|none|
+|»»»»»» createdBy|string|false|none|none|
+|»»»»»» modifiedBy|string|false|none|none|
+|»»»»»» id|string|false|none|none|
+|»»»»»» dayOfWeek|number|false|none|none|
+|»»»»»» end|string|false|none|none|
+|»»»»»» start|string|false|none|none|
+|»»»»»» calendarId|string|true|none|none|
+|»»»»»» extId|string|false|none|none|
+|»»»»»» extMetadata|object|false|none|none|
+|»»»»»» calendar|[CalendarWithRelations](#schemacalendarwithrelations)|false|none|(tsType: CalendarWithRelations, schemaOptions: { includeRelations: true })|
+|»»»» subscriptions|[[SubscriptionWithRelations](#schemasubscriptionwithrelations)]|false|none|(tsType: SubscriptionWithRelations, schemaOptions: { includeRelations: true })|
+|»»»»» SubscriptionWithRelations|[SubscriptionWithRelations](#schemasubscriptionwithrelations)|false|none|(tsType: SubscriptionWithRelations, schemaOptions: { includeRelations: true })|
+|»»»»»» deleted|boolean|false|none|none|
+|»»»»»» deletedOn|string(date-time)¦null|false|none|none|
+|»»»»»» deletedBy|string¦null|false|none|none|
+|»»»»»» createdOn|string(date-time)|false|none|none|
+|»»»»»» modifiedOn|string(date-time)|false|none|none|
+|»»»»»» createdBy|string|false|none|none|
+|»»»»»» modifiedBy|string|false|none|none|
+|»»»»»» id|string|false|none|none|
+|»»»»»» accessRole|string|false|none|none|
+|»»»»»» bgColor|string|false|none|none|
+|»»»»»» fgColor|string|false|none|none|
+|»»»»»» isHidden|boolean|false|none|none|
+|»»»»»» isPrimary|boolean|false|none|none|
+|»»»»»» identifier|string|true|none|none|
+|»»»»»» defaultReminders|object|false|none|none|
+|»»»»»» notificationSettings|object|false|none|none|
+|»»»»»» calendarId|string|true|none|none|
+|»»»»»» extId|string|false|none|none|
+|»»»»»» extMetadata|object|false|none|none|
+|»»»»»» calendar|[CalendarWithRelations](#schemacalendarwithrelations)|false|none|(tsType: CalendarWithRelations, schemaOptions: { includeRelations: true })|
+|»»» parentEvent|[EventWithRelations](#schemaeventwithrelations)|false|none|(tsType: EventWithRelations, schemaOptions: { includeRelations: true })|
+|»»» attendees|[[AttendeeWithRelations](#schemaattendeewithrelations)]|false|none|(tsType: AttendeeWithRelations, schemaOptions: { includeRelations: true })|
+|»»»» AttendeeWithRelations|[AttendeeWithRelations](#schemaattendeewithrelations)|false|none|(tsType: AttendeeWithRelations, schemaOptions: { includeRelations: true })|
+|»»»»» deleted|boolean|false|none|none|
+|»»»»» deletedOn|string(date-time)¦null|false|none|none|
+|»»»»» deletedBy|string¦null|false|none|none|
+|»»»»» createdOn|string(date-time)|false|none|none|
+|»»»»» modifiedOn|string(date-time)|false|none|none|
+|»»»»» createdBy|string|false|none|none|
+|»»»»» modifiedBy|string|false|none|none|
+|»»»»» id|string|false|none|none|
+|»»»»» identifier|string|true|none|none|
+|»»»»» isOptional|boolean|false|none|none|
+|»»»»» isOrganizer|boolean|false|none|none|
+|»»»»» messages|string|false|none|none|
+|»»»»» responseStatus|string|false|none|none|
+|»»»»» eventId|string|true|none|none|
+|»»»»» extId|string|false|none|none|
+|»»»»» extMetadata|object|false|none|none|
+|»»»»» event|[EventWithRelations](#schemaeventwithrelations)|false|none|(tsType: EventWithRelations, schemaOptions: { includeRelations: true })|
+|»»» attachments|[[AttachmentWithRelations](#schemaattachmentwithrelations)]|false|none|(tsType: AttachmentWithRelations, schemaOptions: { includeRelations: true })|
+|»»»» AttachmentWithRelations|[AttachmentWithRelations](#schemaattachmentwithrelations)|false|none|(tsType: AttachmentWithRelations, schemaOptions: { includeRelations: true })|
+
+#### Enumerated Values
+
+|Property|Value|
+|---|---|
+|status|confirmed|
+|status|tentative|
+|status|cancelled|
+|status|completed|
+|dayOfWeek|0|
+|dayOfWeek|1|
+|dayOfWeek|2|
+|dayOfWeek|3|
+|dayOfWeek|4|
+|dayOfWeek|5|
+|dayOfWeek|6|
+|accessRole|freeBusyReader|
+|accessRole|reader|
+|accessRole|writer|
+|accessRole|owner|
+|responseStatus|needsAction|
+|responseStatus|tentative|
+|responseStatus|accepted|
+|responseStatus|declined|
+
+
+This operation does not require authentication
+
+
+AttendeeController
+
+## AttendeeController.count
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|where|query|object|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "count": 0
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Attendee model count|[loopback.Count](#schemaloopback.count)|
+
+
+This operation does not require authentication
+
+
+## AttendeeController.replaceById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|body|body|[Attendee](#schemaattendee)|false|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|Attendee PUT success|None|
+
+
+This operation does not require authentication
+
+
+## AttendeeController.updateById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|body|body|[AttendeePartial](#schemaattendeepartial)|false|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|Attendee PATCH success|None|
+
+
+This operation does not require authentication
+
+
+## AttendeeController.findById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|filter|query|[attendees.Filter](#schemaattendees.filter)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "identifier": "string",
+ "isOptional": true,
+ "isOrganizer": true,
+ "messages": "string",
+ "responseStatus": "needsAction",
+ "eventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "event": {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "bgColor": "string",
+ "description": "string",
+ "endDateTime": "2019-08-24T14:15:22Z",
+ "fgColor": "string",
+ "iCalUid": "string",
+ "isFullDayEvent": true,
+ "isLocked": true,
+ "link": "string",
+ "location": "string",
+ "meetingLink": "string",
+ "identifier": "string",
+ "startDateTime": "2019-08-24T14:15:22Z",
+ "status": "confirmed",
+ "summary": "string",
+ "timezone": "string",
+ "calendarId": "string",
+ "parentEventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "source": "string",
+ "enableWorkingHours": true,
+ "location": "string",
+ "identifier": "string",
+ "summary": "string",
+ "timezone": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "events": [
+ {}
+ ],
+ "workingHours": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "dayOfWeek": 0,
+ "end": "string",
+ "start": "string",
+ "calendarId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {}
+ }
+ ],
+ "subscriptions": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "accessRole": "freeBusyReader",
+ "bgColor": "string",
+ "fgColor": "string",
+ "isHidden": true,
+ "isPrimary": true,
+ "identifier": "string",
+ "defaultReminders": {},
+ "notificationSettings": {},
+ "calendarId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {}
+ }
+ ]
+ },
+ "parentEvent": {},
+ "attendees": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "identifier": "string",
+ "isOptional": true,
+ "isOrganizer": true,
+ "messages": "string",
+ "responseStatus": "needsAction",
+ "eventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "event": {}
+ }
+ ],
+ "attachments": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "fileUrl": "string",
+ "iconLink": "string",
+ "mimeType": "string",
+ "title": "string",
+ "eventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "event": {}
+ }
+ ]
+ }
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Attendee model instance|[AttendeeWithRelations](#schemaattendeewithrelations)|
+
+
+This operation does not require authentication
+
+
+## AttendeeController.deleteById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|Attendee DELETE success|None|
+
+
+This operation does not require authentication
+
+
+## AttendeeController.create
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|body|body|[NewAttendee](#schemanewattendee)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "identifier": "string",
+ "isOptional": true,
+ "isOrganizer": true,
+ "messages": "string",
+ "responseStatus": "needsAction",
+ "eventId": "string",
+ "extId": "string",
+ "extMetadata": {}
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Attendee model instance|[Attendee](#schemaattendee)|
+
+
+This operation does not require authentication
+
+
+## AttendeeController.updateAll
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|where|query|object|false|none|
+|body|body|[AttendeePartial](#schemaattendeepartial)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "count": 0
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Attendee PATCH success count|[loopback.Count](#schemaloopback.count)|
+
+
+This operation does not require authentication
+
+
+## AttendeeController.find
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|filter|query|[attendees.Filter1](#schemaattendees.filter1)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+[
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "identifier": "string",
+ "isOptional": true,
+ "isOrganizer": true,
+ "messages": "string",
+ "responseStatus": "needsAction",
+ "eventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "event": {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "bgColor": "string",
+ "description": "string",
+ "endDateTime": "2019-08-24T14:15:22Z",
+ "fgColor": "string",
+ "iCalUid": "string",
+ "isFullDayEvent": true,
+ "isLocked": true,
+ "link": "string",
+ "location": "string",
+ "meetingLink": "string",
+ "identifier": "string",
+ "startDateTime": "2019-08-24T14:15:22Z",
+ "status": "confirmed",
+ "summary": "string",
+ "timezone": "string",
+ "calendarId": "string",
+ "parentEventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "source": "string",
+ "enableWorkingHours": true,
+ "location": "string",
+ "identifier": "string",
+ "summary": "string",
+ "timezone": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "events": [
+ {}
+ ],
+ "workingHours": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "dayOfWeek": 0,
+ "end": "string",
+ "start": "string",
+ "calendarId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {}
+ }
+ ],
+ "subscriptions": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "accessRole": "freeBusyReader",
+ "bgColor": "string",
+ "fgColor": "string",
+ "isHidden": true,
+ "isPrimary": true,
+ "identifier": "string",
+ "defaultReminders": {},
+ "notificationSettings": {},
+ "calendarId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {}
+ }
+ ]
+ },
+ "parentEvent": {},
+ "attendees": [
+ {}
+ ],
+ "attachments": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "fileUrl": "string",
+ "iconLink": "string",
+ "mimeType": "string",
+ "title": "string",
+ "eventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "event": {}
+ }
+ ]
+ }
+ }
+]
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Array of Attendee model instances|Inline|
+
+Response Schema
+
+Status Code **200**
+
+|Name|Type|Required|Restrictions|Description|
+|---|---|---|---|---|
+|*anonymous*|[[AttendeeWithRelations](#schemaattendeewithrelations)]|false|none|[(tsType: AttendeeWithRelations, schemaOptions: { includeRelations: true })]|
+|» AttendeeWithRelations|[AttendeeWithRelations](#schemaattendeewithrelations)|false|none|(tsType: AttendeeWithRelations, schemaOptions: { includeRelations: true })|
+|»» deleted|boolean|false|none|none|
+|»» deletedOn|string(date-time)¦null|false|none|none|
+|»» deletedBy|string¦null|false|none|none|
+|»» createdOn|string(date-time)|false|none|none|
+|»» modifiedOn|string(date-time)|false|none|none|
+|»» createdBy|string|false|none|none|
+|»» modifiedBy|string|false|none|none|
+|»» id|string|false|none|none|
+|»» identifier|string|true|none|none|
+|»» isOptional|boolean|false|none|none|
+|»» isOrganizer|boolean|false|none|none|
+|»» messages|string|false|none|none|
+|»» responseStatus|string|false|none|none|
+|»» eventId|string|true|none|none|
+|»» extId|string|false|none|none|
+|»» extMetadata|object|false|none|none|
+|»» event|[EventWithRelations](#schemaeventwithrelations)|false|none|(tsType: EventWithRelations, schemaOptions: { includeRelations: true })|
+|»»» deleted|boolean|false|none|none|
+|»»» deletedOn|string(date-time)¦null|false|none|none|
+|»»» deletedBy|string¦null|false|none|none|
+|»»» createdOn|string(date-time)|false|none|none|
+|»»» modifiedOn|string(date-time)|false|none|none|
+|»»» createdBy|string|false|none|none|
+|»»» modifiedBy|string|false|none|none|
+|»»» id|string|false|none|none|
+|»»» bgColor|string|false|none|none|
+|»»» description|string|false|none|none|
+|»»» endDateTime|string(date-time)|false|none|none|
+|»»» fgColor|string|false|none|none|
+|»»» iCalUid|string|false|none|none|
+|»»» isFullDayEvent|boolean|false|none|none|
+|»»» isLocked|boolean|false|none|none|
+|»»» link|string|false|none|none|
+|»»» location|string|false|none|none|
+|»»» meetingLink|string|false|none|none|
+|»»» identifier|string|false|none|none|
+|»»» startDateTime|string(date-time)|false|none|none|
+|»»» status|string|false|none|none|
+|»»» summary|string|false|none|none|
+|»»» timezone|string|false|none|none|
+|»»» calendarId|string|true|none|none|
+|»»» parentEventId|string|false|none|none|
+|»»» extId|string|false|none|none|
+|»»» extMetadata|object|false|none|none|
+|»»» calendar|[CalendarWithRelations](#schemacalendarwithrelations)|false|none|(tsType: CalendarWithRelations, schemaOptions: { includeRelations: true })|
+|»»»» deleted|boolean|false|none|none|
+|»»»» deletedOn|string(date-time)¦null|false|none|none|
+|»»»» deletedBy|string¦null|false|none|none|
+|»»»» createdOn|string(date-time)|false|none|none|
+|»»»» modifiedOn|string(date-time)|false|none|none|
+|»»»» createdBy|string|false|none|none|
+|»»»» modifiedBy|string|false|none|none|
+|»»»» id|string|false|none|none|
+|»»»» source|string|false|none|none|
+|»»»» enableWorkingHours|boolean|false|none|none|
+|»»»» location|string|false|none|none|
+|»»»» identifier|string|true|none|none|
+|»»»» summary|string|false|none|none|
+|»»»» timezone|string|false|none|none|
+|»»»» extId|string|false|none|none|
+|»»»» extMetadata|object|false|none|none|
+|»»»» events|[[EventWithRelations](#schemaeventwithrelations)]|false|none|(tsType: EventWithRelations, schemaOptions: { includeRelations: true })|
+|»»»»» EventWithRelations|[EventWithRelations](#schemaeventwithrelations)|false|none|(tsType: EventWithRelations, schemaOptions: { includeRelations: true })|
+|»»»» workingHours|[[WorkingHourWithRelations](#schemaworkinghourwithrelations)]|false|none|(tsType: WorkingHourWithRelations, schemaOptions: { includeRelations: true })|
+|»»»»» WorkingHourWithRelations|[WorkingHourWithRelations](#schemaworkinghourwithrelations)|false|none|(tsType: WorkingHourWithRelations, schemaOptions: { includeRelations: true })|
+|»»»»»» deleted|boolean|false|none|none|
+|»»»»»» deletedOn|string(date-time)¦null|false|none|none|
+|»»»»»» deletedBy|string¦null|false|none|none|
+|»»»»»» createdOn|string(date-time)|false|none|none|
+|»»»»»» modifiedOn|string(date-time)|false|none|none|
+|»»»»»» createdBy|string|false|none|none|
+|»»»»»» modifiedBy|string|false|none|none|
+|»»»»»» id|string|false|none|none|
+|»»»»»» dayOfWeek|number|false|none|none|
+|»»»»»» end|string|false|none|none|
+|»»»»»» start|string|false|none|none|
+|»»»»»» calendarId|string|true|none|none|
+|»»»»»» extId|string|false|none|none|
+|»»»»»» extMetadata|object|false|none|none|
+|»»»»»» calendar|[CalendarWithRelations](#schemacalendarwithrelations)|false|none|(tsType: CalendarWithRelations, schemaOptions: { includeRelations: true })|
+|»»»» subscriptions|[[SubscriptionWithRelations](#schemasubscriptionwithrelations)]|false|none|(tsType: SubscriptionWithRelations, schemaOptions: { includeRelations: true })|
+|»»»»» SubscriptionWithRelations|[SubscriptionWithRelations](#schemasubscriptionwithrelations)|false|none|(tsType: SubscriptionWithRelations, schemaOptions: { includeRelations: true })|
+|»»»»»» deleted|boolean|false|none|none|
+|»»»»»» deletedOn|string(date-time)¦null|false|none|none|
+|»»»»»» deletedBy|string¦null|false|none|none|
+|»»»»»» createdOn|string(date-time)|false|none|none|
+|»»»»»» modifiedOn|string(date-time)|false|none|none|
+|»»»»»» createdBy|string|false|none|none|
+|»»»»»» modifiedBy|string|false|none|none|
+|»»»»»» id|string|false|none|none|
+|»»»»»» accessRole|string|false|none|none|
+|»»»»»» bgColor|string|false|none|none|
+|»»»»»» fgColor|string|false|none|none|
+|»»»»»» isHidden|boolean|false|none|none|
+|»»»»»» isPrimary|boolean|false|none|none|
+|»»»»»» identifier|string|true|none|none|
+|»»»»»» defaultReminders|object|false|none|none|
+|»»»»»» notificationSettings|object|false|none|none|
+|»»»»»» calendarId|string|true|none|none|
+|»»»»»» extId|string|false|none|none|
+|»»»»»» extMetadata|object|false|none|none|
+|»»»»»» calendar|[CalendarWithRelations](#schemacalendarwithrelations)|false|none|(tsType: CalendarWithRelations, schemaOptions: { includeRelations: true })|
+|»»» parentEvent|[EventWithRelations](#schemaeventwithrelations)|false|none|(tsType: EventWithRelations, schemaOptions: { includeRelations: true })|
+|»»» attendees|[[AttendeeWithRelations](#schemaattendeewithrelations)]|false|none|(tsType: AttendeeWithRelations, schemaOptions: { includeRelations: true })|
+|»»»» AttendeeWithRelations|[AttendeeWithRelations](#schemaattendeewithrelations)|false|none|(tsType: AttendeeWithRelations, schemaOptions: { includeRelations: true })|
+|»»» attachments|[[AttachmentWithRelations](#schemaattachmentwithrelations)]|false|none|(tsType: AttachmentWithRelations, schemaOptions: { includeRelations: true })|
+|»»»» AttachmentWithRelations|[AttachmentWithRelations](#schemaattachmentwithrelations)|false|none|(tsType: AttachmentWithRelations, schemaOptions: { includeRelations: true })|
+|»»»»» deleted|boolean|false|none|none|
+|»»»»» deletedOn|string(date-time)¦null|false|none|none|
+|»»»»» deletedBy|string¦null|false|none|none|
+|»»»»» createdOn|string(date-time)|false|none|none|
+|»»»»» modifiedOn|string(date-time)|false|none|none|
+|»»»»» createdBy|string|false|none|none|
+|»»»»» modifiedBy|string|false|none|none|
+|»»»»» id|string|false|none|none|
+|»»»»» fileUrl|string|true|none|none|
+|»»»»» iconLink|string|false|none|none|
+|»»»»» mimeType|string|false|none|none|
+|»»»»» title|string|false|none|none|
+|»»»»» eventId|string|true|none|none|
+|»»»»» extId|string|false|none|none|
+|»»»»» extMetadata|object|false|none|none|
+|»»»»» event|[EventWithRelations](#schemaeventwithrelations)|false|none|(tsType: EventWithRelations, schemaOptions: { includeRelations: true })|
+
+#### Enumerated Values
+
+|Property|Value|
+|---|---|
+|responseStatus|needsAction|
+|responseStatus|tentative|
+|responseStatus|accepted|
+|responseStatus|declined|
+|status|confirmed|
+|status|tentative|
+|status|cancelled|
+|status|completed|
+|dayOfWeek|0|
+|dayOfWeek|1|
+|dayOfWeek|2|
+|dayOfWeek|3|
+|dayOfWeek|4|
+|dayOfWeek|5|
+|dayOfWeek|6|
+|accessRole|freeBusyReader|
+|accessRole|reader|
+|accessRole|writer|
+|accessRole|owner|
+
+
+This operation does not require authentication
+
+
+CalendarController
+
+## CalendarController.createWithSubscription
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|body|body|[NewCalendar](#schemanewcalendar)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "id": "string",
+ "source": "string",
+ "enableWorkingHours": true,
+ "location": "string",
+ "identifier": "string",
+ "summary": "string",
+ "timezone": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "workingHours": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "dayOfWeek": 0,
+ "end": "string",
+ "start": "string",
+ "calendarId": "string",
+ "extId": "string",
+ "extMetadata": {}
+ }
+ ],
+ "subscription": {}
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Calendar model instance|[CalendarDTO](#schemacalendardto)|
+
+
+This operation does not require authentication
+
+
+## CalendarController.count
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|where|query|object|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "count": 0
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Calendar model count|[loopback.Count](#schemaloopback.count)|
+
+
+This operation does not require authentication
+
+
+## CalendarController.replaceById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|body|body|[CalendarDTO](#schemacalendardto)|false|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|Calendar PUT success|None|
+
+
+This operation does not require authentication
+
+
+## CalendarController.updateById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|body|body|[CalendarPartial](#schemacalendarpartial)|false|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|Calendar PATCH success|None|
+
+
+This operation does not require authentication
+
+
+## CalendarController.findById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|filter|query|[calendars.Filter](#schemacalendars.filter)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "source": "string",
+ "enableWorkingHours": true,
+ "location": "string",
+ "identifier": "string",
+ "summary": "string",
+ "timezone": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "events": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "bgColor": "string",
+ "description": "string",
+ "endDateTime": "2019-08-24T14:15:22Z",
+ "fgColor": "string",
+ "iCalUid": "string",
+ "isFullDayEvent": true,
+ "isLocked": true,
+ "link": "string",
+ "location": "string",
+ "meetingLink": "string",
+ "identifier": "string",
+ "startDateTime": "2019-08-24T14:15:22Z",
+ "status": "confirmed",
+ "summary": "string",
+ "timezone": "string",
+ "calendarId": "string",
+ "parentEventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "source": "string",
+ "enableWorkingHours": true,
+ "location": "string",
+ "identifier": "string",
+ "summary": "string",
+ "timezone": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "events": [],
+ "workingHours": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "dayOfWeek": 0,
+ "end": "string",
+ "start": "string",
+ "calendarId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {}
+ }
+ ],
+ "subscriptions": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "accessRole": "freeBusyReader",
+ "bgColor": "string",
+ "fgColor": "string",
+ "isHidden": true,
+ "isPrimary": true,
+ "identifier": "string",
+ "defaultReminders": {},
+ "notificationSettings": {},
+ "calendarId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {}
+ }
+ ]
+ },
+ "parentEvent": {},
+ "attendees": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "identifier": "string",
+ "isOptional": true,
+ "isOrganizer": true,
+ "messages": "string",
+ "responseStatus": "needsAction",
+ "eventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "event": {}
+ }
+ ],
+ "attachments": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "fileUrl": "string",
+ "iconLink": "string",
+ "mimeType": "string",
+ "title": "string",
+ "eventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "event": {}
+ }
+ ]
+ }
+ ],
+ "workingHours": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "dayOfWeek": 0,
+ "end": "string",
+ "start": "string",
+ "calendarId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "source": "string",
+ "enableWorkingHours": true,
+ "location": "string",
+ "identifier": "string",
+ "summary": "string",
+ "timezone": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "events": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "bgColor": "string",
+ "description": "string",
+ "endDateTime": "2019-08-24T14:15:22Z",
+ "fgColor": "string",
+ "iCalUid": "string",
+ "isFullDayEvent": true,
+ "isLocked": true,
+ "link": "string",
+ "location": "string",
+ "meetingLink": "string",
+ "identifier": "string",
+ "startDateTime": "2019-08-24T14:15:22Z",
+ "status": "confirmed",
+ "summary": "string",
+ "timezone": "string",
+ "calendarId": "string",
+ "parentEventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {},
+ "parentEvent": {},
+ "attendees": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "identifier": "string",
+ "isOptional": true,
+ "isOrganizer": true,
+ "messages": "string",
+ "responseStatus": "needsAction",
+ "eventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "event": {}
+ }
+ ],
+ "attachments": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "fileUrl": "string",
+ "iconLink": "string",
+ "mimeType": "string",
+ "title": "string",
+ "eventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "event": {}
+ }
+ ]
+ }
+ ],
+ "workingHours": [],
+ "subscriptions": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "accessRole": "freeBusyReader",
+ "bgColor": "string",
+ "fgColor": "string",
+ "isHidden": true,
+ "isPrimary": true,
+ "identifier": "string",
+ "defaultReminders": {},
+ "notificationSettings": {},
+ "calendarId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {}
+ }
+ ]
+ }
+ }
+ ],
+ "subscriptions": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "accessRole": "freeBusyReader",
+ "bgColor": "string",
+ "fgColor": "string",
+ "isHidden": true,
+ "isPrimary": true,
+ "identifier": "string",
+ "defaultReminders": {},
+ "notificationSettings": {},
+ "calendarId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "source": "string",
+ "enableWorkingHours": true,
+ "location": "string",
+ "identifier": "string",
+ "summary": "string",
+ "timezone": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "events": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "bgColor": "string",
+ "description": "string",
+ "endDateTime": "2019-08-24T14:15:22Z",
+ "fgColor": "string",
+ "iCalUid": "string",
+ "isFullDayEvent": true,
+ "isLocked": true,
+ "link": "string",
+ "location": "string",
+ "meetingLink": "string",
+ "identifier": "string",
+ "startDateTime": "2019-08-24T14:15:22Z",
+ "status": "confirmed",
+ "summary": "string",
+ "timezone": "string",
+ "calendarId": "string",
+ "parentEventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {},
+ "parentEvent": {},
+ "attendees": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "identifier": "string",
+ "isOptional": true,
+ "isOrganizer": true,
+ "messages": "string",
+ "responseStatus": "needsAction",
+ "eventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "event": {}
+ }
+ ],
+ "attachments": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "fileUrl": "string",
+ "iconLink": "string",
+ "mimeType": "string",
+ "title": "string",
+ "eventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "event": {}
+ }
+ ]
+ }
+ ],
+ "workingHours": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "dayOfWeek": 0,
+ "end": "string",
+ "start": "string",
+ "calendarId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {}
+ }
+ ],
+ "subscriptions": []
+ }
+ }
+ ]
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Calendar model instance|[CalendarWithRelations](#schemacalendarwithrelations)|
+
+
+This operation does not require authentication
+
+
+## CalendarController.deleteById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|Calendar DELETE success|None|
+
+
+This operation does not require authentication
+
+
+## CalendarController.create
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|body|body|[NewCalendar](#schemanewcalendar)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "source": "string",
+ "enableWorkingHours": true,
+ "location": "string",
+ "identifier": "string",
+ "summary": "string",
+ "timezone": "string",
+ "extId": "string",
+ "extMetadata": {}
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Calendar model instance|[Calendar](#schemacalendar)|
+
+
+This operation does not require authentication
+
+
+## CalendarController.updateAll
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|where|query|object|false|none|
+|body|body|[CalendarPartial](#schemacalendarpartial)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "count": 0
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Calendar PATCH success count|[loopback.Count](#schemaloopback.count)|
+
+
+This operation does not require authentication
+
+
+## CalendarController.find
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|filter|query|[calendars.Filter1](#schemacalendars.filter1)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+[
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "source": "string",
+ "enableWorkingHours": true,
+ "location": "string",
+ "identifier": "string",
+ "summary": "string",
+ "timezone": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "events": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "bgColor": "string",
+ "description": "string",
+ "endDateTime": "2019-08-24T14:15:22Z",
+ "fgColor": "string",
+ "iCalUid": "string",
+ "isFullDayEvent": true,
+ "isLocked": true,
+ "link": "string",
+ "location": "string",
+ "meetingLink": "string",
+ "identifier": "string",
+ "startDateTime": "2019-08-24T14:15:22Z",
+ "status": "confirmed",
+ "summary": "string",
+ "timezone": "string",
+ "calendarId": "string",
+ "parentEventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {},
+ "parentEvent": {},
+ "attendees": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "identifier": "string",
+ "isOptional": true,
+ "isOrganizer": true,
+ "messages": "string",
+ "responseStatus": "needsAction",
+ "eventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "event": {}
+ }
+ ],
+ "attachments": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "fileUrl": "string",
+ "iconLink": "string",
+ "mimeType": "string",
+ "title": "string",
+ "eventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "event": {}
+ }
+ ]
+ }
+ ],
+ "workingHours": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "dayOfWeek": 0,
+ "end": "string",
+ "start": "string",
+ "calendarId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {}
+ }
+ ],
+ "subscriptions": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "accessRole": "freeBusyReader",
+ "bgColor": "string",
+ "fgColor": "string",
+ "isHidden": true,
+ "isPrimary": true,
+ "identifier": "string",
+ "defaultReminders": {},
+ "notificationSettings": {},
+ "calendarId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {}
+ }
+ ]
+ }
+]
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Array of Calendar model instances|Inline|
+
+Response Schema
+
+Status Code **200**
+
+|Name|Type|Required|Restrictions|Description|
+|---|---|---|---|---|
+|*anonymous*|[[CalendarWithRelations](#schemacalendarwithrelations)]|false|none|[(tsType: CalendarWithRelations, schemaOptions: { includeRelations: true })]|
+|» CalendarWithRelations|[CalendarWithRelations](#schemacalendarwithrelations)|false|none|(tsType: CalendarWithRelations, schemaOptions: { includeRelations: true })|
+|»» deleted|boolean|false|none|none|
+|»» deletedOn|string(date-time)¦null|false|none|none|
+|»» deletedBy|string¦null|false|none|none|
+|»» createdOn|string(date-time)|false|none|none|
+|»» modifiedOn|string(date-time)|false|none|none|
+|»» createdBy|string|false|none|none|
+|»» modifiedBy|string|false|none|none|
+|»» id|string|false|none|none|
+|»» source|string|false|none|none|
+|»» enableWorkingHours|boolean|false|none|none|
+|»» location|string|false|none|none|
+|»» identifier|string|true|none|none|
+|»» summary|string|false|none|none|
+|»» timezone|string|false|none|none|
+|»» extId|string|false|none|none|
+|»» extMetadata|object|false|none|none|
+|»» events|[[EventWithRelations](#schemaeventwithrelations)]|false|none|(tsType: EventWithRelations, schemaOptions: { includeRelations: true })|
+|»»» EventWithRelations|[EventWithRelations](#schemaeventwithrelations)|false|none|(tsType: EventWithRelations, schemaOptions: { includeRelations: true })|
+|»»»» deleted|boolean|false|none|none|
+|»»»» deletedOn|string(date-time)¦null|false|none|none|
+|»»»» deletedBy|string¦null|false|none|none|
+|»»»» createdOn|string(date-time)|false|none|none|
+|»»»» modifiedOn|string(date-time)|false|none|none|
+|»»»» createdBy|string|false|none|none|
+|»»»» modifiedBy|string|false|none|none|
+|»»»» id|string|false|none|none|
+|»»»» bgColor|string|false|none|none|
+|»»»» description|string|false|none|none|
+|»»»» endDateTime|string(date-time)|false|none|none|
+|»»»» fgColor|string|false|none|none|
+|»»»» iCalUid|string|false|none|none|
+|»»»» isFullDayEvent|boolean|false|none|none|
+|»»»» isLocked|boolean|false|none|none|
+|»»»» link|string|false|none|none|
+|»»»» location|string|false|none|none|
+|»»»» meetingLink|string|false|none|none|
+|»»»» identifier|string|false|none|none|
+|»»»» startDateTime|string(date-time)|false|none|none|
+|»»»» status|string|false|none|none|
+|»»»» summary|string|false|none|none|
+|»»»» timezone|string|false|none|none|
+|»»»» calendarId|string|true|none|none|
+|»»»» parentEventId|string|false|none|none|
+|»»»» extId|string|false|none|none|
+|»»»» extMetadata|object|false|none|none|
+|»»»» calendar|[CalendarWithRelations](#schemacalendarwithrelations)|false|none|(tsType: CalendarWithRelations, schemaOptions: { includeRelations: true })|
+|»»»» parentEvent|[EventWithRelations](#schemaeventwithrelations)|false|none|(tsType: EventWithRelations, schemaOptions: { includeRelations: true })|
+|»»»» attendees|[[AttendeeWithRelations](#schemaattendeewithrelations)]|false|none|(tsType: AttendeeWithRelations, schemaOptions: { includeRelations: true })|
+|»»»»» AttendeeWithRelations|[AttendeeWithRelations](#schemaattendeewithrelations)|false|none|(tsType: AttendeeWithRelations, schemaOptions: { includeRelations: true })|
+|»»»»»» deleted|boolean|false|none|none|
+|»»»»»» deletedOn|string(date-time)¦null|false|none|none|
+|»»»»»» deletedBy|string¦null|false|none|none|
+|»»»»»» createdOn|string(date-time)|false|none|none|
+|»»»»»» modifiedOn|string(date-time)|false|none|none|
+|»»»»»» createdBy|string|false|none|none|
+|»»»»»» modifiedBy|string|false|none|none|
+|»»»»»» id|string|false|none|none|
+|»»»»»» identifier|string|true|none|none|
+|»»»»»» isOptional|boolean|false|none|none|
+|»»»»»» isOrganizer|boolean|false|none|none|
+|»»»»»» messages|string|false|none|none|
+|»»»»»» responseStatus|string|false|none|none|
+|»»»»»» eventId|string|true|none|none|
+|»»»»»» extId|string|false|none|none|
+|»»»»»» extMetadata|object|false|none|none|
+|»»»»»» event|[EventWithRelations](#schemaeventwithrelations)|false|none|(tsType: EventWithRelations, schemaOptions: { includeRelations: true })|
+|»»»» attachments|[[AttachmentWithRelations](#schemaattachmentwithrelations)]|false|none|(tsType: AttachmentWithRelations, schemaOptions: { includeRelations: true })|
+|»»»»» AttachmentWithRelations|[AttachmentWithRelations](#schemaattachmentwithrelations)|false|none|(tsType: AttachmentWithRelations, schemaOptions: { includeRelations: true })|
+|»»»»»» deleted|boolean|false|none|none|
+|»»»»»» deletedOn|string(date-time)¦null|false|none|none|
+|»»»»»» deletedBy|string¦null|false|none|none|
+|»»»»»» createdOn|string(date-time)|false|none|none|
+|»»»»»» modifiedOn|string(date-time)|false|none|none|
+|»»»»»» createdBy|string|false|none|none|
+|»»»»»» modifiedBy|string|false|none|none|
+|»»»»»» id|string|false|none|none|
+|»»»»»» fileUrl|string|true|none|none|
+|»»»»»» iconLink|string|false|none|none|
+|»»»»»» mimeType|string|false|none|none|
+|»»»»»» title|string|false|none|none|
+|»»»»»» eventId|string|true|none|none|
+|»»»»»» extId|string|false|none|none|
+|»»»»»» extMetadata|object|false|none|none|
+|»»»»»» event|[EventWithRelations](#schemaeventwithrelations)|false|none|(tsType: EventWithRelations, schemaOptions: { includeRelations: true })|
+|»» workingHours|[[WorkingHourWithRelations](#schemaworkinghourwithrelations)]|false|none|(tsType: WorkingHourWithRelations, schemaOptions: { includeRelations: true })|
+|»»» WorkingHourWithRelations|[WorkingHourWithRelations](#schemaworkinghourwithrelations)|false|none|(tsType: WorkingHourWithRelations, schemaOptions: { includeRelations: true })|
+|»»»» deleted|boolean|false|none|none|
+|»»»» deletedOn|string(date-time)¦null|false|none|none|
+|»»»» deletedBy|string¦null|false|none|none|
+|»»»» createdOn|string(date-time)|false|none|none|
+|»»»» modifiedOn|string(date-time)|false|none|none|
+|»»»» createdBy|string|false|none|none|
+|»»»» modifiedBy|string|false|none|none|
+|»»»» id|string|false|none|none|
+|»»»» dayOfWeek|number|false|none|none|
+|»»»» end|string|false|none|none|
+|»»»» start|string|false|none|none|
+|»»»» calendarId|string|true|none|none|
+|»»»» extId|string|false|none|none|
+|»»»» extMetadata|object|false|none|none|
+|»»»» calendar|[CalendarWithRelations](#schemacalendarwithrelations)|false|none|(tsType: CalendarWithRelations, schemaOptions: { includeRelations: true })|
+|»» subscriptions|[[SubscriptionWithRelations](#schemasubscriptionwithrelations)]|false|none|(tsType: SubscriptionWithRelations, schemaOptions: { includeRelations: true })|
+|»»» SubscriptionWithRelations|[SubscriptionWithRelations](#schemasubscriptionwithrelations)|false|none|(tsType: SubscriptionWithRelations, schemaOptions: { includeRelations: true })|
+|»»»» deleted|boolean|false|none|none|
+|»»»» deletedOn|string(date-time)¦null|false|none|none|
+|»»»» deletedBy|string¦null|false|none|none|
+|»»»» createdOn|string(date-time)|false|none|none|
+|»»»» modifiedOn|string(date-time)|false|none|none|
+|»»»» createdBy|string|false|none|none|
+|»»»» modifiedBy|string|false|none|none|
+|»»»» id|string|false|none|none|
+|»»»» accessRole|string|false|none|none|
+|»»»» bgColor|string|false|none|none|
+|»»»» fgColor|string|false|none|none|
+|»»»» isHidden|boolean|false|none|none|
+|»»»» isPrimary|boolean|false|none|none|
+|»»»» identifier|string|true|none|none|
+|»»»» defaultReminders|object|false|none|none|
+|»»»» notificationSettings|object|false|none|none|
+|»»»» calendarId|string|true|none|none|
+|»»»» extId|string|false|none|none|
+|»»»» extMetadata|object|false|none|none|
+|»»»» calendar|[CalendarWithRelations](#schemacalendarwithrelations)|false|none|(tsType: CalendarWithRelations, schemaOptions: { includeRelations: true })|
+
+#### Enumerated Values
+
+|Property|Value|
+|---|---|
+|status|confirmed|
+|status|tentative|
+|status|cancelled|
+|status|completed|
+|responseStatus|needsAction|
+|responseStatus|tentative|
+|responseStatus|accepted|
+|responseStatus|declined|
+|dayOfWeek|0|
+|dayOfWeek|1|
+|dayOfWeek|2|
+|dayOfWeek|3|
+|dayOfWeek|4|
+|dayOfWeek|5|
+|dayOfWeek|6|
+|accessRole|freeBusyReader|
+|accessRole|reader|
+|accessRole|writer|
+|accessRole|owner|
+
+
+This operation does not require authentication
+
+
+SubscriptionController
+
+## SubscriptionController.findMe
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|filter|query|[subscriptions.Filter](#schemasubscriptions.filter)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+[
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "accessRole": "freeBusyReader",
+ "bgColor": "string",
+ "fgColor": "string",
+ "isHidden": true,
+ "isPrimary": true,
+ "identifier": "string",
+ "defaultReminders": {},
+ "notificationSettings": {},
+ "calendarId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "source": "string",
+ "enableWorkingHours": true,
+ "location": "string",
+ "identifier": "string",
+ "summary": "string",
+ "timezone": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "events": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "bgColor": "string",
+ "description": "string",
+ "endDateTime": "2019-08-24T14:15:22Z",
+ "fgColor": "string",
+ "iCalUid": "string",
+ "isFullDayEvent": true,
+ "isLocked": true,
+ "link": "string",
+ "location": "string",
+ "meetingLink": "string",
+ "identifier": "string",
+ "startDateTime": "2019-08-24T14:15:22Z",
+ "status": "confirmed",
+ "summary": "string",
+ "timezone": "string",
+ "calendarId": "string",
+ "parentEventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {},
+ "parentEvent": {},
+ "attendees": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "identifier": "string",
+ "isOptional": true,
+ "isOrganizer": true,
+ "messages": "string",
+ "responseStatus": "needsAction",
+ "eventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "event": {}
+ }
+ ],
+ "attachments": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "fileUrl": "string",
+ "iconLink": "string",
+ "mimeType": "string",
+ "title": "string",
+ "eventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "event": {}
+ }
+ ]
+ }
+ ],
+ "workingHours": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "dayOfWeek": 0,
+ "end": "string",
+ "start": "string",
+ "calendarId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {}
+ }
+ ],
+ "subscriptions": [
+ {}
+ ]
+ }
+ }
+]
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Array of Subscription model instances|Inline|
+
+Response Schema
+
+Status Code **200**
+
+|Name|Type|Required|Restrictions|Description|
+|---|---|---|---|---|
+|*anonymous*|[[SubscriptionWithRelations](#schemasubscriptionwithrelations)]|false|none|[(tsType: SubscriptionWithRelations, schemaOptions: { includeRelations: true })]|
+|» SubscriptionWithRelations|[SubscriptionWithRelations](#schemasubscriptionwithrelations)|false|none|(tsType: SubscriptionWithRelations, schemaOptions: { includeRelations: true })|
+|»» deleted|boolean|false|none|none|
+|»» deletedOn|string(date-time)¦null|false|none|none|
+|»» deletedBy|string¦null|false|none|none|
+|»» createdOn|string(date-time)|false|none|none|
+|»» modifiedOn|string(date-time)|false|none|none|
+|»» createdBy|string|false|none|none|
+|»» modifiedBy|string|false|none|none|
+|»» id|string|false|none|none|
+|»» accessRole|string|false|none|none|
+|»» bgColor|string|false|none|none|
+|»» fgColor|string|false|none|none|
+|»» isHidden|boolean|false|none|none|
+|»» isPrimary|boolean|false|none|none|
+|»» identifier|string|true|none|none|
+|»» defaultReminders|object|false|none|none|
+|»» notificationSettings|object|false|none|none|
+|»» calendarId|string|true|none|none|
+|»» extId|string|false|none|none|
+|»» extMetadata|object|false|none|none|
+|»» calendar|[CalendarWithRelations](#schemacalendarwithrelations)|false|none|(tsType: CalendarWithRelations, schemaOptions: { includeRelations: true })|
+|»»» deleted|boolean|false|none|none|
+|»»» deletedOn|string(date-time)¦null|false|none|none|
+|»»» deletedBy|string¦null|false|none|none|
+|»»» createdOn|string(date-time)|false|none|none|
+|»»» modifiedOn|string(date-time)|false|none|none|
+|»»» createdBy|string|false|none|none|
+|»»» modifiedBy|string|false|none|none|
+|»»» id|string|false|none|none|
+|»»» source|string|false|none|none|
+|»»» enableWorkingHours|boolean|false|none|none|
+|»»» location|string|false|none|none|
+|»»» identifier|string|true|none|none|
+|»»» summary|string|false|none|none|
+|»»» timezone|string|false|none|none|
+|»»» extId|string|false|none|none|
+|»»» extMetadata|object|false|none|none|
+|»»» events|[[EventWithRelations](#schemaeventwithrelations)]|false|none|(tsType: EventWithRelations, schemaOptions: { includeRelations: true })|
+|»»»» EventWithRelations|[EventWithRelations](#schemaeventwithrelations)|false|none|(tsType: EventWithRelations, schemaOptions: { includeRelations: true })|
+|»»»»» deleted|boolean|false|none|none|
+|»»»»» deletedOn|string(date-time)¦null|false|none|none|
+|»»»»» deletedBy|string¦null|false|none|none|
+|»»»»» createdOn|string(date-time)|false|none|none|
+|»»»»» modifiedOn|string(date-time)|false|none|none|
+|»»»»» createdBy|string|false|none|none|
+|»»»»» modifiedBy|string|false|none|none|
+|»»»»» id|string|false|none|none|
+|»»»»» bgColor|string|false|none|none|
+|»»»»» description|string|false|none|none|
+|»»»»» endDateTime|string(date-time)|false|none|none|
+|»»»»» fgColor|string|false|none|none|
+|»»»»» iCalUid|string|false|none|none|
+|»»»»» isFullDayEvent|boolean|false|none|none|
+|»»»»» isLocked|boolean|false|none|none|
+|»»»»» link|string|false|none|none|
+|»»»»» location|string|false|none|none|
+|»»»»» meetingLink|string|false|none|none|
+|»»»»» identifier|string|false|none|none|
+|»»»»» startDateTime|string(date-time)|false|none|none|
+|»»»»» status|string|false|none|none|
+|»»»»» summary|string|false|none|none|
+|»»»»» timezone|string|false|none|none|
+|»»»»» calendarId|string|true|none|none|
+|»»»»» parentEventId|string|false|none|none|
+|»»»»» extId|string|false|none|none|
+|»»»»» extMetadata|object|false|none|none|
+|»»»»» calendar|[CalendarWithRelations](#schemacalendarwithrelations)|false|none|(tsType: CalendarWithRelations, schemaOptions: { includeRelations: true })|
+|»»»»» parentEvent|[EventWithRelations](#schemaeventwithrelations)|false|none|(tsType: EventWithRelations, schemaOptions: { includeRelations: true })|
+|»»»»» attendees|[[AttendeeWithRelations](#schemaattendeewithrelations)]|false|none|(tsType: AttendeeWithRelations, schemaOptions: { includeRelations: true })|
+|»»»»»» AttendeeWithRelations|[AttendeeWithRelations](#schemaattendeewithrelations)|false|none|(tsType: AttendeeWithRelations, schemaOptions: { includeRelations: true })|
+|»»»»»»» deleted|boolean|false|none|none|
+|»»»»»»» deletedOn|string(date-time)¦null|false|none|none|
+|»»»»»»» deletedBy|string¦null|false|none|none|
+|»»»»»»» createdOn|string(date-time)|false|none|none|
+|»»»»»»» modifiedOn|string(date-time)|false|none|none|
+|»»»»»»» createdBy|string|false|none|none|
+|»»»»»»» modifiedBy|string|false|none|none|
+|»»»»»»» id|string|false|none|none|
+|»»»»»»» identifier|string|true|none|none|
+|»»»»»»» isOptional|boolean|false|none|none|
+|»»»»»»» isOrganizer|boolean|false|none|none|
+|»»»»»»» messages|string|false|none|none|
+|»»»»»»» responseStatus|string|false|none|none|
+|»»»»»»» eventId|string|true|none|none|
+|»»»»»»» extId|string|false|none|none|
+|»»»»»»» extMetadata|object|false|none|none|
+|»»»»»»» event|[EventWithRelations](#schemaeventwithrelations)|false|none|(tsType: EventWithRelations, schemaOptions: { includeRelations: true })|
+|»»»»» attachments|[[AttachmentWithRelations](#schemaattachmentwithrelations)]|false|none|(tsType: AttachmentWithRelations, schemaOptions: { includeRelations: true })|
+|»»»»»» AttachmentWithRelations|[AttachmentWithRelations](#schemaattachmentwithrelations)|false|none|(tsType: AttachmentWithRelations, schemaOptions: { includeRelations: true })|
+|»»»»»»» deleted|boolean|false|none|none|
+|»»»»»»» deletedOn|string(date-time)¦null|false|none|none|
+|»»»»»»» deletedBy|string¦null|false|none|none|
+|»»»»»»» createdOn|string(date-time)|false|none|none|
+|»»»»»»» modifiedOn|string(date-time)|false|none|none|
+|»»»»»»» createdBy|string|false|none|none|
+|»»»»»»» modifiedBy|string|false|none|none|
+|»»»»»»» id|string|false|none|none|
+|»»»»»»» fileUrl|string|true|none|none|
+|»»»»»»» iconLink|string|false|none|none|
+|»»»»»»» mimeType|string|false|none|none|
+|»»»»»»» title|string|false|none|none|
+|»»»»»»» eventId|string|true|none|none|
+|»»»»»»» extId|string|false|none|none|
+|»»»»»»» extMetadata|object|false|none|none|
+|»»»»»»» event|[EventWithRelations](#schemaeventwithrelations)|false|none|(tsType: EventWithRelations, schemaOptions: { includeRelations: true })|
+|»»» workingHours|[[WorkingHourWithRelations](#schemaworkinghourwithrelations)]|false|none|(tsType: WorkingHourWithRelations, schemaOptions: { includeRelations: true })|
+|»»»» WorkingHourWithRelations|[WorkingHourWithRelations](#schemaworkinghourwithrelations)|false|none|(tsType: WorkingHourWithRelations, schemaOptions: { includeRelations: true })|
+|»»»»» deleted|boolean|false|none|none|
+|»»»»» deletedOn|string(date-time)¦null|false|none|none|
+|»»»»» deletedBy|string¦null|false|none|none|
+|»»»»» createdOn|string(date-time)|false|none|none|
+|»»»»» modifiedOn|string(date-time)|false|none|none|
+|»»»»» createdBy|string|false|none|none|
+|»»»»» modifiedBy|string|false|none|none|
+|»»»»» id|string|false|none|none|
+|»»»»» dayOfWeek|number|false|none|none|
+|»»»»» end|string|false|none|none|
+|»»»»» start|string|false|none|none|
+|»»»»» calendarId|string|true|none|none|
+|»»»»» extId|string|false|none|none|
+|»»»»» extMetadata|object|false|none|none|
+|»»»»» calendar|[CalendarWithRelations](#schemacalendarwithrelations)|false|none|(tsType: CalendarWithRelations, schemaOptions: { includeRelations: true })|
+|»»» subscriptions|[[SubscriptionWithRelations](#schemasubscriptionwithrelations)]|false|none|(tsType: SubscriptionWithRelations, schemaOptions: { includeRelations: true })|
+|»»»» SubscriptionWithRelations|[SubscriptionWithRelations](#schemasubscriptionwithrelations)|false|none|(tsType: SubscriptionWithRelations, schemaOptions: { includeRelations: true })|
+
+#### Enumerated Values
+
+|Property|Value|
+|---|---|
+|accessRole|freeBusyReader|
+|accessRole|reader|
+|accessRole|writer|
+|accessRole|owner|
+|status|confirmed|
+|status|tentative|
+|status|cancelled|
+|status|completed|
+|responseStatus|needsAction|
+|responseStatus|tentative|
+|responseStatus|accepted|
+|responseStatus|declined|
+|dayOfWeek|0|
+|dayOfWeek|1|
+|dayOfWeek|2|
+|dayOfWeek|3|
+|dayOfWeek|4|
+|dayOfWeek|5|
+|dayOfWeek|6|
+
+
+This operation does not require authentication
+
+
+## SubscriptionController.count
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|where|query|object|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "count": 0
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Subscription model count|[loopback.Count](#schemaloopback.count)|
+
+
+This operation does not require authentication
+
+
+## SubscriptionController.replaceById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|body|body|[Subscription](#schemasubscription)|false|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|Subscription PUT success|None|
+
+
+This operation does not require authentication
+
+
+## SubscriptionController.updateById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|body|body|[SubscriptionPartial](#schemasubscriptionpartial)|false|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|Subscription PATCH success|None|
+
+
+This operation does not require authentication
+
+
+## SubscriptionController.findById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|filter|query|[subscriptions.Filter1](#schemasubscriptions.filter1)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "accessRole": "freeBusyReader",
+ "bgColor": "string",
+ "fgColor": "string",
+ "isHidden": true,
+ "isPrimary": true,
+ "identifier": "string",
+ "defaultReminders": {},
+ "notificationSettings": {},
+ "calendarId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "source": "string",
+ "enableWorkingHours": true,
+ "location": "string",
+ "identifier": "string",
+ "summary": "string",
+ "timezone": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "events": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "bgColor": "string",
+ "description": "string",
+ "endDateTime": "2019-08-24T14:15:22Z",
+ "fgColor": "string",
+ "iCalUid": "string",
+ "isFullDayEvent": true,
+ "isLocked": true,
+ "link": "string",
+ "location": "string",
+ "meetingLink": "string",
+ "identifier": "string",
+ "startDateTime": "2019-08-24T14:15:22Z",
+ "status": "confirmed",
+ "summary": "string",
+ "timezone": "string",
+ "calendarId": "string",
+ "parentEventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {},
+ "parentEvent": {},
+ "attendees": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "identifier": "string",
+ "isOptional": true,
+ "isOrganizer": true,
+ "messages": "string",
+ "responseStatus": "needsAction",
+ "eventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "event": {}
+ }
+ ],
+ "attachments": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "fileUrl": "string",
+ "iconLink": "string",
+ "mimeType": "string",
+ "title": "string",
+ "eventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "event": {}
+ }
+ ]
+ }
+ ],
+ "workingHours": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "dayOfWeek": 0,
+ "end": "string",
+ "start": "string",
+ "calendarId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {}
+ }
+ ],
+ "subscriptions": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "accessRole": "freeBusyReader",
+ "bgColor": "string",
+ "fgColor": "string",
+ "isHidden": true,
+ "isPrimary": true,
+ "identifier": "string",
+ "defaultReminders": {},
+ "notificationSettings": {},
+ "calendarId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {}
+ }
+ ]
+ }
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Subscription model instance|[SubscriptionWithRelations](#schemasubscriptionwithrelations)|
+
+
+This operation does not require authentication
+
+
+## SubscriptionController.deleteById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|Subscription DELETE success|None|
+
+
+This operation does not require authentication
+
+
+## SubscriptionController.create
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|body|body|[NewSubscription](#schemanewsubscription)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "accessRole": "freeBusyReader",
+ "bgColor": "string",
+ "fgColor": "string",
+ "isHidden": true,
+ "isPrimary": true,
+ "identifier": "string",
+ "defaultReminders": {},
+ "notificationSettings": {},
+ "calendarId": "string",
+ "extId": "string",
+ "extMetadata": {}
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Subscription model instance|[Subscription](#schemasubscription)|
+
+
+This operation does not require authentication
+
+
+## SubscriptionController.updateAll
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|where|query|object|false|none|
+|body|body|[SubscriptionPartial](#schemasubscriptionpartial)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "count": 0
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Subscription PATCH success count|[loopback.Count](#schemaloopback.count)|
+
+
+This operation does not require authentication
+
+
+## SubscriptionController.find
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|filter|query|[subscriptions.Filter](#schemasubscriptions.filter)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+[
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "accessRole": "freeBusyReader",
+ "bgColor": "string",
+ "fgColor": "string",
+ "isHidden": true,
+ "isPrimary": true,
+ "identifier": "string",
+ "defaultReminders": {},
+ "notificationSettings": {},
+ "calendarId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "source": "string",
+ "enableWorkingHours": true,
+ "location": "string",
+ "identifier": "string",
+ "summary": "string",
+ "timezone": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "events": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "bgColor": "string",
+ "description": "string",
+ "endDateTime": "2019-08-24T14:15:22Z",
+ "fgColor": "string",
+ "iCalUid": "string",
+ "isFullDayEvent": true,
+ "isLocked": true,
+ "link": "string",
+ "location": "string",
+ "meetingLink": "string",
+ "identifier": "string",
+ "startDateTime": "2019-08-24T14:15:22Z",
+ "status": "confirmed",
+ "summary": "string",
+ "timezone": "string",
+ "calendarId": "string",
+ "parentEventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {},
+ "parentEvent": {},
+ "attendees": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "identifier": "string",
+ "isOptional": true,
+ "isOrganizer": true,
+ "messages": "string",
+ "responseStatus": "needsAction",
+ "eventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "event": {}
+ }
+ ],
+ "attachments": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "fileUrl": "string",
+ "iconLink": "string",
+ "mimeType": "string",
+ "title": "string",
+ "eventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "event": {}
+ }
+ ]
+ }
+ ],
+ "workingHours": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "dayOfWeek": 0,
+ "end": "string",
+ "start": "string",
+ "calendarId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {}
+ }
+ ],
+ "subscriptions": [
+ {}
+ ]
+ }
+ }
+]
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Array of Subscription model instances|Inline|
+
+Response Schema
+
+Status Code **200**
+
+|Name|Type|Required|Restrictions|Description|
+|---|---|---|---|---|
+|*anonymous*|[[SubscriptionWithRelations](#schemasubscriptionwithrelations)]|false|none|[(tsType: SubscriptionWithRelations, schemaOptions: { includeRelations: true })]|
+|» SubscriptionWithRelations|[SubscriptionWithRelations](#schemasubscriptionwithrelations)|false|none|(tsType: SubscriptionWithRelations, schemaOptions: { includeRelations: true })|
+|»» deleted|boolean|false|none|none|
+|»» deletedOn|string(date-time)¦null|false|none|none|
+|»» deletedBy|string¦null|false|none|none|
+|»» createdOn|string(date-time)|false|none|none|
+|»» modifiedOn|string(date-time)|false|none|none|
+|»» createdBy|string|false|none|none|
+|»» modifiedBy|string|false|none|none|
+|»» id|string|false|none|none|
+|»» accessRole|string|false|none|none|
+|»» bgColor|string|false|none|none|
+|»» fgColor|string|false|none|none|
+|»» isHidden|boolean|false|none|none|
+|»» isPrimary|boolean|false|none|none|
+|»» identifier|string|true|none|none|
+|»» defaultReminders|object|false|none|none|
+|»» notificationSettings|object|false|none|none|
+|»» calendarId|string|true|none|none|
+|»» extId|string|false|none|none|
+|»» extMetadata|object|false|none|none|
+|»» calendar|[CalendarWithRelations](#schemacalendarwithrelations)|false|none|(tsType: CalendarWithRelations, schemaOptions: { includeRelations: true })|
+|»»» deleted|boolean|false|none|none|
+|»»» deletedOn|string(date-time)¦null|false|none|none|
+|»»» deletedBy|string¦null|false|none|none|
+|»»» createdOn|string(date-time)|false|none|none|
+|»»» modifiedOn|string(date-time)|false|none|none|
+|»»» createdBy|string|false|none|none|
+|»»» modifiedBy|string|false|none|none|
+|»»» id|string|false|none|none|
+|»»» source|string|false|none|none|
+|»»» enableWorkingHours|boolean|false|none|none|
+|»»» location|string|false|none|none|
+|»»» identifier|string|true|none|none|
+|»»» summary|string|false|none|none|
+|»»» timezone|string|false|none|none|
+|»»» extId|string|false|none|none|
+|»»» extMetadata|object|false|none|none|
+|»»» events|[[EventWithRelations](#schemaeventwithrelations)]|false|none|(tsType: EventWithRelations, schemaOptions: { includeRelations: true })|
+|»»»» EventWithRelations|[EventWithRelations](#schemaeventwithrelations)|false|none|(tsType: EventWithRelations, schemaOptions: { includeRelations: true })|
+|»»»»» deleted|boolean|false|none|none|
+|»»»»» deletedOn|string(date-time)¦null|false|none|none|
+|»»»»» deletedBy|string¦null|false|none|none|
+|»»»»» createdOn|string(date-time)|false|none|none|
+|»»»»» modifiedOn|string(date-time)|false|none|none|
+|»»»»» createdBy|string|false|none|none|
+|»»»»» modifiedBy|string|false|none|none|
+|»»»»» id|string|false|none|none|
+|»»»»» bgColor|string|false|none|none|
+|»»»»» description|string|false|none|none|
+|»»»»» endDateTime|string(date-time)|false|none|none|
+|»»»»» fgColor|string|false|none|none|
+|»»»»» iCalUid|string|false|none|none|
+|»»»»» isFullDayEvent|boolean|false|none|none|
+|»»»»» isLocked|boolean|false|none|none|
+|»»»»» link|string|false|none|none|
+|»»»»» location|string|false|none|none|
+|»»»»» meetingLink|string|false|none|none|
+|»»»»» identifier|string|false|none|none|
+|»»»»» startDateTime|string(date-time)|false|none|none|
+|»»»»» status|string|false|none|none|
+|»»»»» summary|string|false|none|none|
+|»»»»» timezone|string|false|none|none|
+|»»»»» calendarId|string|true|none|none|
+|»»»»» parentEventId|string|false|none|none|
+|»»»»» extId|string|false|none|none|
+|»»»»» extMetadata|object|false|none|none|
+|»»»»» calendar|[CalendarWithRelations](#schemacalendarwithrelations)|false|none|(tsType: CalendarWithRelations, schemaOptions: { includeRelations: true })|
+|»»»»» parentEvent|[EventWithRelations](#schemaeventwithrelations)|false|none|(tsType: EventWithRelations, schemaOptions: { includeRelations: true })|
+|»»»»» attendees|[[AttendeeWithRelations](#schemaattendeewithrelations)]|false|none|(tsType: AttendeeWithRelations, schemaOptions: { includeRelations: true })|
+|»»»»»» AttendeeWithRelations|[AttendeeWithRelations](#schemaattendeewithrelations)|false|none|(tsType: AttendeeWithRelations, schemaOptions: { includeRelations: true })|
+|»»»»»»» deleted|boolean|false|none|none|
+|»»»»»»» deletedOn|string(date-time)¦null|false|none|none|
+|»»»»»»» deletedBy|string¦null|false|none|none|
+|»»»»»»» createdOn|string(date-time)|false|none|none|
+|»»»»»»» modifiedOn|string(date-time)|false|none|none|
+|»»»»»»» createdBy|string|false|none|none|
+|»»»»»»» modifiedBy|string|false|none|none|
+|»»»»»»» id|string|false|none|none|
+|»»»»»»» identifier|string|true|none|none|
+|»»»»»»» isOptional|boolean|false|none|none|
+|»»»»»»» isOrganizer|boolean|false|none|none|
+|»»»»»»» messages|string|false|none|none|
+|»»»»»»» responseStatus|string|false|none|none|
+|»»»»»»» eventId|string|true|none|none|
+|»»»»»»» extId|string|false|none|none|
+|»»»»»»» extMetadata|object|false|none|none|
+|»»»»»»» event|[EventWithRelations](#schemaeventwithrelations)|false|none|(tsType: EventWithRelations, schemaOptions: { includeRelations: true })|
+|»»»»» attachments|[[AttachmentWithRelations](#schemaattachmentwithrelations)]|false|none|(tsType: AttachmentWithRelations, schemaOptions: { includeRelations: true })|
+|»»»»»» AttachmentWithRelations|[AttachmentWithRelations](#schemaattachmentwithrelations)|false|none|(tsType: AttachmentWithRelations, schemaOptions: { includeRelations: true })|
+|»»»»»»» deleted|boolean|false|none|none|
+|»»»»»»» deletedOn|string(date-time)¦null|false|none|none|
+|»»»»»»» deletedBy|string¦null|false|none|none|
+|»»»»»»» createdOn|string(date-time)|false|none|none|
+|»»»»»»» modifiedOn|string(date-time)|false|none|none|
+|»»»»»»» createdBy|string|false|none|none|
+|»»»»»»» modifiedBy|string|false|none|none|
+|»»»»»»» id|string|false|none|none|
+|»»»»»»» fileUrl|string|true|none|none|
+|»»»»»»» iconLink|string|false|none|none|
+|»»»»»»» mimeType|string|false|none|none|
+|»»»»»»» title|string|false|none|none|
+|»»»»»»» eventId|string|true|none|none|
+|»»»»»»» extId|string|false|none|none|
+|»»»»»»» extMetadata|object|false|none|none|
+|»»»»»»» event|[EventWithRelations](#schemaeventwithrelations)|false|none|(tsType: EventWithRelations, schemaOptions: { includeRelations: true })|
+|»»» workingHours|[[WorkingHourWithRelations](#schemaworkinghourwithrelations)]|false|none|(tsType: WorkingHourWithRelations, schemaOptions: { includeRelations: true })|
+|»»»» WorkingHourWithRelations|[WorkingHourWithRelations](#schemaworkinghourwithrelations)|false|none|(tsType: WorkingHourWithRelations, schemaOptions: { includeRelations: true })|
+|»»»»» deleted|boolean|false|none|none|
+|»»»»» deletedOn|string(date-time)¦null|false|none|none|
+|»»»»» deletedBy|string¦null|false|none|none|
+|»»»»» createdOn|string(date-time)|false|none|none|
+|»»»»» modifiedOn|string(date-time)|false|none|none|
+|»»»»» createdBy|string|false|none|none|
+|»»»»» modifiedBy|string|false|none|none|
+|»»»»» id|string|false|none|none|
+|»»»»» dayOfWeek|number|false|none|none|
+|»»»»» end|string|false|none|none|
+|»»»»» start|string|false|none|none|
+|»»»»» calendarId|string|true|none|none|
+|»»»»» extId|string|false|none|none|
+|»»»»» extMetadata|object|false|none|none|
+|»»»»» calendar|[CalendarWithRelations](#schemacalendarwithrelations)|false|none|(tsType: CalendarWithRelations, schemaOptions: { includeRelations: true })|
+|»»» subscriptions|[[SubscriptionWithRelations](#schemasubscriptionwithrelations)]|false|none|(tsType: SubscriptionWithRelations, schemaOptions: { includeRelations: true })|
+|»»»» SubscriptionWithRelations|[SubscriptionWithRelations](#schemasubscriptionwithrelations)|false|none|(tsType: SubscriptionWithRelations, schemaOptions: { includeRelations: true })|
+
+#### Enumerated Values
+
+|Property|Value|
+|---|---|
+|accessRole|freeBusyReader|
+|accessRole|reader|
+|accessRole|writer|
+|accessRole|owner|
+|status|confirmed|
+|status|tentative|
+|status|cancelled|
+|status|completed|
+|responseStatus|needsAction|
+|responseStatus|tentative|
+|responseStatus|accepted|
+|responseStatus|declined|
+|dayOfWeek|0|
+|dayOfWeek|1|
+|dayOfWeek|2|
+|dayOfWeek|3|
+|dayOfWeek|4|
+|dayOfWeek|5|
+|dayOfWeek|6|
+
+
+This operation does not require authentication
+
+
+CalendarEventController
+
+## CalendarEventController.create
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|body|body|[NewEventInCalendar](#schemaneweventincalendar)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "bgColor": "string",
+ "description": "string",
+ "endDateTime": "2019-08-24T14:15:22Z",
+ "fgColor": "string",
+ "iCalUid": "string",
+ "isFullDayEvent": true,
+ "isLocked": true,
+ "link": "string",
+ "location": "string",
+ "meetingLink": "string",
+ "identifier": "string",
+ "startDateTime": "2019-08-24T14:15:22Z",
+ "status": "confirmed",
+ "summary": "string",
+ "timezone": "string",
+ "calendarId": "string",
+ "parentEventId": "string",
+ "extId": "string",
+ "extMetadata": {}
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Calendar model instance|[Event](#schemaevent)|
+
+
+This operation does not require authentication
+
+
+## CalendarEventController.patch
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|where|query|object|false|none|
+|body|body|[EventPartial](#schemaeventpartial)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "count": 0
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Calendar.Event PATCH success count|[loopback.Count](#schemaloopback.count)|
+
+
+This operation does not require authentication
+
+
+## CalendarEventController.find
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|filter|query|object|false|none|
+|timeMax|query|string(date-time)|false|none|
+|timeMin|query|string(date-time)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+[
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "bgColor": "string",
+ "description": "string",
+ "endDateTime": "2019-08-24T14:15:22Z",
+ "fgColor": "string",
+ "iCalUid": "string",
+ "isFullDayEvent": true,
+ "isLocked": true,
+ "link": "string",
+ "location": "string",
+ "meetingLink": "string",
+ "identifier": "string",
+ "startDateTime": "2019-08-24T14:15:22Z",
+ "status": "confirmed",
+ "summary": "string",
+ "timezone": "string",
+ "calendarId": "string",
+ "parentEventId": "string",
+ "extId": "string",
+ "extMetadata": {}
+ }
+]
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Array of Calendar has many Event|Inline|
+
+Response Schema
+
+Status Code **200**
+
+|Name|Type|Required|Restrictions|Description|
+|---|---|---|---|---|
+|*anonymous*|[[Event](#schemaevent)]|false|none|none|
+|» Event|[Event](#schemaevent)|false|none|none|
+|»» deleted|boolean|false|none|none|
+|»» deletedOn|string(date-time)¦null|false|none|none|
+|»» deletedBy|string¦null|false|none|none|
+|»» createdOn|string(date-time)|false|none|none|
+|»» modifiedOn|string(date-time)|false|none|none|
+|»» createdBy|string|false|none|none|
+|»» modifiedBy|string|false|none|none|
+|»» id|string|false|none|none|
+|»» bgColor|string|false|none|none|
+|»» description|string|false|none|none|
+|»» endDateTime|string(date-time)|false|none|none|
+|»» fgColor|string|false|none|none|
+|»» iCalUid|string|false|none|none|
+|»» isFullDayEvent|boolean|false|none|none|
+|»» isLocked|boolean|false|none|none|
+|»» link|string|false|none|none|
+|»» location|string|false|none|none|
+|»» meetingLink|string|false|none|none|
+|»» identifier|string|false|none|none|
+|»» startDateTime|string(date-time)|false|none|none|
+|»» status|string|false|none|none|
+|»» summary|string|false|none|none|
+|»» timezone|string|false|none|none|
+|»» calendarId|string|true|none|none|
+|»» parentEventId|string|false|none|none|
+|»» extId|string|false|none|none|
+|»» extMetadata|object|false|none|none|
+
+#### Enumerated Values
+
+|Property|Value|
+|---|---|
+|status|confirmed|
+|status|tentative|
+|status|cancelled|
+|status|completed|
+
+
+This operation does not require authentication
+
+
+## CalendarEventController.delete
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|where|query|object|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "count": 0
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Calendar.Event DELETE success count|[loopback.Count](#schemaloopback.count)|
+
+
+This operation does not require authentication
+
+
+CalendarSubscriptionController
+
+## CalendarSubscriptionController.create
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|body|body|[NewSubscriptionInCalendar](#schemanewsubscriptionincalendar)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "accessRole": "freeBusyReader",
+ "bgColor": "string",
+ "fgColor": "string",
+ "isHidden": true,
+ "isPrimary": true,
+ "identifier": "string",
+ "defaultReminders": {},
+ "notificationSettings": {},
+ "calendarId": "string",
+ "extId": "string",
+ "extMetadata": {}
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Calendar model instance|[Subscription](#schemasubscription)|
+
+
+This operation does not require authentication
+
+
+## CalendarSubscriptionController.patch
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|where|query|object|false|none|
+|body|body|[SubscriptionPartial](#schemasubscriptionpartial)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "count": 0
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Calendar.Subscription PATCH success count|[loopback.Count](#schemaloopback.count)|
+
+
+This operation does not require authentication
+
+
+## CalendarSubscriptionController.find
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|filter|query|object|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+[
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "accessRole": "freeBusyReader",
+ "bgColor": "string",
+ "fgColor": "string",
+ "isHidden": true,
+ "isPrimary": true,
+ "identifier": "string",
+ "defaultReminders": {},
+ "notificationSettings": {},
+ "calendarId": "string",
+ "extId": "string",
+ "extMetadata": {}
+ }
+]
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Array of Calendar has many Subscriptions|Inline|
+
+Response Schema
+
+Status Code **200**
+
+|Name|Type|Required|Restrictions|Description|
+|---|---|---|---|---|
+|*anonymous*|[[Subscription](#schemasubscription)]|false|none|none|
+|» Subscription|[Subscription](#schemasubscription)|false|none|none|
+|»» deleted|boolean|false|none|none|
+|»» deletedOn|string(date-time)¦null|false|none|none|
+|»» deletedBy|string¦null|false|none|none|
+|»» createdOn|string(date-time)|false|none|none|
+|»» modifiedOn|string(date-time)|false|none|none|
+|»» createdBy|string|false|none|none|
+|»» modifiedBy|string|false|none|none|
+|»» id|string|false|none|none|
+|»» accessRole|string|false|none|none|
+|»» bgColor|string|false|none|none|
+|»» fgColor|string|false|none|none|
+|»» isHidden|boolean|false|none|none|
+|»» isPrimary|boolean|false|none|none|
+|»» identifier|string|true|none|none|
+|»» defaultReminders|object|false|none|none|
+|»» notificationSettings|object|false|none|none|
+|»» calendarId|string|true|none|none|
+|»» extId|string|false|none|none|
+|»» extMetadata|object|false|none|none|
+
+#### Enumerated Values
+
+|Property|Value|
+|---|---|
+|accessRole|freeBusyReader|
+|accessRole|reader|
+|accessRole|writer|
+|accessRole|owner|
+
+
+This operation does not require authentication
+
+
+## CalendarSubscriptionController.delete
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|where|query|object|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "count": 0
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Calendar.Subscription DELETE success count|[loopback.Count](#schemaloopback.count)|
+
+
+This operation does not require authentication
+
+
+CalendarWorkingHourController
+
+## CalendarWorkingHourController.create
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|body|body|[NewWorkingHourInCalendar](#schemanewworkinghourincalendar)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "dayOfWeek": 0,
+ "end": "string",
+ "start": "string",
+ "calendarId": "string",
+ "extId": "string",
+ "extMetadata": {}
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Calendar model instance|[WorkingHour](#schemaworkinghour)|
+
+
+This operation does not require authentication
+
+
+## CalendarWorkingHourController.patch
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|where|query|object|false|none|
+|body|body|[WorkingHourPartial](#schemaworkinghourpartial)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "count": 0
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Calendar.WorkingHour PATCH success count|[loopback.Count](#schemaloopback.count)|
+
+
+This operation does not require authentication
+
+
+## CalendarWorkingHourController.find
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|filter|query|object|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+[
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "dayOfWeek": 0,
+ "end": "string",
+ "start": "string",
+ "calendarId": "string",
+ "extId": "string",
+ "extMetadata": {}
+ }
+]
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Array of Calendar has many WorkingHour|Inline|
+
+Response Schema
+
+Status Code **200**
+
+|Name|Type|Required|Restrictions|Description|
+|---|---|---|---|---|
+|*anonymous*|[[WorkingHour](#schemaworkinghour)]|false|none|none|
+|» WorkingHour|[WorkingHour](#schemaworkinghour)|false|none|none|
+|»» deleted|boolean|false|none|none|
+|»» deletedOn|string(date-time)¦null|false|none|none|
+|»» deletedBy|string¦null|false|none|none|
+|»» createdOn|string(date-time)|false|none|none|
+|»» modifiedOn|string(date-time)|false|none|none|
+|»» createdBy|string|false|none|none|
+|»» modifiedBy|string|false|none|none|
+|»» id|string|false|none|none|
+|»» dayOfWeek|number|false|none|none|
+|»» end|string|false|none|none|
+|»» start|string|false|none|none|
+|»» calendarId|string|true|none|none|
+|»» extId|string|false|none|none|
+|»» extMetadata|object|false|none|none|
+
+#### Enumerated Values
+
+|Property|Value|
+|---|---|
+|dayOfWeek|0|
+|dayOfWeek|1|
+|dayOfWeek|2|
+|dayOfWeek|3|
+|dayOfWeek|4|
+|dayOfWeek|5|
+|dayOfWeek|6|
+
+
+This operation does not require authentication
+
+
+## CalendarWorkingHourController.delete
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|where|query|object|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "count": 0
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Calendar.WorkingHour DELETE success count|[loopback.Count](#schemaloopback.count)|
+
+
+This operation does not require authentication
+
+
+EventController
+
+## EventController.count
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|where|query|object|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "count": 0
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Event model count|[loopback.Count](#schemaloopback.count)|
+
+
+This operation does not require authentication
+
+
+## EventController.getFeeBusyStatus
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|body|body|[FreeBusyRequest](#schemafreebusyrequest)|false|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Return value of EventController.getFeeBusyStatus|None|
+
+
+This operation does not require authentication
+
+
+## EventController.replaceById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|body|body|[Event](#schemaevent)|false|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|Event PUT success|None|
+
+
+This operation does not require authentication
+
+
+## EventController.updateById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|body|body|[EventPartial](#schemaeventpartial)|false|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|Event PATCH success|None|
+
+
+This operation does not require authentication
+
+
+## EventController.findById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|filter|query|[events.Filter](#schemaevents.filter)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "bgColor": "string",
+ "description": "string",
+ "endDateTime": "2019-08-24T14:15:22Z",
+ "fgColor": "string",
+ "iCalUid": "string",
+ "isFullDayEvent": true,
+ "isLocked": true,
+ "link": "string",
+ "location": "string",
+ "meetingLink": "string",
+ "identifier": "string",
+ "startDateTime": "2019-08-24T14:15:22Z",
+ "status": "confirmed",
+ "summary": "string",
+ "timezone": "string",
+ "calendarId": "string",
+ "parentEventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "source": "string",
+ "enableWorkingHours": true,
+ "location": "string",
+ "identifier": "string",
+ "summary": "string",
+ "timezone": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "events": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "bgColor": "string",
+ "description": "string",
+ "endDateTime": "2019-08-24T14:15:22Z",
+ "fgColor": "string",
+ "iCalUid": "string",
+ "isFullDayEvent": true,
+ "isLocked": true,
+ "link": "string",
+ "location": "string",
+ "meetingLink": "string",
+ "identifier": "string",
+ "startDateTime": "2019-08-24T14:15:22Z",
+ "status": "confirmed",
+ "summary": "string",
+ "timezone": "string",
+ "calendarId": "string",
+ "parentEventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {},
+ "parentEvent": {},
+ "attendees": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "identifier": "string",
+ "isOptional": true,
+ "isOrganizer": true,
+ "messages": "string",
+ "responseStatus": "needsAction",
+ "eventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "event": {}
+ }
+ ],
+ "attachments": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "fileUrl": "string",
+ "iconLink": "string",
+ "mimeType": "string",
+ "title": "string",
+ "eventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "event": {}
+ }
+ ]
+ }
+ ],
+ "workingHours": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "dayOfWeek": 0,
+ "end": "string",
+ "start": "string",
+ "calendarId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {}
+ }
+ ],
+ "subscriptions": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "accessRole": "freeBusyReader",
+ "bgColor": "string",
+ "fgColor": "string",
+ "isHidden": true,
+ "isPrimary": true,
+ "identifier": "string",
+ "defaultReminders": {},
+ "notificationSettings": {},
+ "calendarId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {}
+ }
+ ]
+ },
+ "parentEvent": {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "bgColor": "string",
+ "description": "string",
+ "endDateTime": "2019-08-24T14:15:22Z",
+ "fgColor": "string",
+ "iCalUid": "string",
+ "isFullDayEvent": true,
+ "isLocked": true,
+ "link": "string",
+ "location": "string",
+ "meetingLink": "string",
+ "identifier": "string",
+ "startDateTime": "2019-08-24T14:15:22Z",
+ "status": "confirmed",
+ "summary": "string",
+ "timezone": "string",
+ "calendarId": "string",
+ "parentEventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "source": "string",
+ "enableWorkingHours": true,
+ "location": "string",
+ "identifier": "string",
+ "summary": "string",
+ "timezone": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "events": [
+ {}
+ ],
+ "workingHours": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "dayOfWeek": 0,
+ "end": "string",
+ "start": "string",
+ "calendarId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {}
+ }
+ ],
+ "subscriptions": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "accessRole": "freeBusyReader",
+ "bgColor": "string",
+ "fgColor": "string",
+ "isHidden": true,
+ "isPrimary": true,
+ "identifier": "string",
+ "defaultReminders": {},
+ "notificationSettings": {},
+ "calendarId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {}
+ }
+ ]
+ },
+ "parentEvent": {},
+ "attendees": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "identifier": "string",
+ "isOptional": true,
+ "isOrganizer": true,
+ "messages": "string",
+ "responseStatus": "needsAction",
+ "eventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "event": {}
+ }
+ ],
+ "attachments": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "fileUrl": "string",
+ "iconLink": "string",
+ "mimeType": "string",
+ "title": "string",
+ "eventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "event": {}
+ }
+ ]
+ },
+ "attendees": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "identifier": "string",
+ "isOptional": true,
+ "isOrganizer": true,
+ "messages": "string",
+ "responseStatus": "needsAction",
+ "eventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "event": {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "bgColor": "string",
+ "description": "string",
+ "endDateTime": "2019-08-24T14:15:22Z",
+ "fgColor": "string",
+ "iCalUid": "string",
+ "isFullDayEvent": true,
+ "isLocked": true,
+ "link": "string",
+ "location": "string",
+ "meetingLink": "string",
+ "identifier": "string",
+ "startDateTime": "2019-08-24T14:15:22Z",
+ "status": "confirmed",
+ "summary": "string",
+ "timezone": "string",
+ "calendarId": "string",
+ "parentEventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "source": "string",
+ "enableWorkingHours": true,
+ "location": "string",
+ "identifier": "string",
+ "summary": "string",
+ "timezone": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "events": [
+ {}
+ ],
+ "workingHours": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "dayOfWeek": 0,
+ "end": "string",
+ "start": "string",
+ "calendarId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {}
+ }
+ ],
+ "subscriptions": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "accessRole": "freeBusyReader",
+ "bgColor": "string",
+ "fgColor": "string",
+ "isHidden": true,
+ "isPrimary": true,
+ "identifier": "string",
+ "defaultReminders": {},
+ "notificationSettings": {},
+ "calendarId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {}
+ }
+ ]
+ },
+ "parentEvent": {},
+ "attendees": [],
+ "attachments": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "fileUrl": "string",
+ "iconLink": "string",
+ "mimeType": "string",
+ "title": "string",
+ "eventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "event": {}
+ }
+ ]
+ }
+ }
+ ],
+ "attachments": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "fileUrl": "string",
+ "iconLink": "string",
+ "mimeType": "string",
+ "title": "string",
+ "eventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "event": {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "bgColor": "string",
+ "description": "string",
+ "endDateTime": "2019-08-24T14:15:22Z",
+ "fgColor": "string",
+ "iCalUid": "string",
+ "isFullDayEvent": true,
+ "isLocked": true,
+ "link": "string",
+ "location": "string",
+ "meetingLink": "string",
+ "identifier": "string",
+ "startDateTime": "2019-08-24T14:15:22Z",
+ "status": "confirmed",
+ "summary": "string",
+ "timezone": "string",
+ "calendarId": "string",
+ "parentEventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "source": "string",
+ "enableWorkingHours": true,
+ "location": "string",
+ "identifier": "string",
+ "summary": "string",
+ "timezone": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "events": [
+ {}
+ ],
+ "workingHours": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "dayOfWeek": 0,
+ "end": "string",
+ "start": "string",
+ "calendarId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {}
+ }
+ ],
+ "subscriptions": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "accessRole": "freeBusyReader",
+ "bgColor": "string",
+ "fgColor": "string",
+ "isHidden": true,
+ "isPrimary": true,
+ "identifier": "string",
+ "defaultReminders": {},
+ "notificationSettings": {},
+ "calendarId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {}
+ }
+ ]
+ },
+ "parentEvent": {},
+ "attendees": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "identifier": "string",
+ "isOptional": true,
+ "isOrganizer": true,
+ "messages": "string",
+ "responseStatus": "needsAction",
+ "eventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "event": {}
+ }
+ ],
+ "attachments": []
+ }
+ }
+ ]
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Event model instance|[EventWithRelations](#schemaeventwithrelations)|
+
+
+This operation does not require authentication
+
+
+## EventController.deleteById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|Event DELETE success|None|
+
+
+This operation does not require authentication
+
+
+## EventController.create
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|body|body|[NewEvent](#schemanewevent)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "bgColor": "string",
+ "description": "string",
+ "endDateTime": "2019-08-24T14:15:22Z",
+ "fgColor": "string",
+ "iCalUid": "string",
+ "isFullDayEvent": true,
+ "isLocked": true,
+ "link": "string",
+ "location": "string",
+ "meetingLink": "string",
+ "identifier": "string",
+ "startDateTime": "2019-08-24T14:15:22Z",
+ "status": "confirmed",
+ "summary": "string",
+ "timezone": "string",
+ "calendarId": "string",
+ "parentEventId": "string",
+ "extId": "string",
+ "extMetadata": {}
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Event model instance|[Event](#schemaevent)|
+
+
+This operation does not require authentication
+
+
+## EventController.updateAll
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|where|query|object|false|none|
+|body|body|[EventPartial](#schemaeventpartial)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "count": 0
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Event PATCH success count|[loopback.Count](#schemaloopback.count)|
+
+
+This operation does not require authentication
+
+
+## EventController.find
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|filter|query|[events_attendees_view.Filter](#schemaevents_attendees_view.filter)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+[
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "bgColor": "string",
+ "description": "string",
+ "endDateTime": "2019-08-24T14:15:22Z",
+ "fgColor": "string",
+ "iCalUid": "string",
+ "isFullDayEvent": true,
+ "isLocked": true,
+ "link": "string",
+ "location": "string",
+ "meetingLink": "string",
+ "identifier": "string",
+ "startDateTime": "2019-08-24T14:15:22Z",
+ "status": "confirmed",
+ "summary": "string",
+ "timezone": "string",
+ "calendarId": "string",
+ "parentEventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "source": "string",
+ "enableWorkingHours": true,
+ "location": "string",
+ "identifier": "string",
+ "summary": "string",
+ "timezone": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "events": [
+ {}
+ ],
+ "workingHours": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "dayOfWeek": 0,
+ "end": "string",
+ "start": "string",
+ "calendarId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {}
+ }
+ ],
+ "subscriptions": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "accessRole": "freeBusyReader",
+ "bgColor": "string",
+ "fgColor": "string",
+ "isHidden": true,
+ "isPrimary": true,
+ "identifier": "string",
+ "defaultReminders": {},
+ "notificationSettings": {},
+ "calendarId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {}
+ }
+ ]
+ },
+ "parentEvent": {},
+ "attendees": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "identifier": "string",
+ "isOptional": true,
+ "isOrganizer": true,
+ "messages": "string",
+ "responseStatus": "needsAction",
+ "eventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "event": {}
+ }
+ ],
+ "attachments": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "fileUrl": "string",
+ "iconLink": "string",
+ "mimeType": "string",
+ "title": "string",
+ "eventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "event": {}
+ }
+ ]
+ }
+]
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Array of Event model instances|Inline|
+
+Response Schema
+
+Status Code **200**
+
+|Name|Type|Required|Restrictions|Description|
+|---|---|---|---|---|
+|*anonymous*|[[EventWithRelations](#schemaeventwithrelations)]|false|none|[(tsType: EventWithRelations, schemaOptions: { includeRelations: true })]|
+|» EventWithRelations|[EventWithRelations](#schemaeventwithrelations)|false|none|(tsType: EventWithRelations, schemaOptions: { includeRelations: true })|
+|»» deleted|boolean|false|none|none|
+|»» deletedOn|string(date-time)¦null|false|none|none|
+|»» deletedBy|string¦null|false|none|none|
+|»» createdOn|string(date-time)|false|none|none|
+|»» modifiedOn|string(date-time)|false|none|none|
+|»» createdBy|string|false|none|none|
+|»» modifiedBy|string|false|none|none|
+|»» id|string|false|none|none|
+|»» bgColor|string|false|none|none|
+|»» description|string|false|none|none|
+|»» endDateTime|string(date-time)|false|none|none|
+|»» fgColor|string|false|none|none|
+|»» iCalUid|string|false|none|none|
+|»» isFullDayEvent|boolean|false|none|none|
+|»» isLocked|boolean|false|none|none|
+|»» link|string|false|none|none|
+|»» location|string|false|none|none|
+|»» meetingLink|string|false|none|none|
+|»» identifier|string|false|none|none|
+|»» startDateTime|string(date-time)|false|none|none|
+|»» status|string|false|none|none|
+|»» summary|string|false|none|none|
+|»» timezone|string|false|none|none|
+|»» calendarId|string|true|none|none|
+|»» parentEventId|string|false|none|none|
+|»» extId|string|false|none|none|
+|»» extMetadata|object|false|none|none|
+|»» calendar|[CalendarWithRelations](#schemacalendarwithrelations)|false|none|(tsType: CalendarWithRelations, schemaOptions: { includeRelations: true })|
+|»»» deleted|boolean|false|none|none|
+|»»» deletedOn|string(date-time)¦null|false|none|none|
+|»»» deletedBy|string¦null|false|none|none|
+|»»» createdOn|string(date-time)|false|none|none|
+|»»» modifiedOn|string(date-time)|false|none|none|
+|»»» createdBy|string|false|none|none|
+|»»» modifiedBy|string|false|none|none|
+|»»» id|string|false|none|none|
+|»»» source|string|false|none|none|
+|»»» enableWorkingHours|boolean|false|none|none|
+|»»» location|string|false|none|none|
+|»»» identifier|string|true|none|none|
+|»»» summary|string|false|none|none|
+|»»» timezone|string|false|none|none|
+|»»» extId|string|false|none|none|
+|»»» extMetadata|object|false|none|none|
+|»»» events|[[EventWithRelations](#schemaeventwithrelations)]|false|none|(tsType: EventWithRelations, schemaOptions: { includeRelations: true })|
+|»»»» EventWithRelations|[EventWithRelations](#schemaeventwithrelations)|false|none|(tsType: EventWithRelations, schemaOptions: { includeRelations: true })|
+|»»» workingHours|[[WorkingHourWithRelations](#schemaworkinghourwithrelations)]|false|none|(tsType: WorkingHourWithRelations, schemaOptions: { includeRelations: true })|
+|»»»» WorkingHourWithRelations|[WorkingHourWithRelations](#schemaworkinghourwithrelations)|false|none|(tsType: WorkingHourWithRelations, schemaOptions: { includeRelations: true })|
+|»»»»» deleted|boolean|false|none|none|
+|»»»»» deletedOn|string(date-time)¦null|false|none|none|
+|»»»»» deletedBy|string¦null|false|none|none|
+|»»»»» createdOn|string(date-time)|false|none|none|
+|»»»»» modifiedOn|string(date-time)|false|none|none|
+|»»»»» createdBy|string|false|none|none|
+|»»»»» modifiedBy|string|false|none|none|
+|»»»»» id|string|false|none|none|
+|»»»»» dayOfWeek|number|false|none|none|
+|»»»»» end|string|false|none|none|
+|»»»»» start|string|false|none|none|
+|»»»»» calendarId|string|true|none|none|
+|»»»»» extId|string|false|none|none|
+|»»»»» extMetadata|object|false|none|none|
+|»»»»» calendar|[CalendarWithRelations](#schemacalendarwithrelations)|false|none|(tsType: CalendarWithRelations, schemaOptions: { includeRelations: true })|
+|»»» subscriptions|[[SubscriptionWithRelations](#schemasubscriptionwithrelations)]|false|none|(tsType: SubscriptionWithRelations, schemaOptions: { includeRelations: true })|
+|»»»» SubscriptionWithRelations|[SubscriptionWithRelations](#schemasubscriptionwithrelations)|false|none|(tsType: SubscriptionWithRelations, schemaOptions: { includeRelations: true })|
+|»»»»» deleted|boolean|false|none|none|
+|»»»»» deletedOn|string(date-time)¦null|false|none|none|
+|»»»»» deletedBy|string¦null|false|none|none|
+|»»»»» createdOn|string(date-time)|false|none|none|
+|»»»»» modifiedOn|string(date-time)|false|none|none|
+|»»»»» createdBy|string|false|none|none|
+|»»»»» modifiedBy|string|false|none|none|
+|»»»»» id|string|false|none|none|
+|»»»»» accessRole|string|false|none|none|
+|»»»»» bgColor|string|false|none|none|
+|»»»»» fgColor|string|false|none|none|
+|»»»»» isHidden|boolean|false|none|none|
+|»»»»» isPrimary|boolean|false|none|none|
+|»»»»» identifier|string|true|none|none|
+|»»»»» defaultReminders|object|false|none|none|
+|»»»»» notificationSettings|object|false|none|none|
+|»»»»» calendarId|string|true|none|none|
+|»»»»» extId|string|false|none|none|
+|»»»»» extMetadata|object|false|none|none|
+|»»»»» calendar|[CalendarWithRelations](#schemacalendarwithrelations)|false|none|(tsType: CalendarWithRelations, schemaOptions: { includeRelations: true })|
+|»» parentEvent|[EventWithRelations](#schemaeventwithrelations)|false|none|(tsType: EventWithRelations, schemaOptions: { includeRelations: true })|
+|»» attendees|[[AttendeeWithRelations](#schemaattendeewithrelations)]|false|none|(tsType: AttendeeWithRelations, schemaOptions: { includeRelations: true })|
+|»»» AttendeeWithRelations|[AttendeeWithRelations](#schemaattendeewithrelations)|false|none|(tsType: AttendeeWithRelations, schemaOptions: { includeRelations: true })|
+|»»»» deleted|boolean|false|none|none|
+|»»»» deletedOn|string(date-time)¦null|false|none|none|
+|»»»» deletedBy|string¦null|false|none|none|
+|»»»» createdOn|string(date-time)|false|none|none|
+|»»»» modifiedOn|string(date-time)|false|none|none|
+|»»»» createdBy|string|false|none|none|
+|»»»» modifiedBy|string|false|none|none|
+|»»»» id|string|false|none|none|
+|»»»» identifier|string|true|none|none|
+|»»»» isOptional|boolean|false|none|none|
+|»»»» isOrganizer|boolean|false|none|none|
+|»»»» messages|string|false|none|none|
+|»»»» responseStatus|string|false|none|none|
+|»»»» eventId|string|true|none|none|
+|»»»» extId|string|false|none|none|
+|»»»» extMetadata|object|false|none|none|
+|»»»» event|[EventWithRelations](#schemaeventwithrelations)|false|none|(tsType: EventWithRelations, schemaOptions: { includeRelations: true })|
+|»» attachments|[[AttachmentWithRelations](#schemaattachmentwithrelations)]|false|none|(tsType: AttachmentWithRelations, schemaOptions: { includeRelations: true })|
+|»»» AttachmentWithRelations|[AttachmentWithRelations](#schemaattachmentwithrelations)|false|none|(tsType: AttachmentWithRelations, schemaOptions: { includeRelations: true })|
+|»»»» deleted|boolean|false|none|none|
+|»»»» deletedOn|string(date-time)¦null|false|none|none|
+|»»»» deletedBy|string¦null|false|none|none|
+|»»»» createdOn|string(date-time)|false|none|none|
+|»»»» modifiedOn|string(date-time)|false|none|none|
+|»»»» createdBy|string|false|none|none|
+|»»»» modifiedBy|string|false|none|none|
+|»»»» id|string|false|none|none|
+|»»»» fileUrl|string|true|none|none|
+|»»»» iconLink|string|false|none|none|
+|»»»» mimeType|string|false|none|none|
+|»»»» title|string|false|none|none|
+|»»»» eventId|string|true|none|none|
+|»»»» extId|string|false|none|none|
+|»»»» extMetadata|object|false|none|none|
+|»»»» event|[EventWithRelations](#schemaeventwithrelations)|false|none|(tsType: EventWithRelations, schemaOptions: { includeRelations: true })|
+
+#### Enumerated Values
+
+|Property|Value|
+|---|---|
+|status|confirmed|
+|status|tentative|
+|status|cancelled|
+|status|completed|
+|dayOfWeek|0|
+|dayOfWeek|1|
+|dayOfWeek|2|
+|dayOfWeek|3|
+|dayOfWeek|4|
+|dayOfWeek|5|
+|dayOfWeek|6|
+|accessRole|freeBusyReader|
+|accessRole|reader|
+|accessRole|writer|
+|accessRole|owner|
+|responseStatus|needsAction|
+|responseStatus|tentative|
+|responseStatus|accepted|
+|responseStatus|declined|
+
+
+This operation does not require authentication
+
+
+EventAttachmentController
+
+## EventAttachmentController.create
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|body|body|[NewAttachmentInEvent](#schemanewattachmentinevent)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "fileUrl": "string",
+ "iconLink": "string",
+ "mimeType": "string",
+ "title": "string",
+ "eventId": "string",
+ "extId": "string",
+ "extMetadata": {}
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Event model instance|[Attachment](#schemaattachment)|
+
+
+This operation does not require authentication
+
+
+## EventAttachmentController.patch
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|where|query|object|false|none|
+|body|body|[AttachmentPartial](#schemaattachmentpartial)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "count": 0
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Event.Attachment PATCH success count|[loopback.Count](#schemaloopback.count)|
+
+
+This operation does not require authentication
+
+
+## EventAttachmentController.find
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|filter|query|object|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+[
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "fileUrl": "string",
+ "iconLink": "string",
+ "mimeType": "string",
+ "title": "string",
+ "eventId": "string",
+ "extId": "string",
+ "extMetadata": {}
+ }
+]
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Array of Event has many Attachment|Inline|
+
+Response Schema
+
+Status Code **200**
+
+|Name|Type|Required|Restrictions|Description|
+|---|---|---|---|---|
+|*anonymous*|[[Attachment](#schemaattachment)]|false|none|none|
+|» Attachment|[Attachment](#schemaattachment)|false|none|none|
+|»» deleted|boolean|false|none|none|
+|»» deletedOn|string(date-time)¦null|false|none|none|
+|»» deletedBy|string¦null|false|none|none|
+|»» createdOn|string(date-time)|false|none|none|
+|»» modifiedOn|string(date-time)|false|none|none|
+|»» createdBy|string|false|none|none|
+|»» modifiedBy|string|false|none|none|
+|»» id|string|false|none|none|
+|»» fileUrl|string|true|none|none|
+|»» iconLink|string|false|none|none|
+|»» mimeType|string|false|none|none|
+|»» title|string|false|none|none|
+|»» eventId|string|true|none|none|
+|»» extId|string|false|none|none|
+|»» extMetadata|object|false|none|none|
+
+
+This operation does not require authentication
+
+
+## EventAttachmentController.delete
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|where|query|object|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "count": 0
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Event.Attachment DELETE success count|[loopback.Count](#schemaloopback.count)|
+
+
+This operation does not require authentication
+
+
+EventAttendeeController
+
+## EventAttendeeController.create
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|body|body|[NewAttendeeInEvent](#schemanewattendeeinevent)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "identifier": "string",
+ "isOptional": true,
+ "isOrganizer": true,
+ "messages": "string",
+ "responseStatus": "needsAction",
+ "eventId": "string",
+ "extId": "string",
+ "extMetadata": {}
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Event model instance|[Attendee](#schemaattendee)|
+
+
+This operation does not require authentication
+
+
+## EventAttendeeController.patch
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|where|query|object|false|none|
+|body|body|[AttendeePartial](#schemaattendeepartial)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "count": 0
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Event.Attendee PATCH success count|[loopback.Count](#schemaloopback.count)|
+
+
+This operation does not require authentication
+
+
+## EventAttendeeController.find
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|filter|query|object|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+[
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "identifier": "string",
+ "isOptional": true,
+ "isOrganizer": true,
+ "messages": "string",
+ "responseStatus": "needsAction",
+ "eventId": "string",
+ "extId": "string",
+ "extMetadata": {}
+ }
+]
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Array of Event has many Attendee|Inline|
+
+Response Schema
+
+Status Code **200**
+
+|Name|Type|Required|Restrictions|Description|
+|---|---|---|---|---|
+|*anonymous*|[[Attendee](#schemaattendee)]|false|none|none|
+|» Attendee|[Attendee](#schemaattendee)|false|none|none|
+|»» deleted|boolean|false|none|none|
+|»» deletedOn|string(date-time)¦null|false|none|none|
+|»» deletedBy|string¦null|false|none|none|
+|»» createdOn|string(date-time)|false|none|none|
+|»» modifiedOn|string(date-time)|false|none|none|
+|»» createdBy|string|false|none|none|
+|»» modifiedBy|string|false|none|none|
+|»» id|string|false|none|none|
+|»» identifier|string|true|none|none|
+|»» isOptional|boolean|false|none|none|
+|»» isOrganizer|boolean|false|none|none|
+|»» messages|string|false|none|none|
+|»» responseStatus|string|false|none|none|
+|»» eventId|string|true|none|none|
+|»» extId|string|false|none|none|
+|»» extMetadata|object|false|none|none|
+
+#### Enumerated Values
+
+|Property|Value|
+|---|---|
+|responseStatus|needsAction|
+|responseStatus|tentative|
+|responseStatus|accepted|
+|responseStatus|declined|
+
+
+This operation does not require authentication
+
+
+## EventAttendeeController.delete
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|where|query|object|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "count": 0
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Event.Attendee DELETE success count|[loopback.Count](#schemaloopback.count)|
+
+
+This operation does not require authentication
+
+
+PingController
+
+## PingController.ping
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Ping Response|[PingResponse](#schemapingresponse)|
+
+
+This operation does not require authentication
+
+
+SettingsController
+
+## SettingsController.count
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|where|query|object|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "count": 0
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Settings model count|[loopback.Count](#schemaloopback.count)|
+
+
+This operation does not require authentication
+
+
+## SettingsController.replaceById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|body|body|[Settings](#schemasettings)|false|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|Settings PUT success|None|
+
+
+This operation does not require authentication
+
+
+## SettingsController.updateById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|body|body|[SettingsPartial](#schemasettingspartial)|false|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|Settings PATCH success|None|
+
+
+This operation does not require authentication
+
+
+## SettingsController.findById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|filter|query|[settings.Filter](#schemasettings.filter)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "ownerId": "string",
+ "ownerType": "global",
+ "settingName": "string",
+ "settingValue": "string",
+ "extId": "string",
+ "extMetadata": {}
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Settings model instance|[SettingsWithRelations](#schemasettingswithrelations)|
+
+
+This operation does not require authentication
+
+
+## SettingsController.deleteById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|Settings DELETE success|None|
+
+
+This operation does not require authentication
+
+
+## SettingsController.create
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|body|body|[NewSettings](#schemanewsettings)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "ownerId": "string",
+ "ownerType": "global",
+ "settingName": "string",
+ "settingValue": "string",
+ "extId": "string",
+ "extMetadata": {}
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Settings model instance|[Settings](#schemasettings)|
+
+
+This operation does not require authentication
+
+
+## SettingsController.updateAll
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|where|query|object|false|none|
+|body|body|[SettingsPartial](#schemasettingspartial)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "count": 0
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Settings PATCH success count|[loopback.Count](#schemaloopback.count)|
+
+
+This operation does not require authentication
+
+
+## SettingsController.find
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|filter|query|[settings.Filter1](#schemasettings.filter1)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+[
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "ownerId": "string",
+ "ownerType": "global",
+ "settingName": "string",
+ "settingValue": "string",
+ "extId": "string",
+ "extMetadata": {}
+ }
+]
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Array of Settings model instances|Inline|
+
+Response Schema
+
+Status Code **200**
+
+|Name|Type|Required|Restrictions|Description|
+|---|---|---|---|---|
+|*anonymous*|[[SettingsWithRelations](#schemasettingswithrelations)]|false|none|[(tsType: SettingsWithRelations, schemaOptions: { includeRelations: true })]|
+|» SettingsWithRelations|[SettingsWithRelations](#schemasettingswithrelations)|false|none|(tsType: SettingsWithRelations, schemaOptions: { includeRelations: true })|
+|»» deleted|boolean|false|none|none|
+|»» deletedOn|string(date-time)¦null|false|none|none|
+|»» deletedBy|string¦null|false|none|none|
+|»» createdOn|string(date-time)|false|none|none|
+|»» modifiedOn|string(date-time)|false|none|none|
+|»» createdBy|string|false|none|none|
+|»» modifiedBy|string|false|none|none|
+|»» id|string|false|none|none|
+|»» ownerId|string|true|none|none|
+|»» ownerType|string|false|none|none|
+|»» settingName|string|false|none|none|
+|»» settingValue|string|false|none|none|
+|»» extId|string|false|none|none|
+|»» extMetadata|object|false|none|none|
+
+#### Enumerated Values
+
+|Property|Value|
+|---|---|
+|ownerType|global|
+|ownerType|user|
+|ownerType|calendar|
+|ownerType|event|
+
+
+This operation does not require authentication
+
+
+ThemeController
+
+## ThemeController.count
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|where|query|object|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "count": 0
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Theme model count|[loopback.Count](#schemaloopback.count)|
+
+
+This operation does not require authentication
+
+
+## ThemeController.replaceById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|body|body|[Theme](#schematheme)|false|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|Theme PUT success|None|
+
+
+This operation does not require authentication
+
+
+## ThemeController.updateById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|body|body|[ThemePartial](#schemathemepartial)|false|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|Theme PATCH success|None|
+
+
+This operation does not require authentication
+
+
+## ThemeController.findById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|filter|query|[themes.Filter](#schemathemes.filter)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "calBg": "string",
+ "calFg": "string",
+ "eventBg": "string",
+ "eventFg": "string",
+ "extId": "string",
+ "extMetadata": {}
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Theme model instance|[ThemeWithRelations](#schemathemewithrelations)|
+
+
+This operation does not require authentication
+
+
+## ThemeController.deleteById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|Theme DELETE success|None|
+
+
+This operation does not require authentication
+
+
+## ThemeController.create
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|body|body|[NewTheme](#schemanewtheme)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "calBg": "string",
+ "calFg": "string",
+ "eventBg": "string",
+ "eventFg": "string",
+ "extId": "string",
+ "extMetadata": {}
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Theme model instance|[Theme](#schematheme)|
+
+
+This operation does not require authentication
+
+
+## ThemeController.updateAll
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|where|query|object|false|none|
+|body|body|[ThemePartial](#schemathemepartial)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "count": 0
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Theme PATCH success count|[loopback.Count](#schemaloopback.count)|
+
+
+This operation does not require authentication
+
+
+## ThemeController.find
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|filter|query|[themes.Filter1](#schemathemes.filter1)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+[
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "calBg": "string",
+ "calFg": "string",
+ "eventBg": "string",
+ "eventFg": "string",
+ "extId": "string",
+ "extMetadata": {}
+ }
+]
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Array of Theme model instances|Inline|
+
+Response Schema
+
+Status Code **200**
+
+|Name|Type|Required|Restrictions|Description|
+|---|---|---|---|---|
+|*anonymous*|[[ThemeWithRelations](#schemathemewithrelations)]|false|none|[(tsType: ThemeWithRelations, schemaOptions: { includeRelations: true })]|
+|» ThemeWithRelations|[ThemeWithRelations](#schemathemewithrelations)|false|none|(tsType: ThemeWithRelations, schemaOptions: { includeRelations: true })|
+|»» deleted|boolean|false|none|none|
+|»» deletedOn|string(date-time)¦null|false|none|none|
+|»» deletedBy|string¦null|false|none|none|
+|»» createdOn|string(date-time)|false|none|none|
+|»» modifiedOn|string(date-time)|false|none|none|
+|»» createdBy|string|false|none|none|
+|»» modifiedBy|string|false|none|none|
+|»» id|string|false|none|none|
+|»» calBg|string|false|none|none|
+|»» calFg|string|false|none|none|
+|»» eventBg|string|false|none|none|
+|»» eventFg|string|false|none|none|
+|»» extId|string|false|none|none|
+|»» extMetadata|object|false|none|none|
+
+
+This operation does not require authentication
+
+
+WorkingHourController
+
+## WorkingHourController.count
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|where|query|object|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "count": 0
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|WorkingHour model count|[loopback.Count](#schemaloopback.count)|
+
+
+This operation does not require authentication
+
+
+## WorkingHourController.replaceById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|body|body|[WorkingHour](#schemaworkinghour)|false|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|WorkingHour PUT success|None|
+
+
+This operation does not require authentication
+
+
+## WorkingHourController.updateById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|body|body|[WorkingHourPartial](#schemaworkinghourpartial)|false|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|WorkingHour PATCH success|None|
+
+
+This operation does not require authentication
+
+
+## WorkingHourController.findById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|filter|query|[working_hours.Filter](#schemaworking_hours.filter)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "dayOfWeek": 0,
+ "end": "string",
+ "start": "string",
+ "calendarId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "source": "string",
+ "enableWorkingHours": true,
+ "location": "string",
+ "identifier": "string",
+ "summary": "string",
+ "timezone": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "events": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "bgColor": "string",
+ "description": "string",
+ "endDateTime": "2019-08-24T14:15:22Z",
+ "fgColor": "string",
+ "iCalUid": "string",
+ "isFullDayEvent": true,
+ "isLocked": true,
+ "link": "string",
+ "location": "string",
+ "meetingLink": "string",
+ "identifier": "string",
+ "startDateTime": "2019-08-24T14:15:22Z",
+ "status": "confirmed",
+ "summary": "string",
+ "timezone": "string",
+ "calendarId": "string",
+ "parentEventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {},
+ "parentEvent": {},
+ "attendees": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "identifier": "string",
+ "isOptional": true,
+ "isOrganizer": true,
+ "messages": "string",
+ "responseStatus": "needsAction",
+ "eventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "event": {}
+ }
+ ],
+ "attachments": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "fileUrl": "string",
+ "iconLink": "string",
+ "mimeType": "string",
+ "title": "string",
+ "eventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "event": {}
+ }
+ ]
+ }
+ ],
+ "workingHours": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "dayOfWeek": 0,
+ "end": "string",
+ "start": "string",
+ "calendarId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {}
+ }
+ ],
+ "subscriptions": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "accessRole": "freeBusyReader",
+ "bgColor": "string",
+ "fgColor": "string",
+ "isHidden": true,
+ "isPrimary": true,
+ "identifier": "string",
+ "defaultReminders": {},
+ "notificationSettings": {},
+ "calendarId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {}
+ }
+ ]
+ }
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|WorkingHour model instance|[WorkingHourWithRelations](#schemaworkinghourwithrelations)|
+
+
+This operation does not require authentication
+
+
+## WorkingHourController.deleteById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|WorkingHour DELETE success|None|
+
+
+This operation does not require authentication
+
+
+## WorkingHourController.create
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|body|body|[NewWorkingHour](#schemanewworkinghour)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "dayOfWeek": 0,
+ "end": "string",
+ "start": "string",
+ "calendarId": "string",
+ "extId": "string",
+ "extMetadata": {}
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|WorkingHour model instance|[WorkingHour](#schemaworkinghour)|
+
+
+This operation does not require authentication
+
+
+## WorkingHourController.updateAll
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|where|query|object|false|none|
+|body|body|[WorkingHourPartial](#schemaworkinghourpartial)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "count": 0
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|WorkingHour PATCH success count|[loopback.Count](#schemaloopback.count)|
+
+
+This operation does not require authentication
+
+
+## WorkingHourController.find
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|filter|query|[working_hours.Filter1](#schemaworking_hours.filter1)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+[
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "dayOfWeek": 0,
+ "end": "string",
+ "start": "string",
+ "calendarId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "source": "string",
+ "enableWorkingHours": true,
+ "location": "string",
+ "identifier": "string",
+ "summary": "string",
+ "timezone": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "events": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "bgColor": "string",
+ "description": "string",
+ "endDateTime": "2019-08-24T14:15:22Z",
+ "fgColor": "string",
+ "iCalUid": "string",
+ "isFullDayEvent": true,
+ "isLocked": true,
+ "link": "string",
+ "location": "string",
+ "meetingLink": "string",
+ "identifier": "string",
+ "startDateTime": "2019-08-24T14:15:22Z",
+ "status": "confirmed",
+ "summary": "string",
+ "timezone": "string",
+ "calendarId": "string",
+ "parentEventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {},
+ "parentEvent": {},
+ "attendees": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "identifier": "string",
+ "isOptional": true,
+ "isOrganizer": true,
+ "messages": "string",
+ "responseStatus": "needsAction",
+ "eventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "event": {}
+ }
+ ],
+ "attachments": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "fileUrl": "string",
+ "iconLink": "string",
+ "mimeType": "string",
+ "title": "string",
+ "eventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "event": {}
+ }
+ ]
+ }
+ ],
+ "workingHours": [
+ {}
+ ],
+ "subscriptions": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "accessRole": "freeBusyReader",
+ "bgColor": "string",
+ "fgColor": "string",
+ "isHidden": true,
+ "isPrimary": true,
+ "identifier": "string",
+ "defaultReminders": {},
+ "notificationSettings": {},
+ "calendarId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {}
+ }
+ ]
+ }
+ }
+]
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Array of WorkingHour model instances|Inline|
+
+Response Schema
+
+Status Code **200**
+
+|Name|Type|Required|Restrictions|Description|
+|---|---|---|---|---|
+|*anonymous*|[[WorkingHourWithRelations](#schemaworkinghourwithrelations)]|false|none|[(tsType: WorkingHourWithRelations, schemaOptions: { includeRelations: true })]|
+|» WorkingHourWithRelations|[WorkingHourWithRelations](#schemaworkinghourwithrelations)|false|none|(tsType: WorkingHourWithRelations, schemaOptions: { includeRelations: true })|
+|»» deleted|boolean|false|none|none|
+|»» deletedOn|string(date-time)¦null|false|none|none|
+|»» deletedBy|string¦null|false|none|none|
+|»» createdOn|string(date-time)|false|none|none|
+|»» modifiedOn|string(date-time)|false|none|none|
+|»» createdBy|string|false|none|none|
+|»» modifiedBy|string|false|none|none|
+|»» id|string|false|none|none|
+|»» dayOfWeek|number|false|none|none|
+|»» end|string|false|none|none|
+|»» start|string|false|none|none|
+|»» calendarId|string|true|none|none|
+|»» extId|string|false|none|none|
+|»» extMetadata|object|false|none|none|
+|»» calendar|[CalendarWithRelations](#schemacalendarwithrelations)|false|none|(tsType: CalendarWithRelations, schemaOptions: { includeRelations: true })|
+|»»» deleted|boolean|false|none|none|
+|»»» deletedOn|string(date-time)¦null|false|none|none|
+|»»» deletedBy|string¦null|false|none|none|
+|»»» createdOn|string(date-time)|false|none|none|
+|»»» modifiedOn|string(date-time)|false|none|none|
+|»»» createdBy|string|false|none|none|
+|»»» modifiedBy|string|false|none|none|
+|»»» id|string|false|none|none|
+|»»» source|string|false|none|none|
+|»»» enableWorkingHours|boolean|false|none|none|
+|»»» location|string|false|none|none|
+|»»» identifier|string|true|none|none|
+|»»» summary|string|false|none|none|
+|»»» timezone|string|false|none|none|
+|»»» extId|string|false|none|none|
+|»»» extMetadata|object|false|none|none|
+|»»» events|[[EventWithRelations](#schemaeventwithrelations)]|false|none|(tsType: EventWithRelations, schemaOptions: { includeRelations: true })|
+|»»»» EventWithRelations|[EventWithRelations](#schemaeventwithrelations)|false|none|(tsType: EventWithRelations, schemaOptions: { includeRelations: true })|
+|»»»»» deleted|boolean|false|none|none|
+|»»»»» deletedOn|string(date-time)¦null|false|none|none|
+|»»»»» deletedBy|string¦null|false|none|none|
+|»»»»» createdOn|string(date-time)|false|none|none|
+|»»»»» modifiedOn|string(date-time)|false|none|none|
+|»»»»» createdBy|string|false|none|none|
+|»»»»» modifiedBy|string|false|none|none|
+|»»»»» id|string|false|none|none|
+|»»»»» bgColor|string|false|none|none|
+|»»»»» description|string|false|none|none|
+|»»»»» endDateTime|string(date-time)|false|none|none|
+|»»»»» fgColor|string|false|none|none|
+|»»»»» iCalUid|string|false|none|none|
+|»»»»» isFullDayEvent|boolean|false|none|none|
+|»»»»» isLocked|boolean|false|none|none|
+|»»»»» link|string|false|none|none|
+|»»»»» location|string|false|none|none|
+|»»»»» meetingLink|string|false|none|none|
+|»»»»» identifier|string|false|none|none|
+|»»»»» startDateTime|string(date-time)|false|none|none|
+|»»»»» status|string|false|none|none|
+|»»»»» summary|string|false|none|none|
+|»»»»» timezone|string|false|none|none|
+|»»»»» calendarId|string|true|none|none|
+|»»»»» parentEventId|string|false|none|none|
+|»»»»» extId|string|false|none|none|
+|»»»»» extMetadata|object|false|none|none|
+|»»»»» calendar|[CalendarWithRelations](#schemacalendarwithrelations)|false|none|(tsType: CalendarWithRelations, schemaOptions: { includeRelations: true })|
+|»»»»» parentEvent|[EventWithRelations](#schemaeventwithrelations)|false|none|(tsType: EventWithRelations, schemaOptions: { includeRelations: true })|
+|»»»»» attendees|[[AttendeeWithRelations](#schemaattendeewithrelations)]|false|none|(tsType: AttendeeWithRelations, schemaOptions: { includeRelations: true })|
+|»»»»»» AttendeeWithRelations|[AttendeeWithRelations](#schemaattendeewithrelations)|false|none|(tsType: AttendeeWithRelations, schemaOptions: { includeRelations: true })|
+|»»»»»»» deleted|boolean|false|none|none|
+|»»»»»»» deletedOn|string(date-time)¦null|false|none|none|
+|»»»»»»» deletedBy|string¦null|false|none|none|
+|»»»»»»» createdOn|string(date-time)|false|none|none|
+|»»»»»»» modifiedOn|string(date-time)|false|none|none|
+|»»»»»»» createdBy|string|false|none|none|
+|»»»»»»» modifiedBy|string|false|none|none|
+|»»»»»»» id|string|false|none|none|
+|»»»»»»» identifier|string|true|none|none|
+|»»»»»»» isOptional|boolean|false|none|none|
+|»»»»»»» isOrganizer|boolean|false|none|none|
+|»»»»»»» messages|string|false|none|none|
+|»»»»»»» responseStatus|string|false|none|none|
+|»»»»»»» eventId|string|true|none|none|
+|»»»»»»» extId|string|false|none|none|
+|»»»»»»» extMetadata|object|false|none|none|
+|»»»»»»» event|[EventWithRelations](#schemaeventwithrelations)|false|none|(tsType: EventWithRelations, schemaOptions: { includeRelations: true })|
+|»»»»» attachments|[[AttachmentWithRelations](#schemaattachmentwithrelations)]|false|none|(tsType: AttachmentWithRelations, schemaOptions: { includeRelations: true })|
+|»»»»»» AttachmentWithRelations|[AttachmentWithRelations](#schemaattachmentwithrelations)|false|none|(tsType: AttachmentWithRelations, schemaOptions: { includeRelations: true })|
+|»»»»»»» deleted|boolean|false|none|none|
+|»»»»»»» deletedOn|string(date-time)¦null|false|none|none|
+|»»»»»»» deletedBy|string¦null|false|none|none|
+|»»»»»»» createdOn|string(date-time)|false|none|none|
+|»»»»»»» modifiedOn|string(date-time)|false|none|none|
+|»»»»»»» createdBy|string|false|none|none|
+|»»»»»»» modifiedBy|string|false|none|none|
+|»»»»»»» id|string|false|none|none|
+|»»»»»»» fileUrl|string|true|none|none|
+|»»»»»»» iconLink|string|false|none|none|
+|»»»»»»» mimeType|string|false|none|none|
+|»»»»»»» title|string|false|none|none|
+|»»»»»»» eventId|string|true|none|none|
+|»»»»»»» extId|string|false|none|none|
+|»»»»»»» extMetadata|object|false|none|none|
+|»»»»»»» event|[EventWithRelations](#schemaeventwithrelations)|false|none|(tsType: EventWithRelations, schemaOptions: { includeRelations: true })|
+|»»» workingHours|[[WorkingHourWithRelations](#schemaworkinghourwithrelations)]|false|none|(tsType: WorkingHourWithRelations, schemaOptions: { includeRelations: true })|
+|»»»» WorkingHourWithRelations|[WorkingHourWithRelations](#schemaworkinghourwithrelations)|false|none|(tsType: WorkingHourWithRelations, schemaOptions: { includeRelations: true })|
+|»»» subscriptions|[[SubscriptionWithRelations](#schemasubscriptionwithrelations)]|false|none|(tsType: SubscriptionWithRelations, schemaOptions: { includeRelations: true })|
+|»»»» SubscriptionWithRelations|[SubscriptionWithRelations](#schemasubscriptionwithrelations)|false|none|(tsType: SubscriptionWithRelations, schemaOptions: { includeRelations: true })|
+|»»»»» deleted|boolean|false|none|none|
+|»»»»» deletedOn|string(date-time)¦null|false|none|none|
+|»»»»» deletedBy|string¦null|false|none|none|
+|»»»»» createdOn|string(date-time)|false|none|none|
+|»»»»» modifiedOn|string(date-time)|false|none|none|
+|»»»»» createdBy|string|false|none|none|
+|»»»»» modifiedBy|string|false|none|none|
+|»»»»» id|string|false|none|none|
+|»»»»» accessRole|string|false|none|none|
+|»»»»» bgColor|string|false|none|none|
+|»»»»» fgColor|string|false|none|none|
+|»»»»» isHidden|boolean|false|none|none|
+|»»»»» isPrimary|boolean|false|none|none|
+|»»»»» identifier|string|true|none|none|
+|»»»»» defaultReminders|object|false|none|none|
+|»»»»» notificationSettings|object|false|none|none|
+|»»»»» calendarId|string|true|none|none|
+|»»»»» extId|string|false|none|none|
+|»»»»» extMetadata|object|false|none|none|
+|»»»»» calendar|[CalendarWithRelations](#schemacalendarwithrelations)|false|none|(tsType: CalendarWithRelations, schemaOptions: { includeRelations: true })|
+
+#### Enumerated Values
+
+|Property|Value|
+|---|---|
+|dayOfWeek|0|
+|dayOfWeek|1|
+|dayOfWeek|2|
+|dayOfWeek|3|
+|dayOfWeek|4|
+|dayOfWeek|5|
+|dayOfWeek|6|
+|status|confirmed|
+|status|tentative|
+|status|cancelled|
+|status|completed|
+|responseStatus|needsAction|
+|responseStatus|tentative|
+|responseStatus|accepted|
+|responseStatus|declined|
+|accessRole|freeBusyReader|
+|accessRole|reader|
+|accessRole|writer|
+|accessRole|owner|
+
+
+This operation does not require authentication
+
+
+# Schemas
+
+Attachment
+
+NewAttachment
+
+AttendeeWithRelations
+
+EventWithRelations
+
+AttachmentWithRelations
+
+AttachmentPartial
+
+Attendee
+
+NewAttendee
+
+AttendeePartial
+
+Calendar
+
+WorkingHourExcluding_id_
+
+NewCalendar
+
+, schemaOptions: { exclude: [ 'id' ] })]|
+|subscription|object|false|none|none|
+
+WorkingHour
+
+CalendarDTO
+
+CalendarWithRelations
+
+CalendarPartial
+
+Event
+
+AttachmentExcluding_id_
+
+AttendeeExcluding_id_
+
+NewEvent
+
+, schemaOptions: { exclude: [ 'id' ] })]|
+|attendees|[[AttendeeExcluding_id_](#schemaattendeeexcluding_id_)]|false|none|[(tsType: Omit, schemaOptions: { exclude: [ 'id' ] })]|
+|extId|string|false|none|none|
+|extMetadata|object|false|none|none|
+
+#### Enumerated Values
+
+|Property|Value|
+|---|---|
+|status|confirmed|
+|status|tentative|
+|status|cancelled|
+|status|completed|
+
+EventAttendeeViewItemDTO
+
+FreeBusyRequest
+
+FreeBusyDTO
+
+EventPartial
+
+Settings
+
+NewSettings
+
+SettingsWithRelations
+
+SettingsPartial
+
+Subscription
+
+NewSubscription
+
+SubscriptionWithRelations
+
+SubscriptionPartial
+
+Theme
+
+NewTheme
+
+ThemeWithRelations
+
+ThemePartial
+
+NewWorkingHour
+
+WorkingHourWithRelations
+
+WorkingHourPartial
+
+Date
+
+NewEventInCalendar
+
+NewSubscriptionInCalendar
+
+NewWorkingHourInCalendar
+
+NewAttachmentInEvent
+
+NewAttendeeInEvent
+
+loopback.Count
+
+attachments.ScopeFilter
+
+attachments.IncludeFilter.Items
+
+attachments.Filter
+
+attachments.Filter1
+
+attendees.ScopeFilter
+
+attendees.IncludeFilter.Items
+
+attendees.Filter
+
+attendees.Filter1
+
+subscriptions.ScopeFilter
+
+subscriptions.IncludeFilter.Items
+
+subscriptions.Filter
+
+calendars.ScopeFilter
+
+calendars.IncludeFilter.Items
+
+calendars.Filter
+
+calendars.Filter1
+
+events.ScopeFilter
+
+events.IncludeFilter.Items
+
+events.Filter
+
+events_attendees_view.ScopeFilter
+
+events_attendees_view.IncludeFilter.Items
+
+events_attendees_view.Filter
+
+PingResponse
+
+settings.Filter
+
+settings.Filter1
+
+subscriptions.Filter1
+
+themes.Filter
+
+themes.Filter1
+
+working_hours.ScopeFilter
+
+working_hours.IncludeFilter.Items
+
+working_hours.Filter
+
+working_hours.Filter1
+
+Video Conferencing Service v1.0.0
+
+> Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
+
+A Video conferencing service example
+
+Base URLs:
+
+* http://localhost:3000
+
+# Authentication
+
+- HTTP Authentication, scheme: bearer
+
+VideoChatArchiveController
+
+## VideoChatArchiveController.setUploadTarget
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|body|body|object|false|none|
+
+> Example responses
+
+> 200 Response
+
+```
+null
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|text|
+
+
+This operation does not require authentication
+
+
+## VideoChatArchiveController.getArchive
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|archiveId|path|string|true|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
+
+Response Schema
+
+
+This operation does not require authentication
+
+
+## VideoChatArchiveController.deleteArchive
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|archiveId|path|string|true|none|
+
+> Example responses
+
+> 200 Response
+
+```
+null
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|text|
+
+
+This operation does not require authentication
+
+
+## VideoChatArchiveController.getArchives
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
+
+Response Schema
+
+
+This operation does not require authentication
+
+
+VideoChatSessionController
+
+## VideoChatSessionController.getAttendeesList
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|meetingLinkId|path|string|true|none|
+|active|query|string|false|none|
+
+> Example responses
+
+> 200 Response
+
+```
+[]
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
+
+Response Schema
+
+
+This operation does not require authentication
+
+
+## VideoChatSessionController.endSession
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|meetingLinkId|path|string|true|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|MessageRecipient PATCH success|None|
+
+
+This operation does not require authentication
+
+
+## VideoChatSessionController.getMeetingToken
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|meetingLinkId|path|string|true|none|
+|body|body|object|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+null
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
+
+Response Schema
+
+
+This operation does not require authentication
+
+
+## VideoChatSessionController.editMeeting
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|meetingLinkId|path|string|true|none|
+|body|body|[VideoChatSessionPartial](#schemavideochatsessionpartial)|false|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|Session details PATCH success|None|
+
+
+This operation does not require authentication
+
+
+## VideoChatSessionController.getMeetingLink
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|body|body|object|false|none|
+
+> Example responses
+
+> 200 Response
+
+```
+"string"
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|string|
+
+
+This operation does not require authentication
+
+
+## VideoChatSessionController.checkWebhookPayload
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|body|body|object|false|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|POST /webhooks/session Success|None|
+
+
+This operation does not require authentication
+
+
+# Schemas
+
+VideoChatSessionPartial
+
+Bpmn Service v1.0.0
+
+> Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
+
+A workflow microservice example
+
+Base URLs:
+
+* http://localhost:3000
+
+# Authentication
+
+- HTTP Authentication, scheme: bearer
+
+WorkflowController
+
+## WorkflowController.startWorkflow
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|body|body|[ExecuteWorkflowDto](#schemaexecuteworkflowdto)|false|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Workflow instance|None|
+
+
+To perform this operation, you must be authenticated by means of one of the following methods:
+None
+
+
+## WorkflowController.updateById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|body|body|[WorkflowDtoPartial](#schemaworkflowdtopartial)|false|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|Workflow PATCH success|None|
+
+
+To perform this operation, you must be authenticated by means of one of the following methods:
+None
+
+
+## WorkflowController.count
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Workflow Model|None|
+
+
+This operation does not require authentication
+
+
+## WorkflowController.deleteById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|Workflow DELETE success|None|
+
+
+To perform this operation, you must be authenticated by means of one of the following methods:
+None
+
+
+## WorkflowController.create
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|body|body|[NewWorkflow](#schemanewworkflow)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "workflowVersion": 0,
+ "externalIdentifier": "string",
+ "name": "string",
+ "provider": "string",
+ "inputSchema": {},
+ "description": "string"
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Workflow model instance|[Workflow](#schemaworkflow)|
+
+
+To perform this operation, you must be authenticated by means of one of the following methods:
+None
+
+
+## WorkflowController.find
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|filter|query|[workflows.Filter](#schemaworkflows.filter)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+[
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "workflowVersion": 0,
+ "externalIdentifier": "string",
+ "name": "string",
+ "provider": "string",
+ "inputSchema": {},
+ "description": "string"
+ }
+]
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Array of Workflow model instances|Inline|
+
+Response Schema
+
+Status Code **200**
+
+|Name|Type|Required|Restrictions|Description|
+|---|---|---|---|---|
+|*anonymous*|[[Workflow](#schemaworkflow)]|false|none|none|
+|» Workflow|[Workflow](#schemaworkflow)|false|none|none|
+|»» deleted|boolean|false|none|none|
+|»» deletedOn|string(date-time)¦null|false|none|none|
+|»» deletedBy|string¦null|false|none|none|
+|»» createdOn|string(date-time)|false|none|none|
+|»» modifiedOn|string(date-time)|false|none|none|
+|»» createdBy|string|false|none|none|
+|»» modifiedBy|string|false|none|none|
+|»» id|string|false|none|none|
+|»» workflowVersion|number|true|none|none|
+|»» externalIdentifier|string|true|none|none|
+|»» name|string|false|none|none|
+|»» provider|string|true|none|none|
+|»» inputSchema|object|true|none|none|
+|»» description|string|false|none|none|
+
+
+This operation does not require authentication
+
+
+# Schemas
+
+Workflow
+
+NewWorkflow
+
+WorkflowDto
+
+WorkflowDtoPartial
+
+ExecuteWorkflowDto
+
+workflows.ScopeFilter
+
+workflows.IncludeFilter.Items
+
+workflows.Filter
+
+ where is a JWT token signed using JWT issu
#### API Details
+Visit the [OpenAPI spec docs](./openapi.md)
+
diff --git a/services/audit-service/migration.js b/services/audit-service/migration.js
index 00ebf7c8df..1754aa4e5e 100644
--- a/services/audit-service/migration.js
+++ b/services/audit-service/migration.js
@@ -1,6 +1,5 @@
const dotenvExt = require('dotenv-extended');
const fs = require('fs');
-const DBMigrate = require('db-migrate');
const path = require('path');
let isLocal = false;
dotenvExt.load({
@@ -27,6 +26,7 @@ if (isLocal) {
`${type}_MIGRATION or SOURCELOOP_MIGRATION variables not found in the environment, skipping automigration.`,
);
} else {
+ const DBMigrate = require('db-migrate');
dotenvExt.load({
schema: path.join('.', 'migrations', '.env.schema'),
path: path.join(process.env.INIT_CWD, '.env'),
diff --git a/services/audit-service/openapi.json b/services/audit-service/openapi.json
new file mode 100644
index 0000000000..d95e3d65b8
--- /dev/null
+++ b/services/audit-service/openapi.json
@@ -0,0 +1,512 @@
+{
+ "openapi": "3.0.0",
+ "info": {
+ "title": "Audit Service",
+ "version": "1.0.0",
+ "description": "A microservice for audit logging",
+ "contact": {}
+ },
+ "paths": {
+ "/audit-logs/count": {
+ "get": {
+ "x-controller-name": "AuditController",
+ "x-operation-name": "count",
+ "tags": [
+ "AuditController"
+ ],
+ "security": [
+ {
+ "HTTPBearer": []
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "AuditLog model count",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/loopback.Count"
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "where",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "audit_logs.WhereFilter",
+ "additionalProperties": true,
+ "x-typescript-type": "@loopback/repository#Where"
+ }
+ }
+ }
+ }
+ ],
+ "operationId": "AuditController.count"
+ }
+ },
+ "/audit-logs/{id}": {
+ "get": {
+ "x-controller-name": "AuditController",
+ "x-operation-name": "findById",
+ "tags": [
+ "AuditController"
+ ],
+ "security": [
+ {
+ "HTTPBearer": []
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "AuditLog model instance",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AuditLogWithRelations"
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ },
+ "required": true
+ },
+ {
+ "name": "filter",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/audit_logs.Filter"
+ }
+ }
+ }
+ }
+ ],
+ "operationId": "AuditController.findById"
+ }
+ },
+ "/audit-logs": {
+ "post": {
+ "x-controller-name": "AuditController",
+ "x-operation-name": "create",
+ "tags": [
+ "AuditController"
+ ],
+ "security": [
+ {
+ "HTTPBearer": []
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "AuditLog model instance",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AuditLog"
+ }
+ }
+ }
+ }
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NewAuditLog"
+ }
+ }
+ }
+ },
+ "operationId": "AuditController.create"
+ },
+ "get": {
+ "x-controller-name": "AuditController",
+ "x-operation-name": "find",
+ "tags": [
+ "AuditController"
+ ],
+ "security": [
+ {
+ "HTTPBearer": []
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Array of AuditLog model instances",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/AuditLogWithRelations"
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "filter",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/audit_logs.Filter1"
+ }
+ }
+ }
+ }
+ ],
+ "operationId": "AuditController.find"
+ }
+ }
+ },
+ "components": {
+ "securitySchemes": {
+ "HTTPBearer": {
+ "type": "http",
+ "scheme": "bearer",
+ "bearerFormat": "JWT"
+ }
+ },
+ "schemas": {
+ "AuditLog": {
+ "title": "AuditLog",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "action": {
+ "type": "string"
+ },
+ "actedAt": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "actedOn": {
+ "type": "string"
+ },
+ "actionKey": {
+ "type": "string"
+ },
+ "entityId": {
+ "type": "string"
+ },
+ "actor": {
+ "type": "string"
+ },
+ "before": {
+ "type": "object"
+ },
+ "after": {
+ "type": "object"
+ },
+ "actionGroup": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "action",
+ "actedAt",
+ "actionKey",
+ "entityId",
+ "actor"
+ ],
+ "additionalProperties": true
+ },
+ "NewAuditLog": {
+ "title": "NewAuditLog",
+ "type": "object",
+ "description": "(tsType: Omit, schemaOptions: { title: 'NewAuditLog', exclude: [ 'id' ] })",
+ "properties": {
+ "action": {
+ "type": "string"
+ },
+ "actedAt": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "actedOn": {
+ "type": "string"
+ },
+ "actionKey": {
+ "type": "string"
+ },
+ "entityId": {
+ "type": "string"
+ },
+ "actor": {
+ "type": "string"
+ },
+ "before": {
+ "type": "object"
+ },
+ "after": {
+ "type": "object"
+ },
+ "actionGroup": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "action",
+ "actedAt",
+ "actionKey",
+ "entityId",
+ "actor"
+ ],
+ "additionalProperties": true,
+ "x-typescript-type": "Omit"
+ },
+ "AuditLogWithRelations": {
+ "title": "AuditLogWithRelations",
+ "type": "object",
+ "description": "(tsType: AuditLogWithRelations, schemaOptions: { includeRelations: true })",
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "action": {
+ "type": "string"
+ },
+ "actedAt": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "actedOn": {
+ "type": "string"
+ },
+ "actionKey": {
+ "type": "string"
+ },
+ "entityId": {
+ "type": "string"
+ },
+ "actor": {
+ "type": "string"
+ },
+ "before": {
+ "type": "object"
+ },
+ "after": {
+ "type": "object"
+ },
+ "actionGroup": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "action",
+ "actedAt",
+ "actionKey",
+ "entityId",
+ "actor"
+ ],
+ "additionalProperties": true,
+ "x-typescript-type": "AuditLogWithRelations"
+ },
+ "loopback.Count": {
+ "type": "object",
+ "title": "loopback.Count",
+ "x-typescript-type": "@loopback/repository#Count",
+ "properties": {
+ "count": {
+ "type": "number"
+ }
+ }
+ },
+ "audit_logs.Filter": {
+ "type": "object",
+ "title": "audit_logs.Filter",
+ "properties": {
+ "offset": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "limit": {
+ "type": "integer",
+ "minimum": 1,
+ "example": 100
+ },
+ "skip": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "order": {
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "fields": {
+ "oneOf": [
+ {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "boolean"
+ },
+ "action": {
+ "type": "boolean"
+ },
+ "actedAt": {
+ "type": "boolean"
+ },
+ "actedOn": {
+ "type": "boolean"
+ },
+ "actionKey": {
+ "type": "boolean"
+ },
+ "entityId": {
+ "type": "boolean"
+ },
+ "actor": {
+ "type": "boolean"
+ },
+ "before": {
+ "type": "boolean"
+ },
+ "after": {
+ "type": "boolean"
+ },
+ "actionGroup": {
+ "type": "boolean"
+ }
+ },
+ "additionalProperties": true
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "example": "id"
+ },
+ "uniqueItems": true
+ }
+ ],
+ "title": "audit_logs.Fields"
+ }
+ },
+ "additionalProperties": false,
+ "x-typescript-type": "@loopback/repository#Filter"
+ },
+ "audit_logs.Filter1": {
+ "type": "object",
+ "title": "audit_logs.Filter",
+ "properties": {
+ "offset": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "limit": {
+ "type": "integer",
+ "minimum": 1,
+ "example": 100
+ },
+ "skip": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "order": {
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "where": {
+ "title": "audit_logs.WhereFilter",
+ "type": "object",
+ "additionalProperties": true
+ },
+ "fields": {
+ "oneOf": [
+ {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "boolean"
+ },
+ "action": {
+ "type": "boolean"
+ },
+ "actedAt": {
+ "type": "boolean"
+ },
+ "actedOn": {
+ "type": "boolean"
+ },
+ "actionKey": {
+ "type": "boolean"
+ },
+ "entityId": {
+ "type": "boolean"
+ },
+ "actor": {
+ "type": "boolean"
+ },
+ "before": {
+ "type": "boolean"
+ },
+ "after": {
+ "type": "boolean"
+ },
+ "actionGroup": {
+ "type": "boolean"
+ }
+ },
+ "additionalProperties": true
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "example": "id"
+ },
+ "uniqueItems": true
+ }
+ ],
+ "title": "audit_logs.Fields"
+ }
+ },
+ "additionalProperties": false,
+ "x-typescript-type": "@loopback/repository#Filter"
+ }
+ }
+ },
+ "servers": [
+ {
+ "url": "/"
+ }
+ ]
+}
\ No newline at end of file
diff --git a/services/audit-service/openapi.md b/services/audit-service/openapi.md
new file mode 100644
index 0000000000..4d5358dbba
--- /dev/null
+++ b/services/audit-service/openapi.md
@@ -0,0 +1,642 @@
+---
+title: Audit Service v1.0.0
+language_tabs:
+ - "'javascript": JavaScript
+ - "'javascript--nodejs": Node.JS'
+language_clients:
+ - "'javascript": request'
+ - "'javascript--nodejs": ""
+toc_footers: []
+includes: []
+search: false
+highlight_theme: darkula
+headingLevel: 2
+
+---
+
+
+
+Audit Service v1.0.0
+
+> Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
+
+A microservice for audit logging
+
+Base URLs:
+
+* /
+
+# Authentication
+
+- HTTP Authentication, scheme: bearer
+
+AuditController
+
+## AuditController.count
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|where|query|object|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "count": 0
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|AuditLog model count|[loopback.Count](#schemaloopback.count)|
+
+
+To perform this operation, you must be authenticated by means of one of the following methods:
+HTTPBearer
+
+
+## AuditController.findById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|filter|query|[audit_logs.Filter](#schemaaudit_logs.filter)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "id": "string",
+ "action": "string",
+ "actedAt": "2019-08-24T14:15:22Z",
+ "actedOn": "string",
+ "actionKey": "string",
+ "entityId": "string",
+ "actor": "string",
+ "before": {},
+ "after": {},
+ "actionGroup": "string"
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|AuditLog model instance|[AuditLogWithRelations](#schemaauditlogwithrelations)|
+
+
+To perform this operation, you must be authenticated by means of one of the following methods:
+HTTPBearer
+
+
+## AuditController.create
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|body|body|[NewAuditLog](#schemanewauditlog)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "id": "string",
+ "action": "string",
+ "actedAt": "2019-08-24T14:15:22Z",
+ "actedOn": "string",
+ "actionKey": "string",
+ "entityId": "string",
+ "actor": "string",
+ "before": {},
+ "after": {},
+ "actionGroup": "string"
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|AuditLog model instance|[AuditLog](#schemaauditlog)|
+
+
+To perform this operation, you must be authenticated by means of one of the following methods:
+HTTPBearer
+
+
+## AuditController.find
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|filter|query|[audit_logs.Filter1](#schemaaudit_logs.filter1)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+[
+ {
+ "id": "string",
+ "action": "string",
+ "actedAt": "2019-08-24T14:15:22Z",
+ "actedOn": "string",
+ "actionKey": "string",
+ "entityId": "string",
+ "actor": "string",
+ "before": {},
+ "after": {},
+ "actionGroup": "string"
+ }
+]
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Array of AuditLog model instances|Inline|
+
+Response Schema
+
+Status Code **200**
+
+|Name|Type|Required|Restrictions|Description|
+|---|---|---|---|---|
+|*anonymous*|[[AuditLogWithRelations](#schemaauditlogwithrelations)]|false|none|[(tsType: AuditLogWithRelations, schemaOptions: { includeRelations: true })]|
+|» AuditLogWithRelations|[AuditLogWithRelations](#schemaauditlogwithrelations)|false|none|(tsType: AuditLogWithRelations, schemaOptions: { includeRelations: true })|
+|»» id|string|false|none|none|
+|»» action|string|true|none|none|
+|»» actedAt|string(date-time)|true|none|none|
+|»» actedOn|string|false|none|none|
+|»» actionKey|string|true|none|none|
+|»» entityId|string|true|none|none|
+|»» actor|string|true|none|none|
+|»» before|object|false|none|none|
+|»» after|object|false|none|none|
+|»» actionGroup|string|false|none|none|
+
+
+To perform this operation, you must be authenticated by means of one of the following methods:
+HTTPBearer
+
+
+# Schemas
+
+AuditLog
+
+NewAuditLog
+
+AuditLogWithRelations
+
+loopback.Count
+
+audit_logs.Filter
+
+audit_logs.Filter1
+
+ {
+ const config: ApplicationConfig = {
+ rest: {
+ port: +(process.env.PORT ?? PORT),
+ host: process.env.HOST ?? 'localhost',
+ },
+ };
+ const outFile = process.argv[FILEARGVI] ?? 'openapi.json';
+ const app = new AuditServiceApplication(config);
+ await app.boot();
+ await app.exportOpenApiSpec(outFile);
+}
+
+exportOpenApiSpec().catch(err => {
+ console.error('Fail to export OpenAPI spec from the application.', err); //NOSONAR
+ process.exit(1);
+});
diff --git a/services/authentication-service/OPEN_API_SPEC.md b/services/authentication-service/OPEN_API_SPEC.md
deleted file mode 100644
index a1dc26367a..0000000000
--- a/services/authentication-service/OPEN_API_SPEC.md
+++ /dev/null
@@ -1,7499 +0,0 @@
----
-title: Authentication Service v1.0.0
-language_tabs:
- - shell: Shell
- - http: HTTP
- - javascript: JavaScript
- - ruby: Ruby
- - python: Python
- - php: PHP
- - java: Java
- - go: Go
-toc_footers: []
-includes: []
-search: true
-highlight_theme: darkula
-headingLevel: 2
-
----
-
-
-
-Authentication Service v1.0.0
-
-> Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
-
-This is a sample application for sandbox testing of auth microservice components.
-
-Base URLs:
-
-* /
-
-# Authentication
-
-- HTTP Authentication, scheme: bearer
-
-LoginController
-
-## LoginController.resetPassword
-
-Parameters
-
-|Name|In|Type|Required|Description|
-|---|---|---|---|---|
-|Authorization|header|string|false|none|
-|body|body|[ResetPasswordPartial](#schemaresetpasswordpartial)|false|none|
-
-Responses
-
-|Status|Meaning|Description|Schema|
-|---|---|---|---|
-|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|If User password successfully changed.|None|
-
-
-To perform this operation, you must be authenticated by means of one of the following methods:
-HTTPBearer
-
-
-## LoginController.loginViaGoogle
-
-Parameters
-
-|Name|In|Type|Required|Description|
-|---|---|---|---|---|
-|client_id|query|string|false|none|
-|client_secret|query|string|false|none|
-
-> Example responses
-
-> 200 Response
-
-```json
-{
- "accessToken": "string",
- "refreshToken": "string",
- "expires": 0,
- "pubnubToken": "string"
-}
-```
-
-Responses
-
-|Status|Meaning|Description|Schema|
-|---|---|---|---|
-|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Google Token Response|[TokenResponse](#schematokenresponse)|
-
-
-This operation does not require authentication
-
-
-## LoginController.googleCallback
-
-Parameters
-
-|Name|In|Type|Required|Description|
-|---|---|---|---|---|
-|code|query|string|false|none|
-|state|query|string|false|none|
-
-> Example responses
-
-> 200 Response
-
-```json
-{
- "accessToken": "string",
- "refreshToken": "string",
- "expires": 0,
- "pubnubToken": "string"
-}
-```
-
-Responses
-
-|Status|Meaning|Description|Schema|
-|---|---|---|---|
-|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Google Redirect Token Response|[TokenResponse](#schematokenresponse)|
-
-
-This operation does not require authentication
-
-
-## LoginController.loginViaInstagram
-
-Parameters
-
-|Name|In|Type|Required|Description|
-|---|---|---|---|---|
-|client_id|query|string|false|none|
-|client_secret|query|string|false|none|
-
-> Example responses
-
-> 200 Response
-
-```json
-{
- "accessToken": "string",
- "refreshToken": "string",
- "expires": 0,
- "pubnubToken": "string"
-}
-```
-
-Responses
-
-|Status|Meaning|Description|Schema|
-|---|---|---|---|
-|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Instagram Token Response|[TokenResponse](#schematokenresponse)|
-
-
-This operation does not require authentication
-
-
-## LoginController.instagramCallback
-
-Parameters
-
-|Name|In|Type|Required|Description|
-|---|---|---|---|---|
-|code|query|string|false|none|
-|state|query|string|false|none|
-
-> Example responses
-
-> 200 Response
-
-```json
-{
- "accessToken": "string",
- "refreshToken": "string",
- "expires": 0,
- "pubnubToken": "string"
-}
-```
-
-Responses
-
-|Status|Meaning|Description|Schema|
-|---|---|---|---|
-|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Instagram Redirect Token Response|[TokenResponse](#schematokenresponse)|
-
-
-This operation does not require authentication
-
-
-## LoginController.loginViaKeycloak
-
-Parameters
-
-|Name|In|Type|Required|Description|
-|---|---|---|---|---|
-|client_id|query|string|false|none|
-|client_secret|query|string|false|none|
-
-> Example responses
-
-> 200 Response
-
-```json
-{
- "accessToken": "string",
- "refreshToken": "string",
- "expires": 0,
- "pubnubToken": "string"
-}
-```
-
-Responses
-
-|Status|Meaning|Description|Schema|
-|---|---|---|---|
-|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Keycloak Token Response|[TokenResponse](#schematokenresponse)|
-
-
-This operation does not require authentication
-
-
-## LoginController.keycloakCallback
-
-Parameters
-
-|Name|In|Type|Required|Description|
-|---|---|---|---|---|
-|code|query|string|false|none|
-|state|query|string|false|none|
-
-> Example responses
-
-> 200 Response
-
-```json
-{
- "accessToken": "string",
- "refreshToken": "string",
- "expires": 0,
- "pubnubToken": "string"
-}
-```
-
-Responses
-
-|Status|Meaning|Description|Schema|
-|---|---|---|---|
-|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Keycloak Redirect Token Response|[TokenResponse](#schematokenresponse)|
-
-
-This operation does not require authentication
-
-
-## LoginController.login
-
-Parameters
-
-|Name|In|Type|Required|Description|
-|---|---|---|---|---|
-|body|body|[LoginRequest](#schemaloginrequest)|false|none|
-
-> Example responses
-
-Responses
-
-|Status|Meaning|Description|Schema|
-|---|---|---|---|
-|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Auth Code|None|
-|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|The syntax of the request entity is incorrect.|None|
-|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Invalid Credentials.|None|
-|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|The entity requested does not exist.|None|
-|422|[Unprocessable Entity](https://tools.ietf.org/html/rfc2518#section-10.3)|The syntax of the request entity is incorrect|None|
-
-Response Schema
-
-
-This operation does not require authentication
-
-
-## LoginController.loginWithClientUser
-
-Parameters
-
-|Name|In|Type|Required|Description|
-|---|---|---|---|---|
-|device_id|header|string|false|none|
-|body|body|[LoginRequest](#schemaloginrequest)|false|none|
-
-> Example responses
-
-> 200 Response
-
-```json
-{
- "accessToken": "string",
- "refreshToken": "string",
- "expires": 0,
- "pubnubToken": "string"
-}
-```
-
-Responses
-
-|Status|Meaning|Description|Schema|
-|---|---|---|---|
-|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Token Response Model|[TokenResponse](#schematokenresponse)|
-|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|The syntax of the request entity is incorrect.|None|
-|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Invalid Credentials.|None|
-|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|The entity requested does not exist.|None|
-|422|[Unprocessable Entity](https://tools.ietf.org/html/rfc2518#section-10.3)|The syntax of the request entity is incorrect|None|
-
-
-This operation does not require authentication
-
-
-## LoginController.me
-
-Responses
-
-|Status|Meaning|Description|Schema|
-|---|---|---|---|
-|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|User Object|None|
-|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|The syntax of the request entity is incorrect.|None|
-|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Invalid Credentials.|None|
-|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|The entity requested does not exist.|None|
-|422|[Unprocessable Entity](https://tools.ietf.org/html/rfc2518#section-10.3)|The syntax of the request entity is incorrect|None|
-
-Response Schema
-
-
-To perform this operation, you must be authenticated by means of one of the following methods:
-HTTPBearer
-
-
-## LoginController.getToken
-
-Parameters
-
-|Name|In|Type|Required|Description|
-|---|---|---|---|---|
-|device_id|header|string|false|none|
-|body|body|[AuthTokenRequest](#schemaauthtokenrequest)|false|none|
-
-> Example responses
-
-> 200 Response
-
-```json
-{
- "accessToken": "string",
- "refreshToken": "string",
- "expires": 0,
- "pubnubToken": "string"
-}
-```
-
-Responses
-
-|Status|Meaning|Description|Schema|
-|---|---|---|---|
-|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Token Response|[TokenResponse](#schematokenresponse)|
-|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|The syntax of the request entity is incorrect.|None|
-|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Invalid Credentials.|None|
-|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|The entity requested does not exist.|None|
-|422|[Unprocessable Entity](https://tools.ietf.org/html/rfc2518#section-10.3)|The syntax of the request entity is incorrect|None|
-
-
-This operation does not require authentication
-
-
-## LoginController.exchangeToken
-
-Parameters
-
-|Name|In|Type|Required|Description|
-|---|---|---|---|---|
-|device_id|header|string|false|none|
-|body|body|[AuthRefreshTokenRequest](#schemaauthrefreshtokenrequest)|false|none|
-
-> Example responses
-
-> 200 Response
-
-```json
-{
- "accessToken": "string",
- "refreshToken": "string",
- "expires": 0,
- "pubnubToken": "string"
-}
-```
-
-Responses
-
-|Status|Meaning|Description|Schema|
-|---|---|---|---|
-|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|New Token Response|[TokenResponse](#schematokenresponse)|
-|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|The syntax of the request entity is incorrect.|None|
-|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Invalid Credentials.|None|
-|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|The entity requested does not exist.|None|
-|422|[Unprocessable Entity](https://tools.ietf.org/html/rfc2518#section-10.3)|The syntax of the request entity is incorrect|None|
-
-
-This operation does not require authentication
-
-
-ForgetPasswordController
-
-## ForgetPasswordController.forgetPassword
-
-Parameters
-
-|Name|In|Type|Required|Description|
-|---|---|---|---|---|
-|body|body|[ForgetPasswordDto](#schemaforgetpassworddto)|false|none|
-
-> Example responses
-
-> 200 Response
-
-```json
-{
- "code": "string",
- "expiry": 0,
- "email": "string",
- "user": {
- "deleted": true,
- "deletedOn": "2019-08-24T14:15:22Z",
- "deletedBy": "string",
- "createdOn": "2019-08-24T14:15:22Z",
- "modifiedOn": "2019-08-24T14:15:22Z",
- "createdBy": "string",
- "modifiedBy": "string",
- "id": "string",
- "firstName": "string",
- "lastName": "string",
- "middleName": "string",
- "username": "string",
- "email": "string",
- "phone": "string",
- "authClientIds": "string",
- "lastLogin": "2019-08-24T14:15:22Z",
- "dob": "2019-08-24T14:15:22Z",
- "gender": "M",
- "defaultTenantId": "string"
- }
-}
-```
-
-Responses
-
-|Status|Meaning|Description|Schema|
-|---|---|---|---|
-|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Success Response.|[ForgetPasswordResponseDto](#schemaforgetpasswordresponsedto)|
-|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|The syntax of the request entity is incorrect.|None|
-|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Invalid Credentials.|None|
-|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|The entity requested does not exist.|None|
-|422|[Unprocessable Entity](https://tools.ietf.org/html/rfc2518#section-10.3)|The syntax of the request entity is incorrect|None|
-
-
-This operation does not require authentication
-
-
-## ForgetPasswordController.resetPassword
-
-Parameters
-
-|Name|In|Type|Required|Description|
-|---|---|---|---|---|
-|body|body|[ResetPasswordWithClient](#schemaresetpasswordwithclient)|false|none|
-
-Responses
-
-|Status|Meaning|Description|Schema|
-|---|---|---|---|
-|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|If User password successfully changed.|None|
-
-
-This operation does not require authentication
-
-
-## ForgetPasswordController.verifyResetPasswordLink
-
-Parameters
-
-|Name|In|Type|Required|Description|
-|---|---|---|---|---|
-|token|query|string|true|none|
-
-Responses
-
-|Status|Meaning|Description|Schema|
-|---|---|---|---|
-|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Check if Token Is Valid and not Expired.|None|
-
-
-This operation does not require authentication
-
-
-AuthClientController
-
-## AuthClientController.count
-
-Parameters
-
-|Name|In|Type|Required|Description|
-|---|---|---|---|---|
-|where|query|object|false|none|
-
-> Example responses
-
-> 200 Response
-
-```json
-{
- "count": 0
-}
-```
-
-Responses
-
-|Status|Meaning|Description|Schema|
-|---|---|---|---|
-|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|AuthClient model count|[loopback.Count](#schemaloopback.count)|
-
-
-To perform this operation, you must be authenticated by means of one of the following methods:
-HTTPBearer
-
-
-## AuthClientController.replaceById
-
-Parameters
-
-|Name|In|Type|Required|Description|
-|---|---|---|---|---|
-|id|path|number|true|none|
-|body|body|[AuthClient](#schemaauthclient)|false|none|
-
-Responses
-
-|Status|Meaning|Description|Schema|
-|---|---|---|---|
-|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|AuthClient PUT success|None|
-
-
-To perform this operation, you must be authenticated by means of one of the following methods:
-HTTPBearer
-
-
-## AuthClientController.updateById
-
-Parameters
-
-|Name|In|Type|Required|Description|
-|---|---|---|---|---|
-|id|path|number|true|none|
-|body|body|[AuthClientPartial](#schemaauthclientpartial)|false|none|
-
-Responses
-
-|Status|Meaning|Description|Schema|
-|---|---|---|---|
-|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|AuthClient PATCH success|None|
-
-
-To perform this operation, you must be authenticated by means of one of the following methods:
-HTTPBearer
-
-
-## AuthClientController.findById
-
-Parameters
-
-|Name|In|Type|Required|Description|
-|---|---|---|---|---|
-|id|path|number|true|none|
-
-> Example responses
-
-> 200 Response
-
-```json
-{
- "deleted": true,
- "deletedOn": "2019-08-24T14:15:22Z",
- "deletedBy": "string",
- "createdOn": "2019-08-24T14:15:22Z",
- "modifiedOn": "2019-08-24T14:15:22Z",
- "id": 0,
- "clientId": "string",
- "clientSecret": "string",
- "secret": "string",
- "redirectUrl": "string",
- "accessTokenExpiration": 0,
- "refreshTokenExpiration": 0,
- "authCodeExpiration": 0
-}
-```
-
-Responses
-
-|Status|Meaning|Description|Schema|
-|---|---|---|---|
-|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|AuthClient model instance|[AuthClient](#schemaauthclient)|
-
-
-To perform this operation, you must be authenticated by means of one of the following methods:
-HTTPBearer
-
-
-## AuthClientController.deleteById
-
-Parameters
-
-|Name|In|Type|Required|Description|
-|---|---|---|---|---|
-|id|path|number|true|none|
-
-Responses
-
-|Status|Meaning|Description|Schema|
-|---|---|---|---|
-|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|AuthClient DELETE success|None|
-
-
-To perform this operation, you must be authenticated by means of one of the following methods:
-HTTPBearer
-
-
-## AuthClientController.create
-
-Parameters
-
-|Name|In|Type|Required|Description|
-|---|---|---|---|---|
-|body|body|[AuthClientExcluding_id_](#schemaauthclientexcluding_id_)|false|none|
-
-> Example responses
-
-> 200 Response
-
-```json
-{
- "deleted": true,
- "deletedOn": "2019-08-24T14:15:22Z",
- "deletedBy": "string",
- "createdOn": "2019-08-24T14:15:22Z",
- "modifiedOn": "2019-08-24T14:15:22Z",
- "id": 0,
- "clientId": "string",
- "clientSecret": "string",
- "secret": "string",
- "redirectUrl": "string",
- "accessTokenExpiration": 0,
- "refreshTokenExpiration": 0,
- "authCodeExpiration": 0
-}
-```
-
-Responses
-
-|Status|Meaning|Description|Schema|
-|---|---|---|---|
-|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|AuthClient model instance|[AuthClient](#schemaauthclient)|
-
-
-To perform this operation, you must be authenticated by means of one of the following methods:
-HTTPBearer
-
-
-## AuthClientController.updateAll
-
-Parameters
-
-|Name|In|Type|Required|Description|
-|---|---|---|---|---|
-|where|query|object|false|none|
-|body|body|[AuthClientPartial](#schemaauthclientpartial)|false|none|
-
-> Example responses
-
-> 200 Response
-
-```json
-{
- "count": 0
-}
-```
-
-Responses
-
-|Status|Meaning|Description|Schema|
-|---|---|---|---|
-|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|AuthClient PATCH success count|[loopback.Count](#schemaloopback.count)|
-
-
-To perform this operation, you must be authenticated by means of one of the following methods:
-HTTPBearer
-
-
-## AuthClientController.find
-
-Parameters
-
-|Name|In|Type|Required|Description|
-|---|---|---|---|---|
-|filter|query|[auth_clients.Filter](#schemaauth_clients.filter)|false|none|
-
-> Example responses
-
-> 200 Response
-
-```json
-[
- {
- "deleted": true,
- "deletedOn": "2019-08-24T14:15:22Z",
- "deletedBy": "string",
- "createdOn": "2019-08-24T14:15:22Z",
- "modifiedOn": "2019-08-24T14:15:22Z",
- "id": 0,
- "clientId": "string",
- "clientSecret": "string",
- "secret": "string",
- "redirectUrl": "string",
- "accessTokenExpiration": 0,
- "refreshTokenExpiration": 0,
- "authCodeExpiration": 0
- }
-]
-```
-
-Responses
-
-|Status|Meaning|Description|Schema|
-|---|---|---|---|
-|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Array of AuthClient model instances|Inline|
-
-Response Schema
-
-Status Code **200**
-
-|Name|Type|Required|Restrictions|Description|
-|---|---|---|---|---|
-|*anonymous*|[[AuthClient](#schemaauthclient)]|false|none|none|
-|» AuthClient|[AuthClient](#schemaauthclient)|false|none|none|
-|»» deleted|boolean|false|none|none|
-|»» deletedOn|string(date-time)¦null|false|none|none|
-|»» deletedBy|string¦null|false|none|none|
-|»» createdOn|string(date-time)|false|none|none|
-|»» modifiedOn|string(date-time)|false|none|none|
-|»» id|number|false|none|none|
-|»» clientId|string|true|none|none|
-|»» clientSecret|string|true|none|none|
-|»» secret|string|true|none|none|
-|»» redirectUrl|string|false|none|none|
-|»» accessTokenExpiration|number|true|none|none|
-|»» refreshTokenExpiration|number|true|none|none|
-|»» authCodeExpiration|number|true|none|none|
-
-
-To perform this operation, you must be authenticated by means of one of the following methods:
-HTTPBearer
-
-
-LogoutController
-
-## LogoutController.logout
-
-Parameters
-
-|Name|In|Type|Required|Description|
-|---|---|---|---|---|
-|Authorization|header|string|false|This is the access token which is required to authenticate user.|
-|body|body|[RefreshTokenRequestPartial](#schemarefreshtokenrequestpartial)|false|none|
-
-> Example responses
-
-> 200 Response
-
-```json
-{
- "success": true
-}
-```
-
-Responses
-
-|Status|Meaning|Description|Schema|
-|---|---|---|---|
-|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Success Response|[SuccessResponse](#schemasuccessresponse)|
-|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|The syntax of the request entity is incorrect.|None|
-|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Invalid Credentials.|None|
-|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|The entity requested does not exist.|None|
-|422|[Unprocessable Entity](https://tools.ietf.org/html/rfc2518#section-10.3)|The syntax of the request entity is incorrect|None|
-
-
-To perform this operation, you must be authenticated by means of one of the following methods:
-HTTPBearer
-
-
-OtpController
-
-## OtpController.findById
-
-Parameters
-
-|Name|In|Type|Required|Description|
-|---|---|---|---|---|
-|id|path|string|true|none|
-
-> Example responses
-
-> 200 Response
-
-```json
-{
- "otp": "string",
- "username": "string"
-}
-```
-
-Responses
-
-|Status|Meaning|Description|Schema|
-|---|---|---|---|
-|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Otp model instance|[Otp](#schemaotp)|
-
-
-This operation does not require authentication
-
-
-## OtpController.deleteById
-
-Parameters
-
-|Name|In|Type|Required|Description|
-|---|---|---|---|---|
-|id|path|string|true|none|
-
-Responses
-
-|Status|Meaning|Description|Schema|
-|---|---|---|---|
-|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|Otp DELETE success|None|
-
-
-This operation does not require authentication
-
-
-## OtpController.create
-
-Parameters
-
-|Name|In|Type|Required|Description|
-|---|---|---|---|---|
-|body|body|[Otp](#schemaotp)|false|none|
-
-> Example responses
-
-> 200 Response
-
-```json
-{
- "otp": "string",
- "username": "string"
-}
-```
-
-Responses
-
-|Status|Meaning|Description|Schema|
-|---|---|---|---|
-|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Otp model instance|[Otp](#schemaotp)|
-
-
-This operation does not require authentication
-
-
-PingController
-
-## PingController.ping
-
-Responses
-
-|Status|Meaning|Description|Schema|
-|---|---|---|---|
-|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Ping Response|Inline|
-
-Response Schema
-
-Status Code **200**
-
-|Name|Type|Required|Restrictions|Description|
-|---|---|---|---|---|
-|» greeting|string|false|none|none|
-|» date|string|false|none|none|
-|» url|string|false|none|none|
-|» headers|object|false|none|none|
-|»» Content-Type|string|false|none|none|
-
-
-This operation does not require authentication
-
-
-TodoController
-
-## TodoController.count
-
-Parameters
-
-|Name|In|Type|Required|Description|
-|---|---|---|---|---|
-|where|query|object|false|none|
-
-> Example responses
-
-> 200 Response
-
-```json
-{
- "count": 0
-}
-```
-
-Responses
-
-|Status|Meaning|Description|Schema|
-|---|---|---|---|
-|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|ToDo model count|[loopback.Count](#schemaloopback.count)|
-
-
-This operation does not require authentication
-
-
-## TodoController.updateById
-
-Parameters
-
-|Name|In|Type|Required|Description|
-|---|---|---|---|---|
-|id|path|string|true|none|
-|body|body|[ToDoPartial](#schematodopartial)|false|none|
-
-Responses
-
-|Status|Meaning|Description|Schema|
-|---|---|---|---|
-|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|ToDo PATCH success|None|
-
-
-This operation does not require authentication
-
-
-## TodoController.findById
-
-Parameters
-
-|Name|In|Type|Required|Description|
-|---|---|---|---|---|
-|id|path|string|true|none|
-|filter|query|[todos.Filter](#schematodos.filter)|false|none|
-
-> Example responses
-
-> 200 Response
-
-```json
-{
- "deleted": true,
- "deletedOn": "2019-08-24T14:15:22Z",
- "deletedBy": "string",
- "createdOn": "2019-08-24T14:15:22Z",
- "modifiedOn": "2019-08-24T14:15:22Z",
- "createdBy": "string",
- "modifiedBy": "string",
- "id": "string",
- "title": "string",
- "description": "string",
- "items": [
- "string"
- ]
-}
-```
-
-Responses
-
-|Status|Meaning|Description|Schema|
-|---|---|---|---|
-|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|ToDo model instance|[ToDoWithRelations](#schematodowithrelations)|
-
-
-This operation does not require authentication
-
-
-## TodoController.deleteById
-
-Parameters
-
-|Name|In|Type|Required|Description|
-|---|---|---|---|---|
-|id|path|string|true|none|
-
-Responses
-
-|Status|Meaning|Description|Schema|
-|---|---|---|---|
-|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|ToDo DELETE success|None|
-
-
-This operation does not require authentication
-
-
-## TodoController.create
-
-Parameters
-
-|Name|In|Type|Required|Description|
-|---|---|---|---|---|
-|body|body|[NewToDo](#schemanewtodo)|false|none|
-
-> Example responses
-
-> 200 Response
-
-```json
-{
- "deleted": true,
- "deletedOn": "2019-08-24T14:15:22Z",
- "deletedBy": "string",
- "createdOn": "2019-08-24T14:15:22Z",
- "modifiedOn": "2019-08-24T14:15:22Z",
- "createdBy": "string",
- "modifiedBy": "string",
- "id": "string",
- "title": "string",
- "description": "string",
- "items": [
- "string"
- ]
-}
-```
-
-Responses
-
-|Status|Meaning|Description|Schema|
-|---|---|---|---|
-|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|ToDo model instance|[ToDo](#schematodo)|
-
-
-This operation does not require authentication
-
-
-## TodoController.find
-
-Parameters
-
-|Name|In|Type|Required|Description|
-|---|---|---|---|---|
-|filter|query|[todos.Filter1](#schematodos.filter1)|false|none|
-
-> Example responses
-
-> 200 Response
-
-```json
-[
- {
- "deleted": true,
- "deletedOn": "2019-08-24T14:15:22Z",
- "deletedBy": "string",
- "createdOn": "2019-08-24T14:15:22Z",
- "modifiedOn": "2019-08-24T14:15:22Z",
- "createdBy": "string",
- "modifiedBy": "string",
- "id": "string",
- "title": "string",
- "description": "string",
- "items": [
- "string"
- ]
- }
-]
-```
-
-Responses
-
-|Status|Meaning|Description|Schema|
-|---|---|---|---|
-|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Array of ToDo model instances|Inline|
-
-Response Schema
-
-Status Code **200**
-
-|Name|Type|Required|Restrictions|Description|
-|---|---|---|---|---|
-|*anonymous*|[[ToDoWithRelations](#schematodowithrelations)]|false|none|[(tsType: ToDoWithRelations, schemaOptions: { includeRelations: true })]|
-|» ToDoWithRelations|[ToDoWithRelations](#schematodowithrelations)|false|none|(tsType: ToDoWithRelations, schemaOptions: { includeRelations: true })|
-|»» deleted|boolean|false|none|none|
-|»» deletedOn|string(date-time)¦null|false|none|none|
-|»» deletedBy|string¦null|false|none|none|
-|»» createdOn|string(date-time)|false|none|none|
-|»» modifiedOn|string(date-time)|false|none|none|
-|»» createdBy|string|false|none|none|
-|»» modifiedBy|string|false|none|none|
-|»» id|string|false|none|none|
-|»» title|string|true|none|none|
-|»» description|string|true|none|none|
-|»» items|[string]|false|none|none|
-
-
-This operation does not require authentication
-
-
-HomePageController
-
-## HomePageController.homePage
-
-Responses
-
-|Status|Meaning|Description|Schema|
-|---|---|---|---|
-|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Home Page|string|
-
-
-This operation does not require authentication
-
-
-# Schemas
-
-LoginRequest
-
-TokenResponse
-
-AuthTokenRequest
-
-AuthRefreshTokenRequest
-
-ResetPasswordPartial
-
-ResetPassword
-
-SuccessResponse
-
-RefreshTokenRequestPartial
-
-RefreshTokenRequest
-
-Otp
-
-AuthClient
-
-AuthClientExcluding_id_
-
-AuthClientPartial
-
-User
-
-ForgetPasswordResponseDto
-
-ForgetPasswordDto
-
-ResetPasswordWithClient
-
-ToDo
-
-NewToDo
-
-ToDoWithRelations
-
-ToDoPartial
-
-loopback.Count
-
-auth_clients.Filter
-
-todos.Filter
-
-todos.Filter1
-
- where is a JWT token signed using JWT issu
#### API Details
-Visit the [OpenAPI spec docs](OPEN_API_SPEC.md)
+Visit the [OpenAPI spec docs](./openapi.md)
diff --git a/services/authentication-service/migration.js b/services/authentication-service/migration.js
index 78ac56b557..15d3d09392 100644
--- a/services/authentication-service/migration.js
+++ b/services/authentication-service/migration.js
@@ -1,6 +1,5 @@
const dotenvExt = require('dotenv-extended');
const fs = require('fs');
-const DBMigrate = require('db-migrate');
const path = require('path');
let isLocal = false;
dotenvExt.load({
@@ -27,6 +26,7 @@ if (isLocal) {
`${type}_MIGRATION or SOURCELOOP_MIGRATION variables not found in the environment, skipping automigration.`,
);
} else {
+ const DBMigrate = require('db-migrate');
dotenvExt.load({
schema: path.join('.', 'migrations', '.env.schema'),
path: path.join(process.env.INIT_CWD, '.env'),
diff --git a/services/authentication-service/openapi.json b/services/authentication-service/openapi.json
new file mode 100644
index 0000000000..390a92341b
--- /dev/null
+++ b/services/authentication-service/openapi.json
@@ -0,0 +1,2027 @@
+{
+ "openapi": "3.0.0",
+ "info": {
+ "title": "Authentication Service",
+ "version": "1.0.0",
+ "description": "services",
+ "contact": {}
+ },
+ "paths": {
+ "/auth/change-password": {
+ "patch": {
+ "x-controller-name": "LoginController",
+ "x-operation-name": "resetPassword",
+ "tags": [
+ "LoginController"
+ ],
+ "security": [
+ {
+ "HTTPBearer": []
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "If User password successfully changed."
+ }
+ },
+ "parameters": [
+ {
+ "name": "Authorization",
+ "in": "header",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ResetPasswordPartial"
+ }
+ }
+ }
+ },
+ "operationId": "LoginController.resetPassword"
+ }
+ },
+ "/auth/forget-password": {
+ "post": {
+ "x-controller-name": "ForgetPasswordController",
+ "x-operation-name": "forgetPassword",
+ "tags": [
+ "ForgetPasswordController"
+ ],
+ "responses": {
+ "200": {
+ "description": "Success Response.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ForgetPasswordResponseDto"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "The syntax of the request entity is incorrect."
+ },
+ "401": {
+ "description": "Invalid Credentials."
+ },
+ "404": {
+ "description": "The entity requested does not exist."
+ },
+ "422": {
+ "description": "The syntax of the request entity is incorrect"
+ }
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ForgetPasswordDto"
+ }
+ }
+ }
+ },
+ "operationId": "ForgetPasswordController.forgetPassword"
+ }
+ },
+ "/auth/google": {
+ "post": {
+ "x-controller-name": "LoginController",
+ "x-operation-name": "postLoginViaGoogle",
+ "tags": [
+ "LoginController"
+ ],
+ "responses": {
+ "200": {
+ "description": "POST Call for Google based login",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/TokenResponse"
+ }
+ }
+ }
+ }
+ },
+ "requestBody": {
+ "content": {
+ "application/x-www-form-urlencoded": {
+ "schema": {
+ "$ref": "#/components/schemas/ClientAuthRequest"
+ }
+ }
+ }
+ },
+ "operationId": "LoginController.postLoginViaGoogle"
+ },
+ "get": {
+ "x-controller-name": "LoginController",
+ "x-operation-name": "loginViaGoogle",
+ "tags": [
+ "LoginController"
+ ],
+ "responses": {
+ "200": {
+ "description": "Google Token Response (Deprecated: Possible security issue if secret is passed via query params, please use the post endpoint)",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/TokenResponse"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": true,
+ "parameters": [
+ {
+ "name": "client_id",
+ "in": "query",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "client_secret",
+ "in": "query",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "operationId": "LoginController.loginViaGoogle"
+ }
+ },
+ "/auth/google-auth-redirect": {
+ "get": {
+ "x-controller-name": "LoginController",
+ "x-operation-name": "googleCallback",
+ "tags": [
+ "LoginController"
+ ],
+ "responses": {
+ "200": {
+ "description": "Google Redirect Token Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/TokenResponse"
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "code",
+ "in": "query",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "state",
+ "in": "query",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "operationId": "LoginController.googleCallback"
+ }
+ },
+ "/auth/instagram": {
+ "post": {
+ "x-controller-name": "LoginController",
+ "x-operation-name": "postLoginViaInstagram",
+ "tags": [
+ "LoginController"
+ ],
+ "responses": {
+ "200": {
+ "description": "POST Call for Instagram based login",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/TokenResponse"
+ }
+ }
+ }
+ }
+ },
+ "requestBody": {
+ "content": {
+ "application/x-www-form-urlencoded": {
+ "schema": {
+ "$ref": "#/components/schemas/ClientAuthRequest"
+ }
+ }
+ }
+ },
+ "operationId": "LoginController.postLoginViaInstagram"
+ }
+ },
+ "/auth/instagram-auth-redirect": {
+ "get": {
+ "x-controller-name": "LoginController",
+ "x-operation-name": "instagramCallback",
+ "tags": [
+ "LoginController"
+ ],
+ "responses": {
+ "200": {
+ "description": "Instagram Redirect Token Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/TokenResponse"
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "code",
+ "in": "query",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "state",
+ "in": "query",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "operationId": "LoginController.instagramCallback"
+ }
+ },
+ "/auth/keycloak": {
+ "post": {
+ "x-controller-name": "LoginController",
+ "x-operation-name": "postLoginViaKeycloak",
+ "tags": [
+ "LoginController"
+ ],
+ "description": "POST Call for keycloak based login",
+ "responses": {
+ "200": {
+ "description": "Keycloak Token Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/TokenResponse"
+ }
+ }
+ }
+ }
+ },
+ "requestBody": {
+ "content": {
+ "application/x-www-form-urlencoded": {
+ "schema": {
+ "$ref": "#/components/schemas/ClientAuthRequest"
+ }
+ }
+ }
+ },
+ "operationId": "LoginController.postLoginViaKeycloak"
+ },
+ "get": {
+ "x-controller-name": "LoginController",
+ "x-operation-name": "loginViaKeycloak",
+ "tags": [
+ "LoginController"
+ ],
+ "responses": {
+ "200": {
+ "description": "Keycloak Token Response (Deprecated: Possible security issue if secret is passed via query params, please use the post endpoint)",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/TokenResponse"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": true,
+ "parameters": [
+ {
+ "name": "client_id",
+ "in": "query",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "client_secret",
+ "in": "query",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "operationId": "LoginController.loginViaKeycloak"
+ }
+ },
+ "/auth/keycloak-auth-redirect": {
+ "get": {
+ "x-controller-name": "LoginController",
+ "x-operation-name": "keycloakCallback",
+ "tags": [
+ "LoginController"
+ ],
+ "responses": {
+ "200": {
+ "description": "Keycloak Redirect Token Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/TokenResponse"
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "code",
+ "in": "query",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "state",
+ "in": "query",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "operationId": "LoginController.keycloakCallback"
+ }
+ },
+ "/auth/login": {
+ "post": {
+ "x-controller-name": "LoginController",
+ "x-operation-name": "login",
+ "tags": [
+ "LoginController"
+ ],
+ "description": "Gets you the code that will be used for getting token (webapps)",
+ "responses": {
+ "200": {
+ "description": "Auth Code",
+ "content": {}
+ },
+ "400": {
+ "description": "The syntax of the request entity is incorrect."
+ },
+ "401": {
+ "description": "Invalid Credentials."
+ },
+ "404": {
+ "description": "The entity requested does not exist."
+ },
+ "422": {
+ "description": "The syntax of the request entity is incorrect"
+ }
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/LoginRequest"
+ }
+ }
+ }
+ },
+ "operationId": "LoginController.login"
+ }
+ },
+ "/auth/login-token": {
+ "post": {
+ "x-controller-name": "LoginController",
+ "x-operation-name": "loginWithClientUser",
+ "tags": [
+ "LoginController"
+ ],
+ "description": "Gets you refresh token and access token in one hit. (mobile app)",
+ "responses": {
+ "200": {
+ "description": "Token Response Model",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/TokenResponse"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "The syntax of the request entity is incorrect."
+ },
+ "401": {
+ "description": "Invalid Credentials."
+ },
+ "404": {
+ "description": "The entity requested does not exist."
+ },
+ "422": {
+ "description": "The syntax of the request entity is incorrect"
+ }
+ },
+ "parameters": [
+ {
+ "name": "device_id",
+ "in": "header",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/LoginRequest"
+ }
+ }
+ }
+ },
+ "operationId": "LoginController.loginWithClientUser"
+ }
+ },
+ "/auth/me": {
+ "get": {
+ "x-controller-name": "LoginController",
+ "x-operation-name": "me",
+ "tags": [
+ "LoginController"
+ ],
+ "security": [
+ {
+ "HTTPBearer": []
+ }
+ ],
+ "description": "To get the user details",
+ "responses": {
+ "200": {
+ "description": "User Object",
+ "content": {}
+ },
+ "400": {
+ "description": "The syntax of the request entity is incorrect."
+ },
+ "401": {
+ "description": "Invalid Credentials."
+ },
+ "404": {
+ "description": "The entity requested does not exist."
+ },
+ "422": {
+ "description": "The syntax of the request entity is incorrect"
+ }
+ },
+ "operationId": "LoginController.me"
+ }
+ },
+ "/auth/reset-password": {
+ "patch": {
+ "x-controller-name": "ForgetPasswordController",
+ "x-operation-name": "resetPassword",
+ "tags": [
+ "ForgetPasswordController"
+ ],
+ "responses": {
+ "204": {
+ "description": "If User password successfully changed."
+ }
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ResetPasswordWithClient"
+ }
+ }
+ }
+ },
+ "operationId": "ForgetPasswordController.resetPassword"
+ }
+ },
+ "/auth/sign-up/create-token": {
+ "post": {
+ "x-controller-name": "SignupRequestController",
+ "x-operation-name": "requestSignup",
+ "tags": [
+ "SignupRequestController"
+ ],
+ "responses": {
+ "200": {
+ "description": "Sucess Response.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SignupRequestResponseDto"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "The syntax of the request entity is incorrect."
+ },
+ "401": {
+ "description": "Invalid Credentials."
+ },
+ "404": {
+ "description": "The entity requested does not exist."
+ },
+ "422": {
+ "description": "The syntax of the request entity is incorrect"
+ }
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SignupRequestDto"
+ }
+ }
+ }
+ },
+ "operationId": "SignupRequestController.requestSignup"
+ }
+ },
+ "/auth/sign-up/create-user": {
+ "post": {
+ "x-controller-name": "SignupRequestController",
+ "x-operation-name": "signupWithToken",
+ "tags": [
+ "SignupRequestController"
+ ],
+ "responses": {
+ "200": {
+ "description": "Sucess Response.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/LocalUserProfileDto"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "The syntax of the request entity is incorrect."
+ },
+ "401": {
+ "description": "Invalid Credentials."
+ },
+ "404": {
+ "description": "The entity requested does not exist."
+ },
+ "422": {
+ "description": "The syntax of the request entity is incorrect"
+ }
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/LocalUserProfileDto"
+ }
+ }
+ }
+ },
+ "operationId": "SignupRequestController.signupWithToken"
+ }
+ },
+ "/auth/sign-up/verify-token": {
+ "get": {
+ "x-controller-name": "SignupRequestController",
+ "x-operation-name": "verifyInviteToken",
+ "tags": [
+ "SignupRequestController"
+ ],
+ "responses": {
+ "200": {
+ "description": "Sucess Response."
+ },
+ "400": {
+ "description": "The syntax of the request entity is incorrect."
+ },
+ "401": {
+ "description": "Invalid Credentials."
+ },
+ "404": {
+ "description": "The entity requested does not exist."
+ },
+ "422": {
+ "description": "The syntax of the request entity is incorrect"
+ }
+ },
+ "operationId": "SignupRequestController.verifyInviteToken"
+ }
+ },
+ "/auth/token": {
+ "post": {
+ "x-controller-name": "LoginController",
+ "x-operation-name": "getToken",
+ "tags": [
+ "LoginController"
+ ],
+ "description": " Send the code received from the above api and this api will send you refresh token and access token (webapps)",
+ "responses": {
+ "200": {
+ "description": "Token Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/TokenResponse"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "The syntax of the request entity is incorrect."
+ },
+ "401": {
+ "description": "Invalid Credentials."
+ },
+ "404": {
+ "description": "The entity requested does not exist."
+ },
+ "422": {
+ "description": "The syntax of the request entity is incorrect"
+ }
+ },
+ "parameters": [
+ {
+ "name": "device_id",
+ "in": "header",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AuthTokenRequest"
+ }
+ }
+ }
+ },
+ "operationId": "LoginController.getToken"
+ }
+ },
+ "/auth/token-refresh": {
+ "post": {
+ "x-controller-name": "LoginController",
+ "x-operation-name": "exchangeToken",
+ "tags": [
+ "LoginController"
+ ],
+ "description": " Gets you a new access and refresh token once your access token is expired. (both mobile and web)\n",
+ "responses": {
+ "200": {
+ "description": "New Token Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/TokenResponse"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "The syntax of the request entity is incorrect."
+ },
+ "401": {
+ "description": "Invalid Credentials."
+ },
+ "404": {
+ "description": "The entity requested does not exist."
+ },
+ "422": {
+ "description": "The syntax of the request entity is incorrect"
+ }
+ },
+ "parameters": [
+ {
+ "name": "device_id",
+ "in": "header",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AuthRefreshTokenRequest"
+ }
+ }
+ }
+ },
+ "operationId": "LoginController.exchangeToken"
+ }
+ },
+ "/auth/verify-reset-password-link": {
+ "get": {
+ "x-controller-name": "ForgetPasswordController",
+ "x-operation-name": "verifyResetPasswordLink",
+ "tags": [
+ "ForgetPasswordController"
+ ],
+ "responses": {
+ "200": {
+ "description": "Check if Token Is Valid and not Expired."
+ }
+ },
+ "parameters": [
+ {
+ "name": "token",
+ "in": "query",
+ "schema": {
+ "type": "string"
+ },
+ "required": true
+ }
+ ],
+ "operationId": "ForgetPasswordController.verifyResetPasswordLink"
+ }
+ },
+ "/auth-clients/count": {
+ "get": {
+ "x-controller-name": "AuthClientController",
+ "x-operation-name": "count",
+ "tags": [
+ "AuthClientController"
+ ],
+ "security": [
+ {
+ "HTTPBearer": []
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "AuthClient model count",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/loopback.Count"
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "where",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "auth_clients.WhereFilter",
+ "additionalProperties": true,
+ "x-typescript-type": "@loopback/repository#Where"
+ }
+ }
+ }
+ }
+ ],
+ "operationId": "AuthClientController.count"
+ }
+ },
+ "/auth-clients/{id}": {
+ "put": {
+ "x-controller-name": "AuthClientController",
+ "x-operation-name": "replaceById",
+ "tags": [
+ "AuthClientController"
+ ],
+ "security": [
+ {
+ "HTTPBearer": []
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "AuthClient PUT success"
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "schema": {
+ "type": "number"
+ },
+ "required": true
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AuthClient"
+ }
+ }
+ },
+ "x-parameter-index": 1
+ },
+ "operationId": "AuthClientController.replaceById"
+ },
+ "patch": {
+ "x-controller-name": "AuthClientController",
+ "x-operation-name": "updateById",
+ "tags": [
+ "AuthClientController"
+ ],
+ "security": [
+ {
+ "HTTPBearer": []
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "AuthClient PATCH success"
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "schema": {
+ "type": "number"
+ },
+ "required": true
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AuthClientPartial"
+ }
+ }
+ },
+ "x-parameter-index": 1
+ },
+ "operationId": "AuthClientController.updateById"
+ },
+ "get": {
+ "x-controller-name": "AuthClientController",
+ "x-operation-name": "findById",
+ "tags": [
+ "AuthClientController"
+ ],
+ "security": [
+ {
+ "HTTPBearer": []
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "AuthClient model instance",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AuthClient"
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "schema": {
+ "type": "number"
+ },
+ "required": true
+ }
+ ],
+ "operationId": "AuthClientController.findById"
+ },
+ "delete": {
+ "x-controller-name": "AuthClientController",
+ "x-operation-name": "deleteById",
+ "tags": [
+ "AuthClientController"
+ ],
+ "security": [
+ {
+ "HTTPBearer": []
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "AuthClient DELETE success"
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "schema": {
+ "type": "number"
+ },
+ "required": true
+ }
+ ],
+ "operationId": "AuthClientController.deleteById"
+ }
+ },
+ "/auth-clients": {
+ "post": {
+ "x-controller-name": "AuthClientController",
+ "x-operation-name": "create",
+ "tags": [
+ "AuthClientController"
+ ],
+ "security": [
+ {
+ "HTTPBearer": []
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "AuthClient model instance",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AuthClient"
+ }
+ }
+ }
+ }
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AuthClientExcluding_id_"
+ }
+ }
+ }
+ },
+ "operationId": "AuthClientController.create"
+ },
+ "patch": {
+ "x-controller-name": "AuthClientController",
+ "x-operation-name": "updateAll",
+ "tags": [
+ "AuthClientController"
+ ],
+ "security": [
+ {
+ "HTTPBearer": []
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "AuthClient PATCH success count",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/loopback.Count"
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "where",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "auth_clients.WhereFilter",
+ "additionalProperties": true,
+ "x-typescript-type": "@loopback/repository#Where"
+ }
+ }
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AuthClientPartial"
+ }
+ }
+ }
+ },
+ "operationId": "AuthClientController.updateAll"
+ },
+ "get": {
+ "x-controller-name": "AuthClientController",
+ "x-operation-name": "find",
+ "tags": [
+ "AuthClientController"
+ ],
+ "security": [
+ {
+ "HTTPBearer": []
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Array of AuthClient model instances",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/AuthClient"
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "filter",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/auth_clients.Filter"
+ }
+ }
+ }
+ }
+ ],
+ "operationId": "AuthClientController.find"
+ }
+ },
+ "/keycloak/logout": {
+ "post": {
+ "x-controller-name": "LogoutController",
+ "x-operation-name": "keycloakLogout",
+ "tags": [
+ "LogoutController"
+ ],
+ "security": [
+ {
+ "HTTPBearer": []
+ }
+ ],
+ "description": "This API will log out the user from application as well as keycloak",
+ "responses": {
+ "200": {
+ "description": "Success Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SuccessResponse"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "The syntax of the request entity is incorrect."
+ },
+ "401": {
+ "description": "Invalid Credentials."
+ },
+ "404": {
+ "description": "The entity requested does not exist."
+ },
+ "422": {
+ "description": "The syntax of the request entity is incorrect"
+ }
+ },
+ "parameters": [
+ {
+ "name": "Authorization",
+ "in": "header",
+ "schema": {
+ "type": "string"
+ },
+ "description": "This is the access token which is required to authenticate user."
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/RefreshTokenRequestPartial"
+ }
+ }
+ },
+ "x-parameter-index": 1
+ },
+ "operationId": "LogoutController.keycloakLogout"
+ }
+ },
+ "/logout": {
+ "post": {
+ "x-controller-name": "LogoutController",
+ "x-operation-name": "logout",
+ "tags": [
+ "LogoutController"
+ ],
+ "security": [
+ {
+ "HTTPBearer": []
+ }
+ ],
+ "description": "To logout",
+ "responses": {
+ "200": {
+ "description": "Success Response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SuccessResponse"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "The syntax of the request entity is incorrect."
+ },
+ "401": {
+ "description": "Invalid Credentials."
+ },
+ "404": {
+ "description": "The entity requested does not exist."
+ },
+ "422": {
+ "description": "The syntax of the request entity is incorrect"
+ }
+ },
+ "parameters": [
+ {
+ "name": "Authorization",
+ "in": "header",
+ "schema": {
+ "type": "string"
+ },
+ "description": "This is the access token which is required to authenticate user."
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/RefreshTokenRequestPartial"
+ }
+ }
+ },
+ "x-parameter-index": 1
+ },
+ "operationId": "LogoutController.logout"
+ }
+ },
+ "/otp-caches/{id}": {
+ "get": {
+ "x-controller-name": "OtpController",
+ "x-operation-name": "findById",
+ "tags": [
+ "OtpController"
+ ],
+ "responses": {
+ "200": {
+ "description": "Otp model instance",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Otp"
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ },
+ "required": true
+ }
+ ],
+ "operationId": "OtpController.findById"
+ },
+ "delete": {
+ "x-controller-name": "OtpController",
+ "x-operation-name": "deleteById",
+ "tags": [
+ "OtpController"
+ ],
+ "responses": {
+ "204": {
+ "description": "Otp DELETE success"
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ },
+ "required": true
+ }
+ ],
+ "operationId": "OtpController.deleteById"
+ }
+ },
+ "/otp-caches": {
+ "post": {
+ "x-controller-name": "OtpController",
+ "x-operation-name": "create",
+ "tags": [
+ "OtpController"
+ ],
+ "responses": {
+ "200": {
+ "description": "Otp model instance",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Otp"
+ }
+ }
+ }
+ }
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Otp"
+ }
+ }
+ }
+ },
+ "operationId": "OtpController.create"
+ }
+ }
+ },
+ "components": {
+ "securitySchemes": {
+ "HTTPBearer": {
+ "type": "http",
+ "scheme": "bearer",
+ "bearerFormat": "JWT"
+ }
+ },
+ "schemas": {
+ "LoginRequest": {
+ "title": "LoginRequest",
+ "type": "object",
+ "description": "This is the signature for login request.",
+ "properties": {
+ "client_id": {
+ "type": "string",
+ "description": "This property is supposed to be a string and is a required field"
+ },
+ "client_secret": {
+ "type": "string",
+ "description": "This property is supposed to be a string and is a required field"
+ },
+ "username": {
+ "type": "string",
+ "description": "This property is supposed to be a string and is a required field"
+ },
+ "password": {
+ "type": "string",
+ "description": "This property is supposed to be a string and is a required field"
+ }
+ },
+ "required": [
+ "client_id",
+ "client_secret",
+ "username",
+ "password"
+ ],
+ "additionalProperties": false
+ },
+ "TokenResponse": {
+ "title": "TokenResponse",
+ "type": "object",
+ "description": "This is signature for successful token response.",
+ "properties": {
+ "accessToken": {
+ "type": "string",
+ "description": "This property is supposed to be a string and is a required field"
+ },
+ "refreshToken": {
+ "type": "string",
+ "description": "This property is supposed to be a string and is a required field"
+ },
+ "expires": {
+ "type": "number"
+ },
+ "pubnubToken": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "accessToken",
+ "refreshToken",
+ "expires"
+ ],
+ "additionalProperties": false
+ },
+ "AuthTokenRequest": {
+ "title": "AuthTokenRequest",
+ "type": "object",
+ "description": "This is the signature for requesting the accessToken and refreshToken.",
+ "properties": {
+ "code": {
+ "type": "string"
+ },
+ "clientId": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "code",
+ "clientId"
+ ],
+ "additionalProperties": false
+ },
+ "Function": {},
+ "AuthRefreshTokenRequest": {
+ "title": "AuthRefreshTokenRequest",
+ "type": "object",
+ "properties": {
+ "refreshToken": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "refreshToken"
+ ],
+ "additionalProperties": false
+ },
+ "ClientAuthRequest": {
+ "title": "ClientAuthRequest",
+ "type": "object",
+ "description": "This is signature for client authentication request.",
+ "properties": {
+ "client_id": {
+ "type": "string",
+ "description": "This property is supposed to be a string and is a required field"
+ },
+ "client_secret": {
+ "type": "string",
+ "description": "This property is supposed to be a string and is a required field"
+ }
+ },
+ "required": [
+ "client_id",
+ "client_secret"
+ ],
+ "additionalProperties": false
+ },
+ "ResetPasswordPartial": {
+ "title": "ResetPasswordPartial",
+ "type": "object",
+ "description": "This is a signature for reset password. (tsType: Partial, schemaOptions: { partial: true })",
+ "properties": {
+ "refreshToken": {
+ "type": "string"
+ },
+ "username": {
+ "type": "string",
+ "description": "This property is supposed to be a string and is a required field"
+ },
+ "password": {
+ "type": "string",
+ "description": "This property is supposed to be a string and is a required field"
+ },
+ "oldPassword": {
+ "type": "string",
+ "description": "This property is supposed to be a string and is a required field"
+ }
+ },
+ "additionalProperties": false
+ },
+ "ResetPassword": {
+ "title": "ResetPassword",
+ "type": "object",
+ "description": "This is a signature for reset password.",
+ "properties": {
+ "refreshToken": {
+ "type": "string"
+ },
+ "username": {
+ "type": "string",
+ "description": "This property is supposed to be a string and is a required field"
+ },
+ "password": {
+ "type": "string",
+ "description": "This property is supposed to be a string and is a required field"
+ },
+ "oldPassword": {
+ "type": "string",
+ "description": "This property is supposed to be a string and is a required field"
+ }
+ },
+ "required": [
+ "refreshToken",
+ "username",
+ "password"
+ ],
+ "additionalProperties": false
+ },
+ "SuccessResponse": {
+ "title": "SuccessResponse",
+ "type": "object",
+ "properties": {
+ "success": {
+ "type": "boolean"
+ }
+ },
+ "additionalProperties": true
+ },
+ "RefreshTokenRequestPartial": {
+ "title": "RefreshTokenRequestPartial",
+ "type": "object",
+ "description": "(tsType: Partial, schemaOptions: { partial: true })",
+ "properties": {
+ "refreshToken": {
+ "type": "string"
+ }
+ },
+ "additionalProperties": false,
+ "x-typescript-type": "Partial"
+ },
+ "RefreshTokenRequest": {
+ "title": "RefreshTokenRequest",
+ "type": "object",
+ "properties": {
+ "refreshToken": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "refreshToken"
+ ],
+ "additionalProperties": false
+ },
+ "Otp": {
+ "title": "Otp",
+ "type": "object",
+ "properties": {
+ "otp": {
+ "type": "string"
+ },
+ "username": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "otp",
+ "username"
+ ],
+ "additionalProperties": false
+ },
+ "AuthClient": {
+ "title": "AuthClient",
+ "type": "object",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "deletedOn": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "deletedBy": {
+ "type": "string",
+ "nullable": true
+ },
+ "createdOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "modifiedOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "id": {
+ "type": "number"
+ },
+ "clientId": {
+ "type": "string"
+ },
+ "clientSecret": {
+ "type": "string"
+ },
+ "secret": {
+ "type": "string"
+ },
+ "redirectUrl": {
+ "type": "string"
+ },
+ "accessTokenExpiration": {
+ "type": "number"
+ },
+ "refreshTokenExpiration": {
+ "type": "number"
+ },
+ "authCodeExpiration": {
+ "type": "number"
+ }
+ },
+ "required": [
+ "clientId",
+ "clientSecret",
+ "secret",
+ "accessTokenExpiration",
+ "refreshTokenExpiration",
+ "authCodeExpiration"
+ ],
+ "additionalProperties": false
+ },
+ "AuthClientExcluding_id_": {
+ "title": "AuthClientExcluding_id_",
+ "type": "object",
+ "description": "(tsType: Omit, schemaOptions: { exclude: [ 'id' ] })",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "deletedOn": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "deletedBy": {
+ "type": "string",
+ "nullable": true
+ },
+ "createdOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "modifiedOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "clientId": {
+ "type": "string"
+ },
+ "clientSecret": {
+ "type": "string"
+ },
+ "secret": {
+ "type": "string"
+ },
+ "redirectUrl": {
+ "type": "string"
+ },
+ "accessTokenExpiration": {
+ "type": "number"
+ },
+ "refreshTokenExpiration": {
+ "type": "number"
+ },
+ "authCodeExpiration": {
+ "type": "number"
+ }
+ },
+ "required": [
+ "clientId",
+ "clientSecret",
+ "secret",
+ "accessTokenExpiration",
+ "refreshTokenExpiration",
+ "authCodeExpiration"
+ ],
+ "additionalProperties": false,
+ "x-typescript-type": "Omit"
+ },
+ "AuthClientPartial": {
+ "title": "AuthClientPartial",
+ "type": "object",
+ "description": "(tsType: Partial, schemaOptions: { partial: true })",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "deletedOn": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "deletedBy": {
+ "type": "string",
+ "nullable": true
+ },
+ "createdOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "modifiedOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "id": {
+ "type": "number"
+ },
+ "clientId": {
+ "type": "string"
+ },
+ "clientSecret": {
+ "type": "string"
+ },
+ "secret": {
+ "type": "string"
+ },
+ "redirectUrl": {
+ "type": "string"
+ },
+ "accessTokenExpiration": {
+ "type": "number"
+ },
+ "refreshTokenExpiration": {
+ "type": "number"
+ },
+ "authCodeExpiration": {
+ "type": "number"
+ }
+ },
+ "additionalProperties": false,
+ "x-typescript-type": "Partial"
+ },
+ "User": {
+ "title": "User",
+ "type": "object",
+ "description": "This is signature for user model.",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "deletedOn": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "deletedBy": {
+ "type": "string",
+ "nullable": true
+ },
+ "createdOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "modifiedOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "createdBy": {
+ "type": "string"
+ },
+ "modifiedBy": {
+ "type": "string"
+ },
+ "id": {
+ "type": "string"
+ },
+ "firstName": {
+ "type": "string"
+ },
+ "lastName": {
+ "type": "string"
+ },
+ "middleName": {
+ "type": "string"
+ },
+ "username": {
+ "type": "string"
+ },
+ "email": {
+ "type": "string"
+ },
+ "phone": {
+ "type": "string",
+ "pattern": "^\\+?[1-9]\\d{1,14}$"
+ },
+ "authClientIds": {
+ "type": "string"
+ },
+ "lastLogin": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "dob": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "gender": {
+ "type": "string",
+ "description": "This field takes a single character as input in database.\n 'M' for male and 'F' for female.",
+ "enum": [
+ "M",
+ "F",
+ "O"
+ ]
+ },
+ "defaultTenantId": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "firstName",
+ "username"
+ ],
+ "additionalProperties": false
+ },
+ "ForgetPasswordResponseDto": {
+ "title": "ForgetPasswordResponseDto",
+ "type": "object",
+ "properties": {
+ "code": {
+ "type": "string"
+ },
+ "expiry": {
+ "type": "number"
+ },
+ "email": {
+ "type": "string"
+ },
+ "user": {
+ "$ref": "#/components/schemas/User"
+ }
+ },
+ "required": [
+ "code",
+ "expiry",
+ "email"
+ ],
+ "additionalProperties": false
+ },
+ "ForgetPasswordDto": {
+ "title": "ForgetPasswordDto",
+ "type": "object",
+ "properties": {
+ "username": {
+ "type": "string"
+ },
+ "client_id": {
+ "type": "string"
+ },
+ "client_secret": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "username",
+ "client_id",
+ "client_secret"
+ ],
+ "additionalProperties": false
+ },
+ "ResetPasswordWithClient": {
+ "title": "ResetPasswordWithClient",
+ "type": "object",
+ "properties": {
+ "token": {
+ "type": "string"
+ },
+ "password": {
+ "type": "string"
+ },
+ "client_id": {
+ "type": "string"
+ },
+ "client_secret": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "token",
+ "password",
+ "client_id",
+ "client_secret"
+ ],
+ "additionalProperties": false
+ },
+ "SignupRequestResponseDto": {
+ "title": "SignupRequestResponseDto",
+ "type": "object",
+ "properties": {
+ "code": {
+ "type": "string"
+ },
+ "expiry": {
+ "type": "number"
+ },
+ "email": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "code",
+ "expiry",
+ "email"
+ ],
+ "additionalProperties": false
+ },
+ "SignupRequestDto": {
+ "title": "SignupRequestDto",
+ "type": "object",
+ "properties": {
+ "email": {
+ "type": "string"
+ },
+ "data": {
+ "type": "object"
+ }
+ },
+ "required": [
+ "email"
+ ],
+ "additionalProperties": false
+ },
+ "LocalUserProfileDto": {
+ "title": "LocalUserProfileDto",
+ "type": "object",
+ "properties": {
+ "email": {
+ "type": "string"
+ },
+ "password": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "email",
+ "password"
+ ],
+ "additionalProperties": true
+ },
+ "SignupRequest": {
+ "title": "SignupRequest",
+ "type": "object",
+ "properties": {
+ "email": {
+ "type": "string"
+ },
+ "expiry": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "email"
+ ],
+ "additionalProperties": false
+ },
+ "loopback.Count": {
+ "type": "object",
+ "title": "loopback.Count",
+ "x-typescript-type": "@loopback/repository#Count",
+ "properties": {
+ "count": {
+ "type": "number"
+ }
+ }
+ },
+ "auth_clients.Filter": {
+ "type": "object",
+ "title": "auth_clients.Filter",
+ "properties": {
+ "offset": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "limit": {
+ "type": "integer",
+ "minimum": 1,
+ "example": 100
+ },
+ "skip": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "order": {
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "where": {
+ "title": "auth_clients.WhereFilter",
+ "type": "object",
+ "additionalProperties": true
+ },
+ "fields": {
+ "oneOf": [
+ {
+ "type": "object",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "deletedOn": {
+ "type": "boolean"
+ },
+ "deletedBy": {
+ "type": "boolean"
+ },
+ "createdOn": {
+ "type": "boolean"
+ },
+ "modifiedOn": {
+ "type": "boolean"
+ },
+ "id": {
+ "type": "boolean"
+ },
+ "clientId": {
+ "type": "boolean"
+ },
+ "clientSecret": {
+ "type": "boolean"
+ },
+ "secret": {
+ "type": "boolean"
+ },
+ "redirectUrl": {
+ "type": "boolean"
+ },
+ "accessTokenExpiration": {
+ "type": "boolean"
+ },
+ "refreshTokenExpiration": {
+ "type": "boolean"
+ },
+ "authCodeExpiration": {
+ "type": "boolean"
+ }
+ },
+ "additionalProperties": false
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": [
+ "deleted",
+ "deletedOn",
+ "deletedBy",
+ "createdOn",
+ "modifiedOn",
+ "id",
+ "clientId",
+ "clientSecret",
+ "secret",
+ "redirectUrl",
+ "accessTokenExpiration",
+ "refreshTokenExpiration",
+ "authCodeExpiration"
+ ],
+ "example": "deleted"
+ },
+ "uniqueItems": true
+ }
+ ],
+ "title": "auth_clients.Fields"
+ }
+ },
+ "additionalProperties": false,
+ "x-typescript-type": "@loopback/repository#Filter"
+ }
+ }
+ },
+ "servers": [
+ {
+ "url": "/"
+ }
+ ]
+}
\ No newline at end of file
diff --git a/services/authentication-service/openapi.md b/services/authentication-service/openapi.md
new file mode 100644
index 0000000000..eae3f5bc5b
--- /dev/null
+++ b/services/authentication-service/openapi.md
@@ -0,0 +1,3099 @@
+---
+title: Authentication Service v1.0.0
+language_tabs:
+ - "'javascript": JavaScript
+ - "'javascript--nodejs": Node.JS'
+language_clients:
+ - "'javascript": request'
+ - "'javascript--nodejs": ""
+toc_footers: []
+includes: []
+search: false
+highlight_theme: darkula
+headingLevel: 2
+
+---
+
+
+
+Authentication Service v1.0.0
+
+> Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
+
+services
+
+Base URLs:
+
+* /
+
+# Authentication
+
+- HTTP Authentication, scheme: bearer
+
+LoginController
+
+## LoginController.resetPassword
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|Authorization|header|string|false|none|
+|body|body|[ResetPasswordPartial](#schemaresetpasswordpartial)|false|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|If User password successfully changed.|None|
+
+
+To perform this operation, you must be authenticated by means of one of the following methods:
+HTTPBearer
+
+
+## LoginController.postLoginViaGoogle
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|body|body|[ClientAuthRequest](#schemaclientauthrequest)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "accessToken": "string",
+ "refreshToken": "string",
+ "expires": 0,
+ "pubnubToken": "string"
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|POST Call for Google based login|[TokenResponse](#schematokenresponse)|
+
+
+This operation does not require authentication
+
+
+## LoginController.loginViaGoogle
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|client_id|query|string|false|none|
+|client_secret|query|string|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "accessToken": "string",
+ "refreshToken": "string",
+ "expires": 0,
+ "pubnubToken": "string"
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Google Token Response (Deprecated: Possible security issue if secret is passed via query params, please use the post endpoint)|[TokenResponse](#schematokenresponse)|
+
+
+This operation does not require authentication
+
+
+## LoginController.googleCallback
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|code|query|string|false|none|
+|state|query|string|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "accessToken": "string",
+ "refreshToken": "string",
+ "expires": 0,
+ "pubnubToken": "string"
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Google Redirect Token Response|[TokenResponse](#schematokenresponse)|
+
+
+This operation does not require authentication
+
+
+## LoginController.postLoginViaInstagram
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|body|body|[ClientAuthRequest](#schemaclientauthrequest)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "accessToken": "string",
+ "refreshToken": "string",
+ "expires": 0,
+ "pubnubToken": "string"
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|POST Call for Instagram based login|[TokenResponse](#schematokenresponse)|
+
+
+This operation does not require authentication
+
+
+## LoginController.instagramCallback
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|code|query|string|false|none|
+|state|query|string|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "accessToken": "string",
+ "refreshToken": "string",
+ "expires": 0,
+ "pubnubToken": "string"
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Instagram Redirect Token Response|[TokenResponse](#schematokenresponse)|
+
+
+This operation does not require authentication
+
+
+## LoginController.postLoginViaKeycloak
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|body|body|[ClientAuthRequest](#schemaclientauthrequest)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "accessToken": "string",
+ "refreshToken": "string",
+ "expires": 0,
+ "pubnubToken": "string"
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Keycloak Token Response|[TokenResponse](#schematokenresponse)|
+
+
+This operation does not require authentication
+
+
+## LoginController.loginViaKeycloak
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|client_id|query|string|false|none|
+|client_secret|query|string|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "accessToken": "string",
+ "refreshToken": "string",
+ "expires": 0,
+ "pubnubToken": "string"
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Keycloak Token Response (Deprecated: Possible security issue if secret is passed via query params, please use the post endpoint)|[TokenResponse](#schematokenresponse)|
+
+
+This operation does not require authentication
+
+
+## LoginController.keycloakCallback
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|code|query|string|false|none|
+|state|query|string|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "accessToken": "string",
+ "refreshToken": "string",
+ "expires": 0,
+ "pubnubToken": "string"
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Keycloak Redirect Token Response|[TokenResponse](#schematokenresponse)|
+
+
+This operation does not require authentication
+
+
+## LoginController.login
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|body|body|[LoginRequest](#schemaloginrequest)|false|none|
+
+> Example responses
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Auth Code|None|
+|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|The syntax of the request entity is incorrect.|None|
+|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Invalid Credentials.|None|
+|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|The entity requested does not exist.|None|
+|422|[Unprocessable Entity](https://tools.ietf.org/html/rfc2518#section-10.3)|The syntax of the request entity is incorrect|None|
+
+Response Schema
+
+
+This operation does not require authentication
+
+
+## LoginController.loginWithClientUser
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|device_id|header|string|false|none|
+|body|body|[LoginRequest](#schemaloginrequest)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "accessToken": "string",
+ "refreshToken": "string",
+ "expires": 0,
+ "pubnubToken": "string"
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Token Response Model|[TokenResponse](#schematokenresponse)|
+|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|The syntax of the request entity is incorrect.|None|
+|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Invalid Credentials.|None|
+|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|The entity requested does not exist.|None|
+|422|[Unprocessable Entity](https://tools.ietf.org/html/rfc2518#section-10.3)|The syntax of the request entity is incorrect|None|
+
+
+This operation does not require authentication
+
+
+## LoginController.me
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|User Object|None|
+|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|The syntax of the request entity is incorrect.|None|
+|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Invalid Credentials.|None|
+|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|The entity requested does not exist.|None|
+|422|[Unprocessable Entity](https://tools.ietf.org/html/rfc2518#section-10.3)|The syntax of the request entity is incorrect|None|
+
+Response Schema
+
+
+To perform this operation, you must be authenticated by means of one of the following methods:
+HTTPBearer
+
+
+## LoginController.getToken
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|device_id|header|string|false|none|
+|body|body|[AuthTokenRequest](#schemaauthtokenrequest)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "accessToken": "string",
+ "refreshToken": "string",
+ "expires": 0,
+ "pubnubToken": "string"
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Token Response|[TokenResponse](#schematokenresponse)|
+|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|The syntax of the request entity is incorrect.|None|
+|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Invalid Credentials.|None|
+|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|The entity requested does not exist.|None|
+|422|[Unprocessable Entity](https://tools.ietf.org/html/rfc2518#section-10.3)|The syntax of the request entity is incorrect|None|
+
+
+This operation does not require authentication
+
+
+## LoginController.exchangeToken
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|device_id|header|string|false|none|
+|body|body|[AuthRefreshTokenRequest](#schemaauthrefreshtokenrequest)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "accessToken": "string",
+ "refreshToken": "string",
+ "expires": 0,
+ "pubnubToken": "string"
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|New Token Response|[TokenResponse](#schematokenresponse)|
+|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|The syntax of the request entity is incorrect.|None|
+|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Invalid Credentials.|None|
+|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|The entity requested does not exist.|None|
+|422|[Unprocessable Entity](https://tools.ietf.org/html/rfc2518#section-10.3)|The syntax of the request entity is incorrect|None|
+
+
+This operation does not require authentication
+
+
+ForgetPasswordController
+
+## ForgetPasswordController.forgetPassword
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|body|body|[ForgetPasswordDto](#schemaforgetpassworddto)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "code": "string",
+ "expiry": 0,
+ "email": "string",
+ "user": {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "firstName": "string",
+ "lastName": "string",
+ "middleName": "string",
+ "username": "string",
+ "email": "string",
+ "phone": "string",
+ "authClientIds": "string",
+ "lastLogin": "2019-08-24T14:15:22Z",
+ "dob": "2019-08-24T14:15:22Z",
+ "gender": "M",
+ "defaultTenantId": "string"
+ }
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Success Response.|[ForgetPasswordResponseDto](#schemaforgetpasswordresponsedto)|
+|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|The syntax of the request entity is incorrect.|None|
+|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Invalid Credentials.|None|
+|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|The entity requested does not exist.|None|
+|422|[Unprocessable Entity](https://tools.ietf.org/html/rfc2518#section-10.3)|The syntax of the request entity is incorrect|None|
+
+
+This operation does not require authentication
+
+
+## ForgetPasswordController.resetPassword
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|body|body|[ResetPasswordWithClient](#schemaresetpasswordwithclient)|false|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|If User password successfully changed.|None|
+
+
+This operation does not require authentication
+
+
+## ForgetPasswordController.verifyResetPasswordLink
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|token|query|string|true|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Check if Token Is Valid and not Expired.|None|
+
+
+This operation does not require authentication
+
+
+SignupRequestController
+
+## SignupRequestController.requestSignup
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|body|body|[SignupRequestDto](#schemasignuprequestdto)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "code": "string",
+ "expiry": 0,
+ "email": "string"
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Sucess Response.|[SignupRequestResponseDto](#schemasignuprequestresponsedto)|
+|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|The syntax of the request entity is incorrect.|None|
+|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Invalid Credentials.|None|
+|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|The entity requested does not exist.|None|
+|422|[Unprocessable Entity](https://tools.ietf.org/html/rfc2518#section-10.3)|The syntax of the request entity is incorrect|None|
+
+
+This operation does not require authentication
+
+
+## SignupRequestController.signupWithToken
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|body|body|[LocalUserProfileDto](#schemalocaluserprofiledto)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "email": "string",
+ "password": "string"
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Sucess Response.|[LocalUserProfileDto](#schemalocaluserprofiledto)|
+|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|The syntax of the request entity is incorrect.|None|
+|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Invalid Credentials.|None|
+|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|The entity requested does not exist.|None|
+|422|[Unprocessable Entity](https://tools.ietf.org/html/rfc2518#section-10.3)|The syntax of the request entity is incorrect|None|
+
+
+This operation does not require authentication
+
+
+## SignupRequestController.verifyInviteToken
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Sucess Response.|None|
+|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|The syntax of the request entity is incorrect.|None|
+|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Invalid Credentials.|None|
+|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|The entity requested does not exist.|None|
+|422|[Unprocessable Entity](https://tools.ietf.org/html/rfc2518#section-10.3)|The syntax of the request entity is incorrect|None|
+
+
+This operation does not require authentication
+
+
+AuthClientController
+
+## AuthClientController.count
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|where|query|object|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "count": 0
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|AuthClient model count|[loopback.Count](#schemaloopback.count)|
+
+
+To perform this operation, you must be authenticated by means of one of the following methods:
+HTTPBearer
+
+
+## AuthClientController.replaceById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|number|true|none|
+|body|body|[AuthClient](#schemaauthclient)|false|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|AuthClient PUT success|None|
+
+
+To perform this operation, you must be authenticated by means of one of the following methods:
+HTTPBearer
+
+
+## AuthClientController.updateById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|number|true|none|
+|body|body|[AuthClientPartial](#schemaauthclientpartial)|false|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|AuthClient PATCH success|None|
+
+
+To perform this operation, you must be authenticated by means of one of the following methods:
+HTTPBearer
+
+
+## AuthClientController.findById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|number|true|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "id": 0,
+ "clientId": "string",
+ "clientSecret": "string",
+ "secret": "string",
+ "redirectUrl": "string",
+ "accessTokenExpiration": 0,
+ "refreshTokenExpiration": 0,
+ "authCodeExpiration": 0
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|AuthClient model instance|[AuthClient](#schemaauthclient)|
+
+
+To perform this operation, you must be authenticated by means of one of the following methods:
+HTTPBearer
+
+
+## AuthClientController.deleteById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|number|true|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|AuthClient DELETE success|None|
+
+
+To perform this operation, you must be authenticated by means of one of the following methods:
+HTTPBearer
+
+
+## AuthClientController.create
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|body|body|[AuthClientExcluding_id_](#schemaauthclientexcluding_id_)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "id": 0,
+ "clientId": "string",
+ "clientSecret": "string",
+ "secret": "string",
+ "redirectUrl": "string",
+ "accessTokenExpiration": 0,
+ "refreshTokenExpiration": 0,
+ "authCodeExpiration": 0
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|AuthClient model instance|[AuthClient](#schemaauthclient)|
+
+
+To perform this operation, you must be authenticated by means of one of the following methods:
+HTTPBearer
+
+
+## AuthClientController.updateAll
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|where|query|object|false|none|
+|body|body|[AuthClientPartial](#schemaauthclientpartial)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "count": 0
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|AuthClient PATCH success count|[loopback.Count](#schemaloopback.count)|
+
+
+To perform this operation, you must be authenticated by means of one of the following methods:
+HTTPBearer
+
+
+## AuthClientController.find
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|filter|query|[auth_clients.Filter](#schemaauth_clients.filter)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+[
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "id": 0,
+ "clientId": "string",
+ "clientSecret": "string",
+ "secret": "string",
+ "redirectUrl": "string",
+ "accessTokenExpiration": 0,
+ "refreshTokenExpiration": 0,
+ "authCodeExpiration": 0
+ }
+]
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Array of AuthClient model instances|Inline|
+
+Response Schema
+
+Status Code **200**
+
+|Name|Type|Required|Restrictions|Description|
+|---|---|---|---|---|
+|*anonymous*|[[AuthClient](#schemaauthclient)]|false|none|none|
+|» AuthClient|[AuthClient](#schemaauthclient)|false|none|none|
+|»» deleted|boolean|false|none|none|
+|»» deletedOn|string(date-time)¦null|false|none|none|
+|»» deletedBy|string¦null|false|none|none|
+|»» createdOn|string(date-time)|false|none|none|
+|»» modifiedOn|string(date-time)|false|none|none|
+|»» id|number|false|none|none|
+|»» clientId|string|true|none|none|
+|»» clientSecret|string|true|none|none|
+|»» secret|string|true|none|none|
+|»» redirectUrl|string|false|none|none|
+|»» accessTokenExpiration|number|true|none|none|
+|»» refreshTokenExpiration|number|true|none|none|
+|»» authCodeExpiration|number|true|none|none|
+
+
+To perform this operation, you must be authenticated by means of one of the following methods:
+HTTPBearer
+
+
+LogoutController
+
+## LogoutController.keycloakLogout
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|Authorization|header|string|false|This is the access token which is required to authenticate user.|
+|body|body|[RefreshTokenRequestPartial](#schemarefreshtokenrequestpartial)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "success": true
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Success Response|[SuccessResponse](#schemasuccessresponse)|
+|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|The syntax of the request entity is incorrect.|None|
+|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Invalid Credentials.|None|
+|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|The entity requested does not exist.|None|
+|422|[Unprocessable Entity](https://tools.ietf.org/html/rfc2518#section-10.3)|The syntax of the request entity is incorrect|None|
+
+
+To perform this operation, you must be authenticated by means of one of the following methods:
+HTTPBearer
+
+
+## LogoutController.logout
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|Authorization|header|string|false|This is the access token which is required to authenticate user.|
+|body|body|[RefreshTokenRequestPartial](#schemarefreshtokenrequestpartial)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "success": true
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Success Response|[SuccessResponse](#schemasuccessresponse)|
+|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|The syntax of the request entity is incorrect.|None|
+|401|[Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)|Invalid Credentials.|None|
+|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|The entity requested does not exist.|None|
+|422|[Unprocessable Entity](https://tools.ietf.org/html/rfc2518#section-10.3)|The syntax of the request entity is incorrect|None|
+
+
+To perform this operation, you must be authenticated by means of one of the following methods:
+HTTPBearer
+
+
+OtpController
+
+## OtpController.findById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "otp": "string",
+ "username": "string"
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Otp model instance|[Otp](#schemaotp)|
+
+
+This operation does not require authentication
+
+
+## OtpController.deleteById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|Otp DELETE success|None|
+
+
+This operation does not require authentication
+
+
+## OtpController.create
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|body|body|[Otp](#schemaotp)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "otp": "string",
+ "username": "string"
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Otp model instance|[Otp](#schemaotp)|
+
+
+This operation does not require authentication
+
+
+# Schemas
+
+LoginRequest
+
+TokenResponse
+
+AuthTokenRequest
+
+Function
+
+AuthRefreshTokenRequest
+
+ClientAuthRequest
+
+ResetPasswordPartial
+
+ResetPassword
+
+SuccessResponse
+
+RefreshTokenRequestPartial
+
+RefreshTokenRequest
+
+Otp
+
+AuthClient
+
+AuthClientExcluding_id_
+
+AuthClientPartial
+
+User
+
+ForgetPasswordResponseDto
+
+ForgetPasswordDto
+
+ResetPasswordWithClient
+
+SignupRequestResponseDto
+
+SignupRequestDto
+
+LocalUserProfileDto
+
+SignupRequest
+
+loopback.Count
+
+auth_clients.Filter
+
+ {
const refreshPayload: RefreshToken = await this.refreshTokenRepo.get(
req.refreshToken,
@@ -326,6 +327,10 @@ export class LoginController {
if (!authClient) {
throw new HttpErrors.Unauthorized(AuthErrorKeys.ClientInvalid);
}
+ const accessToken = token?.split(' ')[1];
+ if (!accessToken || refreshPayload.accessToken !== accessToken) {
+ throw new HttpErrors.Unauthorized(AuthErrorKeys.TokenInvalid);
+ }
await this.revokedTokensRepo.set(refreshPayload.accessToken, {
token: refreshPayload.accessToken,
});
diff --git a/services/authentication-service/src/openapi-spec.ts b/services/authentication-service/src/openapi-spec.ts
new file mode 100644
index 0000000000..4b39fd4f8a
--- /dev/null
+++ b/services/authentication-service/src/openapi-spec.ts
@@ -0,0 +1,25 @@
+import {ApplicationConfig} from '@loopback/core';
+import {AuthenticationServiceApplication} from './application';
+
+/**
+ * Export the OpenAPI spec from the application
+ */
+const PORT = 3000;
+const FILEARGVI = 2;
+async function exportOpenApiSpec(): Promise {
+ const config: ApplicationConfig = {
+ rest: {
+ port: +(process.env.PORT ?? PORT),
+ host: process.env.HOST ?? 'localhost',
+ },
+ };
+ const outFile = process.argv[FILEARGVI] ?? 'openapi.json';
+ const app = new AuthenticationServiceApplication(config);
+ await app.boot();
+ await app.exportOpenApiSpec(outFile);
+}
+
+exportOpenApiSpec().catch(err => {
+ console.error('Fail to export OpenAPI spec from the application.', err); //NOSONAR
+ process.exit(1);
+});
diff --git a/services/bpmn-service/README.md b/services/bpmn-service/README.md
index 1b3c4e95c9..524c190dcd 100644
--- a/services/bpmn-service/README.md
+++ b/services/bpmn-service/README.md
@@ -227,3 +227,7 @@ Endpoint to delete a workflow, uses the `delete` method from the provider.
`GET /workflow`
Endpoint to get all the workflows.
+
+## API's Details
+
+Visit the [OpenAPI spec docs](./openapi.md)
diff --git a/services/bpmn-service/migration.js b/services/bpmn-service/migration.js
index cdd04537d9..f0ab979432 100644
--- a/services/bpmn-service/migration.js
+++ b/services/bpmn-service/migration.js
@@ -1,6 +1,5 @@
const dotenvExt = require('dotenv-extended');
const fs = require('fs');
-const DBMigrate = require('db-migrate');
const path = require('path');
let isLocal = false;
dotenvExt.load({
@@ -27,6 +26,7 @@ if (isLocal) {
`${type}_MIGRATION or SOURCELOOP_MIGRATION variables not found in the environment, skipping automigration.`,
);
} else {
+ const DBMigrate = require('db-migrate');
dotenvExt.load({
schema: path.join('.', 'migrations', '.env.schema'),
path: path.join(process.env.INIT_CWD, '.env'),
diff --git a/services/bpmn-service/openapi.json b/services/bpmn-service/openapi.json
new file mode 100644
index 0000000000..4aed586a88
--- /dev/null
+++ b/services/bpmn-service/openapi.json
@@ -0,0 +1,571 @@
+{
+ "openapi": "3.0.0",
+ "info": {
+ "title": "Bpmn Service",
+ "version": "1.0.0",
+ "description": "services",
+ "contact": {
+ "name": "Sourcefuse"
+ }
+ },
+ "paths": {
+ "/workflow/{id}/execute": {
+ "post": {
+ "x-controller-name": "WorkflowController",
+ "x-operation-name": "startWorkflow",
+ "tags": [
+ "WorkflowController"
+ ],
+ "security": [
+ {
+ "bearerAuth": []
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Workflow instance"
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ },
+ "required": true
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ExecuteWorkflowDto"
+ }
+ }
+ },
+ "x-parameter-index": 1
+ },
+ "operationId": "WorkflowController.startWorkflow"
+ }
+ },
+ "/workflow/{id}": {
+ "patch": {
+ "x-controller-name": "WorkflowController",
+ "x-operation-name": "updateById",
+ "tags": [
+ "WorkflowController"
+ ],
+ "security": [
+ {
+ "bearerAuth": []
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Workflow PATCH success"
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ },
+ "required": true
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/WorkflowDtoPartial"
+ }
+ }
+ }
+ },
+ "operationId": "WorkflowController.updateById"
+ },
+ "get": {
+ "x-controller-name": "WorkflowController",
+ "x-operation-name": "count",
+ "tags": [
+ "WorkflowController"
+ ],
+ "responses": {
+ "200": {
+ "description": "Workflow Model"
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ },
+ "required": true
+ }
+ ],
+ "operationId": "WorkflowController.count"
+ },
+ "delete": {
+ "x-controller-name": "WorkflowController",
+ "x-operation-name": "deleteById",
+ "tags": [
+ "WorkflowController"
+ ],
+ "security": [
+ {
+ "bearerAuth": []
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Workflow DELETE success"
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ },
+ "required": true
+ }
+ ],
+ "operationId": "WorkflowController.deleteById"
+ }
+ },
+ "/workflow": {
+ "post": {
+ "x-controller-name": "WorkflowController",
+ "x-operation-name": "create",
+ "tags": [
+ "WorkflowController"
+ ],
+ "security": [
+ {
+ "bearerAuth": []
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Workflow model instance",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Workflow"
+ }
+ }
+ }
+ }
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NewWorkflow"
+ }
+ }
+ }
+ },
+ "operationId": "WorkflowController.create"
+ },
+ "get": {
+ "x-controller-name": "WorkflowController",
+ "x-operation-name": "find",
+ "tags": [
+ "WorkflowController"
+ ],
+ "responses": {
+ "200": {
+ "description": "Array of Workflow model instances",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Workflow"
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "filter",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/workflows.Filter"
+ }
+ }
+ }
+ }
+ ],
+ "operationId": "WorkflowController.find"
+ }
+ }
+ },
+ "components": {
+ "securitySchemes": {
+ "HTTPBearer": {
+ "type": "http",
+ "scheme": "bearer",
+ "bearerFormat": "JWT"
+ }
+ },
+ "schemas": {
+ "Workflow": {
+ "title": "Workflow",
+ "type": "object",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "deletedOn": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "deletedBy": {
+ "type": "string",
+ "nullable": true
+ },
+ "createdOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "modifiedOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "createdBy": {
+ "type": "string"
+ },
+ "modifiedBy": {
+ "type": "string"
+ },
+ "id": {
+ "type": "string"
+ },
+ "workflowVersion": {
+ "type": "number"
+ },
+ "externalIdentifier": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "provider": {
+ "type": "string"
+ },
+ "inputSchema": {
+ "type": "object"
+ },
+ "description": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "workflowVersion",
+ "externalIdentifier",
+ "provider",
+ "inputSchema"
+ ],
+ "additionalProperties": false
+ },
+ "NewWorkflow": {
+ "title": "NewWorkflow",
+ "type": "object",
+ "description": "(tsType: WorkflowDto, schemaOptions: { title: 'NewWorkflow' })",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "bpmnFile": {
+ "type": "string"
+ },
+ "inputSchema": {
+ "type": "object"
+ }
+ },
+ "required": [
+ "name",
+ "bpmnFile",
+ "inputSchema"
+ ],
+ "additionalProperties": true,
+ "x-typescript-type": "WorkflowDto"
+ },
+ "WorkflowDto": {
+ "title": "WorkflowDto",
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "bpmnFile": {
+ "type": "string"
+ },
+ "inputSchema": {
+ "type": "object"
+ }
+ },
+ "required": [
+ "name",
+ "bpmnFile",
+ "inputSchema"
+ ],
+ "additionalProperties": true
+ },
+ "WorkflowDtoPartial": {
+ "title": "WorkflowDtoPartial",
+ "type": "object",
+ "description": "(tsType: Partial, schemaOptions: { partial: true })",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "bpmnFile": {
+ "type": "string"
+ },
+ "inputSchema": {
+ "type": "object"
+ }
+ },
+ "additionalProperties": true,
+ "x-typescript-type": "Partial"
+ },
+ "ExecuteWorkflowDto": {
+ "title": "ExecuteWorkflowDto",
+ "type": "object",
+ "properties": {
+ "workflowVersion": {
+ "type": "number"
+ },
+ "input": {
+ "type": "object"
+ }
+ },
+ "required": [
+ "input"
+ ],
+ "additionalProperties": false
+ },
+ "workflows.ScopeFilter": {
+ "properties": {
+ "offset": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "limit": {
+ "type": "integer",
+ "minimum": 1,
+ "example": 100
+ },
+ "skip": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "order": {
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "where": {
+ "type": "object",
+ "additionalProperties": true
+ },
+ "fields": {
+ "oneOf": [
+ {
+ "type": "object",
+ "properties": {},
+ "additionalProperties": true
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "uniqueItems": true
+ }
+ ]
+ },
+ "include": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {},
+ "additionalProperties": true
+ }
+ }
+ },
+ "additionalProperties": false,
+ "title": "workflows.ScopeFilter"
+ },
+ "workflows.IncludeFilter.Items": {
+ "title": "workflows.IncludeFilter.Items",
+ "type": "object",
+ "properties": {
+ "relation": {
+ "type": "string"
+ },
+ "scope": {
+ "$ref": "#/components/schemas/workflows.ScopeFilter"
+ }
+ }
+ },
+ "workflows.Filter": {
+ "type": "object",
+ "title": "workflows.Filter",
+ "properties": {
+ "offset": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "limit": {
+ "type": "integer",
+ "minimum": 1,
+ "example": 100
+ },
+ "skip": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "order": {
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "where": {
+ "title": "workflows.WhereFilter",
+ "type": "object",
+ "additionalProperties": true
+ },
+ "fields": {
+ "oneOf": [
+ {
+ "type": "object",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "deletedOn": {
+ "type": "boolean"
+ },
+ "deletedBy": {
+ "type": "boolean"
+ },
+ "createdOn": {
+ "type": "boolean"
+ },
+ "modifiedOn": {
+ "type": "boolean"
+ },
+ "createdBy": {
+ "type": "boolean"
+ },
+ "modifiedBy": {
+ "type": "boolean"
+ },
+ "id": {
+ "type": "boolean"
+ },
+ "workflowVersion": {
+ "type": "boolean"
+ },
+ "externalIdentifier": {
+ "type": "boolean"
+ },
+ "name": {
+ "type": "boolean"
+ },
+ "provider": {
+ "type": "boolean"
+ },
+ "inputSchema": {
+ "type": "boolean"
+ },
+ "description": {
+ "type": "boolean"
+ }
+ },
+ "additionalProperties": false
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": [
+ "deleted",
+ "deletedOn",
+ "deletedBy",
+ "createdOn",
+ "modifiedOn",
+ "createdBy",
+ "modifiedBy",
+ "id",
+ "workflowVersion",
+ "externalIdentifier",
+ "name",
+ "provider",
+ "inputSchema",
+ "description"
+ ],
+ "example": "deleted"
+ },
+ "uniqueItems": true
+ }
+ ],
+ "title": "workflows.Fields"
+ },
+ "include": {
+ "title": "workflows.IncludeFilter",
+ "type": "array",
+ "items": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/workflows.IncludeFilter.Items"
+ },
+ {
+ "type": "string"
+ }
+ ]
+ }
+ }
+ },
+ "additionalProperties": false,
+ "x-typescript-type": "@loopback/repository#Filter"
+ }
+ }
+ },
+ "servers": [
+ {
+ "url": "/"
+ }
+ ]
+}
\ No newline at end of file
diff --git a/services/bpmn-service/openapi.md b/services/bpmn-service/openapi.md
new file mode 100644
index 0000000000..eb59999881
--- /dev/null
+++ b/services/bpmn-service/openapi.md
@@ -0,0 +1,792 @@
+---
+title: Bpmn Service v1.0.0
+language_tabs:
+ - "'javascript": JavaScript
+ - "'javascript--nodejs": Node.JS'
+language_clients:
+ - "'javascript": request'
+ - "'javascript--nodejs": ""
+toc_footers: []
+includes: []
+search: false
+highlight_theme: darkula
+headingLevel: 2
+
+---
+
+
+
+Bpmn Service v1.0.0
+
+> Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
+
+services
+
+Base URLs:
+
+* /
+
+# Authentication
+
+- HTTP Authentication, scheme: bearer
+
+WorkflowController
+
+## WorkflowController.startWorkflow
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|body|body|[ExecuteWorkflowDto](#schemaexecuteworkflowdto)|false|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Workflow instance|None|
+
+
+To perform this operation, you must be authenticated by means of one of the following methods:
+None
+
+
+## WorkflowController.updateById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|body|body|[WorkflowDtoPartial](#schemaworkflowdtopartial)|false|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|Workflow PATCH success|None|
+
+
+To perform this operation, you must be authenticated by means of one of the following methods:
+None
+
+
+## WorkflowController.count
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Workflow Model|None|
+
+
+This operation does not require authentication
+
+
+## WorkflowController.deleteById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|Workflow DELETE success|None|
+
+
+To perform this operation, you must be authenticated by means of one of the following methods:
+None
+
+
+## WorkflowController.create
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|body|body|[NewWorkflow](#schemanewworkflow)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "workflowVersion": 0,
+ "externalIdentifier": "string",
+ "name": "string",
+ "provider": "string",
+ "inputSchema": {},
+ "description": "string"
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Workflow model instance|[Workflow](#schemaworkflow)|
+
+
+To perform this operation, you must be authenticated by means of one of the following methods:
+None
+
+
+## WorkflowController.find
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|filter|query|[workflows.Filter](#schemaworkflows.filter)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+[
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "workflowVersion": 0,
+ "externalIdentifier": "string",
+ "name": "string",
+ "provider": "string",
+ "inputSchema": {},
+ "description": "string"
+ }
+]
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Array of Workflow model instances|Inline|
+
+Response Schema
+
+Status Code **200**
+
+|Name|Type|Required|Restrictions|Description|
+|---|---|---|---|---|
+|*anonymous*|[[Workflow](#schemaworkflow)]|false|none|none|
+|» Workflow|[Workflow](#schemaworkflow)|false|none|none|
+|»» deleted|boolean|false|none|none|
+|»» deletedOn|string(date-time)¦null|false|none|none|
+|»» deletedBy|string¦null|false|none|none|
+|»» createdOn|string(date-time)|false|none|none|
+|»» modifiedOn|string(date-time)|false|none|none|
+|»» createdBy|string|false|none|none|
+|»» modifiedBy|string|false|none|none|
+|»» id|string|false|none|none|
+|»» workflowVersion|number|true|none|none|
+|»» externalIdentifier|string|true|none|none|
+|»» name|string|false|none|none|
+|»» provider|string|true|none|none|
+|»» inputSchema|object|true|none|none|
+|»» description|string|false|none|none|
+
+
+This operation does not require authentication
+
+
+# Schemas
+
+Workflow
+
+NewWorkflow
+
+WorkflowDto
+
+WorkflowDtoPartial
+
+ExecuteWorkflowDto
+
+workflows.ScopeFilter
+
+workflows.IncludeFilter.Items
+
+workflows.Filter
+
+ {
+ const config: ApplicationConfig = {
+ rest: {
+ port: +(process.env.PORT ?? PORT),
+ host: process.env.HOST ?? 'localhost',
+ },
+ };
+ const outFile = process.argv[FILEARGVI] ?? 'openapi.json';
+ const app = new WorkflowServiceApplication(config);
+ await app.boot();
+ await app.exportOpenApiSpec(outFile);
+}
+
+exportOpenApiSpec().catch(err => {
+ console.error('Fail to export OpenAPI spec from the application.', err); //NOSONAR
+ process.exit(1);
+});
diff --git a/services/in-mail-service/README.md b/services/in-mail-service/README.md
index 08fac46ab3..1cc059eb0c 100644
--- a/services/in-mail-service/README.md
+++ b/services/in-mail-service/README.md
@@ -15,12 +15,6 @@ any client application.
## Implementation
-### Migration
-
-The migrations required for this service are processed during the installation automatically if you set the `INMAIL_MIGRATION` or `SOURCELOOP_MIGRATION` env variable. The migrations use [`db-migrate`](https://www.npmjs.com/package/db-migrate) with [`db-migrate-pg`](https://www.npmjs.com/package/db-migrate-pg) driver for migrations, so you will have to install these packages to use auto-migration. Please note that if you are using some pre-existing migrations or database, they may be effected. In such scenario, it is advised that you copy the migration files in your project root, using the `INMAIL_MIGRATION_COPY` or `SOURCELOOP_MIGRATION_COPY` env variables. You can customize or cherry-pick the migrations in the copied files according to your specific requirements and then apply them to the DB.
-
-### Implementation
-
Create a new Application using Loopback CLI and add the Component for `InMailService` in `application.ts`
```typescript
@@ -79,6 +73,15 @@ export class Client extends BootMixin(
}
}
```
+
+### Migration
+
+The migrations required for this service are processed during the installation automatically if you set the `INMAIL_MIGRATION` or `SOURCELOOP_MIGRATION` env variable. The migrations use [`db-migrate`](https://www.npmjs.com/package/db-migrate) with [`db-migrate-pg`](https://www.npmjs.com/package/db-migrate-pg) driver for migrations, so you will have to install these packages to use auto-migration. Please note that if you are using some pre-existing migrations or database, they may be effected. In such scenario, it is advised that you copy the migration files in your project root, using the `INMAIL_MIGRATION_COPY` or `SOURCELOOP_MIGRATION_COPY` env variables. You can customize or cherry-pick the migrations in the copied files according to your specific requirements and then apply them to the DB.
+
+#### Database Model
+
+
+
### Setting Environment Variables
Do not forget to set Environment variables. The examples below show a common configuration for a PostgreSQL Database running locally.
@@ -432,3 +435,7 @@ threadFilter: Object which contains attribute(s) key value pairs of thread model
groupFilter: Object which contains attribute(s) key value pairs of group model which is used to filter items.
threadFilter: Object which contains attribute(s) key value pairs of thread model which is used to filter items.
+
+## API's Details
+
+Visit the [OpenAPI spec docs](./openapi.md)
\ No newline at end of file
diff --git a/services/in-mail-service/migration.js b/services/in-mail-service/migration.js
index da5bf1ecf7..f2e129bee6 100644
--- a/services/in-mail-service/migration.js
+++ b/services/in-mail-service/migration.js
@@ -1,6 +1,5 @@
const dotenvExt = require('dotenv-extended');
const fs = require('fs');
-const DBMigrate = require('db-migrate');
const path = require('path');
let isLocal = false;
dotenvExt.load({
@@ -27,6 +26,7 @@ if (isLocal) {
`${type}_MIGRATION or SOURCELOOP_MIGRATION variables not found in the environment, skipping automigration.`,
);
} else {
+ const DBMigrate = require('db-migrate');
dotenvExt.load({
schema: path.join('.', 'migrations', '.env.schema'),
path: path.join(process.env.INIT_CWD, '.env'),
diff --git a/services/in-mail-service/migrations/in_mail_db.png b/services/in-mail-service/migrations/in_mail_db.png
new file mode 100644
index 0000000000..9905528e65
Binary files /dev/null and b/services/in-mail-service/migrations/in_mail_db.png differ
diff --git a/services/in-mail-service/openapi.json b/services/in-mail-service/openapi.json
new file mode 100644
index 0000000000..f3a22431d6
--- /dev/null
+++ b/services/in-mail-service/openapi.json
@@ -0,0 +1,1914 @@
+{
+ "openapi": "3.0.0",
+ "info": {
+ "title": "In-mail Service",
+ "version": "1.0.0",
+ "description": "services",
+ "contact": {
+ "name": "Sourcefuse"
+ }
+ },
+ "paths": {
+ "/mails/bulk/restore": {
+ "patch": {
+ "x-controller-name": "OriginatorController",
+ "x-operation-name": "restore",
+ "tags": [
+ "OriginatorController"
+ ],
+ "summary": "API provides an interface for restore message from trash.",
+ "responses": {
+ "200": {
+ "description": "Restore Message Successful!"
+ },
+ "400": {
+ "description": "Message identity does not exist."
+ },
+ "403": {
+ "description": "Forbidden request due to unauthorized token in header."
+ }
+ },
+ "parameters": [
+ {
+ "name": "filter",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": true
+ }
+ }
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/IdArraysPartial"
+ }
+ }
+ },
+ "x-parameter-index": 1
+ },
+ "operationId": "OriginatorController.restore"
+ }
+ },
+ "/mails/bulk/{storage}/{action}": {
+ "delete": {
+ "x-controller-name": "OriginatorController",
+ "x-operation-name": "trashBulk",
+ "tags": [
+ "OriginatorController"
+ ],
+ "summary": "API for moving mails to trash and then delete",
+ "responses": {
+ "200": {
+ "description": "Trash/Deletion of Mail(s) sucessful!"
+ },
+ "403": {
+ "description": "Forbidden request due to unauthorized token in header."
+ },
+ "404": {
+ "description": "Message identity does not exist."
+ }
+ },
+ "parameters": [
+ {
+ "name": "storage",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ },
+ "required": true
+ },
+ {
+ "name": "action",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ },
+ "required": true
+ },
+ {
+ "name": "filter",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": true
+ }
+ }
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/IdArraysPartial"
+ }
+ }
+ },
+ "x-parameter-index": 3
+ },
+ "operationId": "OriginatorController.trashBulk"
+ }
+ },
+ "/mails/marking/{markType}": {
+ "patch": {
+ "x-controller-name": "OriginatorController",
+ "x-operation-name": "markMail",
+ "tags": [
+ "OriginatorController"
+ ],
+ "summary": "API provides interface to mark read, unread and important",
+ "responses": {
+ "200": {
+ "description": "Message is marked read/unread/important"
+ }
+ },
+ "parameters": [
+ {
+ "name": "markType",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ },
+ "required": true
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/IdArraysPartial"
+ }
+ }
+ },
+ "x-parameter-index": 1
+ },
+ "operationId": "OriginatorController.markMail"
+ }
+ },
+ "/mails/{messageId}/attachments/{attachmentId}": {
+ "delete": {
+ "x-controller-name": "OriginatorController",
+ "x-operation-name": "removeAttachment",
+ "tags": [
+ "OriginatorController"
+ ],
+ "summary": "API provides an interface for removing attachment before message is sent",
+ "responses": {
+ "200": {
+ "description": "Deletetion of Attachment Successful!"
+ },
+ "403": {
+ "description": "Forbidden request due to unauthorized token in header."
+ },
+ "404": {
+ "description": "Message identity does not exist."
+ }
+ },
+ "parameters": [
+ {
+ "name": "messageId",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ },
+ "required": true
+ },
+ {
+ "name": "attachmentId",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ },
+ "required": true
+ },
+ {
+ "name": "filter",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": true
+ }
+ }
+ }
+ }
+ ],
+ "operationId": "OriginatorController.removeAttachment"
+ }
+ },
+ "/mails/{messageId}/attachments": {
+ "post": {
+ "x-controller-name": "OriginatorController",
+ "x-operation-name": "addAttachment",
+ "tags": [
+ "OriginatorController"
+ ],
+ "summary": "API provides an interface for adding attachment before message is sent.",
+ "responses": {
+ "200": {
+ "description": "collect single attachment for user by message identifier",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Attachment add response schema"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Message identity does not exist."
+ },
+ "403": {
+ "description": "Forbidden request due to unauthorized token in header."
+ }
+ },
+ "parameters": [
+ {
+ "name": "messageId",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ },
+ "required": true
+ },
+ {
+ "name": "filter",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": true
+ }
+ }
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "attachments": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/AttachmentPartial"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "operationId": "OriginatorController.addAttachment"
+ }
+ },
+ "/mails/{messageId}/send": {
+ "patch": {
+ "x-controller-name": "OriginatorController",
+ "x-operation-name": "sendDraft",
+ "tags": [
+ "OriginatorController"
+ ],
+ "summary": "API for sending a drafted message.",
+ "responses": {
+ "200": {
+ "description": "Mail is Successfully sent!"
+ },
+ "400": {
+ "description": "Message identity does not exist."
+ },
+ "403": {
+ "description": "Forbidden request due to unauthorized token in header."
+ }
+ },
+ "parameters": [
+ {
+ "name": "messageId",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ },
+ "required": true
+ },
+ {
+ "name": "filter",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": true
+ }
+ }
+ }
+ }
+ ],
+ "operationId": "OriginatorController.sendDraft"
+ }
+ },
+ "/mails/{messageId}": {
+ "put": {
+ "x-controller-name": "OriginatorController",
+ "x-operation-name": "updateDraft",
+ "tags": [
+ "OriginatorController"
+ ],
+ "summary": "Update API. Update draft messages.",
+ "responses": {
+ "400": {
+ "description": "Message identity does not exist."
+ },
+ "403": {
+ "description": "Forbidden request due to unauthorized token in header."
+ },
+ "application/json": {
+ "description": "collect single message for user by message identifier",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/idResponse"
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "messageId",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ },
+ "required": true
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/composeMailBody"
+ }
+ }
+ }
+ },
+ "operationId": "OriginatorController.updateDraft"
+ },
+ "get": {
+ "x-controller-name": "CollectorController",
+ "x-operation-name": "fetchById",
+ "tags": [
+ "CollectorController"
+ ],
+ "summary": "GET Message API. Collect a single message based on message identity.",
+ "responses": {
+ "200": {
+ "description": "Gets mail details based on unique message id",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "item": {
+ "type": "string",
+ "item": {
+ "$ref": "#/components/schemas/MessageExcluding_deleted_WithRelations",
+ "definitions": {
+ "AttachmentExcluding_deleted_WithRelations": {
+ "$ref": "#/components/schemas/AttachmentExcluding_deleted_WithRelations"
+ },
+ "ThreadExcluding_deleted_WithRelations": {
+ "$ref": "#/components/schemas/ThreadExcluding_deleted_WithRelations"
+ },
+ "GroupExcluding_deleted_WithRelations": {
+ "$ref": "#/components/schemas/GroupExcluding_deleted_WithRelations"
+ },
+ "MetaExcluding_deleted_WithRelations": {
+ "$ref": "#/components/schemas/MetaExcluding_deleted_WithRelations"
+ },
+ "MessageExcluding_deleted_WithRelations": {
+ "$ref": "#/components/schemas/MessageExcluding_deleted_WithRelations"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden request due to unauthrized token in header."
+ },
+ "404": {
+ "description": "Message identity does not exist"
+ }
+ },
+ "parameters": [
+ {
+ "name": "messageId",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ },
+ "required": true
+ },
+ {
+ "name": "filter",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": true
+ }
+ }
+ }
+ }
+ ],
+ "operationId": "CollectorController.fetchById"
+ }
+ },
+ "/mails": {
+ "post": {
+ "x-controller-name": "OriginatorController",
+ "x-operation-name": "composeMail",
+ "tags": [
+ "OriginatorController"
+ ],
+ "summary": "ComposeAPI. For drafting, reply on and create new message",
+ "responses": {
+ "201": {
+ "description": "collect single message for user by message identifier",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/idResponse"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden request due to unauthorized token in header."
+ },
+ "404": {
+ "description": "Message identity does not exist."
+ }
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/composeMailBody"
+ }
+ }
+ }
+ },
+ "operationId": "OriginatorController.composeMail"
+ },
+ "get": {
+ "x-controller-name": "CollectorController",
+ "x-operation-name": "fetchMailList",
+ "tags": [
+ "CollectorController"
+ ],
+ "summary": "Collect a list of all messages.",
+ "responses": {
+ "200": {
+ "description": "fetch mails",
+ "content": {
+ "application/json": {
+ "type": "object",
+ "properties": {
+ "version": {
+ "type": "string"
+ },
+ "items": {
+ "type": "array",
+ "schema": {
+ "$ref": "#/components/schemas/Message",
+ "definitions": {
+ "Message": {
+ "$ref": "#/components/schemas/Message"
+ }
+ }
+ }
+ }
+ },
+ "nullable": true
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden request due to unauthrized token in header."
+ }
+ },
+ "parameters": [
+ {
+ "name": "messageFilter",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": true
+ }
+ }
+ }
+ },
+ {
+ "name": "groupFilter",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": true
+ }
+ }
+ }
+ }
+ ],
+ "operationId": "CollectorController.fetchMailList"
+ }
+ },
+ "/threads/{threadId}/forward": {
+ "patch": {
+ "x-controller-name": "ReplyAndForwardController",
+ "x-operation-name": "forward",
+ "tags": [
+ "ReplyAndForwardController"
+ ],
+ "summary": "API provides interface to forward single message.",
+ "responses": {
+ "204": {
+ "description": "Message is forwarded to another recipient",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/idResponse"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Message identity does not exist."
+ },
+ "403": {
+ "description": "Forbidden request due to unauthorized token in header."
+ }
+ },
+ "parameters": [
+ {
+ "name": "threadId",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ },
+ "required": true
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "groups": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GroupPartial"
+ }
+ },
+ "subject": {
+ "type": "string"
+ },
+ "body": {
+ "type": "string"
+ },
+ "attachments": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/AttachmentPartial"
+ }
+ },
+ "meta": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/MetaPartial"
+ }
+ },
+ "status": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "groups"
+ ]
+ }
+ }
+ }
+ },
+ "operationId": "ReplyAndForwardController.forward"
+ }
+ },
+ "/threads/{threadId}/mails/{messageId}/replies": {
+ "patch": {
+ "x-controller-name": "ReplyAndForwardController",
+ "x-operation-name": "replyMail",
+ "tags": [
+ "ReplyAndForwardController"
+ ],
+ "summary": "API provides interface to reply to a single message",
+ "responses": {
+ "200": {
+ "description": "Message is replied back to the sender"
+ }
+ },
+ "parameters": [
+ {
+ "name": "threadId",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ },
+ "required": true
+ },
+ {
+ "name": "messageId",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ },
+ "required": true
+ },
+ {
+ "name": "replyAll",
+ "in": "query",
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "attachments": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/AttachmentPartial"
+ }
+ },
+ "meta": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/MetaPartial"
+ }
+ },
+ "body": {
+ "type": "string"
+ },
+ "subject": {
+ "type": "string"
+ },
+ "status": {
+ "type": "string"
+ },
+ "extId": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "body",
+ "group",
+ "status"
+ ]
+ }
+ }
+ },
+ "x-parameter-index": 3
+ },
+ "operationId": "ReplyAndForwardController.replyMail"
+ }
+ },
+ "/threads/{threadId}": {
+ "get": {
+ "x-controller-name": "CollectorController",
+ "x-operation-name": "fetchThreadById",
+ "tags": [
+ "CollectorController"
+ ],
+ "summary": "GET Thread Message API. Collect complete single message thread based on thread identity.",
+ "responses": {
+ "200": {
+ "description": "Fetches a thread along with message, group, attachment(s) etc based on unique thread Id",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "item": {
+ "$ref": "#/components/schemas/Thread",
+ "definitions": {
+ "Thread": {
+ "$ref": "#/components/schemas/Thread"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Message identity does not exist"
+ },
+ "403": {
+ "description": "Forbidden request due to unauthorized token in header."
+ }
+ },
+ "parameters": [
+ {
+ "name": "threadId",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ },
+ "required": true
+ },
+ {
+ "name": "filter",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": true
+ }
+ }
+ }
+ }
+ ],
+ "operationId": "CollectorController.fetchThreadById"
+ }
+ },
+ "/threads": {
+ "get": {
+ "403": {
+ "description": "Forbidden request due to unauthrized token in header."
+ },
+ "x-controller-name": "CollectorController",
+ "x-operation-name": "fetchThreadList",
+ "tags": [
+ "CollectorController"
+ ],
+ "summary": "Thread List API. Collect a list of all threads.",
+ "responses": {
+ "200": {
+ "description": "fetch threads",
+ "content": {
+ "application/json": {
+ "schema": {
+ "properties": {
+ "version": {
+ "type": "string"
+ },
+ "items": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Thread",
+ "definitions": {
+ "Thread": {
+ "$ref": "#/components/schemas/Thread"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "threadFilter",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": true
+ }
+ }
+ }
+ },
+ {
+ "name": "groupFilter",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": true
+ }
+ }
+ }
+ }
+ ],
+ "operationId": "CollectorController.fetchThreadList"
+ }
+ }
+ },
+ "components": {
+ "securitySchemes": {
+ "HTTPBearer": {
+ "type": "http",
+ "scheme": "bearer",
+ "bearerFormat": "JWT"
+ }
+ },
+ "schemas": {
+ "idResponse": {
+ "$ref": "#/components/schemas/IdResponse",
+ "definitions": {
+ "IdResponse": {
+ "title": "IdResponse",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string"
+ }
+ },
+ "additionalProperties": false
+ }
+ }
+ },
+ "composeMailBody": {
+ "type": "object",
+ "properties": {
+ "threadId": {
+ "type": "string"
+ },
+ "groups": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GroupPartial",
+ "definitions": {
+ "GroupPartial": {
+ "title": "GroupPartial",
+ "type": "object",
+ "description": "(tsType: Partial, schemaOptions: { partial: true })",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "deletedOn": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "deletedBy": {
+ "type": "string",
+ "nullable": true
+ },
+ "createdOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "modifiedOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "createdBy": {
+ "type": "string"
+ },
+ "modifiedBy": {
+ "type": "string"
+ },
+ "id": {
+ "type": "string"
+ },
+ "party": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "from",
+ "to",
+ "cc",
+ "bcc"
+ ]
+ },
+ "isImportant": {
+ "type": "boolean"
+ },
+ "storage": {
+ "type": "string",
+ "default": "inbox",
+ "enum": [
+ "draft",
+ "send",
+ "inbox",
+ "trash"
+ ]
+ },
+ "visibility": {
+ "type": "string",
+ "default": "new",
+ "enum": [
+ "read",
+ "new",
+ "unread",
+ "important",
+ "not-important"
+ ]
+ },
+ "extId": {
+ "type": "string"
+ },
+ "extMetadata": {
+ "type": "object"
+ },
+ "messageId": {
+ "type": "string"
+ },
+ "threadId": {
+ "type": "string"
+ }
+ },
+ "additionalProperties": false,
+ "x-typescript-type": "Partial"
+ }
+ }
+ }
+ },
+ "attachments": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/AttachmentPartial",
+ "definitions": {
+ "AttachmentPartial": {
+ "title": "AttachmentPartial",
+ "type": "object",
+ "description": "(tsType: Partial, schemaOptions: { partial: true })",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "deletedOn": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "deletedBy": {
+ "type": "string",
+ "nullable": true
+ },
+ "createdOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "modifiedOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "createdBy": {
+ "type": "string"
+ },
+ "modifiedBy": {
+ "type": "string"
+ },
+ "id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "path": {
+ "type": "string"
+ },
+ "thumbnail": {
+ "type": "string"
+ },
+ "mime": {
+ "type": "string"
+ },
+ "extId": {
+ "type": "string"
+ },
+ "extMetadata": {
+ "type": "object"
+ },
+ "messageId": {
+ "type": "string"
+ }
+ },
+ "additionalProperties": false,
+ "x-typescript-type": "Partial"
+ }
+ }
+ }
+ },
+ "meta": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/MetaPartial",
+ "definitions": {
+ "MetaPartial": {
+ "title": "MetaPartial",
+ "type": "object",
+ "description": "(tsType: Partial, schemaOptions: { partial: true })",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "deletedOn": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "deletedBy": {
+ "type": "string",
+ "nullable": true
+ },
+ "createdOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "modifiedOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "createdBy": {
+ "type": "string"
+ },
+ "modifiedBy": {
+ "type": "string"
+ },
+ "id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "path": {
+ "type": "string"
+ },
+ "thumbnail": {
+ "type": "string"
+ },
+ "mime": {
+ "type": "string"
+ },
+ "extId": {
+ "type": "string"
+ },
+ "extMetadata": {
+ "type": "object"
+ },
+ "messageId": {
+ "type": "string"
+ }
+ },
+ "additionalProperties": false,
+ "x-typescript-type": "Partial"
+ },
+ "IdArraysPartial": {
+ "title": "IdArraysPartial",
+ "type": "object",
+ "description": "(tsType: Partial, schemaOptions: { partial: true })",
+ "properties": {
+ "messageIds": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "threadIds": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "additionalProperties": false,
+ "x-typescript-type": "Partial"
+ },
+ "IdArrays": {
+ "title": "IdArrays",
+ "type": "object",
+ "properties": {
+ "messageIds": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "threadIds": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "additionalProperties": false
+ },
+ "MetaPartial": {
+ "title": "MetaPartial",
+ "type": "object",
+ "description": "(tsType: Partial, schemaOptions: { partial: true })",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "deletedOn": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "deletedBy": {
+ "type": "string",
+ "nullable": true
+ },
+ "createdOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "modifiedOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "createdBy": {
+ "type": "string"
+ },
+ "modifiedBy": {
+ "type": "string"
+ },
+ "id": {
+ "type": "string"
+ },
+ "party": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "from",
+ "to",
+ "cc",
+ "bcc"
+ ]
+ },
+ "isImportant": {
+ "type": "boolean"
+ },
+ "storage": {
+ "type": "string",
+ "default": "inbox",
+ "enum": [
+ "draft",
+ "send",
+ "inbox",
+ "trash"
+ ]
+ },
+ "visibility": {
+ "type": "string",
+ "default": "new",
+ "enum": [
+ "read",
+ "new",
+ "unread",
+ "important",
+ "not-important"
+ ]
+ },
+ "extId": {
+ "type": "string"
+ },
+ "extMetadata": {
+ "type": "object"
+ },
+ "messageId": {
+ "type": "string"
+ },
+ "threadId": {
+ "type": "string"
+ }
+ },
+ "additionalProperties": false,
+ "x-typescript-type": "Partial"
+ },
+ "Attachment add response schema": {
+ "type": "object",
+ "title": "Attachment add response schema",
+ "properties": {
+ "items": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Attachment"
+ }
+ }
+ }
+ },
+ "AttachmentExcluding_deleted_WithRelations": {
+ "title": "AttachmentExcluding_deleted_WithRelations",
+ "type": "object",
+ "description": "(tsType: Omit, schemaOptions: { exclude: [ 'deleted' ], includeRelations: true })",
+ "properties": {
+ "deletedOn": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "deletedBy": {
+ "type": "string",
+ "nullable": true
+ },
+ "createdOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "modifiedOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "createdBy": {
+ "type": "string"
+ },
+ "modifiedBy": {
+ "type": "string"
+ },
+ "id": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "path": {
+ "type": "string"
+ },
+ "thumbnail": {
+ "type": "string"
+ },
+ "mime": {
+ "type": "string"
+ },
+ "extId": {
+ "type": "string"
+ },
+ "extMetadata": {
+ "type": "object"
+ },
+ "messageId": {
+ "type": "string"
+ },
+ "message": {
+ "$ref": "#/components/schemas/MessageExcluding_deleted_WithRelations"
+ }
+ },
+ "required": [
+ "name",
+ "path",
+ "thumbnail",
+ "mime"
+ ],
+ "additionalProperties": false,
+ "x-typescript-type": "Omit"
+ },
+ "ThreadExcluding_deleted_WithRelations": {
+ "title": "ThreadExcluding_deleted_WithRelations",
+ "type": "object",
+ "description": "(tsType: Omit, schemaOptions: { exclude: [ 'deleted' ], includeRelations: true })",
+ "properties": {
+ "deletedOn": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "deletedBy": {
+ "type": "string",
+ "nullable": true
+ },
+ "createdOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "modifiedOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "createdBy": {
+ "type": "string"
+ },
+ "modifiedBy": {
+ "type": "string"
+ },
+ "id": {
+ "type": "string"
+ },
+ "subject": {
+ "type": "string"
+ },
+ "messageCounts": {
+ "type": "number"
+ },
+ "extId": {
+ "type": "string"
+ },
+ "extMetadata": {
+ "type": "object"
+ },
+ "message": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/MessageExcluding_deleted_WithRelations"
+ }
+ },
+ "group": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GroupExcluding_deleted_WithRelations"
+ }
+ }
+ },
+ "required": [
+ "subject"
+ ],
+ "additionalProperties": false,
+ "x-typescript-type": "Omit"
+ },
+ "GroupExcluding_deleted_WithRelations": {
+ "title": "GroupExcluding_deleted_WithRelations",
+ "type": "object",
+ "description": "(tsType: Omit, schemaOptions: { exclude: [ 'deleted' ], includeRelations: true })",
+ "properties": {
+ "deletedOn": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "deletedBy": {
+ "type": "string",
+ "nullable": true
+ },
+ "createdOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "modifiedOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "createdBy": {
+ "type": "string"
+ },
+ "modifiedBy": {
+ "type": "string"
+ },
+ "id": {
+ "type": "string"
+ },
+ "party": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "from",
+ "to",
+ "cc",
+ "bcc"
+ ]
+ },
+ "isImportant": {
+ "type": "boolean"
+ },
+ "storage": {
+ "type": "string",
+ "default": "inbox",
+ "enum": [
+ "draft",
+ "send",
+ "inbox",
+ "trash"
+ ]
+ },
+ "visibility": {
+ "type": "string",
+ "default": "new",
+ "enum": [
+ "read",
+ "new",
+ "unread",
+ "important",
+ "not-important"
+ ]
+ },
+ "extId": {
+ "type": "string"
+ },
+ "extMetadata": {
+ "type": "object"
+ },
+ "messageId": {
+ "type": "string"
+ },
+ "threadId": {
+ "type": "string"
+ },
+ "message": {
+ "$ref": "#/components/schemas/MessageExcluding_deleted_WithRelations"
+ },
+ "thread": {
+ "$ref": "#/components/schemas/ThreadExcluding_deleted_WithRelations"
+ }
+ },
+ "required": [
+ "party",
+ "type"
+ ],
+ "additionalProperties": false,
+ "x-typescript-type": "Omit"
+ },
+ "MetaExcluding_deleted_WithRelations": {
+ "title": "MetaExcluding_deleted_WithRelations",
+ "type": "object",
+ "description": "(tsType: Omit, schemaOptions: { exclude: [ 'deleted' ], includeRelations: true })",
+ "properties": {
+ "deletedOn": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "deletedBy": {
+ "type": "string",
+ "nullable": true
+ },
+ "createdOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "modifiedOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "createdBy": {
+ "type": "string"
+ },
+ "modifiedBy": {
+ "type": "string"
+ },
+ "id": {
+ "type": "string"
+ },
+ "key": {
+ "type": "string"
+ },
+ "value": {
+ "type": "string"
+ },
+ "extId": {
+ "type": "string"
+ },
+ "extMetadata": {
+ "type": "object"
+ },
+ "messageId": {
+ "type": "string"
+ },
+ "message": {
+ "$ref": "#/components/schemas/MessageExcluding_deleted_WithRelations"
+ }
+ },
+ "required": [
+ "key"
+ ],
+ "additionalProperties": false,
+ "x-typescript-type": "Omit"
+ },
+ "MessageExcluding_deleted_WithRelations": {
+ "title": "MessageExcluding_deleted_WithRelations",
+ "type": "object",
+ "description": "(tsType: Omit, schemaOptions: { exclude: [ 'deleted' ], includeRelations: true })",
+ "properties": {
+ "deletedOn": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "deletedBy": {
+ "type": "string",
+ "nullable": true
+ },
+ "createdOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "modifiedOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "createdBy": {
+ "type": "string"
+ },
+ "modifiedBy": {
+ "type": "string"
+ },
+ "id": {
+ "type": "string"
+ },
+ "sender": {
+ "type": "string"
+ },
+ "subject": {
+ "type": "string"
+ },
+ "body": {
+ "type": "string"
+ },
+ "status": {
+ "type": "string",
+ "enum": [
+ "draft",
+ "send"
+ ]
+ },
+ "extId": {
+ "type": "string"
+ },
+ "extMetadata": {
+ "type": "object"
+ },
+ "threadId": {
+ "type": "string"
+ },
+ "attachment": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/AttachmentExcluding_deleted_WithRelations"
+ }
+ },
+ "group": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/GroupExcluding_deleted_WithRelations"
+ }
+ },
+ "meta": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/MetaExcluding_deleted_WithRelations"
+ }
+ },
+ "thread": {
+ "$ref": "#/components/schemas/ThreadExcluding_deleted_WithRelations"
+ }
+ },
+ "required": [
+ "sender",
+ "subject",
+ "body",
+ "status"
+ ],
+ "additionalProperties": false,
+ "x-typescript-type": "Omit"
+ },
+ "Message": {
+ "title": "Message",
+ "type": "object",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "deletedOn": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "deletedBy": {
+ "type": "string",
+ "nullable": true
+ },
+ "createdOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "modifiedOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "createdBy": {
+ "type": "string"
+ },
+ "modifiedBy": {
+ "type": "string"
+ },
+ "id": {
+ "type": "string"
+ },
+ "sender": {
+ "type": "string"
+ },
+ "subject": {
+ "type": "string"
+ },
+ "body": {
+ "type": "string"
+ },
+ "status": {
+ "type": "string",
+ "enum": [
+ "draft",
+ "send"
+ ]
+ },
+ "extId": {
+ "type": "string"
+ },
+ "extMetadata": {
+ "type": "object"
+ },
+ "threadId": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "sender",
+ "subject",
+ "body",
+ "status"
+ ],
+ "additionalProperties": false
+ },
+ "Thread": {
+ "title": "Thread",
+ "type": "object",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "deletedOn": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "deletedBy": {
+ "type": "string",
+ "nullable": true
+ },
+ "createdOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "modifiedOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "createdBy": {
+ "type": "string"
+ },
+ "modifiedBy": {
+ "type": "string"
+ },
+ "id": {
+ "type": "string"
+ },
+ "subject": {
+ "type": "string"
+ },
+ "messageCounts": {
+ "type": "number"
+ },
+ "extId": {
+ "type": "string"
+ },
+ "extMetadata": {
+ "type": "object"
+ }
+ },
+ "required": [
+ "subject"
+ ],
+ "additionalProperties": false
+ }
+ }
+ },
+ "servers": [
+ {
+ "url": "/"
+ }
+ ]
+}
\ No newline at end of file
diff --git a/services/in-mail-service/openapi.md b/services/in-mail-service/openapi.md
new file mode 100644
index 0000000000..75f62daa45
--- /dev/null
+++ b/services/in-mail-service/openapi.md
@@ -0,0 +1,3803 @@
+---
+title: In-mail Service v1.0.0
+language_tabs:
+ - "'javascript": JavaScript
+ - "'javascript--nodejs": Node.JS'
+language_clients:
+ - "'javascript": request'
+ - "'javascript--nodejs": ""
+toc_footers: []
+includes: []
+search: false
+highlight_theme: darkula
+headingLevel: 2
+
+---
+
+
+
+In-mail Service v1.0.0
+
+> Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
+
+services
+
+Base URLs:
+
+* /
+
+# Authentication
+
+- HTTP Authentication, scheme: bearer
+
+OriginatorController
+
+## API provides an interface for restore message from trash.
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|filter|query|object|false|none|
+|body|body|[IdArraysPartial](#schemaidarrayspartial)|false|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Restore Message Successful!|None|
+|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|Message identity does not exist.|None|
+|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden request due to unauthorized token in header.|None|
+
+
+This operation does not require authentication
+
+
+## API for moving mails to trash and then delete
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|storage|path|string|true|none|
+|action|path|string|true|none|
+|filter|query|object|false|none|
+|body|body|[IdArraysPartial](#schemaidarrayspartial)|false|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Trash/Deletion of Mail(s) sucessful!|None|
+|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden request due to unauthorized token in header.|None|
+|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Message identity does not exist.|None|
+
+
+This operation does not require authentication
+
+
+## API provides interface to mark read, unread and important
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|markType|path|string|true|none|
+|body|body|[IdArraysPartial](#schemaidarrayspartial)|false|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Message is marked read/unread/important|None|
+
+
+This operation does not require authentication
+
+
+## API provides an interface for removing attachment before message is sent
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|messageId|path|string|true|none|
+|attachmentId|path|string|true|none|
+|filter|query|object|false|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Deletetion of Attachment Successful!|None|
+|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden request due to unauthorized token in header.|None|
+|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Message identity does not exist.|None|
+
+
+This operation does not require authentication
+
+
+## API provides an interface for adding attachment before message is sent.
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|messageId|path|string|true|none|
+|filter|query|object|false|none|
+|body|body|object|false|none|
+|» attachments|body|[[AttachmentPartial](#schemaattachmentpartial)]|false|[(tsType: Partial, schemaOptions: { partial: true })]|
+|»» AttachmentPartial|body|[AttachmentPartial](#schemaattachmentpartial)|false|(tsType: Partial, schemaOptions: { partial: true })|
+|»»» deleted|body|boolean|false|none|
+|»»» deletedOn|body|string(date-time)¦null|false|none|
+|»»» deletedBy|body|string¦null|false|none|
+|»»» createdOn|body|string(date-time)|false|none|
+|»»» modifiedOn|body|string(date-time)|false|none|
+|»»» createdBy|body|string|false|none|
+|»»» modifiedBy|body|string|false|none|
+|»»» id|body|string|false|none|
+|»»» name|body|string|false|none|
+|»»» path|body|string|false|none|
+|»»» thumbnail|body|string|false|none|
+|»»» mime|body|string|false|none|
+|»»» extId|body|string|false|none|
+|»»» extMetadata|body|object|false|none|
+|»»» messageId|body|string|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "items": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "name": "string",
+ "path": "string",
+ "thumbnail": "string",
+ "mime": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "messageId": "string"
+ }
+ ]
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|collect single attachment for user by message identifier|[Attachment add response schema](#schemaattachment add response schema)|
+|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|Message identity does not exist.|None|
+|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden request due to unauthorized token in header.|None|
+
+
+This operation does not require authentication
+
+
+## API for sending a drafted message.
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|messageId|path|string|true|none|
+|filter|query|object|false|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Mail is Successfully sent!|None|
+|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|Message identity does not exist.|None|
+|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden request due to unauthorized token in header.|None|
+
+
+This operation does not require authentication
+
+
+## Update API. Update draft messages.
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|messageId|path|string|true|none|
+|body|body|[composeMailBody](#schemacomposemailbody)|false|none|
+
+> Example responses
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|Message identity does not exist.|None|
+|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden request due to unauthorized token in header.|None|
+|application/json|Unknown|collect single message for user by message identifier|None|
+
+Response Schema
+
+
+To perform this operation, you must be authenticated by means of one of the following methods:
+None
+
+
+## ComposeAPI. For drafting, reply on and create new message
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|body|body|[composeMailBody](#schemacomposemailbody)|false|none|
+
+> Example responses
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|201|[Created](https://tools.ietf.org/html/rfc7231#section-6.3.2)|collect single message for user by message identifier|None|
+|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden request due to unauthorized token in header.|None|
+|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Message identity does not exist.|None|
+
+Response Schema
+
+
+This operation does not require authentication
+
+
+CollectorController
+
+## GET Message API. Collect a single message based on message identity.
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|messageId|path|string|true|none|
+|filter|query|object|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "item": "string"
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Gets mail details based on unique message id|Inline|
+|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden request due to unauthrized token in header.|None|
+|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Message identity does not exist|None|
+
+Response Schema
+
+Status Code **200**
+
+|Name|Type|Required|Restrictions|Description|
+|---|---|---|---|---|
+|» item|string|false|none|none|
+
+
+This operation does not require authentication
+
+
+## Collect a list of all messages.
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|messageFilter|query|object|false|none|
+|groupFilter|query|object|false|none|
+
+> Example responses
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|fetch mails|None|
+|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden request due to unauthrized token in header.|None|
+
+Response Schema
+
+
+This operation does not require authentication
+
+
+## GET Thread Message API. Collect complete single message thread based on thread identity.
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|threadId|path|string|true|none|
+|filter|query|object|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "item": {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "subject": "string",
+ "messageCounts": 0,
+ "extId": "string",
+ "extMetadata": {}
+ }
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Fetches a thread along with message, group, attachment(s) etc based on unique thread Id|Inline|
+|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|Message identity does not exist|None|
+|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden request due to unauthorized token in header.|None|
+
+Response Schema
+
+Status Code **200**
+
+|Name|Type|Required|Restrictions|Description|
+|---|---|---|---|---|
+|» item|[Thread](#schemathread)|false|none|none|
+|»» deleted|boolean|false|none|none|
+|»» deletedOn|string(date-time)¦null|false|none|none|
+|»» deletedBy|string¦null|false|none|none|
+|»» createdOn|string(date-time)|false|none|none|
+|»» modifiedOn|string(date-time)|false|none|none|
+|»» createdBy|string|false|none|none|
+|»» modifiedBy|string|false|none|none|
+|»» id|string|false|none|none|
+|»» subject|string|true|none|none|
+|»» messageCounts|number|false|none|none|
+|»» extId|string|false|none|none|
+|»» extMetadata|object|false|none|none|
+
+
+This operation does not require authentication
+
+
+## Thread List API. Collect a list of all threads.
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|threadFilter|query|object|false|none|
+|groupFilter|query|object|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "version": "string",
+ "items": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "subject": "string",
+ "messageCounts": 0,
+ "extId": "string",
+ "extMetadata": {}
+ }
+ ]
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|fetch threads|Inline|
+
+Response Schema
+
+Status Code **200**
+
+|Name|Type|Required|Restrictions|Description|
+|---|---|---|---|---|
+|» version|string|false|none|none|
+|» items|[[Thread](#schemathread)]|false|none|none|
+|»» Thread|[Thread](#schemathread)|false|none|none|
+|»»» deleted|boolean|false|none|none|
+|»»» deletedOn|string(date-time)¦null|false|none|none|
+|»»» deletedBy|string¦null|false|none|none|
+|»»» createdOn|string(date-time)|false|none|none|
+|»»» modifiedOn|string(date-time)|false|none|none|
+|»»» createdBy|string|false|none|none|
+|»»» modifiedBy|string|false|none|none|
+|»»» id|string|false|none|none|
+|»»» subject|string|true|none|none|
+|»»» messageCounts|number|false|none|none|
+|»»» extId|string|false|none|none|
+|»»» extMetadata|object|false|none|none|
+
+
+This operation does not require authentication
+
+
+ReplyAndForwardController
+
+## API provides interface to forward single message.
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|threadId|path|string|true|none|
+|body|body|object|false|none|
+|» groups|body|[[GroupPartial](#schemagrouppartial)]|true|[(tsType: Partial, schemaOptions: { partial: true })]|
+|»» GroupPartial|body|[GroupPartial](#schemagrouppartial)|false|(tsType: Partial, schemaOptions: { partial: true })|
+|»»» deleted|body|boolean|false|none|
+|»»» deletedOn|body|string(date-time)¦null|false|none|
+|»»» deletedBy|body|string¦null|false|none|
+|»»» createdOn|body|string(date-time)|false|none|
+|»»» modifiedOn|body|string(date-time)|false|none|
+|»»» createdBy|body|string|false|none|
+|»»» modifiedBy|body|string|false|none|
+|»»» id|body|string|false|none|
+|»»» party|body|string|false|none|
+|»»» type|body|string|false|none|
+|»»» isImportant|body|boolean|false|none|
+|»»» storage|body|string|false|none|
+|»»» visibility|body|string|false|none|
+|»»» extId|body|string|false|none|
+|»»» extMetadata|body|object|false|none|
+|»»» messageId|body|string|false|none|
+|»»» threadId|body|string|false|none|
+|» subject|body|string|false|none|
+|» body|body|string|false|none|
+|» attachments|body|[[AttachmentPartial](#schemaattachmentpartial)]|false|[(tsType: Partial, schemaOptions: { partial: true })]|
+|»» AttachmentPartial|body|[AttachmentPartial](#schemaattachmentpartial)|false|(tsType: Partial, schemaOptions: { partial: true })|
+|»»» deleted|body|boolean|false|none|
+|»»» deletedOn|body|string(date-time)¦null|false|none|
+|»»» deletedBy|body|string¦null|false|none|
+|»»» createdOn|body|string(date-time)|false|none|
+|»»» modifiedOn|body|string(date-time)|false|none|
+|»»» createdBy|body|string|false|none|
+|»»» modifiedBy|body|string|false|none|
+|»»» id|body|string|false|none|
+|»»» name|body|string|false|none|
+|»»» path|body|string|false|none|
+|»»» thumbnail|body|string|false|none|
+|»»» mime|body|string|false|none|
+|»»» extId|body|string|false|none|
+|»»» extMetadata|body|object|false|none|
+|»»» messageId|body|string|false|none|
+|» meta|body|[[MetaPartial](#schemametapartial)]|false|[(tsType: PartialResponses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|Message is forwarded to another recipient|None|
+|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|Message identity does not exist.|None|
+|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden request due to unauthorized token in header.|None|
+
+Response Schema
+
+
+This operation does not require authentication
+
+
+## API provides interface to reply to a single message
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|threadId|path|string|true|none|
+|messageId|path|string|true|none|
+|replyAll|query|boolean|false|none|
+|body|body|object|false|none|
+|» attachments|body|[[AttachmentPartial](#schemaattachmentpartial)]|false|[(tsType: Partial, schemaOptions: { partial: true })]|
+|»» AttachmentPartial|body|[AttachmentPartial](#schemaattachmentpartial)|false|(tsType: Partial, schemaOptions: { partial: true })|
+|»»» deleted|body|boolean|false|none|
+|»»» deletedOn|body|string(date-time)¦null|false|none|
+|»»» deletedBy|body|string¦null|false|none|
+|»»» createdOn|body|string(date-time)|false|none|
+|»»» modifiedOn|body|string(date-time)|false|none|
+|»»» createdBy|body|string|false|none|
+|»»» modifiedBy|body|string|false|none|
+|»»» id|body|string|false|none|
+|»»» name|body|string|false|none|
+|»»» path|body|string|false|none|
+|»»» thumbnail|body|string|false|none|
+|»»» mime|body|string|false|none|
+|»»» extId|body|string|false|none|
+|»»» extMetadata|body|object|false|none|
+|»»» messageId|body|string|false|none|
+|» meta|body|[[MetaPartial](#schemametapartial)]|false|[(tsType: PartialResponses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Message is replied back to the sender|None|
+
+
+This operation does not require authentication
+
+
+# Schemas
+
+idResponse
+
+composeMailBody
+
+, schemaOptions: { partial: true })]|
+|attachments|[[AttachmentPartial](#schemaattachmentpartial)]|false|none|[(tsType: Partial, schemaOptions: { partial: true })]|
+|meta|[[MetaPartial](#schemametapartial)]|false|none|[(tsType: PartialAttachment
+
+AttachmentPartial
+
+IdArraysPartial
+
+IdArrays
+
+GroupPartial
+
+Attachment add response schema
+
+AttachmentExcluding_deleted_WithRelations
+
+, schemaOptions: { exclude: [ 'deleted' ], includeRelations: true })|
+
+ThreadExcluding_deleted_WithRelations
+
+, schemaOptions: { exclude: [ 'deleted' ], includeRelations: true })]|
+|group|[[GroupExcluding_deleted_WithRelations](#schemagroupexcluding_deleted_withrelations)]|false|none|[(tsType: Omit, schemaOptions: { exclude: [ 'deleted' ], includeRelations: true })]|
+
+GroupExcluding_deleted_WithRelations
+
+, schemaOptions: { exclude: [ 'deleted' ], includeRelations: true })|
+|thread|[ThreadExcluding_deleted_WithRelations](#schemathreadexcluding_deleted_withrelations)|false|none|(tsType: Omit, schemaOptions: { exclude: [ 'deleted' ], includeRelations: true })|
+
+#### Enumerated Values
+
+|Property|Value|
+|---|---|
+|type|from|
+|type|to|
+|type|cc|
+|type|bcc|
+|storage|draft|
+|storage|send|
+|storage|inbox|
+|storage|trash|
+|visibility|read|
+|visibility|new|
+|visibility|unread|
+|visibility|important|
+|visibility|not-important|
+
+
+
+, schemaOptions: { exclude: [ 'deleted' ], includeRelations: true })|
+
+MessageExcluding_deleted_WithRelations
+
+, schemaOptions: { exclude: [ 'deleted' ], includeRelations: true })]|
+|group|[[GroupExcluding_deleted_WithRelations](#schemagroupexcluding_deleted_withrelations)]|false|none|[(tsType: Omit, schemaOptions: { exclude: [ 'deleted' ], includeRelations: true })]|
+|meta|[[MetaExcluding_deleted_WithRelations](#schemametaexcluding_deleted_withrelations)]|false|none|[(tsType: Omit, schemaOptions: { exclude: [ 'deleted' ], includeRelations: true })]|
+|thread|[ThreadExcluding_deleted_WithRelations](#schemathreadexcluding_deleted_withrelations)|false|none|(tsType: Omit, schemaOptions: { exclude: [ 'deleted' ], includeRelations: true })|
+
+#### Enumerated Values
+
+|Property|Value|
+|---|---|
+|status|draft|
+|status|send|
+
+Message
+
+Thread
+
+ {
+ const config: ApplicationConfig = {
+ rest: {
+ port: +(process.env.PORT ?? PORT),
+ host: process.env.HOST ?? 'localhost',
+ },
+ };
+ const outFile = process.argv[FILEARGVI] ?? 'openapi.json';
+ const app = new InMailServiceApplication(config);
+ await app.boot();
+ await app.exportOpenApiSpec(outFile);
+}
+
+exportOpenApiSpec().catch(err => {
+ console.error('Fail to export OpenAPI spec from the application.', err); //NOSONAR
+ process.exit(1);
+});
diff --git a/services/notification-service/README.md b/services/notification-service/README.md
index 960ec136e7..703e76cd60 100644
--- a/services/notification-service/README.md
+++ b/services/notification-service/README.md
@@ -149,4 +149,6 @@ Authorization: Bearer where is a JWT token signed using JWT issu
400: Bad Request (Error message varies w.r.t API)"
+ }
+ }
+ }
+ }
+ ],
+ "operationId": "NotificationUserController.count"
+ }
+ },
+ "/notification-users/hard": {
+ "delete": {
+ "x-controller-name": "NotificationUserController",
+ "x-operation-name": "deleteAllHard",
+ "tags": [
+ "NotificationUserController"
+ ],
+ "responses": {
+ "204": {
+ "description": "Notification DELETE success"
+ }
+ },
+ "parameters": [
+ {
+ "name": "where",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "notification_users.WhereFilter",
+ "additionalProperties": true,
+ "x-typescript-type": "@loopback/repository#Where"
+ }
+ }
+ }
+ }
+ ],
+ "operationId": "NotificationUserController.deleteAllHard"
+ }
+ },
+ "/notification-users/{id}/notification": {
+ "get": {
+ "x-controller-name": "NotificationUserNotificationController",
+ "x-operation-name": "getNotification",
+ "tags": [
+ "NotificationUserNotificationController"
+ ],
+ "responses": {
+ "200": {
+ "description": "Notification belonging to NotificationUser",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Notification"
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ },
+ "required": true
+ }
+ ],
+ "operationId": "NotificationUserNotificationController.getNotification"
+ }
+ },
+ "/notification-users/{id}": {
+ "put": {
+ "x-controller-name": "NotificationUserController",
+ "x-operation-name": "replaceById",
+ "tags": [
+ "NotificationUserController"
+ ],
+ "responses": {
+ "204": {
+ "description": "NotificationUser PUT success"
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ },
+ "required": true
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NotificationUser"
+ }
+ }
+ },
+ "x-parameter-index": 1
+ },
+ "operationId": "NotificationUserController.replaceById"
+ },
+ "patch": {
+ "x-controller-name": "NotificationUserController",
+ "x-operation-name": "updateById",
+ "tags": [
+ "NotificationUserController"
+ ],
+ "responses": {
+ "204": {
+ "description": "NotificationUser PATCH success"
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ },
+ "required": true
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NotificationUserPartial"
+ }
+ }
+ },
+ "x-parameter-index": 1
+ },
+ "operationId": "NotificationUserController.updateById"
+ },
+ "get": {
+ "x-controller-name": "NotificationUserController",
+ "x-operation-name": "findById",
+ "tags": [
+ "NotificationUserController"
+ ],
+ "responses": {
+ "200": {
+ "description": "NotificationUser instance",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NotificationUser"
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ },
+ "required": true
+ }
+ ],
+ "operationId": "NotificationUserController.findById"
+ },
+ "delete": {
+ "x-controller-name": "NotificationUserController",
+ "x-operation-name": "deleteById",
+ "tags": [
+ "NotificationUserController"
+ ],
+ "responses": {
+ "204": {
+ "description": "NotificationUser DELETE success"
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ },
+ "required": true
+ }
+ ],
+ "operationId": "NotificationUserController.deleteById"
+ }
+ },
+ "/notification-users": {
+ "post": {
+ "x-controller-name": "NotificationUserController",
+ "x-operation-name": "create",
+ "tags": [
+ "NotificationUserController"
+ ],
+ "responses": {
+ "200": {
+ "description": "NotificationUser model instance",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NotificationUser"
+ }
+ }
+ }
+ }
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NewNotificationUser"
+ }
+ }
+ }
+ },
+ "operationId": "NotificationUserController.create"
+ },
+ "patch": {
+ "x-controller-name": "NotificationUserController",
+ "x-operation-name": "updateAll",
+ "tags": [
+ "NotificationUserController"
+ ],
+ "responses": {
+ "200": {
+ "description": "NotificationUser PATCH success count",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/loopback.Count"
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "where",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "notification_users.WhereFilter",
+ "additionalProperties": true,
+ "x-typescript-type": "@loopback/repository#Where"
+ }
+ }
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NotificationUserPartial"
+ }
+ }
+ }
+ },
+ "operationId": "NotificationUserController.updateAll"
+ },
+ "get": {
+ "x-controller-name": "NotificationUserController",
+ "x-operation-name": "find",
+ "tags": [
+ "NotificationUserController"
+ ],
+ "responses": {
+ "200": {
+ "description": "Array of NotificationUser model instances",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/NotificationUser"
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "filter",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/notification_users.Filter"
+ }
+ }
+ }
+ }
+ ],
+ "operationId": "NotificationUserController.find"
+ },
+ "delete": {
+ "x-controller-name": "NotificationUserController",
+ "x-operation-name": "deleteAll",
+ "tags": [
+ "NotificationUserController"
+ ],
+ "responses": {
+ "204": {
+ "description": "Notification DELETE success"
+ }
+ },
+ "parameters": [
+ {
+ "name": "where",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "notification_users.WhereFilter",
+ "additionalProperties": true,
+ "x-typescript-type": "@loopback/repository#Where"
+ }
+ }
+ }
+ }
+ ],
+ "operationId": "NotificationUserController.deleteAll"
+ }
+ },
+ "/notifications/access/{id}": {
+ "patch": {
+ "x-controller-name": "PubnubNotificationController",
+ "x-operation-name": "grantAccess",
+ "tags": [
+ "PubnubNotificationController"
+ ],
+ "responses": {
+ "200": {
+ "description": "Access response",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AccessResponseDto"
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ },
+ "required": true
+ },
+ {
+ "name": "Authorization",
+ "in": "header",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "pubnubToken",
+ "in": "header",
+ "schema": {
+ "type": "string"
+ },
+ "required": true
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NotificationAccess"
+ }
+ }
+ }
+ },
+ "operationId": "PubnubNotificationController.grantAccess"
+ },
+ "delete": {
+ "x-controller-name": "PubnubNotificationController",
+ "x-operation-name": "revokeAccess",
+ "tags": [
+ "PubnubNotificationController"
+ ],
+ "responses": {
+ "200": {
+ "description": "Object with success"
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ },
+ "required": true
+ }
+ ],
+ "operationId": "PubnubNotificationController.revokeAccess"
+ }
+ },
+ "/notifications/bulk": {
+ "post": {
+ "x-controller-name": "NotificationController",
+ "x-operation-name": "createBulkNotificaitions",
+ "tags": [
+ "NotificationController"
+ ],
+ "responses": {
+ "200": {
+ "description": "Array of Notifications",
+ "content": {
+ "application/json": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Notification",
+ "definitions": {
+ "Notification": {
+ "$ref": "#/components/schemas/Notification"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/NotificationExcluding_id_"
+ }
+ }
+ }
+ }
+ },
+ "operationId": "NotificationController.createBulkNotificaitions"
+ }
+ },
+ "/notifications/count": {
+ "get": {
+ "x-controller-name": "NotificationController",
+ "x-operation-name": "count",
+ "tags": [
+ "NotificationController"
+ ],
+ "responses": {
+ "200": {
+ "description": "Notification model count",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/loopback.Count"
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "where",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "notifications.WhereFilter",
+ "additionalProperties": true,
+ "x-typescript-type": "@loopback/repository#Where"
+ }
+ }
+ }
+ }
+ ],
+ "operationId": "NotificationController.count"
+ }
+ },
+ "/notifications/{id}/notification-users": {
+ "post": {
+ "x-controller-name": "NotificationNotificationUserController",
+ "x-operation-name": "create",
+ "tags": [
+ "NotificationNotificationUserController"
+ ],
+ "responses": {
+ "200": {
+ "description": "Notification model instance",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NotificationUser"
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ },
+ "required": true
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NewNotificationUserInNotification"
+ }
+ }
+ },
+ "x-parameter-index": 1
+ },
+ "operationId": "NotificationNotificationUserController.create"
+ },
+ "patch": {
+ "x-controller-name": "NotificationNotificationUserController",
+ "x-operation-name": "patch",
+ "tags": [
+ "NotificationNotificationUserController"
+ ],
+ "responses": {
+ "200": {
+ "description": "Notification.NotificationUser PATCH success count",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/loopback.Count"
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ },
+ "required": true
+ },
+ {
+ "name": "where",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "notification_users.WhereFilter",
+ "additionalProperties": true,
+ "x-typescript-type": "@loopback/repository#Where"
+ }
+ }
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NotificationUserPartial"
+ }
+ }
+ },
+ "x-parameter-index": 1
+ },
+ "operationId": "NotificationNotificationUserController.patch"
+ },
+ "get": {
+ "x-controller-name": "NotificationNotificationUserController",
+ "x-operation-name": "find",
+ "tags": [
+ "NotificationNotificationUserController"
+ ],
+ "responses": {
+ "200": {
+ "description": "Array of Notification has many NotificationUser",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/NotificationUser"
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ },
+ "required": true
+ },
+ {
+ "name": "filter",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": true
+ }
+ }
+ }
+ }
+ ],
+ "operationId": "NotificationNotificationUserController.find"
+ },
+ "delete": {
+ "x-controller-name": "NotificationNotificationUserController",
+ "x-operation-name": "delete",
+ "tags": [
+ "NotificationNotificationUserController"
+ ],
+ "responses": {
+ "200": {
+ "description": "Notification.NotificationUser DELETE success count",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/loopback.Count"
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ },
+ "required": true
+ },
+ {
+ "name": "where",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "notification_users.WhereFilter",
+ "additionalProperties": true,
+ "x-typescript-type": "@loopback/repository#Where"
+ }
+ }
+ }
+ }
+ ],
+ "operationId": "NotificationNotificationUserController.delete"
+ }
+ },
+ "/notifications/{id}": {
+ "get": {
+ "x-controller-name": "NotificationController",
+ "x-operation-name": "findById",
+ "tags": [
+ "NotificationController"
+ ],
+ "responses": {
+ "200": {
+ "description": "Notification model instance",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Notification"
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ },
+ "required": true
+ }
+ ],
+ "operationId": "NotificationController.findById"
+ }
+ },
+ "/notifications": {
+ "post": {
+ "x-controller-name": "NotificationController",
+ "x-operation-name": "create",
+ "tags": [
+ "NotificationController"
+ ],
+ "responses": {
+ "200": {
+ "description": "Notification model instance",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Notification"
+ }
+ }
+ }
+ }
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NotificationExcluding_id_"
+ }
+ }
+ }
+ },
+ "operationId": "NotificationController.create"
+ },
+ "get": {
+ "x-controller-name": "NotificationController",
+ "x-operation-name": "find",
+ "tags": [
+ "NotificationController"
+ ],
+ "responses": {
+ "200": {
+ "description": "Array of Notification model instances",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Notification"
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "filter",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/notifications.Filter"
+ }
+ }
+ }
+ }
+ ],
+ "operationId": "NotificationController.find"
+ },
+ "delete": {
+ "x-controller-name": "NotificationController",
+ "x-operation-name": "deleteAll",
+ "tags": [
+ "NotificationController"
+ ],
+ "responses": {
+ "204": {
+ "description": "Notification DELETE success"
+ }
+ },
+ "parameters": [
+ {
+ "name": "where",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "notifications.WhereFilter",
+ "additionalProperties": true,
+ "x-typescript-type": "@loopback/repository#Where"
+ }
+ }
+ }
+ }
+ ],
+ "operationId": "NotificationController.deleteAll"
+ }
+ }
+ },
+ "components": {
+ "securitySchemes": {
+ "HTTPBearer": {
+ "type": "http",
+ "scheme": "bearer",
+ "bearerFormat": "JWT"
+ }
+ },
+ "schemas": {
+ "Notification": {
+ "title": "Notification",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "subject": {
+ "type": "string",
+ "nullable": true
+ },
+ "body": {
+ "type": "string"
+ },
+ "receiver": {
+ "type": "object"
+ },
+ "type": {
+ "type": "number"
+ },
+ "sentDate": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "options": {
+ "type": "object"
+ }
+ },
+ "required": [
+ "body",
+ "receiver",
+ "type"
+ ],
+ "additionalProperties": false
+ },
+ "NotificationExcluding_id_": {
+ "title": "NotificationExcluding_id_",
+ "type": "object",
+ "description": "(tsType: Omit, schemaOptions: { exclude: [ 'id' ] })",
+ "properties": {
+ "subject": {
+ "type": "string",
+ "nullable": true
+ },
+ "body": {
+ "type": "string"
+ },
+ "receiver": {
+ "type": "object"
+ },
+ "type": {
+ "type": "number"
+ },
+ "sentDate": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "options": {
+ "type": "object"
+ }
+ },
+ "required": [
+ "body",
+ "receiver",
+ "type"
+ ],
+ "additionalProperties": false,
+ "x-typescript-type": "Omit"
+ },
+ "NotificationUser": {
+ "title": "NotificationUser",
+ "type": "object",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "deletedOn": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "deletedBy": {
+ "type": "string",
+ "nullable": true
+ },
+ "createdOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "modifiedOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "id": {
+ "type": "string"
+ },
+ "notificationId": {
+ "type": "string"
+ },
+ "userId": {
+ "type": "string"
+ },
+ "isRead": {
+ "type": "boolean"
+ },
+ "actionMeta": {
+ "type": "object"
+ }
+ },
+ "required": [
+ "notificationId",
+ "userId"
+ ],
+ "additionalProperties": true
+ },
+ "NewNotificationUser": {
+ "title": "NewNotificationUser",
+ "type": "object",
+ "description": "(tsType: Omit, schemaOptions: { title: 'NewNotificationUser', exclude: [ 'id' ] })",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "deletedOn": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "deletedBy": {
+ "type": "string",
+ "nullable": true
+ },
+ "createdOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "modifiedOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "notificationId": {
+ "type": "string"
+ },
+ "userId": {
+ "type": "string"
+ },
+ "isRead": {
+ "type": "boolean"
+ },
+ "actionMeta": {
+ "type": "object"
+ }
+ },
+ "required": [
+ "notificationId",
+ "userId"
+ ],
+ "additionalProperties": true,
+ "x-typescript-type": "Omit"
+ },
+ "NotificationUserPartial": {
+ "title": "NotificationUserPartial",
+ "type": "object",
+ "description": "(tsType: Partial, schemaOptions: { partial: true })",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "deletedOn": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "deletedBy": {
+ "type": "string",
+ "nullable": true
+ },
+ "createdOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "modifiedOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "id": {
+ "type": "string"
+ },
+ "notificationId": {
+ "type": "string"
+ },
+ "userId": {
+ "type": "string"
+ },
+ "isRead": {
+ "type": "boolean"
+ },
+ "actionMeta": {
+ "type": "object"
+ }
+ },
+ "additionalProperties": true,
+ "x-typescript-type": "Partial"
+ },
+ "AccessResponseDto": {
+ "title": "AccessResponseDto",
+ "type": "object",
+ "properties": {
+ "ttl": {
+ "type": "number"
+ },
+ "cipherKey": {
+ "type": "string"
+ }
+ },
+ "additionalProperties": false
+ },
+ "NotificationAccess": {
+ "title": "NotificationAccess",
+ "type": "object",
+ "properties": {
+ "receiver": {
+ "type": "object",
+ "description": "this will contain the list of reciever to give access"
+ },
+ "type": {
+ "type": "number"
+ },
+ "options": {
+ "type": "object",
+ "description": "this will contain the ttl property for now"
+ }
+ },
+ "required": [
+ "receiver",
+ "type"
+ ],
+ "additionalProperties": false
+ },
+ "NewNotificationUserInNotification": {
+ "title": "NewNotificationUserInNotification",
+ "type": "object",
+ "description": "(tsType: @loopback/repository-json-schema#Optional, 'notificationId'>, schemaOptions: { title: 'NewNotificationUserInNotification', exclude: [ 'id' ], optional: [ 'notificationId' ] })",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "deletedOn": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "deletedBy": {
+ "type": "string",
+ "nullable": true
+ },
+ "createdOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "modifiedOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "notificationId": {
+ "type": "string"
+ },
+ "userId": {
+ "type": "string"
+ },
+ "isRead": {
+ "type": "boolean"
+ },
+ "actionMeta": {
+ "type": "object"
+ }
+ },
+ "required": [
+ "userId"
+ ],
+ "additionalProperties": true,
+ "x-typescript-type": "@loopback/repository-json-schema#Optional, 'notificationId'>"
+ },
+ "loopback.Count": {
+ "type": "object",
+ "title": "loopback.Count",
+ "x-typescript-type": "@loopback/repository#Count",
+ "properties": {
+ "count": {
+ "type": "number"
+ }
+ }
+ },
+ "notification_users.ScopeFilter": {
+ "properties": {
+ "offset": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "limit": {
+ "type": "integer",
+ "minimum": 1,
+ "example": 100
+ },
+ "skip": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "order": {
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "where": {
+ "type": "object",
+ "additionalProperties": true
+ },
+ "fields": {
+ "oneOf": [
+ {
+ "type": "object",
+ "properties": {},
+ "additionalProperties": true
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "uniqueItems": true
+ }
+ ]
+ },
+ "include": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {},
+ "additionalProperties": true
+ }
+ }
+ },
+ "additionalProperties": false,
+ "title": "notification_users.ScopeFilter"
+ },
+ "notification_users.IncludeFilter.Items": {
+ "title": "notification_users.IncludeFilter.Items",
+ "type": "object",
+ "properties": {
+ "relation": {
+ "type": "string"
+ },
+ "scope": {
+ "$ref": "#/components/schemas/notification_users.ScopeFilter"
+ }
+ }
+ },
+ "notification_users.Filter": {
+ "type": "object",
+ "title": "notification_users.Filter",
+ "properties": {
+ "offset": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "limit": {
+ "type": "integer",
+ "minimum": 1,
+ "example": 100
+ },
+ "skip": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "order": {
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "where": {
+ "title": "notification_users.WhereFilter",
+ "type": "object",
+ "additionalProperties": true
+ },
+ "fields": {
+ "oneOf": [
+ {
+ "type": "object",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "deletedOn": {
+ "type": "boolean"
+ },
+ "deletedBy": {
+ "type": "boolean"
+ },
+ "createdOn": {
+ "type": "boolean"
+ },
+ "modifiedOn": {
+ "type": "boolean"
+ },
+ "id": {
+ "type": "boolean"
+ },
+ "notificationId": {
+ "type": "boolean"
+ },
+ "userId": {
+ "type": "boolean"
+ },
+ "isRead": {
+ "type": "boolean"
+ },
+ "actionMeta": {
+ "type": "boolean"
+ }
+ },
+ "additionalProperties": true
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "example": "deleted"
+ },
+ "uniqueItems": true
+ }
+ ],
+ "title": "notification_users.Fields"
+ },
+ "include": {
+ "title": "notification_users.IncludeFilter",
+ "type": "array",
+ "items": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/notification_users.IncludeFilter.Items"
+ },
+ {
+ "type": "string"
+ }
+ ]
+ }
+ }
+ },
+ "additionalProperties": false,
+ "x-typescript-type": "@loopback/repository#Filter"
+ },
+ "notifications.ScopeFilter": {
+ "properties": {
+ "offset": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "limit": {
+ "type": "integer",
+ "minimum": 1,
+ "example": 100
+ },
+ "skip": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "order": {
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "where": {
+ "type": "object",
+ "additionalProperties": true
+ },
+ "fields": {
+ "oneOf": [
+ {
+ "type": "object",
+ "properties": {},
+ "additionalProperties": true
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "uniqueItems": true
+ }
+ ]
+ },
+ "include": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {},
+ "additionalProperties": true
+ }
+ }
+ },
+ "additionalProperties": false,
+ "title": "notifications.ScopeFilter"
+ },
+ "notifications.IncludeFilter.Items": {
+ "title": "notifications.IncludeFilter.Items",
+ "type": "object",
+ "properties": {
+ "relation": {
+ "type": "string"
+ },
+ "scope": {
+ "$ref": "#/components/schemas/notifications.ScopeFilter"
+ }
+ }
+ },
+ "notifications.Filter": {
+ "type": "object",
+ "title": "notifications.Filter",
+ "properties": {
+ "offset": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "limit": {
+ "type": "integer",
+ "minimum": 1,
+ "example": 100
+ },
+ "skip": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "order": {
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "where": {
+ "title": "notifications.WhereFilter",
+ "type": "object",
+ "additionalProperties": true
+ },
+ "fields": {
+ "oneOf": [
+ {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "boolean"
+ },
+ "subject": {
+ "type": "boolean"
+ },
+ "body": {
+ "type": "boolean"
+ },
+ "receiver": {
+ "type": "boolean"
+ },
+ "type": {
+ "type": "boolean"
+ },
+ "sentDate": {
+ "type": "boolean"
+ },
+ "options": {
+ "type": "boolean"
+ }
+ },
+ "additionalProperties": false
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": [
+ "id",
+ "subject",
+ "body",
+ "receiver",
+ "type",
+ "sentDate",
+ "options"
+ ],
+ "example": "id"
+ },
+ "uniqueItems": true
+ }
+ ],
+ "title": "notifications.Fields"
+ },
+ "include": {
+ "title": "notifications.IncludeFilter",
+ "type": "array",
+ "items": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/notifications.IncludeFilter.Items"
+ },
+ {
+ "type": "string"
+ }
+ ]
+ }
+ }
+ },
+ "additionalProperties": false,
+ "x-typescript-type": "@loopback/repository#Filter"
+ }
+ }
+ },
+ "servers": [
+ {
+ "url": "/"
+ }
+ ]
+}
\ No newline at end of file
diff --git a/services/notification-service/openapi.md b/services/notification-service/openapi.md
new file mode 100644
index 0000000000..86043be1c2
--- /dev/null
+++ b/services/notification-service/openapi.md
@@ -0,0 +1,2421 @@
+---
+title: Notification Service v1.0.0
+language_tabs:
+ - "'javascript": JavaScript
+ - "'javascript--nodejs": Node.JS'
+language_clients:
+ - "'javascript": request'
+ - "'javascript--nodejs": ""
+toc_footers: []
+includes: []
+search: false
+highlight_theme: darkula
+headingLevel: 2
+
+---
+
+
+
+Notification Service v1.0.0
+
+> Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
+
+services
+
+Base URLs:
+
+* /
+
+# Authentication
+
+- HTTP Authentication, scheme: bearer
+
+NotificationUserController
+
+## NotificationUserController.createAll
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|body|body|[NewNotificationUser](#schemanewnotificationuser)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "id": "string",
+ "notificationId": "string",
+ "userId": "string",
+ "isRead": true,
+ "actionMeta": {}
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Notification User model instance|[NotificationUser](#schemanotificationuser)|
+
+
+This operation does not require authentication
+
+
+## NotificationUserController.count
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|where|query|object|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "count": 0
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|NotificationUser model count|[loopback.Count](#schemaloopback.count)|
+
+
+This operation does not require authentication
+
+
+## NotificationUserController.deleteAllHard
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|where|query|object|false|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|Notification DELETE success|None|
+
+
+This operation does not require authentication
+
+
+## NotificationUserController.replaceById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|body|body|[NotificationUser](#schemanotificationuser)|false|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|NotificationUser PUT success|None|
+
+
+This operation does not require authentication
+
+
+## NotificationUserController.updateById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|body|body|[NotificationUserPartial](#schemanotificationuserpartial)|false|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|NotificationUser PATCH success|None|
+
+
+This operation does not require authentication
+
+
+## NotificationUserController.findById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "id": "string",
+ "notificationId": "string",
+ "userId": "string",
+ "isRead": true,
+ "actionMeta": {}
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|NotificationUser instance|[NotificationUser](#schemanotificationuser)|
+
+
+This operation does not require authentication
+
+
+## NotificationUserController.deleteById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|NotificationUser DELETE success|None|
+
+
+This operation does not require authentication
+
+
+## NotificationUserController.create
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|body|body|[NewNotificationUser](#schemanewnotificationuser)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "id": "string",
+ "notificationId": "string",
+ "userId": "string",
+ "isRead": true,
+ "actionMeta": {}
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|NotificationUser model instance|[NotificationUser](#schemanotificationuser)|
+
+
+This operation does not require authentication
+
+
+## NotificationUserController.updateAll
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|where|query|object|false|none|
+|body|body|[NotificationUserPartial](#schemanotificationuserpartial)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "count": 0
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|NotificationUser PATCH success count|[loopback.Count](#schemaloopback.count)|
+
+
+This operation does not require authentication
+
+
+## NotificationUserController.find
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|filter|query|[notification_users.Filter](#schemanotification_users.filter)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+[
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "id": "string",
+ "notificationId": "string",
+ "userId": "string",
+ "isRead": true,
+ "actionMeta": {}
+ }
+]
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Array of NotificationUser model instances|Inline|
+
+Response Schema
+
+Status Code **200**
+
+|Name|Type|Required|Restrictions|Description|
+|---|---|---|---|---|
+|*anonymous*|[[NotificationUser](#schemanotificationuser)]|false|none|none|
+|» NotificationUser|[NotificationUser](#schemanotificationuser)|false|none|none|
+|»» deleted|boolean|false|none|none|
+|»» deletedOn|string(date-time)¦null|false|none|none|
+|»» deletedBy|string¦null|false|none|none|
+|»» createdOn|string(date-time)|false|none|none|
+|»» modifiedOn|string(date-time)|false|none|none|
+|»» id|string|false|none|none|
+|»» notificationId|string|true|none|none|
+|»» userId|string|true|none|none|
+|»» isRead|boolean|false|none|none|
+|»» actionMeta|object|false|none|none|
+
+
+This operation does not require authentication
+
+
+## NotificationUserController.deleteAll
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|where|query|object|false|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|Notification DELETE success|None|
+
+
+This operation does not require authentication
+
+
+NotificationUserNotificationController
+
+## NotificationUserNotificationController.getNotification
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+[
+ {
+ "id": "string",
+ "subject": "string",
+ "body": "string",
+ "receiver": {},
+ "type": 0,
+ "sentDate": "2019-08-24T14:15:22Z",
+ "options": {}
+ }
+]
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Notification belonging to NotificationUser|Inline|
+
+Response Schema
+
+Status Code **200**
+
+|Name|Type|Required|Restrictions|Description|
+|---|---|---|---|---|
+|*anonymous*|[[Notification](#schemanotification)]|false|none|none|
+|» Notification|[Notification](#schemanotification)|false|none|none|
+|»» id|string|false|none|none|
+|»» subject|string¦null|false|none|none|
+|»» body|string|true|none|none|
+|»» receiver|object|true|none|none|
+|»» type|number|true|none|none|
+|»» sentDate|string(date-time)|false|none|none|
+|»» options|object|false|none|none|
+
+
+This operation does not require authentication
+
+
+PubnubNotificationController
+
+## PubnubNotificationController.grantAccess
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|Authorization|header|string|false|none|
+|pubnubToken|header|string|true|none|
+|body|body|[NotificationAccess](#schemanotificationaccess)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "ttl": 0,
+ "cipherKey": "string"
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Access response|[AccessResponseDto](#schemaaccessresponsedto)|
+
+
+This operation does not require authentication
+
+
+## PubnubNotificationController.revokeAccess
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Object with success|None|
+
+
+This operation does not require authentication
+
+
+NotificationController
+
+## NotificationController.createBulkNotificaitions
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|body|body|[NotificationExcluding_id_](#schemanotificationexcluding_id_)|false|none|
+
+> Example responses
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Array of Notifications|None|
+
+Response Schema
+
+
+This operation does not require authentication
+
+
+## NotificationController.count
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|where|query|object|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "count": 0
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Notification model count|[loopback.Count](#schemaloopback.count)|
+
+
+This operation does not require authentication
+
+
+## NotificationController.findById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "id": "string",
+ "subject": "string",
+ "body": "string",
+ "receiver": {},
+ "type": 0,
+ "sentDate": "2019-08-24T14:15:22Z",
+ "options": {}
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Notification model instance|[Notification](#schemanotification)|
+
+
+This operation does not require authentication
+
+
+## NotificationController.create
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|body|body|[NotificationExcluding_id_](#schemanotificationexcluding_id_)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "id": "string",
+ "subject": "string",
+ "body": "string",
+ "receiver": {},
+ "type": 0,
+ "sentDate": "2019-08-24T14:15:22Z",
+ "options": {}
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Notification model instance|[Notification](#schemanotification)|
+
+
+This operation does not require authentication
+
+
+## NotificationController.find
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|filter|query|[notifications.Filter](#schemanotifications.filter)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+[
+ {
+ "id": "string",
+ "subject": "string",
+ "body": "string",
+ "receiver": {},
+ "type": 0,
+ "sentDate": "2019-08-24T14:15:22Z",
+ "options": {}
+ }
+]
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Array of Notification model instances|Inline|
+
+Response Schema
+
+Status Code **200**
+
+|Name|Type|Required|Restrictions|Description|
+|---|---|---|---|---|
+|*anonymous*|[[Notification](#schemanotification)]|false|none|none|
+|» Notification|[Notification](#schemanotification)|false|none|none|
+|»» id|string|false|none|none|
+|»» subject|string¦null|false|none|none|
+|»» body|string|true|none|none|
+|»» receiver|object|true|none|none|
+|»» type|number|true|none|none|
+|»» sentDate|string(date-time)|false|none|none|
+|»» options|object|false|none|none|
+
+
+This operation does not require authentication
+
+
+## NotificationController.deleteAll
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|where|query|object|false|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|Notification DELETE success|None|
+
+
+This operation does not require authentication
+
+
+NotificationNotificationUserController
+
+## NotificationNotificationUserController.create
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|body|body|[NewNotificationUserInNotification](#schemanewnotificationuserinnotification)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "id": "string",
+ "notificationId": "string",
+ "userId": "string",
+ "isRead": true,
+ "actionMeta": {}
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Notification model instance|[NotificationUser](#schemanotificationuser)|
+
+
+This operation does not require authentication
+
+
+## NotificationNotificationUserController.patch
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|where|query|object|false|none|
+|body|body|[NotificationUserPartial](#schemanotificationuserpartial)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "count": 0
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Notification.NotificationUser PATCH success count|[loopback.Count](#schemaloopback.count)|
+
+
+This operation does not require authentication
+
+
+## NotificationNotificationUserController.find
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|filter|query|object|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+[
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "id": "string",
+ "notificationId": "string",
+ "userId": "string",
+ "isRead": true,
+ "actionMeta": {}
+ }
+]
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Array of Notification has many NotificationUser|Inline|
+
+Response Schema
+
+Status Code **200**
+
+|Name|Type|Required|Restrictions|Description|
+|---|---|---|---|---|
+|*anonymous*|[[NotificationUser](#schemanotificationuser)]|false|none|none|
+|» NotificationUser|[NotificationUser](#schemanotificationuser)|false|none|none|
+|»» deleted|boolean|false|none|none|
+|»» deletedOn|string(date-time)¦null|false|none|none|
+|»» deletedBy|string¦null|false|none|none|
+|»» createdOn|string(date-time)|false|none|none|
+|»» modifiedOn|string(date-time)|false|none|none|
+|»» id|string|false|none|none|
+|»» notificationId|string|true|none|none|
+|»» userId|string|true|none|none|
+|»» isRead|boolean|false|none|none|
+|»» actionMeta|object|false|none|none|
+
+
+This operation does not require authentication
+
+
+## NotificationNotificationUserController.delete
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|where|query|object|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "count": 0
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Notification.NotificationUser DELETE success count|[loopback.Count](#schemaloopback.count)|
+
+
+This operation does not require authentication
+
+
+# Schemas
+
+Notification
+
+NotificationExcluding_id_
+
+NotificationUser
+
+NewNotificationUser
+
+NotificationUserPartial
+
+AccessResponseDto
+
+NotificationAccess
+
+NewNotificationUserInNotification
+
+loopback.Count
+
+notification_users.ScopeFilter
+
+notification_users.IncludeFilter.Items
+
+notification_users.Filter
+
+notifications.ScopeFilter
+
+notifications.IncludeFilter.Items
+
+notifications.Filter
+
+ {
+ const config: ApplicationConfig = {
+ rest: {
+ port: +(process.env.PORT ?? PORT),
+ host: process.env.HOST ?? 'localhost',
+ },
+ };
+ const outFile = process.argv[FILEARGVI] ?? 'openapi.json';
+ const app = new NotificationServiceApplication(config);
+ await app.boot();
+ await app.exportOpenApiSpec(outFile);
+}
+
+exportOpenApiSpec().catch(err => {
+ console.error('Fail to export OpenAPI spec from the application.', err); //NOSONAR
+ process.exit(1);
+});
diff --git a/services/scheduler-service/README.md b/services/scheduler-service/README.md
index 2d0f4f15b7..8f627443ab 100644
--- a/services/scheduler-service/README.md
+++ b/services/scheduler-service/README.md
@@ -259,6 +259,10 @@ They can be retrieved via list and get methods. Note that if a setting has its d
* Event settings from the past could not be created or updated.
+## API's Details
+
+Visit the [OpenAPI spec docs](./openapi.md)
+
## Feedback
If you've noticed a bug or have a question or have a feature request, [search the issue tracker](https://github.com/sourcefuse/loopback4-notifications/issues) to see if someone else in the community has already created a ticket.
If not, go ahead and [make one](https://github.com/sourcefuse/loopback4-notifications/issues/new/choose)!
diff --git a/services/scheduler-service/migration.js b/services/scheduler-service/migration.js
index 70d76ee5df..43a3bf7225 100644
--- a/services/scheduler-service/migration.js
+++ b/services/scheduler-service/migration.js
@@ -1,6 +1,5 @@
const dotenvExt = require('dotenv-extended');
const fs = require('fs');
-const DBMigrate = require('db-migrate');
const path = require('path');
let isLocal = false;
dotenvExt.load({
@@ -27,6 +26,7 @@ if (isLocal) {
`${type}_MIGRATION or SOURCELOOP_MIGRATION variables not found in the environment, skipping automigration.`,
);
} else {
+ const DBMigrate = require('db-migrate');
dotenvExt.load({
schema: path.join('.', 'migrations', '.env.schema'),
path: path.join(process.env.INIT_CWD, '.env'),
diff --git a/services/scheduler-service/openapi.json b/services/scheduler-service/openapi.json
new file mode 100644
index 0000000000..129782ca30
--- /dev/null
+++ b/services/scheduler-service/openapi.json
@@ -0,0 +1,9110 @@
+{
+ "openapi": "3.0.0",
+ "info": {
+ "title": "Scheduler Service",
+ "version": "1.0.0",
+ "description": "services",
+ "contact": {
+ "name": "Sourcefuse"
+ }
+ },
+ "paths": {
+ "/attachments/count": {
+ "get": {
+ "x-controller-name": "AttachmentController",
+ "x-operation-name": "count",
+ "tags": [
+ "AttachmentController"
+ ],
+ "responses": {
+ "200": {
+ "description": "Attachment model count",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/loopback.Count"
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "where",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "attachments.WhereFilter",
+ "additionalProperties": true,
+ "x-typescript-type": "@loopback/repository#Where"
+ }
+ }
+ }
+ }
+ ],
+ "operationId": "AttachmentController.count"
+ }
+ },
+ "/attachments/{id}": {
+ "put": {
+ "x-controller-name": "AttachmentController",
+ "x-operation-name": "replaceById",
+ "tags": [
+ "AttachmentController"
+ ],
+ "responses": {
+ "204": {
+ "description": "Attachment PUT success"
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ },
+ "required": true
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Attachment"
+ }
+ }
+ },
+ "x-parameter-index": 1
+ },
+ "operationId": "AttachmentController.replaceById"
+ },
+ "patch": {
+ "x-controller-name": "AttachmentController",
+ "x-operation-name": "updateById",
+ "tags": [
+ "AttachmentController"
+ ],
+ "responses": {
+ "204": {
+ "description": "Attachment PATCH success"
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ },
+ "required": true
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AttachmentPartial"
+ }
+ }
+ },
+ "x-parameter-index": 1
+ },
+ "operationId": "AttachmentController.updateById"
+ },
+ "get": {
+ "x-controller-name": "AttachmentController",
+ "x-operation-name": "findById",
+ "tags": [
+ "AttachmentController"
+ ],
+ "responses": {
+ "200": {
+ "description": "Attachment model instance",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AttachmentWithRelations"
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ },
+ "required": true
+ },
+ {
+ "name": "filter",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/attachments.Filter"
+ }
+ }
+ }
+ }
+ ],
+ "operationId": "AttachmentController.findById"
+ },
+ "delete": {
+ "x-controller-name": "AttachmentController",
+ "x-operation-name": "deleteById",
+ "tags": [
+ "AttachmentController"
+ ],
+ "responses": {
+ "204": {
+ "description": "Attachment DELETE success"
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ },
+ "required": true
+ }
+ ],
+ "operationId": "AttachmentController.deleteById"
+ }
+ },
+ "/attachments": {
+ "post": {
+ "x-controller-name": "AttachmentController",
+ "x-operation-name": "create",
+ "tags": [
+ "AttachmentController"
+ ],
+ "responses": {
+ "200": {
+ "description": "Attachment model instance",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Attachment"
+ }
+ }
+ }
+ }
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NewAttachment"
+ }
+ }
+ }
+ },
+ "operationId": "AttachmentController.create"
+ },
+ "patch": {
+ "x-controller-name": "AttachmentController",
+ "x-operation-name": "updateAll",
+ "tags": [
+ "AttachmentController"
+ ],
+ "responses": {
+ "200": {
+ "description": "Attachment PATCH success count",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/loopback.Count"
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "where",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "attachments.WhereFilter",
+ "additionalProperties": true,
+ "x-typescript-type": "@loopback/repository#Where"
+ }
+ }
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AttachmentPartial"
+ }
+ }
+ }
+ },
+ "operationId": "AttachmentController.updateAll"
+ },
+ "get": {
+ "x-controller-name": "AttachmentController",
+ "x-operation-name": "find",
+ "tags": [
+ "AttachmentController"
+ ],
+ "responses": {
+ "200": {
+ "description": "Array of Attachment model instances",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/AttachmentWithRelations"
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "filter",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/attachments.Filter1"
+ }
+ }
+ }
+ }
+ ],
+ "operationId": "AttachmentController.find"
+ }
+ },
+ "/attendees/count": {
+ "get": {
+ "x-controller-name": "AttendeeController",
+ "x-operation-name": "count",
+ "tags": [
+ "AttendeeController"
+ ],
+ "responses": {
+ "200": {
+ "description": "Attendee model count",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/loopback.Count"
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "where",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "attendees.WhereFilter",
+ "additionalProperties": true,
+ "x-typescript-type": "@loopback/repository#Where"
+ }
+ }
+ }
+ }
+ ],
+ "operationId": "AttendeeController.count"
+ }
+ },
+ "/attendees/{id}": {
+ "put": {
+ "x-controller-name": "AttendeeController",
+ "x-operation-name": "replaceById",
+ "tags": [
+ "AttendeeController"
+ ],
+ "responses": {
+ "204": {
+ "description": "Attendee PUT success"
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ },
+ "required": true
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Attendee"
+ }
+ }
+ },
+ "x-parameter-index": 1
+ },
+ "operationId": "AttendeeController.replaceById"
+ },
+ "patch": {
+ "x-controller-name": "AttendeeController",
+ "x-operation-name": "updateById",
+ "tags": [
+ "AttendeeController"
+ ],
+ "responses": {
+ "204": {
+ "description": "Attendee PATCH success"
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ },
+ "required": true
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AttendeePartial"
+ }
+ }
+ },
+ "x-parameter-index": 1
+ },
+ "operationId": "AttendeeController.updateById"
+ },
+ "get": {
+ "x-controller-name": "AttendeeController",
+ "x-operation-name": "findById",
+ "tags": [
+ "AttendeeController"
+ ],
+ "responses": {
+ "200": {
+ "description": "Attendee model instance",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AttendeeWithRelations"
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ },
+ "required": true
+ },
+ {
+ "name": "filter",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/attendees.Filter"
+ }
+ }
+ }
+ }
+ ],
+ "operationId": "AttendeeController.findById"
+ },
+ "delete": {
+ "x-controller-name": "AttendeeController",
+ "x-operation-name": "deleteById",
+ "tags": [
+ "AttendeeController"
+ ],
+ "responses": {
+ "204": {
+ "description": "Attendee DELETE success"
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ },
+ "required": true
+ }
+ ],
+ "operationId": "AttendeeController.deleteById"
+ }
+ },
+ "/attendees": {
+ "post": {
+ "x-controller-name": "AttendeeController",
+ "x-operation-name": "create",
+ "tags": [
+ "AttendeeController"
+ ],
+ "responses": {
+ "200": {
+ "description": "Attendee model instance",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Attendee"
+ }
+ }
+ }
+ }
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NewAttendee"
+ }
+ }
+ }
+ },
+ "operationId": "AttendeeController.create"
+ },
+ "patch": {
+ "x-controller-name": "AttendeeController",
+ "x-operation-name": "updateAll",
+ "tags": [
+ "AttendeeController"
+ ],
+ "responses": {
+ "200": {
+ "description": "Attendee PATCH success count",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/loopback.Count"
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "where",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "attendees.WhereFilter",
+ "additionalProperties": true,
+ "x-typescript-type": "@loopback/repository#Where"
+ }
+ }
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AttendeePartial"
+ }
+ }
+ }
+ },
+ "operationId": "AttendeeController.updateAll"
+ },
+ "get": {
+ "x-controller-name": "AttendeeController",
+ "x-operation-name": "find",
+ "tags": [
+ "AttendeeController"
+ ],
+ "responses": {
+ "200": {
+ "description": "Array of Attendee model instances",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/AttendeeWithRelations"
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "filter",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/attendees.Filter1"
+ }
+ }
+ }
+ }
+ ],
+ "operationId": "AttendeeController.find"
+ }
+ },
+ "/calendars/calendarSubscription": {
+ "post": {
+ "x-controller-name": "CalendarController",
+ "x-operation-name": "createWithSubscription",
+ "tags": [
+ "CalendarController"
+ ],
+ "responses": {
+ "200": {
+ "description": "Calendar model instance",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CalendarDTO"
+ }
+ }
+ }
+ }
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NewCalendar"
+ }
+ }
+ }
+ },
+ "operationId": "CalendarController.createWithSubscription"
+ }
+ },
+ "/calendars/count": {
+ "get": {
+ "x-controller-name": "CalendarController",
+ "x-operation-name": "count",
+ "tags": [
+ "CalendarController"
+ ],
+ "responses": {
+ "200": {
+ "description": "Calendar model count",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/loopback.Count"
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "where",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "calendars.WhereFilter",
+ "additionalProperties": true,
+ "x-typescript-type": "@loopback/repository#Where"
+ }
+ }
+ }
+ }
+ ],
+ "operationId": "CalendarController.count"
+ }
+ },
+ "/calendars/subscriptions/me": {
+ "get": {
+ "x-controller-name": "SubscriptionController",
+ "x-operation-name": "findMe",
+ "tags": [
+ "SubscriptionController"
+ ],
+ "responses": {
+ "200": {
+ "description": "Array of Subscription model instances",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SubscriptionWithRelations"
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "filter",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/subscriptions.Filter"
+ }
+ }
+ }
+ }
+ ],
+ "operationId": "SubscriptionController.findMe"
+ }
+ },
+ "/calendars/{id}/events": {
+ "post": {
+ "x-controller-name": "CalendarEventController",
+ "x-operation-name": "create",
+ "tags": [
+ "CalendarEventController"
+ ],
+ "responses": {
+ "200": {
+ "description": "Calendar model instance",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Event"
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ },
+ "required": true
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NewEventInCalendar"
+ }
+ }
+ },
+ "x-parameter-index": 1
+ },
+ "operationId": "CalendarEventController.create"
+ },
+ "patch": {
+ "x-controller-name": "CalendarEventController",
+ "x-operation-name": "patch",
+ "tags": [
+ "CalendarEventController"
+ ],
+ "responses": {
+ "200": {
+ "description": "Calendar.Event PATCH success count",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/loopback.Count"
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ },
+ "required": true
+ },
+ {
+ "name": "where",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "events.WhereFilter",
+ "additionalProperties": true,
+ "x-typescript-type": "@loopback/repository#Where"
+ }
+ }
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/EventPartial"
+ }
+ }
+ },
+ "x-parameter-index": 1
+ },
+ "operationId": "CalendarEventController.patch"
+ },
+ "get": {
+ "x-controller-name": "CalendarEventController",
+ "x-operation-name": "find",
+ "tags": [
+ "CalendarEventController"
+ ],
+ "responses": {
+ "200": {
+ "description": "Array of Calendar has many Event",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Event"
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ },
+ "required": true
+ },
+ {
+ "name": "filter",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": true
+ }
+ }
+ }
+ },
+ {
+ "name": "timeMax",
+ "in": "query",
+ "schema": {
+ "type": "string",
+ "format": "date-time"
+ }
+ },
+ {
+ "name": "timeMin",
+ "in": "query",
+ "schema": {
+ "type": "string",
+ "format": "date-time"
+ }
+ }
+ ],
+ "operationId": "CalendarEventController.find"
+ },
+ "delete": {
+ "x-controller-name": "CalendarEventController",
+ "x-operation-name": "delete",
+ "tags": [
+ "CalendarEventController"
+ ],
+ "responses": {
+ "200": {
+ "description": "Calendar.Event DELETE success count",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/loopback.Count"
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ },
+ "required": true
+ },
+ {
+ "name": "where",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "events.WhereFilter",
+ "additionalProperties": true,
+ "x-typescript-type": "@loopback/repository#Where"
+ }
+ }
+ }
+ }
+ ],
+ "operationId": "CalendarEventController.delete"
+ }
+ },
+ "/calendars/{id}/subscriptions": {
+ "post": {
+ "x-controller-name": "CalendarSubscriptionController",
+ "x-operation-name": "create",
+ "tags": [
+ "CalendarSubscriptionController"
+ ],
+ "responses": {
+ "200": {
+ "description": "Calendar model instance",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Subscription"
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ },
+ "required": true
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NewSubscriptionInCalendar"
+ }
+ }
+ },
+ "x-parameter-index": 1
+ },
+ "operationId": "CalendarSubscriptionController.create"
+ },
+ "patch": {
+ "x-controller-name": "CalendarSubscriptionController",
+ "x-operation-name": "patch",
+ "tags": [
+ "CalendarSubscriptionController"
+ ],
+ "responses": {
+ "200": {
+ "description": "Calendar.Subscription PATCH success count",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/loopback.Count"
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ },
+ "required": true
+ },
+ {
+ "name": "where",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "subscriptions.WhereFilter",
+ "additionalProperties": true,
+ "x-typescript-type": "@loopback/repository#Where"
+ }
+ }
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SubscriptionPartial"
+ }
+ }
+ },
+ "x-parameter-index": 1
+ },
+ "operationId": "CalendarSubscriptionController.patch"
+ },
+ "get": {
+ "x-controller-name": "CalendarSubscriptionController",
+ "x-operation-name": "find",
+ "tags": [
+ "CalendarSubscriptionController"
+ ],
+ "responses": {
+ "200": {
+ "description": "Array of Calendar has many Subscriptions",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Subscription"
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ },
+ "required": true
+ },
+ {
+ "name": "filter",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": true
+ }
+ }
+ }
+ }
+ ],
+ "operationId": "CalendarSubscriptionController.find"
+ },
+ "delete": {
+ "x-controller-name": "CalendarSubscriptionController",
+ "x-operation-name": "delete",
+ "tags": [
+ "CalendarSubscriptionController"
+ ],
+ "responses": {
+ "200": {
+ "description": "Calendar.Subscription DELETE success count",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/loopback.Count"
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ },
+ "required": true
+ },
+ {
+ "name": "where",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "subscriptions.WhereFilter",
+ "additionalProperties": true,
+ "x-typescript-type": "@loopback/repository#Where"
+ }
+ }
+ }
+ }
+ ],
+ "operationId": "CalendarSubscriptionController.delete"
+ }
+ },
+ "/calendars/{id}/working-hours": {
+ "post": {
+ "x-controller-name": "CalendarWorkingHourController",
+ "x-operation-name": "create",
+ "tags": [
+ "CalendarWorkingHourController"
+ ],
+ "responses": {
+ "200": {
+ "description": "Calendar model instance",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/WorkingHour"
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ },
+ "required": true
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NewWorkingHourInCalendar"
+ }
+ }
+ },
+ "x-parameter-index": 1
+ },
+ "operationId": "CalendarWorkingHourController.create"
+ },
+ "patch": {
+ "x-controller-name": "CalendarWorkingHourController",
+ "x-operation-name": "patch",
+ "tags": [
+ "CalendarWorkingHourController"
+ ],
+ "responses": {
+ "200": {
+ "description": "Calendar.WorkingHour PATCH success count",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/loopback.Count"
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ },
+ "required": true
+ },
+ {
+ "name": "where",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "working_hours.WhereFilter",
+ "additionalProperties": true,
+ "x-typescript-type": "@loopback/repository#Where"
+ }
+ }
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/WorkingHourPartial"
+ }
+ }
+ },
+ "x-parameter-index": 1
+ },
+ "operationId": "CalendarWorkingHourController.patch"
+ },
+ "get": {
+ "x-controller-name": "CalendarWorkingHourController",
+ "x-operation-name": "find",
+ "tags": [
+ "CalendarWorkingHourController"
+ ],
+ "responses": {
+ "200": {
+ "description": "Array of Calendar has many WorkingHour",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/WorkingHour"
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ },
+ "required": true
+ },
+ {
+ "name": "filter",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": true
+ }
+ }
+ }
+ }
+ ],
+ "operationId": "CalendarWorkingHourController.find"
+ },
+ "delete": {
+ "x-controller-name": "CalendarWorkingHourController",
+ "x-operation-name": "delete",
+ "tags": [
+ "CalendarWorkingHourController"
+ ],
+ "responses": {
+ "200": {
+ "description": "Calendar.WorkingHour DELETE success count",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/loopback.Count"
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ },
+ "required": true
+ },
+ {
+ "name": "where",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "working_hours.WhereFilter",
+ "additionalProperties": true,
+ "x-typescript-type": "@loopback/repository#Where"
+ }
+ }
+ }
+ }
+ ],
+ "operationId": "CalendarWorkingHourController.delete"
+ }
+ },
+ "/calendars/{id}": {
+ "put": {
+ "x-controller-name": "CalendarController",
+ "x-operation-name": "replaceById",
+ "tags": [
+ "CalendarController"
+ ],
+ "responses": {
+ "204": {
+ "description": "Calendar PUT success"
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ },
+ "required": true
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CalendarDTO"
+ }
+ }
+ },
+ "x-parameter-index": 1
+ },
+ "operationId": "CalendarController.replaceById"
+ },
+ "patch": {
+ "x-controller-name": "CalendarController",
+ "x-operation-name": "updateById",
+ "tags": [
+ "CalendarController"
+ ],
+ "responses": {
+ "204": {
+ "description": "Calendar PATCH success"
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ },
+ "required": true
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CalendarPartial"
+ }
+ }
+ },
+ "x-parameter-index": 1
+ },
+ "operationId": "CalendarController.updateById"
+ },
+ "get": {
+ "x-controller-name": "CalendarController",
+ "x-operation-name": "findById",
+ "tags": [
+ "CalendarController"
+ ],
+ "responses": {
+ "200": {
+ "description": "Calendar model instance",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CalendarWithRelations"
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ },
+ "required": true
+ },
+ {
+ "name": "filter",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/calendars.Filter"
+ }
+ }
+ }
+ }
+ ],
+ "operationId": "CalendarController.findById"
+ },
+ "delete": {
+ "x-controller-name": "CalendarController",
+ "x-operation-name": "deleteById",
+ "tags": [
+ "CalendarController"
+ ],
+ "responses": {
+ "204": {
+ "description": "Calendar DELETE success"
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ },
+ "required": true
+ }
+ ],
+ "operationId": "CalendarController.deleteById"
+ }
+ },
+ "/calendars": {
+ "post": {
+ "x-controller-name": "CalendarController",
+ "x-operation-name": "create",
+ "tags": [
+ "CalendarController"
+ ],
+ "responses": {
+ "200": {
+ "description": "Calendar model instance",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Calendar"
+ }
+ }
+ }
+ }
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NewCalendar"
+ }
+ }
+ }
+ },
+ "operationId": "CalendarController.create"
+ },
+ "patch": {
+ "x-controller-name": "CalendarController",
+ "x-operation-name": "updateAll",
+ "tags": [
+ "CalendarController"
+ ],
+ "responses": {
+ "200": {
+ "description": "Calendar PATCH success count",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/loopback.Count"
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "where",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "calendars.WhereFilter",
+ "additionalProperties": true,
+ "x-typescript-type": "@loopback/repository#Where"
+ }
+ }
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CalendarPartial"
+ }
+ }
+ }
+ },
+ "operationId": "CalendarController.updateAll"
+ },
+ "get": {
+ "x-controller-name": "CalendarController",
+ "x-operation-name": "find",
+ "tags": [
+ "CalendarController"
+ ],
+ "responses": {
+ "200": {
+ "description": "Array of Calendar model instances",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/CalendarWithRelations"
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "filter",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/calendars.Filter1"
+ }
+ }
+ }
+ }
+ ],
+ "operationId": "CalendarController.find"
+ }
+ },
+ "/events/count": {
+ "get": {
+ "x-controller-name": "EventController",
+ "x-operation-name": "count",
+ "tags": [
+ "EventController"
+ ],
+ "responses": {
+ "200": {
+ "description": "Event model count",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/loopback.Count"
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "where",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "events.WhereFilter",
+ "additionalProperties": true,
+ "x-typescript-type": "@loopback/repository#Where"
+ }
+ }
+ }
+ }
+ ],
+ "operationId": "EventController.count"
+ }
+ },
+ "/events/freeBusy": {
+ "get": {
+ "x-controller-name": "EventController",
+ "x-operation-name": "getFeeBusyStatus",
+ "tags": [
+ "EventController"
+ ],
+ "responses": {
+ "200": {
+ "description": "Return value of EventController.getFeeBusyStatus"
+ }
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/FreeBusyRequest"
+ }
+ }
+ }
+ },
+ "operationId": "EventController.getFeeBusyStatus"
+ }
+ },
+ "/events/{id}/attachments": {
+ "post": {
+ "x-controller-name": "EventAttachmentController",
+ "x-operation-name": "create",
+ "tags": [
+ "EventAttachmentController"
+ ],
+ "responses": {
+ "200": {
+ "description": "Event model instance",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Attachment"
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ },
+ "required": true
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NewAttachmentInEvent"
+ }
+ }
+ },
+ "x-parameter-index": 1
+ },
+ "operationId": "EventAttachmentController.create"
+ },
+ "patch": {
+ "x-controller-name": "EventAttachmentController",
+ "x-operation-name": "patch",
+ "tags": [
+ "EventAttachmentController"
+ ],
+ "responses": {
+ "200": {
+ "description": "Event.Attachment PATCH success count",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/loopback.Count"
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ },
+ "required": true
+ },
+ {
+ "name": "where",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "attachments.WhereFilter",
+ "additionalProperties": true,
+ "x-typescript-type": "@loopback/repository#Where"
+ }
+ }
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AttachmentPartial"
+ }
+ }
+ },
+ "x-parameter-index": 1
+ },
+ "operationId": "EventAttachmentController.patch"
+ },
+ "get": {
+ "x-controller-name": "EventAttachmentController",
+ "x-operation-name": "find",
+ "tags": [
+ "EventAttachmentController"
+ ],
+ "responses": {
+ "200": {
+ "description": "Array of Event has many Attachment",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Attachment"
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ },
+ "required": true
+ },
+ {
+ "name": "filter",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": true
+ }
+ }
+ }
+ }
+ ],
+ "operationId": "EventAttachmentController.find"
+ },
+ "delete": {
+ "x-controller-name": "EventAttachmentController",
+ "x-operation-name": "delete",
+ "tags": [
+ "EventAttachmentController"
+ ],
+ "responses": {
+ "200": {
+ "description": "Event.Attachment DELETE success count",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/loopback.Count"
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ },
+ "required": true
+ },
+ {
+ "name": "where",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "attachments.WhereFilter",
+ "additionalProperties": true,
+ "x-typescript-type": "@loopback/repository#Where"
+ }
+ }
+ }
+ }
+ ],
+ "operationId": "EventAttachmentController.delete"
+ }
+ },
+ "/events/{id}/attendees": {
+ "post": {
+ "x-controller-name": "EventAttendeeController",
+ "x-operation-name": "create",
+ "tags": [
+ "EventAttendeeController"
+ ],
+ "responses": {
+ "200": {
+ "description": "Event model instance",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Attendee"
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ },
+ "required": true
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NewAttendeeInEvent"
+ }
+ }
+ },
+ "x-parameter-index": 1
+ },
+ "operationId": "EventAttendeeController.create"
+ },
+ "patch": {
+ "x-controller-name": "EventAttendeeController",
+ "x-operation-name": "patch",
+ "tags": [
+ "EventAttendeeController"
+ ],
+ "responses": {
+ "200": {
+ "description": "Event.Attendee PATCH success count",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/loopback.Count"
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ },
+ "required": true
+ },
+ {
+ "name": "where",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "attendees.WhereFilter",
+ "additionalProperties": true,
+ "x-typescript-type": "@loopback/repository#Where"
+ }
+ }
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AttendeePartial"
+ }
+ }
+ },
+ "x-parameter-index": 1
+ },
+ "operationId": "EventAttendeeController.patch"
+ },
+ "get": {
+ "x-controller-name": "EventAttendeeController",
+ "x-operation-name": "find",
+ "tags": [
+ "EventAttendeeController"
+ ],
+ "responses": {
+ "200": {
+ "description": "Array of Event has many Attendee",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Attendee"
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ },
+ "required": true
+ },
+ {
+ "name": "filter",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": true
+ }
+ }
+ }
+ }
+ ],
+ "operationId": "EventAttendeeController.find"
+ },
+ "delete": {
+ "x-controller-name": "EventAttendeeController",
+ "x-operation-name": "delete",
+ "tags": [
+ "EventAttendeeController"
+ ],
+ "responses": {
+ "200": {
+ "description": "Event.Attendee DELETE success count",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/loopback.Count"
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ },
+ "required": true
+ },
+ {
+ "name": "where",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "attendees.WhereFilter",
+ "additionalProperties": true,
+ "x-typescript-type": "@loopback/repository#Where"
+ }
+ }
+ }
+ }
+ ],
+ "operationId": "EventAttendeeController.delete"
+ }
+ },
+ "/events/{id}": {
+ "put": {
+ "x-controller-name": "EventController",
+ "x-operation-name": "replaceById",
+ "tags": [
+ "EventController"
+ ],
+ "responses": {
+ "204": {
+ "description": "Event PUT success"
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ },
+ "required": true
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Event"
+ }
+ }
+ },
+ "x-parameter-index": 1
+ },
+ "operationId": "EventController.replaceById"
+ },
+ "patch": {
+ "x-controller-name": "EventController",
+ "x-operation-name": "updateById",
+ "tags": [
+ "EventController"
+ ],
+ "responses": {
+ "204": {
+ "description": "Event PATCH success"
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ },
+ "required": true
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/EventPartial"
+ }
+ }
+ },
+ "x-parameter-index": 1
+ },
+ "operationId": "EventController.updateById"
+ },
+ "get": {
+ "x-controller-name": "EventController",
+ "x-operation-name": "findById",
+ "tags": [
+ "EventController"
+ ],
+ "responses": {
+ "200": {
+ "description": "Event model instance",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/EventWithRelations"
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ },
+ "required": true
+ },
+ {
+ "name": "filter",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/events.Filter"
+ }
+ }
+ }
+ }
+ ],
+ "operationId": "EventController.findById"
+ },
+ "delete": {
+ "x-controller-name": "EventController",
+ "x-operation-name": "deleteById",
+ "tags": [
+ "EventController"
+ ],
+ "responses": {
+ "204": {
+ "description": "Event DELETE success"
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ },
+ "required": true
+ }
+ ],
+ "operationId": "EventController.deleteById"
+ }
+ },
+ "/events": {
+ "post": {
+ "x-controller-name": "EventController",
+ "x-operation-name": "create",
+ "tags": [
+ "EventController"
+ ],
+ "responses": {
+ "200": {
+ "description": "Event model instance",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Event"
+ }
+ }
+ }
+ }
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NewEvent"
+ }
+ }
+ }
+ },
+ "operationId": "EventController.create"
+ },
+ "patch": {
+ "x-controller-name": "EventController",
+ "x-operation-name": "updateAll",
+ "tags": [
+ "EventController"
+ ],
+ "responses": {
+ "200": {
+ "description": "Event PATCH success count",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/loopback.Count"
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "where",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "events.WhereFilter",
+ "additionalProperties": true,
+ "x-typescript-type": "@loopback/repository#Where"
+ }
+ }
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/EventPartial"
+ }
+ }
+ }
+ },
+ "operationId": "EventController.updateAll"
+ },
+ "get": {
+ "x-controller-name": "EventController",
+ "x-operation-name": "find",
+ "tags": [
+ "EventController"
+ ],
+ "responses": {
+ "200": {
+ "description": "Array of Event model instances",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/EventWithRelations"
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "filter",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/events_attendees_view.Filter"
+ }
+ }
+ }
+ }
+ ],
+ "operationId": "EventController.find"
+ }
+ },
+ "/settings/count": {
+ "get": {
+ "x-controller-name": "SettingsController",
+ "x-operation-name": "count",
+ "tags": [
+ "SettingsController"
+ ],
+ "responses": {
+ "200": {
+ "description": "Settings model count",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/loopback.Count"
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "where",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "settings.WhereFilter",
+ "additionalProperties": true,
+ "x-typescript-type": "@loopback/repository#Where"
+ }
+ }
+ }
+ }
+ ],
+ "operationId": "SettingsController.count"
+ }
+ },
+ "/settings/{id}": {
+ "put": {
+ "x-controller-name": "SettingsController",
+ "x-operation-name": "replaceById",
+ "tags": [
+ "SettingsController"
+ ],
+ "responses": {
+ "204": {
+ "description": "Settings PUT success"
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ },
+ "required": true
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Settings"
+ }
+ }
+ },
+ "x-parameter-index": 1
+ },
+ "operationId": "SettingsController.replaceById"
+ },
+ "patch": {
+ "x-controller-name": "SettingsController",
+ "x-operation-name": "updateById",
+ "tags": [
+ "SettingsController"
+ ],
+ "responses": {
+ "204": {
+ "description": "Settings PATCH success"
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ },
+ "required": true
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SettingsPartial"
+ }
+ }
+ },
+ "x-parameter-index": 1
+ },
+ "operationId": "SettingsController.updateById"
+ },
+ "get": {
+ "x-controller-name": "SettingsController",
+ "x-operation-name": "findById",
+ "tags": [
+ "SettingsController"
+ ],
+ "responses": {
+ "200": {
+ "description": "Settings model instance",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SettingsWithRelations"
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ },
+ "required": true
+ },
+ {
+ "name": "filter",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/settings.Filter"
+ }
+ }
+ }
+ }
+ ],
+ "operationId": "SettingsController.findById"
+ },
+ "delete": {
+ "x-controller-name": "SettingsController",
+ "x-operation-name": "deleteById",
+ "tags": [
+ "SettingsController"
+ ],
+ "responses": {
+ "204": {
+ "description": "Settings DELETE success"
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ },
+ "required": true
+ }
+ ],
+ "operationId": "SettingsController.deleteById"
+ }
+ },
+ "/settings": {
+ "post": {
+ "x-controller-name": "SettingsController",
+ "x-operation-name": "create",
+ "tags": [
+ "SettingsController"
+ ],
+ "responses": {
+ "200": {
+ "description": "Settings model instance",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Settings"
+ }
+ }
+ }
+ }
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NewSettings"
+ }
+ }
+ }
+ },
+ "operationId": "SettingsController.create"
+ },
+ "patch": {
+ "x-controller-name": "SettingsController",
+ "x-operation-name": "updateAll",
+ "tags": [
+ "SettingsController"
+ ],
+ "responses": {
+ "200": {
+ "description": "Settings PATCH success count",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/loopback.Count"
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "where",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "settings.WhereFilter",
+ "additionalProperties": true,
+ "x-typescript-type": "@loopback/repository#Where"
+ }
+ }
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SettingsPartial"
+ }
+ }
+ }
+ },
+ "operationId": "SettingsController.updateAll"
+ },
+ "get": {
+ "x-controller-name": "SettingsController",
+ "x-operation-name": "find",
+ "tags": [
+ "SettingsController"
+ ],
+ "responses": {
+ "200": {
+ "description": "Array of Settings model instances",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SettingsWithRelations"
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "filter",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/settings.Filter1"
+ }
+ }
+ }
+ }
+ ],
+ "operationId": "SettingsController.find"
+ }
+ },
+ "/subscriptions/count": {
+ "get": {
+ "x-controller-name": "SubscriptionController",
+ "x-operation-name": "count",
+ "tags": [
+ "SubscriptionController"
+ ],
+ "responses": {
+ "200": {
+ "description": "Subscription model count",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/loopback.Count"
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "where",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "subscriptions.WhereFilter",
+ "additionalProperties": true,
+ "x-typescript-type": "@loopback/repository#Where"
+ }
+ }
+ }
+ }
+ ],
+ "operationId": "SubscriptionController.count"
+ }
+ },
+ "/subscriptions/{id}": {
+ "put": {
+ "x-controller-name": "SubscriptionController",
+ "x-operation-name": "replaceById",
+ "tags": [
+ "SubscriptionController"
+ ],
+ "responses": {
+ "204": {
+ "description": "Subscription PUT success"
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ },
+ "required": true
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Subscription"
+ }
+ }
+ },
+ "x-parameter-index": 1
+ },
+ "operationId": "SubscriptionController.replaceById"
+ },
+ "patch": {
+ "x-controller-name": "SubscriptionController",
+ "x-operation-name": "updateById",
+ "tags": [
+ "SubscriptionController"
+ ],
+ "responses": {
+ "204": {
+ "description": "Subscription PATCH success"
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ },
+ "required": true
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SubscriptionPartial"
+ }
+ }
+ },
+ "x-parameter-index": 1
+ },
+ "operationId": "SubscriptionController.updateById"
+ },
+ "get": {
+ "x-controller-name": "SubscriptionController",
+ "x-operation-name": "findById",
+ "tags": [
+ "SubscriptionController"
+ ],
+ "responses": {
+ "200": {
+ "description": "Subscription model instance",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SubscriptionWithRelations"
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ },
+ "required": true
+ },
+ {
+ "name": "filter",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/subscriptions.Filter1"
+ }
+ }
+ }
+ }
+ ],
+ "operationId": "SubscriptionController.findById"
+ },
+ "delete": {
+ "x-controller-name": "SubscriptionController",
+ "x-operation-name": "deleteById",
+ "tags": [
+ "SubscriptionController"
+ ],
+ "responses": {
+ "204": {
+ "description": "Subscription DELETE success"
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ },
+ "required": true
+ }
+ ],
+ "operationId": "SubscriptionController.deleteById"
+ }
+ },
+ "/subscriptions": {
+ "post": {
+ "x-controller-name": "SubscriptionController",
+ "x-operation-name": "create",
+ "tags": [
+ "SubscriptionController"
+ ],
+ "responses": {
+ "200": {
+ "description": "Subscription model instance",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Subscription"
+ }
+ }
+ }
+ }
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NewSubscription"
+ }
+ }
+ }
+ },
+ "operationId": "SubscriptionController.create"
+ },
+ "patch": {
+ "x-controller-name": "SubscriptionController",
+ "x-operation-name": "updateAll",
+ "tags": [
+ "SubscriptionController"
+ ],
+ "responses": {
+ "200": {
+ "description": "Subscription PATCH success count",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/loopback.Count"
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "where",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "subscriptions.WhereFilter",
+ "additionalProperties": true,
+ "x-typescript-type": "@loopback/repository#Where"
+ }
+ }
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/SubscriptionPartial"
+ }
+ }
+ }
+ },
+ "operationId": "SubscriptionController.updateAll"
+ },
+ "get": {
+ "x-controller-name": "SubscriptionController",
+ "x-operation-name": "find",
+ "tags": [
+ "SubscriptionController"
+ ],
+ "responses": {
+ "200": {
+ "description": "Array of Subscription model instances",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SubscriptionWithRelations"
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "filter",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/subscriptions.Filter"
+ }
+ }
+ }
+ }
+ ],
+ "operationId": "SubscriptionController.find"
+ }
+ },
+ "/themes/count": {
+ "get": {
+ "x-controller-name": "ThemeController",
+ "x-operation-name": "count",
+ "tags": [
+ "ThemeController"
+ ],
+ "responses": {
+ "200": {
+ "description": "Theme model count",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/loopback.Count"
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "where",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "themes.WhereFilter",
+ "additionalProperties": true,
+ "x-typescript-type": "@loopback/repository#Where"
+ }
+ }
+ }
+ }
+ ],
+ "operationId": "ThemeController.count"
+ }
+ },
+ "/themes/{id}": {
+ "put": {
+ "x-controller-name": "ThemeController",
+ "x-operation-name": "replaceById",
+ "tags": [
+ "ThemeController"
+ ],
+ "responses": {
+ "204": {
+ "description": "Theme PUT success"
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ },
+ "required": true
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Theme"
+ }
+ }
+ },
+ "x-parameter-index": 1
+ },
+ "operationId": "ThemeController.replaceById"
+ },
+ "patch": {
+ "x-controller-name": "ThemeController",
+ "x-operation-name": "updateById",
+ "tags": [
+ "ThemeController"
+ ],
+ "responses": {
+ "204": {
+ "description": "Theme PATCH success"
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ },
+ "required": true
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ThemePartial"
+ }
+ }
+ },
+ "x-parameter-index": 1
+ },
+ "operationId": "ThemeController.updateById"
+ },
+ "get": {
+ "x-controller-name": "ThemeController",
+ "x-operation-name": "findById",
+ "tags": [
+ "ThemeController"
+ ],
+ "responses": {
+ "200": {
+ "description": "Theme model instance",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ThemeWithRelations"
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ },
+ "required": true
+ },
+ {
+ "name": "filter",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/themes.Filter"
+ }
+ }
+ }
+ }
+ ],
+ "operationId": "ThemeController.findById"
+ },
+ "delete": {
+ "x-controller-name": "ThemeController",
+ "x-operation-name": "deleteById",
+ "tags": [
+ "ThemeController"
+ ],
+ "responses": {
+ "204": {
+ "description": "Theme DELETE success"
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ },
+ "required": true
+ }
+ ],
+ "operationId": "ThemeController.deleteById"
+ }
+ },
+ "/themes": {
+ "post": {
+ "x-controller-name": "ThemeController",
+ "x-operation-name": "create",
+ "tags": [
+ "ThemeController"
+ ],
+ "responses": {
+ "200": {
+ "description": "Theme model instance",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Theme"
+ }
+ }
+ }
+ }
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NewTheme"
+ }
+ }
+ }
+ },
+ "operationId": "ThemeController.create"
+ },
+ "patch": {
+ "x-controller-name": "ThemeController",
+ "x-operation-name": "updateAll",
+ "tags": [
+ "ThemeController"
+ ],
+ "responses": {
+ "200": {
+ "description": "Theme PATCH success count",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/loopback.Count"
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "where",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "themes.WhereFilter",
+ "additionalProperties": true,
+ "x-typescript-type": "@loopback/repository#Where"
+ }
+ }
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ThemePartial"
+ }
+ }
+ }
+ },
+ "operationId": "ThemeController.updateAll"
+ },
+ "get": {
+ "x-controller-name": "ThemeController",
+ "x-operation-name": "find",
+ "tags": [
+ "ThemeController"
+ ],
+ "responses": {
+ "200": {
+ "description": "Array of Theme model instances",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ThemeWithRelations"
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "filter",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/themes.Filter1"
+ }
+ }
+ }
+ }
+ ],
+ "operationId": "ThemeController.find"
+ }
+ },
+ "/working-hours/count": {
+ "get": {
+ "x-controller-name": "WorkingHourController",
+ "x-operation-name": "count",
+ "tags": [
+ "WorkingHourController"
+ ],
+ "responses": {
+ "200": {
+ "description": "WorkingHour model count",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/loopback.Count"
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "where",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "working_hours.WhereFilter",
+ "additionalProperties": true,
+ "x-typescript-type": "@loopback/repository#Where"
+ }
+ }
+ }
+ }
+ ],
+ "operationId": "WorkingHourController.count"
+ }
+ },
+ "/working-hours/{id}": {
+ "put": {
+ "x-controller-name": "WorkingHourController",
+ "x-operation-name": "replaceById",
+ "tags": [
+ "WorkingHourController"
+ ],
+ "responses": {
+ "204": {
+ "description": "WorkingHour PUT success"
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ },
+ "required": true
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/WorkingHour"
+ }
+ }
+ },
+ "x-parameter-index": 1
+ },
+ "operationId": "WorkingHourController.replaceById"
+ },
+ "patch": {
+ "x-controller-name": "WorkingHourController",
+ "x-operation-name": "updateById",
+ "tags": [
+ "WorkingHourController"
+ ],
+ "responses": {
+ "204": {
+ "description": "WorkingHour PATCH success"
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ },
+ "required": true
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/WorkingHourPartial"
+ }
+ }
+ },
+ "x-parameter-index": 1
+ },
+ "operationId": "WorkingHourController.updateById"
+ },
+ "get": {
+ "x-controller-name": "WorkingHourController",
+ "x-operation-name": "findById",
+ "tags": [
+ "WorkingHourController"
+ ],
+ "responses": {
+ "200": {
+ "description": "WorkingHour model instance",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/WorkingHourWithRelations"
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ },
+ "required": true
+ },
+ {
+ "name": "filter",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/working_hours.Filter"
+ }
+ }
+ }
+ }
+ ],
+ "operationId": "WorkingHourController.findById"
+ },
+ "delete": {
+ "x-controller-name": "WorkingHourController",
+ "x-operation-name": "deleteById",
+ "tags": [
+ "WorkingHourController"
+ ],
+ "responses": {
+ "204": {
+ "description": "WorkingHour DELETE success"
+ }
+ },
+ "parameters": [
+ {
+ "name": "id",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ },
+ "required": true
+ }
+ ],
+ "operationId": "WorkingHourController.deleteById"
+ }
+ },
+ "/working-hours": {
+ "post": {
+ "x-controller-name": "WorkingHourController",
+ "x-operation-name": "create",
+ "tags": [
+ "WorkingHourController"
+ ],
+ "responses": {
+ "200": {
+ "description": "WorkingHour model instance",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/WorkingHour"
+ }
+ }
+ }
+ }
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/NewWorkingHour"
+ }
+ }
+ }
+ },
+ "operationId": "WorkingHourController.create"
+ },
+ "patch": {
+ "x-controller-name": "WorkingHourController",
+ "x-operation-name": "updateAll",
+ "tags": [
+ "WorkingHourController"
+ ],
+ "responses": {
+ "200": {
+ "description": "WorkingHour PATCH success count",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/loopback.Count"
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "where",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "title": "working_hours.WhereFilter",
+ "additionalProperties": true,
+ "x-typescript-type": "@loopback/repository#Where"
+ }
+ }
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/WorkingHourPartial"
+ }
+ }
+ }
+ },
+ "operationId": "WorkingHourController.updateAll"
+ },
+ "get": {
+ "x-controller-name": "WorkingHourController",
+ "x-operation-name": "find",
+ "tags": [
+ "WorkingHourController"
+ ],
+ "responses": {
+ "200": {
+ "description": "Array of WorkingHour model instances",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/WorkingHourWithRelations"
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "filter",
+ "in": "query",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/working_hours.Filter1"
+ }
+ }
+ }
+ }
+ ],
+ "operationId": "WorkingHourController.find"
+ }
+ }
+ },
+ "components": {
+ "securitySchemes": {
+ "HTTPBearer": {
+ "type": "http",
+ "scheme": "bearer",
+ "bearerFormat": "JWT"
+ }
+ },
+ "schemas": {
+ "Attachment": {
+ "title": "Attachment",
+ "type": "object",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "deletedOn": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "deletedBy": {
+ "type": "string",
+ "nullable": true
+ },
+ "createdOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "modifiedOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "createdBy": {
+ "type": "string"
+ },
+ "modifiedBy": {
+ "type": "string"
+ },
+ "id": {
+ "type": "string"
+ },
+ "fileUrl": {
+ "type": "string"
+ },
+ "iconLink": {
+ "type": "string"
+ },
+ "mimeType": {
+ "type": "string",
+ "maxLength": 200
+ },
+ "title": {
+ "type": "string",
+ "maxLength": 400
+ },
+ "eventId": {
+ "type": "string"
+ },
+ "extId": {
+ "type": "string"
+ },
+ "extMetadata": {
+ "type": "object"
+ }
+ },
+ "required": [
+ "fileUrl",
+ "eventId"
+ ],
+ "additionalProperties": false
+ },
+ "NewAttachment": {
+ "title": "NewAttachment",
+ "type": "object",
+ "description": "(tsType: Omit, schemaOptions: { title: 'NewAttachment', exclude: [ 'id' ] })",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "deletedOn": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "deletedBy": {
+ "type": "string",
+ "nullable": true
+ },
+ "createdOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "modifiedOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "createdBy": {
+ "type": "string"
+ },
+ "modifiedBy": {
+ "type": "string"
+ },
+ "fileUrl": {
+ "type": "string"
+ },
+ "iconLink": {
+ "type": "string"
+ },
+ "mimeType": {
+ "type": "string",
+ "maxLength": 200
+ },
+ "title": {
+ "type": "string",
+ "maxLength": 400
+ },
+ "eventId": {
+ "type": "string"
+ },
+ "extId": {
+ "type": "string"
+ },
+ "extMetadata": {
+ "type": "object"
+ }
+ },
+ "required": [
+ "fileUrl",
+ "eventId"
+ ],
+ "additionalProperties": false,
+ "x-typescript-type": "Omit"
+ },
+ "AttendeeWithRelations": {
+ "title": "AttendeeWithRelations",
+ "type": "object",
+ "description": "(tsType: AttendeeWithRelations, schemaOptions: { includeRelations: true })",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "deletedOn": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "deletedBy": {
+ "type": "string",
+ "nullable": true
+ },
+ "createdOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "modifiedOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "createdBy": {
+ "type": "string"
+ },
+ "modifiedBy": {
+ "type": "string"
+ },
+ "id": {
+ "type": "string"
+ },
+ "identifier": {
+ "type": "string",
+ "maxLength": 200
+ },
+ "isOptional": {
+ "type": "boolean"
+ },
+ "isOrganizer": {
+ "type": "boolean"
+ },
+ "messages": {
+ "type": "string"
+ },
+ "responseStatus": {
+ "type": "string",
+ "enum": [
+ "needsAction",
+ "tentative",
+ "accepted",
+ "declined"
+ ]
+ },
+ "eventId": {
+ "type": "string"
+ },
+ "extId": {
+ "type": "string"
+ },
+ "extMetadata": {
+ "type": "object"
+ },
+ "event": {
+ "$ref": "#/components/schemas/EventWithRelations"
+ }
+ },
+ "required": [
+ "identifier",
+ "eventId"
+ ],
+ "additionalProperties": false,
+ "x-typescript-type": "AttendeeWithRelations"
+ },
+ "EventWithRelations": {
+ "title": "EventWithRelations",
+ "type": "object",
+ "description": "(tsType: EventWithRelations, schemaOptions: { includeRelations: true })",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "deletedOn": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "deletedBy": {
+ "type": "string",
+ "nullable": true
+ },
+ "createdOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "modifiedOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "createdBy": {
+ "type": "string"
+ },
+ "modifiedBy": {
+ "type": "string"
+ },
+ "id": {
+ "type": "string"
+ },
+ "bgColor": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "endDateTime": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "fgColor": {
+ "type": "string"
+ },
+ "iCalUid": {
+ "type": "string"
+ },
+ "isFullDayEvent": {
+ "type": "boolean"
+ },
+ "isLocked": {
+ "type": "boolean"
+ },
+ "link": {
+ "type": "string"
+ },
+ "location": {
+ "type": "string",
+ "maxLength": 300
+ },
+ "meetingLink": {
+ "type": "string"
+ },
+ "identifier": {
+ "type": "string",
+ "maxLength": 200
+ },
+ "startDateTime": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "status": {
+ "type": "string",
+ "enum": [
+ "confirmed",
+ "tentative",
+ "cancelled",
+ "completed"
+ ]
+ },
+ "summary": {
+ "type": "string"
+ },
+ "timezone": {
+ "type": "string"
+ },
+ "calendarId": {
+ "type": "string"
+ },
+ "parentEventId": {
+ "type": "string"
+ },
+ "extId": {
+ "type": "string"
+ },
+ "extMetadata": {
+ "type": "object"
+ },
+ "calendar": {
+ "$ref": "#/components/schemas/CalendarWithRelations"
+ },
+ "parentEvent": {
+ "$ref": "#/components/schemas/EventWithRelations"
+ },
+ "attendees": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/AttendeeWithRelations"
+ }
+ },
+ "attachments": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/AttachmentWithRelations"
+ }
+ }
+ },
+ "required": [
+ "calendarId"
+ ],
+ "additionalProperties": false,
+ "x-typescript-type": "EventWithRelations"
+ },
+ "AttachmentWithRelations": {
+ "title": "AttachmentWithRelations",
+ "type": "object",
+ "description": "(tsType: AttachmentWithRelations, schemaOptions: { includeRelations: true })",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "deletedOn": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "deletedBy": {
+ "type": "string",
+ "nullable": true
+ },
+ "createdOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "modifiedOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "createdBy": {
+ "type": "string"
+ },
+ "modifiedBy": {
+ "type": "string"
+ },
+ "id": {
+ "type": "string"
+ },
+ "fileUrl": {
+ "type": "string"
+ },
+ "iconLink": {
+ "type": "string"
+ },
+ "mimeType": {
+ "type": "string",
+ "maxLength": 200
+ },
+ "title": {
+ "type": "string",
+ "maxLength": 400
+ },
+ "eventId": {
+ "type": "string"
+ },
+ "extId": {
+ "type": "string"
+ },
+ "extMetadata": {
+ "type": "object"
+ },
+ "event": {
+ "$ref": "#/components/schemas/EventWithRelations"
+ }
+ },
+ "required": [
+ "fileUrl",
+ "eventId"
+ ],
+ "additionalProperties": false,
+ "x-typescript-type": "AttachmentWithRelations"
+ },
+ "AttachmentPartial": {
+ "title": "AttachmentPartial",
+ "type": "object",
+ "description": "(tsType: Partial, schemaOptions: { partial: true })",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "deletedOn": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "deletedBy": {
+ "type": "string",
+ "nullable": true
+ },
+ "createdOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "modifiedOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "createdBy": {
+ "type": "string"
+ },
+ "modifiedBy": {
+ "type": "string"
+ },
+ "id": {
+ "type": "string"
+ },
+ "fileUrl": {
+ "type": "string"
+ },
+ "iconLink": {
+ "type": "string"
+ },
+ "mimeType": {
+ "type": "string",
+ "maxLength": 200
+ },
+ "title": {
+ "type": "string",
+ "maxLength": 400
+ },
+ "eventId": {
+ "type": "string"
+ },
+ "extId": {
+ "type": "string"
+ },
+ "extMetadata": {
+ "type": "object"
+ }
+ },
+ "additionalProperties": false,
+ "x-typescript-type": "Partial"
+ },
+ "Attendee": {
+ "title": "Attendee",
+ "type": "object",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "deletedOn": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "deletedBy": {
+ "type": "string",
+ "nullable": true
+ },
+ "createdOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "modifiedOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "createdBy": {
+ "type": "string"
+ },
+ "modifiedBy": {
+ "type": "string"
+ },
+ "id": {
+ "type": "string"
+ },
+ "identifier": {
+ "type": "string",
+ "maxLength": 200
+ },
+ "isOptional": {
+ "type": "boolean"
+ },
+ "isOrganizer": {
+ "type": "boolean"
+ },
+ "messages": {
+ "type": "string"
+ },
+ "responseStatus": {
+ "type": "string",
+ "enum": [
+ "needsAction",
+ "tentative",
+ "accepted",
+ "declined"
+ ]
+ },
+ "eventId": {
+ "type": "string"
+ },
+ "extId": {
+ "type": "string"
+ },
+ "extMetadata": {
+ "type": "object"
+ }
+ },
+ "required": [
+ "identifier",
+ "eventId"
+ ],
+ "additionalProperties": false
+ },
+ "NewAttendee": {
+ "title": "NewAttendee",
+ "type": "object",
+ "description": "(tsType: Omit, schemaOptions: { title: 'NewAttendee', exclude: [ 'id' ] })",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "deletedOn": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "deletedBy": {
+ "type": "string",
+ "nullable": true
+ },
+ "createdOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "modifiedOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "createdBy": {
+ "type": "string"
+ },
+ "modifiedBy": {
+ "type": "string"
+ },
+ "identifier": {
+ "type": "string",
+ "maxLength": 200
+ },
+ "isOptional": {
+ "type": "boolean"
+ },
+ "isOrganizer": {
+ "type": "boolean"
+ },
+ "messages": {
+ "type": "string"
+ },
+ "responseStatus": {
+ "type": "string",
+ "enum": [
+ "needsAction",
+ "tentative",
+ "accepted",
+ "declined"
+ ]
+ },
+ "eventId": {
+ "type": "string"
+ },
+ "extId": {
+ "type": "string"
+ },
+ "extMetadata": {
+ "type": "object"
+ }
+ },
+ "required": [
+ "identifier",
+ "eventId"
+ ],
+ "additionalProperties": false,
+ "x-typescript-type": "Omit"
+ },
+ "AttendeePartial": {
+ "title": "AttendeePartial",
+ "type": "object",
+ "description": "(tsType: Partial, schemaOptions: { partial: true })",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "deletedOn": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "deletedBy": {
+ "type": "string",
+ "nullable": true
+ },
+ "createdOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "modifiedOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "createdBy": {
+ "type": "string"
+ },
+ "modifiedBy": {
+ "type": "string"
+ },
+ "id": {
+ "type": "string"
+ },
+ "identifier": {
+ "type": "string",
+ "maxLength": 200
+ },
+ "isOptional": {
+ "type": "boolean"
+ },
+ "isOrganizer": {
+ "type": "boolean"
+ },
+ "messages": {
+ "type": "string"
+ },
+ "responseStatus": {
+ "type": "string",
+ "enum": [
+ "needsAction",
+ "tentative",
+ "accepted",
+ "declined"
+ ]
+ },
+ "eventId": {
+ "type": "string"
+ },
+ "extId": {
+ "type": "string"
+ },
+ "extMetadata": {
+ "type": "object"
+ }
+ },
+ "additionalProperties": false,
+ "x-typescript-type": "Partial"
+ },
+ "Calendar": {
+ "title": "Calendar",
+ "type": "object",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "deletedOn": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "deletedBy": {
+ "type": "string",
+ "nullable": true
+ },
+ "createdOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "modifiedOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "createdBy": {
+ "type": "string"
+ },
+ "modifiedBy": {
+ "type": "string"
+ },
+ "id": {
+ "type": "string"
+ },
+ "source": {
+ "type": "string"
+ },
+ "enableWorkingHours": {
+ "type": "boolean"
+ },
+ "location": {
+ "type": "string",
+ "maxLength": 300
+ },
+ "identifier": {
+ "type": "string",
+ "maxLength": 200
+ },
+ "summary": {
+ "type": "string",
+ "maxLength": 100
+ },
+ "timezone": {
+ "type": "string",
+ "maxLength": 120
+ },
+ "extId": {
+ "type": "string"
+ },
+ "extMetadata": {
+ "type": "object"
+ }
+ },
+ "required": [
+ "identifier"
+ ],
+ "additionalProperties": false
+ },
+ "WorkingHourExcluding_id_": {
+ "title": "WorkingHourExcluding_id_",
+ "type": "object",
+ "description": "(tsType: Omit, schemaOptions: { exclude: [ 'id' ] })",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "deletedOn": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "deletedBy": {
+ "type": "string",
+ "nullable": true
+ },
+ "createdOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "modifiedOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "createdBy": {
+ "type": "string"
+ },
+ "modifiedBy": {
+ "type": "string"
+ },
+ "dayOfWeek": {
+ "type": "number",
+ "enum": [
+ 0,
+ 1,
+ 2,
+ 3,
+ 4,
+ 5,
+ 6
+ ]
+ },
+ "end": {
+ "type": "string"
+ },
+ "start": {
+ "type": "string"
+ },
+ "calendarId": {
+ "type": "string"
+ },
+ "extId": {
+ "type": "string"
+ },
+ "extMetadata": {
+ "type": "object"
+ }
+ },
+ "required": [
+ "calendarId"
+ ],
+ "additionalProperties": false,
+ "x-typescript-type": "Omit"
+ },
+ "NewCalendar": {
+ "title": "NewCalendar",
+ "type": "object",
+ "description": "(tsType: Omit, schemaOptions: { title: 'NewCalendar', exclude: [ 'id' ] })",
+ "properties": {
+ "source": {
+ "type": "string"
+ },
+ "enableWorkingHours": {
+ "type": "boolean"
+ },
+ "location": {
+ "type": "string",
+ "maxLength": 300
+ },
+ "identifier": {
+ "type": "string",
+ "maxLength": 200
+ },
+ "summary": {
+ "type": "string",
+ "maxLength": 100
+ },
+ "timezone": {
+ "type": "string",
+ "maxLength": 120
+ },
+ "extId": {
+ "type": "string"
+ },
+ "extMetadata": {
+ "type": "object"
+ },
+ "workingHours": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/WorkingHourExcluding_id_"
+ }
+ },
+ "subscription": {
+ "type": "object"
+ }
+ },
+ "required": [
+ "identifier"
+ ],
+ "additionalProperties": false,
+ "x-typescript-type": "Omit"
+ },
+ "WorkingHour": {
+ "title": "WorkingHour",
+ "type": "object",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "deletedOn": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "deletedBy": {
+ "type": "string",
+ "nullable": true
+ },
+ "createdOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "modifiedOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "createdBy": {
+ "type": "string"
+ },
+ "modifiedBy": {
+ "type": "string"
+ },
+ "id": {
+ "type": "string"
+ },
+ "dayOfWeek": {
+ "type": "number",
+ "enum": [
+ 0,
+ 1,
+ 2,
+ 3,
+ 4,
+ 5,
+ 6
+ ]
+ },
+ "end": {
+ "type": "string"
+ },
+ "start": {
+ "type": "string"
+ },
+ "calendarId": {
+ "type": "string"
+ },
+ "extId": {
+ "type": "string"
+ },
+ "extMetadata": {
+ "type": "object"
+ }
+ },
+ "required": [
+ "calendarId"
+ ],
+ "additionalProperties": false
+ },
+ "CalendarDTO": {
+ "title": "CalendarDTO",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "source": {
+ "type": "string"
+ },
+ "enableWorkingHours": {
+ "type": "boolean"
+ },
+ "location": {
+ "type": "string",
+ "maxLength": 300
+ },
+ "identifier": {
+ "type": "string",
+ "maxLength": 200
+ },
+ "summary": {
+ "type": "string",
+ "maxLength": 100
+ },
+ "timezone": {
+ "type": "string",
+ "maxLength": 120
+ },
+ "extId": {
+ "type": "string"
+ },
+ "extMetadata": {
+ "type": "object"
+ },
+ "workingHours": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/WorkingHour"
+ }
+ },
+ "subscription": {
+ "type": "object"
+ }
+ },
+ "required": [
+ "identifier"
+ ],
+ "additionalProperties": false
+ },
+ "CalendarWithRelations": {
+ "title": "CalendarWithRelations",
+ "type": "object",
+ "description": "(tsType: CalendarWithRelations, schemaOptions: { includeRelations: true })",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "deletedOn": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "deletedBy": {
+ "type": "string",
+ "nullable": true
+ },
+ "createdOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "modifiedOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "createdBy": {
+ "type": "string"
+ },
+ "modifiedBy": {
+ "type": "string"
+ },
+ "id": {
+ "type": "string"
+ },
+ "source": {
+ "type": "string"
+ },
+ "enableWorkingHours": {
+ "type": "boolean"
+ },
+ "location": {
+ "type": "string",
+ "maxLength": 300
+ },
+ "identifier": {
+ "type": "string",
+ "maxLength": 200
+ },
+ "summary": {
+ "type": "string",
+ "maxLength": 100
+ },
+ "timezone": {
+ "type": "string",
+ "maxLength": 120
+ },
+ "extId": {
+ "type": "string"
+ },
+ "extMetadata": {
+ "type": "object"
+ },
+ "events": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/EventWithRelations"
+ }
+ },
+ "workingHours": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/WorkingHourWithRelations"
+ }
+ },
+ "subscriptions": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SubscriptionWithRelations"
+ }
+ }
+ },
+ "required": [
+ "identifier"
+ ],
+ "additionalProperties": false,
+ "x-typescript-type": "CalendarWithRelations"
+ },
+ "CalendarPartial": {
+ "title": "CalendarPartial",
+ "type": "object",
+ "description": "(tsType: Partial, schemaOptions: { partial: true })",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "deletedOn": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "deletedBy": {
+ "type": "string",
+ "nullable": true
+ },
+ "createdOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "modifiedOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "createdBy": {
+ "type": "string"
+ },
+ "modifiedBy": {
+ "type": "string"
+ },
+ "id": {
+ "type": "string"
+ },
+ "source": {
+ "type": "string"
+ },
+ "enableWorkingHours": {
+ "type": "boolean"
+ },
+ "location": {
+ "type": "string",
+ "maxLength": 300
+ },
+ "identifier": {
+ "type": "string",
+ "maxLength": 200
+ },
+ "summary": {
+ "type": "string",
+ "maxLength": 100
+ },
+ "timezone": {
+ "type": "string",
+ "maxLength": 120
+ },
+ "extId": {
+ "type": "string"
+ },
+ "extMetadata": {
+ "type": "object"
+ }
+ },
+ "additionalProperties": false,
+ "x-typescript-type": "Partial"
+ },
+ "Event": {
+ "title": "Event",
+ "type": "object",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "deletedOn": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "deletedBy": {
+ "type": "string",
+ "nullable": true
+ },
+ "createdOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "modifiedOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "createdBy": {
+ "type": "string"
+ },
+ "modifiedBy": {
+ "type": "string"
+ },
+ "id": {
+ "type": "string"
+ },
+ "bgColor": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "endDateTime": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "fgColor": {
+ "type": "string"
+ },
+ "iCalUid": {
+ "type": "string"
+ },
+ "isFullDayEvent": {
+ "type": "boolean"
+ },
+ "isLocked": {
+ "type": "boolean"
+ },
+ "link": {
+ "type": "string"
+ },
+ "location": {
+ "type": "string",
+ "maxLength": 300
+ },
+ "meetingLink": {
+ "type": "string"
+ },
+ "identifier": {
+ "type": "string",
+ "maxLength": 200
+ },
+ "startDateTime": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "status": {
+ "type": "string",
+ "enum": [
+ "confirmed",
+ "tentative",
+ "cancelled",
+ "completed"
+ ]
+ },
+ "summary": {
+ "type": "string"
+ },
+ "timezone": {
+ "type": "string"
+ },
+ "calendarId": {
+ "type": "string"
+ },
+ "parentEventId": {
+ "type": "string"
+ },
+ "extId": {
+ "type": "string"
+ },
+ "extMetadata": {
+ "type": "object"
+ }
+ },
+ "required": [
+ "calendarId"
+ ],
+ "additionalProperties": false
+ },
+ "AttachmentExcluding_id_": {
+ "title": "AttachmentExcluding_id_",
+ "type": "object",
+ "description": "(tsType: Omit, schemaOptions: { exclude: [ 'id' ] })",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "deletedOn": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "deletedBy": {
+ "type": "string",
+ "nullable": true
+ },
+ "createdOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "modifiedOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "createdBy": {
+ "type": "string"
+ },
+ "modifiedBy": {
+ "type": "string"
+ },
+ "fileUrl": {
+ "type": "string"
+ },
+ "iconLink": {
+ "type": "string"
+ },
+ "mimeType": {
+ "type": "string",
+ "maxLength": 200
+ },
+ "title": {
+ "type": "string",
+ "maxLength": 400
+ },
+ "eventId": {
+ "type": "string"
+ },
+ "extId": {
+ "type": "string"
+ },
+ "extMetadata": {
+ "type": "object"
+ }
+ },
+ "required": [
+ "fileUrl",
+ "eventId"
+ ],
+ "additionalProperties": false,
+ "x-typescript-type": "Omit"
+ },
+ "AttendeeExcluding_id_": {
+ "title": "AttendeeExcluding_id_",
+ "type": "object",
+ "description": "(tsType: Omit, schemaOptions: { exclude: [ 'id' ] })",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "deletedOn": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "deletedBy": {
+ "type": "string",
+ "nullable": true
+ },
+ "createdOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "modifiedOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "createdBy": {
+ "type": "string"
+ },
+ "modifiedBy": {
+ "type": "string"
+ },
+ "identifier": {
+ "type": "string",
+ "maxLength": 200
+ },
+ "isOptional": {
+ "type": "boolean"
+ },
+ "isOrganizer": {
+ "type": "boolean"
+ },
+ "messages": {
+ "type": "string"
+ },
+ "responseStatus": {
+ "type": "string",
+ "enum": [
+ "needsAction",
+ "tentative",
+ "accepted",
+ "declined"
+ ]
+ },
+ "eventId": {
+ "type": "string"
+ },
+ "extId": {
+ "type": "string"
+ },
+ "extMetadata": {
+ "type": "object"
+ }
+ },
+ "required": [
+ "identifier",
+ "eventId"
+ ],
+ "additionalProperties": false,
+ "x-typescript-type": "Omit"
+ },
+ "NewEvent": {
+ "title": "NewEvent",
+ "type": "object",
+ "description": "(tsType: Omit, schemaOptions: { title: 'NewEvent', exclude: [ 'id' ] })",
+ "properties": {
+ "bgColor": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "endDateTime": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "fgColor": {
+ "type": "string"
+ },
+ "iCalUid": {
+ "type": "string"
+ },
+ "isFullDayEvent": {
+ "type": "boolean"
+ },
+ "isLocked": {
+ "type": "boolean"
+ },
+ "link": {
+ "type": "string"
+ },
+ "location": {
+ "type": "string",
+ "maxLength": 300
+ },
+ "meetingLink": {
+ "type": "string"
+ },
+ "identifier": {
+ "type": "string",
+ "maxLength": 200
+ },
+ "startDateTime": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "status": {
+ "type": "string",
+ "enum": [
+ "confirmed",
+ "tentative",
+ "cancelled",
+ "completed"
+ ]
+ },
+ "summary": {
+ "type": "string"
+ },
+ "timezone": {
+ "type": "string"
+ },
+ "calendarId": {
+ "type": "string"
+ },
+ "parentEventId": {
+ "type": "string"
+ },
+ "attachments": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/AttachmentExcluding_id_"
+ }
+ },
+ "attendees": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/AttendeeExcluding_id_"
+ }
+ },
+ "extId": {
+ "type": "string"
+ },
+ "extMetadata": {
+ "type": "object"
+ }
+ },
+ "required": [
+ "calendarId"
+ ],
+ "additionalProperties": false,
+ "x-typescript-type": "Omit"
+ },
+ "EventAttendeeViewItemDTO": {
+ "title": "EventAttendeeViewItemDTO",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "bgColor": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "endDateTime": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "extId": {
+ "type": "string"
+ },
+ "extMetadata": {
+ "type": "object"
+ },
+ "fgColor": {
+ "type": "string"
+ },
+ "iCalUid": {
+ "type": "string"
+ },
+ "isFullDayEvent": {
+ "type": "boolean"
+ },
+ "isLocked": {
+ "type": "boolean"
+ },
+ "link": {
+ "type": "string"
+ },
+ "location": {
+ "type": "string",
+ "maxLength": 300
+ },
+ "meetingLink": {
+ "type": "string"
+ },
+ "identifier": {
+ "type": "string",
+ "maxLength": 200
+ },
+ "startDateTime": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "status": {
+ "type": "string",
+ "enum": [
+ "confirmed",
+ "tentative",
+ "cancelled",
+ "completed"
+ ]
+ },
+ "summary": {
+ "type": "string"
+ },
+ "timezone": {
+ "type": "string"
+ },
+ "attendeeId": {
+ "type": "string"
+ },
+ "isOptional": {
+ "type": "boolean"
+ },
+ "attendeeIdentifier": {
+ "type": "string"
+ },
+ "isOrganizer": {
+ "type": "boolean"
+ },
+ "messages": {
+ "type": "string"
+ },
+ "eventId": {
+ "type": "string"
+ }
+ },
+ "additionalProperties": false
+ },
+ "FreeBusyRequest": {
+ "title": "FreeBusyRequest",
+ "type": "object",
+ "description": "(tsType: FreeBusyDTO, schemaOptions: { title: 'FreeBusyRequest' })",
+ "properties": {
+ "timeMax": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "timeMin": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "items": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/EventAttendeeViewItemDTO"
+ }
+ }
+ },
+ "required": [
+ "timeMax",
+ "timeMin"
+ ],
+ "additionalProperties": false,
+ "x-typescript-type": "FreeBusyDTO"
+ },
+ "FreeBusyDTO": {
+ "title": "FreeBusyDTO",
+ "type": "object",
+ "properties": {
+ "timeMax": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "timeMin": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "items": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/EventAttendeeViewItemDTO"
+ }
+ }
+ },
+ "required": [
+ "timeMax",
+ "timeMin"
+ ],
+ "additionalProperties": false
+ },
+ "EventPartial": {
+ "title": "EventPartial",
+ "type": "object",
+ "description": "(tsType: Partial, schemaOptions: { partial: true })",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "deletedOn": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "deletedBy": {
+ "type": "string",
+ "nullable": true
+ },
+ "createdOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "modifiedOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "createdBy": {
+ "type": "string"
+ },
+ "modifiedBy": {
+ "type": "string"
+ },
+ "id": {
+ "type": "string"
+ },
+ "bgColor": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "endDateTime": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "fgColor": {
+ "type": "string"
+ },
+ "iCalUid": {
+ "type": "string"
+ },
+ "isFullDayEvent": {
+ "type": "boolean"
+ },
+ "isLocked": {
+ "type": "boolean"
+ },
+ "link": {
+ "type": "string"
+ },
+ "location": {
+ "type": "string",
+ "maxLength": 300
+ },
+ "meetingLink": {
+ "type": "string"
+ },
+ "identifier": {
+ "type": "string",
+ "maxLength": 200
+ },
+ "startDateTime": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "status": {
+ "type": "string",
+ "enum": [
+ "confirmed",
+ "tentative",
+ "cancelled",
+ "completed"
+ ]
+ },
+ "summary": {
+ "type": "string"
+ },
+ "timezone": {
+ "type": "string"
+ },
+ "calendarId": {
+ "type": "string"
+ },
+ "parentEventId": {
+ "type": "string"
+ },
+ "extId": {
+ "type": "string"
+ },
+ "extMetadata": {
+ "type": "object"
+ }
+ },
+ "additionalProperties": false,
+ "x-typescript-type": "Partial"
+ },
+ "Settings": {
+ "title": "Settings",
+ "type": "object",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "deletedOn": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "deletedBy": {
+ "type": "string",
+ "nullable": true
+ },
+ "createdOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "modifiedOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "createdBy": {
+ "type": "string"
+ },
+ "modifiedBy": {
+ "type": "string"
+ },
+ "id": {
+ "type": "string"
+ },
+ "ownerId": {
+ "type": "string",
+ "maxLength": 225
+ },
+ "ownerType": {
+ "type": "string",
+ "enum": [
+ "global",
+ "user",
+ "calendar",
+ "event"
+ ]
+ },
+ "settingName": {
+ "type": "string",
+ "maxLength": 225
+ },
+ "settingValue": {
+ "type": "string",
+ "maxLength": 1500
+ },
+ "extId": {
+ "type": "string"
+ },
+ "extMetadata": {
+ "type": "object"
+ }
+ },
+ "required": [
+ "ownerId"
+ ],
+ "additionalProperties": false
+ },
+ "NewSettings": {
+ "title": "NewSettings",
+ "type": "object",
+ "description": "(tsType: Omit, schemaOptions: { title: 'NewSettings', exclude: [ 'id' ] })",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "deletedOn": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "deletedBy": {
+ "type": "string",
+ "nullable": true
+ },
+ "createdOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "modifiedOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "createdBy": {
+ "type": "string"
+ },
+ "modifiedBy": {
+ "type": "string"
+ },
+ "ownerId": {
+ "type": "string",
+ "maxLength": 225
+ },
+ "ownerType": {
+ "type": "string",
+ "enum": [
+ "global",
+ "user",
+ "calendar",
+ "event"
+ ]
+ },
+ "settingName": {
+ "type": "string",
+ "maxLength": 225
+ },
+ "settingValue": {
+ "type": "string",
+ "maxLength": 1500
+ },
+ "extId": {
+ "type": "string"
+ },
+ "extMetadata": {
+ "type": "object"
+ }
+ },
+ "required": [
+ "ownerId"
+ ],
+ "additionalProperties": false,
+ "x-typescript-type": "Omit"
+ },
+ "SettingsWithRelations": {
+ "title": "SettingsWithRelations",
+ "type": "object",
+ "description": "(tsType: SettingsWithRelations, schemaOptions: { includeRelations: true })",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "deletedOn": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "deletedBy": {
+ "type": "string",
+ "nullable": true
+ },
+ "createdOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "modifiedOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "createdBy": {
+ "type": "string"
+ },
+ "modifiedBy": {
+ "type": "string"
+ },
+ "id": {
+ "type": "string"
+ },
+ "ownerId": {
+ "type": "string",
+ "maxLength": 225
+ },
+ "ownerType": {
+ "type": "string",
+ "enum": [
+ "global",
+ "user",
+ "calendar",
+ "event"
+ ]
+ },
+ "settingName": {
+ "type": "string",
+ "maxLength": 225
+ },
+ "settingValue": {
+ "type": "string",
+ "maxLength": 1500
+ },
+ "extId": {
+ "type": "string"
+ },
+ "extMetadata": {
+ "type": "object"
+ }
+ },
+ "required": [
+ "ownerId"
+ ],
+ "additionalProperties": false,
+ "x-typescript-type": "SettingsWithRelations"
+ },
+ "SettingsPartial": {
+ "title": "SettingsPartial",
+ "type": "object",
+ "description": "(tsType: Partial, schemaOptions: { partial: true })",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "deletedOn": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "deletedBy": {
+ "type": "string",
+ "nullable": true
+ },
+ "createdOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "modifiedOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "createdBy": {
+ "type": "string"
+ },
+ "modifiedBy": {
+ "type": "string"
+ },
+ "id": {
+ "type": "string"
+ },
+ "ownerId": {
+ "type": "string",
+ "maxLength": 225
+ },
+ "ownerType": {
+ "type": "string",
+ "enum": [
+ "global",
+ "user",
+ "calendar",
+ "event"
+ ]
+ },
+ "settingName": {
+ "type": "string",
+ "maxLength": 225
+ },
+ "settingValue": {
+ "type": "string",
+ "maxLength": 1500
+ },
+ "extId": {
+ "type": "string"
+ },
+ "extMetadata": {
+ "type": "object"
+ }
+ },
+ "additionalProperties": false,
+ "x-typescript-type": "Partial"
+ },
+ "Subscription": {
+ "title": "Subscription",
+ "type": "object",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "deletedOn": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "deletedBy": {
+ "type": "string",
+ "nullable": true
+ },
+ "createdOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "modifiedOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "createdBy": {
+ "type": "string"
+ },
+ "modifiedBy": {
+ "type": "string"
+ },
+ "id": {
+ "type": "string"
+ },
+ "accessRole": {
+ "type": "string",
+ "enum": [
+ "freeBusyReader",
+ "reader",
+ "writer",
+ "owner"
+ ]
+ },
+ "bgColor": {
+ "type": "string"
+ },
+ "fgColor": {
+ "type": "string"
+ },
+ "isHidden": {
+ "type": "boolean"
+ },
+ "isPrimary": {
+ "type": "boolean"
+ },
+ "identifier": {
+ "type": "string"
+ },
+ "defaultReminders": {
+ "type": "object"
+ },
+ "notificationSettings": {
+ "type": "object"
+ },
+ "calendarId": {
+ "type": "string"
+ },
+ "extId": {
+ "type": "string"
+ },
+ "extMetadata": {
+ "type": "object"
+ }
+ },
+ "required": [
+ "identifier",
+ "calendarId"
+ ],
+ "additionalProperties": false
+ },
+ "NewSubscription": {
+ "title": "NewSubscription",
+ "type": "object",
+ "description": "(tsType: Omit, schemaOptions: { title: 'NewSubscription', exclude: [ 'id' ] })",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "deletedOn": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "deletedBy": {
+ "type": "string",
+ "nullable": true
+ },
+ "createdOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "modifiedOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "createdBy": {
+ "type": "string"
+ },
+ "modifiedBy": {
+ "type": "string"
+ },
+ "accessRole": {
+ "type": "string",
+ "enum": [
+ "freeBusyReader",
+ "reader",
+ "writer",
+ "owner"
+ ]
+ },
+ "bgColor": {
+ "type": "string"
+ },
+ "fgColor": {
+ "type": "string"
+ },
+ "isHidden": {
+ "type": "boolean"
+ },
+ "isPrimary": {
+ "type": "boolean"
+ },
+ "identifier": {
+ "type": "string"
+ },
+ "defaultReminders": {
+ "type": "object"
+ },
+ "notificationSettings": {
+ "type": "object"
+ },
+ "calendarId": {
+ "type": "string"
+ },
+ "extId": {
+ "type": "string"
+ },
+ "extMetadata": {
+ "type": "object"
+ }
+ },
+ "required": [
+ "identifier",
+ "calendarId"
+ ],
+ "additionalProperties": false,
+ "x-typescript-type": "Omit"
+ },
+ "SubscriptionWithRelations": {
+ "title": "SubscriptionWithRelations",
+ "type": "object",
+ "description": "(tsType: SubscriptionWithRelations, schemaOptions: { includeRelations: true })",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "deletedOn": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "deletedBy": {
+ "type": "string",
+ "nullable": true
+ },
+ "createdOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "modifiedOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "createdBy": {
+ "type": "string"
+ },
+ "modifiedBy": {
+ "type": "string"
+ },
+ "id": {
+ "type": "string"
+ },
+ "accessRole": {
+ "type": "string",
+ "enum": [
+ "freeBusyReader",
+ "reader",
+ "writer",
+ "owner"
+ ]
+ },
+ "bgColor": {
+ "type": "string"
+ },
+ "fgColor": {
+ "type": "string"
+ },
+ "isHidden": {
+ "type": "boolean"
+ },
+ "isPrimary": {
+ "type": "boolean"
+ },
+ "identifier": {
+ "type": "string"
+ },
+ "defaultReminders": {
+ "type": "object"
+ },
+ "notificationSettings": {
+ "type": "object"
+ },
+ "calendarId": {
+ "type": "string"
+ },
+ "extId": {
+ "type": "string"
+ },
+ "extMetadata": {
+ "type": "object"
+ },
+ "calendar": {
+ "$ref": "#/components/schemas/CalendarWithRelations"
+ }
+ },
+ "required": [
+ "identifier",
+ "calendarId"
+ ],
+ "additionalProperties": false,
+ "x-typescript-type": "SubscriptionWithRelations"
+ },
+ "SubscriptionPartial": {
+ "title": "SubscriptionPartial",
+ "type": "object",
+ "description": "(tsType: Partial, schemaOptions: { partial: true })",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "deletedOn": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "deletedBy": {
+ "type": "string",
+ "nullable": true
+ },
+ "createdOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "modifiedOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "createdBy": {
+ "type": "string"
+ },
+ "modifiedBy": {
+ "type": "string"
+ },
+ "id": {
+ "type": "string"
+ },
+ "accessRole": {
+ "type": "string",
+ "enum": [
+ "freeBusyReader",
+ "reader",
+ "writer",
+ "owner"
+ ]
+ },
+ "bgColor": {
+ "type": "string"
+ },
+ "fgColor": {
+ "type": "string"
+ },
+ "isHidden": {
+ "type": "boolean"
+ },
+ "isPrimary": {
+ "type": "boolean"
+ },
+ "identifier": {
+ "type": "string"
+ },
+ "defaultReminders": {
+ "type": "object"
+ },
+ "notificationSettings": {
+ "type": "object"
+ },
+ "calendarId": {
+ "type": "string"
+ },
+ "extId": {
+ "type": "string"
+ },
+ "extMetadata": {
+ "type": "object"
+ }
+ },
+ "additionalProperties": false,
+ "x-typescript-type": "Partial"
+ },
+ "Theme": {
+ "title": "Theme",
+ "type": "object",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "deletedOn": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "deletedBy": {
+ "type": "string",
+ "nullable": true
+ },
+ "createdOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "modifiedOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "createdBy": {
+ "type": "string"
+ },
+ "modifiedBy": {
+ "type": "string"
+ },
+ "id": {
+ "type": "string"
+ },
+ "calBg": {
+ "type": "string",
+ "maxLength": 200
+ },
+ "calFg": {
+ "type": "string",
+ "maxLength": 200
+ },
+ "eventBg": {
+ "type": "string",
+ "maxLength": 200
+ },
+ "eventFg": {
+ "type": "string",
+ "maxLength": 200
+ },
+ "extId": {
+ "type": "string"
+ },
+ "extMetadata": {
+ "type": "object"
+ }
+ },
+ "additionalProperties": false
+ },
+ "NewTheme": {
+ "title": "NewTheme",
+ "type": "object",
+ "description": "(tsType: Omit, schemaOptions: { title: 'NewTheme', exclude: [ 'id' ] })",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "deletedOn": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "deletedBy": {
+ "type": "string",
+ "nullable": true
+ },
+ "createdOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "modifiedOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "createdBy": {
+ "type": "string"
+ },
+ "modifiedBy": {
+ "type": "string"
+ },
+ "calBg": {
+ "type": "string",
+ "maxLength": 200
+ },
+ "calFg": {
+ "type": "string",
+ "maxLength": 200
+ },
+ "eventBg": {
+ "type": "string",
+ "maxLength": 200
+ },
+ "eventFg": {
+ "type": "string",
+ "maxLength": 200
+ },
+ "extId": {
+ "type": "string"
+ },
+ "extMetadata": {
+ "type": "object"
+ }
+ },
+ "additionalProperties": false,
+ "x-typescript-type": "Omit"
+ },
+ "ThemeWithRelations": {
+ "title": "ThemeWithRelations",
+ "type": "object",
+ "description": "(tsType: ThemeWithRelations, schemaOptions: { includeRelations: true })",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "deletedOn": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "deletedBy": {
+ "type": "string",
+ "nullable": true
+ },
+ "createdOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "modifiedOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "createdBy": {
+ "type": "string"
+ },
+ "modifiedBy": {
+ "type": "string"
+ },
+ "id": {
+ "type": "string"
+ },
+ "calBg": {
+ "type": "string",
+ "maxLength": 200
+ },
+ "calFg": {
+ "type": "string",
+ "maxLength": 200
+ },
+ "eventBg": {
+ "type": "string",
+ "maxLength": 200
+ },
+ "eventFg": {
+ "type": "string",
+ "maxLength": 200
+ },
+ "extId": {
+ "type": "string"
+ },
+ "extMetadata": {
+ "type": "object"
+ }
+ },
+ "additionalProperties": false,
+ "x-typescript-type": "ThemeWithRelations"
+ },
+ "ThemePartial": {
+ "title": "ThemePartial",
+ "type": "object",
+ "description": "(tsType: Partial, schemaOptions: { partial: true })",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "deletedOn": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "deletedBy": {
+ "type": "string",
+ "nullable": true
+ },
+ "createdOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "modifiedOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "createdBy": {
+ "type": "string"
+ },
+ "modifiedBy": {
+ "type": "string"
+ },
+ "id": {
+ "type": "string"
+ },
+ "calBg": {
+ "type": "string",
+ "maxLength": 200
+ },
+ "calFg": {
+ "type": "string",
+ "maxLength": 200
+ },
+ "eventBg": {
+ "type": "string",
+ "maxLength": 200
+ },
+ "eventFg": {
+ "type": "string",
+ "maxLength": 200
+ },
+ "extId": {
+ "type": "string"
+ },
+ "extMetadata": {
+ "type": "object"
+ }
+ },
+ "additionalProperties": false,
+ "x-typescript-type": "Partial"
+ },
+ "NewWorkingHour": {
+ "title": "NewWorkingHour",
+ "type": "object",
+ "description": "(tsType: Omit, schemaOptions: { title: 'NewWorkingHour', exclude: [ 'id' ] })",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "deletedOn": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "deletedBy": {
+ "type": "string",
+ "nullable": true
+ },
+ "createdOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "modifiedOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "createdBy": {
+ "type": "string"
+ },
+ "modifiedBy": {
+ "type": "string"
+ },
+ "dayOfWeek": {
+ "type": "number",
+ "enum": [
+ 0,
+ 1,
+ 2,
+ 3,
+ 4,
+ 5,
+ 6
+ ]
+ },
+ "end": {
+ "type": "string"
+ },
+ "start": {
+ "type": "string"
+ },
+ "calendarId": {
+ "type": "string"
+ },
+ "extId": {
+ "type": "string"
+ },
+ "extMetadata": {
+ "type": "object"
+ }
+ },
+ "required": [
+ "calendarId"
+ ],
+ "additionalProperties": false,
+ "x-typescript-type": "Omit"
+ },
+ "WorkingHourWithRelations": {
+ "title": "WorkingHourWithRelations",
+ "type": "object",
+ "description": "(tsType: WorkingHourWithRelations, schemaOptions: { includeRelations: true })",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "deletedOn": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "deletedBy": {
+ "type": "string",
+ "nullable": true
+ },
+ "createdOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "modifiedOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "createdBy": {
+ "type": "string"
+ },
+ "modifiedBy": {
+ "type": "string"
+ },
+ "id": {
+ "type": "string"
+ },
+ "dayOfWeek": {
+ "type": "number",
+ "enum": [
+ 0,
+ 1,
+ 2,
+ 3,
+ 4,
+ 5,
+ 6
+ ]
+ },
+ "end": {
+ "type": "string"
+ },
+ "start": {
+ "type": "string"
+ },
+ "calendarId": {
+ "type": "string"
+ },
+ "extId": {
+ "type": "string"
+ },
+ "extMetadata": {
+ "type": "object"
+ },
+ "calendar": {
+ "$ref": "#/components/schemas/CalendarWithRelations"
+ }
+ },
+ "required": [
+ "calendarId"
+ ],
+ "additionalProperties": false,
+ "x-typescript-type": "WorkingHourWithRelations"
+ },
+ "WorkingHourPartial": {
+ "title": "WorkingHourPartial",
+ "type": "object",
+ "description": "(tsType: Partial, schemaOptions: { partial: true })",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "deletedOn": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "deletedBy": {
+ "type": "string",
+ "nullable": true
+ },
+ "createdOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "modifiedOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "createdBy": {
+ "type": "string"
+ },
+ "modifiedBy": {
+ "type": "string"
+ },
+ "id": {
+ "type": "string"
+ },
+ "dayOfWeek": {
+ "type": "number",
+ "enum": [
+ 0,
+ 1,
+ 2,
+ 3,
+ 4,
+ 5,
+ 6
+ ]
+ },
+ "end": {
+ "type": "string"
+ },
+ "start": {
+ "type": "string"
+ },
+ "calendarId": {
+ "type": "string"
+ },
+ "extId": {
+ "type": "string"
+ },
+ "extMetadata": {
+ "type": "object"
+ }
+ },
+ "additionalProperties": false,
+ "x-typescript-type": "Partial"
+ },
+ "Date": {},
+ "NewEventInCalendar": {
+ "title": "NewEventInCalendar",
+ "type": "object",
+ "description": "(tsType: @loopback/repository-json-schema#Optional, 'calendarId'>, schemaOptions: { title: 'NewEventInCalendar', exclude: [ 'id' ], optional: [ 'calendarId' ] })",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "deletedOn": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "deletedBy": {
+ "type": "string",
+ "nullable": true
+ },
+ "createdOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "modifiedOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "createdBy": {
+ "type": "string"
+ },
+ "modifiedBy": {
+ "type": "string"
+ },
+ "bgColor": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "endDateTime": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "fgColor": {
+ "type": "string"
+ },
+ "iCalUid": {
+ "type": "string"
+ },
+ "isFullDayEvent": {
+ "type": "boolean"
+ },
+ "isLocked": {
+ "type": "boolean"
+ },
+ "link": {
+ "type": "string"
+ },
+ "location": {
+ "type": "string",
+ "maxLength": 300
+ },
+ "meetingLink": {
+ "type": "string"
+ },
+ "identifier": {
+ "type": "string",
+ "maxLength": 200
+ },
+ "startDateTime": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "status": {
+ "type": "string",
+ "enum": [
+ "confirmed",
+ "tentative",
+ "cancelled",
+ "completed"
+ ]
+ },
+ "summary": {
+ "type": "string"
+ },
+ "timezone": {
+ "type": "string"
+ },
+ "calendarId": {
+ "type": "string"
+ },
+ "parentEventId": {
+ "type": "string"
+ },
+ "extId": {
+ "type": "string"
+ },
+ "extMetadata": {
+ "type": "object"
+ }
+ },
+ "additionalProperties": false,
+ "x-typescript-type": "@loopback/repository-json-schema#Optional, 'calendarId'>"
+ },
+ "NewSubscriptionInCalendar": {
+ "title": "NewSubscriptionInCalendar",
+ "type": "object",
+ "description": "(tsType: @loopback/repository-json-schema#Optional, 'calendarId'>, schemaOptions: { title: 'NewSubscriptionInCalendar', exclude: [ 'id' ], optional: [ 'calendarId' ] })",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "deletedOn": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "deletedBy": {
+ "type": "string",
+ "nullable": true
+ },
+ "createdOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "modifiedOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "createdBy": {
+ "type": "string"
+ },
+ "modifiedBy": {
+ "type": "string"
+ },
+ "accessRole": {
+ "type": "string",
+ "enum": [
+ "freeBusyReader",
+ "reader",
+ "writer",
+ "owner"
+ ]
+ },
+ "bgColor": {
+ "type": "string"
+ },
+ "fgColor": {
+ "type": "string"
+ },
+ "isHidden": {
+ "type": "boolean"
+ },
+ "isPrimary": {
+ "type": "boolean"
+ },
+ "identifier": {
+ "type": "string"
+ },
+ "defaultReminders": {
+ "type": "object"
+ },
+ "notificationSettings": {
+ "type": "object"
+ },
+ "calendarId": {
+ "type": "string"
+ },
+ "extId": {
+ "type": "string"
+ },
+ "extMetadata": {
+ "type": "object"
+ }
+ },
+ "required": [
+ "identifier"
+ ],
+ "additionalProperties": false,
+ "x-typescript-type": "@loopback/repository-json-schema#Optional, 'calendarId'>"
+ },
+ "NewWorkingHourInCalendar": {
+ "title": "NewWorkingHourInCalendar",
+ "type": "object",
+ "description": "(tsType: @loopback/repository-json-schema#Optional, 'calendarId'>, schemaOptions: { title: 'NewWorkingHourInCalendar', exclude: [ 'id' ], optional: [ 'calendarId' ] })",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "deletedOn": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "deletedBy": {
+ "type": "string",
+ "nullable": true
+ },
+ "createdOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "modifiedOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "createdBy": {
+ "type": "string"
+ },
+ "modifiedBy": {
+ "type": "string"
+ },
+ "dayOfWeek": {
+ "type": "number",
+ "enum": [
+ 0,
+ 1,
+ 2,
+ 3,
+ 4,
+ 5,
+ 6
+ ]
+ },
+ "end": {
+ "type": "string"
+ },
+ "start": {
+ "type": "string"
+ },
+ "calendarId": {
+ "type": "string"
+ },
+ "extId": {
+ "type": "string"
+ },
+ "extMetadata": {
+ "type": "object"
+ }
+ },
+ "additionalProperties": false,
+ "x-typescript-type": "@loopback/repository-json-schema#Optional, 'calendarId'>"
+ },
+ "NewAttachmentInEvent": {
+ "title": "NewAttachmentInEvent",
+ "type": "object",
+ "description": "(tsType: @loopback/repository-json-schema#Optional, 'eventId'>, schemaOptions: { title: 'NewAttachmentInEvent', exclude: [ 'id' ], optional: [ 'eventId' ] })",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "deletedOn": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "deletedBy": {
+ "type": "string",
+ "nullable": true
+ },
+ "createdOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "modifiedOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "createdBy": {
+ "type": "string"
+ },
+ "modifiedBy": {
+ "type": "string"
+ },
+ "fileUrl": {
+ "type": "string"
+ },
+ "iconLink": {
+ "type": "string"
+ },
+ "mimeType": {
+ "type": "string",
+ "maxLength": 200
+ },
+ "title": {
+ "type": "string",
+ "maxLength": 400
+ },
+ "eventId": {
+ "type": "string"
+ },
+ "extId": {
+ "type": "string"
+ },
+ "extMetadata": {
+ "type": "object"
+ }
+ },
+ "required": [
+ "fileUrl"
+ ],
+ "additionalProperties": false,
+ "x-typescript-type": "@loopback/repository-json-schema#Optional, 'eventId'>"
+ },
+ "NewAttendeeInEvent": {
+ "title": "NewAttendeeInEvent",
+ "type": "object",
+ "description": "(tsType: @loopback/repository-json-schema#Optional, 'eventId'>, schemaOptions: { title: 'NewAttendeeInEvent', exclude: [ 'id' ], optional: [ 'eventId' ] })",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "deletedOn": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "deletedBy": {
+ "type": "string",
+ "nullable": true
+ },
+ "createdOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "modifiedOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "createdBy": {
+ "type": "string"
+ },
+ "modifiedBy": {
+ "type": "string"
+ },
+ "identifier": {
+ "type": "string",
+ "maxLength": 200
+ },
+ "isOptional": {
+ "type": "boolean"
+ },
+ "isOrganizer": {
+ "type": "boolean"
+ },
+ "messages": {
+ "type": "string"
+ },
+ "responseStatus": {
+ "type": "string",
+ "enum": [
+ "needsAction",
+ "tentative",
+ "accepted",
+ "declined"
+ ]
+ },
+ "eventId": {
+ "type": "string"
+ },
+ "extId": {
+ "type": "string"
+ },
+ "extMetadata": {
+ "type": "object"
+ }
+ },
+ "required": [
+ "identifier"
+ ],
+ "additionalProperties": false,
+ "x-typescript-type": "@loopback/repository-json-schema#Optional, 'eventId'>"
+ },
+ "loopback.Count": {
+ "type": "object",
+ "title": "loopback.Count",
+ "x-typescript-type": "@loopback/repository#Count",
+ "properties": {
+ "count": {
+ "type": "number"
+ }
+ }
+ },
+ "attachments.ScopeFilter": {
+ "properties": {
+ "offset": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "limit": {
+ "type": "integer",
+ "minimum": 1,
+ "example": 100
+ },
+ "skip": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "order": {
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "where": {
+ "type": "object",
+ "additionalProperties": true
+ },
+ "fields": {
+ "oneOf": [
+ {
+ "type": "object",
+ "properties": {},
+ "additionalProperties": true
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "uniqueItems": true
+ }
+ ]
+ },
+ "include": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {},
+ "additionalProperties": true
+ }
+ }
+ },
+ "additionalProperties": false,
+ "title": "attachments.ScopeFilter"
+ },
+ "attachments.IncludeFilter.Items": {
+ "title": "attachments.IncludeFilter.Items",
+ "type": "object",
+ "properties": {
+ "relation": {
+ "type": "string"
+ },
+ "scope": {
+ "$ref": "#/components/schemas/attachments.ScopeFilter"
+ }
+ }
+ },
+ "attachments.Filter": {
+ "type": "object",
+ "title": "attachments.Filter",
+ "properties": {
+ "offset": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "limit": {
+ "type": "integer",
+ "minimum": 1,
+ "example": 100
+ },
+ "skip": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "order": {
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "fields": {
+ "oneOf": [
+ {
+ "type": "object",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "deletedOn": {
+ "type": "boolean"
+ },
+ "deletedBy": {
+ "type": "boolean"
+ },
+ "createdOn": {
+ "type": "boolean"
+ },
+ "modifiedOn": {
+ "type": "boolean"
+ },
+ "createdBy": {
+ "type": "boolean"
+ },
+ "modifiedBy": {
+ "type": "boolean"
+ },
+ "id": {
+ "type": "boolean"
+ },
+ "fileUrl": {
+ "type": "boolean"
+ },
+ "iconLink": {
+ "type": "boolean"
+ },
+ "mimeType": {
+ "type": "boolean"
+ },
+ "title": {
+ "type": "boolean"
+ },
+ "eventId": {
+ "type": "boolean"
+ },
+ "extId": {
+ "type": "boolean"
+ },
+ "extMetadata": {
+ "type": "boolean"
+ }
+ },
+ "additionalProperties": false
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": [
+ "deleted",
+ "deletedOn",
+ "deletedBy",
+ "createdOn",
+ "modifiedOn",
+ "createdBy",
+ "modifiedBy",
+ "id",
+ "fileUrl",
+ "iconLink",
+ "mimeType",
+ "title",
+ "eventId",
+ "extId",
+ "extMetadata"
+ ],
+ "example": "deleted"
+ },
+ "uniqueItems": true
+ }
+ ],
+ "title": "attachments.Fields"
+ },
+ "include": {
+ "title": "attachments.IncludeFilter",
+ "type": "array",
+ "items": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/attachments.IncludeFilter.Items"
+ },
+ {
+ "type": "string"
+ }
+ ]
+ }
+ }
+ },
+ "additionalProperties": false,
+ "x-typescript-type": "@loopback/repository#Filter"
+ },
+ "attachments.Filter1": {
+ "type": "object",
+ "title": "attachments.Filter",
+ "properties": {
+ "offset": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "limit": {
+ "type": "integer",
+ "minimum": 1,
+ "example": 100
+ },
+ "skip": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "order": {
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "where": {
+ "title": "attachments.WhereFilter",
+ "type": "object",
+ "additionalProperties": true
+ },
+ "fields": {
+ "oneOf": [
+ {
+ "type": "object",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "deletedOn": {
+ "type": "boolean"
+ },
+ "deletedBy": {
+ "type": "boolean"
+ },
+ "createdOn": {
+ "type": "boolean"
+ },
+ "modifiedOn": {
+ "type": "boolean"
+ },
+ "createdBy": {
+ "type": "boolean"
+ },
+ "modifiedBy": {
+ "type": "boolean"
+ },
+ "id": {
+ "type": "boolean"
+ },
+ "fileUrl": {
+ "type": "boolean"
+ },
+ "iconLink": {
+ "type": "boolean"
+ },
+ "mimeType": {
+ "type": "boolean"
+ },
+ "title": {
+ "type": "boolean"
+ },
+ "eventId": {
+ "type": "boolean"
+ },
+ "extId": {
+ "type": "boolean"
+ },
+ "extMetadata": {
+ "type": "boolean"
+ }
+ },
+ "additionalProperties": false
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": [
+ "deleted",
+ "deletedOn",
+ "deletedBy",
+ "createdOn",
+ "modifiedOn",
+ "createdBy",
+ "modifiedBy",
+ "id",
+ "fileUrl",
+ "iconLink",
+ "mimeType",
+ "title",
+ "eventId",
+ "extId",
+ "extMetadata"
+ ],
+ "example": "deleted"
+ },
+ "uniqueItems": true
+ }
+ ],
+ "title": "attachments.Fields"
+ },
+ "include": {
+ "title": "attachments.IncludeFilter",
+ "type": "array",
+ "items": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/attachments.IncludeFilter.Items"
+ },
+ {
+ "type": "string"
+ }
+ ]
+ }
+ }
+ },
+ "additionalProperties": false,
+ "x-typescript-type": "@loopback/repository#Filter"
+ },
+ "attendees.ScopeFilter": {
+ "properties": {
+ "offset": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "limit": {
+ "type": "integer",
+ "minimum": 1,
+ "example": 100
+ },
+ "skip": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "order": {
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "where": {
+ "type": "object",
+ "additionalProperties": true
+ },
+ "fields": {
+ "oneOf": [
+ {
+ "type": "object",
+ "properties": {},
+ "additionalProperties": true
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "uniqueItems": true
+ }
+ ]
+ },
+ "include": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {},
+ "additionalProperties": true
+ }
+ }
+ },
+ "additionalProperties": false,
+ "title": "attendees.ScopeFilter"
+ },
+ "attendees.IncludeFilter.Items": {
+ "title": "attendees.IncludeFilter.Items",
+ "type": "object",
+ "properties": {
+ "relation": {
+ "type": "string"
+ },
+ "scope": {
+ "$ref": "#/components/schemas/attendees.ScopeFilter"
+ }
+ }
+ },
+ "attendees.Filter": {
+ "type": "object",
+ "title": "attendees.Filter",
+ "properties": {
+ "offset": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "limit": {
+ "type": "integer",
+ "minimum": 1,
+ "example": 100
+ },
+ "skip": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "order": {
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "fields": {
+ "oneOf": [
+ {
+ "type": "object",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "deletedOn": {
+ "type": "boolean"
+ },
+ "deletedBy": {
+ "type": "boolean"
+ },
+ "createdOn": {
+ "type": "boolean"
+ },
+ "modifiedOn": {
+ "type": "boolean"
+ },
+ "createdBy": {
+ "type": "boolean"
+ },
+ "modifiedBy": {
+ "type": "boolean"
+ },
+ "id": {
+ "type": "boolean"
+ },
+ "identifier": {
+ "type": "boolean"
+ },
+ "isOptional": {
+ "type": "boolean"
+ },
+ "isOrganizer": {
+ "type": "boolean"
+ },
+ "messages": {
+ "type": "boolean"
+ },
+ "responseStatus": {
+ "type": "boolean"
+ },
+ "eventId": {
+ "type": "boolean"
+ },
+ "extId": {
+ "type": "boolean"
+ },
+ "extMetadata": {
+ "type": "boolean"
+ }
+ },
+ "additionalProperties": false
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": [
+ "deleted",
+ "deletedOn",
+ "deletedBy",
+ "createdOn",
+ "modifiedOn",
+ "createdBy",
+ "modifiedBy",
+ "id",
+ "identifier",
+ "isOptional",
+ "isOrganizer",
+ "messages",
+ "responseStatus",
+ "eventId",
+ "extId",
+ "extMetadata"
+ ],
+ "example": "deleted"
+ },
+ "uniqueItems": true
+ }
+ ],
+ "title": "attendees.Fields"
+ },
+ "include": {
+ "title": "attendees.IncludeFilter",
+ "type": "array",
+ "items": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/attendees.IncludeFilter.Items"
+ },
+ {
+ "type": "string"
+ }
+ ]
+ }
+ }
+ },
+ "additionalProperties": false,
+ "x-typescript-type": "@loopback/repository#Filter"
+ },
+ "attendees.Filter1": {
+ "type": "object",
+ "title": "attendees.Filter",
+ "properties": {
+ "offset": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "limit": {
+ "type": "integer",
+ "minimum": 1,
+ "example": 100
+ },
+ "skip": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "order": {
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "where": {
+ "title": "attendees.WhereFilter",
+ "type": "object",
+ "additionalProperties": true
+ },
+ "fields": {
+ "oneOf": [
+ {
+ "type": "object",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "deletedOn": {
+ "type": "boolean"
+ },
+ "deletedBy": {
+ "type": "boolean"
+ },
+ "createdOn": {
+ "type": "boolean"
+ },
+ "modifiedOn": {
+ "type": "boolean"
+ },
+ "createdBy": {
+ "type": "boolean"
+ },
+ "modifiedBy": {
+ "type": "boolean"
+ },
+ "id": {
+ "type": "boolean"
+ },
+ "identifier": {
+ "type": "boolean"
+ },
+ "isOptional": {
+ "type": "boolean"
+ },
+ "isOrganizer": {
+ "type": "boolean"
+ },
+ "messages": {
+ "type": "boolean"
+ },
+ "responseStatus": {
+ "type": "boolean"
+ },
+ "eventId": {
+ "type": "boolean"
+ },
+ "extId": {
+ "type": "boolean"
+ },
+ "extMetadata": {
+ "type": "boolean"
+ }
+ },
+ "additionalProperties": false
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": [
+ "deleted",
+ "deletedOn",
+ "deletedBy",
+ "createdOn",
+ "modifiedOn",
+ "createdBy",
+ "modifiedBy",
+ "id",
+ "identifier",
+ "isOptional",
+ "isOrganizer",
+ "messages",
+ "responseStatus",
+ "eventId",
+ "extId",
+ "extMetadata"
+ ],
+ "example": "deleted"
+ },
+ "uniqueItems": true
+ }
+ ],
+ "title": "attendees.Fields"
+ },
+ "include": {
+ "title": "attendees.IncludeFilter",
+ "type": "array",
+ "items": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/attendees.IncludeFilter.Items"
+ },
+ {
+ "type": "string"
+ }
+ ]
+ }
+ }
+ },
+ "additionalProperties": false,
+ "x-typescript-type": "@loopback/repository#Filter"
+ },
+ "subscriptions.ScopeFilter": {
+ "properties": {
+ "offset": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "limit": {
+ "type": "integer",
+ "minimum": 1,
+ "example": 100
+ },
+ "skip": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "order": {
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "where": {
+ "type": "object",
+ "additionalProperties": true
+ },
+ "fields": {
+ "oneOf": [
+ {
+ "type": "object",
+ "properties": {},
+ "additionalProperties": true
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "uniqueItems": true
+ }
+ ]
+ },
+ "include": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {},
+ "additionalProperties": true
+ }
+ }
+ },
+ "additionalProperties": false,
+ "title": "subscriptions.ScopeFilter"
+ },
+ "subscriptions.IncludeFilter.Items": {
+ "title": "subscriptions.IncludeFilter.Items",
+ "type": "object",
+ "properties": {
+ "relation": {
+ "type": "string"
+ },
+ "scope": {
+ "$ref": "#/components/schemas/subscriptions.ScopeFilter"
+ }
+ }
+ },
+ "subscriptions.Filter": {
+ "type": "object",
+ "title": "subscriptions.Filter",
+ "properties": {
+ "offset": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "limit": {
+ "type": "integer",
+ "minimum": 1,
+ "example": 100
+ },
+ "skip": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "order": {
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "where": {
+ "title": "subscriptions.WhereFilter",
+ "type": "object",
+ "additionalProperties": true
+ },
+ "fields": {
+ "oneOf": [
+ {
+ "type": "object",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "deletedOn": {
+ "type": "boolean"
+ },
+ "deletedBy": {
+ "type": "boolean"
+ },
+ "createdOn": {
+ "type": "boolean"
+ },
+ "modifiedOn": {
+ "type": "boolean"
+ },
+ "createdBy": {
+ "type": "boolean"
+ },
+ "modifiedBy": {
+ "type": "boolean"
+ },
+ "id": {
+ "type": "boolean"
+ },
+ "accessRole": {
+ "type": "boolean"
+ },
+ "bgColor": {
+ "type": "boolean"
+ },
+ "fgColor": {
+ "type": "boolean"
+ },
+ "isHidden": {
+ "type": "boolean"
+ },
+ "isPrimary": {
+ "type": "boolean"
+ },
+ "identifier": {
+ "type": "boolean"
+ },
+ "defaultReminders": {
+ "type": "boolean"
+ },
+ "notificationSettings": {
+ "type": "boolean"
+ },
+ "calendarId": {
+ "type": "boolean"
+ },
+ "extId": {
+ "type": "boolean"
+ },
+ "extMetadata": {
+ "type": "boolean"
+ }
+ },
+ "additionalProperties": false
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": [
+ "deleted",
+ "deletedOn",
+ "deletedBy",
+ "createdOn",
+ "modifiedOn",
+ "createdBy",
+ "modifiedBy",
+ "id",
+ "accessRole",
+ "bgColor",
+ "fgColor",
+ "isHidden",
+ "isPrimary",
+ "identifier",
+ "defaultReminders",
+ "notificationSettings",
+ "calendarId",
+ "extId",
+ "extMetadata"
+ ],
+ "example": "deleted"
+ },
+ "uniqueItems": true
+ }
+ ],
+ "title": "subscriptions.Fields"
+ },
+ "include": {
+ "title": "subscriptions.IncludeFilter",
+ "type": "array",
+ "items": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/subscriptions.IncludeFilter.Items"
+ },
+ {
+ "type": "string"
+ }
+ ]
+ }
+ }
+ },
+ "additionalProperties": false,
+ "x-typescript-type": "@loopback/repository#Filter"
+ },
+ "calendars.ScopeFilter": {
+ "properties": {
+ "offset": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "limit": {
+ "type": "integer",
+ "minimum": 1,
+ "example": 100
+ },
+ "skip": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "order": {
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "where": {
+ "type": "object",
+ "additionalProperties": true
+ },
+ "fields": {
+ "oneOf": [
+ {
+ "type": "object",
+ "properties": {},
+ "additionalProperties": true
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "uniqueItems": true
+ }
+ ]
+ },
+ "include": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {},
+ "additionalProperties": true
+ }
+ }
+ },
+ "additionalProperties": false,
+ "title": "calendars.ScopeFilter"
+ },
+ "calendars.IncludeFilter.Items": {
+ "title": "calendars.IncludeFilter.Items",
+ "type": "object",
+ "properties": {
+ "relation": {
+ "type": "string"
+ },
+ "scope": {
+ "$ref": "#/components/schemas/calendars.ScopeFilter"
+ }
+ }
+ },
+ "calendars.Filter": {
+ "type": "object",
+ "title": "calendars.Filter",
+ "properties": {
+ "offset": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "limit": {
+ "type": "integer",
+ "minimum": 1,
+ "example": 100
+ },
+ "skip": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "order": {
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "fields": {
+ "oneOf": [
+ {
+ "type": "object",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "deletedOn": {
+ "type": "boolean"
+ },
+ "deletedBy": {
+ "type": "boolean"
+ },
+ "createdOn": {
+ "type": "boolean"
+ },
+ "modifiedOn": {
+ "type": "boolean"
+ },
+ "createdBy": {
+ "type": "boolean"
+ },
+ "modifiedBy": {
+ "type": "boolean"
+ },
+ "id": {
+ "type": "boolean"
+ },
+ "source": {
+ "type": "boolean"
+ },
+ "enableWorkingHours": {
+ "type": "boolean"
+ },
+ "location": {
+ "type": "boolean"
+ },
+ "identifier": {
+ "type": "boolean"
+ },
+ "summary": {
+ "type": "boolean"
+ },
+ "timezone": {
+ "type": "boolean"
+ },
+ "extId": {
+ "type": "boolean"
+ },
+ "extMetadata": {
+ "type": "boolean"
+ }
+ },
+ "additionalProperties": false
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": [
+ "deleted",
+ "deletedOn",
+ "deletedBy",
+ "createdOn",
+ "modifiedOn",
+ "createdBy",
+ "modifiedBy",
+ "id",
+ "source",
+ "enableWorkingHours",
+ "location",
+ "identifier",
+ "summary",
+ "timezone",
+ "extId",
+ "extMetadata"
+ ],
+ "example": "deleted"
+ },
+ "uniqueItems": true
+ }
+ ],
+ "title": "calendars.Fields"
+ },
+ "include": {
+ "title": "calendars.IncludeFilter",
+ "type": "array",
+ "items": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/calendars.IncludeFilter.Items"
+ },
+ {
+ "type": "string"
+ }
+ ]
+ }
+ }
+ },
+ "additionalProperties": false,
+ "x-typescript-type": "@loopback/repository#Filter"
+ },
+ "calendars.Filter1": {
+ "type": "object",
+ "title": "calendars.Filter",
+ "properties": {
+ "offset": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "limit": {
+ "type": "integer",
+ "minimum": 1,
+ "example": 100
+ },
+ "skip": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "order": {
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "where": {
+ "title": "calendars.WhereFilter",
+ "type": "object",
+ "additionalProperties": true
+ },
+ "fields": {
+ "oneOf": [
+ {
+ "type": "object",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "deletedOn": {
+ "type": "boolean"
+ },
+ "deletedBy": {
+ "type": "boolean"
+ },
+ "createdOn": {
+ "type": "boolean"
+ },
+ "modifiedOn": {
+ "type": "boolean"
+ },
+ "createdBy": {
+ "type": "boolean"
+ },
+ "modifiedBy": {
+ "type": "boolean"
+ },
+ "id": {
+ "type": "boolean"
+ },
+ "source": {
+ "type": "boolean"
+ },
+ "enableWorkingHours": {
+ "type": "boolean"
+ },
+ "location": {
+ "type": "boolean"
+ },
+ "identifier": {
+ "type": "boolean"
+ },
+ "summary": {
+ "type": "boolean"
+ },
+ "timezone": {
+ "type": "boolean"
+ },
+ "extId": {
+ "type": "boolean"
+ },
+ "extMetadata": {
+ "type": "boolean"
+ }
+ },
+ "additionalProperties": false
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": [
+ "deleted",
+ "deletedOn",
+ "deletedBy",
+ "createdOn",
+ "modifiedOn",
+ "createdBy",
+ "modifiedBy",
+ "id",
+ "source",
+ "enableWorkingHours",
+ "location",
+ "identifier",
+ "summary",
+ "timezone",
+ "extId",
+ "extMetadata"
+ ],
+ "example": "deleted"
+ },
+ "uniqueItems": true
+ }
+ ],
+ "title": "calendars.Fields"
+ },
+ "include": {
+ "title": "calendars.IncludeFilter",
+ "type": "array",
+ "items": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/calendars.IncludeFilter.Items"
+ },
+ {
+ "type": "string"
+ }
+ ]
+ }
+ }
+ },
+ "additionalProperties": false,
+ "x-typescript-type": "@loopback/repository#Filter"
+ },
+ "events.ScopeFilter": {
+ "properties": {
+ "offset": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "limit": {
+ "type": "integer",
+ "minimum": 1,
+ "example": 100
+ },
+ "skip": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "order": {
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "where": {
+ "type": "object",
+ "additionalProperties": true
+ },
+ "fields": {
+ "oneOf": [
+ {
+ "type": "object",
+ "properties": {},
+ "additionalProperties": true
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "uniqueItems": true
+ }
+ ]
+ },
+ "include": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {},
+ "additionalProperties": true
+ }
+ }
+ },
+ "additionalProperties": false,
+ "title": "events.ScopeFilter"
+ },
+ "events.IncludeFilter.Items": {
+ "title": "events.IncludeFilter.Items",
+ "type": "object",
+ "properties": {
+ "relation": {
+ "type": "string"
+ },
+ "scope": {
+ "$ref": "#/components/schemas/events.ScopeFilter"
+ }
+ }
+ },
+ "events.Filter": {
+ "type": "object",
+ "title": "events.Filter",
+ "properties": {
+ "offset": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "limit": {
+ "type": "integer",
+ "minimum": 1,
+ "example": 100
+ },
+ "skip": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "order": {
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "fields": {
+ "oneOf": [
+ {
+ "type": "object",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "deletedOn": {
+ "type": "boolean"
+ },
+ "deletedBy": {
+ "type": "boolean"
+ },
+ "createdOn": {
+ "type": "boolean"
+ },
+ "modifiedOn": {
+ "type": "boolean"
+ },
+ "createdBy": {
+ "type": "boolean"
+ },
+ "modifiedBy": {
+ "type": "boolean"
+ },
+ "id": {
+ "type": "boolean"
+ },
+ "bgColor": {
+ "type": "boolean"
+ },
+ "description": {
+ "type": "boolean"
+ },
+ "endDateTime": {
+ "type": "boolean"
+ },
+ "fgColor": {
+ "type": "boolean"
+ },
+ "iCalUid": {
+ "type": "boolean"
+ },
+ "isFullDayEvent": {
+ "type": "boolean"
+ },
+ "isLocked": {
+ "type": "boolean"
+ },
+ "link": {
+ "type": "boolean"
+ },
+ "location": {
+ "type": "boolean"
+ },
+ "meetingLink": {
+ "type": "boolean"
+ },
+ "identifier": {
+ "type": "boolean"
+ },
+ "startDateTime": {
+ "type": "boolean"
+ },
+ "status": {
+ "type": "boolean"
+ },
+ "summary": {
+ "type": "boolean"
+ },
+ "timezone": {
+ "type": "boolean"
+ },
+ "calendarId": {
+ "type": "boolean"
+ },
+ "parentEventId": {
+ "type": "boolean"
+ },
+ "extId": {
+ "type": "boolean"
+ },
+ "extMetadata": {
+ "type": "boolean"
+ }
+ },
+ "additionalProperties": false
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": [
+ "deleted",
+ "deletedOn",
+ "deletedBy",
+ "createdOn",
+ "modifiedOn",
+ "createdBy",
+ "modifiedBy",
+ "id",
+ "bgColor",
+ "description",
+ "endDateTime",
+ "fgColor",
+ "iCalUid",
+ "isFullDayEvent",
+ "isLocked",
+ "link",
+ "location",
+ "meetingLink",
+ "identifier",
+ "startDateTime",
+ "status",
+ "summary",
+ "timezone",
+ "calendarId",
+ "parentEventId",
+ "extId",
+ "extMetadata"
+ ],
+ "example": "deleted"
+ },
+ "uniqueItems": true
+ }
+ ],
+ "title": "events.Fields"
+ },
+ "include": {
+ "title": "events.IncludeFilter",
+ "type": "array",
+ "items": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/events.IncludeFilter.Items"
+ },
+ {
+ "type": "string"
+ }
+ ]
+ }
+ }
+ },
+ "additionalProperties": false,
+ "x-typescript-type": "@loopback/repository#Filter"
+ },
+ "events_attendees_view.ScopeFilter": {
+ "properties": {
+ "offset": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "limit": {
+ "type": "integer",
+ "minimum": 1,
+ "example": 100
+ },
+ "skip": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "order": {
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "where": {
+ "type": "object",
+ "additionalProperties": true
+ },
+ "fields": {
+ "oneOf": [
+ {
+ "type": "object",
+ "properties": {},
+ "additionalProperties": true
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "uniqueItems": true
+ }
+ ]
+ },
+ "include": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {},
+ "additionalProperties": true
+ }
+ }
+ },
+ "additionalProperties": false,
+ "title": "events_attendees_view.ScopeFilter"
+ },
+ "events_attendees_view.IncludeFilter.Items": {
+ "title": "events_attendees_view.IncludeFilter.Items",
+ "type": "object",
+ "properties": {
+ "relation": {
+ "type": "string"
+ },
+ "scope": {
+ "$ref": "#/components/schemas/events_attendees_view.ScopeFilter"
+ }
+ }
+ },
+ "events_attendees_view.Filter": {
+ "type": "object",
+ "title": "events_attendees_view.Filter",
+ "properties": {
+ "offset": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "limit": {
+ "type": "integer",
+ "minimum": 1,
+ "example": 100
+ },
+ "skip": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "order": {
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "where": {
+ "title": "events_attendees_view.WhereFilter",
+ "type": "object",
+ "additionalProperties": true
+ },
+ "fields": {
+ "oneOf": [
+ {
+ "type": "object",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "deletedOn": {
+ "type": "boolean"
+ },
+ "deletedBy": {
+ "type": "boolean"
+ },
+ "createdOn": {
+ "type": "boolean"
+ },
+ "modifiedOn": {
+ "type": "boolean"
+ },
+ "createdBy": {
+ "type": "boolean"
+ },
+ "modifiedBy": {
+ "type": "boolean"
+ },
+ "id": {
+ "type": "boolean"
+ },
+ "bgColor": {
+ "type": "boolean"
+ },
+ "description": {
+ "type": "boolean"
+ },
+ "endDateTime": {
+ "type": "boolean"
+ },
+ "fgColor": {
+ "type": "boolean"
+ },
+ "iCalUid": {
+ "type": "boolean"
+ },
+ "isFullDayEvent": {
+ "type": "boolean"
+ },
+ "isLocked": {
+ "type": "boolean"
+ },
+ "link": {
+ "type": "boolean"
+ },
+ "location": {
+ "type": "boolean"
+ },
+ "meetingLink": {
+ "type": "boolean"
+ },
+ "identifier": {
+ "type": "boolean"
+ },
+ "startDateTime": {
+ "type": "boolean"
+ },
+ "status": {
+ "type": "boolean"
+ },
+ "summary": {
+ "type": "boolean"
+ },
+ "timezone": {
+ "type": "boolean"
+ },
+ "calendarId": {
+ "type": "boolean"
+ },
+ "parentEventId": {
+ "type": "boolean"
+ },
+ "extId": {
+ "type": "boolean"
+ },
+ "extMetadata": {
+ "type": "boolean"
+ },
+ "attendeeId": {
+ "type": "boolean"
+ },
+ "isOptional": {
+ "type": "boolean"
+ },
+ "attendeeIdentifier": {
+ "type": "boolean"
+ },
+ "isOrganizer": {
+ "type": "boolean"
+ },
+ "messages": {
+ "type": "boolean"
+ },
+ "responseStatus": {
+ "type": "boolean"
+ },
+ "eventId": {
+ "type": "boolean"
+ }
+ },
+ "additionalProperties": false
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": [
+ "deleted",
+ "deletedOn",
+ "deletedBy",
+ "createdOn",
+ "modifiedOn",
+ "createdBy",
+ "modifiedBy",
+ "id",
+ "bgColor",
+ "description",
+ "endDateTime",
+ "fgColor",
+ "iCalUid",
+ "isFullDayEvent",
+ "isLocked",
+ "link",
+ "location",
+ "meetingLink",
+ "identifier",
+ "startDateTime",
+ "status",
+ "summary",
+ "timezone",
+ "calendarId",
+ "parentEventId",
+ "extId",
+ "extMetadata",
+ "attendeeId",
+ "isOptional",
+ "attendeeIdentifier",
+ "isOrganizer",
+ "messages",
+ "responseStatus",
+ "eventId"
+ ],
+ "example": "deleted"
+ },
+ "uniqueItems": true
+ }
+ ],
+ "title": "events_attendees_view.Fields"
+ },
+ "include": {
+ "title": "events_attendees_view.IncludeFilter",
+ "type": "array",
+ "items": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/events_attendees_view.IncludeFilter.Items"
+ },
+ {
+ "type": "string"
+ }
+ ]
+ }
+ }
+ },
+ "additionalProperties": false,
+ "x-typescript-type": "@loopback/repository#Filter"
+ },
+ "settings.Filter": {
+ "type": "object",
+ "title": "settings.Filter",
+ "properties": {
+ "offset": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "limit": {
+ "type": "integer",
+ "minimum": 1,
+ "example": 100
+ },
+ "skip": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "order": {
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "fields": {
+ "oneOf": [
+ {
+ "type": "object",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "deletedOn": {
+ "type": "boolean"
+ },
+ "deletedBy": {
+ "type": "boolean"
+ },
+ "createdOn": {
+ "type": "boolean"
+ },
+ "modifiedOn": {
+ "type": "boolean"
+ },
+ "createdBy": {
+ "type": "boolean"
+ },
+ "modifiedBy": {
+ "type": "boolean"
+ },
+ "id": {
+ "type": "boolean"
+ },
+ "ownerId": {
+ "type": "boolean"
+ },
+ "ownerType": {
+ "type": "boolean"
+ },
+ "settingName": {
+ "type": "boolean"
+ },
+ "settingValue": {
+ "type": "boolean"
+ },
+ "extId": {
+ "type": "boolean"
+ },
+ "extMetadata": {
+ "type": "boolean"
+ }
+ },
+ "additionalProperties": false
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": [
+ "deleted",
+ "deletedOn",
+ "deletedBy",
+ "createdOn",
+ "modifiedOn",
+ "createdBy",
+ "modifiedBy",
+ "id",
+ "ownerId",
+ "ownerType",
+ "settingName",
+ "settingValue",
+ "extId",
+ "extMetadata"
+ ],
+ "example": "deleted"
+ },
+ "uniqueItems": true
+ }
+ ],
+ "title": "settings.Fields"
+ }
+ },
+ "additionalProperties": false,
+ "x-typescript-type": "@loopback/repository#Filter"
+ },
+ "settings.Filter1": {
+ "type": "object",
+ "title": "settings.Filter",
+ "properties": {
+ "offset": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "limit": {
+ "type": "integer",
+ "minimum": 1,
+ "example": 100
+ },
+ "skip": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "order": {
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "where": {
+ "title": "settings.WhereFilter",
+ "type": "object",
+ "additionalProperties": true
+ },
+ "fields": {
+ "oneOf": [
+ {
+ "type": "object",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "deletedOn": {
+ "type": "boolean"
+ },
+ "deletedBy": {
+ "type": "boolean"
+ },
+ "createdOn": {
+ "type": "boolean"
+ },
+ "modifiedOn": {
+ "type": "boolean"
+ },
+ "createdBy": {
+ "type": "boolean"
+ },
+ "modifiedBy": {
+ "type": "boolean"
+ },
+ "id": {
+ "type": "boolean"
+ },
+ "ownerId": {
+ "type": "boolean"
+ },
+ "ownerType": {
+ "type": "boolean"
+ },
+ "settingName": {
+ "type": "boolean"
+ },
+ "settingValue": {
+ "type": "boolean"
+ },
+ "extId": {
+ "type": "boolean"
+ },
+ "extMetadata": {
+ "type": "boolean"
+ }
+ },
+ "additionalProperties": false
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": [
+ "deleted",
+ "deletedOn",
+ "deletedBy",
+ "createdOn",
+ "modifiedOn",
+ "createdBy",
+ "modifiedBy",
+ "id",
+ "ownerId",
+ "ownerType",
+ "settingName",
+ "settingValue",
+ "extId",
+ "extMetadata"
+ ],
+ "example": "deleted"
+ },
+ "uniqueItems": true
+ }
+ ],
+ "title": "settings.Fields"
+ }
+ },
+ "additionalProperties": false,
+ "x-typescript-type": "@loopback/repository#Filter"
+ },
+ "subscriptions.Filter1": {
+ "type": "object",
+ "title": "subscriptions.Filter",
+ "properties": {
+ "offset": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "limit": {
+ "type": "integer",
+ "minimum": 1,
+ "example": 100
+ },
+ "skip": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "order": {
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "fields": {
+ "oneOf": [
+ {
+ "type": "object",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "deletedOn": {
+ "type": "boolean"
+ },
+ "deletedBy": {
+ "type": "boolean"
+ },
+ "createdOn": {
+ "type": "boolean"
+ },
+ "modifiedOn": {
+ "type": "boolean"
+ },
+ "createdBy": {
+ "type": "boolean"
+ },
+ "modifiedBy": {
+ "type": "boolean"
+ },
+ "id": {
+ "type": "boolean"
+ },
+ "accessRole": {
+ "type": "boolean"
+ },
+ "bgColor": {
+ "type": "boolean"
+ },
+ "fgColor": {
+ "type": "boolean"
+ },
+ "isHidden": {
+ "type": "boolean"
+ },
+ "isPrimary": {
+ "type": "boolean"
+ },
+ "identifier": {
+ "type": "boolean"
+ },
+ "defaultReminders": {
+ "type": "boolean"
+ },
+ "notificationSettings": {
+ "type": "boolean"
+ },
+ "calendarId": {
+ "type": "boolean"
+ },
+ "extId": {
+ "type": "boolean"
+ },
+ "extMetadata": {
+ "type": "boolean"
+ }
+ },
+ "additionalProperties": false
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": [
+ "deleted",
+ "deletedOn",
+ "deletedBy",
+ "createdOn",
+ "modifiedOn",
+ "createdBy",
+ "modifiedBy",
+ "id",
+ "accessRole",
+ "bgColor",
+ "fgColor",
+ "isHidden",
+ "isPrimary",
+ "identifier",
+ "defaultReminders",
+ "notificationSettings",
+ "calendarId",
+ "extId",
+ "extMetadata"
+ ],
+ "example": "deleted"
+ },
+ "uniqueItems": true
+ }
+ ],
+ "title": "subscriptions.Fields"
+ },
+ "include": {
+ "title": "subscriptions.IncludeFilter",
+ "type": "array",
+ "items": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/subscriptions.IncludeFilter.Items"
+ },
+ {
+ "type": "string"
+ }
+ ]
+ }
+ }
+ },
+ "additionalProperties": false,
+ "x-typescript-type": "@loopback/repository#Filter"
+ },
+ "themes.Filter": {
+ "type": "object",
+ "title": "themes.Filter",
+ "properties": {
+ "offset": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "limit": {
+ "type": "integer",
+ "minimum": 1,
+ "example": 100
+ },
+ "skip": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "order": {
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "fields": {
+ "oneOf": [
+ {
+ "type": "object",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "deletedOn": {
+ "type": "boolean"
+ },
+ "deletedBy": {
+ "type": "boolean"
+ },
+ "createdOn": {
+ "type": "boolean"
+ },
+ "modifiedOn": {
+ "type": "boolean"
+ },
+ "createdBy": {
+ "type": "boolean"
+ },
+ "modifiedBy": {
+ "type": "boolean"
+ },
+ "id": {
+ "type": "boolean"
+ },
+ "calBg": {
+ "type": "boolean"
+ },
+ "calFg": {
+ "type": "boolean"
+ },
+ "eventBg": {
+ "type": "boolean"
+ },
+ "eventFg": {
+ "type": "boolean"
+ },
+ "extId": {
+ "type": "boolean"
+ },
+ "extMetadata": {
+ "type": "boolean"
+ }
+ },
+ "additionalProperties": false
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": [
+ "deleted",
+ "deletedOn",
+ "deletedBy",
+ "createdOn",
+ "modifiedOn",
+ "createdBy",
+ "modifiedBy",
+ "id",
+ "calBg",
+ "calFg",
+ "eventBg",
+ "eventFg",
+ "extId",
+ "extMetadata"
+ ],
+ "example": "deleted"
+ },
+ "uniqueItems": true
+ }
+ ],
+ "title": "themes.Fields"
+ }
+ },
+ "additionalProperties": false,
+ "x-typescript-type": "@loopback/repository#Filter"
+ },
+ "themes.Filter1": {
+ "type": "object",
+ "title": "themes.Filter",
+ "properties": {
+ "offset": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "limit": {
+ "type": "integer",
+ "minimum": 1,
+ "example": 100
+ },
+ "skip": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "order": {
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "where": {
+ "title": "themes.WhereFilter",
+ "type": "object",
+ "additionalProperties": true
+ },
+ "fields": {
+ "oneOf": [
+ {
+ "type": "object",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "deletedOn": {
+ "type": "boolean"
+ },
+ "deletedBy": {
+ "type": "boolean"
+ },
+ "createdOn": {
+ "type": "boolean"
+ },
+ "modifiedOn": {
+ "type": "boolean"
+ },
+ "createdBy": {
+ "type": "boolean"
+ },
+ "modifiedBy": {
+ "type": "boolean"
+ },
+ "id": {
+ "type": "boolean"
+ },
+ "calBg": {
+ "type": "boolean"
+ },
+ "calFg": {
+ "type": "boolean"
+ },
+ "eventBg": {
+ "type": "boolean"
+ },
+ "eventFg": {
+ "type": "boolean"
+ },
+ "extId": {
+ "type": "boolean"
+ },
+ "extMetadata": {
+ "type": "boolean"
+ }
+ },
+ "additionalProperties": false
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": [
+ "deleted",
+ "deletedOn",
+ "deletedBy",
+ "createdOn",
+ "modifiedOn",
+ "createdBy",
+ "modifiedBy",
+ "id",
+ "calBg",
+ "calFg",
+ "eventBg",
+ "eventFg",
+ "extId",
+ "extMetadata"
+ ],
+ "example": "deleted"
+ },
+ "uniqueItems": true
+ }
+ ],
+ "title": "themes.Fields"
+ }
+ },
+ "additionalProperties": false,
+ "x-typescript-type": "@loopback/repository#Filter"
+ },
+ "working_hours.ScopeFilter": {
+ "properties": {
+ "offset": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "limit": {
+ "type": "integer",
+ "minimum": 1,
+ "example": 100
+ },
+ "skip": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "order": {
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "where": {
+ "type": "object",
+ "additionalProperties": true
+ },
+ "fields": {
+ "oneOf": [
+ {
+ "type": "object",
+ "properties": {},
+ "additionalProperties": true
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "uniqueItems": true
+ }
+ ]
+ },
+ "include": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "properties": {},
+ "additionalProperties": true
+ }
+ }
+ },
+ "additionalProperties": false,
+ "title": "working_hours.ScopeFilter"
+ },
+ "working_hours.IncludeFilter.Items": {
+ "title": "working_hours.IncludeFilter.Items",
+ "type": "object",
+ "properties": {
+ "relation": {
+ "type": "string"
+ },
+ "scope": {
+ "$ref": "#/components/schemas/working_hours.ScopeFilter"
+ }
+ }
+ },
+ "working_hours.Filter": {
+ "type": "object",
+ "title": "working_hours.Filter",
+ "properties": {
+ "offset": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "limit": {
+ "type": "integer",
+ "minimum": 1,
+ "example": 100
+ },
+ "skip": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "order": {
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "fields": {
+ "oneOf": [
+ {
+ "type": "object",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "deletedOn": {
+ "type": "boolean"
+ },
+ "deletedBy": {
+ "type": "boolean"
+ },
+ "createdOn": {
+ "type": "boolean"
+ },
+ "modifiedOn": {
+ "type": "boolean"
+ },
+ "createdBy": {
+ "type": "boolean"
+ },
+ "modifiedBy": {
+ "type": "boolean"
+ },
+ "id": {
+ "type": "boolean"
+ },
+ "dayOfWeek": {
+ "type": "boolean"
+ },
+ "end": {
+ "type": "boolean"
+ },
+ "start": {
+ "type": "boolean"
+ },
+ "calendarId": {
+ "type": "boolean"
+ },
+ "extId": {
+ "type": "boolean"
+ },
+ "extMetadata": {
+ "type": "boolean"
+ }
+ },
+ "additionalProperties": false
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": [
+ "deleted",
+ "deletedOn",
+ "deletedBy",
+ "createdOn",
+ "modifiedOn",
+ "createdBy",
+ "modifiedBy",
+ "id",
+ "dayOfWeek",
+ "end",
+ "start",
+ "calendarId",
+ "extId",
+ "extMetadata"
+ ],
+ "example": "deleted"
+ },
+ "uniqueItems": true
+ }
+ ],
+ "title": "working_hours.Fields"
+ },
+ "include": {
+ "title": "working_hours.IncludeFilter",
+ "type": "array",
+ "items": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/working_hours.IncludeFilter.Items"
+ },
+ {
+ "type": "string"
+ }
+ ]
+ }
+ }
+ },
+ "additionalProperties": false,
+ "x-typescript-type": "@loopback/repository#Filter"
+ },
+ "working_hours.Filter1": {
+ "type": "object",
+ "title": "working_hours.Filter",
+ "properties": {
+ "offset": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "limit": {
+ "type": "integer",
+ "minimum": 1,
+ "example": 100
+ },
+ "skip": {
+ "type": "integer",
+ "minimum": 0
+ },
+ "order": {
+ "oneOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ ]
+ },
+ "where": {
+ "title": "working_hours.WhereFilter",
+ "type": "object",
+ "additionalProperties": true
+ },
+ "fields": {
+ "oneOf": [
+ {
+ "type": "object",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "deletedOn": {
+ "type": "boolean"
+ },
+ "deletedBy": {
+ "type": "boolean"
+ },
+ "createdOn": {
+ "type": "boolean"
+ },
+ "modifiedOn": {
+ "type": "boolean"
+ },
+ "createdBy": {
+ "type": "boolean"
+ },
+ "modifiedBy": {
+ "type": "boolean"
+ },
+ "id": {
+ "type": "boolean"
+ },
+ "dayOfWeek": {
+ "type": "boolean"
+ },
+ "end": {
+ "type": "boolean"
+ },
+ "start": {
+ "type": "boolean"
+ },
+ "calendarId": {
+ "type": "boolean"
+ },
+ "extId": {
+ "type": "boolean"
+ },
+ "extMetadata": {
+ "type": "boolean"
+ }
+ },
+ "additionalProperties": false
+ },
+ {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": [
+ "deleted",
+ "deletedOn",
+ "deletedBy",
+ "createdOn",
+ "modifiedOn",
+ "createdBy",
+ "modifiedBy",
+ "id",
+ "dayOfWeek",
+ "end",
+ "start",
+ "calendarId",
+ "extId",
+ "extMetadata"
+ ],
+ "example": "deleted"
+ },
+ "uniqueItems": true
+ }
+ ],
+ "title": "working_hours.Fields"
+ },
+ "include": {
+ "title": "working_hours.IncludeFilter",
+ "type": "array",
+ "items": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/working_hours.IncludeFilter.Items"
+ },
+ {
+ "type": "string"
+ }
+ ]
+ }
+ }
+ },
+ "additionalProperties": false,
+ "x-typescript-type": "@loopback/repository#Filter"
+ }
+ }
+ },
+ "servers": [
+ {
+ "url": "/"
+ }
+ ]
+}
\ No newline at end of file
diff --git a/services/scheduler-service/openapi.md b/services/scheduler-service/openapi.md
new file mode 100644
index 0000000000..ebcd08c7ea
--- /dev/null
+++ b/services/scheduler-service/openapi.md
@@ -0,0 +1,17712 @@
+---
+title: Scheduler Service v1.0.0
+language_tabs:
+ - "'javascript": JavaScript
+ - "'javascript--nodejs": Node.JS'
+language_clients:
+ - "'javascript": request'
+ - "'javascript--nodejs": ""
+toc_footers: []
+includes: []
+search: false
+highlight_theme: darkula
+headingLevel: 2
+
+---
+
+
+
+Scheduler Service v1.0.0
+
+> Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
+
+services
+
+Base URLs:
+
+* /
+
+# Authentication
+
+- HTTP Authentication, scheme: bearer
+
+AttachmentController
+
+## AttachmentController.count
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|where|query|object|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "count": 0
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Attachment model count|[loopback.Count](#schemaloopback.count)|
+
+
+This operation does not require authentication
+
+
+## AttachmentController.replaceById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|body|body|[Attachment](#schemaattachment)|false|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|Attachment PUT success|None|
+
+
+This operation does not require authentication
+
+
+## AttachmentController.updateById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|body|body|[AttachmentPartial](#schemaattachmentpartial)|false|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|Attachment PATCH success|None|
+
+
+This operation does not require authentication
+
+
+## AttachmentController.findById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|filter|query|[attachments.Filter](#schemaattachments.filter)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "fileUrl": "string",
+ "iconLink": "string",
+ "mimeType": "string",
+ "title": "string",
+ "eventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "event": {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "bgColor": "string",
+ "description": "string",
+ "endDateTime": "2019-08-24T14:15:22Z",
+ "fgColor": "string",
+ "iCalUid": "string",
+ "isFullDayEvent": true,
+ "isLocked": true,
+ "link": "string",
+ "location": "string",
+ "meetingLink": "string",
+ "identifier": "string",
+ "startDateTime": "2019-08-24T14:15:22Z",
+ "status": "confirmed",
+ "summary": "string",
+ "timezone": "string",
+ "calendarId": "string",
+ "parentEventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "source": "string",
+ "enableWorkingHours": true,
+ "location": "string",
+ "identifier": "string",
+ "summary": "string",
+ "timezone": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "events": [
+ {}
+ ],
+ "workingHours": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "dayOfWeek": 0,
+ "end": "string",
+ "start": "string",
+ "calendarId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {}
+ }
+ ],
+ "subscriptions": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "accessRole": "freeBusyReader",
+ "bgColor": "string",
+ "fgColor": "string",
+ "isHidden": true,
+ "isPrimary": true,
+ "identifier": "string",
+ "defaultReminders": {},
+ "notificationSettings": {},
+ "calendarId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {}
+ }
+ ]
+ },
+ "parentEvent": {},
+ "attendees": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "identifier": "string",
+ "isOptional": true,
+ "isOrganizer": true,
+ "messages": "string",
+ "responseStatus": "needsAction",
+ "eventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "event": {}
+ }
+ ],
+ "attachments": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "fileUrl": "string",
+ "iconLink": "string",
+ "mimeType": "string",
+ "title": "string",
+ "eventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "event": {}
+ }
+ ]
+ }
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Attachment model instance|[AttachmentWithRelations](#schemaattachmentwithrelations)|
+
+
+This operation does not require authentication
+
+
+## AttachmentController.deleteById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|Attachment DELETE success|None|
+
+
+This operation does not require authentication
+
+
+## AttachmentController.create
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|body|body|[NewAttachment](#schemanewattachment)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "fileUrl": "string",
+ "iconLink": "string",
+ "mimeType": "string",
+ "title": "string",
+ "eventId": "string",
+ "extId": "string",
+ "extMetadata": {}
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Attachment model instance|[Attachment](#schemaattachment)|
+
+
+This operation does not require authentication
+
+
+## AttachmentController.updateAll
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|where|query|object|false|none|
+|body|body|[AttachmentPartial](#schemaattachmentpartial)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "count": 0
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Attachment PATCH success count|[loopback.Count](#schemaloopback.count)|
+
+
+This operation does not require authentication
+
+
+## AttachmentController.find
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|filter|query|[attachments.Filter1](#schemaattachments.filter1)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+[
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "fileUrl": "string",
+ "iconLink": "string",
+ "mimeType": "string",
+ "title": "string",
+ "eventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "event": {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "bgColor": "string",
+ "description": "string",
+ "endDateTime": "2019-08-24T14:15:22Z",
+ "fgColor": "string",
+ "iCalUid": "string",
+ "isFullDayEvent": true,
+ "isLocked": true,
+ "link": "string",
+ "location": "string",
+ "meetingLink": "string",
+ "identifier": "string",
+ "startDateTime": "2019-08-24T14:15:22Z",
+ "status": "confirmed",
+ "summary": "string",
+ "timezone": "string",
+ "calendarId": "string",
+ "parentEventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "source": "string",
+ "enableWorkingHours": true,
+ "location": "string",
+ "identifier": "string",
+ "summary": "string",
+ "timezone": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "events": [
+ {}
+ ],
+ "workingHours": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "dayOfWeek": 0,
+ "end": "string",
+ "start": "string",
+ "calendarId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {}
+ }
+ ],
+ "subscriptions": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "accessRole": "freeBusyReader",
+ "bgColor": "string",
+ "fgColor": "string",
+ "isHidden": true,
+ "isPrimary": true,
+ "identifier": "string",
+ "defaultReminders": {},
+ "notificationSettings": {},
+ "calendarId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {}
+ }
+ ]
+ },
+ "parentEvent": {},
+ "attendees": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "identifier": "string",
+ "isOptional": true,
+ "isOrganizer": true,
+ "messages": "string",
+ "responseStatus": "needsAction",
+ "eventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "event": {}
+ }
+ ],
+ "attachments": [
+ {}
+ ]
+ }
+ }
+]
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Array of Attachment model instances|Inline|
+
+Response Schema
+
+Status Code **200**
+
+|Name|Type|Required|Restrictions|Description|
+|---|---|---|---|---|
+|*anonymous*|[[AttachmentWithRelations](#schemaattachmentwithrelations)]|false|none|[(tsType: AttachmentWithRelations, schemaOptions: { includeRelations: true })]|
+|» AttachmentWithRelations|[AttachmentWithRelations](#schemaattachmentwithrelations)|false|none|(tsType: AttachmentWithRelations, schemaOptions: { includeRelations: true })|
+|»» deleted|boolean|false|none|none|
+|»» deletedOn|string(date-time)¦null|false|none|none|
+|»» deletedBy|string¦null|false|none|none|
+|»» createdOn|string(date-time)|false|none|none|
+|»» modifiedOn|string(date-time)|false|none|none|
+|»» createdBy|string|false|none|none|
+|»» modifiedBy|string|false|none|none|
+|»» id|string|false|none|none|
+|»» fileUrl|string|true|none|none|
+|»» iconLink|string|false|none|none|
+|»» mimeType|string|false|none|none|
+|»» title|string|false|none|none|
+|»» eventId|string|true|none|none|
+|»» extId|string|false|none|none|
+|»» extMetadata|object|false|none|none|
+|»» event|[EventWithRelations](#schemaeventwithrelations)|false|none|(tsType: EventWithRelations, schemaOptions: { includeRelations: true })|
+|»»» deleted|boolean|false|none|none|
+|»»» deletedOn|string(date-time)¦null|false|none|none|
+|»»» deletedBy|string¦null|false|none|none|
+|»»» createdOn|string(date-time)|false|none|none|
+|»»» modifiedOn|string(date-time)|false|none|none|
+|»»» createdBy|string|false|none|none|
+|»»» modifiedBy|string|false|none|none|
+|»»» id|string|false|none|none|
+|»»» bgColor|string|false|none|none|
+|»»» description|string|false|none|none|
+|»»» endDateTime|string(date-time)|false|none|none|
+|»»» fgColor|string|false|none|none|
+|»»» iCalUid|string|false|none|none|
+|»»» isFullDayEvent|boolean|false|none|none|
+|»»» isLocked|boolean|false|none|none|
+|»»» link|string|false|none|none|
+|»»» location|string|false|none|none|
+|»»» meetingLink|string|false|none|none|
+|»»» identifier|string|false|none|none|
+|»»» startDateTime|string(date-time)|false|none|none|
+|»»» status|string|false|none|none|
+|»»» summary|string|false|none|none|
+|»»» timezone|string|false|none|none|
+|»»» calendarId|string|true|none|none|
+|»»» parentEventId|string|false|none|none|
+|»»» extId|string|false|none|none|
+|»»» extMetadata|object|false|none|none|
+|»»» calendar|[CalendarWithRelations](#schemacalendarwithrelations)|false|none|(tsType: CalendarWithRelations, schemaOptions: { includeRelations: true })|
+|»»»» deleted|boolean|false|none|none|
+|»»»» deletedOn|string(date-time)¦null|false|none|none|
+|»»»» deletedBy|string¦null|false|none|none|
+|»»»» createdOn|string(date-time)|false|none|none|
+|»»»» modifiedOn|string(date-time)|false|none|none|
+|»»»» createdBy|string|false|none|none|
+|»»»» modifiedBy|string|false|none|none|
+|»»»» id|string|false|none|none|
+|»»»» source|string|false|none|none|
+|»»»» enableWorkingHours|boolean|false|none|none|
+|»»»» location|string|false|none|none|
+|»»»» identifier|string|true|none|none|
+|»»»» summary|string|false|none|none|
+|»»»» timezone|string|false|none|none|
+|»»»» extId|string|false|none|none|
+|»»»» extMetadata|object|false|none|none|
+|»»»» events|[[EventWithRelations](#schemaeventwithrelations)]|false|none|(tsType: EventWithRelations, schemaOptions: { includeRelations: true })|
+|»»»»» EventWithRelations|[EventWithRelations](#schemaeventwithrelations)|false|none|(tsType: EventWithRelations, schemaOptions: { includeRelations: true })|
+|»»»» workingHours|[[WorkingHourWithRelations](#schemaworkinghourwithrelations)]|false|none|(tsType: WorkingHourWithRelations, schemaOptions: { includeRelations: true })|
+|»»»»» WorkingHourWithRelations|[WorkingHourWithRelations](#schemaworkinghourwithrelations)|false|none|(tsType: WorkingHourWithRelations, schemaOptions: { includeRelations: true })|
+|»»»»»» deleted|boolean|false|none|none|
+|»»»»»» deletedOn|string(date-time)¦null|false|none|none|
+|»»»»»» deletedBy|string¦null|false|none|none|
+|»»»»»» createdOn|string(date-time)|false|none|none|
+|»»»»»» modifiedOn|string(date-time)|false|none|none|
+|»»»»»» createdBy|string|false|none|none|
+|»»»»»» modifiedBy|string|false|none|none|
+|»»»»»» id|string|false|none|none|
+|»»»»»» dayOfWeek|number|false|none|none|
+|»»»»»» end|string|false|none|none|
+|»»»»»» start|string|false|none|none|
+|»»»»»» calendarId|string|true|none|none|
+|»»»»»» extId|string|false|none|none|
+|»»»»»» extMetadata|object|false|none|none|
+|»»»»»» calendar|[CalendarWithRelations](#schemacalendarwithrelations)|false|none|(tsType: CalendarWithRelations, schemaOptions: { includeRelations: true })|
+|»»»» subscriptions|[[SubscriptionWithRelations](#schemasubscriptionwithrelations)]|false|none|(tsType: SubscriptionWithRelations, schemaOptions: { includeRelations: true })|
+|»»»»» SubscriptionWithRelations|[SubscriptionWithRelations](#schemasubscriptionwithrelations)|false|none|(tsType: SubscriptionWithRelations, schemaOptions: { includeRelations: true })|
+|»»»»»» deleted|boolean|false|none|none|
+|»»»»»» deletedOn|string(date-time)¦null|false|none|none|
+|»»»»»» deletedBy|string¦null|false|none|none|
+|»»»»»» createdOn|string(date-time)|false|none|none|
+|»»»»»» modifiedOn|string(date-time)|false|none|none|
+|»»»»»» createdBy|string|false|none|none|
+|»»»»»» modifiedBy|string|false|none|none|
+|»»»»»» id|string|false|none|none|
+|»»»»»» accessRole|string|false|none|none|
+|»»»»»» bgColor|string|false|none|none|
+|»»»»»» fgColor|string|false|none|none|
+|»»»»»» isHidden|boolean|false|none|none|
+|»»»»»» isPrimary|boolean|false|none|none|
+|»»»»»» identifier|string|true|none|none|
+|»»»»»» defaultReminders|object|false|none|none|
+|»»»»»» notificationSettings|object|false|none|none|
+|»»»»»» calendarId|string|true|none|none|
+|»»»»»» extId|string|false|none|none|
+|»»»»»» extMetadata|object|false|none|none|
+|»»»»»» calendar|[CalendarWithRelations](#schemacalendarwithrelations)|false|none|(tsType: CalendarWithRelations, schemaOptions: { includeRelations: true })|
+|»»» parentEvent|[EventWithRelations](#schemaeventwithrelations)|false|none|(tsType: EventWithRelations, schemaOptions: { includeRelations: true })|
+|»»» attendees|[[AttendeeWithRelations](#schemaattendeewithrelations)]|false|none|(tsType: AttendeeWithRelations, schemaOptions: { includeRelations: true })|
+|»»»» AttendeeWithRelations|[AttendeeWithRelations](#schemaattendeewithrelations)|false|none|(tsType: AttendeeWithRelations, schemaOptions: { includeRelations: true })|
+|»»»»» deleted|boolean|false|none|none|
+|»»»»» deletedOn|string(date-time)¦null|false|none|none|
+|»»»»» deletedBy|string¦null|false|none|none|
+|»»»»» createdOn|string(date-time)|false|none|none|
+|»»»»» modifiedOn|string(date-time)|false|none|none|
+|»»»»» createdBy|string|false|none|none|
+|»»»»» modifiedBy|string|false|none|none|
+|»»»»» id|string|false|none|none|
+|»»»»» identifier|string|true|none|none|
+|»»»»» isOptional|boolean|false|none|none|
+|»»»»» isOrganizer|boolean|false|none|none|
+|»»»»» messages|string|false|none|none|
+|»»»»» responseStatus|string|false|none|none|
+|»»»»» eventId|string|true|none|none|
+|»»»»» extId|string|false|none|none|
+|»»»»» extMetadata|object|false|none|none|
+|»»»»» event|[EventWithRelations](#schemaeventwithrelations)|false|none|(tsType: EventWithRelations, schemaOptions: { includeRelations: true })|
+|»»» attachments|[[AttachmentWithRelations](#schemaattachmentwithrelations)]|false|none|(tsType: AttachmentWithRelations, schemaOptions: { includeRelations: true })|
+|»»»» AttachmentWithRelations|[AttachmentWithRelations](#schemaattachmentwithrelations)|false|none|(tsType: AttachmentWithRelations, schemaOptions: { includeRelations: true })|
+
+#### Enumerated Values
+
+|Property|Value|
+|---|---|
+|status|confirmed|
+|status|tentative|
+|status|cancelled|
+|status|completed|
+|dayOfWeek|0|
+|dayOfWeek|1|
+|dayOfWeek|2|
+|dayOfWeek|3|
+|dayOfWeek|4|
+|dayOfWeek|5|
+|dayOfWeek|6|
+|accessRole|freeBusyReader|
+|accessRole|reader|
+|accessRole|writer|
+|accessRole|owner|
+|responseStatus|needsAction|
+|responseStatus|tentative|
+|responseStatus|accepted|
+|responseStatus|declined|
+
+
+This operation does not require authentication
+
+
+AttendeeController
+
+## AttendeeController.count
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|where|query|object|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "count": 0
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Attendee model count|[loopback.Count](#schemaloopback.count)|
+
+
+This operation does not require authentication
+
+
+## AttendeeController.replaceById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|body|body|[Attendee](#schemaattendee)|false|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|Attendee PUT success|None|
+
+
+This operation does not require authentication
+
+
+## AttendeeController.updateById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|body|body|[AttendeePartial](#schemaattendeepartial)|false|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|Attendee PATCH success|None|
+
+
+This operation does not require authentication
+
+
+## AttendeeController.findById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|filter|query|[attendees.Filter](#schemaattendees.filter)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "identifier": "string",
+ "isOptional": true,
+ "isOrganizer": true,
+ "messages": "string",
+ "responseStatus": "needsAction",
+ "eventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "event": {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "bgColor": "string",
+ "description": "string",
+ "endDateTime": "2019-08-24T14:15:22Z",
+ "fgColor": "string",
+ "iCalUid": "string",
+ "isFullDayEvent": true,
+ "isLocked": true,
+ "link": "string",
+ "location": "string",
+ "meetingLink": "string",
+ "identifier": "string",
+ "startDateTime": "2019-08-24T14:15:22Z",
+ "status": "confirmed",
+ "summary": "string",
+ "timezone": "string",
+ "calendarId": "string",
+ "parentEventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "source": "string",
+ "enableWorkingHours": true,
+ "location": "string",
+ "identifier": "string",
+ "summary": "string",
+ "timezone": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "events": [
+ {}
+ ],
+ "workingHours": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "dayOfWeek": 0,
+ "end": "string",
+ "start": "string",
+ "calendarId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {}
+ }
+ ],
+ "subscriptions": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "accessRole": "freeBusyReader",
+ "bgColor": "string",
+ "fgColor": "string",
+ "isHidden": true,
+ "isPrimary": true,
+ "identifier": "string",
+ "defaultReminders": {},
+ "notificationSettings": {},
+ "calendarId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {}
+ }
+ ]
+ },
+ "parentEvent": {},
+ "attendees": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "identifier": "string",
+ "isOptional": true,
+ "isOrganizer": true,
+ "messages": "string",
+ "responseStatus": "needsAction",
+ "eventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "event": {}
+ }
+ ],
+ "attachments": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "fileUrl": "string",
+ "iconLink": "string",
+ "mimeType": "string",
+ "title": "string",
+ "eventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "event": {}
+ }
+ ]
+ }
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Attendee model instance|[AttendeeWithRelations](#schemaattendeewithrelations)|
+
+
+This operation does not require authentication
+
+
+## AttendeeController.deleteById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|Attendee DELETE success|None|
+
+
+This operation does not require authentication
+
+
+## AttendeeController.create
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|body|body|[NewAttendee](#schemanewattendee)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "identifier": "string",
+ "isOptional": true,
+ "isOrganizer": true,
+ "messages": "string",
+ "responseStatus": "needsAction",
+ "eventId": "string",
+ "extId": "string",
+ "extMetadata": {}
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Attendee model instance|[Attendee](#schemaattendee)|
+
+
+This operation does not require authentication
+
+
+## AttendeeController.updateAll
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|where|query|object|false|none|
+|body|body|[AttendeePartial](#schemaattendeepartial)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "count": 0
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Attendee PATCH success count|[loopback.Count](#schemaloopback.count)|
+
+
+This operation does not require authentication
+
+
+## AttendeeController.find
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|filter|query|[attendees.Filter1](#schemaattendees.filter1)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+[
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "identifier": "string",
+ "isOptional": true,
+ "isOrganizer": true,
+ "messages": "string",
+ "responseStatus": "needsAction",
+ "eventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "event": {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "bgColor": "string",
+ "description": "string",
+ "endDateTime": "2019-08-24T14:15:22Z",
+ "fgColor": "string",
+ "iCalUid": "string",
+ "isFullDayEvent": true,
+ "isLocked": true,
+ "link": "string",
+ "location": "string",
+ "meetingLink": "string",
+ "identifier": "string",
+ "startDateTime": "2019-08-24T14:15:22Z",
+ "status": "confirmed",
+ "summary": "string",
+ "timezone": "string",
+ "calendarId": "string",
+ "parentEventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "source": "string",
+ "enableWorkingHours": true,
+ "location": "string",
+ "identifier": "string",
+ "summary": "string",
+ "timezone": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "events": [
+ {}
+ ],
+ "workingHours": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "dayOfWeek": 0,
+ "end": "string",
+ "start": "string",
+ "calendarId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {}
+ }
+ ],
+ "subscriptions": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "accessRole": "freeBusyReader",
+ "bgColor": "string",
+ "fgColor": "string",
+ "isHidden": true,
+ "isPrimary": true,
+ "identifier": "string",
+ "defaultReminders": {},
+ "notificationSettings": {},
+ "calendarId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {}
+ }
+ ]
+ },
+ "parentEvent": {},
+ "attendees": [
+ {}
+ ],
+ "attachments": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "fileUrl": "string",
+ "iconLink": "string",
+ "mimeType": "string",
+ "title": "string",
+ "eventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "event": {}
+ }
+ ]
+ }
+ }
+]
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Array of Attendee model instances|Inline|
+
+Response Schema
+
+Status Code **200**
+
+|Name|Type|Required|Restrictions|Description|
+|---|---|---|---|---|
+|*anonymous*|[[AttendeeWithRelations](#schemaattendeewithrelations)]|false|none|[(tsType: AttendeeWithRelations, schemaOptions: { includeRelations: true })]|
+|» AttendeeWithRelations|[AttendeeWithRelations](#schemaattendeewithrelations)|false|none|(tsType: AttendeeWithRelations, schemaOptions: { includeRelations: true })|
+|»» deleted|boolean|false|none|none|
+|»» deletedOn|string(date-time)¦null|false|none|none|
+|»» deletedBy|string¦null|false|none|none|
+|»» createdOn|string(date-time)|false|none|none|
+|»» modifiedOn|string(date-time)|false|none|none|
+|»» createdBy|string|false|none|none|
+|»» modifiedBy|string|false|none|none|
+|»» id|string|false|none|none|
+|»» identifier|string|true|none|none|
+|»» isOptional|boolean|false|none|none|
+|»» isOrganizer|boolean|false|none|none|
+|»» messages|string|false|none|none|
+|»» responseStatus|string|false|none|none|
+|»» eventId|string|true|none|none|
+|»» extId|string|false|none|none|
+|»» extMetadata|object|false|none|none|
+|»» event|[EventWithRelations](#schemaeventwithrelations)|false|none|(tsType: EventWithRelations, schemaOptions: { includeRelations: true })|
+|»»» deleted|boolean|false|none|none|
+|»»» deletedOn|string(date-time)¦null|false|none|none|
+|»»» deletedBy|string¦null|false|none|none|
+|»»» createdOn|string(date-time)|false|none|none|
+|»»» modifiedOn|string(date-time)|false|none|none|
+|»»» createdBy|string|false|none|none|
+|»»» modifiedBy|string|false|none|none|
+|»»» id|string|false|none|none|
+|»»» bgColor|string|false|none|none|
+|»»» description|string|false|none|none|
+|»»» endDateTime|string(date-time)|false|none|none|
+|»»» fgColor|string|false|none|none|
+|»»» iCalUid|string|false|none|none|
+|»»» isFullDayEvent|boolean|false|none|none|
+|»»» isLocked|boolean|false|none|none|
+|»»» link|string|false|none|none|
+|»»» location|string|false|none|none|
+|»»» meetingLink|string|false|none|none|
+|»»» identifier|string|false|none|none|
+|»»» startDateTime|string(date-time)|false|none|none|
+|»»» status|string|false|none|none|
+|»»» summary|string|false|none|none|
+|»»» timezone|string|false|none|none|
+|»»» calendarId|string|true|none|none|
+|»»» parentEventId|string|false|none|none|
+|»»» extId|string|false|none|none|
+|»»» extMetadata|object|false|none|none|
+|»»» calendar|[CalendarWithRelations](#schemacalendarwithrelations)|false|none|(tsType: CalendarWithRelations, schemaOptions: { includeRelations: true })|
+|»»»» deleted|boolean|false|none|none|
+|»»»» deletedOn|string(date-time)¦null|false|none|none|
+|»»»» deletedBy|string¦null|false|none|none|
+|»»»» createdOn|string(date-time)|false|none|none|
+|»»»» modifiedOn|string(date-time)|false|none|none|
+|»»»» createdBy|string|false|none|none|
+|»»»» modifiedBy|string|false|none|none|
+|»»»» id|string|false|none|none|
+|»»»» source|string|false|none|none|
+|»»»» enableWorkingHours|boolean|false|none|none|
+|»»»» location|string|false|none|none|
+|»»»» identifier|string|true|none|none|
+|»»»» summary|string|false|none|none|
+|»»»» timezone|string|false|none|none|
+|»»»» extId|string|false|none|none|
+|»»»» extMetadata|object|false|none|none|
+|»»»» events|[[EventWithRelations](#schemaeventwithrelations)]|false|none|(tsType: EventWithRelations, schemaOptions: { includeRelations: true })|
+|»»»»» EventWithRelations|[EventWithRelations](#schemaeventwithrelations)|false|none|(tsType: EventWithRelations, schemaOptions: { includeRelations: true })|
+|»»»» workingHours|[[WorkingHourWithRelations](#schemaworkinghourwithrelations)]|false|none|(tsType: WorkingHourWithRelations, schemaOptions: { includeRelations: true })|
+|»»»»» WorkingHourWithRelations|[WorkingHourWithRelations](#schemaworkinghourwithrelations)|false|none|(tsType: WorkingHourWithRelations, schemaOptions: { includeRelations: true })|
+|»»»»»» deleted|boolean|false|none|none|
+|»»»»»» deletedOn|string(date-time)¦null|false|none|none|
+|»»»»»» deletedBy|string¦null|false|none|none|
+|»»»»»» createdOn|string(date-time)|false|none|none|
+|»»»»»» modifiedOn|string(date-time)|false|none|none|
+|»»»»»» createdBy|string|false|none|none|
+|»»»»»» modifiedBy|string|false|none|none|
+|»»»»»» id|string|false|none|none|
+|»»»»»» dayOfWeek|number|false|none|none|
+|»»»»»» end|string|false|none|none|
+|»»»»»» start|string|false|none|none|
+|»»»»»» calendarId|string|true|none|none|
+|»»»»»» extId|string|false|none|none|
+|»»»»»» extMetadata|object|false|none|none|
+|»»»»»» calendar|[CalendarWithRelations](#schemacalendarwithrelations)|false|none|(tsType: CalendarWithRelations, schemaOptions: { includeRelations: true })|
+|»»»» subscriptions|[[SubscriptionWithRelations](#schemasubscriptionwithrelations)]|false|none|(tsType: SubscriptionWithRelations, schemaOptions: { includeRelations: true })|
+|»»»»» SubscriptionWithRelations|[SubscriptionWithRelations](#schemasubscriptionwithrelations)|false|none|(tsType: SubscriptionWithRelations, schemaOptions: { includeRelations: true })|
+|»»»»»» deleted|boolean|false|none|none|
+|»»»»»» deletedOn|string(date-time)¦null|false|none|none|
+|»»»»»» deletedBy|string¦null|false|none|none|
+|»»»»»» createdOn|string(date-time)|false|none|none|
+|»»»»»» modifiedOn|string(date-time)|false|none|none|
+|»»»»»» createdBy|string|false|none|none|
+|»»»»»» modifiedBy|string|false|none|none|
+|»»»»»» id|string|false|none|none|
+|»»»»»» accessRole|string|false|none|none|
+|»»»»»» bgColor|string|false|none|none|
+|»»»»»» fgColor|string|false|none|none|
+|»»»»»» isHidden|boolean|false|none|none|
+|»»»»»» isPrimary|boolean|false|none|none|
+|»»»»»» identifier|string|true|none|none|
+|»»»»»» defaultReminders|object|false|none|none|
+|»»»»»» notificationSettings|object|false|none|none|
+|»»»»»» calendarId|string|true|none|none|
+|»»»»»» extId|string|false|none|none|
+|»»»»»» extMetadata|object|false|none|none|
+|»»»»»» calendar|[CalendarWithRelations](#schemacalendarwithrelations)|false|none|(tsType: CalendarWithRelations, schemaOptions: { includeRelations: true })|
+|»»» parentEvent|[EventWithRelations](#schemaeventwithrelations)|false|none|(tsType: EventWithRelations, schemaOptions: { includeRelations: true })|
+|»»» attendees|[[AttendeeWithRelations](#schemaattendeewithrelations)]|false|none|(tsType: AttendeeWithRelations, schemaOptions: { includeRelations: true })|
+|»»»» AttendeeWithRelations|[AttendeeWithRelations](#schemaattendeewithrelations)|false|none|(tsType: AttendeeWithRelations, schemaOptions: { includeRelations: true })|
+|»»» attachments|[[AttachmentWithRelations](#schemaattachmentwithrelations)]|false|none|(tsType: AttachmentWithRelations, schemaOptions: { includeRelations: true })|
+|»»»» AttachmentWithRelations|[AttachmentWithRelations](#schemaattachmentwithrelations)|false|none|(tsType: AttachmentWithRelations, schemaOptions: { includeRelations: true })|
+|»»»»» deleted|boolean|false|none|none|
+|»»»»» deletedOn|string(date-time)¦null|false|none|none|
+|»»»»» deletedBy|string¦null|false|none|none|
+|»»»»» createdOn|string(date-time)|false|none|none|
+|»»»»» modifiedOn|string(date-time)|false|none|none|
+|»»»»» createdBy|string|false|none|none|
+|»»»»» modifiedBy|string|false|none|none|
+|»»»»» id|string|false|none|none|
+|»»»»» fileUrl|string|true|none|none|
+|»»»»» iconLink|string|false|none|none|
+|»»»»» mimeType|string|false|none|none|
+|»»»»» title|string|false|none|none|
+|»»»»» eventId|string|true|none|none|
+|»»»»» extId|string|false|none|none|
+|»»»»» extMetadata|object|false|none|none|
+|»»»»» event|[EventWithRelations](#schemaeventwithrelations)|false|none|(tsType: EventWithRelations, schemaOptions: { includeRelations: true })|
+
+#### Enumerated Values
+
+|Property|Value|
+|---|---|
+|responseStatus|needsAction|
+|responseStatus|tentative|
+|responseStatus|accepted|
+|responseStatus|declined|
+|status|confirmed|
+|status|tentative|
+|status|cancelled|
+|status|completed|
+|dayOfWeek|0|
+|dayOfWeek|1|
+|dayOfWeek|2|
+|dayOfWeek|3|
+|dayOfWeek|4|
+|dayOfWeek|5|
+|dayOfWeek|6|
+|accessRole|freeBusyReader|
+|accessRole|reader|
+|accessRole|writer|
+|accessRole|owner|
+
+
+This operation does not require authentication
+
+
+CalendarController
+
+## CalendarController.createWithSubscription
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|body|body|[NewCalendar](#schemanewcalendar)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "id": "string",
+ "source": "string",
+ "enableWorkingHours": true,
+ "location": "string",
+ "identifier": "string",
+ "summary": "string",
+ "timezone": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "workingHours": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "dayOfWeek": 0,
+ "end": "string",
+ "start": "string",
+ "calendarId": "string",
+ "extId": "string",
+ "extMetadata": {}
+ }
+ ],
+ "subscription": {}
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Calendar model instance|[CalendarDTO](#schemacalendardto)|
+
+
+This operation does not require authentication
+
+
+## CalendarController.count
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|where|query|object|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "count": 0
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Calendar model count|[loopback.Count](#schemaloopback.count)|
+
+
+This operation does not require authentication
+
+
+## CalendarController.replaceById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|body|body|[CalendarDTO](#schemacalendardto)|false|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|Calendar PUT success|None|
+
+
+This operation does not require authentication
+
+
+## CalendarController.updateById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|body|body|[CalendarPartial](#schemacalendarpartial)|false|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|Calendar PATCH success|None|
+
+
+This operation does not require authentication
+
+
+## CalendarController.findById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|filter|query|[calendars.Filter](#schemacalendars.filter)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "source": "string",
+ "enableWorkingHours": true,
+ "location": "string",
+ "identifier": "string",
+ "summary": "string",
+ "timezone": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "events": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "bgColor": "string",
+ "description": "string",
+ "endDateTime": "2019-08-24T14:15:22Z",
+ "fgColor": "string",
+ "iCalUid": "string",
+ "isFullDayEvent": true,
+ "isLocked": true,
+ "link": "string",
+ "location": "string",
+ "meetingLink": "string",
+ "identifier": "string",
+ "startDateTime": "2019-08-24T14:15:22Z",
+ "status": "confirmed",
+ "summary": "string",
+ "timezone": "string",
+ "calendarId": "string",
+ "parentEventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "source": "string",
+ "enableWorkingHours": true,
+ "location": "string",
+ "identifier": "string",
+ "summary": "string",
+ "timezone": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "events": [],
+ "workingHours": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "dayOfWeek": 0,
+ "end": "string",
+ "start": "string",
+ "calendarId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {}
+ }
+ ],
+ "subscriptions": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "accessRole": "freeBusyReader",
+ "bgColor": "string",
+ "fgColor": "string",
+ "isHidden": true,
+ "isPrimary": true,
+ "identifier": "string",
+ "defaultReminders": {},
+ "notificationSettings": {},
+ "calendarId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {}
+ }
+ ]
+ },
+ "parentEvent": {},
+ "attendees": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "identifier": "string",
+ "isOptional": true,
+ "isOrganizer": true,
+ "messages": "string",
+ "responseStatus": "needsAction",
+ "eventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "event": {}
+ }
+ ],
+ "attachments": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "fileUrl": "string",
+ "iconLink": "string",
+ "mimeType": "string",
+ "title": "string",
+ "eventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "event": {}
+ }
+ ]
+ }
+ ],
+ "workingHours": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "dayOfWeek": 0,
+ "end": "string",
+ "start": "string",
+ "calendarId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "source": "string",
+ "enableWorkingHours": true,
+ "location": "string",
+ "identifier": "string",
+ "summary": "string",
+ "timezone": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "events": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "bgColor": "string",
+ "description": "string",
+ "endDateTime": "2019-08-24T14:15:22Z",
+ "fgColor": "string",
+ "iCalUid": "string",
+ "isFullDayEvent": true,
+ "isLocked": true,
+ "link": "string",
+ "location": "string",
+ "meetingLink": "string",
+ "identifier": "string",
+ "startDateTime": "2019-08-24T14:15:22Z",
+ "status": "confirmed",
+ "summary": "string",
+ "timezone": "string",
+ "calendarId": "string",
+ "parentEventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {},
+ "parentEvent": {},
+ "attendees": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "identifier": "string",
+ "isOptional": true,
+ "isOrganizer": true,
+ "messages": "string",
+ "responseStatus": "needsAction",
+ "eventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "event": {}
+ }
+ ],
+ "attachments": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "fileUrl": "string",
+ "iconLink": "string",
+ "mimeType": "string",
+ "title": "string",
+ "eventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "event": {}
+ }
+ ]
+ }
+ ],
+ "workingHours": [],
+ "subscriptions": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "accessRole": "freeBusyReader",
+ "bgColor": "string",
+ "fgColor": "string",
+ "isHidden": true,
+ "isPrimary": true,
+ "identifier": "string",
+ "defaultReminders": {},
+ "notificationSettings": {},
+ "calendarId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {}
+ }
+ ]
+ }
+ }
+ ],
+ "subscriptions": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "accessRole": "freeBusyReader",
+ "bgColor": "string",
+ "fgColor": "string",
+ "isHidden": true,
+ "isPrimary": true,
+ "identifier": "string",
+ "defaultReminders": {},
+ "notificationSettings": {},
+ "calendarId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "source": "string",
+ "enableWorkingHours": true,
+ "location": "string",
+ "identifier": "string",
+ "summary": "string",
+ "timezone": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "events": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "bgColor": "string",
+ "description": "string",
+ "endDateTime": "2019-08-24T14:15:22Z",
+ "fgColor": "string",
+ "iCalUid": "string",
+ "isFullDayEvent": true,
+ "isLocked": true,
+ "link": "string",
+ "location": "string",
+ "meetingLink": "string",
+ "identifier": "string",
+ "startDateTime": "2019-08-24T14:15:22Z",
+ "status": "confirmed",
+ "summary": "string",
+ "timezone": "string",
+ "calendarId": "string",
+ "parentEventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {},
+ "parentEvent": {},
+ "attendees": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "identifier": "string",
+ "isOptional": true,
+ "isOrganizer": true,
+ "messages": "string",
+ "responseStatus": "needsAction",
+ "eventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "event": {}
+ }
+ ],
+ "attachments": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "fileUrl": "string",
+ "iconLink": "string",
+ "mimeType": "string",
+ "title": "string",
+ "eventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "event": {}
+ }
+ ]
+ }
+ ],
+ "workingHours": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "dayOfWeek": 0,
+ "end": "string",
+ "start": "string",
+ "calendarId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {}
+ }
+ ],
+ "subscriptions": []
+ }
+ }
+ ]
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Calendar model instance|[CalendarWithRelations](#schemacalendarwithrelations)|
+
+
+This operation does not require authentication
+
+
+## CalendarController.deleteById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|Calendar DELETE success|None|
+
+
+This operation does not require authentication
+
+
+## CalendarController.create
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|body|body|[NewCalendar](#schemanewcalendar)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "source": "string",
+ "enableWorkingHours": true,
+ "location": "string",
+ "identifier": "string",
+ "summary": "string",
+ "timezone": "string",
+ "extId": "string",
+ "extMetadata": {}
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Calendar model instance|[Calendar](#schemacalendar)|
+
+
+This operation does not require authentication
+
+
+## CalendarController.updateAll
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|where|query|object|false|none|
+|body|body|[CalendarPartial](#schemacalendarpartial)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "count": 0
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Calendar PATCH success count|[loopback.Count](#schemaloopback.count)|
+
+
+This operation does not require authentication
+
+
+## CalendarController.find
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|filter|query|[calendars.Filter1](#schemacalendars.filter1)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+[
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "source": "string",
+ "enableWorkingHours": true,
+ "location": "string",
+ "identifier": "string",
+ "summary": "string",
+ "timezone": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "events": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "bgColor": "string",
+ "description": "string",
+ "endDateTime": "2019-08-24T14:15:22Z",
+ "fgColor": "string",
+ "iCalUid": "string",
+ "isFullDayEvent": true,
+ "isLocked": true,
+ "link": "string",
+ "location": "string",
+ "meetingLink": "string",
+ "identifier": "string",
+ "startDateTime": "2019-08-24T14:15:22Z",
+ "status": "confirmed",
+ "summary": "string",
+ "timezone": "string",
+ "calendarId": "string",
+ "parentEventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {},
+ "parentEvent": {},
+ "attendees": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "identifier": "string",
+ "isOptional": true,
+ "isOrganizer": true,
+ "messages": "string",
+ "responseStatus": "needsAction",
+ "eventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "event": {}
+ }
+ ],
+ "attachments": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "fileUrl": "string",
+ "iconLink": "string",
+ "mimeType": "string",
+ "title": "string",
+ "eventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "event": {}
+ }
+ ]
+ }
+ ],
+ "workingHours": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "dayOfWeek": 0,
+ "end": "string",
+ "start": "string",
+ "calendarId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {}
+ }
+ ],
+ "subscriptions": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "accessRole": "freeBusyReader",
+ "bgColor": "string",
+ "fgColor": "string",
+ "isHidden": true,
+ "isPrimary": true,
+ "identifier": "string",
+ "defaultReminders": {},
+ "notificationSettings": {},
+ "calendarId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {}
+ }
+ ]
+ }
+]
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Array of Calendar model instances|Inline|
+
+Response Schema
+
+Status Code **200**
+
+|Name|Type|Required|Restrictions|Description|
+|---|---|---|---|---|
+|*anonymous*|[[CalendarWithRelations](#schemacalendarwithrelations)]|false|none|[(tsType: CalendarWithRelations, schemaOptions: { includeRelations: true })]|
+|» CalendarWithRelations|[CalendarWithRelations](#schemacalendarwithrelations)|false|none|(tsType: CalendarWithRelations, schemaOptions: { includeRelations: true })|
+|»» deleted|boolean|false|none|none|
+|»» deletedOn|string(date-time)¦null|false|none|none|
+|»» deletedBy|string¦null|false|none|none|
+|»» createdOn|string(date-time)|false|none|none|
+|»» modifiedOn|string(date-time)|false|none|none|
+|»» createdBy|string|false|none|none|
+|»» modifiedBy|string|false|none|none|
+|»» id|string|false|none|none|
+|»» source|string|false|none|none|
+|»» enableWorkingHours|boolean|false|none|none|
+|»» location|string|false|none|none|
+|»» identifier|string|true|none|none|
+|»» summary|string|false|none|none|
+|»» timezone|string|false|none|none|
+|»» extId|string|false|none|none|
+|»» extMetadata|object|false|none|none|
+|»» events|[[EventWithRelations](#schemaeventwithrelations)]|false|none|(tsType: EventWithRelations, schemaOptions: { includeRelations: true })|
+|»»» EventWithRelations|[EventWithRelations](#schemaeventwithrelations)|false|none|(tsType: EventWithRelations, schemaOptions: { includeRelations: true })|
+|»»»» deleted|boolean|false|none|none|
+|»»»» deletedOn|string(date-time)¦null|false|none|none|
+|»»»» deletedBy|string¦null|false|none|none|
+|»»»» createdOn|string(date-time)|false|none|none|
+|»»»» modifiedOn|string(date-time)|false|none|none|
+|»»»» createdBy|string|false|none|none|
+|»»»» modifiedBy|string|false|none|none|
+|»»»» id|string|false|none|none|
+|»»»» bgColor|string|false|none|none|
+|»»»» description|string|false|none|none|
+|»»»» endDateTime|string(date-time)|false|none|none|
+|»»»» fgColor|string|false|none|none|
+|»»»» iCalUid|string|false|none|none|
+|»»»» isFullDayEvent|boolean|false|none|none|
+|»»»» isLocked|boolean|false|none|none|
+|»»»» link|string|false|none|none|
+|»»»» location|string|false|none|none|
+|»»»» meetingLink|string|false|none|none|
+|»»»» identifier|string|false|none|none|
+|»»»» startDateTime|string(date-time)|false|none|none|
+|»»»» status|string|false|none|none|
+|»»»» summary|string|false|none|none|
+|»»»» timezone|string|false|none|none|
+|»»»» calendarId|string|true|none|none|
+|»»»» parentEventId|string|false|none|none|
+|»»»» extId|string|false|none|none|
+|»»»» extMetadata|object|false|none|none|
+|»»»» calendar|[CalendarWithRelations](#schemacalendarwithrelations)|false|none|(tsType: CalendarWithRelations, schemaOptions: { includeRelations: true })|
+|»»»» parentEvent|[EventWithRelations](#schemaeventwithrelations)|false|none|(tsType: EventWithRelations, schemaOptions: { includeRelations: true })|
+|»»»» attendees|[[AttendeeWithRelations](#schemaattendeewithrelations)]|false|none|(tsType: AttendeeWithRelations, schemaOptions: { includeRelations: true })|
+|»»»»» AttendeeWithRelations|[AttendeeWithRelations](#schemaattendeewithrelations)|false|none|(tsType: AttendeeWithRelations, schemaOptions: { includeRelations: true })|
+|»»»»»» deleted|boolean|false|none|none|
+|»»»»»» deletedOn|string(date-time)¦null|false|none|none|
+|»»»»»» deletedBy|string¦null|false|none|none|
+|»»»»»» createdOn|string(date-time)|false|none|none|
+|»»»»»» modifiedOn|string(date-time)|false|none|none|
+|»»»»»» createdBy|string|false|none|none|
+|»»»»»» modifiedBy|string|false|none|none|
+|»»»»»» id|string|false|none|none|
+|»»»»»» identifier|string|true|none|none|
+|»»»»»» isOptional|boolean|false|none|none|
+|»»»»»» isOrganizer|boolean|false|none|none|
+|»»»»»» messages|string|false|none|none|
+|»»»»»» responseStatus|string|false|none|none|
+|»»»»»» eventId|string|true|none|none|
+|»»»»»» extId|string|false|none|none|
+|»»»»»» extMetadata|object|false|none|none|
+|»»»»»» event|[EventWithRelations](#schemaeventwithrelations)|false|none|(tsType: EventWithRelations, schemaOptions: { includeRelations: true })|
+|»»»» attachments|[[AttachmentWithRelations](#schemaattachmentwithrelations)]|false|none|(tsType: AttachmentWithRelations, schemaOptions: { includeRelations: true })|
+|»»»»» AttachmentWithRelations|[AttachmentWithRelations](#schemaattachmentwithrelations)|false|none|(tsType: AttachmentWithRelations, schemaOptions: { includeRelations: true })|
+|»»»»»» deleted|boolean|false|none|none|
+|»»»»»» deletedOn|string(date-time)¦null|false|none|none|
+|»»»»»» deletedBy|string¦null|false|none|none|
+|»»»»»» createdOn|string(date-time)|false|none|none|
+|»»»»»» modifiedOn|string(date-time)|false|none|none|
+|»»»»»» createdBy|string|false|none|none|
+|»»»»»» modifiedBy|string|false|none|none|
+|»»»»»» id|string|false|none|none|
+|»»»»»» fileUrl|string|true|none|none|
+|»»»»»» iconLink|string|false|none|none|
+|»»»»»» mimeType|string|false|none|none|
+|»»»»»» title|string|false|none|none|
+|»»»»»» eventId|string|true|none|none|
+|»»»»»» extId|string|false|none|none|
+|»»»»»» extMetadata|object|false|none|none|
+|»»»»»» event|[EventWithRelations](#schemaeventwithrelations)|false|none|(tsType: EventWithRelations, schemaOptions: { includeRelations: true })|
+|»» workingHours|[[WorkingHourWithRelations](#schemaworkinghourwithrelations)]|false|none|(tsType: WorkingHourWithRelations, schemaOptions: { includeRelations: true })|
+|»»» WorkingHourWithRelations|[WorkingHourWithRelations](#schemaworkinghourwithrelations)|false|none|(tsType: WorkingHourWithRelations, schemaOptions: { includeRelations: true })|
+|»»»» deleted|boolean|false|none|none|
+|»»»» deletedOn|string(date-time)¦null|false|none|none|
+|»»»» deletedBy|string¦null|false|none|none|
+|»»»» createdOn|string(date-time)|false|none|none|
+|»»»» modifiedOn|string(date-time)|false|none|none|
+|»»»» createdBy|string|false|none|none|
+|»»»» modifiedBy|string|false|none|none|
+|»»»» id|string|false|none|none|
+|»»»» dayOfWeek|number|false|none|none|
+|»»»» end|string|false|none|none|
+|»»»» start|string|false|none|none|
+|»»»» calendarId|string|true|none|none|
+|»»»» extId|string|false|none|none|
+|»»»» extMetadata|object|false|none|none|
+|»»»» calendar|[CalendarWithRelations](#schemacalendarwithrelations)|false|none|(tsType: CalendarWithRelations, schemaOptions: { includeRelations: true })|
+|»» subscriptions|[[SubscriptionWithRelations](#schemasubscriptionwithrelations)]|false|none|(tsType: SubscriptionWithRelations, schemaOptions: { includeRelations: true })|
+|»»» SubscriptionWithRelations|[SubscriptionWithRelations](#schemasubscriptionwithrelations)|false|none|(tsType: SubscriptionWithRelations, schemaOptions: { includeRelations: true })|
+|»»»» deleted|boolean|false|none|none|
+|»»»» deletedOn|string(date-time)¦null|false|none|none|
+|»»»» deletedBy|string¦null|false|none|none|
+|»»»» createdOn|string(date-time)|false|none|none|
+|»»»» modifiedOn|string(date-time)|false|none|none|
+|»»»» createdBy|string|false|none|none|
+|»»»» modifiedBy|string|false|none|none|
+|»»»» id|string|false|none|none|
+|»»»» accessRole|string|false|none|none|
+|»»»» bgColor|string|false|none|none|
+|»»»» fgColor|string|false|none|none|
+|»»»» isHidden|boolean|false|none|none|
+|»»»» isPrimary|boolean|false|none|none|
+|»»»» identifier|string|true|none|none|
+|»»»» defaultReminders|object|false|none|none|
+|»»»» notificationSettings|object|false|none|none|
+|»»»» calendarId|string|true|none|none|
+|»»»» extId|string|false|none|none|
+|»»»» extMetadata|object|false|none|none|
+|»»»» calendar|[CalendarWithRelations](#schemacalendarwithrelations)|false|none|(tsType: CalendarWithRelations, schemaOptions: { includeRelations: true })|
+
+#### Enumerated Values
+
+|Property|Value|
+|---|---|
+|status|confirmed|
+|status|tentative|
+|status|cancelled|
+|status|completed|
+|responseStatus|needsAction|
+|responseStatus|tentative|
+|responseStatus|accepted|
+|responseStatus|declined|
+|dayOfWeek|0|
+|dayOfWeek|1|
+|dayOfWeek|2|
+|dayOfWeek|3|
+|dayOfWeek|4|
+|dayOfWeek|5|
+|dayOfWeek|6|
+|accessRole|freeBusyReader|
+|accessRole|reader|
+|accessRole|writer|
+|accessRole|owner|
+
+
+This operation does not require authentication
+
+
+SubscriptionController
+
+## SubscriptionController.findMe
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|filter|query|[subscriptions.Filter](#schemasubscriptions.filter)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+[
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "accessRole": "freeBusyReader",
+ "bgColor": "string",
+ "fgColor": "string",
+ "isHidden": true,
+ "isPrimary": true,
+ "identifier": "string",
+ "defaultReminders": {},
+ "notificationSettings": {},
+ "calendarId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "source": "string",
+ "enableWorkingHours": true,
+ "location": "string",
+ "identifier": "string",
+ "summary": "string",
+ "timezone": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "events": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "bgColor": "string",
+ "description": "string",
+ "endDateTime": "2019-08-24T14:15:22Z",
+ "fgColor": "string",
+ "iCalUid": "string",
+ "isFullDayEvent": true,
+ "isLocked": true,
+ "link": "string",
+ "location": "string",
+ "meetingLink": "string",
+ "identifier": "string",
+ "startDateTime": "2019-08-24T14:15:22Z",
+ "status": "confirmed",
+ "summary": "string",
+ "timezone": "string",
+ "calendarId": "string",
+ "parentEventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {},
+ "parentEvent": {},
+ "attendees": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "identifier": "string",
+ "isOptional": true,
+ "isOrganizer": true,
+ "messages": "string",
+ "responseStatus": "needsAction",
+ "eventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "event": {}
+ }
+ ],
+ "attachments": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "fileUrl": "string",
+ "iconLink": "string",
+ "mimeType": "string",
+ "title": "string",
+ "eventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "event": {}
+ }
+ ]
+ }
+ ],
+ "workingHours": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "dayOfWeek": 0,
+ "end": "string",
+ "start": "string",
+ "calendarId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {}
+ }
+ ],
+ "subscriptions": [
+ {}
+ ]
+ }
+ }
+]
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Array of Subscription model instances|Inline|
+
+Response Schema
+
+Status Code **200**
+
+|Name|Type|Required|Restrictions|Description|
+|---|---|---|---|---|
+|*anonymous*|[[SubscriptionWithRelations](#schemasubscriptionwithrelations)]|false|none|[(tsType: SubscriptionWithRelations, schemaOptions: { includeRelations: true })]|
+|» SubscriptionWithRelations|[SubscriptionWithRelations](#schemasubscriptionwithrelations)|false|none|(tsType: SubscriptionWithRelations, schemaOptions: { includeRelations: true })|
+|»» deleted|boolean|false|none|none|
+|»» deletedOn|string(date-time)¦null|false|none|none|
+|»» deletedBy|string¦null|false|none|none|
+|»» createdOn|string(date-time)|false|none|none|
+|»» modifiedOn|string(date-time)|false|none|none|
+|»» createdBy|string|false|none|none|
+|»» modifiedBy|string|false|none|none|
+|»» id|string|false|none|none|
+|»» accessRole|string|false|none|none|
+|»» bgColor|string|false|none|none|
+|»» fgColor|string|false|none|none|
+|»» isHidden|boolean|false|none|none|
+|»» isPrimary|boolean|false|none|none|
+|»» identifier|string|true|none|none|
+|»» defaultReminders|object|false|none|none|
+|»» notificationSettings|object|false|none|none|
+|»» calendarId|string|true|none|none|
+|»» extId|string|false|none|none|
+|»» extMetadata|object|false|none|none|
+|»» calendar|[CalendarWithRelations](#schemacalendarwithrelations)|false|none|(tsType: CalendarWithRelations, schemaOptions: { includeRelations: true })|
+|»»» deleted|boolean|false|none|none|
+|»»» deletedOn|string(date-time)¦null|false|none|none|
+|»»» deletedBy|string¦null|false|none|none|
+|»»» createdOn|string(date-time)|false|none|none|
+|»»» modifiedOn|string(date-time)|false|none|none|
+|»»» createdBy|string|false|none|none|
+|»»» modifiedBy|string|false|none|none|
+|»»» id|string|false|none|none|
+|»»» source|string|false|none|none|
+|»»» enableWorkingHours|boolean|false|none|none|
+|»»» location|string|false|none|none|
+|»»» identifier|string|true|none|none|
+|»»» summary|string|false|none|none|
+|»»» timezone|string|false|none|none|
+|»»» extId|string|false|none|none|
+|»»» extMetadata|object|false|none|none|
+|»»» events|[[EventWithRelations](#schemaeventwithrelations)]|false|none|(tsType: EventWithRelations, schemaOptions: { includeRelations: true })|
+|»»»» EventWithRelations|[EventWithRelations](#schemaeventwithrelations)|false|none|(tsType: EventWithRelations, schemaOptions: { includeRelations: true })|
+|»»»»» deleted|boolean|false|none|none|
+|»»»»» deletedOn|string(date-time)¦null|false|none|none|
+|»»»»» deletedBy|string¦null|false|none|none|
+|»»»»» createdOn|string(date-time)|false|none|none|
+|»»»»» modifiedOn|string(date-time)|false|none|none|
+|»»»»» createdBy|string|false|none|none|
+|»»»»» modifiedBy|string|false|none|none|
+|»»»»» id|string|false|none|none|
+|»»»»» bgColor|string|false|none|none|
+|»»»»» description|string|false|none|none|
+|»»»»» endDateTime|string(date-time)|false|none|none|
+|»»»»» fgColor|string|false|none|none|
+|»»»»» iCalUid|string|false|none|none|
+|»»»»» isFullDayEvent|boolean|false|none|none|
+|»»»»» isLocked|boolean|false|none|none|
+|»»»»» link|string|false|none|none|
+|»»»»» location|string|false|none|none|
+|»»»»» meetingLink|string|false|none|none|
+|»»»»» identifier|string|false|none|none|
+|»»»»» startDateTime|string(date-time)|false|none|none|
+|»»»»» status|string|false|none|none|
+|»»»»» summary|string|false|none|none|
+|»»»»» timezone|string|false|none|none|
+|»»»»» calendarId|string|true|none|none|
+|»»»»» parentEventId|string|false|none|none|
+|»»»»» extId|string|false|none|none|
+|»»»»» extMetadata|object|false|none|none|
+|»»»»» calendar|[CalendarWithRelations](#schemacalendarwithrelations)|false|none|(tsType: CalendarWithRelations, schemaOptions: { includeRelations: true })|
+|»»»»» parentEvent|[EventWithRelations](#schemaeventwithrelations)|false|none|(tsType: EventWithRelations, schemaOptions: { includeRelations: true })|
+|»»»»» attendees|[[AttendeeWithRelations](#schemaattendeewithrelations)]|false|none|(tsType: AttendeeWithRelations, schemaOptions: { includeRelations: true })|
+|»»»»»» AttendeeWithRelations|[AttendeeWithRelations](#schemaattendeewithrelations)|false|none|(tsType: AttendeeWithRelations, schemaOptions: { includeRelations: true })|
+|»»»»»»» deleted|boolean|false|none|none|
+|»»»»»»» deletedOn|string(date-time)¦null|false|none|none|
+|»»»»»»» deletedBy|string¦null|false|none|none|
+|»»»»»»» createdOn|string(date-time)|false|none|none|
+|»»»»»»» modifiedOn|string(date-time)|false|none|none|
+|»»»»»»» createdBy|string|false|none|none|
+|»»»»»»» modifiedBy|string|false|none|none|
+|»»»»»»» id|string|false|none|none|
+|»»»»»»» identifier|string|true|none|none|
+|»»»»»»» isOptional|boolean|false|none|none|
+|»»»»»»» isOrganizer|boolean|false|none|none|
+|»»»»»»» messages|string|false|none|none|
+|»»»»»»» responseStatus|string|false|none|none|
+|»»»»»»» eventId|string|true|none|none|
+|»»»»»»» extId|string|false|none|none|
+|»»»»»»» extMetadata|object|false|none|none|
+|»»»»»»» event|[EventWithRelations](#schemaeventwithrelations)|false|none|(tsType: EventWithRelations, schemaOptions: { includeRelations: true })|
+|»»»»» attachments|[[AttachmentWithRelations](#schemaattachmentwithrelations)]|false|none|(tsType: AttachmentWithRelations, schemaOptions: { includeRelations: true })|
+|»»»»»» AttachmentWithRelations|[AttachmentWithRelations](#schemaattachmentwithrelations)|false|none|(tsType: AttachmentWithRelations, schemaOptions: { includeRelations: true })|
+|»»»»»»» deleted|boolean|false|none|none|
+|»»»»»»» deletedOn|string(date-time)¦null|false|none|none|
+|»»»»»»» deletedBy|string¦null|false|none|none|
+|»»»»»»» createdOn|string(date-time)|false|none|none|
+|»»»»»»» modifiedOn|string(date-time)|false|none|none|
+|»»»»»»» createdBy|string|false|none|none|
+|»»»»»»» modifiedBy|string|false|none|none|
+|»»»»»»» id|string|false|none|none|
+|»»»»»»» fileUrl|string|true|none|none|
+|»»»»»»» iconLink|string|false|none|none|
+|»»»»»»» mimeType|string|false|none|none|
+|»»»»»»» title|string|false|none|none|
+|»»»»»»» eventId|string|true|none|none|
+|»»»»»»» extId|string|false|none|none|
+|»»»»»»» extMetadata|object|false|none|none|
+|»»»»»»» event|[EventWithRelations](#schemaeventwithrelations)|false|none|(tsType: EventWithRelations, schemaOptions: { includeRelations: true })|
+|»»» workingHours|[[WorkingHourWithRelations](#schemaworkinghourwithrelations)]|false|none|(tsType: WorkingHourWithRelations, schemaOptions: { includeRelations: true })|
+|»»»» WorkingHourWithRelations|[WorkingHourWithRelations](#schemaworkinghourwithrelations)|false|none|(tsType: WorkingHourWithRelations, schemaOptions: { includeRelations: true })|
+|»»»»» deleted|boolean|false|none|none|
+|»»»»» deletedOn|string(date-time)¦null|false|none|none|
+|»»»»» deletedBy|string¦null|false|none|none|
+|»»»»» createdOn|string(date-time)|false|none|none|
+|»»»»» modifiedOn|string(date-time)|false|none|none|
+|»»»»» createdBy|string|false|none|none|
+|»»»»» modifiedBy|string|false|none|none|
+|»»»»» id|string|false|none|none|
+|»»»»» dayOfWeek|number|false|none|none|
+|»»»»» end|string|false|none|none|
+|»»»»» start|string|false|none|none|
+|»»»»» calendarId|string|true|none|none|
+|»»»»» extId|string|false|none|none|
+|»»»»» extMetadata|object|false|none|none|
+|»»»»» calendar|[CalendarWithRelations](#schemacalendarwithrelations)|false|none|(tsType: CalendarWithRelations, schemaOptions: { includeRelations: true })|
+|»»» subscriptions|[[SubscriptionWithRelations](#schemasubscriptionwithrelations)]|false|none|(tsType: SubscriptionWithRelations, schemaOptions: { includeRelations: true })|
+|»»»» SubscriptionWithRelations|[SubscriptionWithRelations](#schemasubscriptionwithrelations)|false|none|(tsType: SubscriptionWithRelations, schemaOptions: { includeRelations: true })|
+
+#### Enumerated Values
+
+|Property|Value|
+|---|---|
+|accessRole|freeBusyReader|
+|accessRole|reader|
+|accessRole|writer|
+|accessRole|owner|
+|status|confirmed|
+|status|tentative|
+|status|cancelled|
+|status|completed|
+|responseStatus|needsAction|
+|responseStatus|tentative|
+|responseStatus|accepted|
+|responseStatus|declined|
+|dayOfWeek|0|
+|dayOfWeek|1|
+|dayOfWeek|2|
+|dayOfWeek|3|
+|dayOfWeek|4|
+|dayOfWeek|5|
+|dayOfWeek|6|
+
+
+This operation does not require authentication
+
+
+## SubscriptionController.count
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|where|query|object|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "count": 0
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Subscription model count|[loopback.Count](#schemaloopback.count)|
+
+
+This operation does not require authentication
+
+
+## SubscriptionController.replaceById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|body|body|[Subscription](#schemasubscription)|false|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|Subscription PUT success|None|
+
+
+This operation does not require authentication
+
+
+## SubscriptionController.updateById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|body|body|[SubscriptionPartial](#schemasubscriptionpartial)|false|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|Subscription PATCH success|None|
+
+
+This operation does not require authentication
+
+
+## SubscriptionController.findById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|filter|query|[subscriptions.Filter1](#schemasubscriptions.filter1)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "accessRole": "freeBusyReader",
+ "bgColor": "string",
+ "fgColor": "string",
+ "isHidden": true,
+ "isPrimary": true,
+ "identifier": "string",
+ "defaultReminders": {},
+ "notificationSettings": {},
+ "calendarId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "source": "string",
+ "enableWorkingHours": true,
+ "location": "string",
+ "identifier": "string",
+ "summary": "string",
+ "timezone": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "events": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "bgColor": "string",
+ "description": "string",
+ "endDateTime": "2019-08-24T14:15:22Z",
+ "fgColor": "string",
+ "iCalUid": "string",
+ "isFullDayEvent": true,
+ "isLocked": true,
+ "link": "string",
+ "location": "string",
+ "meetingLink": "string",
+ "identifier": "string",
+ "startDateTime": "2019-08-24T14:15:22Z",
+ "status": "confirmed",
+ "summary": "string",
+ "timezone": "string",
+ "calendarId": "string",
+ "parentEventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {},
+ "parentEvent": {},
+ "attendees": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "identifier": "string",
+ "isOptional": true,
+ "isOrganizer": true,
+ "messages": "string",
+ "responseStatus": "needsAction",
+ "eventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "event": {}
+ }
+ ],
+ "attachments": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "fileUrl": "string",
+ "iconLink": "string",
+ "mimeType": "string",
+ "title": "string",
+ "eventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "event": {}
+ }
+ ]
+ }
+ ],
+ "workingHours": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "dayOfWeek": 0,
+ "end": "string",
+ "start": "string",
+ "calendarId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {}
+ }
+ ],
+ "subscriptions": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "accessRole": "freeBusyReader",
+ "bgColor": "string",
+ "fgColor": "string",
+ "isHidden": true,
+ "isPrimary": true,
+ "identifier": "string",
+ "defaultReminders": {},
+ "notificationSettings": {},
+ "calendarId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {}
+ }
+ ]
+ }
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Subscription model instance|[SubscriptionWithRelations](#schemasubscriptionwithrelations)|
+
+
+This operation does not require authentication
+
+
+## SubscriptionController.deleteById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|Subscription DELETE success|None|
+
+
+This operation does not require authentication
+
+
+## SubscriptionController.create
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|body|body|[NewSubscription](#schemanewsubscription)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "accessRole": "freeBusyReader",
+ "bgColor": "string",
+ "fgColor": "string",
+ "isHidden": true,
+ "isPrimary": true,
+ "identifier": "string",
+ "defaultReminders": {},
+ "notificationSettings": {},
+ "calendarId": "string",
+ "extId": "string",
+ "extMetadata": {}
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Subscription model instance|[Subscription](#schemasubscription)|
+
+
+This operation does not require authentication
+
+
+## SubscriptionController.updateAll
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|where|query|object|false|none|
+|body|body|[SubscriptionPartial](#schemasubscriptionpartial)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "count": 0
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Subscription PATCH success count|[loopback.Count](#schemaloopback.count)|
+
+
+This operation does not require authentication
+
+
+## SubscriptionController.find
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|filter|query|[subscriptions.Filter](#schemasubscriptions.filter)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+[
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "accessRole": "freeBusyReader",
+ "bgColor": "string",
+ "fgColor": "string",
+ "isHidden": true,
+ "isPrimary": true,
+ "identifier": "string",
+ "defaultReminders": {},
+ "notificationSettings": {},
+ "calendarId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "source": "string",
+ "enableWorkingHours": true,
+ "location": "string",
+ "identifier": "string",
+ "summary": "string",
+ "timezone": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "events": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "bgColor": "string",
+ "description": "string",
+ "endDateTime": "2019-08-24T14:15:22Z",
+ "fgColor": "string",
+ "iCalUid": "string",
+ "isFullDayEvent": true,
+ "isLocked": true,
+ "link": "string",
+ "location": "string",
+ "meetingLink": "string",
+ "identifier": "string",
+ "startDateTime": "2019-08-24T14:15:22Z",
+ "status": "confirmed",
+ "summary": "string",
+ "timezone": "string",
+ "calendarId": "string",
+ "parentEventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {},
+ "parentEvent": {},
+ "attendees": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "identifier": "string",
+ "isOptional": true,
+ "isOrganizer": true,
+ "messages": "string",
+ "responseStatus": "needsAction",
+ "eventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "event": {}
+ }
+ ],
+ "attachments": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "fileUrl": "string",
+ "iconLink": "string",
+ "mimeType": "string",
+ "title": "string",
+ "eventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "event": {}
+ }
+ ]
+ }
+ ],
+ "workingHours": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "dayOfWeek": 0,
+ "end": "string",
+ "start": "string",
+ "calendarId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {}
+ }
+ ],
+ "subscriptions": [
+ {}
+ ]
+ }
+ }
+]
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Array of Subscription model instances|Inline|
+
+Response Schema
+
+Status Code **200**
+
+|Name|Type|Required|Restrictions|Description|
+|---|---|---|---|---|
+|*anonymous*|[[SubscriptionWithRelations](#schemasubscriptionwithrelations)]|false|none|[(tsType: SubscriptionWithRelations, schemaOptions: { includeRelations: true })]|
+|» SubscriptionWithRelations|[SubscriptionWithRelations](#schemasubscriptionwithrelations)|false|none|(tsType: SubscriptionWithRelations, schemaOptions: { includeRelations: true })|
+|»» deleted|boolean|false|none|none|
+|»» deletedOn|string(date-time)¦null|false|none|none|
+|»» deletedBy|string¦null|false|none|none|
+|»» createdOn|string(date-time)|false|none|none|
+|»» modifiedOn|string(date-time)|false|none|none|
+|»» createdBy|string|false|none|none|
+|»» modifiedBy|string|false|none|none|
+|»» id|string|false|none|none|
+|»» accessRole|string|false|none|none|
+|»» bgColor|string|false|none|none|
+|»» fgColor|string|false|none|none|
+|»» isHidden|boolean|false|none|none|
+|»» isPrimary|boolean|false|none|none|
+|»» identifier|string|true|none|none|
+|»» defaultReminders|object|false|none|none|
+|»» notificationSettings|object|false|none|none|
+|»» calendarId|string|true|none|none|
+|»» extId|string|false|none|none|
+|»» extMetadata|object|false|none|none|
+|»» calendar|[CalendarWithRelations](#schemacalendarwithrelations)|false|none|(tsType: CalendarWithRelations, schemaOptions: { includeRelations: true })|
+|»»» deleted|boolean|false|none|none|
+|»»» deletedOn|string(date-time)¦null|false|none|none|
+|»»» deletedBy|string¦null|false|none|none|
+|»»» createdOn|string(date-time)|false|none|none|
+|»»» modifiedOn|string(date-time)|false|none|none|
+|»»» createdBy|string|false|none|none|
+|»»» modifiedBy|string|false|none|none|
+|»»» id|string|false|none|none|
+|»»» source|string|false|none|none|
+|»»» enableWorkingHours|boolean|false|none|none|
+|»»» location|string|false|none|none|
+|»»» identifier|string|true|none|none|
+|»»» summary|string|false|none|none|
+|»»» timezone|string|false|none|none|
+|»»» extId|string|false|none|none|
+|»»» extMetadata|object|false|none|none|
+|»»» events|[[EventWithRelations](#schemaeventwithrelations)]|false|none|(tsType: EventWithRelations, schemaOptions: { includeRelations: true })|
+|»»»» EventWithRelations|[EventWithRelations](#schemaeventwithrelations)|false|none|(tsType: EventWithRelations, schemaOptions: { includeRelations: true })|
+|»»»»» deleted|boolean|false|none|none|
+|»»»»» deletedOn|string(date-time)¦null|false|none|none|
+|»»»»» deletedBy|string¦null|false|none|none|
+|»»»»» createdOn|string(date-time)|false|none|none|
+|»»»»» modifiedOn|string(date-time)|false|none|none|
+|»»»»» createdBy|string|false|none|none|
+|»»»»» modifiedBy|string|false|none|none|
+|»»»»» id|string|false|none|none|
+|»»»»» bgColor|string|false|none|none|
+|»»»»» description|string|false|none|none|
+|»»»»» endDateTime|string(date-time)|false|none|none|
+|»»»»» fgColor|string|false|none|none|
+|»»»»» iCalUid|string|false|none|none|
+|»»»»» isFullDayEvent|boolean|false|none|none|
+|»»»»» isLocked|boolean|false|none|none|
+|»»»»» link|string|false|none|none|
+|»»»»» location|string|false|none|none|
+|»»»»» meetingLink|string|false|none|none|
+|»»»»» identifier|string|false|none|none|
+|»»»»» startDateTime|string(date-time)|false|none|none|
+|»»»»» status|string|false|none|none|
+|»»»»» summary|string|false|none|none|
+|»»»»» timezone|string|false|none|none|
+|»»»»» calendarId|string|true|none|none|
+|»»»»» parentEventId|string|false|none|none|
+|»»»»» extId|string|false|none|none|
+|»»»»» extMetadata|object|false|none|none|
+|»»»»» calendar|[CalendarWithRelations](#schemacalendarwithrelations)|false|none|(tsType: CalendarWithRelations, schemaOptions: { includeRelations: true })|
+|»»»»» parentEvent|[EventWithRelations](#schemaeventwithrelations)|false|none|(tsType: EventWithRelations, schemaOptions: { includeRelations: true })|
+|»»»»» attendees|[[AttendeeWithRelations](#schemaattendeewithrelations)]|false|none|(tsType: AttendeeWithRelations, schemaOptions: { includeRelations: true })|
+|»»»»»» AttendeeWithRelations|[AttendeeWithRelations](#schemaattendeewithrelations)|false|none|(tsType: AttendeeWithRelations, schemaOptions: { includeRelations: true })|
+|»»»»»»» deleted|boolean|false|none|none|
+|»»»»»»» deletedOn|string(date-time)¦null|false|none|none|
+|»»»»»»» deletedBy|string¦null|false|none|none|
+|»»»»»»» createdOn|string(date-time)|false|none|none|
+|»»»»»»» modifiedOn|string(date-time)|false|none|none|
+|»»»»»»» createdBy|string|false|none|none|
+|»»»»»»» modifiedBy|string|false|none|none|
+|»»»»»»» id|string|false|none|none|
+|»»»»»»» identifier|string|true|none|none|
+|»»»»»»» isOptional|boolean|false|none|none|
+|»»»»»»» isOrganizer|boolean|false|none|none|
+|»»»»»»» messages|string|false|none|none|
+|»»»»»»» responseStatus|string|false|none|none|
+|»»»»»»» eventId|string|true|none|none|
+|»»»»»»» extId|string|false|none|none|
+|»»»»»»» extMetadata|object|false|none|none|
+|»»»»»»» event|[EventWithRelations](#schemaeventwithrelations)|false|none|(tsType: EventWithRelations, schemaOptions: { includeRelations: true })|
+|»»»»» attachments|[[AttachmentWithRelations](#schemaattachmentwithrelations)]|false|none|(tsType: AttachmentWithRelations, schemaOptions: { includeRelations: true })|
+|»»»»»» AttachmentWithRelations|[AttachmentWithRelations](#schemaattachmentwithrelations)|false|none|(tsType: AttachmentWithRelations, schemaOptions: { includeRelations: true })|
+|»»»»»»» deleted|boolean|false|none|none|
+|»»»»»»» deletedOn|string(date-time)¦null|false|none|none|
+|»»»»»»» deletedBy|string¦null|false|none|none|
+|»»»»»»» createdOn|string(date-time)|false|none|none|
+|»»»»»»» modifiedOn|string(date-time)|false|none|none|
+|»»»»»»» createdBy|string|false|none|none|
+|»»»»»»» modifiedBy|string|false|none|none|
+|»»»»»»» id|string|false|none|none|
+|»»»»»»» fileUrl|string|true|none|none|
+|»»»»»»» iconLink|string|false|none|none|
+|»»»»»»» mimeType|string|false|none|none|
+|»»»»»»» title|string|false|none|none|
+|»»»»»»» eventId|string|true|none|none|
+|»»»»»»» extId|string|false|none|none|
+|»»»»»»» extMetadata|object|false|none|none|
+|»»»»»»» event|[EventWithRelations](#schemaeventwithrelations)|false|none|(tsType: EventWithRelations, schemaOptions: { includeRelations: true })|
+|»»» workingHours|[[WorkingHourWithRelations](#schemaworkinghourwithrelations)]|false|none|(tsType: WorkingHourWithRelations, schemaOptions: { includeRelations: true })|
+|»»»» WorkingHourWithRelations|[WorkingHourWithRelations](#schemaworkinghourwithrelations)|false|none|(tsType: WorkingHourWithRelations, schemaOptions: { includeRelations: true })|
+|»»»»» deleted|boolean|false|none|none|
+|»»»»» deletedOn|string(date-time)¦null|false|none|none|
+|»»»»» deletedBy|string¦null|false|none|none|
+|»»»»» createdOn|string(date-time)|false|none|none|
+|»»»»» modifiedOn|string(date-time)|false|none|none|
+|»»»»» createdBy|string|false|none|none|
+|»»»»» modifiedBy|string|false|none|none|
+|»»»»» id|string|false|none|none|
+|»»»»» dayOfWeek|number|false|none|none|
+|»»»»» end|string|false|none|none|
+|»»»»» start|string|false|none|none|
+|»»»»» calendarId|string|true|none|none|
+|»»»»» extId|string|false|none|none|
+|»»»»» extMetadata|object|false|none|none|
+|»»»»» calendar|[CalendarWithRelations](#schemacalendarwithrelations)|false|none|(tsType: CalendarWithRelations, schemaOptions: { includeRelations: true })|
+|»»» subscriptions|[[SubscriptionWithRelations](#schemasubscriptionwithrelations)]|false|none|(tsType: SubscriptionWithRelations, schemaOptions: { includeRelations: true })|
+|»»»» SubscriptionWithRelations|[SubscriptionWithRelations](#schemasubscriptionwithrelations)|false|none|(tsType: SubscriptionWithRelations, schemaOptions: { includeRelations: true })|
+
+#### Enumerated Values
+
+|Property|Value|
+|---|---|
+|accessRole|freeBusyReader|
+|accessRole|reader|
+|accessRole|writer|
+|accessRole|owner|
+|status|confirmed|
+|status|tentative|
+|status|cancelled|
+|status|completed|
+|responseStatus|needsAction|
+|responseStatus|tentative|
+|responseStatus|accepted|
+|responseStatus|declined|
+|dayOfWeek|0|
+|dayOfWeek|1|
+|dayOfWeek|2|
+|dayOfWeek|3|
+|dayOfWeek|4|
+|dayOfWeek|5|
+|dayOfWeek|6|
+
+
+This operation does not require authentication
+
+
+CalendarEventController
+
+## CalendarEventController.create
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|body|body|[NewEventInCalendar](#schemaneweventincalendar)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "bgColor": "string",
+ "description": "string",
+ "endDateTime": "2019-08-24T14:15:22Z",
+ "fgColor": "string",
+ "iCalUid": "string",
+ "isFullDayEvent": true,
+ "isLocked": true,
+ "link": "string",
+ "location": "string",
+ "meetingLink": "string",
+ "identifier": "string",
+ "startDateTime": "2019-08-24T14:15:22Z",
+ "status": "confirmed",
+ "summary": "string",
+ "timezone": "string",
+ "calendarId": "string",
+ "parentEventId": "string",
+ "extId": "string",
+ "extMetadata": {}
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Calendar model instance|[Event](#schemaevent)|
+
+
+This operation does not require authentication
+
+
+## CalendarEventController.patch
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|where|query|object|false|none|
+|body|body|[EventPartial](#schemaeventpartial)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "count": 0
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Calendar.Event PATCH success count|[loopback.Count](#schemaloopback.count)|
+
+
+This operation does not require authentication
+
+
+## CalendarEventController.find
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|filter|query|object|false|none|
+|timeMax|query|string(date-time)|false|none|
+|timeMin|query|string(date-time)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+[
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "bgColor": "string",
+ "description": "string",
+ "endDateTime": "2019-08-24T14:15:22Z",
+ "fgColor": "string",
+ "iCalUid": "string",
+ "isFullDayEvent": true,
+ "isLocked": true,
+ "link": "string",
+ "location": "string",
+ "meetingLink": "string",
+ "identifier": "string",
+ "startDateTime": "2019-08-24T14:15:22Z",
+ "status": "confirmed",
+ "summary": "string",
+ "timezone": "string",
+ "calendarId": "string",
+ "parentEventId": "string",
+ "extId": "string",
+ "extMetadata": {}
+ }
+]
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Array of Calendar has many Event|Inline|
+
+Response Schema
+
+Status Code **200**
+
+|Name|Type|Required|Restrictions|Description|
+|---|---|---|---|---|
+|*anonymous*|[[Event](#schemaevent)]|false|none|none|
+|» Event|[Event](#schemaevent)|false|none|none|
+|»» deleted|boolean|false|none|none|
+|»» deletedOn|string(date-time)¦null|false|none|none|
+|»» deletedBy|string¦null|false|none|none|
+|»» createdOn|string(date-time)|false|none|none|
+|»» modifiedOn|string(date-time)|false|none|none|
+|»» createdBy|string|false|none|none|
+|»» modifiedBy|string|false|none|none|
+|»» id|string|false|none|none|
+|»» bgColor|string|false|none|none|
+|»» description|string|false|none|none|
+|»» endDateTime|string(date-time)|false|none|none|
+|»» fgColor|string|false|none|none|
+|»» iCalUid|string|false|none|none|
+|»» isFullDayEvent|boolean|false|none|none|
+|»» isLocked|boolean|false|none|none|
+|»» link|string|false|none|none|
+|»» location|string|false|none|none|
+|»» meetingLink|string|false|none|none|
+|»» identifier|string|false|none|none|
+|»» startDateTime|string(date-time)|false|none|none|
+|»» status|string|false|none|none|
+|»» summary|string|false|none|none|
+|»» timezone|string|false|none|none|
+|»» calendarId|string|true|none|none|
+|»» parentEventId|string|false|none|none|
+|»» extId|string|false|none|none|
+|»» extMetadata|object|false|none|none|
+
+#### Enumerated Values
+
+|Property|Value|
+|---|---|
+|status|confirmed|
+|status|tentative|
+|status|cancelled|
+|status|completed|
+
+
+This operation does not require authentication
+
+
+## CalendarEventController.delete
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|where|query|object|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "count": 0
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Calendar.Event DELETE success count|[loopback.Count](#schemaloopback.count)|
+
+
+This operation does not require authentication
+
+
+CalendarSubscriptionController
+
+## CalendarSubscriptionController.create
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|body|body|[NewSubscriptionInCalendar](#schemanewsubscriptionincalendar)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "accessRole": "freeBusyReader",
+ "bgColor": "string",
+ "fgColor": "string",
+ "isHidden": true,
+ "isPrimary": true,
+ "identifier": "string",
+ "defaultReminders": {},
+ "notificationSettings": {},
+ "calendarId": "string",
+ "extId": "string",
+ "extMetadata": {}
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Calendar model instance|[Subscription](#schemasubscription)|
+
+
+This operation does not require authentication
+
+
+## CalendarSubscriptionController.patch
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|where|query|object|false|none|
+|body|body|[SubscriptionPartial](#schemasubscriptionpartial)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "count": 0
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Calendar.Subscription PATCH success count|[loopback.Count](#schemaloopback.count)|
+
+
+This operation does not require authentication
+
+
+## CalendarSubscriptionController.find
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|filter|query|object|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+[
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "accessRole": "freeBusyReader",
+ "bgColor": "string",
+ "fgColor": "string",
+ "isHidden": true,
+ "isPrimary": true,
+ "identifier": "string",
+ "defaultReminders": {},
+ "notificationSettings": {},
+ "calendarId": "string",
+ "extId": "string",
+ "extMetadata": {}
+ }
+]
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Array of Calendar has many Subscriptions|Inline|
+
+Response Schema
+
+Status Code **200**
+
+|Name|Type|Required|Restrictions|Description|
+|---|---|---|---|---|
+|*anonymous*|[[Subscription](#schemasubscription)]|false|none|none|
+|» Subscription|[Subscription](#schemasubscription)|false|none|none|
+|»» deleted|boolean|false|none|none|
+|»» deletedOn|string(date-time)¦null|false|none|none|
+|»» deletedBy|string¦null|false|none|none|
+|»» createdOn|string(date-time)|false|none|none|
+|»» modifiedOn|string(date-time)|false|none|none|
+|»» createdBy|string|false|none|none|
+|»» modifiedBy|string|false|none|none|
+|»» id|string|false|none|none|
+|»» accessRole|string|false|none|none|
+|»» bgColor|string|false|none|none|
+|»» fgColor|string|false|none|none|
+|»» isHidden|boolean|false|none|none|
+|»» isPrimary|boolean|false|none|none|
+|»» identifier|string|true|none|none|
+|»» defaultReminders|object|false|none|none|
+|»» notificationSettings|object|false|none|none|
+|»» calendarId|string|true|none|none|
+|»» extId|string|false|none|none|
+|»» extMetadata|object|false|none|none|
+
+#### Enumerated Values
+
+|Property|Value|
+|---|---|
+|accessRole|freeBusyReader|
+|accessRole|reader|
+|accessRole|writer|
+|accessRole|owner|
+
+
+This operation does not require authentication
+
+
+## CalendarSubscriptionController.delete
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|where|query|object|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "count": 0
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Calendar.Subscription DELETE success count|[loopback.Count](#schemaloopback.count)|
+
+
+This operation does not require authentication
+
+
+CalendarWorkingHourController
+
+## CalendarWorkingHourController.create
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|body|body|[NewWorkingHourInCalendar](#schemanewworkinghourincalendar)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "dayOfWeek": 0,
+ "end": "string",
+ "start": "string",
+ "calendarId": "string",
+ "extId": "string",
+ "extMetadata": {}
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Calendar model instance|[WorkingHour](#schemaworkinghour)|
+
+
+This operation does not require authentication
+
+
+## CalendarWorkingHourController.patch
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|where|query|object|false|none|
+|body|body|[WorkingHourPartial](#schemaworkinghourpartial)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "count": 0
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Calendar.WorkingHour PATCH success count|[loopback.Count](#schemaloopback.count)|
+
+
+This operation does not require authentication
+
+
+## CalendarWorkingHourController.find
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|filter|query|object|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+[
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "dayOfWeek": 0,
+ "end": "string",
+ "start": "string",
+ "calendarId": "string",
+ "extId": "string",
+ "extMetadata": {}
+ }
+]
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Array of Calendar has many WorkingHour|Inline|
+
+Response Schema
+
+Status Code **200**
+
+|Name|Type|Required|Restrictions|Description|
+|---|---|---|---|---|
+|*anonymous*|[[WorkingHour](#schemaworkinghour)]|false|none|none|
+|» WorkingHour|[WorkingHour](#schemaworkinghour)|false|none|none|
+|»» deleted|boolean|false|none|none|
+|»» deletedOn|string(date-time)¦null|false|none|none|
+|»» deletedBy|string¦null|false|none|none|
+|»» createdOn|string(date-time)|false|none|none|
+|»» modifiedOn|string(date-time)|false|none|none|
+|»» createdBy|string|false|none|none|
+|»» modifiedBy|string|false|none|none|
+|»» id|string|false|none|none|
+|»» dayOfWeek|number|false|none|none|
+|»» end|string|false|none|none|
+|»» start|string|false|none|none|
+|»» calendarId|string|true|none|none|
+|»» extId|string|false|none|none|
+|»» extMetadata|object|false|none|none|
+
+#### Enumerated Values
+
+|Property|Value|
+|---|---|
+|dayOfWeek|0|
+|dayOfWeek|1|
+|dayOfWeek|2|
+|dayOfWeek|3|
+|dayOfWeek|4|
+|dayOfWeek|5|
+|dayOfWeek|6|
+
+
+This operation does not require authentication
+
+
+## CalendarWorkingHourController.delete
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|where|query|object|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "count": 0
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Calendar.WorkingHour DELETE success count|[loopback.Count](#schemaloopback.count)|
+
+
+This operation does not require authentication
+
+
+EventController
+
+## EventController.count
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|where|query|object|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "count": 0
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Event model count|[loopback.Count](#schemaloopback.count)|
+
+
+This operation does not require authentication
+
+
+## EventController.getFeeBusyStatus
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|body|body|[FreeBusyRequest](#schemafreebusyrequest)|false|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Return value of EventController.getFeeBusyStatus|None|
+
+
+This operation does not require authentication
+
+
+## EventController.replaceById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|body|body|[Event](#schemaevent)|false|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|Event PUT success|None|
+
+
+This operation does not require authentication
+
+
+## EventController.updateById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|body|body|[EventPartial](#schemaeventpartial)|false|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|Event PATCH success|None|
+
+
+This operation does not require authentication
+
+
+## EventController.findById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|filter|query|[events.Filter](#schemaevents.filter)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "bgColor": "string",
+ "description": "string",
+ "endDateTime": "2019-08-24T14:15:22Z",
+ "fgColor": "string",
+ "iCalUid": "string",
+ "isFullDayEvent": true,
+ "isLocked": true,
+ "link": "string",
+ "location": "string",
+ "meetingLink": "string",
+ "identifier": "string",
+ "startDateTime": "2019-08-24T14:15:22Z",
+ "status": "confirmed",
+ "summary": "string",
+ "timezone": "string",
+ "calendarId": "string",
+ "parentEventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "source": "string",
+ "enableWorkingHours": true,
+ "location": "string",
+ "identifier": "string",
+ "summary": "string",
+ "timezone": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "events": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "bgColor": "string",
+ "description": "string",
+ "endDateTime": "2019-08-24T14:15:22Z",
+ "fgColor": "string",
+ "iCalUid": "string",
+ "isFullDayEvent": true,
+ "isLocked": true,
+ "link": "string",
+ "location": "string",
+ "meetingLink": "string",
+ "identifier": "string",
+ "startDateTime": "2019-08-24T14:15:22Z",
+ "status": "confirmed",
+ "summary": "string",
+ "timezone": "string",
+ "calendarId": "string",
+ "parentEventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {},
+ "parentEvent": {},
+ "attendees": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "identifier": "string",
+ "isOptional": true,
+ "isOrganizer": true,
+ "messages": "string",
+ "responseStatus": "needsAction",
+ "eventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "event": {}
+ }
+ ],
+ "attachments": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "fileUrl": "string",
+ "iconLink": "string",
+ "mimeType": "string",
+ "title": "string",
+ "eventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "event": {}
+ }
+ ]
+ }
+ ],
+ "workingHours": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "dayOfWeek": 0,
+ "end": "string",
+ "start": "string",
+ "calendarId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {}
+ }
+ ],
+ "subscriptions": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "accessRole": "freeBusyReader",
+ "bgColor": "string",
+ "fgColor": "string",
+ "isHidden": true,
+ "isPrimary": true,
+ "identifier": "string",
+ "defaultReminders": {},
+ "notificationSettings": {},
+ "calendarId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {}
+ }
+ ]
+ },
+ "parentEvent": {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "bgColor": "string",
+ "description": "string",
+ "endDateTime": "2019-08-24T14:15:22Z",
+ "fgColor": "string",
+ "iCalUid": "string",
+ "isFullDayEvent": true,
+ "isLocked": true,
+ "link": "string",
+ "location": "string",
+ "meetingLink": "string",
+ "identifier": "string",
+ "startDateTime": "2019-08-24T14:15:22Z",
+ "status": "confirmed",
+ "summary": "string",
+ "timezone": "string",
+ "calendarId": "string",
+ "parentEventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "source": "string",
+ "enableWorkingHours": true,
+ "location": "string",
+ "identifier": "string",
+ "summary": "string",
+ "timezone": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "events": [
+ {}
+ ],
+ "workingHours": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "dayOfWeek": 0,
+ "end": "string",
+ "start": "string",
+ "calendarId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {}
+ }
+ ],
+ "subscriptions": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "accessRole": "freeBusyReader",
+ "bgColor": "string",
+ "fgColor": "string",
+ "isHidden": true,
+ "isPrimary": true,
+ "identifier": "string",
+ "defaultReminders": {},
+ "notificationSettings": {},
+ "calendarId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {}
+ }
+ ]
+ },
+ "parentEvent": {},
+ "attendees": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "identifier": "string",
+ "isOptional": true,
+ "isOrganizer": true,
+ "messages": "string",
+ "responseStatus": "needsAction",
+ "eventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "event": {}
+ }
+ ],
+ "attachments": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "fileUrl": "string",
+ "iconLink": "string",
+ "mimeType": "string",
+ "title": "string",
+ "eventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "event": {}
+ }
+ ]
+ },
+ "attendees": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "identifier": "string",
+ "isOptional": true,
+ "isOrganizer": true,
+ "messages": "string",
+ "responseStatus": "needsAction",
+ "eventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "event": {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "bgColor": "string",
+ "description": "string",
+ "endDateTime": "2019-08-24T14:15:22Z",
+ "fgColor": "string",
+ "iCalUid": "string",
+ "isFullDayEvent": true,
+ "isLocked": true,
+ "link": "string",
+ "location": "string",
+ "meetingLink": "string",
+ "identifier": "string",
+ "startDateTime": "2019-08-24T14:15:22Z",
+ "status": "confirmed",
+ "summary": "string",
+ "timezone": "string",
+ "calendarId": "string",
+ "parentEventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "source": "string",
+ "enableWorkingHours": true,
+ "location": "string",
+ "identifier": "string",
+ "summary": "string",
+ "timezone": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "events": [
+ {}
+ ],
+ "workingHours": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "dayOfWeek": 0,
+ "end": "string",
+ "start": "string",
+ "calendarId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {}
+ }
+ ],
+ "subscriptions": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "accessRole": "freeBusyReader",
+ "bgColor": "string",
+ "fgColor": "string",
+ "isHidden": true,
+ "isPrimary": true,
+ "identifier": "string",
+ "defaultReminders": {},
+ "notificationSettings": {},
+ "calendarId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {}
+ }
+ ]
+ },
+ "parentEvent": {},
+ "attendees": [],
+ "attachments": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "fileUrl": "string",
+ "iconLink": "string",
+ "mimeType": "string",
+ "title": "string",
+ "eventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "event": {}
+ }
+ ]
+ }
+ }
+ ],
+ "attachments": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "fileUrl": "string",
+ "iconLink": "string",
+ "mimeType": "string",
+ "title": "string",
+ "eventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "event": {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "bgColor": "string",
+ "description": "string",
+ "endDateTime": "2019-08-24T14:15:22Z",
+ "fgColor": "string",
+ "iCalUid": "string",
+ "isFullDayEvent": true,
+ "isLocked": true,
+ "link": "string",
+ "location": "string",
+ "meetingLink": "string",
+ "identifier": "string",
+ "startDateTime": "2019-08-24T14:15:22Z",
+ "status": "confirmed",
+ "summary": "string",
+ "timezone": "string",
+ "calendarId": "string",
+ "parentEventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "source": "string",
+ "enableWorkingHours": true,
+ "location": "string",
+ "identifier": "string",
+ "summary": "string",
+ "timezone": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "events": [
+ {}
+ ],
+ "workingHours": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "dayOfWeek": 0,
+ "end": "string",
+ "start": "string",
+ "calendarId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {}
+ }
+ ],
+ "subscriptions": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "accessRole": "freeBusyReader",
+ "bgColor": "string",
+ "fgColor": "string",
+ "isHidden": true,
+ "isPrimary": true,
+ "identifier": "string",
+ "defaultReminders": {},
+ "notificationSettings": {},
+ "calendarId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {}
+ }
+ ]
+ },
+ "parentEvent": {},
+ "attendees": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "identifier": "string",
+ "isOptional": true,
+ "isOrganizer": true,
+ "messages": "string",
+ "responseStatus": "needsAction",
+ "eventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "event": {}
+ }
+ ],
+ "attachments": []
+ }
+ }
+ ]
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Event model instance|[EventWithRelations](#schemaeventwithrelations)|
+
+
+This operation does not require authentication
+
+
+## EventController.deleteById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|Event DELETE success|None|
+
+
+This operation does not require authentication
+
+
+## EventController.create
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|body|body|[NewEvent](#schemanewevent)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "bgColor": "string",
+ "description": "string",
+ "endDateTime": "2019-08-24T14:15:22Z",
+ "fgColor": "string",
+ "iCalUid": "string",
+ "isFullDayEvent": true,
+ "isLocked": true,
+ "link": "string",
+ "location": "string",
+ "meetingLink": "string",
+ "identifier": "string",
+ "startDateTime": "2019-08-24T14:15:22Z",
+ "status": "confirmed",
+ "summary": "string",
+ "timezone": "string",
+ "calendarId": "string",
+ "parentEventId": "string",
+ "extId": "string",
+ "extMetadata": {}
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Event model instance|[Event](#schemaevent)|
+
+
+This operation does not require authentication
+
+
+## EventController.updateAll
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|where|query|object|false|none|
+|body|body|[EventPartial](#schemaeventpartial)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "count": 0
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Event PATCH success count|[loopback.Count](#schemaloopback.count)|
+
+
+This operation does not require authentication
+
+
+## EventController.find
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|filter|query|[events_attendees_view.Filter](#schemaevents_attendees_view.filter)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+[
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "bgColor": "string",
+ "description": "string",
+ "endDateTime": "2019-08-24T14:15:22Z",
+ "fgColor": "string",
+ "iCalUid": "string",
+ "isFullDayEvent": true,
+ "isLocked": true,
+ "link": "string",
+ "location": "string",
+ "meetingLink": "string",
+ "identifier": "string",
+ "startDateTime": "2019-08-24T14:15:22Z",
+ "status": "confirmed",
+ "summary": "string",
+ "timezone": "string",
+ "calendarId": "string",
+ "parentEventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "source": "string",
+ "enableWorkingHours": true,
+ "location": "string",
+ "identifier": "string",
+ "summary": "string",
+ "timezone": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "events": [
+ {}
+ ],
+ "workingHours": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "dayOfWeek": 0,
+ "end": "string",
+ "start": "string",
+ "calendarId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {}
+ }
+ ],
+ "subscriptions": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "accessRole": "freeBusyReader",
+ "bgColor": "string",
+ "fgColor": "string",
+ "isHidden": true,
+ "isPrimary": true,
+ "identifier": "string",
+ "defaultReminders": {},
+ "notificationSettings": {},
+ "calendarId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {}
+ }
+ ]
+ },
+ "parentEvent": {},
+ "attendees": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "identifier": "string",
+ "isOptional": true,
+ "isOrganizer": true,
+ "messages": "string",
+ "responseStatus": "needsAction",
+ "eventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "event": {}
+ }
+ ],
+ "attachments": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "fileUrl": "string",
+ "iconLink": "string",
+ "mimeType": "string",
+ "title": "string",
+ "eventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "event": {}
+ }
+ ]
+ }
+]
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Array of Event model instances|Inline|
+
+Response Schema
+
+Status Code **200**
+
+|Name|Type|Required|Restrictions|Description|
+|---|---|---|---|---|
+|*anonymous*|[[EventWithRelations](#schemaeventwithrelations)]|false|none|[(tsType: EventWithRelations, schemaOptions: { includeRelations: true })]|
+|» EventWithRelations|[EventWithRelations](#schemaeventwithrelations)|false|none|(tsType: EventWithRelations, schemaOptions: { includeRelations: true })|
+|»» deleted|boolean|false|none|none|
+|»» deletedOn|string(date-time)¦null|false|none|none|
+|»» deletedBy|string¦null|false|none|none|
+|»» createdOn|string(date-time)|false|none|none|
+|»» modifiedOn|string(date-time)|false|none|none|
+|»» createdBy|string|false|none|none|
+|»» modifiedBy|string|false|none|none|
+|»» id|string|false|none|none|
+|»» bgColor|string|false|none|none|
+|»» description|string|false|none|none|
+|»» endDateTime|string(date-time)|false|none|none|
+|»» fgColor|string|false|none|none|
+|»» iCalUid|string|false|none|none|
+|»» isFullDayEvent|boolean|false|none|none|
+|»» isLocked|boolean|false|none|none|
+|»» link|string|false|none|none|
+|»» location|string|false|none|none|
+|»» meetingLink|string|false|none|none|
+|»» identifier|string|false|none|none|
+|»» startDateTime|string(date-time)|false|none|none|
+|»» status|string|false|none|none|
+|»» summary|string|false|none|none|
+|»» timezone|string|false|none|none|
+|»» calendarId|string|true|none|none|
+|»» parentEventId|string|false|none|none|
+|»» extId|string|false|none|none|
+|»» extMetadata|object|false|none|none|
+|»» calendar|[CalendarWithRelations](#schemacalendarwithrelations)|false|none|(tsType: CalendarWithRelations, schemaOptions: { includeRelations: true })|
+|»»» deleted|boolean|false|none|none|
+|»»» deletedOn|string(date-time)¦null|false|none|none|
+|»»» deletedBy|string¦null|false|none|none|
+|»»» createdOn|string(date-time)|false|none|none|
+|»»» modifiedOn|string(date-time)|false|none|none|
+|»»» createdBy|string|false|none|none|
+|»»» modifiedBy|string|false|none|none|
+|»»» id|string|false|none|none|
+|»»» source|string|false|none|none|
+|»»» enableWorkingHours|boolean|false|none|none|
+|»»» location|string|false|none|none|
+|»»» identifier|string|true|none|none|
+|»»» summary|string|false|none|none|
+|»»» timezone|string|false|none|none|
+|»»» extId|string|false|none|none|
+|»»» extMetadata|object|false|none|none|
+|»»» events|[[EventWithRelations](#schemaeventwithrelations)]|false|none|(tsType: EventWithRelations, schemaOptions: { includeRelations: true })|
+|»»»» EventWithRelations|[EventWithRelations](#schemaeventwithrelations)|false|none|(tsType: EventWithRelations, schemaOptions: { includeRelations: true })|
+|»»» workingHours|[[WorkingHourWithRelations](#schemaworkinghourwithrelations)]|false|none|(tsType: WorkingHourWithRelations, schemaOptions: { includeRelations: true })|
+|»»»» WorkingHourWithRelations|[WorkingHourWithRelations](#schemaworkinghourwithrelations)|false|none|(tsType: WorkingHourWithRelations, schemaOptions: { includeRelations: true })|
+|»»»»» deleted|boolean|false|none|none|
+|»»»»» deletedOn|string(date-time)¦null|false|none|none|
+|»»»»» deletedBy|string¦null|false|none|none|
+|»»»»» createdOn|string(date-time)|false|none|none|
+|»»»»» modifiedOn|string(date-time)|false|none|none|
+|»»»»» createdBy|string|false|none|none|
+|»»»»» modifiedBy|string|false|none|none|
+|»»»»» id|string|false|none|none|
+|»»»»» dayOfWeek|number|false|none|none|
+|»»»»» end|string|false|none|none|
+|»»»»» start|string|false|none|none|
+|»»»»» calendarId|string|true|none|none|
+|»»»»» extId|string|false|none|none|
+|»»»»» extMetadata|object|false|none|none|
+|»»»»» calendar|[CalendarWithRelations](#schemacalendarwithrelations)|false|none|(tsType: CalendarWithRelations, schemaOptions: { includeRelations: true })|
+|»»» subscriptions|[[SubscriptionWithRelations](#schemasubscriptionwithrelations)]|false|none|(tsType: SubscriptionWithRelations, schemaOptions: { includeRelations: true })|
+|»»»» SubscriptionWithRelations|[SubscriptionWithRelations](#schemasubscriptionwithrelations)|false|none|(tsType: SubscriptionWithRelations, schemaOptions: { includeRelations: true })|
+|»»»»» deleted|boolean|false|none|none|
+|»»»»» deletedOn|string(date-time)¦null|false|none|none|
+|»»»»» deletedBy|string¦null|false|none|none|
+|»»»»» createdOn|string(date-time)|false|none|none|
+|»»»»» modifiedOn|string(date-time)|false|none|none|
+|»»»»» createdBy|string|false|none|none|
+|»»»»» modifiedBy|string|false|none|none|
+|»»»»» id|string|false|none|none|
+|»»»»» accessRole|string|false|none|none|
+|»»»»» bgColor|string|false|none|none|
+|»»»»» fgColor|string|false|none|none|
+|»»»»» isHidden|boolean|false|none|none|
+|»»»»» isPrimary|boolean|false|none|none|
+|»»»»» identifier|string|true|none|none|
+|»»»»» defaultReminders|object|false|none|none|
+|»»»»» notificationSettings|object|false|none|none|
+|»»»»» calendarId|string|true|none|none|
+|»»»»» extId|string|false|none|none|
+|»»»»» extMetadata|object|false|none|none|
+|»»»»» calendar|[CalendarWithRelations](#schemacalendarwithrelations)|false|none|(tsType: CalendarWithRelations, schemaOptions: { includeRelations: true })|
+|»» parentEvent|[EventWithRelations](#schemaeventwithrelations)|false|none|(tsType: EventWithRelations, schemaOptions: { includeRelations: true })|
+|»» attendees|[[AttendeeWithRelations](#schemaattendeewithrelations)]|false|none|(tsType: AttendeeWithRelations, schemaOptions: { includeRelations: true })|
+|»»» AttendeeWithRelations|[AttendeeWithRelations](#schemaattendeewithrelations)|false|none|(tsType: AttendeeWithRelations, schemaOptions: { includeRelations: true })|
+|»»»» deleted|boolean|false|none|none|
+|»»»» deletedOn|string(date-time)¦null|false|none|none|
+|»»»» deletedBy|string¦null|false|none|none|
+|»»»» createdOn|string(date-time)|false|none|none|
+|»»»» modifiedOn|string(date-time)|false|none|none|
+|»»»» createdBy|string|false|none|none|
+|»»»» modifiedBy|string|false|none|none|
+|»»»» id|string|false|none|none|
+|»»»» identifier|string|true|none|none|
+|»»»» isOptional|boolean|false|none|none|
+|»»»» isOrganizer|boolean|false|none|none|
+|»»»» messages|string|false|none|none|
+|»»»» responseStatus|string|false|none|none|
+|»»»» eventId|string|true|none|none|
+|»»»» extId|string|false|none|none|
+|»»»» extMetadata|object|false|none|none|
+|»»»» event|[EventWithRelations](#schemaeventwithrelations)|false|none|(tsType: EventWithRelations, schemaOptions: { includeRelations: true })|
+|»» attachments|[[AttachmentWithRelations](#schemaattachmentwithrelations)]|false|none|(tsType: AttachmentWithRelations, schemaOptions: { includeRelations: true })|
+|»»» AttachmentWithRelations|[AttachmentWithRelations](#schemaattachmentwithrelations)|false|none|(tsType: AttachmentWithRelations, schemaOptions: { includeRelations: true })|
+|»»»» deleted|boolean|false|none|none|
+|»»»» deletedOn|string(date-time)¦null|false|none|none|
+|»»»» deletedBy|string¦null|false|none|none|
+|»»»» createdOn|string(date-time)|false|none|none|
+|»»»» modifiedOn|string(date-time)|false|none|none|
+|»»»» createdBy|string|false|none|none|
+|»»»» modifiedBy|string|false|none|none|
+|»»»» id|string|false|none|none|
+|»»»» fileUrl|string|true|none|none|
+|»»»» iconLink|string|false|none|none|
+|»»»» mimeType|string|false|none|none|
+|»»»» title|string|false|none|none|
+|»»»» eventId|string|true|none|none|
+|»»»» extId|string|false|none|none|
+|»»»» extMetadata|object|false|none|none|
+|»»»» event|[EventWithRelations](#schemaeventwithrelations)|false|none|(tsType: EventWithRelations, schemaOptions: { includeRelations: true })|
+
+#### Enumerated Values
+
+|Property|Value|
+|---|---|
+|status|confirmed|
+|status|tentative|
+|status|cancelled|
+|status|completed|
+|dayOfWeek|0|
+|dayOfWeek|1|
+|dayOfWeek|2|
+|dayOfWeek|3|
+|dayOfWeek|4|
+|dayOfWeek|5|
+|dayOfWeek|6|
+|accessRole|freeBusyReader|
+|accessRole|reader|
+|accessRole|writer|
+|accessRole|owner|
+|responseStatus|needsAction|
+|responseStatus|tentative|
+|responseStatus|accepted|
+|responseStatus|declined|
+
+
+This operation does not require authentication
+
+
+EventAttachmentController
+
+## EventAttachmentController.create
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|body|body|[NewAttachmentInEvent](#schemanewattachmentinevent)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "fileUrl": "string",
+ "iconLink": "string",
+ "mimeType": "string",
+ "title": "string",
+ "eventId": "string",
+ "extId": "string",
+ "extMetadata": {}
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Event model instance|[Attachment](#schemaattachment)|
+
+
+This operation does not require authentication
+
+
+## EventAttachmentController.patch
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|where|query|object|false|none|
+|body|body|[AttachmentPartial](#schemaattachmentpartial)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "count": 0
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Event.Attachment PATCH success count|[loopback.Count](#schemaloopback.count)|
+
+
+This operation does not require authentication
+
+
+## EventAttachmentController.find
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|filter|query|object|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+[
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "fileUrl": "string",
+ "iconLink": "string",
+ "mimeType": "string",
+ "title": "string",
+ "eventId": "string",
+ "extId": "string",
+ "extMetadata": {}
+ }
+]
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Array of Event has many Attachment|Inline|
+
+Response Schema
+
+Status Code **200**
+
+|Name|Type|Required|Restrictions|Description|
+|---|---|---|---|---|
+|*anonymous*|[[Attachment](#schemaattachment)]|false|none|none|
+|» Attachment|[Attachment](#schemaattachment)|false|none|none|
+|»» deleted|boolean|false|none|none|
+|»» deletedOn|string(date-time)¦null|false|none|none|
+|»» deletedBy|string¦null|false|none|none|
+|»» createdOn|string(date-time)|false|none|none|
+|»» modifiedOn|string(date-time)|false|none|none|
+|»» createdBy|string|false|none|none|
+|»» modifiedBy|string|false|none|none|
+|»» id|string|false|none|none|
+|»» fileUrl|string|true|none|none|
+|»» iconLink|string|false|none|none|
+|»» mimeType|string|false|none|none|
+|»» title|string|false|none|none|
+|»» eventId|string|true|none|none|
+|»» extId|string|false|none|none|
+|»» extMetadata|object|false|none|none|
+
+
+This operation does not require authentication
+
+
+## EventAttachmentController.delete
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|where|query|object|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "count": 0
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Event.Attachment DELETE success count|[loopback.Count](#schemaloopback.count)|
+
+
+This operation does not require authentication
+
+
+EventAttendeeController
+
+## EventAttendeeController.create
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|body|body|[NewAttendeeInEvent](#schemanewattendeeinevent)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "identifier": "string",
+ "isOptional": true,
+ "isOrganizer": true,
+ "messages": "string",
+ "responseStatus": "needsAction",
+ "eventId": "string",
+ "extId": "string",
+ "extMetadata": {}
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Event model instance|[Attendee](#schemaattendee)|
+
+
+This operation does not require authentication
+
+
+## EventAttendeeController.patch
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|where|query|object|false|none|
+|body|body|[AttendeePartial](#schemaattendeepartial)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "count": 0
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Event.Attendee PATCH success count|[loopback.Count](#schemaloopback.count)|
+
+
+This operation does not require authentication
+
+
+## EventAttendeeController.find
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|filter|query|object|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+[
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "identifier": "string",
+ "isOptional": true,
+ "isOrganizer": true,
+ "messages": "string",
+ "responseStatus": "needsAction",
+ "eventId": "string",
+ "extId": "string",
+ "extMetadata": {}
+ }
+]
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Array of Event has many Attendee|Inline|
+
+Response Schema
+
+Status Code **200**
+
+|Name|Type|Required|Restrictions|Description|
+|---|---|---|---|---|
+|*anonymous*|[[Attendee](#schemaattendee)]|false|none|none|
+|» Attendee|[Attendee](#schemaattendee)|false|none|none|
+|»» deleted|boolean|false|none|none|
+|»» deletedOn|string(date-time)¦null|false|none|none|
+|»» deletedBy|string¦null|false|none|none|
+|»» createdOn|string(date-time)|false|none|none|
+|»» modifiedOn|string(date-time)|false|none|none|
+|»» createdBy|string|false|none|none|
+|»» modifiedBy|string|false|none|none|
+|»» id|string|false|none|none|
+|»» identifier|string|true|none|none|
+|»» isOptional|boolean|false|none|none|
+|»» isOrganizer|boolean|false|none|none|
+|»» messages|string|false|none|none|
+|»» responseStatus|string|false|none|none|
+|»» eventId|string|true|none|none|
+|»» extId|string|false|none|none|
+|»» extMetadata|object|false|none|none|
+
+#### Enumerated Values
+
+|Property|Value|
+|---|---|
+|responseStatus|needsAction|
+|responseStatus|tentative|
+|responseStatus|accepted|
+|responseStatus|declined|
+
+
+This operation does not require authentication
+
+
+## EventAttendeeController.delete
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|where|query|object|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "count": 0
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Event.Attendee DELETE success count|[loopback.Count](#schemaloopback.count)|
+
+
+This operation does not require authentication
+
+
+SettingsController
+
+## SettingsController.count
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|where|query|object|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "count": 0
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Settings model count|[loopback.Count](#schemaloopback.count)|
+
+
+This operation does not require authentication
+
+
+## SettingsController.replaceById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|body|body|[Settings](#schemasettings)|false|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|Settings PUT success|None|
+
+
+This operation does not require authentication
+
+
+## SettingsController.updateById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|body|body|[SettingsPartial](#schemasettingspartial)|false|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|Settings PATCH success|None|
+
+
+This operation does not require authentication
+
+
+## SettingsController.findById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|filter|query|[settings.Filter](#schemasettings.filter)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "ownerId": "string",
+ "ownerType": "global",
+ "settingName": "string",
+ "settingValue": "string",
+ "extId": "string",
+ "extMetadata": {}
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Settings model instance|[SettingsWithRelations](#schemasettingswithrelations)|
+
+
+This operation does not require authentication
+
+
+## SettingsController.deleteById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|Settings DELETE success|None|
+
+
+This operation does not require authentication
+
+
+## SettingsController.create
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|body|body|[NewSettings](#schemanewsettings)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "ownerId": "string",
+ "ownerType": "global",
+ "settingName": "string",
+ "settingValue": "string",
+ "extId": "string",
+ "extMetadata": {}
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Settings model instance|[Settings](#schemasettings)|
+
+
+This operation does not require authentication
+
+
+## SettingsController.updateAll
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|where|query|object|false|none|
+|body|body|[SettingsPartial](#schemasettingspartial)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "count": 0
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Settings PATCH success count|[loopback.Count](#schemaloopback.count)|
+
+
+This operation does not require authentication
+
+
+## SettingsController.find
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|filter|query|[settings.Filter1](#schemasettings.filter1)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+[
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "ownerId": "string",
+ "ownerType": "global",
+ "settingName": "string",
+ "settingValue": "string",
+ "extId": "string",
+ "extMetadata": {}
+ }
+]
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Array of Settings model instances|Inline|
+
+Response Schema
+
+Status Code **200**
+
+|Name|Type|Required|Restrictions|Description|
+|---|---|---|---|---|
+|*anonymous*|[[SettingsWithRelations](#schemasettingswithrelations)]|false|none|[(tsType: SettingsWithRelations, schemaOptions: { includeRelations: true })]|
+|» SettingsWithRelations|[SettingsWithRelations](#schemasettingswithrelations)|false|none|(tsType: SettingsWithRelations, schemaOptions: { includeRelations: true })|
+|»» deleted|boolean|false|none|none|
+|»» deletedOn|string(date-time)¦null|false|none|none|
+|»» deletedBy|string¦null|false|none|none|
+|»» createdOn|string(date-time)|false|none|none|
+|»» modifiedOn|string(date-time)|false|none|none|
+|»» createdBy|string|false|none|none|
+|»» modifiedBy|string|false|none|none|
+|»» id|string|false|none|none|
+|»» ownerId|string|true|none|none|
+|»» ownerType|string|false|none|none|
+|»» settingName|string|false|none|none|
+|»» settingValue|string|false|none|none|
+|»» extId|string|false|none|none|
+|»» extMetadata|object|false|none|none|
+
+#### Enumerated Values
+
+|Property|Value|
+|---|---|
+|ownerType|global|
+|ownerType|user|
+|ownerType|calendar|
+|ownerType|event|
+
+
+This operation does not require authentication
+
+
+ThemeController
+
+## ThemeController.count
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|where|query|object|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "count": 0
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Theme model count|[loopback.Count](#schemaloopback.count)|
+
+
+This operation does not require authentication
+
+
+## ThemeController.replaceById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|body|body|[Theme](#schematheme)|false|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|Theme PUT success|None|
+
+
+This operation does not require authentication
+
+
+## ThemeController.updateById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|body|body|[ThemePartial](#schemathemepartial)|false|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|Theme PATCH success|None|
+
+
+This operation does not require authentication
+
+
+## ThemeController.findById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|filter|query|[themes.Filter](#schemathemes.filter)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "calBg": "string",
+ "calFg": "string",
+ "eventBg": "string",
+ "eventFg": "string",
+ "extId": "string",
+ "extMetadata": {}
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Theme model instance|[ThemeWithRelations](#schemathemewithrelations)|
+
+
+This operation does not require authentication
+
+
+## ThemeController.deleteById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|Theme DELETE success|None|
+
+
+This operation does not require authentication
+
+
+## ThemeController.create
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|body|body|[NewTheme](#schemanewtheme)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "calBg": "string",
+ "calFg": "string",
+ "eventBg": "string",
+ "eventFg": "string",
+ "extId": "string",
+ "extMetadata": {}
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Theme model instance|[Theme](#schematheme)|
+
+
+This operation does not require authentication
+
+
+## ThemeController.updateAll
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|where|query|object|false|none|
+|body|body|[ThemePartial](#schemathemepartial)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "count": 0
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Theme PATCH success count|[loopback.Count](#schemaloopback.count)|
+
+
+This operation does not require authentication
+
+
+## ThemeController.find
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|filter|query|[themes.Filter1](#schemathemes.filter1)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+[
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "calBg": "string",
+ "calFg": "string",
+ "eventBg": "string",
+ "eventFg": "string",
+ "extId": "string",
+ "extMetadata": {}
+ }
+]
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Array of Theme model instances|Inline|
+
+Response Schema
+
+Status Code **200**
+
+|Name|Type|Required|Restrictions|Description|
+|---|---|---|---|---|
+|*anonymous*|[[ThemeWithRelations](#schemathemewithrelations)]|false|none|[(tsType: ThemeWithRelations, schemaOptions: { includeRelations: true })]|
+|» ThemeWithRelations|[ThemeWithRelations](#schemathemewithrelations)|false|none|(tsType: ThemeWithRelations, schemaOptions: { includeRelations: true })|
+|»» deleted|boolean|false|none|none|
+|»» deletedOn|string(date-time)¦null|false|none|none|
+|»» deletedBy|string¦null|false|none|none|
+|»» createdOn|string(date-time)|false|none|none|
+|»» modifiedOn|string(date-time)|false|none|none|
+|»» createdBy|string|false|none|none|
+|»» modifiedBy|string|false|none|none|
+|»» id|string|false|none|none|
+|»» calBg|string|false|none|none|
+|»» calFg|string|false|none|none|
+|»» eventBg|string|false|none|none|
+|»» eventFg|string|false|none|none|
+|»» extId|string|false|none|none|
+|»» extMetadata|object|false|none|none|
+
+
+This operation does not require authentication
+
+
+WorkingHourController
+
+## WorkingHourController.count
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|where|query|object|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "count": 0
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|WorkingHour model count|[loopback.Count](#schemaloopback.count)|
+
+
+This operation does not require authentication
+
+
+## WorkingHourController.replaceById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|body|body|[WorkingHour](#schemaworkinghour)|false|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|WorkingHour PUT success|None|
+
+
+This operation does not require authentication
+
+
+## WorkingHourController.updateById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|body|body|[WorkingHourPartial](#schemaworkinghourpartial)|false|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|WorkingHour PATCH success|None|
+
+
+This operation does not require authentication
+
+
+## WorkingHourController.findById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+|filter|query|[working_hours.Filter](#schemaworking_hours.filter)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "dayOfWeek": 0,
+ "end": "string",
+ "start": "string",
+ "calendarId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "source": "string",
+ "enableWorkingHours": true,
+ "location": "string",
+ "identifier": "string",
+ "summary": "string",
+ "timezone": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "events": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "bgColor": "string",
+ "description": "string",
+ "endDateTime": "2019-08-24T14:15:22Z",
+ "fgColor": "string",
+ "iCalUid": "string",
+ "isFullDayEvent": true,
+ "isLocked": true,
+ "link": "string",
+ "location": "string",
+ "meetingLink": "string",
+ "identifier": "string",
+ "startDateTime": "2019-08-24T14:15:22Z",
+ "status": "confirmed",
+ "summary": "string",
+ "timezone": "string",
+ "calendarId": "string",
+ "parentEventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {},
+ "parentEvent": {},
+ "attendees": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "identifier": "string",
+ "isOptional": true,
+ "isOrganizer": true,
+ "messages": "string",
+ "responseStatus": "needsAction",
+ "eventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "event": {}
+ }
+ ],
+ "attachments": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "fileUrl": "string",
+ "iconLink": "string",
+ "mimeType": "string",
+ "title": "string",
+ "eventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "event": {}
+ }
+ ]
+ }
+ ],
+ "workingHours": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "dayOfWeek": 0,
+ "end": "string",
+ "start": "string",
+ "calendarId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {}
+ }
+ ],
+ "subscriptions": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "accessRole": "freeBusyReader",
+ "bgColor": "string",
+ "fgColor": "string",
+ "isHidden": true,
+ "isPrimary": true,
+ "identifier": "string",
+ "defaultReminders": {},
+ "notificationSettings": {},
+ "calendarId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {}
+ }
+ ]
+ }
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|WorkingHour model instance|[WorkingHourWithRelations](#schemaworkinghourwithrelations)|
+
+
+This operation does not require authentication
+
+
+## WorkingHourController.deleteById
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|id|path|string|true|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|WorkingHour DELETE success|None|
+
+
+This operation does not require authentication
+
+
+## WorkingHourController.create
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|body|body|[NewWorkingHour](#schemanewworkinghour)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "dayOfWeek": 0,
+ "end": "string",
+ "start": "string",
+ "calendarId": "string",
+ "extId": "string",
+ "extMetadata": {}
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|WorkingHour model instance|[WorkingHour](#schemaworkinghour)|
+
+
+This operation does not require authentication
+
+
+## WorkingHourController.updateAll
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|where|query|object|false|none|
+|body|body|[WorkingHourPartial](#schemaworkinghourpartial)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{
+ "count": 0
+}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|WorkingHour PATCH success count|[loopback.Count](#schemaloopback.count)|
+
+
+This operation does not require authentication
+
+
+## WorkingHourController.find
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|filter|query|[working_hours.Filter1](#schemaworking_hours.filter1)|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+[
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "dayOfWeek": 0,
+ "end": "string",
+ "start": "string",
+ "calendarId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "source": "string",
+ "enableWorkingHours": true,
+ "location": "string",
+ "identifier": "string",
+ "summary": "string",
+ "timezone": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "events": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "bgColor": "string",
+ "description": "string",
+ "endDateTime": "2019-08-24T14:15:22Z",
+ "fgColor": "string",
+ "iCalUid": "string",
+ "isFullDayEvent": true,
+ "isLocked": true,
+ "link": "string",
+ "location": "string",
+ "meetingLink": "string",
+ "identifier": "string",
+ "startDateTime": "2019-08-24T14:15:22Z",
+ "status": "confirmed",
+ "summary": "string",
+ "timezone": "string",
+ "calendarId": "string",
+ "parentEventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {},
+ "parentEvent": {},
+ "attendees": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "identifier": "string",
+ "isOptional": true,
+ "isOrganizer": true,
+ "messages": "string",
+ "responseStatus": "needsAction",
+ "eventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "event": {}
+ }
+ ],
+ "attachments": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "fileUrl": "string",
+ "iconLink": "string",
+ "mimeType": "string",
+ "title": "string",
+ "eventId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "event": {}
+ }
+ ]
+ }
+ ],
+ "workingHours": [
+ {}
+ ],
+ "subscriptions": [
+ {
+ "deleted": true,
+ "deletedOn": "2019-08-24T14:15:22Z",
+ "deletedBy": "string",
+ "createdOn": "2019-08-24T14:15:22Z",
+ "modifiedOn": "2019-08-24T14:15:22Z",
+ "createdBy": "string",
+ "modifiedBy": "string",
+ "id": "string",
+ "accessRole": "freeBusyReader",
+ "bgColor": "string",
+ "fgColor": "string",
+ "isHidden": true,
+ "isPrimary": true,
+ "identifier": "string",
+ "defaultReminders": {},
+ "notificationSettings": {},
+ "calendarId": "string",
+ "extId": "string",
+ "extMetadata": {},
+ "calendar": {}
+ }
+ ]
+ }
+ }
+]
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Array of WorkingHour model instances|Inline|
+
+Response Schema
+
+Status Code **200**
+
+|Name|Type|Required|Restrictions|Description|
+|---|---|---|---|---|
+|*anonymous*|[[WorkingHourWithRelations](#schemaworkinghourwithrelations)]|false|none|[(tsType: WorkingHourWithRelations, schemaOptions: { includeRelations: true })]|
+|» WorkingHourWithRelations|[WorkingHourWithRelations](#schemaworkinghourwithrelations)|false|none|(tsType: WorkingHourWithRelations, schemaOptions: { includeRelations: true })|
+|»» deleted|boolean|false|none|none|
+|»» deletedOn|string(date-time)¦null|false|none|none|
+|»» deletedBy|string¦null|false|none|none|
+|»» createdOn|string(date-time)|false|none|none|
+|»» modifiedOn|string(date-time)|false|none|none|
+|»» createdBy|string|false|none|none|
+|»» modifiedBy|string|false|none|none|
+|»» id|string|false|none|none|
+|»» dayOfWeek|number|false|none|none|
+|»» end|string|false|none|none|
+|»» start|string|false|none|none|
+|»» calendarId|string|true|none|none|
+|»» extId|string|false|none|none|
+|»» extMetadata|object|false|none|none|
+|»» calendar|[CalendarWithRelations](#schemacalendarwithrelations)|false|none|(tsType: CalendarWithRelations, schemaOptions: { includeRelations: true })|
+|»»» deleted|boolean|false|none|none|
+|»»» deletedOn|string(date-time)¦null|false|none|none|
+|»»» deletedBy|string¦null|false|none|none|
+|»»» createdOn|string(date-time)|false|none|none|
+|»»» modifiedOn|string(date-time)|false|none|none|
+|»»» createdBy|string|false|none|none|
+|»»» modifiedBy|string|false|none|none|
+|»»» id|string|false|none|none|
+|»»» source|string|false|none|none|
+|»»» enableWorkingHours|boolean|false|none|none|
+|»»» location|string|false|none|none|
+|»»» identifier|string|true|none|none|
+|»»» summary|string|false|none|none|
+|»»» timezone|string|false|none|none|
+|»»» extId|string|false|none|none|
+|»»» extMetadata|object|false|none|none|
+|»»» events|[[EventWithRelations](#schemaeventwithrelations)]|false|none|(tsType: EventWithRelations, schemaOptions: { includeRelations: true })|
+|»»»» EventWithRelations|[EventWithRelations](#schemaeventwithrelations)|false|none|(tsType: EventWithRelations, schemaOptions: { includeRelations: true })|
+|»»»»» deleted|boolean|false|none|none|
+|»»»»» deletedOn|string(date-time)¦null|false|none|none|
+|»»»»» deletedBy|string¦null|false|none|none|
+|»»»»» createdOn|string(date-time)|false|none|none|
+|»»»»» modifiedOn|string(date-time)|false|none|none|
+|»»»»» createdBy|string|false|none|none|
+|»»»»» modifiedBy|string|false|none|none|
+|»»»»» id|string|false|none|none|
+|»»»»» bgColor|string|false|none|none|
+|»»»»» description|string|false|none|none|
+|»»»»» endDateTime|string(date-time)|false|none|none|
+|»»»»» fgColor|string|false|none|none|
+|»»»»» iCalUid|string|false|none|none|
+|»»»»» isFullDayEvent|boolean|false|none|none|
+|»»»»» isLocked|boolean|false|none|none|
+|»»»»» link|string|false|none|none|
+|»»»»» location|string|false|none|none|
+|»»»»» meetingLink|string|false|none|none|
+|»»»»» identifier|string|false|none|none|
+|»»»»» startDateTime|string(date-time)|false|none|none|
+|»»»»» status|string|false|none|none|
+|»»»»» summary|string|false|none|none|
+|»»»»» timezone|string|false|none|none|
+|»»»»» calendarId|string|true|none|none|
+|»»»»» parentEventId|string|false|none|none|
+|»»»»» extId|string|false|none|none|
+|»»»»» extMetadata|object|false|none|none|
+|»»»»» calendar|[CalendarWithRelations](#schemacalendarwithrelations)|false|none|(tsType: CalendarWithRelations, schemaOptions: { includeRelations: true })|
+|»»»»» parentEvent|[EventWithRelations](#schemaeventwithrelations)|false|none|(tsType: EventWithRelations, schemaOptions: { includeRelations: true })|
+|»»»»» attendees|[[AttendeeWithRelations](#schemaattendeewithrelations)]|false|none|(tsType: AttendeeWithRelations, schemaOptions: { includeRelations: true })|
+|»»»»»» AttendeeWithRelations|[AttendeeWithRelations](#schemaattendeewithrelations)|false|none|(tsType: AttendeeWithRelations, schemaOptions: { includeRelations: true })|
+|»»»»»»» deleted|boolean|false|none|none|
+|»»»»»»» deletedOn|string(date-time)¦null|false|none|none|
+|»»»»»»» deletedBy|string¦null|false|none|none|
+|»»»»»»» createdOn|string(date-time)|false|none|none|
+|»»»»»»» modifiedOn|string(date-time)|false|none|none|
+|»»»»»»» createdBy|string|false|none|none|
+|»»»»»»» modifiedBy|string|false|none|none|
+|»»»»»»» id|string|false|none|none|
+|»»»»»»» identifier|string|true|none|none|
+|»»»»»»» isOptional|boolean|false|none|none|
+|»»»»»»» isOrganizer|boolean|false|none|none|
+|»»»»»»» messages|string|false|none|none|
+|»»»»»»» responseStatus|string|false|none|none|
+|»»»»»»» eventId|string|true|none|none|
+|»»»»»»» extId|string|false|none|none|
+|»»»»»»» extMetadata|object|false|none|none|
+|»»»»»»» event|[EventWithRelations](#schemaeventwithrelations)|false|none|(tsType: EventWithRelations, schemaOptions: { includeRelations: true })|
+|»»»»» attachments|[[AttachmentWithRelations](#schemaattachmentwithrelations)]|false|none|(tsType: AttachmentWithRelations, schemaOptions: { includeRelations: true })|
+|»»»»»» AttachmentWithRelations|[AttachmentWithRelations](#schemaattachmentwithrelations)|false|none|(tsType: AttachmentWithRelations, schemaOptions: { includeRelations: true })|
+|»»»»»»» deleted|boolean|false|none|none|
+|»»»»»»» deletedOn|string(date-time)¦null|false|none|none|
+|»»»»»»» deletedBy|string¦null|false|none|none|
+|»»»»»»» createdOn|string(date-time)|false|none|none|
+|»»»»»»» modifiedOn|string(date-time)|false|none|none|
+|»»»»»»» createdBy|string|false|none|none|
+|»»»»»»» modifiedBy|string|false|none|none|
+|»»»»»»» id|string|false|none|none|
+|»»»»»»» fileUrl|string|true|none|none|
+|»»»»»»» iconLink|string|false|none|none|
+|»»»»»»» mimeType|string|false|none|none|
+|»»»»»»» title|string|false|none|none|
+|»»»»»»» eventId|string|true|none|none|
+|»»»»»»» extId|string|false|none|none|
+|»»»»»»» extMetadata|object|false|none|none|
+|»»»»»»» event|[EventWithRelations](#schemaeventwithrelations)|false|none|(tsType: EventWithRelations, schemaOptions: { includeRelations: true })|
+|»»» workingHours|[[WorkingHourWithRelations](#schemaworkinghourwithrelations)]|false|none|(tsType: WorkingHourWithRelations, schemaOptions: { includeRelations: true })|
+|»»»» WorkingHourWithRelations|[WorkingHourWithRelations](#schemaworkinghourwithrelations)|false|none|(tsType: WorkingHourWithRelations, schemaOptions: { includeRelations: true })|
+|»»» subscriptions|[[SubscriptionWithRelations](#schemasubscriptionwithrelations)]|false|none|(tsType: SubscriptionWithRelations, schemaOptions: { includeRelations: true })|
+|»»»» SubscriptionWithRelations|[SubscriptionWithRelations](#schemasubscriptionwithrelations)|false|none|(tsType: SubscriptionWithRelations, schemaOptions: { includeRelations: true })|
+|»»»»» deleted|boolean|false|none|none|
+|»»»»» deletedOn|string(date-time)¦null|false|none|none|
+|»»»»» deletedBy|string¦null|false|none|none|
+|»»»»» createdOn|string(date-time)|false|none|none|
+|»»»»» modifiedOn|string(date-time)|false|none|none|
+|»»»»» createdBy|string|false|none|none|
+|»»»»» modifiedBy|string|false|none|none|
+|»»»»» id|string|false|none|none|
+|»»»»» accessRole|string|false|none|none|
+|»»»»» bgColor|string|false|none|none|
+|»»»»» fgColor|string|false|none|none|
+|»»»»» isHidden|boolean|false|none|none|
+|»»»»» isPrimary|boolean|false|none|none|
+|»»»»» identifier|string|true|none|none|
+|»»»»» defaultReminders|object|false|none|none|
+|»»»»» notificationSettings|object|false|none|none|
+|»»»»» calendarId|string|true|none|none|
+|»»»»» extId|string|false|none|none|
+|»»»»» extMetadata|object|false|none|none|
+|»»»»» calendar|[CalendarWithRelations](#schemacalendarwithrelations)|false|none|(tsType: CalendarWithRelations, schemaOptions: { includeRelations: true })|
+
+#### Enumerated Values
+
+|Property|Value|
+|---|---|
+|dayOfWeek|0|
+|dayOfWeek|1|
+|dayOfWeek|2|
+|dayOfWeek|3|
+|dayOfWeek|4|
+|dayOfWeek|5|
+|dayOfWeek|6|
+|status|confirmed|
+|status|tentative|
+|status|cancelled|
+|status|completed|
+|responseStatus|needsAction|
+|responseStatus|tentative|
+|responseStatus|accepted|
+|responseStatus|declined|
+|accessRole|freeBusyReader|
+|accessRole|reader|
+|accessRole|writer|
+|accessRole|owner|
+
+
+This operation does not require authentication
+
+
+# Schemas
+
+Attachment
+
+NewAttachment
+
+AttendeeWithRelations
+
+EventWithRelations
+
+AttachmentWithRelations
+
+AttachmentPartial
+
+Attendee
+
+NewAttendee
+
+AttendeePartial
+
+Calendar
+
+WorkingHourExcluding_id_
+
+NewCalendar
+
+, schemaOptions: { exclude: [ 'id' ] })]|
+|subscription|object|false|none|none|
+
+WorkingHour
+
+CalendarDTO
+
+CalendarWithRelations
+
+CalendarPartial
+
+Event
+
+AttachmentExcluding_id_
+
+AttendeeExcluding_id_
+
+NewEvent
+
+, schemaOptions: { exclude: [ 'id' ] })]|
+|attendees|[[AttendeeExcluding_id_](#schemaattendeeexcluding_id_)]|false|none|[(tsType: Omit, schemaOptions: { exclude: [ 'id' ] })]|
+|extId|string|false|none|none|
+|extMetadata|object|false|none|none|
+
+#### Enumerated Values
+
+|Property|Value|
+|---|---|
+|status|confirmed|
+|status|tentative|
+|status|cancelled|
+|status|completed|
+
+EventAttendeeViewItemDTO
+
+FreeBusyRequest
+
+FreeBusyDTO
+
+EventPartial
+
+Settings
+
+NewSettings
+
+SettingsWithRelations
+
+SettingsPartial
+
+Subscription
+
+NewSubscription
+
+SubscriptionWithRelations
+
+SubscriptionPartial
+
+Theme
+
+NewTheme
+
+ThemeWithRelations
+
+ThemePartial
+
+NewWorkingHour
+
+WorkingHourWithRelations
+
+WorkingHourPartial
+
+Date
+
+NewEventInCalendar
+
+NewSubscriptionInCalendar
+
+NewWorkingHourInCalendar
+
+NewAttachmentInEvent
+
+NewAttendeeInEvent
+
+loopback.Count
+
+attachments.ScopeFilter
+
+attachments.IncludeFilter.Items
+
+attachments.Filter
+
+attachments.Filter1
+
+attendees.ScopeFilter
+
+attendees.IncludeFilter.Items
+
+attendees.Filter
+
+attendees.Filter1
+
+subscriptions.ScopeFilter
+
+subscriptions.IncludeFilter.Items
+
+subscriptions.Filter
+
+calendars.ScopeFilter
+
+calendars.IncludeFilter.Items
+
+calendars.Filter
+
+calendars.Filter1
+
+events.ScopeFilter
+
+events.IncludeFilter.Items
+
+events.Filter
+
+events_attendees_view.ScopeFilter
+
+events_attendees_view.IncludeFilter.Items
+
+events_attendees_view.Filter
+
+settings.Filter
+
+settings.Filter1
+
+subscriptions.Filter1
+
+themes.Filter
+
+themes.Filter1
+
+working_hours.ScopeFilter
+
+working_hours.IncludeFilter.Items
+
+working_hours.Filter
+
+working_hours.Filter1
+
+ {
+ const config: ApplicationConfig = {
+ rest: {
+ port: +(process.env.PORT ?? PORT),
+ host: process.env.HOST ?? 'localhost',
+ },
+ };
+ const outFile = process.argv[FILEARGVI] ?? 'openapi.json';
+ const app = new SchedulerServiceApplication(config);
+ await app.boot();
+ await app.exportOpenApiSpec(outFile);
+}
+
+exportOpenApiSpec().catch(err => {
+ console.error('Fail to export OpenAPI spec from the application.', err); //NOSONAR
+ process.exit(1);
+});
diff --git a/services/video-conferencing-service/README.md b/services/video-conferencing-service/README.md
index c09d5c11df..fae4d281b5 100644
--- a/services/video-conferencing-service/README.md
+++ b/services/video-conferencing-service/README.md
@@ -113,6 +113,10 @@ For configuration in vonage, see [Session Monitoring](https://tokbox.com/develop
### PUT /archives/storage-target
Configures custom storage target to a custom Amazon s3 bucket or Microsoft Azure Storage.
+## API's Details
+
+Visit the [OpenAPI spec docs](./openapi.md)
+
## Feedback
If you've noticed a bug or have a question or have a feature request, [search the issue tracker](https://github.com/sourcefuse/loopback4-microservice-catalog/issues) to see if someone else in the community has already created a ticket.
diff --git a/services/video-conferencing-service/migration.js b/services/video-conferencing-service/migration.js
index 32597301bf..f99a14cfa6 100644
--- a/services/video-conferencing-service/migration.js
+++ b/services/video-conferencing-service/migration.js
@@ -1,6 +1,5 @@
const dotenvExt = require('dotenv-extended');
const fs = require('fs');
-const DBMigrate = require('db-migrate');
const path = require('path');
let isLocal = false;
dotenvExt.load({
@@ -27,6 +26,7 @@ if (isLocal) {
`${type}_MIGRATION or SOURCELOOP_MIGRATION variables not found in the environment, skipping automigration.`,
);
} else {
+ const DBMigrate = require('db-migrate');
dotenvExt.load({
schema: path.join('.', 'migrations', '.env.schema'),
path: path.join(process.env.INIT_CWD, '.env'),
diff --git a/services/video-conferencing-service/openapi.json b/services/video-conferencing-service/openapi.json
new file mode 100644
index 0000000000..c519a82dea
--- /dev/null
+++ b/services/video-conferencing-service/openapi.json
@@ -0,0 +1,407 @@
+{
+ "openapi": "3.0.0",
+ "info": {
+ "title": "Video Conferencing Service",
+ "version": "1.0.0",
+ "description": "Microservice providing Video-Conferencing service",
+ "contact": {
+ "name": "Sourcefuse"
+ }
+ },
+ "paths": {
+ "/archives/storage-target": {
+ "put": {
+ "x-controller-name": "VideoChatArchiveController",
+ "x-operation-name": "setUploadTarget",
+ "tags": [
+ "VideoChatArchiveController"
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "text/plain": {
+ "schema": {
+ "type": "text"
+ }
+ }
+ }
+ }
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object"
+ }
+ }
+ }
+ },
+ "operationId": "VideoChatArchiveController.setUploadTarget"
+ }
+ },
+ "/archives/{archiveId}": {
+ "get": {
+ "x-controller-name": "VideoChatArchiveController",
+ "x-operation-name": "getArchive",
+ "tags": [
+ "VideoChatArchiveController"
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object"
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "archiveId",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ },
+ "required": true
+ }
+ ],
+ "operationId": "VideoChatArchiveController.getArchive"
+ },
+ "delete": {
+ "x-controller-name": "VideoChatArchiveController",
+ "x-operation-name": "deleteArchive",
+ "tags": [
+ "VideoChatArchiveController"
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "text/plain": {
+ "schema": {
+ "type": "text"
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "archiveId",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ },
+ "required": true
+ }
+ ],
+ "operationId": "VideoChatArchiveController.deleteArchive"
+ }
+ },
+ "/archives": {
+ "get": {
+ "x-controller-name": "VideoChatArchiveController",
+ "x-operation-name": "getArchives",
+ "tags": [
+ "VideoChatArchiveController"
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object"
+ }
+ }
+ }
+ }
+ },
+ "operationId": "VideoChatArchiveController.getArchives"
+ }
+ },
+ "/session/{meetingLinkId}/attendees": {
+ "get": {
+ "x-controller-name": "VideoChatSessionController",
+ "x-operation-name": "getAttendeesList",
+ "tags": [
+ "VideoChatSessionController"
+ ],
+ "parameters": [
+ {
+ "name": "meetingLinkId",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ },
+ "required": true
+ },
+ {
+ "name": "active",
+ "in": "query",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "text/plain": {
+ "schema": {
+ "type": "array"
+ }
+ }
+ }
+ }
+ },
+ "operationId": "VideoChatSessionController.getAttendeesList"
+ }
+ },
+ "/session/{meetingLinkId}/end": {
+ "patch": {
+ "x-controller-name": "VideoChatSessionController",
+ "x-operation-name": "endSession",
+ "tags": [
+ "VideoChatSessionController"
+ ],
+ "responses": {
+ "204": {
+ "description": "MessageRecipient PATCH success"
+ }
+ },
+ "parameters": [
+ {
+ "name": "meetingLinkId",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ },
+ "required": true
+ }
+ ],
+ "operationId": "VideoChatSessionController.endSession"
+ }
+ },
+ "/session/{meetingLinkId}/token": {
+ "post": {
+ "x-controller-name": "VideoChatSessionController",
+ "x-operation-name": "getMeetingToken",
+ "tags": [
+ "VideoChatSessionController"
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "sessionId": "string",
+ "token": "string"
+ }
+ }
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "meetingLinkId",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ },
+ "required": true
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object"
+ }
+ }
+ }
+ },
+ "operationId": "VideoChatSessionController.getMeetingToken"
+ }
+ },
+ "/session/{meetingLinkId}": {
+ "patch": {
+ "x-controller-name": "VideoChatSessionController",
+ "x-operation-name": "editMeeting",
+ "tags": [
+ "VideoChatSessionController"
+ ],
+ "responses": {
+ "204": {
+ "description": "Session details PATCH success"
+ }
+ },
+ "parameters": [
+ {
+ "name": "meetingLinkId",
+ "in": "path",
+ "schema": {
+ "type": "string"
+ },
+ "required": true
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/VideoChatSessionPartial"
+ }
+ }
+ },
+ "x-parameter-index": 1
+ },
+ "operationId": "VideoChatSessionController.editMeeting"
+ }
+ },
+ "/session": {
+ "post": {
+ "x-controller-name": "VideoChatSessionController",
+ "x-operation-name": "getMeetingLink",
+ "tags": [
+ "VideoChatSessionController"
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "text/plain": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object"
+ }
+ }
+ }
+ },
+ "operationId": "VideoChatSessionController.getMeetingLink"
+ }
+ },
+ "/webhooks/session": {
+ "post": {
+ "x-controller-name": "VideoChatSessionController",
+ "x-operation-name": "checkWebhookPayload",
+ "tags": [
+ "VideoChatSessionController"
+ ],
+ "responses": {
+ "204": {
+ "description": "POST /webhooks/session Success"
+ }
+ },
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object"
+ }
+ }
+ }
+ },
+ "operationId": "VideoChatSessionController.checkWebhookPayload"
+ }
+ }
+ },
+ "components": {
+ "securitySchemes": {
+ "HTTPBearer": {
+ "type": "http",
+ "scheme": "bearer",
+ "bearerFormat": "JWT"
+ }
+ },
+ "schemas": {
+ "VideoChatSessionPartial": {
+ "title": "VideoChatSessionPartial",
+ "type": "object",
+ "description": "(tsType: Partial, schemaOptions: { partial: true })",
+ "properties": {
+ "deleted": {
+ "type": "boolean"
+ },
+ "deletedOn": {
+ "type": "string",
+ "format": "date-time",
+ "nullable": true
+ },
+ "deletedBy": {
+ "type": "string",
+ "nullable": true
+ },
+ "createdOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "modifiedOn": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "createdBy": {
+ "type": "string"
+ },
+ "modifiedBy": {
+ "type": "string"
+ },
+ "id": {
+ "type": "number"
+ },
+ "sessionId": {
+ "type": "string"
+ },
+ "meetingLink": {
+ "type": "string"
+ },
+ "isScheduled": {
+ "type": "boolean"
+ },
+ "scheduleTime": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "isArchived": {
+ "type": "boolean"
+ },
+ "archiveId": {
+ "type": "string"
+ },
+ "uploadTarget": {
+ "type": "string"
+ },
+ "startTime": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "endTime": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "extId": {
+ "type": "string"
+ },
+ "extMetadata": {
+ "type": "object"
+ }
+ },
+ "additionalProperties": false,
+ "x-typescript-type": "Partial"
+ }
+ }
+ },
+ "servers": [
+ {
+ "url": "/"
+ }
+ ]
+}
\ No newline at end of file
diff --git a/services/video-conferencing-service/openapi.md b/services/video-conferencing-service/openapi.md
new file mode 100644
index 0000000000..3c8fec35d5
--- /dev/null
+++ b/services/video-conferencing-service/openapi.md
@@ -0,0 +1,675 @@
+---
+title: Video Conferencing Service v1.0.0
+language_tabs:
+ - "'javascript": JavaScript
+ - "'javascript--nodejs": Node.JS'
+language_clients:
+ - "'javascript": request'
+ - "'javascript--nodejs": ""
+toc_footers: []
+includes: []
+search: false
+highlight_theme: darkula
+headingLevel: 2
+
+---
+
+
+
+Video Conferencing Service v1.0.0
+
+> Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
+
+Microservice providing Video-Conferencing service
+
+Base URLs:
+
+* /
+
+# Authentication
+
+- HTTP Authentication, scheme: bearer
+
+VideoChatArchiveController
+
+## VideoChatArchiveController.setUploadTarget
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|body|body|object|false|none|
+
+> Example responses
+
+> 200 Response
+
+```
+null
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|text|
+
+
+This operation does not require authentication
+
+
+## VideoChatArchiveController.getArchive
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|archiveId|path|string|true|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+{}
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
+
+Response Schema
+
+
+This operation does not require authentication
+
+
+## VideoChatArchiveController.deleteArchive
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|archiveId|path|string|true|none|
+
+> Example responses
+
+> 200 Response
+
+```
+null
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|text|
+
+
+This operation does not require authentication
+
+
+## VideoChatArchiveController.getArchives
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
+
+Response Schema
+
+
+This operation does not require authentication
+
+
+VideoChatSessionController
+
+## VideoChatSessionController.getAttendeesList
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|meetingLinkId|path|string|true|none|
+|active|query|string|false|none|
+
+> Example responses
+
+> 200 Response
+
+```
+[]
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
+
+Response Schema
+
+
+This operation does not require authentication
+
+
+## VideoChatSessionController.endSession
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|meetingLinkId|path|string|true|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|MessageRecipient PATCH success|None|
+
+
+This operation does not require authentication
+
+
+## VideoChatSessionController.getMeetingToken
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|meetingLinkId|path|string|true|none|
+|body|body|object|false|none|
+
+> Example responses
+
+> 200 Response
+
+```json
+null
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|Inline|
+
+Response Schema
+
+
+This operation does not require authentication
+
+
+## VideoChatSessionController.editMeeting
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|meetingLinkId|path|string|true|none|
+|body|body|[VideoChatSessionPartial](#schemavideochatsessionpartial)|false|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|Session details PATCH success|None|
+
+
+This operation does not require authentication
+
+
+## VideoChatSessionController.getMeetingLink
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|body|body|object|false|none|
+
+> Example responses
+
+> 200 Response
+
+```
+"string"
+```
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|none|string|
+
+
+This operation does not require authentication
+
+
+## VideoChatSessionController.checkWebhookPayload
+
+Parameters
+
+|Name|In|Type|Required|Description|
+|---|---|---|---|---|
+|body|body|object|false|none|
+
+Responses
+
+|Status|Meaning|Description|Schema|
+|---|---|---|---|
+|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|POST /webhooks/session Success|None|
+
+
+This operation does not require authentication
+
+
+# Schemas
+
+VideoChatSessionPartial
+
+ {
+ const config: ApplicationConfig = {
+ rest: {
+ port: +(process.env.PORT ?? PORT),
+ host: process.env.HOST ?? 'localhost',
+ },
+ };
+ const outFile = process.argv[FILEARGVI] ?? 'openapi.json';
+ const app = new VideoConfServiceApplication(config);
+ await app.boot();
+ await app.exportOpenApiSpec(outFile);
+}
+
+exportOpenApiSpec().catch(err => {
+ console.error('Fail to export OpenAPI spec from the application.', err); //NOSONAR
+ process.exit(1);
+});