@nmshd/runtime 1.4.2 → 2.0.0-alpha.3

package/dist/useCases/common/Schemas.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DeleteDeviceRequest = exports.CreateDeviceOnboardingTokenRequest = exports.CreateDeviceRequest = exports.ValidateChallengeRequest = exports.CreateChallengeRequest = exports.CreateDeviceChallengeRequest = exports.CreateIdentityChallengeRequest = exports.CreateRelationshipChallengeRequest = exports.SyncEverythingRequest = exports.DownloadAttachmentRequest = exports.DownloadFileRequest = exports.SyncDatawalletRequest = exports.RegisterPushNotificationTokenRequest = exports.UpdateSharedItemRequest = exports.GetSharedItemsSharedWithAddressRequest = exports.GetSharedItemsSharedByAddressRequest = exports.GetSharedItemsByReferenceRequest = exports.GetSharedItemsByAddressRequest = exports.GetSharedItemsRequest = exports.GetSharedItemRequest = exports.DeleteSharedItemRequest = exports.CreateSharedItemRequest = exports.UpdateSettingRequest = exports.GetSettingsRequest = exports.GetSettingRequest = exports.DeleteSettingRequest = exports.CreateSettingRequest = exports.UpdateRelationshipInfoRequest = exports.GetRelationshipInfoByRelationshipRequest = exports.GetRelationshipInfoRequest = exports.DeleteRelationshipInfoByRelationshipRequest = exports.DeleteRelationshipInfoRequest = exports.CreateRelationshipInfoRequest = exports.UpdateDraftRequest = exports.GetDraftsRequest = exports.GetDraftRequest = exports.DeleteDraftRequest = exports.CreateDraftRequest = exports.UpdateAttributeRequest = exports.SucceedAttributeRequest = exports.GetHistoryByNameRequest = exports.GetAttributesRequest = exports.GetAttributeByNameRequest = exports.GetAttributeRequest = exports.DeleteAttributeByNameRequest = exports.DeleteAttributeRequest = exports.CreateAttributeRequest = exports.GetAttributesByNamesRequest = exports.LoadPeerTokenAnonymousByTruncatedReferenceRequest = exports.LoadPeerTokenAnonymousByIdAndKeyRequest = void 0;
-exports.LoadPeerTokenRequest = exports.GetTokensRequest = exports.GetTokenRequest = exports.GetQRCodeForTokenRequest = exports.CreateOwnTokenRequest = exports.LoadPeerRelationshipTemplateRequest = exports.GetRelationshipTemplatesRequest = exports.GetRelationshipTemplateRequest = exports.CreateTokenQrCodeForOwnTemplateRequest = exports.CreateTokenForOwnTemplateRequest = exports.CreateOwnRelationshipTemplateRequest = exports.RevokeRelationshipChangeRequest = exports.RejectRelationshipChangeRequest = exports.GetRelationshipsRequest = exports.GetRelationshipByAddressRequest = exports.GetRelationshipRequest = exports.CreateRelationshipChangeRequest = exports.CreateRelationshipRequest = exports.AcceptRelationshipChangeRequest = exports.SendMessageRequest = exports.GetMessagesRequest = exports.GetMessageRequest = exports.GetAttachmentMetadataRequest = exports.CheckIdentityRequest = exports.UploadOwnFileRequest = exports.LoadPeerFileRequest = exports.LoadPeerFileViaReferenceRequest = exports.LoadPeerFileViaSecretRequest = exports.GetFilesRequest = exports.GetFileRequest = exports.CreateTokenQrCodeForFileRequest = exports.CreateTokenForFileRequest = exports.UpdateDeviceRequest = exports.GetDeviceOnboardingInfoRequest = exports.GetDeviceRequest = void 0;
+exports.GetDeviceRequest = exports.DeleteDeviceRequest = exports.CreateDeviceOnboardingTokenRequest = exports.CreateDeviceRequest = exports.ValidateChallengeRequest = exports.CreateChallengeRequest = exports.CreateDeviceChallengeRequest = exports.CreateIdentityChallengeRequest = exports.CreateRelationshipChallengeRequest = exports.SyncEverythingRequest = exports.DownloadAttachmentRequest = exports.DownloadFileRequest = exports.SyncDatawalletRequest = exports.RegisterPushNotificationTokenRequest = exports.UpdateSettingRequest = exports.GetSettingsRequest = exports.GetSettingRequest = exports.DeleteSettingRequest = exports.CreateSettingRequest = exports.SentOutgoingRequestRequest = exports.RequireManualDecisionOfIncomingRequestRequest = exports.ReceivedIncomingRequestRequest = exports.GetOutgoingRequestsRequest = exports.GetOutgoingRequestRequest = exports.GetIncomingRequestsRequest = exports.GetIncomingRequestRequest = exports.CreateAndCompleteOutgoingRequestFromRelationshipCreationChangeRequest = exports.CompleteOutgoingRequestRequest = exports.CompleteIncomingRequestRequest = exports.CheckPrerequisitesOfIncomingRequestRequest = exports.RejectIncomingRequestRequest = exports.CreateOutgoingRequestRequest = exports.AcceptIncomingRequestRequest = exports.UpdateDraftRequest = exports.GetDraftsRequest = exports.GetDraftRequest = exports.DeleteDraftRequest = exports.CreateDraftRequest = exports.UpdateAttributeRequest = exports.SucceedAttributeRequest = exports.GetHistoryByNameRequest = exports.GetAttributesRequest = exports.GetAttributeByNameRequest = exports.GetAttributeRequest = exports.DeleteAttributeByNameRequest = exports.DeleteAttributeRequest = exports.CreateAttributeRequest = exports.GetAttributesByNamesRequest = exports.LoadPeerTokenAnonymousByTruncatedReferenceRequest = exports.LoadPeerTokenAnonymousByIdAndKeyRequest = void 0;
+exports.LoadPeerTokenRequest = exports.GetTokensRequest = exports.GetTokenRequest = exports.GetQRCodeForTokenRequest = exports.CreateOwnTokenRequest = exports.LoadPeerRelationshipTemplateRequest = exports.GetRelationshipTemplatesRequest = exports.GetRelationshipTemplateRequest = exports.CreateTokenQrCodeForOwnTemplateRequest = exports.CreateTokenForOwnTemplateRequest = exports.CreateOwnRelationshipTemplateRequest = exports.RevokeRelationshipChangeRequest = exports.RejectRelationshipChangeRequest = exports.GetRelationshipsRequest = exports.GetRelationshipByAddressRequest = exports.GetRelationshipRequest = exports.CreateRelationshipChangeRequest = exports.CreateRelationshipRequest = exports.AcceptRelationshipChangeRequest = exports.SendMessageRequest = exports.GetMessagesRequest = exports.GetMessageRequest = exports.GetAttachmentMetadataRequest = exports.CheckIdentityRequest = exports.UploadOwnFileRequest = exports.LoadPeerFileRequest = exports.LoadPeerFileViaReferenceRequest = exports.LoadPeerFileViaSecretRequest = exports.GetFilesRequest = exports.GetFileRequest = exports.CreateTokenQrCodeForFileRequest = exports.CreateTokenForFileRequest = exports.UpdateDeviceRequest = exports.GetDeviceOnboardingInfoRequest = void 0;
 exports.LoadPeerTokenAnonymousByIdAndKeyRequest = {
     "$schema": "http://json-schema.org/draft-07/schema#",
     "$ref": "#/definitions/LoadPeerTokenAnonymousByIdAndKeyRequest",
@@ -397,131 +397,628 @@ exports.UpdateDraftRequest = {
         }
     }
 };
-exports.CreateRelationshipInfoRequest = {
+exports.AcceptIncomingRequestRequest = {
     "$schema": "http://json-schema.org/draft-07/schema#",
-    "$ref": "#/definitions/CreateRelationshipInfoRequest",
+    "$ref": "#/definitions/AcceptIncomingRequestRequest",
     "definitions": {
-        "CreateRelationshipInfoRequest": {
+        "AcceptIncomingRequestRequest": {
             "type": "object",
+            "additionalProperties": false,
             "properties": {
-                "relationshipId": {
+                "requestId": {
                     "type": "string"
                 },
-                "attributes": {
+                "items": {
                     "type": "array",
                     "items": {
-                        "$ref": "#/definitions/RelationshipAttributeDTO"
+                        "anyOf": [
+                            {
+                                "$ref": "#/definitions/DecideRequestItemParametersJSON"
+                            },
+                            {
+                                "$ref": "#/definitions/DecideRequestItemGroupParametersJSON"
+                            }
+                        ]
                     }
+                }
+            },
+            "required": [
+                "items",
+                "requestId"
+            ]
+        },
+        "DecideRequestItemParametersJSON": {
+            "anyOf": [
+                {
+                    "$ref": "#/definitions/AcceptRequestItemParametersJSON"
                 },
-                "isPinned": {
-                    "type": "boolean"
+                {
+                    "$ref": "#/definitions/RejectRequestItemParametersJSON"
+                }
+            ]
+        },
+        "AcceptRequestItemParametersJSON": {
+            "type": "object",
+            "properties": {
+                "accept": {
+                    "type": "boolean",
+                    "const": true
+                }
+            },
+            "required": [
+                "accept"
+            ],
+            "additionalProperties": false
+        },
+        "RejectRequestItemParametersJSON": {
+            "type": "object",
+            "properties": {
+                "accept": {
+                    "type": "boolean",
+                    "const": false
                 },
-                "title": {
+                "code": {
                     "type": "string"
                 },
+                "message": {
+                    "type": "string"
+                }
+            },
+            "required": [
+                "accept"
+            ],
+            "additionalProperties": false
+        },
+        "DecideRequestItemGroupParametersJSON": {
+            "type": "object",
+            "properties": {
+                "items": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/definitions/DecideRequestItemParametersJSON"
+                    }
+                }
+            },
+            "required": [
+                "items"
+            ],
+            "additionalProperties": false
+        }
+    }
+};
+exports.CreateOutgoingRequestRequest = {
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "$ref": "#/definitions/CreateOutgoingRequestRequest",
+    "definitions": {
+        "CreateOutgoingRequestRequest": {
+            "type": "object",
+            "properties": {
+                "content": {
+                    "type": "object",
+                    "properties": {
+                        "expiresAt": {
+                            "anyOf": [
+                                {
+                                    "type": "string",
+                                    "description": "The point in time the request is considered obsolete either technically (e.g. the request is no longer valid or its response is no longer accepted) or from a business perspective (e.g. the request is no longer of interest).",
+                                    "default": "undefined - the request won't expire"
+                                },
+                                {
+                                    "$ref": "#/definitions/ICoreDate",
+                                    "description": "The point in time the request is considered obsolete either technically (e.g. the request is no longer valid or its response is no longer accepted) or from a business perspective (e.g. the request is no longer of interest).",
+                                    "default": "undefined - the request won't expire"
+                                }
+                            ],
+                            "description": "The point in time the request is considered obsolete either technically (e.g. the request is no longer valid or its response is no longer accepted) or from a business perspective (e.g. the request is no longer of interest).",
+                            "default": "undefined - the request won't expire"
+                        },
+                        "items": {
+                            "anyOf": [
+                                {
+                                    "type": "array",
+                                    "items": {
+                                        "anyOf": [
+                                            {
+                                                "$ref": "#/definitions/RequestItemGroupJSON"
+                                            },
+                                            {
+                                                "$ref": "#/definitions/RequestItemJSON"
+                                            }
+                                        ]
+                                    },
+                                    "description": "The items of the Request. Can be either a single  {@link  RequestItemJSON RequestItem }  or a  {@link  RequestItemGroupJSON RequestItemGroup } , which itself can contain further  {@link  RequestItemJSON RequestItems } ."
+                                },
+                                {
+                                    "type": "array",
+                                    "items": {
+                                        "anyOf": [
+                                            {
+                                                "$ref": "#/definitions/IRequestItemGroup"
+                                            },
+                                            {
+                                                "$ref": "#/definitions/IRequestItem"
+                                            }
+                                        ]
+                                    },
+                                    "description": "The items of the Request. Can be either a single  {@link  RequestItem RequestItem }  or a  {@link  RequestItemGroup RequestItemGroup } , which itself can contain further  {@link  RequestItem RequestItems } ."
+                                }
+                            ],
+                            "description": "The items of the Request. Can be either a single  {@link  RequestItemJSON RequestItem }  or a  {@link  RequestItemGroupJSON RequestItemGroup } , which itself can contain further  {@link  RequestItemJSON RequestItems } ."
+                        },
+                        "@context": {
+                            "type": "string"
+                        }
+                    },
+                    "required": [
+                        "items"
+                    ],
+                    "additionalProperties": false
+                },
+                "peer": {
+                    "type": "string",
+                    "pattern": "id1[A-Za-z0-9]{32,33}"
+                }
+            },
+            "required": [
+                "content",
+                "peer"
+            ],
+            "additionalProperties": false
+        },
+        "ICoreDate": {
+            "type": "object",
+            "properties": {
+                "date": {
+                    "type": "string"
+                }
+            },
+            "required": [
+                "date"
+            ],
+            "additionalProperties": false
+        },
+        "RequestItemGroupJSON": {
+            "type": "object",
+            "properties": {
+                "@type": {
+                    "type": "string"
+                },
+                "@context": {
+                    "type": "string"
+                },
+                "@version": {
+                    "type": "string"
+                },
+                "title": {
+                    "type": "string",
+                    "description": "The human-readable title of this group."
+                },
                 "description": {
+                    "type": "string",
+                    "description": "The human-readable description of this group."
+                },
+                "mustBeAccepted": {
+                    "type": "boolean",
+                    "description": "If set to `true`, the recipient has to accept this group if he wants to accept the Request. If set to `false`, the recipient can decide whether he wants to accept it or not."
+                },
+                "responseMetadata": {
+                    "type": "object",
+                    "description": "This propertycan be used to add some arbitrary metadata to this group. The content of this property will be copied into the response on the side of the recipient, so the sender can use it to identify the group content as they receive the response."
+                },
+                "items": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/definitions/RequestItemJSON"
+                    },
+                    "description": "The items of this group."
+                }
+            },
+            "required": [
+                "@type",
+                "items",
+                "mustBeAccepted"
+            ],
+            "additionalProperties": false,
+            "description": "A RequestItemGroup can be used to group one or more  {@link  RequestItemJSON RequestItems } . This is useful if you want to\n* make sure that the items in the group can only be accepted together\n\n  Example: when sending a `CreateAttributeRequestItem` **and** a `ShareAttributeRequestItem` in a single   Request where the latter one targets an attribute created by the first one, it it should be impossible to   reject the first item, while accepting the second one.\n* visually group items on the UI and give the a common title/description"
+        },
+        "RequestItemJSON": {
+            "type": "object",
+            "properties": {
+                "@type": {
                     "type": "string"
                 },
-                "userTitle": {
+                "@context": {
                     "type": "string"
                 },
-                "userDescription": {
+                "@version": {
                     "type": "string"
                 },
-                "theme": {
-                    "$ref": "#/definitions/RelationshipThemeDTO"
+                "title": {
+                    "type": "string",
+                    "description": "The human-readable title of this item."
+                },
+                "description": {
+                    "type": "string",
+                    "description": "The human-readable description of this item."
+                },
+                "responseMetadata": {
+                    "type": "object",
+                    "description": "This propertycan be used to add some arbitrary metadata to this item. The content of this property will be copied into the response on the side of the recipient, so the sender can use it to identify the group content as they receive the response."
+                },
+                "mustBeAccepted": {
+                    "type": "boolean",
+                    "description": "If set to `true`, the recipient has to accept this group if he wants to accept the Request. If set to `false`, the recipient can decide whether he wants to accept it or not.\n\nCaution: this setting does not take effect in case it is inside of a\n {@link  RequestItemGroupJSON RequestItemGroup } , which is not accepted by the recipient, since a  {@link  RequestItemJSON RequestItem }  can only be accepted if the parent group is accepted as well."
                 }
             },
             "required": [
-                "relationshipId",
-                "attributes",
-                "isPinned",
-                "title"
+                "@type",
+                "mustBeAccepted"
             ],
             "additionalProperties": false
         },
-        "RelationshipAttributeDTO": {
+        "IRequestItemGroup": {
             "type": "object",
             "properties": {
-                "name": {
+                "title": {
+                    "type": "string",
+                    "description": "The human-readable title of this group."
+                },
+                "description": {
+                    "type": "string",
+                    "description": "The human-readable description of this group."
+                },
+                "mustBeAccepted": {
+                    "type": "boolean",
+                    "description": "If set to `true`, the recipient has to accept this group if he wants to accept the Request. If set to `false`, the recipient can decide whether he wants to accept it or not."
+                },
+                "responseMetadata": {
+                    "type": "object",
+                    "description": "This propertycan be used to add some arbitrary metadata to this group. The content of this property will be copied into the response on the side of the recipient, so the sender can use it to identify the group content as they receive the response."
+                },
+                "items": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/definitions/IRequestItem"
+                    },
+                    "description": "The items of this group."
+                }
+            },
+            "required": [
+                "mustBeAccepted",
+                "items"
+            ],
+            "additionalProperties": false,
+            "description": "A RequestItemGroup can be used to group one or more  {@link  RequestItem RequestItems } . This is useful if you want to\n* make sure that the items in the group can only be accepted together\n\n  Example: when sending a `CreateAttributeRequestItem` **and** a `ShareAttributeRequestItem` in a single   Request where the latter one targets an attribute created by the first one, it it should be impossible to   reject the first item, while accepting the second one.\n* visually group items on the UI and give the a common title/description"
+        },
+        "IRequestItem": {
+            "type": "object",
+            "properties": {
+                "title": {
+                    "type": "string",
+                    "description": "The human-readable title of this item."
+                },
+                "description": {
+                    "type": "string",
+                    "description": "The human-readable description of this item."
+                },
+                "responseMetadata": {
+                    "type": "object",
+                    "description": "This propertycan be used to add some arbitrary metadata to this item. The content of this property will be copied into the response on the side of the recipient, so the sender can use it to identify the group content as they receive the response."
+                },
+                "mustBeAccepted": {
+                    "type": "boolean",
+                    "description": "If set to `true`, the recipient has to accept this group if he wants to accept the Request. If set to `false`, the recipient can decide whether he wants to accept it or not.\n\nCaution: this setting does not take effect in case it is inside of a\n {@link  RequestItemGroup RequestItemGroup } , which is not accepted by the recipient, since a  {@link  RequestItem RequestItem }  can only be accepted if the parent group is accepted as well."
+                }
+            },
+            "required": [
+                "mustBeAccepted"
+            ],
+            "additionalProperties": false
+        }
+    }
+};
+exports.RejectIncomingRequestRequest = {
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "$ref": "#/definitions/RejectIncomingRequestRequest",
+    "definitions": {
+        "RejectIncomingRequestRequest": {
+            "type": "object",
+            "additionalProperties": false,
+            "properties": {
+                "requestId": {
                     "type": "string"
                 },
-                "content": {
-                    "$ref": "#/definitions/AttributeJSON"
+                "items": {
+                    "type": "array",
+                    "items": {
+                        "anyOf": [
+                            {
+                                "$ref": "#/definitions/DecideRequestItemParametersJSON"
+                            },
+                            {
+                                "$ref": "#/definitions/DecideRequestItemGroupParametersJSON"
+                            }
+                        ]
+                    }
+                }
+            },
+            "required": [
+                "items",
+                "requestId"
+            ]
+        },
+        "DecideRequestItemParametersJSON": {
+            "anyOf": [
+                {
+                    "$ref": "#/definitions/AcceptRequestItemParametersJSON"
+                },
+                {
+                    "$ref": "#/definitions/RejectRequestItemParametersJSON"
+                }
+            ]
+        },
+        "AcceptRequestItemParametersJSON": {
+            "type": "object",
+            "properties": {
+                "accept": {
+                    "type": "boolean",
+                    "const": true
+                }
+            },
+            "required": [
+                "accept"
+            ],
+            "additionalProperties": false
+        },
+        "RejectRequestItemParametersJSON": {
+            "type": "object",
+            "properties": {
+                "accept": {
+                    "type": "boolean",
+                    "const": false
                 },
-                "sharedItem": {
+                "code": {
+                    "type": "string"
+                },
+                "message": {
                     "type": "string"
                 }
             },
             "required": [
-                "name",
-                "content",
-                "sharedItem"
+                "accept"
             ],
             "additionalProperties": false
         },
-        "AttributeJSON": {
+        "DecideRequestItemGroupParametersJSON": {
+            "type": "object",
+            "properties": {
+                "items": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/definitions/DecideRequestItemParametersJSON"
+                    }
+                }
+            },
+            "required": [
+                "items"
+            ],
+            "additionalProperties": false
+        }
+    }
+};
+exports.CheckPrerequisitesOfIncomingRequestRequest = {
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "$ref": "#/definitions/CheckPrerequisitesOfIncomingRequestRequest",
+    "definitions": {
+        "CheckPrerequisitesOfIncomingRequestRequest": {
+            "type": "object",
+            "properties": {
+                "requestId": {
+                    "type": "string",
+                    "pattern": "CNSREQ[A-Za-z0-9]{14}"
+                }
+            },
+            "required": [
+                "requestId"
+            ],
+            "additionalProperties": false
+        }
+    }
+};
+exports.CompleteIncomingRequestRequest = {
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "$ref": "#/definitions/CompleteIncomingRequestRequest",
+    "definitions": {
+        "CompleteIncomingRequestRequest": {
+            "type": "object",
+            "properties": {
+                "requestId": {
+                    "type": "string",
+                    "pattern": "CNSREQ[A-Za-z0-9]{14}"
+                },
+                "responseSourceId": {
+                    "type": "string",
+                    "pattern": "(MSG|RCH)[A-Za-z0-9]{17}"
+                }
+            },
+            "required": [
+                "requestId",
+                "responseSourceId"
+            ],
+            "additionalProperties": false
+        }
+    }
+};
+exports.CompleteOutgoingRequestRequest = {
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "$ref": "#/definitions/CompleteOutgoingRequestRequest",
+    "definitions": {
+        "CompleteOutgoingRequestRequest": {
+            "type": "object",
+            "properties": {
+                "requestId": {
+                    "type": "string",
+                    "pattern": "CNSREQ[A-Za-z0-9]{14}"
+                },
+                "receivedResponse": {
+                    "$ref": "#/definitions/ResponseJSON"
+                },
+                "messageId": {
+                    "type": "string",
+                    "pattern": "MSG[A-Za-z0-9]{17}"
+                }
+            },
+            "required": [
+                "requestId",
+                "receivedResponse",
+                "messageId"
+            ],
+            "additionalProperties": false
+        },
+        "ResponseJSON": {
             "type": "object",
             "properties": {
                 "@type": {
                     "type": "string"
                 },
-                "@schema": {
+                "@context": {
                     "type": "string"
                 },
-                "name": {
+                "@version": {
                     "type": "string"
                 },
-                "value": {},
-                "validFrom": {
-                    "type": "string"
+                "result": {
+                    "$ref": "#/definitions/ResponseResult"
                 },
-                "validTo": {
+                "requestId": {
                     "type": "string"
+                },
+                "items": {
+                    "type": "array",
+                    "items": {
+                        "anyOf": [
+                            {
+                                "$ref": "#/definitions/ResponseItemGroupJSON"
+                            },
+                            {
+                                "$ref": "#/definitions/ResponseItemJSON"
+                            }
+                        ]
+                    }
                 }
             },
             "required": [
                 "@type",
-                "name",
-                "value"
+                "items",
+                "requestId",
+                "result"
             ],
             "additionalProperties": false
         },
-        "RelationshipThemeDTO": {
+        "ResponseResult": {
+            "type": "string",
+            "enum": [
+                "Accepted",
+                "Rejected"
+            ]
+        },
+        "ResponseItemGroupJSON": {
             "type": "object",
             "properties": {
-                "image": {
+                "@type": {
                     "type": "string"
                 },
-                "imageBar": {
+                "@context": {
+                    "type": "string"
+                },
+                "@version": {
+                    "type": "string"
+                },
+                "items": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/definitions/ResponseItemJSON"
+                    }
+                },
+                "metadata": {
+                    "type": "object"
+                }
+            },
+            "required": [
+                "@type",
+                "items"
+            ],
+            "additionalProperties": false
+        },
+        "ResponseItemJSON": {
+            "type": "object",
+            "properties": {
+                "@type": {
                     "type": "string"
                 },
-                "backgroundColor": {
+                "@context": {
                     "type": "string"
                 },
-                "foregroundColor": {
+                "@version": {
                     "type": "string"
+                },
+                "result": {
+                    "$ref": "#/definitions/ResponseItemResult"
+                },
+                "metadata": {
+                    "type": "object"
+                }
+            },
+            "required": [
+                "@type",
+                "result"
+            ],
+            "additionalProperties": false
+        },
+        "ResponseItemResult": {
+            "type": "string",
+            "enum": [
+                "Accepted",
+                "Rejected",
+                "Error"
+            ]
+        }
+    }
+};
+exports.CreateAndCompleteOutgoingRequestFromRelationshipCreationChangeRequest = {
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "$ref": "#/definitions/CreateAndCompleteOutgoingRequestFromRelationshipCreationChangeRequest",
+    "definitions": {
+        "CreateAndCompleteOutgoingRequestFromRelationshipCreationChangeRequest": {
+            "type": "object",
+            "properties": {
+                "templateId": {
+                    "type": "string",
+                    "pattern": "RLT[A-Za-z0-9]{17}"
+                },
+                "relationshipChangeId": {
+                    "type": "string",
+                    "pattern": "RCH[A-Za-z0-9]{17}"
                 }
             },
             "required": [
-                "image",
-                "imageBar",
-                "backgroundColor",
-                "foregroundColor"
+                "templateId",
+                "relationshipChangeId"
             ],
             "additionalProperties": false
         }
     }
 };
-exports.DeleteRelationshipInfoRequest = {
+exports.GetIncomingRequestRequest = {
     "$schema": "http://json-schema.org/draft-07/schema#",
-    "$ref": "#/definitions/DeleteRelationshipInfoRequest",
+    "$ref": "#/definitions/GetIncomingRequestRequest",
     "definitions": {
-        "DeleteRelationshipInfoRequest": {
+        "GetIncomingRequestRequest": {
             "type": "object",
             "properties": {
                 "id": {
-                    "type": "string"
+                    "type": "string",
+                    "pattern": "CNSREQ[A-Za-z0-9]{14}"
                 }
             },
             "required": [
@@ -531,169 +1028,429 @@ exports.DeleteRelationshipInfoRequest = {
         }
     }
 };
-exports.DeleteRelationshipInfoByRelationshipRequest = {
+exports.GetIncomingRequestsRequest = {
     "$schema": "http://json-schema.org/draft-07/schema#",
-    "$ref": "#/definitions/DeleteRelationshipInfoByRelationshipRequest",
+    "$ref": "#/definitions/GetIncomingRequestsRequest",
     "definitions": {
-        "DeleteRelationshipInfoByRelationshipRequest": {
+        "GetIncomingRequestsRequest": {
             "type": "object",
             "properties": {
-                "relationshipId": {
+                "query": {
+                    "$ref": "#/definitions/GetIncomingRequestsRequestsQuery"
+                }
+            },
+            "additionalProperties": false
+        },
+        "GetIncomingRequestsRequestsQuery": {
+            "type": "object",
+            "properties": {
+                "id": {
+                    "type": "string"
+                },
+                "peer": {
+                    "type": "string"
+                },
+                "createdAt": {
+                    "type": "string"
+                },
+                "status": {
                     "type": "string"
+                },
+                "content": {
+                    "type": "object",
+                    "properties": {
+                        "expiresAt": {
+                            "type": "string"
+                        },
+                        "items": {
+                            "type": "object",
+                            "properties": {
+                                "@type": {
+                                    "type": "string"
+                                }
+                            },
+                            "additionalProperties": false
+                        }
+                    },
+                    "additionalProperties": false
+                },
+                "source": {
+                    "type": "object",
+                    "properties": {
+                        "type": {
+                            "type": "string"
+                        },
+                        "reference": {
+                            "type": "string"
+                        }
+                    },
+                    "additionalProperties": false
+                },
+                "response": {
+                    "type": "object",
+                    "properties": {
+                        "createdAt": {
+                            "type": "string"
+                        },
+                        "source": {
+                            "type": "object",
+                            "properties": {
+                                "type": {
+                                    "type": "string"
+                                },
+                                "reference": {
+                                    "type": "string"
+                                }
+                            },
+                            "additionalProperties": false
+                        },
+                        "content": {
+                            "type": "object",
+                            "properties": {
+                                "result": {
+                                    "type": "string"
+                                },
+                                "items": {
+                                    "type": "object",
+                                    "properties": {
+                                        "@type": {
+                                            "type": "string"
+                                        },
+                                        "items": {
+                                            "type": "object",
+                                            "properties": {
+                                                "@type": {
+                                                    "type": "string"
+                                                }
+                                            },
+                                            "additionalProperties": false
+                                        }
+                                    },
+                                    "additionalProperties": false
+                                }
+                            },
+                            "additionalProperties": false
+                        }
+                    },
+                    "additionalProperties": false
+                }
+            },
+            "additionalProperties": {}
+        }
+    }
+};
+exports.GetOutgoingRequestRequest = {
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "$ref": "#/definitions/GetOutgoingRequestRequest",
+    "definitions": {
+        "GetOutgoingRequestRequest": {
+            "type": "object",
+            "properties": {
+                "id": {
+                    "type": "string",
+                    "pattern": "CNSREQ[A-Za-z0-9]{14}"
                 }
             },
             "required": [
-                "relationshipId"
+                "id"
             ],
             "additionalProperties": false
         }
     }
 };
-exports.GetRelationshipInfoRequest = {
+exports.GetOutgoingRequestsRequest = {
     "$schema": "http://json-schema.org/draft-07/schema#",
-    "$ref": "#/definitions/GetRelationshipInfoRequest",
+    "$ref": "#/definitions/GetOutgoingRequestsRequest",
     "definitions": {
-        "GetRelationshipInfoRequest": {
+        "GetOutgoingRequestsRequest": {
+            "type": "object",
+            "properties": {
+                "query": {
+                    "$ref": "#/definitions/GetOutgoingRequestsRequestQuery"
+                }
+            },
+            "additionalProperties": false
+        },
+        "GetOutgoingRequestsRequestQuery": {
             "type": "object",
             "properties": {
                 "id": {
                     "type": "string"
+                },
+                "peer": {
+                    "type": "string"
+                },
+                "createdAt": {
+                    "type": "string"
+                },
+                "status": {
+                    "type": "string"
+                },
+                "content": {
+                    "type": "object",
+                    "properties": {
+                        "expiresAt": {
+                            "type": "string"
+                        },
+                        "items": {
+                            "type": "object",
+                            "properties": {
+                                "@type": {
+                                    "type": "string"
+                                }
+                            },
+                            "additionalProperties": false
+                        }
+                    },
+                    "additionalProperties": false
+                },
+                "source": {
+                    "type": "object",
+                    "properties": {
+                        "type": {
+                            "type": "string"
+                        },
+                        "reference": {
+                            "type": "string"
+                        }
+                    },
+                    "additionalProperties": false
+                },
+                "response": {
+                    "type": "object",
+                    "properties": {
+                        "createdAt": {
+                            "type": "string"
+                        },
+                        "source": {
+                            "type": "object",
+                            "properties": {
+                                "type": {
+                                    "type": "string"
+                                },
+                                "reference": {
+                                    "type": "string"
+                                }
+                            },
+                            "additionalProperties": false
+                        },
+                        "content": {
+                            "type": "object",
+                            "properties": {
+                                "result": {
+                                    "type": "string"
+                                },
+                                "items": {
+                                    "type": "object",
+                                    "properties": {
+                                        "@type": {
+                                            "type": "string"
+                                        },
+                                        "items": {
+                                            "type": "object",
+                                            "properties": {
+                                                "@type": {
+                                                    "type": "string"
+                                                }
+                                            },
+                                            "additionalProperties": false
+                                        }
+                                    },
+                                    "additionalProperties": false
+                                }
+                            },
+                            "additionalProperties": false
+                        }
+                    },
+                    "additionalProperties": false
                 }
             },
-            "required": [
-                "id"
-            ],
-            "additionalProperties": false
+            "additionalProperties": {}
         }
     }
 };
-exports.GetRelationshipInfoByRelationshipRequest = {
+exports.ReceivedIncomingRequestRequest = {
     "$schema": "http://json-schema.org/draft-07/schema#",
-    "$ref": "#/definitions/GetRelationshipInfoByRelationshipRequest",
+    "$ref": "#/definitions/ReceivedIncomingRequestRequest",
     "definitions": {
-        "GetRelationshipInfoByRelationshipRequest": {
+        "ReceivedIncomingRequestRequest": {
             "type": "object",
             "properties": {
-                "relationshipId": {
-                    "type": "string"
+                "receivedRequest": {
+                    "$ref": "#/definitions/RequestJSON"
+                },
+                "requestSourceId": {
+                    "type": "string",
+                    "description": "The id of the Message or RelationshipTemplate in which the Response was received.",
+                    "pattern": "(MSG|RLT)[A-Za-z0-9]{14}"
                 }
             },
             "required": [
-                "relationshipId"
+                "receivedRequest",
+                "requestSourceId"
             ],
             "additionalProperties": false
-        }
-    }
-};
-exports.UpdateRelationshipInfoRequest = {
-    "$schema": "http://json-schema.org/draft-07/schema#",
-    "$ref": "#/definitions/UpdateRelationshipInfoRequest",
-    "definitions": {
-        "UpdateRelationshipInfoRequest": {
+        },
+        "RequestJSON": {
             "type": "object",
             "properties": {
-                "id": {
+                "@type": {
                     "type": "string"
                 },
-                "attributes": {
-                    "type": "array",
-                    "items": {
-                        "$ref": "#/definitions/RelationshipAttributeDTO"
-                    }
-                },
-                "isPinned": {
-                    "type": "boolean"
-                },
-                "title": {
+                "@context": {
                     "type": "string"
                 },
-                "description": {
+                "@version": {
                     "type": "string"
                 },
-                "userTitle": {
+                "id": {
                     "type": "string"
                 },
-                "userDescription": {
-                    "type": "string"
+                "expiresAt": {
+                    "type": "string",
+                    "description": "The point in time the request is considered obsolete either technically (e.g. the request is no longer valid or its response is no longer accepted) or from a business perspective (e.g. the request is no longer of interest).",
+                    "default": "undefined - the request won't expire"
                 },
-                "theme": {
-                    "$ref": "#/definitions/RelationshipThemeDTO"
+                "items": {
+                    "type": "array",
+                    "items": {
+                        "anyOf": [
+                            {
+                                "$ref": "#/definitions/RequestItemGroupJSON"
+                            },
+                            {
+                                "$ref": "#/definitions/RequestItemJSON"
+                            }
+                        ]
+                    },
+                    "description": "The items of the Request. Can be either a single  {@link  RequestItemJSON RequestItem }  or a  {@link  RequestItemGroupJSON RequestItemGroup } , which itself can contain further  {@link  RequestItemJSON RequestItems } ."
                 }
             },
             "required": [
-                "id"
+                "@type",
+                "items"
             ],
-            "additionalProperties": false,
-            "description": "Overwrite a RelationshipInfo's attributes with the request's corresponding fields. Undefined fields in the request will leave the corresponding RelationshipInfo's attributes untouched."
+            "additionalProperties": false
         },
-        "RelationshipAttributeDTO": {
+        "RequestItemGroupJSON": {
             "type": "object",
             "properties": {
-                "name": {
+                "@type": {
                     "type": "string"
                 },
-                "content": {
-                    "$ref": "#/definitions/AttributeJSON"
+                "@context": {
+                    "type": "string"
                 },
-                "sharedItem": {
+                "@version": {
                     "type": "string"
+                },
+                "title": {
+                    "type": "string",
+                    "description": "The human-readable title of this group."
+                },
+                "description": {
+                    "type": "string",
+                    "description": "The human-readable description of this group."
+                },
+                "mustBeAccepted": {
+                    "type": "boolean",
+                    "description": "If set to `true`, the recipient has to accept this group if he wants to accept the Request. If set to `false`, the recipient can decide whether he wants to accept it or not."
+                },
+                "responseMetadata": {
+                    "type": "object",
+                    "description": "This propertycan be used to add some arbitrary metadata to this group. The content of this property will be copied into the response on the side of the recipient, so the sender can use it to identify the group content as they receive the response."
+                },
+                "items": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/definitions/RequestItemJSON"
+                    },
+                    "description": "The items of this group."
                 }
             },
             "required": [
-                "name",
-                "content",
-                "sharedItem"
+                "@type",
+                "items",
+                "mustBeAccepted"
             ],
-            "additionalProperties": false
+            "additionalProperties": false,
+            "description": "A RequestItemGroup can be used to group one or more  {@link  RequestItemJSON RequestItems } . This is useful if you want to\n* make sure that the items in the group can only be accepted together\n\n  Example: when sending a `CreateAttributeRequestItem` **and** a `ShareAttributeRequestItem` in a single   Request where the latter one targets an attribute created by the first one, it it should be impossible to   reject the first item, while accepting the second one.\n* visually group items on the UI and give the a common title/description"
         },
-        "AttributeJSON": {
+        "RequestItemJSON": {
             "type": "object",
             "properties": {
                 "@type": {
                     "type": "string"
                 },
-                "@schema": {
+                "@context": {
                     "type": "string"
                 },
-                "name": {
+                "@version": {
                     "type": "string"
                 },
-                "value": {},
-                "validFrom": {
-                    "type": "string"
+                "title": {
+                    "type": "string",
+                    "description": "The human-readable title of this item."
                 },
-                "validTo": {
-                    "type": "string"
+                "description": {
+                    "type": "string",
+                    "description": "The human-readable description of this item."
+                },
+                "responseMetadata": {
+                    "type": "object",
+                    "description": "This propertycan be used to add some arbitrary metadata to this item. The content of this property will be copied into the response on the side of the recipient, so the sender can use it to identify the group content as they receive the response."
+                },
+                "mustBeAccepted": {
+                    "type": "boolean",
+                    "description": "If set to `true`, the recipient has to accept this group if he wants to accept the Request. If set to `false`, the recipient can decide whether he wants to accept it or not.\n\nCaution: this setting does not take effect in case it is inside of a\n {@link  RequestItemGroupJSON RequestItemGroup } , which is not accepted by the recipient, since a  {@link  RequestItemJSON RequestItem }  can only be accepted if the parent group is accepted as well."
                 }
             },
             "required": [
                 "@type",
-                "name",
-                "value"
+                "mustBeAccepted"
             ],
             "additionalProperties": false
-        },
-        "RelationshipThemeDTO": {
+        }
+    }
+};
+exports.RequireManualDecisionOfIncomingRequestRequest = {
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "$ref": "#/definitions/RequireManualDecisionOfIncomingRequestRequest",
+    "definitions": {
+        "RequireManualDecisionOfIncomingRequestRequest": {
             "type": "object",
             "properties": {
-                "image": {
-                    "type": "string"
-                },
-                "imageBar": {
-                    "type": "string"
-                },
-                "backgroundColor": {
-                    "type": "string"
+                "requestId": {
+                    "type": "string",
+                    "pattern": "CNSREQ[A-Za-z0-9]{14}"
+                }
+            },
+            "required": [
+                "requestId"
+            ],
+            "additionalProperties": false
+        }
+    }
+};
+exports.SentOutgoingRequestRequest = {
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "$ref": "#/definitions/SentOutgoingRequestRequest",
+    "definitions": {
+        "SentOutgoingRequestRequest": {
+            "type": "object",
+            "properties": {
+                "requestId": {
+                    "type": "string",
+                    "pattern": "CNSREQ[A-Za-z0-9]{14}"
                 },
-                "foregroundColor": {
-                    "type": "string"
+                "messageId": {
+                    "type": "string",
+                    "pattern": "MSG[A-Za-z0-9]{17}"
                 }
             },
             "required": [
-                "image",
-                "imageBar",
-                "backgroundColor",
-                "foregroundColor"
+                "requestId",
+                "messageId"
             ],
             "additionalProperties": false
         }
@@ -800,193 +1557,6 @@ exports.UpdateSettingRequest = {
         }
     }
 };
-exports.CreateSharedItemRequest = {
-    "$schema": "http://json-schema.org/draft-07/schema#",
-    "$ref": "#/definitions/CreateSharedItemRequest",
-    "definitions": {
-        "CreateSharedItemRequest": {
-            "type": "object",
-            "properties": {
-                "tags": {
-                    "type": "array",
-                    "items": {
-                        "type": "string"
-                    }
-                },
-                "sharedBy": {
-                    "type": "string"
-                },
-                "sharedWith": {
-                    "type": "string"
-                },
-                "sharedAt": {
-                    "type": "string"
-                },
-                "reference": {
-                    "type": "string"
-                },
-                "content": {},
-                "succeedsItem": {
-                    "type": "string"
-                },
-                "succeedsAt": {
-                    "type": "string"
-                },
-                "expiresAt": {
-                    "type": "string"
-                }
-            },
-            "required": [
-                "sharedBy",
-                "sharedWith",
-                "sharedAt",
-                "content"
-            ],
-            "additionalProperties": false
-        }
-    }
-};
-exports.DeleteSharedItemRequest = {
-    "$schema": "http://json-schema.org/draft-07/schema#",
-    "$ref": "#/definitions/DeleteSharedItemRequest",
-    "definitions": {
-        "DeleteSharedItemRequest": {
-            "type": "object",
-            "properties": {
-                "id": {
-                    "type": "string"
-                }
-            },
-            "required": [
-                "id"
-            ],
-            "additionalProperties": false
-        }
-    }
-};
-exports.GetSharedItemRequest = {
-    "$schema": "http://json-schema.org/draft-07/schema#",
-    "$ref": "#/definitions/GetSharedItemRequest",
-    "definitions": {
-        "GetSharedItemRequest": {
-            "type": "object",
-            "properties": {
-                "id": {
-                    "type": "string"
-                }
-            },
-            "required": [
-                "id"
-            ],
-            "additionalProperties": false
-        }
-    }
-};
-exports.GetSharedItemsRequest = {
-    "$schema": "http://json-schema.org/draft-07/schema#",
-    "$ref": "#/definitions/GetSharedItemsRequest",
-    "definitions": {
-        "GetSharedItemsRequest": {
-            "type": "object",
-            "properties": {
-                "query": {}
-            },
-            "additionalProperties": false
-        }
-    }
-};
-exports.GetSharedItemsByAddressRequest = {
-    "$schema": "http://json-schema.org/draft-07/schema#",
-    "$ref": "#/definitions/GetSharedItemsByAddressRequest",
-    "definitions": {
-        "GetSharedItemsByAddressRequest": {
-            "type": "object",
-            "properties": {
-                "address": {
-                    "type": "string"
-                }
-            },
-            "required": [
-                "address"
-            ],
-            "additionalProperties": false
-        }
-    }
-};
-exports.GetSharedItemsByReferenceRequest = {
-    "$schema": "http://json-schema.org/draft-07/schema#",
-    "$ref": "#/definitions/GetSharedItemsByReferenceRequest",
-    "definitions": {
-        "GetSharedItemsByReferenceRequest": {
-            "type": "object",
-            "properties": {
-                "reference": {
-                    "type": "string"
-                }
-            },
-            "required": [
-                "reference"
-            ],
-            "additionalProperties": false
-        }
-    }
-};
-exports.GetSharedItemsSharedByAddressRequest = {
-    "$schema": "http://json-schema.org/draft-07/schema#",
-    "$ref": "#/definitions/GetSharedItemsSharedByAddressRequest",
-    "definitions": {
-        "GetSharedItemsSharedByAddressRequest": {
-            "type": "object",
-            "properties": {
-                "address": {
-                    "type": "string"
-                }
-            },
-            "required": [
-                "address"
-            ],
-            "additionalProperties": false
-        }
-    }
-};
-exports.GetSharedItemsSharedWithAddressRequest = {
-    "$schema": "http://json-schema.org/draft-07/schema#",
-    "$ref": "#/definitions/GetSharedItemsSharedWithAddressRequest",
-    "definitions": {
-        "GetSharedItemsSharedWithAddressRequest": {
-            "type": "object",
-            "properties": {
-                "address": {
-                    "type": "string"
-                }
-            },
-            "required": [
-                "address"
-            ],
-            "additionalProperties": false
-        }
-    }
-};
-exports.UpdateSharedItemRequest = {
-    "$schema": "http://json-schema.org/draft-07/schema#",
-    "$ref": "#/definitions/UpdateSharedItemRequest",
-    "definitions": {
-        "UpdateSharedItemRequest": {
-            "type": "object",
-            "properties": {
-                "id": {
-                    "type": "string"
-                },
-                "content": {}
-            },
-            "required": [
-                "id",
-                "content"
-            ],
-            "additionalProperties": false
-        }
-    }
-};
 exports.RegisterPushNotificationTokenRequest = {
     "$schema": "http://json-schema.org/draft-07/schema#",
     "$ref": "#/definitions/RegisterPushNotificationTokenRequest",
@@ -1032,7 +1602,7 @@ exports.DownloadFileRequest = {
             "properties": {
                 "id": {
                     "type": "string",
-                    "format": "fileId"
+                    "pattern": "FIL[A-z0-9]{17}"
                 }
             },
             "required": [
@@ -1087,7 +1657,7 @@ exports.CreateRelationshipChallengeRequest = {
                 },
                 "relationship": {
                     "type": "string",
-                    "format": "relationshipId"
+                    "pattern": "REL[A-z0-9]{17}"
                 }
             },
             "required": [
@@ -1162,7 +1732,7 @@ exports.CreateChallengeRequest = {
                 },
                 "relationship": {
                     "type": "string",
-                    "format": "relationshipId"
+                    "pattern": "REL[A-z0-9]{17}"
                 }
             },
             "required": [
@@ -1350,7 +1920,7 @@ exports.CreateTokenForFileRequest = {
             "properties": {
                 "fileId": {
                     "type": "string",
-                    "format": "fileId"
+                    "pattern": "FIL[A-z0-9]{17}"
                 },
                 "expiresAt": {
                     "type": "string",
@@ -1376,7 +1946,7 @@ exports.CreateTokenQrCodeForFileRequest = {
             "properties": {
                 "fileId": {
                     "type": "string",
-                    "format": "fileId"
+                    "pattern": "FIL[A-z0-9]{17}"
                 },
                 "expiresAt": {
                     "type": "string",
@@ -1399,7 +1969,7 @@ exports.GetFileRequest = {
             "properties": {
                 "id": {
                     "type": "string",
-                    "format": "fileId"
+                    "pattern": "FIL[A-z0-9]{17}"
                 }
             },
             "required": [
@@ -1441,7 +2011,7 @@ exports.LoadPeerFileViaSecretRequest = {
             "properties": {
                 "id": {
                     "type": "string",
-                    "format": "fileId"
+                    "pattern": "FIL[A-z0-9]{17}"
                 },
                 "secretKey": {
                     "type": "string",
@@ -1495,7 +2065,7 @@ exports.LoadPeerFileRequest = {
             "properties": {
                 "id": {
                     "type": "string",
-                    "format": "fileId"
+                    "pattern": "FIL[A-z0-9]{17}"
                 },
                 "secretKey": {
                     "type": "string",