@nmshd/runtime 2.0.0-beta.19 → 2.0.0-beta.21

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (21) hide show
  1. package/dist/buildInformation.js +5 -5
  2. package/dist/dataViews/DataViewExpander.js +34 -17
  3. package/dist/dataViews/DataViewExpander.js.map +1 -1
  4. package/dist/dataViews/consumption/PeerRelationshipTemplateDVO.d.ts +4 -2
  5. package/dist/dataViews/transport/RelationshipDVO.d.ts +1 -0
  6. package/dist/dataViews/transport/RelationshipTemplateDVO.d.ts +2 -0
  7. package/dist/extensibility/facades/consumption/OutgoingRequestsFacade.d.ts +2 -2
  8. package/dist/extensibility/facades/consumption/OutgoingRequestsFacade.js.map +1 -1
  9. package/dist/useCases/common/SchemaRepository.js +1 -1
  10. package/dist/useCases/common/SchemaRepository.js.map +1 -1
  11. package/dist/useCases/common/Schemas.d.ts +2 -1
  12. package/dist/useCases/common/Schemas.js +1383 -7
  13. package/dist/useCases/common/Schemas.js.map +1 -1
  14. package/dist/useCases/consumption/requests/CanCreateOutgoingRequest.d.ts +13 -5
  15. package/dist/useCases/consumption/requests/CanCreateOutgoingRequest.js +14 -4
  16. package/dist/useCases/consumption/requests/CanCreateOutgoingRequest.js.map +1 -1
  17. package/lib-web/nmshd.runtime.js +1666 -242
  18. package/lib-web/nmshd.runtime.js.map +1 -1
  19. package/lib-web/nmshd.runtime.min.js +5 -5
  20. package/lib-web/nmshd.runtime.min.js.map +1 -1
  21. package/package.json +11 -11
package/dist/useCases/common/Schemas.js CHANGED
@@ -1,7 +1,7 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.CreateDeviceOnboardingTokenRequest = exports.CreateDeviceRequest = exports.ValidateChallengeRequest = exports.CreateChallengeRequest = exports.CreateDeviceChallengeRequest = exports.CreateIdentityChallengeRequest = exports.CreateRelationshipChallengeRequest = exports.SyncEverythingRequest = exports.DownloadAttachmentRequest = exports.SyncDatawalletRequest = exports.RegisterPushNotificationTokenRequest = exports.LoadItemFromTruncatedReferenceRequest = exports.DownloadFileRequest = 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.GetSharedToPeerAttributesRequest = exports.GetPeerAttributesRequest = exports.GetAttributesRequest = exports.GetAttributeRequest = exports.ExecuteRelationshipAttributeQueryRequest = exports.ExecuteIdentityAttributeQueryRequest = exports.DeleteAttributeRequest = exports.CreateSharedAttributeCopyRequest = exports.CreateAttributeRequest = exports.LoadPeerTokenAnonymousByTruncatedReferenceRequest = exports.LoadPeerTokenAnonymousByIdAndKeyRequest = void 0;
4
- exports.LoadPeerTokenRequest = exports.LoadPeerTokenViaSecretRequest = exports.LoadPeerTokenViaReferenceRequest = exports.GetTokensRequest = exports.GetTokenRequest = exports.GetQRCodeForTokenRequest = exports.CreateOwnTokenRequest = exports.LoadPeerRelationshipTemplateRequest = exports.LoadPeerRelationshipTemplateViaReferenceRequest = exports.LoadPeerRelationshipTemplateViaSecretRequest = exports.GetRelationshipTemplatesRequest = exports.GetRelationshipTemplateRequest = exports.CreateTokenQrCodeForOwnTemplateRequest = exports.CreateTokenForOwnTemplateRequest = exports.CreateQrCodeForOwnTemplateRequest = exports.CreateOwnRelationshipTemplateRequest = exports.RevokeRelationshipChangeRequest = exports.RejectRelationshipChangeRequest = exports.GetRelationshipsRequest = exports.GetRelationshipByAddressRequest = exports.GetRelationshipRequest = exports.GetAttributesForRelationshipRequest = exports.CreateRelationshipChangeRequest = exports.CreateRelationshipRequest = exports.AcceptRelationshipChangeRequest = exports.SendMessageRequest = exports.GetMessagesRequest = exports.GetMessageRequest = exports.GetAttachmentMetadataRequest = exports.CheckIdentityRequest = exports.UploadOwnFileValidatableRequest = exports.UploadOwnFileRequest = exports.GetOrLoadFileRequest = exports.GetOrLoadFileViaReferenceRequest = exports.GetOrLoadFileViaSecretRequest = exports.GetFilesRequest = exports.GetFileRequest = exports.CreateTokenQrCodeForFileRequest = exports.CreateTokenForFileRequest = exports.CreateQrCodeForFileRequest = exports.UpdateDeviceRequest = exports.GetDeviceOnboardingInfoRequest = exports.GetDeviceRequest = exports.DeleteDeviceRequest = void 0;
3
+ exports.CreateDeviceRequest = exports.ValidateChallengeRequest = exports.CreateChallengeRequest = exports.CreateDeviceChallengeRequest = exports.CreateIdentityChallengeRequest = exports.CreateRelationshipChallengeRequest = exports.SyncEverythingRequest = exports.DownloadAttachmentRequest = exports.SyncDatawalletRequest = exports.RegisterPushNotificationTokenRequest = exports.LoadItemFromTruncatedReferenceRequest = exports.DownloadFileRequest = 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.CreateOutgoingRequestRequest = exports.CreateAndCompleteOutgoingRequestFromRelationshipCreationChangeRequest = exports.CompleteOutgoingRequestRequest = exports.CompleteIncomingRequestRequest = exports.CheckPrerequisitesOfIncomingRequestRequest = exports.RejectIncomingRequestRequest = exports.CanCreateOutgoingRequestRequest = exports.AcceptIncomingRequestRequest = exports.UpdateDraftRequest = exports.GetDraftsRequest = exports.GetDraftRequest = exports.DeleteDraftRequest = exports.CreateDraftRequest = exports.UpdateAttributeRequest = exports.SucceedAttributeRequest = exports.GetSharedToPeerAttributesRequest = exports.GetPeerAttributesRequest = exports.GetAttributesRequest = exports.GetAttributeRequest = exports.ExecuteRelationshipAttributeQueryRequest = exports.ExecuteIdentityAttributeQueryRequest = exports.DeleteAttributeRequest = exports.CreateSharedAttributeCopyRequest = exports.CreateAttributeRequest = exports.LoadPeerTokenAnonymousByTruncatedReferenceRequest = exports.LoadPeerTokenAnonymousByIdAndKeyRequest = void 0;
4
+ exports.LoadPeerTokenRequest = exports.LoadPeerTokenViaSecretRequest = exports.LoadPeerTokenViaReferenceRequest = exports.GetTokensRequest = exports.GetTokenRequest = exports.GetQRCodeForTokenRequest = exports.CreateOwnTokenRequest = exports.LoadPeerRelationshipTemplateRequest = exports.LoadPeerRelationshipTemplateViaReferenceRequest = exports.LoadPeerRelationshipTemplateViaSecretRequest = exports.GetRelationshipTemplatesRequest = exports.GetRelationshipTemplateRequest = exports.CreateTokenQrCodeForOwnTemplateRequest = exports.CreateTokenForOwnTemplateRequest = exports.CreateQrCodeForOwnTemplateRequest = exports.CreateOwnRelationshipTemplateRequest = exports.RevokeRelationshipChangeRequest = exports.RejectRelationshipChangeRequest = exports.GetRelationshipsRequest = exports.GetRelationshipByAddressRequest = exports.GetRelationshipRequest = exports.GetAttributesForRelationshipRequest = exports.CreateRelationshipChangeRequest = exports.CreateRelationshipRequest = exports.AcceptRelationshipChangeRequest = exports.SendMessageRequest = exports.GetMessagesRequest = exports.GetMessageRequest = exports.GetAttachmentMetadataRequest = exports.CheckIdentityRequest = exports.UploadOwnFileValidatableRequest = exports.UploadOwnFileRequest = exports.GetOrLoadFileRequest = exports.GetOrLoadFileViaReferenceRequest = exports.GetOrLoadFileViaSecretRequest = exports.GetFilesRequest = exports.GetFileRequest = exports.CreateTokenQrCodeForFileRequest = exports.CreateTokenForFileRequest = exports.CreateQrCodeForFileRequest = exports.UpdateDeviceRequest = exports.GetDeviceOnboardingInfoRequest = exports.GetDeviceRequest = exports.DeleteDeviceRequest = exports.CreateDeviceOnboardingTokenRequest = void 0;
5
5
  exports.LoadPeerTokenAnonymousByIdAndKeyRequest = {
6
6
  "$schema": "http://json-schema.org/draft-07/schema#",
7
7
  "$ref": "#/definitions/LoadPeerTokenAnonymousByIdAndKeyRequest",
@@ -1775,11 +1775,11 @@ exports.AcceptIncomingRequestRequest = {
1775
1775
  }
1776
1776
  }
1777
1777
  };
1778
- exports.CreateOutgoingRequestRequest = {
1778
+ exports.CanCreateOutgoingRequestRequest = {
1779
1779
  "$schema": "http://json-schema.org/draft-07/schema#",
1780
- "$ref": "#/definitions/CreateOutgoingRequestRequest",
1780
+ "$ref": "#/definitions/CanCreateOutgoingRequestRequest",
1781
1781
  "definitions": {
1782
- "CreateOutgoingRequestRequest": {
1782
+ "CanCreateOutgoingRequestRequest": {
1783
1783
  "type": "object",
1784
1784
  "properties": {
1785
1785
  "content": {
@@ -1869,8 +1869,7 @@ exports.CreateOutgoingRequestRequest = {
1869
1869
  }
1870
1870
  },
1871
1871
  "required": [
1872
- "content",
1873
- "peer"
1872
+ "content"
1874
1873
  ],
1875
1874
  "additionalProperties": false
1876
1875
  },
@@ -3788,6 +3787,1383 @@ exports.CreateAndCompleteOutgoingRequestFromRelationshipCreationChangeRequest =
3788
3787
  }
3789
3788
  }
3790
3789
  };
3790
+ exports.CreateOutgoingRequestRequest = {
3791
+ "$schema": "http://json-schema.org/draft-07/schema#",
3792
+ "$ref": "#/definitions/CreateOutgoingRequestRequest",
3793
+ "definitions": {
3794
+ "CreateOutgoingRequestRequest": {
3795
+ "type": "object",
3796
+ "properties": {
3797
+ "content": {
3798
+ "type": "object",
3799
+ "properties": {
3800
+ "expiresAt": {
3801
+ "anyOf": [
3802
+ {
3803
+ "type": "string",
3804
+ "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).",
3805
+ "default": "undefined - the request won't expire"
3806
+ },
3807
+ {
3808
+ "$ref": "#/definitions/ICoreDate",
3809
+ "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).",
3810
+ "default": "undefined - the request won't expire"
3811
+ }
3812
+ ],
3813
+ "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).",
3814
+ "default": "undefined - the request won't expire"
3815
+ },
3816
+ "items": {
3817
+ "anyOf": [
3818
+ {
3819
+ "type": "array",
3820
+ "items": {
3821
+ "anyOf": [
3822
+ {
3823
+ "$ref": "#/definitions/RequestItemGroupJSON"
3824
+ },
3825
+ {
3826
+ "$ref": "#/definitions/RequestItemJSONDerivations"
3827
+ }
3828
+ ]
3829
+ },
3830
+ "description": "The items of the Request. Can be either a single {@link RequestItemJSONDerivations RequestItem } or a {@link RequestItemGroupJSON RequestItemGroup } , which itself can contain further {@link RequestItemJSONDerivations RequestItems } ."
3831
+ },
3832
+ {
3833
+ "type": "array",
3834
+ "items": {
3835
+ "anyOf": [
3836
+ {
3837
+ "$ref": "#/definitions/IRequestItemGroup"
3838
+ },
3839
+ {
3840
+ "$ref": "#/definitions/IRequestItemDerivations"
3841
+ }
3842
+ ]
3843
+ },
3844
+ "description": "The items of the Request. Can be either a single {@link IRequestItemDerivations RequestItem } or a {@link IRequestItemGroup RequestItemGroup } , which itself can contain further {@link IRequestItemDerivations RequestItems } ."
3845
+ }
3846
+ ],
3847
+ "description": "The items of the Request. Can be either a single {@link RequestItemJSONDerivations RequestItem } or a {@link RequestItemGroupJSON RequestItemGroup } , which itself can contain further {@link RequestItemJSONDerivations RequestItems } ."
3848
+ },
3849
+ "title": {
3850
+ "type": "string",
3851
+ "description": "The human-readable title of this Request."
3852
+ },
3853
+ "description": {
3854
+ "type": "string",
3855
+ "description": "The human-readable description of this Request."
3856
+ },
3857
+ "metadata": {
3858
+ "anyOf": [
3859
+ {
3860
+ "type": "object",
3861
+ "description": "This property can be used to add some arbitrary metadata to this request. The content of this property will be copied into the response on the side of the recipient."
3862
+ },
3863
+ {
3864
+ "type": "object",
3865
+ "description": "This property can be used to add some arbitrary metadata to this request. The content of this property will be copied into the response on the side of the recipient."
3866
+ }
3867
+ ],
3868
+ "description": "This property can be used to add some arbitrary metadata to this request. The content of this property will be copied into the response on the side of the recipient."
3869
+ },
3870
+ "@context": {
3871
+ "type": "string"
3872
+ }
3873
+ },
3874
+ "required": [
3875
+ "items"
3876
+ ],
3877
+ "additionalProperties": false
3878
+ },
3879
+ "peer": {
3880
+ "$ref": "#/definitions/AddressString"
3881
+ }
3882
+ },
3883
+ "required": [
3884
+ "content",
3885
+ "peer"
3886
+ ],
3887
+ "additionalProperties": false
3888
+ },
3889
+ "ICoreDate": {
3890
+ "type": "object",
3891
+ "properties": {
3892
+ "date": {
3893
+ "type": "string"
3894
+ }
3895
+ },
3896
+ "required": [
3897
+ "date"
3898
+ ],
3899
+ "additionalProperties": false
3900
+ },
3901
+ "RequestItemGroupJSON": {
3902
+ "type": "object",
3903
+ "properties": {
3904
+ "@type": {
3905
+ "type": "string"
3906
+ },
3907
+ "@context": {
3908
+ "type": "string"
3909
+ },
3910
+ "@version": {
3911
+ "type": "string"
3912
+ },
3913
+ "title": {
3914
+ "type": "string",
3915
+ "description": "The human-readable title of this group."
3916
+ },
3917
+ "description": {
3918
+ "type": "string",
3919
+ "description": "The human-readable description of this group."
3920
+ },
3921
+ "mustBeAccepted": {
3922
+ "type": "boolean",
3923
+ "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."
3924
+ },
3925
+ "metadata": {
3926
+ "type": "object",
3927
+ "description": "This property can 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."
3928
+ },
3929
+ "items": {
3930
+ "type": "array",
3931
+ "items": {
3932
+ "$ref": "#/definitions/RequestItemJSONDerivations"
3933
+ },
3934
+ "description": "The items of this group."
3935
+ }
3936
+ },
3937
+ "required": [
3938
+ "@type",
3939
+ "items",
3940
+ "mustBeAccepted"
3941
+ ],
3942
+ "additionalProperties": false,
3943
+ "description": "A RequestItemGroup can be used to group one or more 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 `CreateRelationshipAttributeRequestItem` **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"
3944
+ },
3945
+ "RequestItemJSONDerivations": {
3946
+ "anyOf": [
3947
+ {
3948
+ "$ref": "#/definitions/RequestItemJSON"
3949
+ },
3950
+ {
3951
+ "$ref": "#/definitions/CreateRelationshipAttributeRequestItemJSON"
3952
+ },
3953
+ {
3954
+ "$ref": "#/definitions/ShareAttributeRequestItemJSON"
3955
+ },
3956
+ {
3957
+ "$ref": "#/definitions/ProposeAttributeRequestItemJSON"
3958
+ },
3959
+ {
3960
+ "$ref": "#/definitions/ReadAttributeRequestItemJSON"
3961
+ },
3962
+ {
3963
+ "$ref": "#/definitions/ConsentRequestItemJSON"
3964
+ },
3965
+ {
3966
+ "$ref": "#/definitions/AuthenticationRequestItemJSON"
3967
+ }
3968
+ ]
3969
+ },
3970
+ "RequestItemJSON": {
3971
+ "type": "object",
3972
+ "properties": {
3973
+ "@type": {
3974
+ "type": "string"
3975
+ },
3976
+ "@context": {
3977
+ "type": "string"
3978
+ },
3979
+ "@version": {
3980
+ "type": "string"
3981
+ },
3982
+ "title": {
3983
+ "type": "string",
3984
+ "description": "The human-readable title of this item."
3985
+ },
3986
+ "description": {
3987
+ "type": "string",
3988
+ "description": "The human-readable description of this item."
3989
+ },
3990
+ "metadata": {
3991
+ "type": "object",
3992
+ "description": "This property can 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."
3993
+ },
3994
+ "mustBeAccepted": {
3995
+ "type": "boolean",
3996
+ "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."
3997
+ },
3998
+ "requireManualDecision": {
3999
+ "type": "boolean",
4000
+ "description": "If set to `true`, it advices the recipient of this RequestItem to carefully consider their decision and especially do not decide based on some automation rules."
4001
+ }
4002
+ },
4003
+ "required": [
4004
+ "@type",
4005
+ "mustBeAccepted"
4006
+ ],
4007
+ "additionalProperties": false
4008
+ },
4009
+ "CreateRelationshipAttributeRequestItemJSON": {
4010
+ "type": "object",
4011
+ "properties": {
4012
+ "@type": {
4013
+ "type": "string"
4014
+ },
4015
+ "@context": {
4016
+ "type": "string"
4017
+ },
4018
+ "@version": {
4019
+ "type": "string"
4020
+ },
4021
+ "title": {
4022
+ "type": "string",
4023
+ "description": "The human-readable title of this item."
4024
+ },
4025
+ "description": {
4026
+ "type": "string",
4027
+ "description": "The human-readable description of this item."
4028
+ },
4029
+ "metadata": {
4030
+ "type": "object",
4031
+ "description": "This property can 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."
4032
+ },
4033
+ "mustBeAccepted": {
4034
+ "type": "boolean",
4035
+ "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."
4036
+ },
4037
+ "requireManualDecision": {
4038
+ "type": "boolean",
4039
+ "description": "If set to `true`, it advices the recipient of this RequestItem to carefully consider their decision and especially do not decide based on some automation rules."
4040
+ },
4041
+ "attribute": {
4042
+ "$ref": "#/definitions/RelationshipAttributeJSON"
4043
+ }
4044
+ },
4045
+ "required": [
4046
+ "@type",
4047
+ "attribute",
4048
+ "mustBeAccepted"
4049
+ ],
4050
+ "additionalProperties": false
4051
+ },
4052
+ "RelationshipAttributeJSON": {
4053
+ "type": "object",
4054
+ "properties": {
4055
+ "@type": {
4056
+ "type": "string"
4057
+ },
4058
+ "@context": {
4059
+ "type": "string"
4060
+ },
4061
+ "@version": {
4062
+ "type": "string"
4063
+ },
4064
+ "owner": {
4065
+ "type": "string"
4066
+ },
4067
+ "validFrom": {
4068
+ "type": "string"
4069
+ },
4070
+ "validTo": {
4071
+ "type": "string"
4072
+ },
4073
+ "value": {
4074
+ "$ref": "#/definitions/AbstractAttributeValueJSON"
4075
+ },
4076
+ "key": {
4077
+ "type": "string"
4078
+ },
4079
+ "isTechnical": {
4080
+ "type": "boolean"
4081
+ },
4082
+ "confidentiality": {
4083
+ "$ref": "#/definitions/RelationshipAttributeConfidentiality"
4084
+ }
4085
+ },
4086
+ "required": [
4087
+ "@type",
4088
+ "confidentiality",
4089
+ "key",
4090
+ "owner",
4091
+ "value"
4092
+ ],
4093
+ "additionalProperties": false
4094
+ },
4095
+ "AbstractAttributeValueJSON": {
4096
+ "type": "object",
4097
+ "properties": {
4098
+ "@type": {
4099
+ "type": "string"
4100
+ },
4101
+ "@context": {
4102
+ "type": "string"
4103
+ },
4104
+ "@version": {
4105
+ "type": "string"
4106
+ }
4107
+ },
4108
+ "required": [
4109
+ "@type"
4110
+ ]
4111
+ },
4112
+ "RelationshipAttributeConfidentiality": {
4113
+ "type": "string",
4114
+ "enum": [
4115
+ "public",
4116
+ "private",
4117
+ "protected"
4118
+ ]
4119
+ },
4120
+ "ShareAttributeRequestItemJSON": {
4121
+ "type": "object",
4122
+ "properties": {
4123
+ "@type": {
4124
+ "type": "string"
4125
+ },
4126
+ "@context": {
4127
+ "type": "string"
4128
+ },
4129
+ "@version": {
4130
+ "type": "string"
4131
+ },
4132
+ "title": {
4133
+ "type": "string",
4134
+ "description": "The human-readable title of this item."
4135
+ },
4136
+ "description": {
4137
+ "type": "string",
4138
+ "description": "The human-readable description of this item."
4139
+ },
4140
+ "metadata": {
4141
+ "type": "object",
4142
+ "description": "This property can 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."
4143
+ },
4144
+ "mustBeAccepted": {
4145
+ "type": "boolean",
4146
+ "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."
4147
+ },
4148
+ "requireManualDecision": {
4149
+ "type": "boolean",
4150
+ "description": "If set to `true`, it advices the recipient of this RequestItem to carefully consider their decision and especially do not decide based on some automation rules."
4151
+ },
4152
+ "attribute": {
4153
+ "anyOf": [
4154
+ {
4155
+ "$ref": "#/definitions/IdentityAttributeJSON"
4156
+ },
4157
+ {
4158
+ "$ref": "#/definitions/RelationshipAttributeJSON"
4159
+ }
4160
+ ]
4161
+ },
4162
+ "sourceAttributeId": {
4163
+ "type": "string"
4164
+ }
4165
+ },
4166
+ "required": [
4167
+ "@type",
4168
+ "attribute",
4169
+ "mustBeAccepted",
4170
+ "sourceAttributeId"
4171
+ ],
4172
+ "additionalProperties": false
4173
+ },
4174
+ "IdentityAttributeJSON": {
4175
+ "type": "object",
4176
+ "properties": {
4177
+ "@type": {
4178
+ "type": "string"
4179
+ },
4180
+ "@context": {
4181
+ "type": "string"
4182
+ },
4183
+ "@version": {
4184
+ "type": "string"
4185
+ },
4186
+ "owner": {
4187
+ "type": "string"
4188
+ },
4189
+ "validFrom": {
4190
+ "type": "string"
4191
+ },
4192
+ "validTo": {
4193
+ "type": "string"
4194
+ },
4195
+ "value": {
4196
+ "$ref": "#/definitions/AbstractAttributeValueJSON"
4197
+ },
4198
+ "tags": {
4199
+ "type": "array",
4200
+ "items": {
4201
+ "type": "string"
4202
+ }
4203
+ }
4204
+ },
4205
+ "required": [
4206
+ "@type",
4207
+ "owner",
4208
+ "value"
4209
+ ],
4210
+ "additionalProperties": false
4211
+ },
4212
+ "ProposeAttributeRequestItemJSON": {
4213
+ "type": "object",
4214
+ "properties": {
4215
+ "@type": {
4216
+ "type": "string"
4217
+ },
4218
+ "@context": {
4219
+ "type": "string"
4220
+ },
4221
+ "@version": {
4222
+ "type": "string"
4223
+ },
4224
+ "title": {
4225
+ "type": "string",
4226
+ "description": "The human-readable title of this item."
4227
+ },
4228
+ "description": {
4229
+ "type": "string",
4230
+ "description": "The human-readable description of this item."
4231
+ },
4232
+ "metadata": {
4233
+ "type": "object",
4234
+ "description": "This property can 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."
4235
+ },
4236
+ "mustBeAccepted": {
4237
+ "type": "boolean",
4238
+ "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."
4239
+ },
4240
+ "requireManualDecision": {
4241
+ "type": "boolean",
4242
+ "description": "If set to `true`, it advices the recipient of this RequestItem to carefully consider their decision and especially do not decide based on some automation rules."
4243
+ },
4244
+ "query": {
4245
+ "anyOf": [
4246
+ {
4247
+ "$ref": "#/definitions/IdentityAttributeQueryJSON"
4248
+ },
4249
+ {
4250
+ "$ref": "#/definitions/RelationshipAttributeQueryJSON"
4251
+ }
4252
+ ]
4253
+ },
4254
+ "attribute": {
4255
+ "anyOf": [
4256
+ {
4257
+ "$ref": "#/definitions/IdentityAttributeJSON"
4258
+ },
4259
+ {
4260
+ "$ref": "#/definitions/RelationshipAttributeJSON"
4261
+ }
4262
+ ]
4263
+ }
4264
+ },
4265
+ "required": [
4266
+ "@type",
4267
+ "attribute",
4268
+ "mustBeAccepted",
4269
+ "query"
4270
+ ],
4271
+ "additionalProperties": false
4272
+ },
4273
+ "IdentityAttributeQueryJSON": {
4274
+ "type": "object",
4275
+ "properties": {
4276
+ "@type": {
4277
+ "type": "string"
4278
+ },
4279
+ "@context": {
4280
+ "type": "string"
4281
+ },
4282
+ "@version": {
4283
+ "type": "string"
4284
+ },
4285
+ "valueType": {
4286
+ "type": "string"
4287
+ },
4288
+ "validFrom": {
4289
+ "type": "string"
4290
+ },
4291
+ "validTo": {
4292
+ "type": "string"
4293
+ },
4294
+ "tags": {
4295
+ "type": "array",
4296
+ "items": {
4297
+ "type": "string"
4298
+ }
4299
+ }
4300
+ },
4301
+ "additionalProperties": false,
4302
+ "required": [
4303
+ "@type",
4304
+ "valueType"
4305
+ ]
4306
+ },
4307
+ "RelationshipAttributeQueryJSON": {
4308
+ "type": "object",
4309
+ "properties": {
4310
+ "@type": {
4311
+ "type": "string"
4312
+ },
4313
+ "@context": {
4314
+ "type": "string"
4315
+ },
4316
+ "@version": {
4317
+ "type": "string"
4318
+ },
4319
+ "valueType": {
4320
+ "type": "string"
4321
+ },
4322
+ "validFrom": {
4323
+ "type": "string"
4324
+ },
4325
+ "validTo": {
4326
+ "type": "string"
4327
+ },
4328
+ "key": {
4329
+ "type": "string"
4330
+ },
4331
+ "owner": {
4332
+ "type": "string"
4333
+ },
4334
+ "thirdParty": {
4335
+ "type": "string"
4336
+ },
4337
+ "attributeCreationHints": {
4338
+ "$ref": "#/definitions/RelationshipAttributeCreationHintsJSON"
4339
+ }
4340
+ },
4341
+ "required": [
4342
+ "@type",
4343
+ "attributeCreationHints",
4344
+ "key",
4345
+ "owner",
4346
+ "valueType"
4347
+ ],
4348
+ "additionalProperties": false
4349
+ },
4350
+ "RelationshipAttributeCreationHintsJSON": {
4351
+ "type": "object",
4352
+ "properties": {
4353
+ "title": {
4354
+ "type": "string"
4355
+ },
4356
+ "description": {
4357
+ "type": "string"
4358
+ },
4359
+ "valueHints": {
4360
+ "$ref": "#/definitions/ValueHintsJSON"
4361
+ },
4362
+ "isTechnical": {
4363
+ "type": "boolean"
4364
+ },
4365
+ "confidentiality": {
4366
+ "$ref": "#/definitions/RelationshipAttributeConfidentiality"
4367
+ }
4368
+ },
4369
+ "required": [
4370
+ "title",
4371
+ "confidentiality"
4372
+ ],
4373
+ "additionalProperties": false
4374
+ },
4375
+ "ValueHintsJSON": {
4376
+ "type": "object",
4377
+ "properties": {
4378
+ "@type": {
4379
+ "type": "string"
4380
+ },
4381
+ "@context": {
4382
+ "type": "string"
4383
+ },
4384
+ "@version": {
4385
+ "type": "string"
4386
+ },
4387
+ "editHelp": {
4388
+ "type": "string"
4389
+ },
4390
+ "min": {
4391
+ "type": "number"
4392
+ },
4393
+ "max": {
4394
+ "type": "number"
4395
+ },
4396
+ "pattern": {
4397
+ "type": "string"
4398
+ },
4399
+ "values": {
4400
+ "type": "array",
4401
+ "items": {
4402
+ "$ref": "#/definitions/ValueHintsValueJSON"
4403
+ }
4404
+ },
4405
+ "defaultValue": {
4406
+ "type": [
4407
+ "string",
4408
+ "number",
4409
+ "boolean"
4410
+ ]
4411
+ },
4412
+ "propertyHints": {
4413
+ "type": "object",
4414
+ "additionalProperties": {
4415
+ "$ref": "#/definitions/ValueHintsJSON"
4416
+ }
4417
+ }
4418
+ },
4419
+ "additionalProperties": false,
4420
+ "required": [
4421
+ "@type"
4422
+ ]
4423
+ },
4424
+ "ValueHintsValueJSON": {
4425
+ "type": "object",
4426
+ "properties": {
4427
+ "key": {
4428
+ "type": [
4429
+ "string",
4430
+ "number",
4431
+ "boolean"
4432
+ ]
4433
+ },
4434
+ "displayName": {
4435
+ "type": "string"
4436
+ }
4437
+ },
4438
+ "required": [
4439
+ "key",
4440
+ "displayName"
4441
+ ],
4442
+ "additionalProperties": false
4443
+ },
4444
+ "ReadAttributeRequestItemJSON": {
4445
+ "type": "object",
4446
+ "properties": {
4447
+ "@type": {
4448
+ "type": "string"
4449
+ },
4450
+ "@context": {
4451
+ "type": "string"
4452
+ },
4453
+ "@version": {
4454
+ "type": "string"
4455
+ },
4456
+ "title": {
4457
+ "type": "string",
4458
+ "description": "The human-readable title of this item."
4459
+ },
4460
+ "description": {
4461
+ "type": "string",
4462
+ "description": "The human-readable description of this item."
4463
+ },
4464
+ "metadata": {
4465
+ "type": "object",
4466
+ "description": "This property can 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."
4467
+ },
4468
+ "mustBeAccepted": {
4469
+ "type": "boolean",
4470
+ "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."
4471
+ },
4472
+ "requireManualDecision": {
4473
+ "type": "boolean",
4474
+ "description": "If set to `true`, it advices the recipient of this RequestItem to carefully consider their decision and especially do not decide based on some automation rules."
4475
+ },
4476
+ "query": {
4477
+ "$ref": "#/definitions/AbstractAttributeQueryJSON"
4478
+ }
4479
+ },
4480
+ "required": [
4481
+ "@type",
4482
+ "mustBeAccepted",
4483
+ "query"
4484
+ ],
4485
+ "additionalProperties": false
4486
+ },
4487
+ "AbstractAttributeQueryJSON": {
4488
+ "type": "object",
4489
+ "properties": {
4490
+ "@type": {
4491
+ "type": "string"
4492
+ },
4493
+ "@context": {
4494
+ "type": "string"
4495
+ },
4496
+ "@version": {
4497
+ "type": "string"
4498
+ },
4499
+ "valueType": {
4500
+ "type": "string"
4501
+ },
4502
+ "validFrom": {
4503
+ "type": "string"
4504
+ },
4505
+ "validTo": {
4506
+ "type": "string"
4507
+ }
4508
+ },
4509
+ "required": [
4510
+ "@type",
4511
+ "valueType"
4512
+ ],
4513
+ "additionalProperties": false
4514
+ },
4515
+ "ConsentRequestItemJSON": {
4516
+ "type": "object",
4517
+ "properties": {
4518
+ "@type": {
4519
+ "type": "string"
4520
+ },
4521
+ "@context": {
4522
+ "type": "string"
4523
+ },
4524
+ "@version": {
4525
+ "type": "string"
4526
+ },
4527
+ "title": {
4528
+ "type": "string",
4529
+ "description": "The human-readable title of this item."
4530
+ },
4531
+ "description": {
4532
+ "type": "string",
4533
+ "description": "The human-readable description of this item."
4534
+ },
4535
+ "metadata": {
4536
+ "type": "object",
4537
+ "description": "This property can 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."
4538
+ },
4539
+ "mustBeAccepted": {
4540
+ "type": "boolean",
4541
+ "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."
4542
+ },
4543
+ "requireManualDecision": {
4544
+ "type": "boolean",
4545
+ "description": "If set to `true`, it advices the recipient of this RequestItem to carefully consider their decision and especially do not decide based on some automation rules."
4546
+ },
4547
+ "consent": {
4548
+ "type": "string"
4549
+ },
4550
+ "link": {
4551
+ "type": "string"
4552
+ }
4553
+ },
4554
+ "required": [
4555
+ "@type",
4556
+ "consent",
4557
+ "mustBeAccepted"
4558
+ ],
4559
+ "additionalProperties": false
4560
+ },
4561
+ "AuthenticationRequestItemJSON": {
4562
+ "type": "object",
4563
+ "additionalProperties": false,
4564
+ "properties": {
4565
+ "@type": {
4566
+ "type": "string"
4567
+ },
4568
+ "@context": {
4569
+ "type": "string"
4570
+ },
4571
+ "@version": {
4572
+ "type": "string"
4573
+ },
4574
+ "title": {
4575
+ "type": "string",
4576
+ "description": "The human-readable title of this item."
4577
+ },
4578
+ "description": {
4579
+ "type": "string",
4580
+ "description": "The human-readable description of this item."
4581
+ },
4582
+ "metadata": {
4583
+ "type": "object",
4584
+ "description": "This property can 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."
4585
+ },
4586
+ "mustBeAccepted": {
4587
+ "type": "boolean",
4588
+ "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."
4589
+ },
4590
+ "requireManualDecision": {
4591
+ "type": "boolean",
4592
+ "description": "If set to `true`, it advices the recipient of this RequestItem to carefully consider their decision and especially do not decide based on some automation rules."
4593
+ }
4594
+ },
4595
+ "required": [
4596
+ "@type",
4597
+ "mustBeAccepted"
4598
+ ]
4599
+ },
4600
+ "IRequestItemGroup": {
4601
+ "type": "object",
4602
+ "properties": {
4603
+ "title": {
4604
+ "type": "string",
4605
+ "description": "The human-readable title of this group."
4606
+ },
4607
+ "description": {
4608
+ "type": "string",
4609
+ "description": "The human-readable description of this group."
4610
+ },
4611
+ "mustBeAccepted": {
4612
+ "type": "boolean",
4613
+ "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."
4614
+ },
4615
+ "metadata": {
4616
+ "type": "object",
4617
+ "description": "This property can 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."
4618
+ },
4619
+ "items": {
4620
+ "type": "array",
4621
+ "items": {
4622
+ "$ref": "#/definitions/IRequestItemDerivations"
4623
+ },
4624
+ "description": "The items of this group."
4625
+ }
4626
+ },
4627
+ "required": [
4628
+ "mustBeAccepted",
4629
+ "items"
4630
+ ],
4631
+ "additionalProperties": false,
4632
+ "description": "A RequestItemGroup can be used to group one or more 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 `CreateRelationshipAttributeRequestItem` **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"
4633
+ },
4634
+ "IRequestItemDerivations": {
4635
+ "anyOf": [
4636
+ {
4637
+ "$ref": "#/definitions/IRequestItem"
4638
+ },
4639
+ {
4640
+ "$ref": "#/definitions/ICreateRelationshipAttributeRequestItem"
4641
+ },
4642
+ {
4643
+ "$ref": "#/definitions/IShareAttributeRequestItem"
4644
+ },
4645
+ {
4646
+ "$ref": "#/definitions/IProposeAttributeRequestItem"
4647
+ },
4648
+ {
4649
+ "$ref": "#/definitions/IReadAttributeRequestItem"
4650
+ },
4651
+ {
4652
+ "$ref": "#/definitions/IConsentRequestItem"
4653
+ },
4654
+ {
4655
+ "$ref": "#/definitions/IAuthenticationRequestItem"
4656
+ }
4657
+ ]
4658
+ },
4659
+ "IRequestItem": {
4660
+ "type": "object",
4661
+ "properties": {
4662
+ "title": {
4663
+ "type": "string",
4664
+ "description": "The human-readable title of this item."
4665
+ },
4666
+ "description": {
4667
+ "type": "string",
4668
+ "description": "The human-readable description of this item."
4669
+ },
4670
+ "metadata": {
4671
+ "type": "object",
4672
+ "description": "This property can 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."
4673
+ },
4674
+ "mustBeAccepted": {
4675
+ "type": "boolean",
4676
+ "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."
4677
+ },
4678
+ "requireManualDecision": {
4679
+ "type": "boolean",
4680
+ "description": "If set to `true`, it advices the recipient of this RequestItem to carefully consider their decision and especially do not decide based on some automation rules."
4681
+ }
4682
+ },
4683
+ "required": [
4684
+ "mustBeAccepted"
4685
+ ],
4686
+ "additionalProperties": false
4687
+ },
4688
+ "ICreateRelationshipAttributeRequestItem": {
4689
+ "type": "object",
4690
+ "properties": {
4691
+ "title": {
4692
+ "type": "string",
4693
+ "description": "The human-readable title of this item."
4694
+ },
4695
+ "description": {
4696
+ "type": "string",
4697
+ "description": "The human-readable description of this item."
4698
+ },
4699
+ "metadata": {
4700
+ "type": "object",
4701
+ "description": "This property can 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."
4702
+ },
4703
+ "mustBeAccepted": {
4704
+ "type": "boolean",
4705
+ "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."
4706
+ },
4707
+ "requireManualDecision": {
4708
+ "type": "boolean",
4709
+ "description": "If set to `true`, it advices the recipient of this RequestItem to carefully consider their decision and especially do not decide based on some automation rules."
4710
+ },
4711
+ "attribute": {
4712
+ "$ref": "#/definitions/IRelationshipAttribute"
4713
+ }
4714
+ },
4715
+ "required": [
4716
+ "attribute",
4717
+ "mustBeAccepted"
4718
+ ],
4719
+ "additionalProperties": false
4720
+ },
4721
+ "IRelationshipAttribute": {
4722
+ "type": "object",
4723
+ "properties": {
4724
+ "owner": {
4725
+ "$ref": "#/definitions/ICoreAddress"
4726
+ },
4727
+ "validFrom": {
4728
+ "$ref": "#/definitions/ICoreDate"
4729
+ },
4730
+ "validTo": {
4731
+ "$ref": "#/definitions/ICoreDate"
4732
+ },
4733
+ "value": {
4734
+ "$ref": "#/definitions/IAbstractAttributeValue"
4735
+ },
4736
+ "key": {
4737
+ "type": "string"
4738
+ },
4739
+ "isTechnical": {
4740
+ "type": "boolean"
4741
+ },
4742
+ "confidentiality": {
4743
+ "$ref": "#/definitions/RelationshipAttributeConfidentiality"
4744
+ }
4745
+ },
4746
+ "required": [
4747
+ "confidentiality",
4748
+ "key",
4749
+ "owner",
4750
+ "value"
4751
+ ],
4752
+ "additionalProperties": false
4753
+ },
4754
+ "ICoreAddress": {
4755
+ "type": "object",
4756
+ "properties": {
4757
+ "address": {
4758
+ "type": "string"
4759
+ }
4760
+ },
4761
+ "required": [
4762
+ "address"
4763
+ ],
4764
+ "additionalProperties": false
4765
+ },
4766
+ "IAbstractAttributeValue": {
4767
+ "type": "object",
4768
+ "additionalProperties": false,
4769
+ "properties": {}
4770
+ },
4771
+ "IShareAttributeRequestItem": {
4772
+ "type": "object",
4773
+ "properties": {
4774
+ "title": {
4775
+ "type": "string",
4776
+ "description": "The human-readable title of this item."
4777
+ },
4778
+ "description": {
4779
+ "type": "string",
4780
+ "description": "The human-readable description of this item."
4781
+ },
4782
+ "metadata": {
4783
+ "type": "object",
4784
+ "description": "This property can 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."
4785
+ },
4786
+ "mustBeAccepted": {
4787
+ "type": "boolean",
4788
+ "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."
4789
+ },
4790
+ "requireManualDecision": {
4791
+ "type": "boolean",
4792
+ "description": "If set to `true`, it advices the recipient of this RequestItem to carefully consider their decision and especially do not decide based on some automation rules."
4793
+ },
4794
+ "attribute": {
4795
+ "anyOf": [
4796
+ {
4797
+ "$ref": "#/definitions/IIdentityAttribute"
4798
+ },
4799
+ {
4800
+ "$ref": "#/definitions/IRelationshipAttribute"
4801
+ }
4802
+ ]
4803
+ },
4804
+ "sourceAttributeId": {
4805
+ "$ref": "#/definitions/ICoreId"
4806
+ }
4807
+ },
4808
+ "required": [
4809
+ "attribute",
4810
+ "mustBeAccepted",
4811
+ "sourceAttributeId"
4812
+ ],
4813
+ "additionalProperties": false
4814
+ },
4815
+ "IIdentityAttribute": {
4816
+ "type": "object",
4817
+ "properties": {
4818
+ "owner": {
4819
+ "$ref": "#/definitions/ICoreAddress"
4820
+ },
4821
+ "validFrom": {
4822
+ "$ref": "#/definitions/ICoreDate"
4823
+ },
4824
+ "validTo": {
4825
+ "$ref": "#/definitions/ICoreDate"
4826
+ },
4827
+ "value": {
4828
+ "$ref": "#/definitions/IAbstractAttributeValue"
4829
+ },
4830
+ "tags": {
4831
+ "type": "array",
4832
+ "items": {
4833
+ "type": "string"
4834
+ }
4835
+ }
4836
+ },
4837
+ "required": [
4838
+ "owner",
4839
+ "value"
4840
+ ],
4841
+ "additionalProperties": false
4842
+ },
4843
+ "ICoreId": {
4844
+ "type": "object",
4845
+ "properties": {
4846
+ "id": {
4847
+ "type": "string"
4848
+ }
4849
+ },
4850
+ "required": [
4851
+ "id"
4852
+ ],
4853
+ "additionalProperties": false
4854
+ },
4855
+ "IProposeAttributeRequestItem": {
4856
+ "type": "object",
4857
+ "properties": {
4858
+ "title": {
4859
+ "type": "string",
4860
+ "description": "The human-readable title of this item."
4861
+ },
4862
+ "description": {
4863
+ "type": "string",
4864
+ "description": "The human-readable description of this item."
4865
+ },
4866
+ "metadata": {
4867
+ "type": "object",
4868
+ "description": "This property can 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."
4869
+ },
4870
+ "mustBeAccepted": {
4871
+ "type": "boolean",
4872
+ "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."
4873
+ },
4874
+ "requireManualDecision": {
4875
+ "type": "boolean",
4876
+ "description": "If set to `true`, it advices the recipient of this RequestItem to carefully consider their decision and especially do not decide based on some automation rules."
4877
+ },
4878
+ "query": {
4879
+ "anyOf": [
4880
+ {
4881
+ "$ref": "#/definitions/IIdentityAttributeQuery"
4882
+ },
4883
+ {
4884
+ "$ref": "#/definitions/IRelationshipAttributeQuery"
4885
+ }
4886
+ ]
4887
+ },
4888
+ "attribute": {
4889
+ "anyOf": [
4890
+ {
4891
+ "$ref": "#/definitions/IIdentityAttribute"
4892
+ },
4893
+ {
4894
+ "$ref": "#/definitions/IRelationshipAttribute"
4895
+ }
4896
+ ]
4897
+ }
4898
+ },
4899
+ "required": [
4900
+ "attribute",
4901
+ "mustBeAccepted",
4902
+ "query"
4903
+ ],
4904
+ "additionalProperties": false
4905
+ },
4906
+ "IIdentityAttributeQuery": {
4907
+ "type": "object",
4908
+ "properties": {
4909
+ "valueType": {
4910
+ "type": "string"
4911
+ },
4912
+ "validFrom": {
4913
+ "$ref": "#/definitions/ICoreDate"
4914
+ },
4915
+ "validTo": {
4916
+ "$ref": "#/definitions/ICoreDate"
4917
+ },
4918
+ "tags": {
4919
+ "type": "array",
4920
+ "items": {
4921
+ "type": "string"
4922
+ }
4923
+ }
4924
+ },
4925
+ "additionalProperties": false,
4926
+ "required": [
4927
+ "valueType"
4928
+ ]
4929
+ },
4930
+ "IRelationshipAttributeQuery": {
4931
+ "type": "object",
4932
+ "properties": {
4933
+ "valueType": {
4934
+ "type": "string"
4935
+ },
4936
+ "validFrom": {
4937
+ "$ref": "#/definitions/ICoreDate"
4938
+ },
4939
+ "validTo": {
4940
+ "$ref": "#/definitions/ICoreDate"
4941
+ },
4942
+ "key": {
4943
+ "type": "string"
4944
+ },
4945
+ "owner": {
4946
+ "$ref": "#/definitions/ICoreAddress"
4947
+ },
4948
+ "thirdParty": {
4949
+ "$ref": "#/definitions/ICoreAddress"
4950
+ },
4951
+ "attributeCreationHints": {
4952
+ "$ref": "#/definitions/IRelationshipAttributeCreationHints"
4953
+ }
4954
+ },
4955
+ "required": [
4956
+ "attributeCreationHints",
4957
+ "key",
4958
+ "owner",
4959
+ "valueType"
4960
+ ],
4961
+ "additionalProperties": false
4962
+ },
4963
+ "IRelationshipAttributeCreationHints": {
4964
+ "type": "object",
4965
+ "properties": {
4966
+ "title": {
4967
+ "type": "string"
4968
+ },
4969
+ "description": {
4970
+ "type": "string"
4971
+ },
4972
+ "valueHints": {
4973
+ "$ref": "#/definitions/IValueHints"
4974
+ },
4975
+ "isTechnical": {
4976
+ "type": "boolean"
4977
+ },
4978
+ "confidentiality": {
4979
+ "$ref": "#/definitions/RelationshipAttributeConfidentiality"
4980
+ }
4981
+ },
4982
+ "required": [
4983
+ "title",
4984
+ "confidentiality"
4985
+ ],
4986
+ "additionalProperties": false
4987
+ },
4988
+ "IValueHints": {
4989
+ "type": "object",
4990
+ "properties": {
4991
+ "editHelp": {
4992
+ "type": "string"
4993
+ },
4994
+ "min": {
4995
+ "type": "number"
4996
+ },
4997
+ "max": {
4998
+ "type": "number"
4999
+ },
5000
+ "pattern": {
5001
+ "type": "string"
5002
+ },
5003
+ "values": {
5004
+ "type": "array",
5005
+ "items": {
5006
+ "$ref": "#/definitions/IValueHintsValue"
5007
+ }
5008
+ },
5009
+ "defaultValue": {
5010
+ "type": [
5011
+ "string",
5012
+ "number",
5013
+ "boolean"
5014
+ ]
5015
+ },
5016
+ "propertyHints": {
5017
+ "type": "object",
5018
+ "additionalProperties": {
5019
+ "$ref": "#/definitions/IValueHints"
5020
+ }
5021
+ }
5022
+ },
5023
+ "additionalProperties": false
5024
+ },
5025
+ "IValueHintsValue": {
5026
+ "type": "object",
5027
+ "properties": {
5028
+ "key": {
5029
+ "type": [
5030
+ "string",
5031
+ "number",
5032
+ "boolean"
5033
+ ]
5034
+ },
5035
+ "displayName": {
5036
+ "type": "string"
5037
+ }
5038
+ },
5039
+ "required": [
5040
+ "key",
5041
+ "displayName"
5042
+ ],
5043
+ "additionalProperties": false
5044
+ },
5045
+ "IReadAttributeRequestItem": {
5046
+ "type": "object",
5047
+ "properties": {
5048
+ "title": {
5049
+ "type": "string",
5050
+ "description": "The human-readable title of this item."
5051
+ },
5052
+ "description": {
5053
+ "type": "string",
5054
+ "description": "The human-readable description of this item."
5055
+ },
5056
+ "metadata": {
5057
+ "type": "object",
5058
+ "description": "This property can 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."
5059
+ },
5060
+ "mustBeAccepted": {
5061
+ "type": "boolean",
5062
+ "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."
5063
+ },
5064
+ "requireManualDecision": {
5065
+ "type": "boolean",
5066
+ "description": "If set to `true`, it advices the recipient of this RequestItem to carefully consider their decision and especially do not decide based on some automation rules."
5067
+ },
5068
+ "query": {
5069
+ "$ref": "#/definitions/IAbstractAttributeQuery"
5070
+ }
5071
+ },
5072
+ "required": [
5073
+ "mustBeAccepted",
5074
+ "query"
5075
+ ],
5076
+ "additionalProperties": false
5077
+ },
5078
+ "IAbstractAttributeQuery": {
5079
+ "type": "object",
5080
+ "properties": {
5081
+ "valueType": {
5082
+ "type": "string"
5083
+ },
5084
+ "validFrom": {
5085
+ "$ref": "#/definitions/ICoreDate"
5086
+ },
5087
+ "validTo": {
5088
+ "$ref": "#/definitions/ICoreDate"
5089
+ }
5090
+ },
5091
+ "required": [
5092
+ "valueType"
5093
+ ],
5094
+ "additionalProperties": false
5095
+ },
5096
+ "IConsentRequestItem": {
5097
+ "type": "object",
5098
+ "properties": {
5099
+ "title": {
5100
+ "type": "string",
5101
+ "description": "The human-readable title of this item."
5102
+ },
5103
+ "description": {
5104
+ "type": "string",
5105
+ "description": "The human-readable description of this item."
5106
+ },
5107
+ "metadata": {
5108
+ "type": "object",
5109
+ "description": "This property can 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."
5110
+ },
5111
+ "mustBeAccepted": {
5112
+ "type": "boolean",
5113
+ "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."
5114
+ },
5115
+ "requireManualDecision": {
5116
+ "type": "boolean",
5117
+ "description": "If set to `true`, it advices the recipient of this RequestItem to carefully consider their decision and especially do not decide based on some automation rules."
5118
+ },
5119
+ "consent": {
5120
+ "type": "string"
5121
+ },
5122
+ "link": {
5123
+ "type": "string"
5124
+ }
5125
+ },
5126
+ "required": [
5127
+ "consent",
5128
+ "mustBeAccepted"
5129
+ ],
5130
+ "additionalProperties": false
5131
+ },
5132
+ "IAuthenticationRequestItem": {
5133
+ "type": "object",
5134
+ "additionalProperties": false,
5135
+ "properties": {
5136
+ "title": {
5137
+ "type": "string",
5138
+ "description": "The human-readable title of this item."
5139
+ },
5140
+ "description": {
5141
+ "type": "string",
5142
+ "description": "The human-readable description of this item."
5143
+ },
5144
+ "metadata": {
5145
+ "type": "object",
5146
+ "description": "This property can 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."
5147
+ },
5148
+ "mustBeAccepted": {
5149
+ "type": "boolean",
5150
+ "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."
5151
+ },
5152
+ "requireManualDecision": {
5153
+ "type": "boolean",
5154
+ "description": "If set to `true`, it advices the recipient of this RequestItem to carefully consider their decision and especially do not decide based on some automation rules."
5155
+ }
5156
+ },
5157
+ "required": [
5158
+ "mustBeAccepted"
5159
+ ]
5160
+ },
5161
+ "AddressString": {
5162
+ "type": "string",
5163
+ "pattern": "id1[A-Za-z0-9]{32,33}"
5164
+ }
5165
+ }
5166
+ };
3791
5167
  exports.GetIncomingRequestRequest = {
3792
5168
  "$schema": "http://json-schema.org/draft-07/schema#",
3793
5169
  "$ref": "#/definitions/GetIncomingRequestRequest",