@nmshd/runtime 2.0.0-beta.2 → 2.0.0-beta.20

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 (360) hide show
  1. package/dist/Runtime.d.ts +6 -5
  2. package/dist/Runtime.js +20 -8
  3. package/dist/Runtime.js.map +1 -1
  4. package/dist/buildInformation.js +5 -5
  5. package/dist/dataViews/DataViewExpander.d.ts +12 -6
  6. package/dist/dataViews/DataViewExpander.js +186 -58
  7. package/dist/dataViews/DataViewExpander.js.map +1 -1
  8. package/dist/dataViews/consumption/DecidableRequestItemDVOs.d.ts +5 -7
  9. package/dist/dataViews/consumption/LocalAttributeDVO.d.ts +4 -3
  10. package/dist/dataViews/consumption/LocalRequestDVO.d.ts +2 -3
  11. package/dist/dataViews/consumption/RelationshipSettingDVO.d.ts +5 -0
  12. package/dist/{types/consumption/RelationshipAttributeDTO.js → dataViews/consumption/RelationshipSettingDVO.js} +1 -1
  13. package/dist/dataViews/consumption/RelationshipSettingDVO.js.map +1 -0
  14. package/dist/dataViews/consumption/index.d.ts +1 -0
  15. package/dist/dataViews/consumption/index.js +1 -0
  16. package/dist/dataViews/consumption/index.js.map +1 -1
  17. package/dist/dataViews/content/AttributeDVOs.d.ts +1 -0
  18. package/dist/dataViews/content/RequestItemDVOs.d.ts +4 -7
  19. package/dist/dataViews/content/ResponseDVO.d.ts +8 -0
  20. package/dist/{types/consumption/SharedItemDTO.js → dataViews/content/ResponseDVO.js} +1 -1
  21. package/dist/dataViews/content/ResponseDVO.js.map +1 -0
  22. package/dist/dataViews/content/ResponseItemDVOs.d.ts +41 -0
  23. package/dist/{types/consumption/RelationshipInfoDTO.js → dataViews/content/ResponseItemDVOs.js} +1 -1
  24. package/dist/dataViews/content/ResponseItemDVOs.js.map +1 -0
  25. package/dist/dataViews/content/index.d.ts +2 -0
  26. package/dist/dataViews/content/index.js +2 -0
  27. package/dist/dataViews/content/index.js.map +1 -1
  28. package/dist/dataViews/transport/RelationshipDVO.d.ts +5 -1
  29. package/dist/dataViews/transport/RelationshipDVO.js.map +1 -1
  30. package/dist/events/EventProxy.d.ts +12 -0
  31. package/dist/events/EventProxy.js +112 -0
  32. package/dist/events/EventProxy.js.map +1 -0
  33. package/dist/events/consumption/MessageProcessedEvent.d.ts +15 -0
  34. package/dist/events/consumption/MessageProcessedEvent.js +18 -0
  35. package/dist/events/consumption/MessageProcessedEvent.js.map +1 -0
  36. package/dist/events/consumption/RelationshipTemplateProcessedEvent.d.ts +17 -0
  37. package/dist/events/consumption/RelationshipTemplateProcessedEvent.js +22 -0
  38. package/dist/events/consumption/RelationshipTemplateProcessedEvent.js.map +1 -0
  39. package/dist/events/consumption/index.d.ts +14 -0
  40. package/dist/events/consumption/index.js +31 -0
  41. package/dist/events/consumption/index.js.map +1 -0
  42. package/dist/events/index.d.ts +3 -23
  43. package/dist/events/index.js +3 -23
  44. package/dist/events/index.js.map +1 -1
  45. package/dist/events/runtime/index.d.ts +5 -0
  46. package/dist/events/runtime/index.js +22 -0
  47. package/dist/events/runtime/index.js.map +1 -0
  48. package/dist/events/transport/MessageDeliveredEvent.d.ts +6 -0
  49. package/dist/events/transport/MessageDeliveredEvent.js +13 -0
  50. package/dist/events/transport/MessageDeliveredEvent.js.map +1 -0
  51. package/dist/events/transport/index.d.ts +5 -0
  52. package/dist/events/transport/index.js +22 -0
  53. package/dist/events/transport/index.js.map +1 -0
  54. package/dist/extensibility/facades/consumption/OutgoingRequestsFacade.d.ts +2 -2
  55. package/dist/extensibility/facades/consumption/OutgoingRequestsFacade.js.map +1 -1
  56. package/dist/extensibility/facades/transport/AccountFacade.d.ts +4 -2
  57. package/dist/extensibility/facades/transport/AccountFacade.js +8 -2
  58. package/dist/extensibility/facades/transport/AccountFacade.js.map +1 -1
  59. package/dist/extensibility/facades/transport/FilesFacade.d.ts +4 -4
  60. package/dist/extensibility/facades/transport/FilesFacade.js +5 -5
  61. package/dist/extensibility/facades/transport/FilesFacade.js.map +1 -1
  62. package/dist/modules/DeciderModule.d.ts +5 -3
  63. package/dist/modules/DeciderModule.js +29 -3
  64. package/dist/modules/DeciderModule.js.map +1 -1
  65. package/dist/modules/MessageModule.js +1 -1
  66. package/dist/modules/MessageModule.js.map +1 -1
  67. package/dist/modules/RequestModule.d.ts +3 -3
  68. package/dist/modules/RequestModule.js +65 -27
  69. package/dist/modules/RequestModule.js.map +1 -1
  70. package/dist/types/consumption/SettingDTO.d.ts +0 -1
  71. package/dist/types/consumption/index.d.ts +0 -4
  72. package/dist/types/consumption/index.js +0 -4
  73. package/dist/types/consumption/index.js.map +1 -1
  74. package/dist/useCases/anonymous/tokens/LoadPeerTokenAnonymousByIdAndKey.d.ts +5 -5
  75. package/dist/useCases/anonymous/tokens/LoadPeerTokenAnonymousByIdAndKey.js +9 -7
  76. package/dist/useCases/anonymous/tokens/LoadPeerTokenAnonymousByIdAndKey.js.map +1 -1
  77. package/dist/useCases/anonymous/tokens/LoadPeerTokenAnonymousByTruncatedReference.d.ts +5 -5
  78. package/dist/useCases/anonymous/tokens/LoadPeerTokenAnonymousByTruncatedReference.js +9 -6
  79. package/dist/useCases/anonymous/tokens/LoadPeerTokenAnonymousByTruncatedReference.js.map +1 -1
  80. package/dist/useCases/common/RuntimeErrors.d.ts +1 -1
  81. package/dist/useCases/common/RuntimeErrors.js +2 -2
  82. package/dist/useCases/common/RuntimeErrors.js.map +1 -1
  83. package/dist/useCases/common/Schemas.d.ts +10 -5
  84. package/dist/useCases/common/Schemas.js +2594 -323
  85. package/dist/useCases/common/Schemas.js.map +1 -1
  86. package/dist/useCases/common/UseCase.js +1 -4
  87. package/dist/useCases/common/UseCase.js.map +1 -1
  88. package/dist/useCases/common/index.d.ts +3 -4
  89. package/dist/useCases/common/index.js +3 -4
  90. package/dist/useCases/common/index.js.map +1 -1
  91. package/dist/useCases/common/validation/IValidator.d.ts +1 -1
  92. package/dist/useCases/common/validation/SchemaValidator.d.ts +2 -2
  93. package/dist/useCases/common/validation/SchemaValidator.js +5 -3
  94. package/dist/useCases/common/validation/SchemaValidator.js.map +1 -1
  95. package/dist/useCases/common/validation/ValidatableStrings.d.ts +68 -0
  96. package/dist/{types/consumption/RelationshipThemeDTO.js → useCases/common/validation/ValidatableStrings.js} +1 -1
  97. package/dist/useCases/common/validation/ValidatableStrings.js.map +1 -0
  98. package/dist/useCases/common/validation/ValidationFailure.d.ts +6 -0
  99. package/dist/useCases/common/validation/ValidationFailure.js +11 -0
  100. package/dist/useCases/common/validation/ValidationFailure.js.map +1 -0
  101. package/dist/useCases/common/validation/ValidationResult.d.ts +11 -0
  102. package/dist/useCases/common/validation/ValidationResult.js +31 -0
  103. package/dist/useCases/common/validation/ValidationResult.js.map +1 -0
  104. package/dist/useCases/consumption/attributes/CreateAttribute.d.ts +3 -5
  105. package/dist/useCases/consumption/attributes/CreateAttribute.js +2 -11
  106. package/dist/useCases/consumption/attributes/CreateAttribute.js.map +1 -1
  107. package/dist/useCases/consumption/attributes/CreateSharedAttributeCopy.d.ts +7 -18
  108. package/dist/useCases/consumption/attributes/CreateSharedAttributeCopy.js +2 -11
  109. package/dist/useCases/consumption/attributes/CreateSharedAttributeCopy.js.map +1 -1
  110. package/dist/useCases/consumption/attributes/DeleteAttribute.d.ts +5 -10
  111. package/dist/useCases/consumption/attributes/DeleteAttribute.js +1 -10
  112. package/dist/useCases/consumption/attributes/DeleteAttribute.js.map +1 -1
  113. package/dist/useCases/consumption/attributes/GetAttribute.d.ts +2 -5
  114. package/dist/useCases/consumption/attributes/GetAttribute.js.map +1 -1
  115. package/dist/useCases/consumption/attributes/SucceedAttribute.d.ts +5 -10
  116. package/dist/useCases/consumption/attributes/SucceedAttribute.js +2 -11
  117. package/dist/useCases/consumption/attributes/SucceedAttribute.js.map +1 -1
  118. package/dist/useCases/consumption/attributes/UpdateAttribute.d.ts +5 -10
  119. package/dist/useCases/consumption/attributes/UpdateAttribute.js +2 -11
  120. package/dist/useCases/consumption/attributes/UpdateAttribute.js.map +1 -1
  121. package/dist/useCases/consumption/drafts/CreateDraft.d.ts +4 -4
  122. package/dist/useCases/consumption/drafts/CreateDraft.js +9 -7
  123. package/dist/useCases/consumption/drafts/CreateDraft.js.map +1 -1
  124. package/dist/useCases/consumption/drafts/DeleteDraft.d.ts +5 -5
  125. package/dist/useCases/consumption/drafts/DeleteDraft.js +9 -8
  126. package/dist/useCases/consumption/drafts/DeleteDraft.js.map +1 -1
  127. package/dist/useCases/consumption/drafts/GetDraft.d.ts +5 -5
  128. package/dist/useCases/consumption/drafts/GetDraft.js +9 -5
  129. package/dist/useCases/consumption/drafts/GetDraft.js.map +1 -1
  130. package/dist/useCases/consumption/drafts/GetDrafts.d.ts +6 -2
  131. package/dist/useCases/consumption/drafts/GetDrafts.js +10 -1
  132. package/dist/useCases/consumption/drafts/GetDrafts.js.map +1 -1
  133. package/dist/useCases/consumption/drafts/UpdateDraft.d.ts +5 -5
  134. package/dist/useCases/consumption/drafts/UpdateDraft.js +9 -7
  135. package/dist/useCases/consumption/drafts/UpdateDraft.js.map +1 -1
  136. package/dist/useCases/consumption/requests/AcceptIncomingRequest.d.ts +2 -3
  137. package/dist/useCases/consumption/requests/AcceptIncomingRequest.js +3 -13
  138. package/dist/useCases/consumption/requests/AcceptIncomingRequest.js.map +1 -1
  139. package/dist/useCases/consumption/requests/CanCreateOutgoingRequest.d.ts +13 -5
  140. package/dist/useCases/consumption/requests/CanCreateOutgoingRequest.js +14 -4
  141. package/dist/useCases/consumption/requests/CanCreateOutgoingRequest.js.map +1 -1
  142. package/dist/useCases/consumption/requests/CheckPrerequisitesOfIncomingRequest.d.ts +4 -8
  143. package/dist/useCases/consumption/requests/CheckPrerequisitesOfIncomingRequest.js +3 -14
  144. package/dist/useCases/consumption/requests/CheckPrerequisitesOfIncomingRequest.js.map +1 -1
  145. package/dist/useCases/consumption/requests/CompleteIncomingRequest.d.ts +6 -12
  146. package/dist/useCases/consumption/requests/CompleteIncomingRequest.js +16 -30
  147. package/dist/useCases/consumption/requests/CompleteIncomingRequest.js.map +1 -1
  148. package/dist/useCases/consumption/requests/CompleteOutgoingRequest.d.ts +4 -8
  149. package/dist/useCases/consumption/requests/CompleteOutgoingRequest.js +3 -13
  150. package/dist/useCases/consumption/requests/CompleteOutgoingRequest.js.map +1 -1
  151. package/dist/useCases/consumption/requests/CreateAndCompleteOutgoingRequestFromRelationshipCreationChange.d.ts +5 -12
  152. package/dist/useCases/consumption/requests/CreateAndCompleteOutgoingRequestFromRelationshipCreationChange.js +3 -9
  153. package/dist/useCases/consumption/requests/CreateAndCompleteOutgoingRequestFromRelationshipCreationChange.js.map +1 -1
  154. package/dist/useCases/consumption/requests/CreateOutgoingRequest.d.ts +4 -8
  155. package/dist/useCases/consumption/requests/CreateOutgoingRequest.js +3 -8
  156. package/dist/useCases/consumption/requests/CreateOutgoingRequest.js.map +1 -1
  157. package/dist/useCases/consumption/requests/GetIncomingRequest.d.ts +2 -5
  158. package/dist/useCases/consumption/requests/GetIncomingRequest.js.map +1 -1
  159. package/dist/useCases/consumption/requests/GetOutgoingRequest.d.ts +2 -5
  160. package/dist/useCases/consumption/requests/GetOutgoingRequest.js.map +1 -1
  161. package/dist/useCases/consumption/requests/ReceivedIncomingRequest.d.ts +4 -9
  162. package/dist/useCases/consumption/requests/ReceivedIncomingRequest.js +3 -9
  163. package/dist/useCases/consumption/requests/ReceivedIncomingRequest.js.map +1 -1
  164. package/dist/useCases/consumption/requests/RejectIncomingRequest.d.ts +2 -3
  165. package/dist/useCases/consumption/requests/RejectIncomingRequest.js +3 -13
  166. package/dist/useCases/consumption/requests/RejectIncomingRequest.js.map +1 -1
  167. package/dist/useCases/consumption/requests/RequestMapper.js.map +1 -1
  168. package/dist/useCases/consumption/requests/RequireManualDecisionOfIncomingRequest.d.ts +4 -8
  169. package/dist/useCases/consumption/requests/RequireManualDecisionOfIncomingRequest.js +3 -12
  170. package/dist/useCases/consumption/requests/RequireManualDecisionOfIncomingRequest.js.map +1 -1
  171. package/dist/useCases/consumption/requests/SentOutgoingRequest.d.ts +5 -12
  172. package/dist/useCases/consumption/requests/SentOutgoingRequest.js +3 -14
  173. package/dist/useCases/consumption/requests/SentOutgoingRequest.js.map +1 -1
  174. package/dist/useCases/consumption/settings/CreateSetting.d.ts +8 -8
  175. package/dist/useCases/consumption/settings/CreateSetting.js +9 -13
  176. package/dist/useCases/consumption/settings/CreateSetting.js.map +1 -1
  177. package/dist/useCases/consumption/settings/DeleteSetting.d.ts +5 -5
  178. package/dist/useCases/consumption/settings/DeleteSetting.js +9 -6
  179. package/dist/useCases/consumption/settings/DeleteSetting.js.map +1 -1
  180. package/dist/useCases/consumption/settings/GetSetting.d.ts +5 -5
  181. package/dist/useCases/consumption/settings/GetSetting.js +9 -6
  182. package/dist/useCases/consumption/settings/GetSetting.js.map +1 -1
  183. package/dist/useCases/consumption/settings/GetSettings.d.ts +6 -2
  184. package/dist/useCases/consumption/settings/GetSettings.js +10 -1
  185. package/dist/useCases/consumption/settings/GetSettings.js.map +1 -1
  186. package/dist/useCases/consumption/settings/SettingMapper.js +0 -1
  187. package/dist/useCases/consumption/settings/SettingMapper.js.map +1 -1
  188. package/dist/useCases/consumption/settings/UpdateSetting.d.ts +5 -5
  189. package/dist/useCases/consumption/settings/UpdateSetting.js +9 -7
  190. package/dist/useCases/consumption/settings/UpdateSetting.js.map +1 -1
  191. package/dist/useCases/transport/account/LoadItemFromTruncatedReference.d.ts +34 -0
  192. package/dist/useCases/transport/account/LoadItemFromTruncatedReference.js +112 -0
  193. package/dist/useCases/transport/account/LoadItemFromTruncatedReference.js.map +1 -0
  194. package/dist/useCases/transport/account/RegisterPushNotificationToken.d.ts +3 -3
  195. package/dist/useCases/transport/account/RegisterPushNotificationToken.js +8 -13
  196. package/dist/useCases/transport/account/RegisterPushNotificationToken.js.map +1 -1
  197. package/dist/useCases/transport/account/SyncEverything.d.ts +3 -7
  198. package/dist/useCases/transport/account/SyncEverything.js +2 -33
  199. package/dist/useCases/transport/account/SyncEverything.js.map +1 -1
  200. package/dist/useCases/transport/account/index.d.ts +1 -0
  201. package/dist/useCases/transport/account/index.js +1 -0
  202. package/dist/useCases/transport/account/index.js.map +1 -1
  203. package/dist/useCases/transport/challenges/CreateChallenge.d.ts +2 -6
  204. package/dist/useCases/transport/challenges/CreateChallenge.js +3 -4
  205. package/dist/useCases/transport/challenges/CreateChallenge.js.map +1 -1
  206. package/dist/useCases/transport/challenges/ValidateChallenge.d.ts +2 -3
  207. package/dist/useCases/transport/challenges/ValidateChallenge.js +5 -5
  208. package/dist/useCases/transport/challenges/ValidateChallenge.js.map +1 -1
  209. package/dist/useCases/transport/devices/CreateDevice.d.ts +4 -4
  210. package/dist/useCases/transport/devices/CreateDevice.js +9 -8
  211. package/dist/useCases/transport/devices/CreateDevice.js.map +1 -1
  212. package/dist/useCases/transport/devices/CreateDeviceOnboardingToken.d.ts +6 -6
  213. package/dist/useCases/transport/devices/CreateDeviceOnboardingToken.js +9 -14
  214. package/dist/useCases/transport/devices/CreateDeviceOnboardingToken.js.map +1 -1
  215. package/dist/useCases/transport/devices/DeleteDevice.d.ts +5 -5
  216. package/dist/useCases/transport/devices/DeleteDevice.js +9 -8
  217. package/dist/useCases/transport/devices/DeleteDevice.js.map +1 -1
  218. package/dist/useCases/transport/devices/GetDevice.d.ts +5 -5
  219. package/dist/useCases/transport/devices/GetDevice.js +9 -6
  220. package/dist/useCases/transport/devices/GetDevice.js.map +1 -1
  221. package/dist/useCases/transport/devices/GetDeviceOnboardingInfo.d.ts +7 -3
  222. package/dist/useCases/transport/devices/GetDeviceOnboardingInfo.js +10 -1
  223. package/dist/useCases/transport/devices/GetDeviceOnboardingInfo.js.map +1 -1
  224. package/dist/useCases/transport/devices/UpdateDevice.d.ts +5 -5
  225. package/dist/useCases/transport/devices/UpdateDevice.js +9 -8
  226. package/dist/useCases/transport/devices/UpdateDevice.js.map +1 -1
  227. package/dist/useCases/transport/files/CreateQrCodeForFile.d.ts +2 -5
  228. package/dist/useCases/transport/files/CreateQrCodeForFile.js.map +1 -1
  229. package/dist/useCases/transport/files/CreateTokenForFile.d.ts +3 -9
  230. package/dist/useCases/transport/files/CreateTokenForFile.js.map +1 -1
  231. package/dist/useCases/transport/files/CreateTokenQrCodeForFile.d.ts +3 -9
  232. package/dist/useCases/transport/files/CreateTokenQrCodeForFile.js.map +1 -1
  233. package/dist/useCases/transport/files/DownloadFile.d.ts +2 -5
  234. package/dist/useCases/transport/files/DownloadFile.js.map +1 -1
  235. package/dist/useCases/transport/files/GetFile.d.ts +2 -5
  236. package/dist/useCases/transport/files/GetFile.js.map +1 -1
  237. package/dist/useCases/transport/files/GetFiles.d.ts +6 -2
  238. package/dist/useCases/transport/files/GetFiles.js +10 -1
  239. package/dist/useCases/transport/files/GetFiles.js.map +1 -1
  240. package/dist/useCases/transport/files/{LoadPeerFile.d.ts → GetOrLoadFile.d.ts} +10 -17
  241. package/dist/useCases/transport/files/{LoadPeerFile.js → GetOrLoadFile.js} +21 -22
  242. package/dist/useCases/transport/files/GetOrLoadFile.js.map +1 -0
  243. package/dist/useCases/transport/files/UploadOwnFile.d.ts +9 -5
  244. package/dist/useCases/transport/files/UploadOwnFile.js +25 -23
  245. package/dist/useCases/transport/files/UploadOwnFile.js.map +1 -1
  246. package/dist/useCases/transport/files/index.d.ts +1 -1
  247. package/dist/useCases/transport/files/index.js +1 -1
  248. package/dist/useCases/transport/files/index.js.map +1 -1
  249. package/dist/useCases/transport/identity/CheckIdentity.d.ts +5 -5
  250. package/dist/useCases/transport/identity/CheckIdentity.js +9 -6
  251. package/dist/useCases/transport/identity/CheckIdentity.js.map +1 -1
  252. package/dist/useCases/transport/messages/DownloadAttachment.d.ts +6 -6
  253. package/dist/useCases/transport/messages/DownloadAttachment.js +9 -9
  254. package/dist/useCases/transport/messages/DownloadAttachment.js.map +1 -1
  255. package/dist/useCases/transport/messages/GetAttachmentMetadata.d.ts +6 -6
  256. package/dist/useCases/transport/messages/GetAttachmentMetadata.js +9 -9
  257. package/dist/useCases/transport/messages/GetAttachmentMetadata.js.map +1 -1
  258. package/dist/useCases/transport/messages/GetMessage.d.ts +5 -5
  259. package/dist/useCases/transport/messages/GetMessage.js +9 -8
  260. package/dist/useCases/transport/messages/GetMessage.js.map +1 -1
  261. package/dist/useCases/transport/messages/GetMessages.d.ts +4 -4
  262. package/dist/useCases/transport/messages/GetMessages.js +9 -5
  263. package/dist/useCases/transport/messages/GetMessages.js.map +1 -1
  264. package/dist/useCases/transport/messages/SendMessage.d.ts +11 -10
  265. package/dist/useCases/transport/messages/SendMessage.js +10 -19
  266. package/dist/useCases/transport/messages/SendMessage.js.map +1 -1
  267. package/dist/useCases/transport/relationshipTemplates/CreateOwnRelationshipTemplate.d.ts +10 -5
  268. package/dist/useCases/transport/relationshipTemplates/CreateOwnRelationshipTemplate.js +19 -16
  269. package/dist/useCases/transport/relationshipTemplates/CreateOwnRelationshipTemplate.js.map +1 -1
  270. package/dist/useCases/transport/relationshipTemplates/CreateQrCodeForOwnRelationshipTemplate.d.ts +5 -5
  271. package/dist/useCases/transport/relationshipTemplates/CreateQrCodeForOwnRelationshipTemplate.js +9 -6
  272. package/dist/useCases/transport/relationshipTemplates/CreateQrCodeForOwnRelationshipTemplate.js.map +1 -1
  273. package/dist/useCases/transport/relationshipTemplates/CreateTokenForOwnRelationshipTemplate.d.ts +6 -6
  274. package/dist/useCases/transport/relationshipTemplates/CreateTokenForOwnRelationshipTemplate.js +9 -7
  275. package/dist/useCases/transport/relationshipTemplates/CreateTokenForOwnRelationshipTemplate.js.map +1 -1
  276. package/dist/useCases/transport/relationshipTemplates/CreateTokenQrCodeForOwnRelationshipTemplate.d.ts +6 -6
  277. package/dist/useCases/transport/relationshipTemplates/CreateTokenQrCodeForOwnRelationshipTemplate.js +9 -7
  278. package/dist/useCases/transport/relationshipTemplates/CreateTokenQrCodeForOwnRelationshipTemplate.js.map +1 -1
  279. package/dist/useCases/transport/relationshipTemplates/GetRelationshipTemplate.d.ts +5 -5
  280. package/dist/useCases/transport/relationshipTemplates/GetRelationshipTemplate.js +9 -6
  281. package/dist/useCases/transport/relationshipTemplates/GetRelationshipTemplate.js.map +1 -1
  282. package/dist/useCases/transport/relationshipTemplates/GetRelationshipTemplates.d.ts +6 -2
  283. package/dist/useCases/transport/relationshipTemplates/GetRelationshipTemplates.js +10 -1
  284. package/dist/useCases/transport/relationshipTemplates/GetRelationshipTemplates.js.map +1 -1
  285. package/dist/useCases/transport/relationshipTemplates/LoadPeerRelationshipTemplate.d.ts +5 -13
  286. package/dist/useCases/transport/relationshipTemplates/LoadPeerRelationshipTemplate.js +4 -13
  287. package/dist/useCases/transport/relationshipTemplates/LoadPeerRelationshipTemplate.js.map +1 -1
  288. package/dist/useCases/transport/relationships/AcceptRelationshipChange.d.ts +8 -10
  289. package/dist/useCases/transport/relationships/AcceptRelationshipChange.js +11 -19
  290. package/dist/useCases/transport/relationships/AcceptRelationshipChange.js.map +1 -1
  291. package/dist/useCases/transport/relationships/CreateRelationship.d.ts +7 -9
  292. package/dist/useCases/transport/relationships/CreateRelationship.js +11 -18
  293. package/dist/useCases/transport/relationships/CreateRelationship.js.map +1 -1
  294. package/dist/useCases/transport/relationships/CreateRelationshipChange.d.ts +5 -5
  295. package/dist/useCases/transport/relationships/CreateRelationshipChange.js +9 -7
  296. package/dist/useCases/transport/relationships/CreateRelationshipChange.js.map +1 -1
  297. package/dist/useCases/transport/relationships/GetAttributesForRelationship.d.ts +2 -2
  298. package/dist/useCases/transport/relationships/GetAttributesForRelationship.js.map +1 -1
  299. package/dist/useCases/transport/relationships/GetRelationship.d.ts +5 -5
  300. package/dist/useCases/transport/relationships/GetRelationship.js +9 -6
  301. package/dist/useCases/transport/relationships/GetRelationship.js.map +1 -1
  302. package/dist/useCases/transport/relationships/GetRelationshipByAddress.d.ts +5 -5
  303. package/dist/useCases/transport/relationships/GetRelationshipByAddress.js +9 -6
  304. package/dist/useCases/transport/relationships/GetRelationshipByAddress.js.map +1 -1
  305. package/dist/useCases/transport/relationships/GetRelationships.d.ts +6 -2
  306. package/dist/useCases/transport/relationships/GetRelationships.js +10 -1
  307. package/dist/useCases/transport/relationships/GetRelationships.js.map +1 -1
  308. package/dist/useCases/transport/relationships/RejectRelationshipChange.d.ts +8 -10
  309. package/dist/useCases/transport/relationships/RejectRelationshipChange.js +11 -19
  310. package/dist/useCases/transport/relationships/RejectRelationshipChange.js.map +1 -1
  311. package/dist/useCases/transport/relationships/RevokeRelationshipChange.d.ts +8 -10
  312. package/dist/useCases/transport/relationships/RevokeRelationshipChange.js +11 -19
  313. package/dist/useCases/transport/relationships/RevokeRelationshipChange.js.map +1 -1
  314. package/dist/useCases/transport/tokens/CreateOwnToken.d.ts +6 -5
  315. package/dist/useCases/transport/tokens/CreateOwnToken.js +19 -14
  316. package/dist/useCases/transport/tokens/CreateOwnToken.js.map +1 -1
  317. package/dist/useCases/transport/tokens/GetQRCodeForToken.d.ts +5 -5
  318. package/dist/useCases/transport/tokens/GetQRCodeForToken.js +9 -6
  319. package/dist/useCases/transport/tokens/GetQRCodeForToken.js.map +1 -1
  320. package/dist/useCases/transport/tokens/GetToken.d.ts +5 -5
  321. package/dist/useCases/transport/tokens/GetToken.js +9 -6
  322. package/dist/useCases/transport/tokens/GetToken.js.map +1 -1
  323. package/dist/useCases/transport/tokens/GetTokens.d.ts +6 -2
  324. package/dist/useCases/transport/tokens/GetTokens.js +10 -1
  325. package/dist/useCases/transport/tokens/GetTokens.js.map +1 -1
  326. package/dist/useCases/transport/tokens/LoadPeerToken.d.ts +21 -10
  327. package/dist/useCases/transport/tokens/LoadPeerToken.js +36 -35
  328. package/dist/useCases/transport/tokens/LoadPeerToken.js.map +1 -1
  329. package/lib-web/nmshd.runtime.js +19716 -27572
  330. package/lib-web/nmshd.runtime.js.map +1 -1
  331. package/lib-web/nmshd.runtime.min.js +7 -7
  332. package/lib-web/nmshd.runtime.min.js.map +1 -1
  333. package/package.json +14 -15
  334. package/dist/events/transport/TransportLibraryInitializedEvent.d.ts +0 -5
  335. package/dist/events/transport/TransportLibraryInitializedEvent.js +0 -12
  336. package/dist/events/transport/TransportLibraryInitializedEvent.js.map +0 -1
  337. package/dist/events/transport/TransportLibraryInitializingEvent.d.ts +0 -5
  338. package/dist/events/transport/TransportLibraryInitializingEvent.js +0 -12
  339. package/dist/events/transport/TransportLibraryInitializingEvent.js.map +0 -1
  340. package/dist/types/consumption/RelationshipAttributeDTO.d.ts +0 -6
  341. package/dist/types/consumption/RelationshipAttributeDTO.js.map +0 -1
  342. package/dist/types/consumption/RelationshipInfoDTO.d.ts +0 -13
  343. package/dist/types/consumption/RelationshipInfoDTO.js.map +0 -1
  344. package/dist/types/consumption/RelationshipThemeDTO.d.ts +0 -6
  345. package/dist/types/consumption/RelationshipThemeDTO.js.map +0 -1
  346. package/dist/types/consumption/SharedItemDTO.d.ts +0 -12
  347. package/dist/types/consumption/SharedItemDTO.js.map +0 -1
  348. package/dist/useCases/common/RuntimeValidator.d.ts +0 -4
  349. package/dist/useCases/common/RuntimeValidator.js +0 -14
  350. package/dist/useCases/common/RuntimeValidator.js.map +0 -1
  351. package/dist/useCases/common/validation/AddressValidator.d.ts +0 -6
  352. package/dist/useCases/common/validation/AddressValidator.js +0 -25
  353. package/dist/useCases/common/validation/AddressValidator.js.map +0 -1
  354. package/dist/useCases/common/validation/DateValidator.d.ts +0 -6
  355. package/dist/useCases/common/validation/DateValidator.js +0 -26
  356. package/dist/useCases/common/validation/DateValidator.js.map +0 -1
  357. package/dist/useCases/common/validation/IdValidator.d.ts +0 -7
  358. package/dist/useCases/common/validation/IdValidator.js +0 -25
  359. package/dist/useCases/common/validation/IdValidator.js.map +0 -1
  360. package/dist/useCases/transport/files/LoadPeerFile.js.map +0 -1
@@ -1,7 +1,7 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- 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.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.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.UploadOwnFileRequest = exports.LoadPeerFileRequest = exports.LoadPeerFileViaReferenceRequest = exports.LoadPeerFileViaSecretRequest = exports.GetFilesRequest = exports.GetFileRequest = exports.CreateTokenQrCodeForFileRequest = exports.CreateTokenForFileRequest = exports.CreateQrCodeForFileRequest = exports.UpdateDeviceRequest = exports.GetDeviceOnboardingInfoRequest = exports.GetDeviceRequest = 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",
@@ -10,7 +10,7 @@ exports.LoadPeerTokenAnonymousByIdAndKeyRequest = {
10
10
  "type": "object",
11
11
  "properties": {
12
12
  "id": {
13
- "type": "string"
13
+ "$ref": "#/definitions/TokenIdString"
14
14
  },
15
15
  "secretKey": {
16
16
  "type": "string"
@@ -21,6 +21,10 @@ exports.LoadPeerTokenAnonymousByIdAndKeyRequest = {
21
21
  "secretKey"
22
22
  ],
23
23
  "additionalProperties": false
24
+ },
25
+ "TokenIdString": {
26
+ "type": "string",
27
+ "pattern": "TOK[A-Za-z0-9]{17}"
24
28
  }
25
29
  }
26
30
  };
@@ -32,13 +36,17 @@ exports.LoadPeerTokenAnonymousByTruncatedReferenceRequest = {
32
36
  "type": "object",
33
37
  "properties": {
34
38
  "reference": {
35
- "type": "string"
39
+ "$ref": "#/definitions/TokenReferenceString"
36
40
  }
37
41
  },
38
42
  "required": [
39
43
  "reference"
40
44
  ],
41
45
  "additionalProperties": false
46
+ },
47
+ "TokenReferenceString": {
48
+ "type": "string",
49
+ "pattern": "VE9L.{84}"
42
50
  }
43
51
  }
44
52
  };
@@ -192,16 +200,13 @@ exports.CreateSharedAttributeCopyRequest = {
192
200
  "type": "object",
193
201
  "properties": {
194
202
  "attributeId": {
195
- "type": "string",
196
- "pattern": "ATT[A-Za-z0-9]{17}"
203
+ "$ref": "#/definitions/AttributeIdString"
197
204
  },
198
205
  "peer": {
199
- "type": "string",
200
- "pattern": "[a-zA-Z1-9]{35,36}"
206
+ "$ref": "#/definitions/AddressString"
201
207
  },
202
208
  "requestReference": {
203
- "type": "string",
204
- "pattern": "REQ[A-Za-z0-9]{17}"
209
+ "$ref": "#/definitions/RequestIdString"
205
210
  }
206
211
  },
207
212
  "required": [
@@ -210,6 +215,18 @@ exports.CreateSharedAttributeCopyRequest = {
210
215
  "requestReference"
211
216
  ],
212
217
  "additionalProperties": false
218
+ },
219
+ "AttributeIdString": {
220
+ "type": "string",
221
+ "pattern": "ATT[A-Za-z0-9]{17}"
222
+ },
223
+ "AddressString": {
224
+ "type": "string",
225
+ "pattern": "id1[A-Za-z0-9]{32,33}"
226
+ },
227
+ "RequestIdString": {
228
+ "type": "string",
229
+ "pattern": "REQ[A-Za-z0-9]{17}"
213
230
  }
214
231
  }
215
232
  };
@@ -221,14 +238,17 @@ exports.DeleteAttributeRequest = {
221
238
  "type": "object",
222
239
  "properties": {
223
240
  "id": {
224
- "type": "string",
225
- "pattern": "ATT[A-Za-z0-9]{17}"
241
+ "$ref": "#/definitions/AttributeIdString"
226
242
  }
227
243
  },
228
244
  "required": [
229
245
  "id"
230
246
  ],
231
247
  "additionalProperties": false
248
+ },
249
+ "AttributeIdString": {
250
+ "type": "string",
251
+ "pattern": "ATT[A-Za-z0-9]{17}"
232
252
  }
233
253
  }
234
254
  };
@@ -644,14 +664,17 @@ exports.GetAttributeRequest = {
644
664
  "type": "object",
645
665
  "properties": {
646
666
  "id": {
647
- "type": "string",
648
- "pattern": "ATT[A-Za-z0-9]{17}"
667
+ "$ref": "#/definitions/AttributeIdString"
649
668
  }
650
669
  },
651
670
  "required": [
652
671
  "id"
653
672
  ],
654
673
  "additionalProperties": false
674
+ },
675
+ "AttributeIdString": {
676
+ "type": "string",
677
+ "pattern": "ATT[A-Za-z0-9]{17}"
655
678
  }
656
679
  }
657
680
  };
@@ -1234,8 +1257,7 @@ exports.SucceedAttributeRequest = {
1234
1257
  ]
1235
1258
  },
1236
1259
  "succeeds": {
1237
- "type": "string",
1238
- "pattern": "ATT[A-Za-z0-9]{17}"
1260
+ "$ref": "#/definitions/AttributeIdString"
1239
1261
  }
1240
1262
  },
1241
1263
  "required": [
@@ -1360,6 +1382,10 @@ exports.SucceedAttributeRequest = {
1360
1382
  "private",
1361
1383
  "protected"
1362
1384
  ]
1385
+ },
1386
+ "AttributeIdString": {
1387
+ "type": "string",
1388
+ "pattern": "ATT[A-Za-z0-9]{17}"
1363
1389
  }
1364
1390
  }
1365
1391
  };
@@ -1371,8 +1397,7 @@ exports.UpdateAttributeRequest = {
1371
1397
  "type": "object",
1372
1398
  "properties": {
1373
1399
  "id": {
1374
- "type": "string",
1375
- "pattern": "ATT[A-Za-z0-9]{17}"
1400
+ "$ref": "#/definitions/AttributeIdString"
1376
1401
  },
1377
1402
  "content": {
1378
1403
  "anyOf": [
@@ -1391,6 +1416,10 @@ exports.UpdateAttributeRequest = {
1391
1416
  ],
1392
1417
  "additionalProperties": false
1393
1418
  },
1419
+ "AttributeIdString": {
1420
+ "type": "string",
1421
+ "pattern": "ATT[A-Za-z0-9]{17}"
1422
+ },
1394
1423
  "ExtendedIdentityAttributeJSON": {
1395
1424
  "type": "object",
1396
1425
  "properties": {
@@ -1537,13 +1566,17 @@ exports.DeleteDraftRequest = {
1537
1566
  "type": "object",
1538
1567
  "properties": {
1539
1568
  "id": {
1540
- "type": "string"
1569
+ "$ref": "#/definitions/LocalDraftIdString"
1541
1570
  }
1542
1571
  },
1543
1572
  "required": [
1544
1573
  "id"
1545
1574
  ],
1546
1575
  "additionalProperties": false
1576
+ },
1577
+ "LocalDraftIdString": {
1578
+ "type": "string",
1579
+ "pattern": "LCLDRF[A-Za-z0-9]{14}"
1547
1580
  }
1548
1581
  }
1549
1582
  };
@@ -1555,13 +1588,17 @@ exports.GetDraftRequest = {
1555
1588
  "type": "object",
1556
1589
  "properties": {
1557
1590
  "id": {
1558
- "type": "string"
1591
+ "$ref": "#/definitions/LocalDraftIdString"
1559
1592
  }
1560
1593
  },
1561
1594
  "required": [
1562
1595
  "id"
1563
1596
  ],
1564
1597
  "additionalProperties": false
1598
+ },
1599
+ "LocalDraftIdString": {
1600
+ "type": "string",
1601
+ "pattern": "LCLDRF[A-Za-z0-9]{14}"
1565
1602
  }
1566
1603
  }
1567
1604
  };
@@ -1633,7 +1670,7 @@ exports.UpdateDraftRequest = {
1633
1670
  "type": "object",
1634
1671
  "properties": {
1635
1672
  "id": {
1636
- "type": "string"
1673
+ "$ref": "#/definitions/LocalDraftIdString"
1637
1674
  },
1638
1675
  "content": {}
1639
1676
  },
@@ -1642,6 +1679,10 @@ exports.UpdateDraftRequest = {
1642
1679
  "content"
1643
1680
  ],
1644
1681
  "additionalProperties": false
1682
+ },
1683
+ "LocalDraftIdString": {
1684
+ "type": "string",
1685
+ "pattern": "LCLDRF[A-Za-z0-9]{14}"
1645
1686
  }
1646
1687
  }
1647
1688
  };
@@ -1734,11 +1775,11 @@ exports.AcceptIncomingRequestRequest = {
1734
1775
  }
1735
1776
  }
1736
1777
  };
1737
- exports.CreateOutgoingRequestRequest = {
1778
+ exports.CanCreateOutgoingRequestRequest = {
1738
1779
  "$schema": "http://json-schema.org/draft-07/schema#",
1739
- "$ref": "#/definitions/CreateOutgoingRequestRequest",
1780
+ "$ref": "#/definitions/CanCreateOutgoingRequestRequest",
1740
1781
  "definitions": {
1741
- "CreateOutgoingRequestRequest": {
1782
+ "CanCreateOutgoingRequestRequest": {
1742
1783
  "type": "object",
1743
1784
  "properties": {
1744
1785
  "content": {
@@ -1793,6 +1834,14 @@ exports.CreateOutgoingRequestRequest = {
1793
1834
  ],
1794
1835
  "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 } ."
1795
1836
  },
1837
+ "title": {
1838
+ "type": "string",
1839
+ "description": "The human-readable title of this Request."
1840
+ },
1841
+ "description": {
1842
+ "type": "string",
1843
+ "description": "The human-readable description of this Request."
1844
+ },
1796
1845
  "metadata": {
1797
1846
  "anyOf": [
1798
1847
  {
@@ -1816,13 +1865,11 @@ exports.CreateOutgoingRequestRequest = {
1816
1865
  "additionalProperties": false
1817
1866
  },
1818
1867
  "peer": {
1819
- "type": "string",
1820
- "pattern": "id1[A-Za-z0-9]{32,33}"
1868
+ "$ref": "#/definitions/AddressString"
1821
1869
  }
1822
1870
  },
1823
1871
  "required": [
1824
- "content",
1825
- "peer"
1872
+ "content"
1826
1873
  ],
1827
1874
  "additionalProperties": false
1828
1875
  },
@@ -1880,7 +1927,7 @@ exports.CreateOutgoingRequestRequest = {
1880
1927
  "mustBeAccepted"
1881
1928
  ],
1882
1929
  "additionalProperties": false,
1883
- "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 `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"
1930
+ "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"
1884
1931
  },
1885
1932
  "RequestItemJSONDerivations": {
1886
1933
  "anyOf": [
@@ -1888,7 +1935,10 @@ exports.CreateOutgoingRequestRequest = {
1888
1935
  "$ref": "#/definitions/RequestItemJSON"
1889
1936
  },
1890
1937
  {
1891
- "$ref": "#/definitions/CreateAttributeRequestItemJSON"
1938
+ "$ref": "#/definitions/CreateRelationshipAttributeRequestItemJSON"
1939
+ },
1940
+ {
1941
+ "$ref": "#/definitions/ShareAttributeRequestItemJSON"
1892
1942
  },
1893
1943
  {
1894
1944
  "$ref": "#/definitions/ProposeAttributeRequestItemJSON"
@@ -1897,7 +1947,10 @@ exports.CreateOutgoingRequestRequest = {
1897
1947
  "$ref": "#/definitions/ReadAttributeRequestItemJSON"
1898
1948
  },
1899
1949
  {
1900
- "$ref": "#/definitions/ShareAttributeRequestItemJSON"
1950
+ "$ref": "#/definitions/ConsentRequestItemJSON"
1951
+ },
1952
+ {
1953
+ "$ref": "#/definitions/AuthenticationRequestItemJSON"
1901
1954
  }
1902
1955
  ]
1903
1956
  },
@@ -1928,6 +1981,10 @@ exports.CreateOutgoingRequestRequest = {
1928
1981
  "mustBeAccepted": {
1929
1982
  "type": "boolean",
1930
1983
  "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."
1984
+ },
1985
+ "requireManualDecision": {
1986
+ "type": "boolean",
1987
+ "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."
1931
1988
  }
1932
1989
  },
1933
1990
  "required": [
@@ -1936,7 +1993,7 @@ exports.CreateOutgoingRequestRequest = {
1936
1993
  ],
1937
1994
  "additionalProperties": false
1938
1995
  },
1939
- "CreateAttributeRequestItemJSON": {
1996
+ "CreateRelationshipAttributeRequestItemJSON": {
1940
1997
  "type": "object",
1941
1998
  "properties": {
1942
1999
  "@type": {
@@ -1964,18 +2021,12 @@ exports.CreateOutgoingRequestRequest = {
1964
2021
  "type": "boolean",
1965
2022
  "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."
1966
2023
  },
1967
- "attribute": {
1968
- "anyOf": [
1969
- {
1970
- "$ref": "#/definitions/IdentityAttributeJSON"
1971
- },
1972
- {
1973
- "$ref": "#/definitions/RelationshipAttributeJSON"
1974
- }
1975
- ]
2024
+ "requireManualDecision": {
2025
+ "type": "boolean",
2026
+ "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."
1976
2027
  },
1977
- "sourceAttributeId": {
1978
- "type": "string"
2028
+ "attribute": {
2029
+ "$ref": "#/definitions/RelationshipAttributeJSON"
1979
2030
  }
1980
2031
  },
1981
2032
  "required": [
@@ -1985,7 +2036,7 @@ exports.CreateOutgoingRequestRequest = {
1985
2036
  ],
1986
2037
  "additionalProperties": false
1987
2038
  },
1988
- "IdentityAttributeJSON": {
2039
+ "RelationshipAttributeJSON": {
1989
2040
  "type": "object",
1990
2041
  "properties": {
1991
2042
  "@type": {
@@ -2009,15 +2060,20 @@ exports.CreateOutgoingRequestRequest = {
2009
2060
  "value": {
2010
2061
  "$ref": "#/definitions/AbstractAttributeValueJSON"
2011
2062
  },
2012
- "tags": {
2013
- "type": "array",
2014
- "items": {
2015
- "type": "string"
2016
- }
2063
+ "key": {
2064
+ "type": "string"
2065
+ },
2066
+ "isTechnical": {
2067
+ "type": "boolean"
2068
+ },
2069
+ "confidentiality": {
2070
+ "$ref": "#/definitions/RelationshipAttributeConfidentiality"
2017
2071
  }
2018
2072
  },
2019
2073
  "required": [
2020
2074
  "@type",
2075
+ "confidentiality",
2076
+ "key",
2021
2077
  "owner",
2022
2078
  "value"
2023
2079
  ],
@@ -2040,7 +2096,69 @@ exports.CreateOutgoingRequestRequest = {
2040
2096
  "@type"
2041
2097
  ]
2042
2098
  },
2043
- "RelationshipAttributeJSON": {
2099
+ "RelationshipAttributeConfidentiality": {
2100
+ "type": "string",
2101
+ "enum": [
2102
+ "public",
2103
+ "private",
2104
+ "protected"
2105
+ ]
2106
+ },
2107
+ "ShareAttributeRequestItemJSON": {
2108
+ "type": "object",
2109
+ "properties": {
2110
+ "@type": {
2111
+ "type": "string"
2112
+ },
2113
+ "@context": {
2114
+ "type": "string"
2115
+ },
2116
+ "@version": {
2117
+ "type": "string"
2118
+ },
2119
+ "title": {
2120
+ "type": "string",
2121
+ "description": "The human-readable title of this item."
2122
+ },
2123
+ "description": {
2124
+ "type": "string",
2125
+ "description": "The human-readable description of this item."
2126
+ },
2127
+ "metadata": {
2128
+ "type": "object",
2129
+ "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."
2130
+ },
2131
+ "mustBeAccepted": {
2132
+ "type": "boolean",
2133
+ "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."
2134
+ },
2135
+ "requireManualDecision": {
2136
+ "type": "boolean",
2137
+ "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."
2138
+ },
2139
+ "attribute": {
2140
+ "anyOf": [
2141
+ {
2142
+ "$ref": "#/definitions/IdentityAttributeJSON"
2143
+ },
2144
+ {
2145
+ "$ref": "#/definitions/RelationshipAttributeJSON"
2146
+ }
2147
+ ]
2148
+ },
2149
+ "sourceAttributeId": {
2150
+ "type": "string"
2151
+ }
2152
+ },
2153
+ "required": [
2154
+ "@type",
2155
+ "attribute",
2156
+ "mustBeAccepted",
2157
+ "sourceAttributeId"
2158
+ ],
2159
+ "additionalProperties": false
2160
+ },
2161
+ "IdentityAttributeJSON": {
2044
2162
  "type": "object",
2045
2163
  "properties": {
2046
2164
  "@type": {
@@ -2064,33 +2182,20 @@ exports.CreateOutgoingRequestRequest = {
2064
2182
  "value": {
2065
2183
  "$ref": "#/definitions/AbstractAttributeValueJSON"
2066
2184
  },
2067
- "key": {
2068
- "type": "string"
2069
- },
2070
- "isTechnical": {
2071
- "type": "boolean"
2072
- },
2073
- "confidentiality": {
2074
- "$ref": "#/definitions/RelationshipAttributeConfidentiality"
2185
+ "tags": {
2186
+ "type": "array",
2187
+ "items": {
2188
+ "type": "string"
2189
+ }
2075
2190
  }
2076
2191
  },
2077
2192
  "required": [
2078
2193
  "@type",
2079
- "confidentiality",
2080
- "key",
2081
2194
  "owner",
2082
2195
  "value"
2083
2196
  ],
2084
2197
  "additionalProperties": false
2085
2198
  },
2086
- "RelationshipAttributeConfidentiality": {
2087
- "type": "string",
2088
- "enum": [
2089
- "public",
2090
- "private",
2091
- "protected"
2092
- ]
2093
- },
2094
2199
  "ProposeAttributeRequestItemJSON": {
2095
2200
  "type": "object",
2096
2201
  "properties": {
@@ -2119,6 +2224,10 @@ exports.CreateOutgoingRequestRequest = {
2119
2224
  "type": "boolean",
2120
2225
  "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."
2121
2226
  },
2227
+ "requireManualDecision": {
2228
+ "type": "boolean",
2229
+ "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."
2230
+ },
2122
2231
  "query": {
2123
2232
  "anyOf": [
2124
2233
  {
@@ -2347,6 +2456,10 @@ exports.CreateOutgoingRequestRequest = {
2347
2456
  "type": "boolean",
2348
2457
  "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."
2349
2458
  },
2459
+ "requireManualDecision": {
2460
+ "type": "boolean",
2461
+ "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."
2462
+ },
2350
2463
  "query": {
2351
2464
  "$ref": "#/definitions/AbstractAttributeQueryJSON"
2352
2465
  }
@@ -2386,7 +2499,7 @@ exports.CreateOutgoingRequestRequest = {
2386
2499
  ],
2387
2500
  "additionalProperties": false
2388
2501
  },
2389
- "ShareAttributeRequestItemJSON": {
2502
+ "ConsentRequestItemJSON": {
2390
2503
  "type": "object",
2391
2504
  "properties": {
2392
2505
  "@type": {
@@ -2414,21 +2527,63 @@ exports.CreateOutgoingRequestRequest = {
2414
2527
  "type": "boolean",
2415
2528
  "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."
2416
2529
  },
2417
- "attributeId": {
2530
+ "requireManualDecision": {
2531
+ "type": "boolean",
2532
+ "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."
2533
+ },
2534
+ "consent": {
2418
2535
  "type": "string"
2419
2536
  },
2420
- "shareWith": {
2537
+ "link": {
2421
2538
  "type": "string"
2422
2539
  }
2423
2540
  },
2424
2541
  "required": [
2425
2542
  "@type",
2426
- "attributeId",
2427
- "mustBeAccepted",
2428
- "shareWith"
2543
+ "consent",
2544
+ "mustBeAccepted"
2429
2545
  ],
2430
2546
  "additionalProperties": false
2431
2547
  },
2548
+ "AuthenticationRequestItemJSON": {
2549
+ "type": "object",
2550
+ "additionalProperties": false,
2551
+ "properties": {
2552
+ "@type": {
2553
+ "type": "string"
2554
+ },
2555
+ "@context": {
2556
+ "type": "string"
2557
+ },
2558
+ "@version": {
2559
+ "type": "string"
2560
+ },
2561
+ "title": {
2562
+ "type": "string",
2563
+ "description": "The human-readable title of this item."
2564
+ },
2565
+ "description": {
2566
+ "type": "string",
2567
+ "description": "The human-readable description of this item."
2568
+ },
2569
+ "metadata": {
2570
+ "type": "object",
2571
+ "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."
2572
+ },
2573
+ "mustBeAccepted": {
2574
+ "type": "boolean",
2575
+ "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."
2576
+ },
2577
+ "requireManualDecision": {
2578
+ "type": "boolean",
2579
+ "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."
2580
+ }
2581
+ },
2582
+ "required": [
2583
+ "@type",
2584
+ "mustBeAccepted"
2585
+ ]
2586
+ },
2432
2587
  "IRequestItemGroup": {
2433
2588
  "type": "object",
2434
2589
  "properties": {
@@ -2461,7 +2616,7 @@ exports.CreateOutgoingRequestRequest = {
2461
2616
  "items"
2462
2617
  ],
2463
2618
  "additionalProperties": false,
2464
- "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 `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"
2619
+ "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"
2465
2620
  },
2466
2621
  "IRequestItemDerivations": {
2467
2622
  "anyOf": [
@@ -2469,7 +2624,10 @@ exports.CreateOutgoingRequestRequest = {
2469
2624
  "$ref": "#/definitions/IRequestItem"
2470
2625
  },
2471
2626
  {
2472
- "$ref": "#/definitions/ICreateAttributeRequestItem"
2627
+ "$ref": "#/definitions/ICreateRelationshipAttributeRequestItem"
2628
+ },
2629
+ {
2630
+ "$ref": "#/definitions/IShareAttributeRequestItem"
2473
2631
  },
2474
2632
  {
2475
2633
  "$ref": "#/definitions/IProposeAttributeRequestItem"
@@ -2478,7 +2636,10 @@ exports.CreateOutgoingRequestRequest = {
2478
2636
  "$ref": "#/definitions/IReadAttributeRequestItem"
2479
2637
  },
2480
2638
  {
2481
- "$ref": "#/definitions/IShareAttributeRequestItem"
2639
+ "$ref": "#/definitions/IConsentRequestItem"
2640
+ },
2641
+ {
2642
+ "$ref": "#/definitions/IAuthenticationRequestItem"
2482
2643
  }
2483
2644
  ]
2484
2645
  },
@@ -2500,6 +2661,10 @@ exports.CreateOutgoingRequestRequest = {
2500
2661
  "mustBeAccepted": {
2501
2662
  "type": "boolean",
2502
2663
  "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."
2664
+ },
2665
+ "requireManualDecision": {
2666
+ "type": "boolean",
2667
+ "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."
2503
2668
  }
2504
2669
  },
2505
2670
  "required": [
@@ -2507,7 +2672,7 @@ exports.CreateOutgoingRequestRequest = {
2507
2672
  ],
2508
2673
  "additionalProperties": false
2509
2674
  },
2510
- "ICreateAttributeRequestItem": {
2675
+ "ICreateRelationshipAttributeRequestItem": {
2511
2676
  "type": "object",
2512
2677
  "properties": {
2513
2678
  "title": {
@@ -2526,18 +2691,12 @@ exports.CreateOutgoingRequestRequest = {
2526
2691
  "type": "boolean",
2527
2692
  "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."
2528
2693
  },
2529
- "attribute": {
2530
- "anyOf": [
2531
- {
2532
- "$ref": "#/definitions/IIdentityAttribute"
2533
- },
2534
- {
2535
- "$ref": "#/definitions/IRelationshipAttribute"
2536
- }
2537
- ]
2694
+ "requireManualDecision": {
2695
+ "type": "boolean",
2696
+ "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."
2538
2697
  },
2539
- "sourceAttributeId": {
2540
- "$ref": "#/definitions/ICoreId"
2698
+ "attribute": {
2699
+ "$ref": "#/definitions/IRelationshipAttribute"
2541
2700
  }
2542
2701
  },
2543
2702
  "required": [
@@ -2546,7 +2705,7 @@ exports.CreateOutgoingRequestRequest = {
2546
2705
  ],
2547
2706
  "additionalProperties": false
2548
2707
  },
2549
- "IIdentityAttribute": {
2708
+ "IRelationshipAttribute": {
2550
2709
  "type": "object",
2551
2710
  "properties": {
2552
2711
  "owner": {
@@ -2561,14 +2720,19 @@ exports.CreateOutgoingRequestRequest = {
2561
2720
  "value": {
2562
2721
  "$ref": "#/definitions/IAbstractAttributeValue"
2563
2722
  },
2564
- "tags": {
2565
- "type": "array",
2566
- "items": {
2567
- "type": "string"
2568
- }
2723
+ "key": {
2724
+ "type": "string"
2725
+ },
2726
+ "isTechnical": {
2727
+ "type": "boolean"
2728
+ },
2729
+ "confidentiality": {
2730
+ "$ref": "#/definitions/RelationshipAttributeConfidentiality"
2569
2731
  }
2570
2732
  },
2571
2733
  "required": [
2734
+ "confidentiality",
2735
+ "key",
2572
2736
  "owner",
2573
2737
  "value"
2574
2738
  ],
@@ -2591,11 +2755,55 @@ exports.CreateOutgoingRequestRequest = {
2591
2755
  "additionalProperties": false,
2592
2756
  "properties": {}
2593
2757
  },
2594
- "IRelationshipAttribute": {
2758
+ "IShareAttributeRequestItem": {
2595
2759
  "type": "object",
2596
2760
  "properties": {
2597
- "owner": {
2598
- "$ref": "#/definitions/ICoreAddress"
2761
+ "title": {
2762
+ "type": "string",
2763
+ "description": "The human-readable title of this item."
2764
+ },
2765
+ "description": {
2766
+ "type": "string",
2767
+ "description": "The human-readable description of this item."
2768
+ },
2769
+ "metadata": {
2770
+ "type": "object",
2771
+ "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."
2772
+ },
2773
+ "mustBeAccepted": {
2774
+ "type": "boolean",
2775
+ "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."
2776
+ },
2777
+ "requireManualDecision": {
2778
+ "type": "boolean",
2779
+ "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."
2780
+ },
2781
+ "attribute": {
2782
+ "anyOf": [
2783
+ {
2784
+ "$ref": "#/definitions/IIdentityAttribute"
2785
+ },
2786
+ {
2787
+ "$ref": "#/definitions/IRelationshipAttribute"
2788
+ }
2789
+ ]
2790
+ },
2791
+ "sourceAttributeId": {
2792
+ "$ref": "#/definitions/ICoreId"
2793
+ }
2794
+ },
2795
+ "required": [
2796
+ "attribute",
2797
+ "mustBeAccepted",
2798
+ "sourceAttributeId"
2799
+ ],
2800
+ "additionalProperties": false
2801
+ },
2802
+ "IIdentityAttribute": {
2803
+ "type": "object",
2804
+ "properties": {
2805
+ "owner": {
2806
+ "$ref": "#/definitions/ICoreAddress"
2599
2807
  },
2600
2808
  "validFrom": {
2601
2809
  "$ref": "#/definitions/ICoreDate"
@@ -2606,19 +2814,14 @@ exports.CreateOutgoingRequestRequest = {
2606
2814
  "value": {
2607
2815
  "$ref": "#/definitions/IAbstractAttributeValue"
2608
2816
  },
2609
- "key": {
2610
- "type": "string"
2611
- },
2612
- "isTechnical": {
2613
- "type": "boolean"
2614
- },
2615
- "confidentiality": {
2616
- "$ref": "#/definitions/RelationshipAttributeConfidentiality"
2817
+ "tags": {
2818
+ "type": "array",
2819
+ "items": {
2820
+ "type": "string"
2821
+ }
2617
2822
  }
2618
2823
  },
2619
2824
  "required": [
2620
- "confidentiality",
2621
- "key",
2622
2825
  "owner",
2623
2826
  "value"
2624
2827
  ],
@@ -2655,6 +2858,10 @@ exports.CreateOutgoingRequestRequest = {
2655
2858
  "type": "boolean",
2656
2859
  "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."
2657
2860
  },
2861
+ "requireManualDecision": {
2862
+ "type": "boolean",
2863
+ "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."
2864
+ },
2658
2865
  "query": {
2659
2866
  "anyOf": [
2660
2867
  {
@@ -2841,6 +3048,10 @@ exports.CreateOutgoingRequestRequest = {
2841
3048
  "type": "boolean",
2842
3049
  "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."
2843
3050
  },
3051
+ "requireManualDecision": {
3052
+ "type": "boolean",
3053
+ "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."
3054
+ },
2844
3055
  "query": {
2845
3056
  "$ref": "#/definitions/IAbstractAttributeQuery"
2846
3057
  }
@@ -2869,7 +3080,7 @@ exports.CreateOutgoingRequestRequest = {
2869
3080
  ],
2870
3081
  "additionalProperties": false
2871
3082
  },
2872
- "IShareAttributeRequestItem": {
3083
+ "IConsentRequestItem": {
2873
3084
  "type": "object",
2874
3085
  "properties": {
2875
3086
  "title": {
@@ -2888,19 +3099,55 @@ exports.CreateOutgoingRequestRequest = {
2888
3099
  "type": "boolean",
2889
3100
  "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."
2890
3101
  },
2891
- "attributeId": {
2892
- "$ref": "#/definitions/ICoreId"
3102
+ "requireManualDecision": {
3103
+ "type": "boolean",
3104
+ "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."
2893
3105
  },
2894
- "shareWith": {
2895
- "$ref": "#/definitions/ICoreAddress"
3106
+ "consent": {
3107
+ "type": "string"
3108
+ },
3109
+ "link": {
3110
+ "type": "string"
2896
3111
  }
2897
3112
  },
2898
3113
  "required": [
2899
- "attributeId",
2900
- "mustBeAccepted",
2901
- "shareWith"
3114
+ "consent",
3115
+ "mustBeAccepted"
2902
3116
  ],
2903
3117
  "additionalProperties": false
3118
+ },
3119
+ "IAuthenticationRequestItem": {
3120
+ "type": "object",
3121
+ "additionalProperties": false,
3122
+ "properties": {
3123
+ "title": {
3124
+ "type": "string",
3125
+ "description": "The human-readable title of this item."
3126
+ },
3127
+ "description": {
3128
+ "type": "string",
3129
+ "description": "The human-readable description of this item."
3130
+ },
3131
+ "metadata": {
3132
+ "type": "object",
3133
+ "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."
3134
+ },
3135
+ "mustBeAccepted": {
3136
+ "type": "boolean",
3137
+ "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."
3138
+ },
3139
+ "requireManualDecision": {
3140
+ "type": "boolean",
3141
+ "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."
3142
+ }
3143
+ },
3144
+ "required": [
3145
+ "mustBeAccepted"
3146
+ ]
3147
+ },
3148
+ "AddressString": {
3149
+ "type": "string",
3150
+ "pattern": "id1[A-Za-z0-9]{32,33}"
2904
3151
  }
2905
3152
  }
2906
3153
  };
@@ -3001,14 +3248,17 @@ exports.CheckPrerequisitesOfIncomingRequestRequest = {
3001
3248
  "type": "object",
3002
3249
  "properties": {
3003
3250
  "requestId": {
3004
- "type": "string",
3005
- "pattern": "REQ[A-Za-z0-9]{17}"
3251
+ "$ref": "#/definitions/RequestIdString"
3006
3252
  }
3007
3253
  },
3008
3254
  "required": [
3009
3255
  "requestId"
3010
3256
  ],
3011
3257
  "additionalProperties": false
3258
+ },
3259
+ "RequestIdString": {
3260
+ "type": "string",
3261
+ "pattern": "REQ[A-Za-z0-9]{17}"
3012
3262
  }
3013
3263
  }
3014
3264
  };
@@ -3020,19 +3270,35 @@ exports.CompleteIncomingRequestRequest = {
3020
3270
  "type": "object",
3021
3271
  "properties": {
3022
3272
  "requestId": {
3023
- "type": "string",
3024
- "pattern": "REQ[A-Za-z0-9]{17}"
3273
+ "$ref": "#/definitions/RequestIdString"
3025
3274
  },
3026
3275
  "responseSourceId": {
3027
- "type": "string",
3028
- "pattern": "(MSG|RCH)[A-Za-z0-9]{17}"
3276
+ "anyOf": [
3277
+ {
3278
+ "$ref": "#/definitions/MessageIdString"
3279
+ },
3280
+ {
3281
+ "$ref": "#/definitions/RelationshipChangeIdString"
3282
+ }
3283
+ ]
3029
3284
  }
3030
3285
  },
3031
3286
  "required": [
3032
- "requestId",
3033
- "responseSourceId"
3287
+ "requestId"
3034
3288
  ],
3035
3289
  "additionalProperties": false
3290
+ },
3291
+ "RequestIdString": {
3292
+ "type": "string",
3293
+ "pattern": "REQ[A-Za-z0-9]{17}"
3294
+ },
3295
+ "MessageIdString": {
3296
+ "type": "string",
3297
+ "pattern": "MSG[A-Za-z0-9]{17}"
3298
+ },
3299
+ "RelationshipChangeIdString": {
3300
+ "type": "string",
3301
+ "pattern": "RCH[A-Za-z0-9]{17}"
3036
3302
  }
3037
3303
  }
3038
3304
  };
@@ -3047,8 +3313,7 @@ exports.CompleteOutgoingRequestRequest = {
3047
3313
  "$ref": "#/definitions/ResponseJSON"
3048
3314
  },
3049
3315
  "messageId": {
3050
- "type": "string",
3051
- "pattern": "MSG[A-Za-z0-9]{17}"
3316
+ "$ref": "#/definitions/MessageIdString"
3052
3317
  }
3053
3318
  },
3054
3319
  "required": [
@@ -3148,7 +3413,10 @@ exports.CompleteOutgoingRequestRequest = {
3148
3413
  "$ref": "#/definitions/AcceptResponseItemJSON"
3149
3414
  },
3150
3415
  {
3151
- "$ref": "#/definitions/CreateAttributeAcceptResponseItemJSON"
3416
+ "$ref": "#/definitions/CreateRelationshipAttributeAcceptResponseItemJSON"
3417
+ },
3418
+ {
3419
+ "$ref": "#/definitions/ShareAttributeAcceptResponseItemJSON"
3152
3420
  },
3153
3421
  {
3154
3422
  "$ref": "#/definitions/ProposeAttributeAcceptResponseItemJSON"
@@ -3181,7 +3449,34 @@ exports.CompleteOutgoingRequestRequest = {
3181
3449
  ],
3182
3450
  "additionalProperties": false
3183
3451
  },
3184
- "CreateAttributeAcceptResponseItemJSON": {
3452
+ "CreateRelationshipAttributeAcceptResponseItemJSON": {
3453
+ "type": "object",
3454
+ "properties": {
3455
+ "@type": {
3456
+ "type": "string"
3457
+ },
3458
+ "@context": {
3459
+ "type": "string"
3460
+ },
3461
+ "@version": {
3462
+ "type": "string"
3463
+ },
3464
+ "result": {
3465
+ "type": "string",
3466
+ "const": "Accepted"
3467
+ },
3468
+ "attributeId": {
3469
+ "type": "string"
3470
+ }
3471
+ },
3472
+ "required": [
3473
+ "@type",
3474
+ "attributeId",
3475
+ "result"
3476
+ ],
3477
+ "additionalProperties": false
3478
+ },
3479
+ "ShareAttributeAcceptResponseItemJSON": {
3185
3480
  "type": "object",
3186
3481
  "properties": {
3187
3482
  "@type": {
@@ -3455,6 +3750,10 @@ exports.CompleteOutgoingRequestRequest = {
3455
3750
  "result"
3456
3751
  ],
3457
3752
  "additionalProperties": false
3753
+ },
3754
+ "MessageIdString": {
3755
+ "type": "string",
3756
+ "pattern": "MSG[A-Za-z0-9]{17}"
3458
3757
  }
3459
3758
  }
3460
3759
  };
@@ -3466,12 +3765,10 @@ exports.CreateAndCompleteOutgoingRequestFromRelationshipCreationChangeRequest =
3466
3765
  "type": "object",
3467
3766
  "properties": {
3468
3767
  "templateId": {
3469
- "type": "string",
3470
- "pattern": "RLT[A-Za-z0-9]{17}"
3768
+ "$ref": "#/definitions/RelationshipTemplateIdString"
3471
3769
  },
3472
3770
  "relationshipChangeId": {
3473
- "type": "string",
3474
- "pattern": "RCH[A-Za-z0-9]{17}"
3771
+ "$ref": "#/definitions/RelationshipChangeIdString"
3475
3772
  }
3476
3773
  },
3477
3774
  "required": [
@@ -3479,36 +3776,1424 @@ exports.CreateAndCompleteOutgoingRequestFromRelationshipCreationChangeRequest =
3479
3776
  "relationshipChangeId"
3480
3777
  ],
3481
3778
  "additionalProperties": false
3779
+ },
3780
+ "RelationshipTemplateIdString": {
3781
+ "type": "string",
3782
+ "pattern": "RLT[A-Za-z0-9]{17}"
3783
+ },
3784
+ "RelationshipChangeIdString": {
3785
+ "type": "string",
3786
+ "pattern": "RCH[A-Za-z0-9]{17}"
3482
3787
  }
3483
3788
  }
3484
3789
  };
3485
- exports.GetIncomingRequestRequest = {
3790
+ exports.CreateOutgoingRequestRequest = {
3486
3791
  "$schema": "http://json-schema.org/draft-07/schema#",
3487
- "$ref": "#/definitions/GetIncomingRequestRequest",
3792
+ "$ref": "#/definitions/CreateOutgoingRequestRequest",
3488
3793
  "definitions": {
3489
- "GetIncomingRequestRequest": {
3794
+ "CreateOutgoingRequestRequest": {
3490
3795
  "type": "object",
3491
3796
  "properties": {
3492
- "id": {
3493
- "type": "string",
3494
- "pattern": "REQ[A-Za-z0-9]{17}"
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"
3495
3881
  }
3496
3882
  },
3497
3883
  "required": [
3498
- "id"
3884
+ "content",
3885
+ "peer"
3499
3886
  ],
3500
3887
  "additionalProperties": false
3501
- }
3502
- }
3503
- };
3504
- exports.GetIncomingRequestsRequest = {
3505
- "$schema": "http://json-schema.org/draft-07/schema#",
3506
- "$ref": "#/definitions/GetIncomingRequestsRequest",
3507
- "definitions": {
3508
- "GetIncomingRequestsRequest": {
3888
+ },
3889
+ "ICoreDate": {
3509
3890
  "type": "object",
3510
3891
  "properties": {
3511
- "query": {
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
+ };
5167
+ exports.GetIncomingRequestRequest = {
5168
+ "$schema": "http://json-schema.org/draft-07/schema#",
5169
+ "$ref": "#/definitions/GetIncomingRequestRequest",
5170
+ "definitions": {
5171
+ "GetIncomingRequestRequest": {
5172
+ "type": "object",
5173
+ "properties": {
5174
+ "id": {
5175
+ "$ref": "#/definitions/RequestIdString"
5176
+ }
5177
+ },
5178
+ "required": [
5179
+ "id"
5180
+ ],
5181
+ "additionalProperties": false
5182
+ },
5183
+ "RequestIdString": {
5184
+ "type": "string",
5185
+ "pattern": "REQ[A-Za-z0-9]{17}"
5186
+ }
5187
+ }
5188
+ };
5189
+ exports.GetIncomingRequestsRequest = {
5190
+ "$schema": "http://json-schema.org/draft-07/schema#",
5191
+ "$ref": "#/definitions/GetIncomingRequestsRequest",
5192
+ "definitions": {
5193
+ "GetIncomingRequestsRequest": {
5194
+ "type": "object",
5195
+ "properties": {
5196
+ "query": {
3512
5197
  "$ref": "#/definitions/GetIncomingRequestsRequestQuery"
3513
5198
  }
3514
5199
  },
@@ -3712,14 +5397,17 @@ exports.GetOutgoingRequestRequest = {
3712
5397
  "type": "object",
3713
5398
  "properties": {
3714
5399
  "id": {
3715
- "type": "string",
3716
- "pattern": "REQ[A-Za-z0-9]{17}"
5400
+ "$ref": "#/definitions/RequestIdString"
3717
5401
  }
3718
5402
  },
3719
5403
  "required": [
3720
5404
  "id"
3721
5405
  ],
3722
5406
  "additionalProperties": false
5407
+ },
5408
+ "RequestIdString": {
5409
+ "type": "string",
5410
+ "pattern": "REQ[A-Za-z0-9]{17}"
3723
5411
  }
3724
5412
  }
3725
5413
  };
@@ -3937,9 +5625,14 @@ exports.ReceivedIncomingRequestRequest = {
3937
5625
  "$ref": "#/definitions/RequestJSON"
3938
5626
  },
3939
5627
  "requestSourceId": {
3940
- "type": "string",
3941
- "description": "The id of the Message or RelationshipTemplate in which the Response was received.",
3942
- "pattern": "(MSG|RLT)[A-Za-z0-9]{17}"
5628
+ "anyOf": [
5629
+ {
5630
+ "$ref": "#/definitions/MessageIdString"
5631
+ },
5632
+ {
5633
+ "$ref": "#/definitions/RelationshipTemplateIdString"
5634
+ }
5635
+ ]
3943
5636
  }
3944
5637
  },
3945
5638
  "required": [
@@ -3982,6 +5675,14 @@ exports.ReceivedIncomingRequestRequest = {
3982
5675
  },
3983
5676
  "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 } ."
3984
5677
  },
5678
+ "title": {
5679
+ "type": "string",
5680
+ "description": "The human-readable title of this Request."
5681
+ },
5682
+ "description": {
5683
+ "type": "string",
5684
+ "description": "The human-readable description of this Request."
5685
+ },
3985
5686
  "metadata": {
3986
5687
  "type": "object",
3987
5688
  "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."
@@ -4035,7 +5736,7 @@ exports.ReceivedIncomingRequestRequest = {
4035
5736
  "mustBeAccepted"
4036
5737
  ],
4037
5738
  "additionalProperties": false,
4038
- "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 `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"
5739
+ "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"
4039
5740
  },
4040
5741
  "RequestItemJSONDerivations": {
4041
5742
  "anyOf": [
@@ -4043,7 +5744,10 @@ exports.ReceivedIncomingRequestRequest = {
4043
5744
  "$ref": "#/definitions/RequestItemJSON"
4044
5745
  },
4045
5746
  {
4046
- "$ref": "#/definitions/CreateAttributeRequestItemJSON"
5747
+ "$ref": "#/definitions/CreateRelationshipAttributeRequestItemJSON"
5748
+ },
5749
+ {
5750
+ "$ref": "#/definitions/ShareAttributeRequestItemJSON"
4047
5751
  },
4048
5752
  {
4049
5753
  "$ref": "#/definitions/ProposeAttributeRequestItemJSON"
@@ -4052,7 +5756,10 @@ exports.ReceivedIncomingRequestRequest = {
4052
5756
  "$ref": "#/definitions/ReadAttributeRequestItemJSON"
4053
5757
  },
4054
5758
  {
4055
- "$ref": "#/definitions/ShareAttributeRequestItemJSON"
5759
+ "$ref": "#/definitions/ConsentRequestItemJSON"
5760
+ },
5761
+ {
5762
+ "$ref": "#/definitions/AuthenticationRequestItemJSON"
4056
5763
  }
4057
5764
  ]
4058
5765
  },
@@ -4083,6 +5790,10 @@ exports.ReceivedIncomingRequestRequest = {
4083
5790
  "mustBeAccepted": {
4084
5791
  "type": "boolean",
4085
5792
  "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."
5793
+ },
5794
+ "requireManualDecision": {
5795
+ "type": "boolean",
5796
+ "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."
4086
5797
  }
4087
5798
  },
4088
5799
  "required": [
@@ -4091,7 +5802,7 @@ exports.ReceivedIncomingRequestRequest = {
4091
5802
  ],
4092
5803
  "additionalProperties": false
4093
5804
  },
4094
- "CreateAttributeRequestItemJSON": {
5805
+ "CreateRelationshipAttributeRequestItemJSON": {
4095
5806
  "type": "object",
4096
5807
  "properties": {
4097
5808
  "@type": {
@@ -4119,18 +5830,12 @@ exports.ReceivedIncomingRequestRequest = {
4119
5830
  "type": "boolean",
4120
5831
  "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."
4121
5832
  },
4122
- "attribute": {
4123
- "anyOf": [
4124
- {
4125
- "$ref": "#/definitions/IdentityAttributeJSON"
4126
- },
4127
- {
4128
- "$ref": "#/definitions/RelationshipAttributeJSON"
4129
- }
4130
- ]
5833
+ "requireManualDecision": {
5834
+ "type": "boolean",
5835
+ "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."
4131
5836
  },
4132
- "sourceAttributeId": {
4133
- "type": "string"
5837
+ "attribute": {
5838
+ "$ref": "#/definitions/RelationshipAttributeJSON"
4134
5839
  }
4135
5840
  },
4136
5841
  "required": [
@@ -4140,7 +5845,7 @@ exports.ReceivedIncomingRequestRequest = {
4140
5845
  ],
4141
5846
  "additionalProperties": false
4142
5847
  },
4143
- "IdentityAttributeJSON": {
5848
+ "RelationshipAttributeJSON": {
4144
5849
  "type": "object",
4145
5850
  "properties": {
4146
5851
  "@type": {
@@ -4164,21 +5869,51 @@ exports.ReceivedIncomingRequestRequest = {
4164
5869
  "value": {
4165
5870
  "$ref": "#/definitions/AbstractAttributeValueJSON"
4166
5871
  },
4167
- "tags": {
4168
- "type": "array",
4169
- "items": {
4170
- "type": "string"
4171
- }
5872
+ "key": {
5873
+ "type": "string"
5874
+ },
5875
+ "isTechnical": {
5876
+ "type": "boolean"
5877
+ },
5878
+ "confidentiality": {
5879
+ "$ref": "#/definitions/RelationshipAttributeConfidentiality"
4172
5880
  }
4173
5881
  },
4174
5882
  "required": [
4175
5883
  "@type",
5884
+ "confidentiality",
5885
+ "key",
4176
5886
  "owner",
4177
5887
  "value"
4178
5888
  ],
4179
5889
  "additionalProperties": false
4180
5890
  },
4181
- "AbstractAttributeValueJSON": {
5891
+ "AbstractAttributeValueJSON": {
5892
+ "type": "object",
5893
+ "properties": {
5894
+ "@type": {
5895
+ "type": "string"
5896
+ },
5897
+ "@context": {
5898
+ "type": "string"
5899
+ },
5900
+ "@version": {
5901
+ "type": "string"
5902
+ }
5903
+ },
5904
+ "required": [
5905
+ "@type"
5906
+ ]
5907
+ },
5908
+ "RelationshipAttributeConfidentiality": {
5909
+ "type": "string",
5910
+ "enum": [
5911
+ "public",
5912
+ "private",
5913
+ "protected"
5914
+ ]
5915
+ },
5916
+ "ShareAttributeRequestItemJSON": {
4182
5917
  "type": "object",
4183
5918
  "properties": {
4184
5919
  "@type": {
@@ -4189,13 +5924,50 @@ exports.ReceivedIncomingRequestRequest = {
4189
5924
  },
4190
5925
  "@version": {
4191
5926
  "type": "string"
5927
+ },
5928
+ "title": {
5929
+ "type": "string",
5930
+ "description": "The human-readable title of this item."
5931
+ },
5932
+ "description": {
5933
+ "type": "string",
5934
+ "description": "The human-readable description of this item."
5935
+ },
5936
+ "metadata": {
5937
+ "type": "object",
5938
+ "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."
5939
+ },
5940
+ "mustBeAccepted": {
5941
+ "type": "boolean",
5942
+ "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."
5943
+ },
5944
+ "requireManualDecision": {
5945
+ "type": "boolean",
5946
+ "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."
5947
+ },
5948
+ "attribute": {
5949
+ "anyOf": [
5950
+ {
5951
+ "$ref": "#/definitions/IdentityAttributeJSON"
5952
+ },
5953
+ {
5954
+ "$ref": "#/definitions/RelationshipAttributeJSON"
5955
+ }
5956
+ ]
5957
+ },
5958
+ "sourceAttributeId": {
5959
+ "type": "string"
4192
5960
  }
4193
5961
  },
4194
5962
  "required": [
4195
- "@type"
4196
- ]
5963
+ "@type",
5964
+ "attribute",
5965
+ "mustBeAccepted",
5966
+ "sourceAttributeId"
5967
+ ],
5968
+ "additionalProperties": false
4197
5969
  },
4198
- "RelationshipAttributeJSON": {
5970
+ "IdentityAttributeJSON": {
4199
5971
  "type": "object",
4200
5972
  "properties": {
4201
5973
  "@type": {
@@ -4219,33 +5991,20 @@ exports.ReceivedIncomingRequestRequest = {
4219
5991
  "value": {
4220
5992
  "$ref": "#/definitions/AbstractAttributeValueJSON"
4221
5993
  },
4222
- "key": {
4223
- "type": "string"
4224
- },
4225
- "isTechnical": {
4226
- "type": "boolean"
4227
- },
4228
- "confidentiality": {
4229
- "$ref": "#/definitions/RelationshipAttributeConfidentiality"
5994
+ "tags": {
5995
+ "type": "array",
5996
+ "items": {
5997
+ "type": "string"
5998
+ }
4230
5999
  }
4231
6000
  },
4232
6001
  "required": [
4233
6002
  "@type",
4234
- "confidentiality",
4235
- "key",
4236
6003
  "owner",
4237
6004
  "value"
4238
6005
  ],
4239
6006
  "additionalProperties": false
4240
6007
  },
4241
- "RelationshipAttributeConfidentiality": {
4242
- "type": "string",
4243
- "enum": [
4244
- "public",
4245
- "private",
4246
- "protected"
4247
- ]
4248
- },
4249
6008
  "ProposeAttributeRequestItemJSON": {
4250
6009
  "type": "object",
4251
6010
  "properties": {
@@ -4274,6 +6033,10 @@ exports.ReceivedIncomingRequestRequest = {
4274
6033
  "type": "boolean",
4275
6034
  "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."
4276
6035
  },
6036
+ "requireManualDecision": {
6037
+ "type": "boolean",
6038
+ "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."
6039
+ },
4277
6040
  "query": {
4278
6041
  "anyOf": [
4279
6042
  {
@@ -4502,6 +6265,10 @@ exports.ReceivedIncomingRequestRequest = {
4502
6265
  "type": "boolean",
4503
6266
  "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."
4504
6267
  },
6268
+ "requireManualDecision": {
6269
+ "type": "boolean",
6270
+ "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."
6271
+ },
4505
6272
  "query": {
4506
6273
  "$ref": "#/definitions/AbstractAttributeQueryJSON"
4507
6274
  }
@@ -4541,7 +6308,7 @@ exports.ReceivedIncomingRequestRequest = {
4541
6308
  ],
4542
6309
  "additionalProperties": false
4543
6310
  },
4544
- "ShareAttributeRequestItemJSON": {
6311
+ "ConsentRequestItemJSON": {
4545
6312
  "type": "object",
4546
6313
  "properties": {
4547
6314
  "@type": {
@@ -4569,20 +6336,70 @@ exports.ReceivedIncomingRequestRequest = {
4569
6336
  "type": "boolean",
4570
6337
  "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."
4571
6338
  },
4572
- "attributeId": {
6339
+ "requireManualDecision": {
6340
+ "type": "boolean",
6341
+ "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."
6342
+ },
6343
+ "consent": {
4573
6344
  "type": "string"
4574
6345
  },
4575
- "shareWith": {
6346
+ "link": {
4576
6347
  "type": "string"
4577
6348
  }
4578
6349
  },
4579
6350
  "required": [
4580
6351
  "@type",
4581
- "attributeId",
4582
- "mustBeAccepted",
4583
- "shareWith"
6352
+ "consent",
6353
+ "mustBeAccepted"
4584
6354
  ],
4585
6355
  "additionalProperties": false
6356
+ },
6357
+ "AuthenticationRequestItemJSON": {
6358
+ "type": "object",
6359
+ "additionalProperties": false,
6360
+ "properties": {
6361
+ "@type": {
6362
+ "type": "string"
6363
+ },
6364
+ "@context": {
6365
+ "type": "string"
6366
+ },
6367
+ "@version": {
6368
+ "type": "string"
6369
+ },
6370
+ "title": {
6371
+ "type": "string",
6372
+ "description": "The human-readable title of this item."
6373
+ },
6374
+ "description": {
6375
+ "type": "string",
6376
+ "description": "The human-readable description of this item."
6377
+ },
6378
+ "metadata": {
6379
+ "type": "object",
6380
+ "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."
6381
+ },
6382
+ "mustBeAccepted": {
6383
+ "type": "boolean",
6384
+ "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."
6385
+ },
6386
+ "requireManualDecision": {
6387
+ "type": "boolean",
6388
+ "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."
6389
+ }
6390
+ },
6391
+ "required": [
6392
+ "@type",
6393
+ "mustBeAccepted"
6394
+ ]
6395
+ },
6396
+ "MessageIdString": {
6397
+ "type": "string",
6398
+ "pattern": "MSG[A-Za-z0-9]{17}"
6399
+ },
6400
+ "RelationshipTemplateIdString": {
6401
+ "type": "string",
6402
+ "pattern": "RLT[A-Za-z0-9]{17}"
4586
6403
  }
4587
6404
  }
4588
6405
  };
@@ -4594,14 +6411,17 @@ exports.RequireManualDecisionOfIncomingRequestRequest = {
4594
6411
  "type": "object",
4595
6412
  "properties": {
4596
6413
  "requestId": {
4597
- "type": "string",
4598
- "pattern": "REQ[A-Za-z0-9]{17}"
6414
+ "$ref": "#/definitions/RequestIdString"
4599
6415
  }
4600
6416
  },
4601
6417
  "required": [
4602
6418
  "requestId"
4603
6419
  ],
4604
6420
  "additionalProperties": false
6421
+ },
6422
+ "RequestIdString": {
6423
+ "type": "string",
6424
+ "pattern": "REQ[A-Za-z0-9]{17}"
4605
6425
  }
4606
6426
  }
4607
6427
  };
@@ -4613,12 +6433,10 @@ exports.SentOutgoingRequestRequest = {
4613
6433
  "type": "object",
4614
6434
  "properties": {
4615
6435
  "requestId": {
4616
- "type": "string",
4617
- "pattern": "REQ[A-Za-z0-9]{17}"
6436
+ "$ref": "#/definitions/RequestIdString"
4618
6437
  },
4619
6438
  "messageId": {
4620
- "type": "string",
4621
- "pattern": "MSG[A-Za-z0-9]{17}"
6439
+ "$ref": "#/definitions/MessageIdString"
4622
6440
  }
4623
6441
  },
4624
6442
  "required": [
@@ -4626,6 +6444,14 @@ exports.SentOutgoingRequestRequest = {
4626
6444
  "messageId"
4627
6445
  ],
4628
6446
  "additionalProperties": false
6447
+ },
6448
+ "RequestIdString": {
6449
+ "type": "string",
6450
+ "pattern": "REQ[A-Za-z0-9]{17}"
6451
+ },
6452
+ "MessageIdString": {
6453
+ "type": "string",
6454
+ "pattern": "MSG[A-Za-z0-9]{17}"
4629
6455
  }
4630
6456
  }
4631
6457
  };
@@ -4641,16 +6467,21 @@ exports.CreateSettingRequest = {
4641
6467
  },
4642
6468
  "value": {},
4643
6469
  "reference": {
4644
- "type": "string"
6470
+ "$ref": "#/definitions/GenericIdString"
4645
6471
  },
4646
6472
  "scope": {
4647
- "type": "string"
6473
+ "type": "string",
6474
+ "enum": [
6475
+ "Identity",
6476
+ "Device",
6477
+ "Relationship"
6478
+ ]
4648
6479
  },
4649
6480
  "succeedsAt": {
4650
- "type": "string"
6481
+ "$ref": "#/definitions/DateTimeString"
4651
6482
  },
4652
6483
  "succeedsItem": {
4653
- "type": "string"
6484
+ "$ref": "#/definitions/LocalSettingIdString"
4654
6485
  }
4655
6486
  },
4656
6487
  "required": [
@@ -4658,6 +6489,18 @@ exports.CreateSettingRequest = {
4658
6489
  "value"
4659
6490
  ],
4660
6491
  "additionalProperties": false
6492
+ },
6493
+ "GenericIdString": {
6494
+ "type": "string",
6495
+ "pattern": "[A-Za-z0-9]{20}"
6496
+ },
6497
+ "DateTimeString": {
6498
+ "type": "string",
6499
+ "format": "date-time"
6500
+ },
6501
+ "LocalSettingIdString": {
6502
+ "type": "string",
6503
+ "pattern": "LCLSET[A-Za-z0-9]{14}"
4661
6504
  }
4662
6505
  }
4663
6506
  };
@@ -4669,13 +6512,17 @@ exports.DeleteSettingRequest = {
4669
6512
  "type": "object",
4670
6513
  "properties": {
4671
6514
  "id": {
4672
- "type": "string"
6515
+ "$ref": "#/definitions/LocalSettingIdString"
4673
6516
  }
4674
6517
  },
4675
6518
  "required": [
4676
6519
  "id"
4677
6520
  ],
4678
6521
  "additionalProperties": false
6522
+ },
6523
+ "LocalSettingIdString": {
6524
+ "type": "string",
6525
+ "pattern": "LCLSET[A-Za-z0-9]{14}"
4679
6526
  }
4680
6527
  }
4681
6528
  };
@@ -4687,13 +6534,17 @@ exports.GetSettingRequest = {
4687
6534
  "type": "object",
4688
6535
  "properties": {
4689
6536
  "id": {
4690
- "type": "string"
6537
+ "$ref": "#/definitions/LocalSettingIdString"
4691
6538
  }
4692
6539
  },
4693
6540
  "required": [
4694
6541
  "id"
4695
6542
  ],
4696
6543
  "additionalProperties": false
6544
+ },
6545
+ "LocalSettingIdString": {
6546
+ "type": "string",
6547
+ "pattern": "LCLSET[A-Za-z0-9]{14}"
4697
6548
  }
4698
6549
  }
4699
6550
  };
@@ -4804,7 +6655,7 @@ exports.UpdateSettingRequest = {
4804
6655
  "type": "object",
4805
6656
  "properties": {
4806
6657
  "id": {
4807
- "type": "string"
6658
+ "$ref": "#/definitions/LocalSettingIdString"
4808
6659
  },
4809
6660
  "value": {}
4810
6661
  },
@@ -4813,6 +6664,72 @@ exports.UpdateSettingRequest = {
4813
6664
  "value"
4814
6665
  ],
4815
6666
  "additionalProperties": false
6667
+ },
6668
+ "LocalSettingIdString": {
6669
+ "type": "string",
6670
+ "pattern": "LCLSET[A-Za-z0-9]{14}"
6671
+ }
6672
+ }
6673
+ };
6674
+ exports.DownloadFileRequest = {
6675
+ "$schema": "http://json-schema.org/draft-07/schema#",
6676
+ "$ref": "#/definitions/DownloadFileRequest",
6677
+ "definitions": {
6678
+ "DownloadFileRequest": {
6679
+ "type": "object",
6680
+ "properties": {
6681
+ "id": {
6682
+ "$ref": "#/definitions/FileIdString"
6683
+ }
6684
+ },
6685
+ "required": [
6686
+ "id"
6687
+ ],
6688
+ "additionalProperties": false
6689
+ },
6690
+ "FileIdString": {
6691
+ "type": "string",
6692
+ "pattern": "FIL[A-Za-z0-9]{17}"
6693
+ }
6694
+ }
6695
+ };
6696
+ exports.LoadItemFromTruncatedReferenceRequest = {
6697
+ "$schema": "http://json-schema.org/draft-07/schema#",
6698
+ "$ref": "#/definitions/LoadItemFromTruncatedReferenceRequest",
6699
+ "definitions": {
6700
+ "LoadItemFromTruncatedReferenceRequest": {
6701
+ "type": "object",
6702
+ "properties": {
6703
+ "reference": {
6704
+ "anyOf": [
6705
+ {
6706
+ "$ref": "#/definitions/TokenReferenceString"
6707
+ },
6708
+ {
6709
+ "$ref": "#/definitions/FileReferenceString"
6710
+ },
6711
+ {
6712
+ "$ref": "#/definitions/RelationshipTemplateReferenceString"
6713
+ }
6714
+ ]
6715
+ }
6716
+ },
6717
+ "required": [
6718
+ "reference"
6719
+ ],
6720
+ "additionalProperties": false
6721
+ },
6722
+ "TokenReferenceString": {
6723
+ "type": "string",
6724
+ "pattern": "VE9L.{84}"
6725
+ },
6726
+ "FileReferenceString": {
6727
+ "type": "string",
6728
+ "pattern": "RklM.{84}"
6729
+ },
6730
+ "RelationshipTemplateReferenceString": {
6731
+ "type": "string",
6732
+ "pattern": "UkxU.{84}"
4816
6733
  }
4817
6734
  }
4818
6735
  };
@@ -4852,25 +6769,6 @@ exports.SyncDatawalletRequest = {
4852
6769
  }
4853
6770
  }
4854
6771
  };
4855
- exports.DownloadFileRequest = {
4856
- "$schema": "http://json-schema.org/draft-07/schema#",
4857
- "$ref": "#/definitions/DownloadFileRequest",
4858
- "definitions": {
4859
- "DownloadFileRequest": {
4860
- "type": "object",
4861
- "properties": {
4862
- "id": {
4863
- "type": "string",
4864
- "pattern": "FIL[A-Za-z0-9]{17}"
4865
- }
4866
- },
4867
- "required": [
4868
- "id"
4869
- ],
4870
- "additionalProperties": false
4871
- }
4872
- }
4873
- };
4874
6772
  exports.DownloadAttachmentRequest = {
4875
6773
  "$schema": "http://json-schema.org/draft-07/schema#",
4876
6774
  "$ref": "#/definitions/DownloadAttachmentRequest",
@@ -4879,10 +6777,10 @@ exports.DownloadAttachmentRequest = {
4879
6777
  "type": "object",
4880
6778
  "properties": {
4881
6779
  "id": {
4882
- "type": "string"
6780
+ "$ref": "#/definitions/MessageIdString"
4883
6781
  },
4884
6782
  "attachmentId": {
4885
- "type": "string"
6783
+ "$ref": "#/definitions/FileIdString"
4886
6784
  }
4887
6785
  },
4888
6786
  "required": [
@@ -4890,6 +6788,14 @@ exports.DownloadAttachmentRequest = {
4890
6788
  "attachmentId"
4891
6789
  ],
4892
6790
  "additionalProperties": false
6791
+ },
6792
+ "MessageIdString": {
6793
+ "type": "string",
6794
+ "pattern": "MSG[A-Za-z0-9]{17}"
6795
+ },
6796
+ "FileIdString": {
6797
+ "type": "string",
6798
+ "pattern": "FIL[A-Za-z0-9]{17}"
4893
6799
  }
4894
6800
  }
4895
6801
  };
@@ -4915,8 +6821,7 @@ exports.CreateRelationshipChallengeRequest = {
4915
6821
  "const": "Relationship"
4916
6822
  },
4917
6823
  "relationship": {
4918
- "type": "string",
4919
- "pattern": "REL[A-Za-z0-9]{17}"
6824
+ "$ref": "#/definitions/RelationshipIdString"
4920
6825
  }
4921
6826
  },
4922
6827
  "required": [
@@ -4924,6 +6829,10 @@ exports.CreateRelationshipChallengeRequest = {
4924
6829
  "relationship"
4925
6830
  ],
4926
6831
  "additionalProperties": false
6832
+ },
6833
+ "RelationshipIdString": {
6834
+ "type": "string",
6835
+ "pattern": "REL[A-Za-z0-9]{17}"
4927
6836
  }
4928
6837
  }
4929
6838
  };
@@ -4990,8 +6899,7 @@ exports.CreateChallengeRequest = {
4990
6899
  "const": "Relationship"
4991
6900
  },
4992
6901
  "relationship": {
4993
- "type": "string",
4994
- "pattern": "REL[A-Za-z0-9]{17}"
6902
+ "$ref": "#/definitions/RelationshipIdString"
4995
6903
  }
4996
6904
  },
4997
6905
  "required": [
@@ -5000,6 +6908,10 @@ exports.CreateChallengeRequest = {
5000
6908
  ],
5001
6909
  "additionalProperties": false
5002
6910
  },
6911
+ "RelationshipIdString": {
6912
+ "type": "string",
6913
+ "pattern": "REL[A-Za-z0-9]{17}"
6914
+ },
5003
6915
  "CreateIdentityChallengeRequest": {
5004
6916
  "type": "object",
5005
6917
  "properties": {
@@ -5079,16 +6991,24 @@ exports.CreateDeviceOnboardingTokenRequest = {
5079
6991
  "type": "object",
5080
6992
  "properties": {
5081
6993
  "id": {
5082
- "type": "string"
6994
+ "$ref": "#/definitions/DeviceIdString"
5083
6995
  },
5084
6996
  "expiresAt": {
5085
- "type": "string"
6997
+ "$ref": "#/definitions/DateTimeString"
5086
6998
  }
5087
6999
  },
5088
7000
  "required": [
5089
7001
  "id"
5090
7002
  ],
5091
7003
  "additionalProperties": false
7004
+ },
7005
+ "DeviceIdString": {
7006
+ "type": "string",
7007
+ "pattern": "DVC[A-Za-z0-9]{17}"
7008
+ },
7009
+ "DateTimeString": {
7010
+ "type": "string",
7011
+ "format": "date-time"
5092
7012
  }
5093
7013
  }
5094
7014
  };
@@ -5100,13 +7020,17 @@ exports.DeleteDeviceRequest = {
5100
7020
  "type": "object",
5101
7021
  "properties": {
5102
7022
  "id": {
5103
- "type": "string"
7023
+ "$ref": "#/definitions/DeviceIdString"
5104
7024
  }
5105
7025
  },
5106
7026
  "required": [
5107
7027
  "id"
5108
7028
  ],
5109
7029
  "additionalProperties": false
7030
+ },
7031
+ "DeviceIdString": {
7032
+ "type": "string",
7033
+ "pattern": "DVC[A-Za-z0-9]{17}"
5110
7034
  }
5111
7035
  }
5112
7036
  };
@@ -5118,13 +7042,17 @@ exports.GetDeviceRequest = {
5118
7042
  "type": "object",
5119
7043
  "properties": {
5120
7044
  "id": {
5121
- "type": "string"
7045
+ "$ref": "#/definitions/DeviceIdString"
5122
7046
  }
5123
7047
  },
5124
7048
  "required": [
5125
7049
  "id"
5126
7050
  ],
5127
7051
  "additionalProperties": false
7052
+ },
7053
+ "DeviceIdString": {
7054
+ "type": "string",
7055
+ "pattern": "DVC[A-Za-z0-9]{17}"
5128
7056
  }
5129
7057
  }
5130
7058
  };
@@ -5136,13 +7064,17 @@ exports.GetDeviceOnboardingInfoRequest = {
5136
7064
  "type": "object",
5137
7065
  "properties": {
5138
7066
  "id": {
5139
- "type": "string"
7067
+ "$ref": "#/definitions/GenericIdString"
5140
7068
  }
5141
7069
  },
5142
7070
  "required": [
5143
7071
  "id"
5144
7072
  ],
5145
7073
  "additionalProperties": false
7074
+ },
7075
+ "GenericIdString": {
7076
+ "type": "string",
7077
+ "pattern": "[A-Za-z0-9]{20}"
5146
7078
  }
5147
7079
  }
5148
7080
  };
@@ -5154,7 +7086,7 @@ exports.UpdateDeviceRequest = {
5154
7086
  "type": "object",
5155
7087
  "properties": {
5156
7088
  "id": {
5157
- "type": "string"
7089
+ "$ref": "#/definitions/DeviceIdString"
5158
7090
  },
5159
7091
  "name": {
5160
7092
  "type": "string"
@@ -5167,6 +7099,10 @@ exports.UpdateDeviceRequest = {
5167
7099
  "id"
5168
7100
  ],
5169
7101
  "additionalProperties": false
7102
+ },
7103
+ "DeviceIdString": {
7104
+ "type": "string",
7105
+ "pattern": "DVC[A-Za-z0-9]{17}"
5170
7106
  }
5171
7107
  }
5172
7108
  };
@@ -5178,14 +7114,17 @@ exports.CreateQrCodeForFileRequest = {
5178
7114
  "type": "object",
5179
7115
  "properties": {
5180
7116
  "fileId": {
5181
- "type": "string",
5182
- "pattern": "FIL[A-Za-z0-9]{17}"
7117
+ "$ref": "#/definitions/FileIdString"
5183
7118
  }
5184
7119
  },
5185
7120
  "required": [
5186
7121
  "fileId"
5187
7122
  ],
5188
7123
  "additionalProperties": false
7124
+ },
7125
+ "FileIdString": {
7126
+ "type": "string",
7127
+ "pattern": "FIL[A-Za-z0-9]{17}"
5189
7128
  }
5190
7129
  }
5191
7130
  };
@@ -5197,12 +7136,10 @@ exports.CreateTokenForFileRequest = {
5197
7136
  "type": "object",
5198
7137
  "properties": {
5199
7138
  "fileId": {
5200
- "type": "string",
5201
- "pattern": "FIL[A-Za-z0-9]{17}"
7139
+ "$ref": "#/definitions/FileIdString"
5202
7140
  },
5203
7141
  "expiresAt": {
5204
- "type": "string",
5205
- "format": "date-time"
7142
+ "$ref": "#/definitions/DateTimeString"
5206
7143
  },
5207
7144
  "ephemeral": {
5208
7145
  "type": "boolean"
@@ -5212,6 +7149,14 @@ exports.CreateTokenForFileRequest = {
5212
7149
  "fileId"
5213
7150
  ],
5214
7151
  "additionalProperties": false
7152
+ },
7153
+ "FileIdString": {
7154
+ "type": "string",
7155
+ "pattern": "FIL[A-Za-z0-9]{17}"
7156
+ },
7157
+ "DateTimeString": {
7158
+ "type": "string",
7159
+ "format": "date-time"
5215
7160
  }
5216
7161
  }
5217
7162
  };
@@ -5223,18 +7168,24 @@ exports.CreateTokenQrCodeForFileRequest = {
5223
7168
  "type": "object",
5224
7169
  "properties": {
5225
7170
  "fileId": {
5226
- "type": "string",
5227
- "pattern": "FIL[A-Za-z0-9]{17}"
7171
+ "$ref": "#/definitions/FileIdString"
5228
7172
  },
5229
7173
  "expiresAt": {
5230
- "type": "string",
5231
- "format": "date-time"
7174
+ "$ref": "#/definitions/DateTimeString"
5232
7175
  }
5233
7176
  },
5234
7177
  "required": [
5235
7178
  "fileId"
5236
7179
  ],
5237
7180
  "additionalProperties": false
7181
+ },
7182
+ "FileIdString": {
7183
+ "type": "string",
7184
+ "pattern": "FIL[A-Za-z0-9]{17}"
7185
+ },
7186
+ "DateTimeString": {
7187
+ "type": "string",
7188
+ "format": "date-time"
5238
7189
  }
5239
7190
  }
5240
7191
  };
@@ -5246,14 +7197,17 @@ exports.GetFileRequest = {
5246
7197
  "type": "object",
5247
7198
  "properties": {
5248
7199
  "id": {
5249
- "type": "string",
5250
- "pattern": "FIL[A-Za-z0-9]{17}"
7200
+ "$ref": "#/definitions/FileIdString"
5251
7201
  }
5252
7202
  },
5253
7203
  "required": [
5254
7204
  "id"
5255
7205
  ],
5256
7206
  "additionalProperties": false
7207
+ },
7208
+ "FileIdString": {
7209
+ "type": "string",
7210
+ "pattern": "FIL[A-Za-z0-9]{17}"
5257
7211
  }
5258
7212
  }
5259
7213
  };
@@ -5418,16 +7372,15 @@ exports.GetFilesRequest = {
5418
7372
  }
5419
7373
  }
5420
7374
  };
5421
- exports.LoadPeerFileViaSecretRequest = {
7375
+ exports.GetOrLoadFileViaSecretRequest = {
5422
7376
  "$schema": "http://json-schema.org/draft-07/schema#",
5423
- "$ref": "#/definitions/LoadPeerFileViaSecretRequest",
7377
+ "$ref": "#/definitions/GetOrLoadFileViaSecretRequest",
5424
7378
  "definitions": {
5425
- "LoadPeerFileViaSecretRequest": {
7379
+ "GetOrLoadFileViaSecretRequest": {
5426
7380
  "type": "object",
5427
7381
  "properties": {
5428
7382
  "id": {
5429
- "type": "string",
5430
- "pattern": "FIL[A-Za-z0-9]{17}"
7383
+ "$ref": "#/definitions/FileIdString"
5431
7384
  },
5432
7385
  "secretKey": {
5433
7386
  "type": "string",
@@ -5439,19 +7392,29 @@ exports.LoadPeerFileViaSecretRequest = {
5439
7392
  "secretKey"
5440
7393
  ],
5441
7394
  "additionalProperties": false
7395
+ },
7396
+ "FileIdString": {
7397
+ "type": "string",
7398
+ "pattern": "FIL[A-Za-z0-9]{17}"
5442
7399
  }
5443
7400
  }
5444
7401
  };
5445
- exports.LoadPeerFileViaReferenceRequest = {
7402
+ exports.GetOrLoadFileViaReferenceRequest = {
5446
7403
  "$schema": "http://json-schema.org/draft-07/schema#",
5447
- "$ref": "#/definitions/LoadPeerFileViaReferenceRequest",
7404
+ "$ref": "#/definitions/GetOrLoadFileViaReferenceRequest",
5448
7405
  "definitions": {
5449
- "LoadPeerFileViaReferenceRequest": {
7406
+ "GetOrLoadFileViaReferenceRequest": {
5450
7407
  "type": "object",
5451
7408
  "properties": {
5452
7409
  "reference": {
5453
- "type": "string",
5454
- "pattern": "(VE9L|RklM).{84}"
7410
+ "anyOf": [
7411
+ {
7412
+ "$ref": "#/definitions/TokenReferenceString"
7413
+ },
7414
+ {
7415
+ "$ref": "#/definitions/FileReferenceString"
7416
+ }
7417
+ ]
5455
7418
  }
5456
7419
  },
5457
7420
  "required": [
@@ -5459,29 +7422,36 @@ exports.LoadPeerFileViaReferenceRequest = {
5459
7422
  ],
5460
7423
  "additionalProperties": false,
5461
7424
  "errorMessage": "token / file reference invalid"
7425
+ },
7426
+ "TokenReferenceString": {
7427
+ "type": "string",
7428
+ "pattern": "VE9L.{84}"
7429
+ },
7430
+ "FileReferenceString": {
7431
+ "type": "string",
7432
+ "pattern": "RklM.{84}"
5462
7433
  }
5463
7434
  }
5464
7435
  };
5465
- exports.LoadPeerFileRequest = {
7436
+ exports.GetOrLoadFileRequest = {
5466
7437
  "$schema": "http://json-schema.org/draft-07/schema#",
5467
- "$ref": "#/definitions/LoadPeerFileRequest",
7438
+ "$ref": "#/definitions/GetOrLoadFileRequest",
5468
7439
  "definitions": {
5469
- "LoadPeerFileRequest": {
7440
+ "GetOrLoadFileRequest": {
5470
7441
  "anyOf": [
5471
7442
  {
5472
- "$ref": "#/definitions/LoadPeerFileViaSecretRequest"
7443
+ "$ref": "#/definitions/GetOrLoadFileViaSecretRequest"
5473
7444
  },
5474
7445
  {
5475
- "$ref": "#/definitions/LoadPeerFileViaReferenceRequest"
7446
+ "$ref": "#/definitions/GetOrLoadFileViaReferenceRequest"
5476
7447
  }
5477
7448
  ]
5478
7449
  },
5479
- "LoadPeerFileViaSecretRequest": {
7450
+ "GetOrLoadFileViaSecretRequest": {
5480
7451
  "type": "object",
5481
7452
  "properties": {
5482
7453
  "id": {
5483
- "type": "string",
5484
- "pattern": "FIL[A-Za-z0-9]{17}"
7454
+ "$ref": "#/definitions/FileIdString"
5485
7455
  },
5486
7456
  "secretKey": {
5487
7457
  "type": "string",
@@ -5494,12 +7464,22 @@ exports.LoadPeerFileRequest = {
5494
7464
  ],
5495
7465
  "additionalProperties": false
5496
7466
  },
5497
- "LoadPeerFileViaReferenceRequest": {
7467
+ "FileIdString": {
7468
+ "type": "string",
7469
+ "pattern": "FIL[A-Za-z0-9]{17}"
7470
+ },
7471
+ "GetOrLoadFileViaReferenceRequest": {
5498
7472
  "type": "object",
5499
7473
  "properties": {
5500
7474
  "reference": {
5501
- "type": "string",
5502
- "pattern": "(VE9L|RklM).{84}"
7475
+ "anyOf": [
7476
+ {
7477
+ "$ref": "#/definitions/TokenReferenceString"
7478
+ },
7479
+ {
7480
+ "$ref": "#/definitions/FileReferenceString"
7481
+ }
7482
+ ]
5503
7483
  }
5504
7484
  },
5505
7485
  "required": [
@@ -5507,6 +7487,14 @@ exports.LoadPeerFileRequest = {
5507
7487
  ],
5508
7488
  "additionalProperties": false,
5509
7489
  "errorMessage": "token / file reference invalid"
7490
+ },
7491
+ "TokenReferenceString": {
7492
+ "type": "string",
7493
+ "pattern": "VE9L.{84}"
7494
+ },
7495
+ "FileReferenceString": {
7496
+ "type": "string",
7497
+ "pattern": "RklM.{84}"
5510
7498
  }
5511
7499
  }
5512
7500
  };
@@ -5563,7 +7551,7 @@ exports.UploadOwnFileRequest = {
5563
7551
  "type": "string"
5564
7552
  },
5565
7553
  "expiresAt": {
5566
- "type": "string"
7554
+ "$ref": "#/definitions/DateTimeString"
5567
7555
  },
5568
7556
  "title": {
5569
7557
  "type": "string"
@@ -5580,6 +7568,51 @@ exports.UploadOwnFileRequest = {
5580
7568
  "title"
5581
7569
  ],
5582
7570
  "additionalProperties": false
7571
+ },
7572
+ "DateTimeString": {
7573
+ "type": "string",
7574
+ "format": "date-time"
7575
+ }
7576
+ }
7577
+ };
7578
+ exports.UploadOwnFileValidatableRequest = {
7579
+ "$schema": "http://json-schema.org/draft-07/schema#",
7580
+ "$ref": "#/definitions/UploadOwnFileValidatableRequest",
7581
+ "definitions": {
7582
+ "UploadOwnFileValidatableRequest": {
7583
+ "type": "object",
7584
+ "properties": {
7585
+ "filename": {
7586
+ "type": "string"
7587
+ },
7588
+ "mimetype": {
7589
+ "type": "string"
7590
+ },
7591
+ "expiresAt": {
7592
+ "$ref": "#/definitions/DateTimeString"
7593
+ },
7594
+ "title": {
7595
+ "type": "string"
7596
+ },
7597
+ "description": {
7598
+ "type": "string"
7599
+ },
7600
+ "content": {
7601
+ "type": "object"
7602
+ }
7603
+ },
7604
+ "required": [
7605
+ "content",
7606
+ "expiresAt",
7607
+ "filename",
7608
+ "mimetype",
7609
+ "title"
7610
+ ],
7611
+ "additionalProperties": false
7612
+ },
7613
+ "DateTimeString": {
7614
+ "type": "string",
7615
+ "format": "date-time"
5583
7616
  }
5584
7617
  }
5585
7618
  };
@@ -5591,13 +7624,17 @@ exports.CheckIdentityRequest = {
5591
7624
  "type": "object",
5592
7625
  "properties": {
5593
7626
  "address": {
5594
- "type": "string"
7627
+ "$ref": "#/definitions/AddressString"
5595
7628
  }
5596
7629
  },
5597
7630
  "required": [
5598
7631
  "address"
5599
7632
  ],
5600
7633
  "additionalProperties": false
7634
+ },
7635
+ "AddressString": {
7636
+ "type": "string",
7637
+ "pattern": "id1[A-Za-z0-9]{32,33}"
5601
7638
  }
5602
7639
  }
5603
7640
  };
@@ -5609,10 +7646,10 @@ exports.GetAttachmentMetadataRequest = {
5609
7646
  "type": "object",
5610
7647
  "properties": {
5611
7648
  "id": {
5612
- "type": "string"
7649
+ "$ref": "#/definitions/MessageIdString"
5613
7650
  },
5614
7651
  "attachmentId": {
5615
- "type": "string"
7652
+ "$ref": "#/definitions/FileIdString"
5616
7653
  }
5617
7654
  },
5618
7655
  "required": [
@@ -5620,6 +7657,14 @@ exports.GetAttachmentMetadataRequest = {
5620
7657
  "attachmentId"
5621
7658
  ],
5622
7659
  "additionalProperties": false
7660
+ },
7661
+ "MessageIdString": {
7662
+ "type": "string",
7663
+ "pattern": "MSG[A-Za-z0-9]{17}"
7664
+ },
7665
+ "FileIdString": {
7666
+ "type": "string",
7667
+ "pattern": "FIL[A-Za-z0-9]{17}"
5623
7668
  }
5624
7669
  }
5625
7670
  };
@@ -5631,13 +7676,17 @@ exports.GetMessageRequest = {
5631
7676
  "type": "object",
5632
7677
  "properties": {
5633
7678
  "id": {
5634
- "type": "string"
7679
+ "$ref": "#/definitions/MessageIdString"
5635
7680
  }
5636
7681
  },
5637
7682
  "required": [
5638
7683
  "id"
5639
7684
  ],
5640
7685
  "additionalProperties": false
7686
+ },
7687
+ "MessageIdString": {
7688
+ "type": "string",
7689
+ "pattern": "MSG[A-Za-z0-9]{17}"
5641
7690
  }
5642
7691
  }
5643
7692
  };
@@ -5664,14 +7713,15 @@ exports.SendMessageRequest = {
5664
7713
  "recipients": {
5665
7714
  "type": "array",
5666
7715
  "items": {
5667
- "type": "string"
5668
- }
7716
+ "$ref": "#/definitions/AddressString"
7717
+ },
7718
+ "minItems": 1
5669
7719
  },
5670
7720
  "content": {},
5671
7721
  "attachments": {
5672
7722
  "type": "array",
5673
7723
  "items": {
5674
- "type": "string"
7724
+ "$ref": "#/definitions/FileIdString"
5675
7725
  }
5676
7726
  }
5677
7727
  },
@@ -5680,6 +7730,14 @@ exports.SendMessageRequest = {
5680
7730
  "content"
5681
7731
  ],
5682
7732
  "additionalProperties": false
7733
+ },
7734
+ "AddressString": {
7735
+ "type": "string",
7736
+ "pattern": "id1[A-Za-z0-9]{32,33}"
7737
+ },
7738
+ "FileIdString": {
7739
+ "type": "string",
7740
+ "pattern": "FIL[A-Za-z0-9]{17}"
5683
7741
  }
5684
7742
  }
5685
7743
  };
@@ -5691,10 +7749,10 @@ exports.AcceptRelationshipChangeRequest = {
5691
7749
  "type": "object",
5692
7750
  "properties": {
5693
7751
  "relationshipId": {
5694
- "type": "string"
7752
+ "$ref": "#/definitions/RelationshipIdString"
5695
7753
  },
5696
7754
  "changeId": {
5697
- "type": "string"
7755
+ "$ref": "#/definitions/RelationshipChangeIdString"
5698
7756
  },
5699
7757
  "content": {}
5700
7758
  },
@@ -5704,6 +7762,14 @@ exports.AcceptRelationshipChangeRequest = {
5704
7762
  "content"
5705
7763
  ],
5706
7764
  "additionalProperties": false
7765
+ },
7766
+ "RelationshipIdString": {
7767
+ "type": "string",
7768
+ "pattern": "REL[A-Za-z0-9]{17}"
7769
+ },
7770
+ "RelationshipChangeIdString": {
7771
+ "type": "string",
7772
+ "pattern": "RCH[A-Za-z0-9]{17}"
5707
7773
  }
5708
7774
  }
5709
7775
  };
@@ -5715,7 +7781,7 @@ exports.CreateRelationshipRequest = {
5715
7781
  "type": "object",
5716
7782
  "properties": {
5717
7783
  "templateId": {
5718
- "type": "string"
7784
+ "$ref": "#/definitions/RelationshipTemplateIdString"
5719
7785
  },
5720
7786
  "content": {}
5721
7787
  },
@@ -5724,6 +7790,10 @@ exports.CreateRelationshipRequest = {
5724
7790
  "content"
5725
7791
  ],
5726
7792
  "additionalProperties": false
7793
+ },
7794
+ "RelationshipTemplateIdString": {
7795
+ "type": "string",
7796
+ "pattern": "RLT[A-Za-z0-9]{17}"
5727
7797
  }
5728
7798
  }
5729
7799
  };
@@ -5735,7 +7805,7 @@ exports.CreateRelationshipChangeRequest = {
5735
7805
  "type": "object",
5736
7806
  "properties": {
5737
7807
  "id": {
5738
- "type": "string"
7808
+ "$ref": "#/definitions/RelationshipIdString"
5739
7809
  },
5740
7810
  "content": {}
5741
7811
  },
@@ -5743,6 +7813,10 @@ exports.CreateRelationshipChangeRequest = {
5743
7813
  "id"
5744
7814
  ],
5745
7815
  "additionalProperties": false
7816
+ },
7817
+ "RelationshipIdString": {
7818
+ "type": "string",
7819
+ "pattern": "REL[A-Za-z0-9]{17}"
5746
7820
  }
5747
7821
  }
5748
7822
  };
@@ -5754,13 +7828,17 @@ exports.GetAttributesForRelationshipRequest = {
5754
7828
  "type": "object",
5755
7829
  "properties": {
5756
7830
  "id": {
5757
- "type": "string"
7831
+ "$ref": "#/definitions/RelationshipIdString"
5758
7832
  }
5759
7833
  },
5760
7834
  "required": [
5761
7835
  "id"
5762
7836
  ],
5763
7837
  "additionalProperties": false
7838
+ },
7839
+ "RelationshipIdString": {
7840
+ "type": "string",
7841
+ "pattern": "REL[A-Za-z0-9]{17}"
5764
7842
  }
5765
7843
  }
5766
7844
  };
@@ -5772,13 +7850,17 @@ exports.GetRelationshipRequest = {
5772
7850
  "type": "object",
5773
7851
  "properties": {
5774
7852
  "id": {
5775
- "type": "string"
7853
+ "$ref": "#/definitions/RelationshipIdString"
5776
7854
  }
5777
7855
  },
5778
7856
  "required": [
5779
7857
  "id"
5780
7858
  ],
5781
7859
  "additionalProperties": false
7860
+ },
7861
+ "RelationshipIdString": {
7862
+ "type": "string",
7863
+ "pattern": "REL[A-Za-z0-9]{17}"
5782
7864
  }
5783
7865
  }
5784
7866
  };
@@ -5790,13 +7872,17 @@ exports.GetRelationshipByAddressRequest = {
5790
7872
  "type": "object",
5791
7873
  "properties": {
5792
7874
  "address": {
5793
- "type": "string"
7875
+ "$ref": "#/definitions/AddressString"
5794
7876
  }
5795
7877
  },
5796
7878
  "required": [
5797
7879
  "address"
5798
7880
  ],
5799
7881
  "additionalProperties": false
7882
+ },
7883
+ "AddressString": {
7884
+ "type": "string",
7885
+ "pattern": "id1[A-Za-z0-9]{32,33}"
5800
7886
  }
5801
7887
  }
5802
7888
  };
@@ -5868,10 +7954,10 @@ exports.RejectRelationshipChangeRequest = {
5868
7954
  "type": "object",
5869
7955
  "properties": {
5870
7956
  "relationshipId": {
5871
- "type": "string"
7957
+ "$ref": "#/definitions/RelationshipIdString"
5872
7958
  },
5873
7959
  "changeId": {
5874
- "type": "string"
7960
+ "$ref": "#/definitions/RelationshipChangeIdString"
5875
7961
  },
5876
7962
  "content": {}
5877
7963
  },
@@ -5881,6 +7967,14 @@ exports.RejectRelationshipChangeRequest = {
5881
7967
  "content"
5882
7968
  ],
5883
7969
  "additionalProperties": false
7970
+ },
7971
+ "RelationshipIdString": {
7972
+ "type": "string",
7973
+ "pattern": "REL[A-Za-z0-9]{17}"
7974
+ },
7975
+ "RelationshipChangeIdString": {
7976
+ "type": "string",
7977
+ "pattern": "RCH[A-Za-z0-9]{17}"
5884
7978
  }
5885
7979
  }
5886
7980
  };
@@ -5892,10 +7986,10 @@ exports.RevokeRelationshipChangeRequest = {
5892
7986
  "type": "object",
5893
7987
  "properties": {
5894
7988
  "relationshipId": {
5895
- "type": "string"
7989
+ "$ref": "#/definitions/RelationshipIdString"
5896
7990
  },
5897
7991
  "changeId": {
5898
- "type": "string"
7992
+ "$ref": "#/definitions/RelationshipChangeIdString"
5899
7993
  },
5900
7994
  "content": {}
5901
7995
  },
@@ -5905,6 +7999,14 @@ exports.RevokeRelationshipChangeRequest = {
5905
7999
  "content"
5906
8000
  ],
5907
8001
  "additionalProperties": false
8002
+ },
8003
+ "RelationshipIdString": {
8004
+ "type": "string",
8005
+ "pattern": "REL[A-Za-z0-9]{17}"
8006
+ },
8007
+ "RelationshipChangeIdString": {
8008
+ "type": "string",
8009
+ "pattern": "RCH[A-Za-z0-9]{17}"
5908
8010
  }
5909
8011
  }
5910
8012
  };
@@ -5916,15 +8018,17 @@ exports.CreateOwnRelationshipTemplateRequest = {
5916
8018
  "type": "object",
5917
8019
  "properties": {
5918
8020
  "expiresAt": {
5919
- "type": "string"
8021
+ "$ref": "#/definitions/DateTimeString"
5920
8022
  },
5921
8023
  "content": {},
5922
8024
  "maxNumberOfAllocations": {
5923
- "type": "number"
8025
+ "type": "number",
8026
+ "minimum": 1
5924
8027
  },
5925
8028
  "maxNumberOfRelationships": {
5926
8029
  "type": "number",
5927
- "deprecated": "use `maxNumberOfAllocations` instead"
8030
+ "deprecated": "use `maxNumberOfAllocations` instead",
8031
+ "minimum": 1
5928
8032
  }
5929
8033
  },
5930
8034
  "required": [
@@ -5932,6 +8036,10 @@ exports.CreateOwnRelationshipTemplateRequest = {
5932
8036
  "content"
5933
8037
  ],
5934
8038
  "additionalProperties": false
8039
+ },
8040
+ "DateTimeString": {
8041
+ "type": "string",
8042
+ "format": "date-time"
5935
8043
  }
5936
8044
  }
5937
8045
  };
@@ -5943,13 +8051,17 @@ exports.CreateQrCodeForOwnTemplateRequest = {
5943
8051
  "type": "object",
5944
8052
  "properties": {
5945
8053
  "templateId": {
5946
- "type": "string"
8054
+ "$ref": "#/definitions/RelationshipTemplateIdString"
5947
8055
  }
5948
8056
  },
5949
8057
  "required": [
5950
8058
  "templateId"
5951
8059
  ],
5952
8060
  "additionalProperties": false
8061
+ },
8062
+ "RelationshipTemplateIdString": {
8063
+ "type": "string",
8064
+ "pattern": "RLT[A-Za-z0-9]{17}"
5953
8065
  }
5954
8066
  }
5955
8067
  };
@@ -5961,10 +8073,10 @@ exports.CreateTokenForOwnTemplateRequest = {
5961
8073
  "type": "object",
5962
8074
  "properties": {
5963
8075
  "templateId": {
5964
- "type": "string"
8076
+ "$ref": "#/definitions/RelationshipTemplateIdString"
5965
8077
  },
5966
8078
  "expiresAt": {
5967
- "type": "string"
8079
+ "$ref": "#/definitions/DateTimeString"
5968
8080
  },
5969
8081
  "ephemeral": {
5970
8082
  "type": "boolean"
@@ -5974,6 +8086,14 @@ exports.CreateTokenForOwnTemplateRequest = {
5974
8086
  "templateId"
5975
8087
  ],
5976
8088
  "additionalProperties": false
8089
+ },
8090
+ "RelationshipTemplateIdString": {
8091
+ "type": "string",
8092
+ "pattern": "RLT[A-Za-z0-9]{17}"
8093
+ },
8094
+ "DateTimeString": {
8095
+ "type": "string",
8096
+ "format": "date-time"
5977
8097
  }
5978
8098
  }
5979
8099
  };
@@ -5985,16 +8105,24 @@ exports.CreateTokenQrCodeForOwnTemplateRequest = {
5985
8105
  "type": "object",
5986
8106
  "properties": {
5987
8107
  "templateId": {
5988
- "type": "string"
8108
+ "$ref": "#/definitions/RelationshipTemplateIdString"
5989
8109
  },
5990
8110
  "expiresAt": {
5991
- "type": "string"
8111
+ "$ref": "#/definitions/DateTimeString"
5992
8112
  }
5993
8113
  },
5994
8114
  "required": [
5995
8115
  "templateId"
5996
8116
  ],
5997
8117
  "additionalProperties": false
8118
+ },
8119
+ "RelationshipTemplateIdString": {
8120
+ "type": "string",
8121
+ "pattern": "RLT[A-Za-z0-9]{17}"
8122
+ },
8123
+ "DateTimeString": {
8124
+ "type": "string",
8125
+ "format": "date-time"
5998
8126
  }
5999
8127
  }
6000
8128
  };
@@ -6006,13 +8134,17 @@ exports.GetRelationshipTemplateRequest = {
6006
8134
  "type": "object",
6007
8135
  "properties": {
6008
8136
  "id": {
6009
- "type": "string"
8137
+ "$ref": "#/definitions/RelationshipTemplateIdString"
6010
8138
  }
6011
8139
  },
6012
8140
  "required": [
6013
8141
  "id"
6014
8142
  ],
6015
8143
  "additionalProperties": false
8144
+ },
8145
+ "RelationshipTemplateIdString": {
8146
+ "type": "string",
8147
+ "pattern": "RLT[A-Za-z0-9]{17}"
6016
8148
  }
6017
8149
  }
6018
8150
  };
@@ -6047,8 +8179,7 @@ exports.LoadPeerRelationshipTemplateViaSecretRequest = {
6047
8179
  "type": "object",
6048
8180
  "properties": {
6049
8181
  "id": {
6050
- "type": "string",
6051
- "pattern": "RLT[A-Za-z0-9]{17}"
8182
+ "$ref": "#/definitions/RelationshipTemplateIdString"
6052
8183
  },
6053
8184
  "secretKey": {
6054
8185
  "type": "string",
@@ -6060,6 +8191,10 @@ exports.LoadPeerRelationshipTemplateViaSecretRequest = {
6060
8191
  "secretKey"
6061
8192
  ],
6062
8193
  "additionalProperties": false
8194
+ },
8195
+ "RelationshipTemplateIdString": {
8196
+ "type": "string",
8197
+ "pattern": "RLT[A-Za-z0-9]{17}"
6063
8198
  }
6064
8199
  }
6065
8200
  };
@@ -6071,8 +8206,14 @@ exports.LoadPeerRelationshipTemplateViaReferenceRequest = {
6071
8206
  "type": "object",
6072
8207
  "properties": {
6073
8208
  "reference": {
6074
- "type": "string",
6075
- "pattern": "(VE9L|UkxU).{84}"
8209
+ "anyOf": [
8210
+ {
8211
+ "$ref": "#/definitions/TokenReferenceString"
8212
+ },
8213
+ {
8214
+ "$ref": "#/definitions/RelationshipTemplateReferenceString"
8215
+ }
8216
+ ]
6076
8217
  }
6077
8218
  },
6078
8219
  "required": [
@@ -6080,6 +8221,14 @@ exports.LoadPeerRelationshipTemplateViaReferenceRequest = {
6080
8221
  ],
6081
8222
  "additionalProperties": false,
6082
8223
  "errorMessage": "token / relationship template reference invalid"
8224
+ },
8225
+ "TokenReferenceString": {
8226
+ "type": "string",
8227
+ "pattern": "VE9L.{84}"
8228
+ },
8229
+ "RelationshipTemplateReferenceString": {
8230
+ "type": "string",
8231
+ "pattern": "UkxU.{84}"
6083
8232
  }
6084
8233
  }
6085
8234
  };
@@ -6101,8 +8250,7 @@ exports.LoadPeerRelationshipTemplateRequest = {
6101
8250
  "type": "object",
6102
8251
  "properties": {
6103
8252
  "id": {
6104
- "type": "string",
6105
- "pattern": "RLT[A-Za-z0-9]{17}"
8253
+ "$ref": "#/definitions/RelationshipTemplateIdString"
6106
8254
  },
6107
8255
  "secretKey": {
6108
8256
  "type": "string",
@@ -6115,12 +8263,22 @@ exports.LoadPeerRelationshipTemplateRequest = {
6115
8263
  ],
6116
8264
  "additionalProperties": false
6117
8265
  },
8266
+ "RelationshipTemplateIdString": {
8267
+ "type": "string",
8268
+ "pattern": "RLT[A-Za-z0-9]{17}"
8269
+ },
6118
8270
  "LoadPeerRelationshipTemplateViaReferenceRequest": {
6119
8271
  "type": "object",
6120
8272
  "properties": {
6121
8273
  "reference": {
6122
- "type": "string",
6123
- "pattern": "(VE9L|UkxU).{84}"
8274
+ "anyOf": [
8275
+ {
8276
+ "$ref": "#/definitions/TokenReferenceString"
8277
+ },
8278
+ {
8279
+ "$ref": "#/definitions/RelationshipTemplateReferenceString"
8280
+ }
8281
+ ]
6124
8282
  }
6125
8283
  },
6126
8284
  "required": [
@@ -6128,6 +8286,14 @@ exports.LoadPeerRelationshipTemplateRequest = {
6128
8286
  ],
6129
8287
  "additionalProperties": false,
6130
8288
  "errorMessage": "token / relationship template reference invalid"
8289
+ },
8290
+ "TokenReferenceString": {
8291
+ "type": "string",
8292
+ "pattern": "VE9L.{84}"
8293
+ },
8294
+ "RelationshipTemplateReferenceString": {
8295
+ "type": "string",
8296
+ "pattern": "UkxU.{84}"
6131
8297
  }
6132
8298
  }
6133
8299
  };
@@ -6140,7 +8306,7 @@ exports.CreateOwnTokenRequest = {
6140
8306
  "properties": {
6141
8307
  "content": {},
6142
8308
  "expiresAt": {
6143
- "type": "string"
8309
+ "$ref": "#/definitions/DateTimeString"
6144
8310
  },
6145
8311
  "ephemeral": {
6146
8312
  "type": "boolean"
@@ -6152,6 +8318,10 @@ exports.CreateOwnTokenRequest = {
6152
8318
  "ephemeral"
6153
8319
  ],
6154
8320
  "additionalProperties": false
8321
+ },
8322
+ "DateTimeString": {
8323
+ "type": "string",
8324
+ "format": "date-time"
6155
8325
  }
6156
8326
  }
6157
8327
  };
@@ -6163,13 +8333,17 @@ exports.GetQRCodeForTokenRequest = {
6163
8333
  "type": "object",
6164
8334
  "properties": {
6165
8335
  "id": {
6166
- "type": "string"
8336
+ "$ref": "#/definitions/TokenIdString"
6167
8337
  }
6168
8338
  },
6169
8339
  "required": [
6170
8340
  "id"
6171
8341
  ],
6172
8342
  "additionalProperties": false
8343
+ },
8344
+ "TokenIdString": {
8345
+ "type": "string",
8346
+ "pattern": "TOK[A-Za-z0-9]{17}"
6173
8347
  }
6174
8348
  }
6175
8349
  };
@@ -6181,13 +8355,17 @@ exports.GetTokenRequest = {
6181
8355
  "type": "object",
6182
8356
  "properties": {
6183
8357
  "id": {
6184
- "type": "string"
8358
+ "$ref": "#/definitions/TokenIdString"
6185
8359
  }
6186
8360
  },
6187
8361
  "required": [
6188
8362
  "id"
6189
8363
  ],
6190
8364
  "additionalProperties": false
8365
+ },
8366
+ "TokenIdString": {
8367
+ "type": "string",
8368
+ "pattern": "TOK[A-Za-z0-9]{17}"
6191
8369
  }
6192
8370
  }
6193
8371
  };
@@ -6274,30 +8452,123 @@ exports.GetTokensRequest = {
6274
8452
  }
6275
8453
  }
6276
8454
  };
8455
+ exports.LoadPeerTokenViaReferenceRequest = {
8456
+ "$schema": "http://json-schema.org/draft-07/schema#",
8457
+ "$ref": "#/definitions/LoadPeerTokenViaReferenceRequest",
8458
+ "definitions": {
8459
+ "LoadPeerTokenViaReferenceRequest": {
8460
+ "type": "object",
8461
+ "properties": {
8462
+ "reference": {
8463
+ "$ref": "#/definitions/TokenReferenceString"
8464
+ },
8465
+ "ephemeral": {
8466
+ "type": "boolean"
8467
+ }
8468
+ },
8469
+ "required": [
8470
+ "reference",
8471
+ "ephemeral"
8472
+ ],
8473
+ "additionalProperties": false,
8474
+ "errorMessage": "token reference invalid"
8475
+ },
8476
+ "TokenReferenceString": {
8477
+ "type": "string",
8478
+ "pattern": "VE9L.{84}"
8479
+ }
8480
+ }
8481
+ };
8482
+ exports.LoadPeerTokenViaSecretRequest = {
8483
+ "$schema": "http://json-schema.org/draft-07/schema#",
8484
+ "$ref": "#/definitions/LoadPeerTokenViaSecretRequest",
8485
+ "definitions": {
8486
+ "LoadPeerTokenViaSecretRequest": {
8487
+ "type": "object",
8488
+ "properties": {
8489
+ "id": {
8490
+ "$ref": "#/definitions/TokenIdString"
8491
+ },
8492
+ "secretKey": {
8493
+ "type": "string",
8494
+ "minLength": 10
8495
+ },
8496
+ "ephemeral": {
8497
+ "type": "boolean"
8498
+ }
8499
+ },
8500
+ "required": [
8501
+ "id",
8502
+ "secretKey",
8503
+ "ephemeral"
8504
+ ],
8505
+ "additionalProperties": false
8506
+ },
8507
+ "TokenIdString": {
8508
+ "type": "string",
8509
+ "pattern": "TOK[A-Za-z0-9]{17}"
8510
+ }
8511
+ }
8512
+ };
6277
8513
  exports.LoadPeerTokenRequest = {
6278
8514
  "$schema": "http://json-schema.org/draft-07/schema#",
6279
8515
  "$ref": "#/definitions/LoadPeerTokenRequest",
6280
8516
  "definitions": {
6281
8517
  "LoadPeerTokenRequest": {
8518
+ "anyOf": [
8519
+ {
8520
+ "$ref": "#/definitions/LoadPeerTokenViaReferenceRequest"
8521
+ },
8522
+ {
8523
+ "$ref": "#/definitions/LoadPeerTokenViaSecretRequest"
8524
+ }
8525
+ ]
8526
+ },
8527
+ "LoadPeerTokenViaReferenceRequest": {
8528
+ "type": "object",
8529
+ "properties": {
8530
+ "reference": {
8531
+ "$ref": "#/definitions/TokenReferenceString"
8532
+ },
8533
+ "ephemeral": {
8534
+ "type": "boolean"
8535
+ }
8536
+ },
8537
+ "required": [
8538
+ "reference",
8539
+ "ephemeral"
8540
+ ],
8541
+ "additionalProperties": false,
8542
+ "errorMessage": "token reference invalid"
8543
+ },
8544
+ "TokenReferenceString": {
8545
+ "type": "string",
8546
+ "pattern": "VE9L.{84}"
8547
+ },
8548
+ "LoadPeerTokenViaSecretRequest": {
6282
8549
  "type": "object",
6283
8550
  "properties": {
6284
8551
  "id": {
6285
- "type": "string"
8552
+ "$ref": "#/definitions/TokenIdString"
6286
8553
  },
6287
8554
  "secretKey": {
6288
- "type": "string"
6289
- },
6290
- "reference": {
6291
- "type": "string"
8555
+ "type": "string",
8556
+ "minLength": 10
6292
8557
  },
6293
8558
  "ephemeral": {
6294
8559
  "type": "boolean"
6295
8560
  }
6296
8561
  },
6297
8562
  "required": [
8563
+ "id",
8564
+ "secretKey",
6298
8565
  "ephemeral"
6299
8566
  ],
6300
8567
  "additionalProperties": false
8568
+ },
8569
+ "TokenIdString": {
8570
+ "type": "string",
8571
+ "pattern": "TOK[A-Za-z0-9]{17}"
6301
8572
  }
6302
8573
  }
6303
8574
  };