@breadstone/archipel-mcp 0.0.9 → 0.0.10

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 (565) hide show
  1. package/data/packages/platform-analytics/api/Class.AnalyticsClientPort.md +19 -20
  2. package/data/packages/platform-analytics/api/Class.AnalyticsModule.md +2 -3
  3. package/data/packages/platform-analytics/api/Class.AppInsightsAnalyticsClient.md +21 -22
  4. package/data/packages/platform-analytics/api/Class.DatadogAnalyticsClient.md +21 -22
  5. package/data/packages/platform-analytics/api/Class.NoopAnalyticsClient.md +19 -20
  6. package/data/packages/platform-analytics/api/Class.SentryAnalyticsClient.md +21 -22
  7. package/data/packages/platform-analytics/api/Interface.IAnalyticsBreadcrumb.md +3 -4
  8. package/data/packages/platform-analytics/api/Interface.IAnalyticsModuleOptions.md +2 -3
  9. package/data/packages/platform-analytics/api/Interface.IAnalyticsUser.md +3 -4
  10. package/data/packages/platform-analytics/api/TypeAlias.AnalyticsLevel.md +1 -2
  11. package/data/packages/platform-analytics/api/Variable.APPINSIGHTS_CONFIG_ENTRIES.md +2 -3
  12. package/data/packages/platform-analytics/api/Variable.APPLICATIONINSIGHTS_CONNECTION_STRING.md +1 -2
  13. package/data/packages/platform-analytics/api/Variable.DATADOG_CONFIG_ENTRIES.md +2 -3
  14. package/data/packages/platform-analytics/api/Variable.DD_ENV.md +1 -2
  15. package/data/packages/platform-analytics/api/Variable.DD_SERVICE.md +1 -2
  16. package/data/packages/platform-analytics/api/Variable.SENTRY_CONFIG_ENTRIES.md +2 -3
  17. package/data/packages/platform-analytics/api/Variable.SENTRY_DSN.md +1 -2
  18. package/data/packages/platform-analytics/api/Variable.SENTRY_ENVIRONMENT.md +1 -2
  19. package/data/packages/platform-analytics/api/index.md +25 -26
  20. package/data/packages/platform-authentication/api/Class.AnonymousAuthGuard.md +4 -5
  21. package/data/packages/platform-authentication/api/Class.AppleConnector.md +19 -20
  22. package/data/packages/platform-authentication/api/Class.AuthModule.md +8 -9
  23. package/data/packages/platform-authentication/api/Class.AuthSubjectPort.md +10 -11
  24. package/data/packages/platform-authentication/api/Class.AuthTokenService.md +5 -6
  25. package/data/packages/platform-authentication/api/Class.ChallengeService.md +26 -27
  26. package/data/packages/platform-authentication/api/Class.GithubAuthGuard.md +4 -5
  27. package/data/packages/platform-authentication/api/Class.GithubConnector.md +14 -15
  28. package/data/packages/platform-authentication/api/Class.GoogleConnector.md +14 -15
  29. package/data/packages/platform-authentication/api/Class.JwtAuthGuard.md +4 -5
  30. package/data/packages/platform-authentication/api/Class.JwtPayloadBase.md +15 -16
  31. package/data/packages/platform-authentication/api/Class.LastActiveMiddleware.md +10 -11
  32. package/data/packages/platform-authentication/api/Class.LocalAuthGuard.md +4 -5
  33. package/data/packages/platform-authentication/api/Class.MfaService.md +54 -55
  34. package/data/packages/platform-authentication/api/Class.MfaSubjectPort.md +8 -9
  35. package/data/packages/platform-authentication/api/Class.MicrosoftConnector.md +17 -18
  36. package/data/packages/platform-authentication/api/Class.RolesGuard.md +5 -6
  37. package/data/packages/platform-authentication/api/Class.SessionMappingProfile.md +4 -5
  38. package/data/packages/platform-authentication/api/Class.SessionPersistencePort.md +25 -26
  39. package/data/packages/platform-authentication/api/Class.SessionResponse.md +12 -13
  40. package/data/packages/platform-authentication/api/Class.SessionService.md +33 -34
  41. package/data/packages/platform-authentication/api/Class.SocialAuthGuard.md +5 -6
  42. package/data/packages/platform-authentication/api/Class.SocialAuthPort.md +2 -3
  43. package/data/packages/platform-authentication/api/Class.TokenEnricherPort.md +2 -3
  44. package/data/packages/platform-authentication/api/Class.TotpMfaChannel.md +27 -28
  45. package/data/packages/platform-authentication/api/Class.VerificationService.md +29 -30
  46. package/data/packages/platform-authentication/api/Class.VerificationSubjectPort.md +16 -17
  47. package/data/packages/platform-authentication/api/Function.Token.md +0 -1
  48. package/data/packages/platform-authentication/api/Function.UseRoles.md +2 -3
  49. package/data/packages/platform-authentication/api/Function.socialAuthGuardFactory.md +2 -3
  50. package/data/packages/platform-authentication/api/Interface.IAuthModuleOptions.md +20 -21
  51. package/data/packages/platform-authentication/api/Interface.IAuthSubject.md +7 -8
  52. package/data/packages/platform-authentication/api/Interface.IMfaChallengePayload.md +5 -6
  53. package/data/packages/platform-authentication/api/Interface.IMfaChallengeState.md +10 -11
  54. package/data/packages/platform-authentication/api/Interface.IMfaConfirmation.md +0 -1
  55. package/data/packages/platform-authentication/api/Interface.IMfaSetup.md +3 -4
  56. package/data/packages/platform-authentication/api/Interface.IMfaSubject.md +9 -10
  57. package/data/packages/platform-authentication/api/Interface.IMfaSubjectUpdate.md +7 -8
  58. package/data/packages/platform-authentication/api/Interface.ISessionRecord.md +14 -15
  59. package/data/packages/platform-authentication/api/Interface.ISignInResult.md +5 -6
  60. package/data/packages/platform-authentication/api/Interface.ISocialProfile.md +3 -4
  61. package/data/packages/platform-authentication/api/Interface.IStoreSessionArgs.md +5 -6
  62. package/data/packages/platform-authentication/api/Interface.IVerifiableSubject.md +4 -5
  63. package/data/packages/platform-authentication/api/Variable.APPLE_AUTH_CONFIG_ENTRIES.md +2 -3
  64. package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_CALLBACK_URL.md +2 -3
  65. package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_CLIENT_ID.md +2 -3
  66. package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_KEY_ID.md +2 -3
  67. package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_PRIVATE_KEY.md +2 -3
  68. package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_SCOPE.md +2 -3
  69. package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_TEAM_ID.md +2 -3
  70. package/data/packages/platform-authentication/api/Variable.AUTH_GITHUB_CALLBACK_URL.md +2 -3
  71. package/data/packages/platform-authentication/api/Variable.AUTH_GITHUB_CLIENT_ID.md +2 -3
  72. package/data/packages/platform-authentication/api/Variable.AUTH_GITHUB_CLIENT_SECRET.md +2 -3
  73. package/data/packages/platform-authentication/api/Variable.AUTH_GITHUB_SCOPE.md +2 -3
  74. package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_CALLBACK_URL.md +2 -3
  75. package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_CLIENT_ID.md +2 -3
  76. package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_CLIENT_SECRET.md +2 -3
  77. package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_SCOPE.md +2 -3
  78. package/data/packages/platform-authentication/api/Variable.AUTH_JWT_EXPIRES_IN.md +2 -3
  79. package/data/packages/platform-authentication/api/Variable.AUTH_JWT_SECRET.md +2 -3
  80. package/data/packages/platform-authentication/api/Variable.AUTH_MFA_CHALLENGE_EXPIRES_IN.md +2 -3
  81. package/data/packages/platform-authentication/api/Variable.AUTH_MFA_EMAIL_CODE_TTL.md +2 -3
  82. package/data/packages/platform-authentication/api/Variable.AUTH_MFA_EMAIL_MIN_RESEND.md +2 -3
  83. package/data/packages/platform-authentication/api/Variable.AUTH_MFA_ENCRYPTION_KEY.md +2 -3
  84. package/data/packages/platform-authentication/api/Variable.AUTH_MFA_ISSUER.md +2 -3
  85. package/data/packages/platform-authentication/api/Variable.AUTH_MFA_MAX_ATTEMPTS.md +2 -3
  86. package/data/packages/platform-authentication/api/Variable.AUTH_MFA_PUSH_CODE_TTL.md +2 -3
  87. package/data/packages/platform-authentication/api/Variable.AUTH_MFA_PUSH_MIN_RESEND.md +2 -3
  88. package/data/packages/platform-authentication/api/Variable.AUTH_MFA_SMS_CODE_TTL.md +2 -3
  89. package/data/packages/platform-authentication/api/Variable.AUTH_MFA_SMS_MIN_RESEND.md +2 -3
  90. package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_CALLBACK_URL.md +2 -3
  91. package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_CLIENT_ID.md +2 -3
  92. package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_CLIENT_SECRET.md +2 -3
  93. package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_SCOPE.md +2 -3
  94. package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_TENANT.md +2 -3
  95. package/data/packages/platform-authentication/api/Variable.AUTH_VERIFY_JWT_EXPIRES_IN.md +2 -3
  96. package/data/packages/platform-authentication/api/Variable.GITHUB_AUTH_CONFIG_ENTRIES.md +3 -4
  97. package/data/packages/platform-authentication/api/Variable.GOOGLE_AUTH_CONFIG_ENTRIES.md +3 -4
  98. package/data/packages/platform-authentication/api/Variable.MICROSOFT_AUTH_CONFIG_ENTRIES.md +2 -3
  99. package/data/packages/platform-authentication/api/Variable.PLATFORM_AUTHENTICATION_CONFIG_ENTRIES.md +3 -4
  100. package/data/packages/platform-authentication/api/Variable.ROLES_KEY.md +2 -3
  101. package/data/packages/platform-authentication/api/Variable.SEED_ANONYMOUS_USERNAME.md +2 -3
  102. package/data/packages/platform-authentication/api/Variable.SESSION_LIST_MAPPING_KEY.md +1 -2
  103. package/data/packages/platform-authentication/api/Variable.SESSION_MAPPING_KEY.md +1 -2
  104. package/data/packages/platform-authentication/api/Variable.TOTP_MFA_PROVIDERS.md +1 -2
  105. package/data/packages/platform-authentication/api/Variable.User.md +2 -3
  106. package/data/packages/platform-authentication/api/index.md +94 -95
  107. package/data/packages/platform-blob-storage/api/Class.AwsS3BlobProvider.md +16 -17
  108. package/data/packages/platform-blob-storage/api/Class.AzureBlobProvider.md +16 -17
  109. package/data/packages/platform-blob-storage/api/Class.BlobHealthIndicator.md +5 -6
  110. package/data/packages/platform-blob-storage/api/Class.BlobModule.md +2 -3
  111. package/data/packages/platform-blob-storage/api/Class.BlobObjectPersistencePort.md +12 -13
  112. package/data/packages/platform-blob-storage/api/Class.BlobService.md +45 -46
  113. package/data/packages/platform-blob-storage/api/Class.BlobVariantPersistencePort.md +7 -8
  114. package/data/packages/platform-blob-storage/api/Class.VercelBlobProvider.md +18 -19
  115. package/data/packages/platform-blob-storage/api/Interface.IAwsS3BlobProviderRegistration.md +2 -3
  116. package/data/packages/platform-blob-storage/api/Interface.IAwsS3ProviderOptions.md +5 -6
  117. package/data/packages/platform-blob-storage/api/Interface.IAzureBlobProviderOptions.md +2 -3
  118. package/data/packages/platform-blob-storage/api/Interface.IAzureBlobProviderRegistration.md +2 -3
  119. package/data/packages/platform-blob-storage/api/Interface.IBlobDeleteRequest.md +2 -3
  120. package/data/packages/platform-blob-storage/api/Interface.IBlobDownloadRequest.md +3 -4
  121. package/data/packages/platform-blob-storage/api/Interface.IBlobDownloadResult.md +6 -7
  122. package/data/packages/platform-blob-storage/api/Interface.IBlobModuleOptions.md +3 -4
  123. package/data/packages/platform-blob-storage/api/Interface.IBlobObjectMetadata.md +12 -13
  124. package/data/packages/platform-blob-storage/api/Interface.IBlobProvider.md +14 -15
  125. package/data/packages/platform-blob-storage/api/Interface.IBlobSignedUrlRequest.md +3 -4
  126. package/data/packages/platform-blob-storage/api/Interface.IBlobUploadRequest.md +8 -9
  127. package/data/packages/platform-blob-storage/api/Interface.IBlobUploadResult.md +1 -2
  128. package/data/packages/platform-blob-storage/api/Interface.ICustomBlobProviderRegistration.md +2 -3
  129. package/data/packages/platform-blob-storage/api/Interface.IVercelBlobProviderOptions.md +5 -6
  130. package/data/packages/platform-blob-storage/api/Interface.IVercelBlobProviderRegistration.md +2 -3
  131. package/data/packages/platform-blob-storage/api/TypeAlias.BlobDownloadResponseType.md +1 -2
  132. package/data/packages/platform-blob-storage/api/TypeAlias.BlobUploadBody.md +0 -1
  133. package/data/packages/platform-blob-storage/api/TypeAlias.IBlobProviderRegistration.md +1 -2
  134. package/data/packages/platform-blob-storage/api/Variable.AWS_S3_PROVIDER_OPTIONS.md +1 -2
  135. package/data/packages/platform-blob-storage/api/Variable.AZURE_BLOB_PROVIDER_OPTIONS.md +1 -2
  136. package/data/packages/platform-blob-storage/api/Variable.BLOB_PROVIDER.md +1 -2
  137. package/data/packages/platform-blob-storage/api/Variable.BlobDownloadResponseTypes.md +9 -10
  138. package/data/packages/platform-blob-storage/api/Variable.BlobProviderKinds.md +10 -11
  139. package/data/packages/platform-blob-storage/api/Variable.VERCEL_BLOB_PROVIDER_OPTIONS.md +1 -2
  140. package/data/packages/platform-blob-storage/api/index.md +41 -42
  141. package/data/packages/platform-caching/api/Class.MemoryLayeredCache.md +37 -38
  142. package/data/packages/platform-caching/api/Class.NoopCacheMetricsRecorder.md +19 -20
  143. package/data/packages/platform-caching/api/Class.RedisLayeredCache.md +39 -40
  144. package/data/packages/platform-caching/api/Interface.ICacheMetricsRecorder.md +19 -20
  145. package/data/packages/platform-caching/api/Interface.ICacheStats.md +4 -5
  146. package/data/packages/platform-caching/api/Interface.ILayeredCache.md +34 -35
  147. package/data/packages/platform-caching/api/Interface.ILayeredCacheOptions.md +4 -5
  148. package/data/packages/platform-caching/api/Interface.IRedisLayeredCacheOptions.md +15 -16
  149. package/data/packages/platform-caching/api/index.md +12 -13
  150. package/data/packages/platform-core/api/Class.AppHealthIndicator.md +4 -5
  151. package/data/packages/platform-core/api/Class.BlobResourceStrategy.md +20 -21
  152. package/data/packages/platform-core/api/Class.BooleanUtils.md +12 -13
  153. package/data/packages/platform-core/api/Class.CUIDGenerator.md +17 -18
  154. package/data/packages/platform-core/api/Class.CasingInterceptor.md +10 -11
  155. package/data/packages/platform-core/api/Class.CatchUtils.md +15 -16
  156. package/data/packages/platform-core/api/Class.ConfigKeyNotFoundError.md +89 -0
  157. package/data/packages/platform-core/api/Class.ConfigModule.md +7 -8
  158. package/data/packages/platform-core/api/Class.ConfigRegistry.md +8 -9
  159. package/data/packages/platform-core/api/Class.ConfigService.md +30 -32
  160. package/data/packages/platform-core/api/Class.ConfigStrategyBase.md +17 -18
  161. package/data/packages/platform-core/api/Class.ContentTemplateEngine.md +4 -5
  162. package/data/packages/platform-core/api/Class.DateTimeUtils.md +12 -13
  163. package/data/packages/platform-core/api/Class.DeviceParserService.md +2 -3
  164. package/data/packages/platform-core/api/Class.EmbeddedResourceStrategy.md +22 -23
  165. package/data/packages/platform-core/api/Class.EnvironmentConfigStrategy.md +19 -20
  166. package/data/packages/platform-core/api/Class.ErrorTemplateService.md +18 -19
  167. package/data/packages/platform-core/api/Class.EventHub.md +25 -26
  168. package/data/packages/platform-core/api/Class.EventModule.md +0 -1
  169. package/data/packages/platform-core/api/Class.FileConfigStrategy.md +21 -22
  170. package/data/packages/platform-core/api/Class.FileResourceStrategy.md +19 -20
  171. package/data/packages/platform-core/api/Class.GUIDGenerator.md +7 -8
  172. package/data/packages/platform-core/api/Class.GlobalExceptionFilter.md +7 -8
  173. package/data/packages/platform-core/api/Class.HealthModule.md +2 -3
  174. package/data/packages/platform-core/api/Class.HealthOrchestrator.md +3 -4
  175. package/data/packages/platform-core/api/Class.HostModule.md +0 -2
  176. package/data/packages/platform-core/api/Class.HostService.md +21 -22
  177. package/data/packages/platform-core/api/Class.HttpLoggerMiddleware.md +8 -9
  178. package/data/packages/platform-core/api/Class.IdGeneratorBase.md +7 -8
  179. package/data/packages/platform-core/api/Class.IdentifierModule.md +3 -4
  180. package/data/packages/platform-core/api/Class.LimitRequestSizeMiddleware.md +8 -9
  181. package/data/packages/platform-core/api/Class.LocalizedTextRequest.md +1 -2
  182. package/data/packages/platform-core/api/Class.LocalizedTextResponse.md +1 -2
  183. package/data/packages/platform-core/api/Class.MappingBuilder.md +18 -19
  184. package/data/packages/platform-core/api/Class.MappingModule.md +2 -3
  185. package/data/packages/platform-core/api/Class.MappingNotRegisteredError.md +5 -6
  186. package/data/packages/platform-core/api/Class.MappingProfileBase.md +2 -3
  187. package/data/packages/platform-core/api/Class.MappingService.md +52 -53
  188. package/data/packages/platform-core/api/Class.NormalizedUtils.md +20 -21
  189. package/data/packages/platform-core/api/Class.PageableRequest.md +1 -2
  190. package/data/packages/platform-core/api/Class.PageableResponse.md +3 -4
  191. package/data/packages/platform-core/api/Class.ProblemDetailException.md +6 -7
  192. package/data/packages/platform-core/api/Class.ProblemDetailExceptionFilter.md +11 -12
  193. package/data/packages/platform-core/api/Class.QuantityResponse.md +1 -2
  194. package/data/packages/platform-core/api/Class.ResourceManager.md +88 -89
  195. package/data/packages/platform-core/api/Class.ResourceModule.md +3 -4
  196. package/data/packages/platform-core/api/Class.ResponseReturn.md +102 -104
  197. package/data/packages/platform-core/api/Class.SseHub.md +23 -24
  198. package/data/packages/platform-core/api/Class.SseModule.md +3 -4
  199. package/data/packages/platform-core/api/Class.TimeStampResponse.md +1 -2
  200. package/data/packages/platform-core/api/Class.TypeMappingNotRegisteredError.md +5 -6
  201. package/data/packages/platform-core/api/Class.UUIDGenerator.md +7 -8
  202. package/data/packages/platform-core/api/Class.UserAvatarGeneratorService.md +4 -5
  203. package/data/packages/platform-core/api/Class.UserNameGeneratorService.md +4 -5
  204. package/data/packages/platform-core/api/Function.Public.md +0 -1
  205. package/data/packages/platform-core/api/Function.createConfigKey.md +7 -9
  206. package/data/packages/platform-core/api/Function.createEventKey.md +6 -7
  207. package/data/packages/platform-core/api/Function.createMappingKey.md +6 -7
  208. package/data/packages/platform-core/api/Function.env.md +4 -5
  209. package/data/packages/platform-core/api/Function.getMimeTypeByFileNameOrExtension.md +2 -3
  210. package/data/packages/platform-core/api/ISseEventData.Function.isActionId.md +4 -5
  211. package/data/packages/platform-core/api/Interface.IBlobResourceStrategyConfig.md +1 -2
  212. package/data/packages/platform-core/api/Interface.IBlobServiceAdapter.md +5 -6
  213. package/data/packages/platform-core/api/Interface.IConfigKey.md +16 -17
  214. package/data/packages/platform-core/api/Interface.IConfigModuleOptions.md +3 -4
  215. package/data/packages/platform-core/api/Interface.IConfigRegistryEntry.md +6 -7
  216. package/data/packages/platform-core/api/Interface.IDeviceInfo.md +6 -7
  217. package/data/packages/platform-core/api/Interface.IErrorPageParams.md +19 -20
  218. package/data/packages/platform-core/api/Interface.IEventKey.md +7 -8
  219. package/data/packages/platform-core/api/Interface.IEventMap.md +0 -1
  220. package/data/packages/platform-core/api/Interface.IFileResourceStrategyConfig.md +5 -6
  221. package/data/packages/platform-core/api/Interface.IHealthCheckResult.md +3 -4
  222. package/data/packages/platform-core/api/Interface.IHealthIndicator.md +3 -4
  223. package/data/packages/platform-core/api/Interface.IHostContentParams.md +17 -18
  224. package/data/packages/platform-core/api/Interface.IIdGenerator.md +7 -8
  225. package/data/packages/platform-core/api/Interface.IMappingBuilder.md +17 -18
  226. package/data/packages/platform-core/api/Interface.IMappingKey.md +7 -8
  227. package/data/packages/platform-core/api/Interface.IMappingProfile.md +2 -3
  228. package/data/packages/platform-core/api/Interface.IResourceManagerConfig.md +4 -5
  229. package/data/packages/platform-core/api/Interface.IResourceMetadata.md +6 -7
  230. package/data/packages/platform-core/api/Interface.IResourceResult.md +1 -2
  231. package/data/packages/platform-core/api/Interface.IResourceStrategy.md +16 -17
  232. package/data/packages/platform-core/api/Interface.ISseEventData.md +3 -4
  233. package/data/packages/platform-core/api/Interface.ISseHub.md +16 -17
  234. package/data/packages/platform-core/api/Namespace.ISseEventData.md +2 -3
  235. package/data/packages/platform-core/api/TypeAlias.CamelCase.md +2 -3
  236. package/data/packages/platform-core/api/TypeAlias.ProblemDetail.md +5 -6
  237. package/data/packages/platform-core/api/TypeAlias.ProblemDetailTypeUrlResolver.md +4 -5
  238. package/data/packages/platform-core/api/TypeAlias.SetOptional.md +4 -5
  239. package/data/packages/platform-core/api/TypeAlias.StringValue.md +4 -2
  240. package/data/packages/platform-core/api/Variable.APP_NAME.md +1 -2
  241. package/data/packages/platform-core/api/Variable.APP_PORT.md +1 -2
  242. package/data/packages/platform-core/api/Variable.APP_URL.md +1 -2
  243. package/data/packages/platform-core/api/Variable.APP_VERSION.md +1 -2
  244. package/data/packages/platform-core/api/Variable.GIT_COMMIT.md +1 -2
  245. package/data/packages/platform-core/api/Variable.HEALTH_INDICATORS_TOKEN.md +1 -2
  246. package/data/packages/platform-core/api/Variable.ID_GENERATOR_TOKEN.md +1 -2
  247. package/data/packages/platform-core/api/Variable.INTELLIGENCE_MAX_OUTPUT_TOKENS.md +1 -2
  248. package/data/packages/platform-core/api/Variable.INTELLIGENCE_MODEL.md +1 -2
  249. package/data/packages/platform-core/api/Variable.INTELLIGENCE_TEMPERATURE.md +1 -2
  250. package/data/packages/platform-core/api/Variable.INTELLIGENCE_TOP_P.md +1 -2
  251. package/data/packages/platform-core/api/Variable.IS_PUBLIC_KEY.md +2 -3
  252. package/data/packages/platform-core/api/Variable.IpAddress.md +6 -7
  253. package/data/packages/platform-core/api/Variable.Lang.md +5 -6
  254. package/data/packages/platform-core/api/Variable.NODE_ENV.md +1 -2
  255. package/data/packages/platform-core/api/Variable.PLATFORM_CORE_CONFIG_ENTRIES.md +2 -3
  256. package/data/packages/platform-core/api/Variable.UserAgent.md +2 -3
  257. package/data/packages/platform-core/api/index.md +116 -116
  258. package/data/packages/platform-cryptography/api/Class.BcryptService.md +7 -8
  259. package/data/packages/platform-cryptography/api/Class.CryptoService.md +3 -4
  260. package/data/packages/platform-cryptography/api/Class.OtpService.md +8 -9
  261. package/data/packages/platform-cryptography/api/Interface.IOtpService.md +8 -9
  262. package/data/packages/platform-cryptography/api/Interface.IOtpUriOptions.md +2 -3
  263. package/data/packages/platform-cryptography/api/Variable.OTP_SERVICE_TOKEN.md +1 -2
  264. package/data/packages/platform-cryptography/api/Variable.TOTP_EPOCH_TOLERANCE.md +7 -8
  265. package/data/packages/platform-cryptography/api/index.md +11 -12
  266. package/data/packages/platform-database/api/Class.DatabaseHealthIndicator.md +6 -7
  267. package/data/packages/platform-database/api/Class.DatabaseModule.md +5 -6
  268. package/data/packages/platform-database/api/Class.DatabaseService.md +19 -20
  269. package/data/packages/platform-database/api/Class.PrismaService.md +7 -8
  270. package/data/packages/platform-database/api/Class.RepositoryBase.md +126 -127
  271. package/data/packages/platform-database/api/Class.RepositoryExceptionFilter.md +5 -6
  272. package/data/packages/platform-database/api/Function.pageable.md +13 -10
  273. package/data/packages/platform-database/api/Function.paginator.md +2 -3
  274. package/data/packages/platform-database/api/Function.query.md +7 -8
  275. package/data/packages/platform-database/api/Function.skip.md +5 -6
  276. package/data/packages/platform-database/api/Function.transactionalQuery.md +6 -7
  277. package/data/packages/platform-database/api/Interface.IDatabaseModuleConfig.md +0 -1
  278. package/data/packages/platform-database/api/Interface.IPaginateOptions.md +1 -2
  279. package/data/packages/platform-database/api/Interface.IPaginatedResult.md +4 -5
  280. package/data/packages/platform-database/api/Interface.IRepositoryQuery.md +7 -8
  281. package/data/packages/platform-database/api/Interface.ITransactionalRepositoryQuery.md +5 -6
  282. package/data/packages/platform-database/api/TypeAlias.DelegateArgs.md +2 -3
  283. package/data/packages/platform-database/api/TypeAlias.DelegateReturnTypes.md +2 -3
  284. package/data/packages/platform-database/api/TypeAlias.PaginateFunction.md +7 -8
  285. package/data/packages/platform-database/api/TypeAlias.QueryResultType.md +3 -4
  286. package/data/packages/platform-database/api/TypeAlias.TransactionalQueryResultType.md +3 -4
  287. package/data/packages/platform-database/api/index.md +27 -28
  288. package/data/packages/platform-documents/api/Class.BaseDocumentRenderer.md +31 -33
  289. package/data/packages/platform-documents/api/Class.DocumentEngine.md +7 -8
  290. package/data/packages/platform-documents/api/Class.DocumentModule.md +2 -3
  291. package/data/packages/platform-documents/api/Class.SharpImageProcessor.md +21 -22
  292. package/data/packages/platform-documents/api/Interface.IDocumentModuleOptions.md +5 -7
  293. package/data/packages/platform-documents/api/Interface.IDocumentPlaceholderDetail.md +5 -6
  294. package/data/packages/platform-documents/api/Interface.IDocumentProbeReport.md +8 -9
  295. package/data/packages/platform-documents/api/Interface.IDocumentRenderer.md +2 -3
  296. package/data/packages/platform-documents/api/Interface.IImagePayload.md +3 -4
  297. package/data/packages/platform-documents/api/Interface.IImageProcessor.md +18 -19
  298. package/data/packages/platform-documents/api/Interface.IRenderOptions.md +3 -4
  299. package/data/packages/platform-documents/api/Interface.IRenderResult.md +3 -4
  300. package/data/packages/platform-documents/api/TypeAlias.DocumentFormat.md +1 -2
  301. package/data/packages/platform-documents/api/TypeAlias.EngineType.md +1 -2
  302. package/data/packages/platform-documents/api/TypeAlias.ImageMimeType.md +1 -2
  303. package/data/packages/platform-documents/api/TypeAlias.TemplateFormat.md +1 -2
  304. package/data/packages/platform-documents/api/TypeAlias.TemplateType.md +1 -2
  305. package/data/packages/platform-documents/api/Variable.DOCUMENT_MODULE_OPTIONS.md +1 -2
  306. package/data/packages/platform-documents/api/Variable.DOCUMENT_PARSER_TOKEN.md +1 -2
  307. package/data/packages/platform-documents/api/Variable.DOCUMENT_RENDERER_TOKEN.md +1 -2
  308. package/data/packages/platform-documents/api/Variable.IMAGE_PROCESSOR_TOKEN.md +1 -2
  309. package/data/packages/platform-documents/api/index.md +28 -29
  310. package/data/packages/platform-esigning/api/Class.EsigningClientPort.md +20 -21
  311. package/data/packages/platform-esigning/api/Class.EsigningError.md +4 -5
  312. package/data/packages/platform-esigning/api/Class.EsigningModule.md +2 -3
  313. package/data/packages/platform-esigning/api/Class.EsigningPersistencePort.md +9 -10
  314. package/data/packages/platform-esigning/api/Class.EsigningService.md +24 -25
  315. package/data/packages/platform-esigning/api/Class.InternalEsigningProvider.md +24 -25
  316. package/data/packages/platform-esigning/api/Class.SigningProviderError.md +9 -10
  317. package/data/packages/platform-esigning/api/Class.SigningRequestNotFoundError.md +3 -4
  318. package/data/packages/platform-esigning/api/Class.WebhookVerificationError.md +2 -3
  319. package/data/packages/platform-esigning/api/Interface.ICreateSigningRequest.md +6 -7
  320. package/data/packages/platform-esigning/api/Interface.ICreateSigningRequestDocument.md +3 -4
  321. package/data/packages/platform-esigning/api/Interface.ICreateSigningRequestSigner.md +3 -4
  322. package/data/packages/platform-esigning/api/Interface.ICreateSigningSessionRequest.md +2 -3
  323. package/data/packages/platform-esigning/api/Interface.IEsigningModuleOptions.md +3 -4
  324. package/data/packages/platform-esigning/api/Interface.IEsigningWebhookEvent.md +5 -6
  325. package/data/packages/platform-esigning/api/Interface.ISignedDocument.md +5 -6
  326. package/data/packages/platform-esigning/api/Interface.ISigner.md +5 -6
  327. package/data/packages/platform-esigning/api/Interface.ISigningDocument.md +5 -6
  328. package/data/packages/platform-esigning/api/Interface.ISigningField.md +10 -11
  329. package/data/packages/platform-esigning/api/Interface.ISigningRequest.md +10 -11
  330. package/data/packages/platform-esigning/api/Interface.ISigningSession.md +4 -5
  331. package/data/packages/platform-esigning/api/TypeAlias.SignerRole.md +1 -2
  332. package/data/packages/platform-esigning/api/TypeAlias.SignerStatus.md +1 -2
  333. package/data/packages/platform-esigning/api/TypeAlias.SigningFieldType.md +1 -2
  334. package/data/packages/platform-esigning/api/TypeAlias.SigningRequestStatus.md +1 -2
  335. package/data/packages/platform-esigning/api/TypeAlias.WebhookEventType.md +1 -2
  336. package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_BASE_URL.md +1 -2
  337. package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_CLIENT_SECRET.md +1 -2
  338. package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_CONFIG_ENTRIES.md +2 -3
  339. package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_INTEGRATION_KEY.md +1 -2
  340. package/data/packages/platform-esigning/api/Variable.ADOBE_SIGN_WEBHOOK_CLIENT_ID.md +1 -2
  341. package/data/packages/platform-esigning/api/Variable.DOCUSIGN_ACCOUNT_ID.md +1 -2
  342. package/data/packages/platform-esigning/api/Variable.DOCUSIGN_BASE_URL.md +1 -2
  343. package/data/packages/platform-esigning/api/Variable.DOCUSIGN_CONFIG_ENTRIES.md +2 -3
  344. package/data/packages/platform-esigning/api/Variable.DOCUSIGN_INTEGRATION_KEY.md +1 -2
  345. package/data/packages/platform-esigning/api/Variable.DOCUSIGN_SECRET_KEY.md +1 -2
  346. package/data/packages/platform-esigning/api/Variable.DOCUSIGN_WEBHOOK_HMAC_KEY.md +1 -2
  347. package/data/packages/platform-esigning/api/Variable.DROPBOX_SIGN_API_KEY.md +1 -2
  348. package/data/packages/platform-esigning/api/Variable.DROPBOX_SIGN_CLIENT_ID.md +1 -2
  349. package/data/packages/platform-esigning/api/Variable.DROPBOX_SIGN_CONFIG_ENTRIES.md +2 -3
  350. package/data/packages/platform-esigning/api/Variable.DROPBOX_SIGN_WEBHOOK_SECRET.md +1 -2
  351. package/data/packages/platform-esigning/api/Variable.ESIGNING_API_BASE_URL.md +1 -2
  352. package/data/packages/platform-esigning/api/Variable.ESIGNING_API_KEY.md +1 -2
  353. package/data/packages/platform-esigning/api/Variable.ESIGNING_PROVIDER.md +1 -2
  354. package/data/packages/platform-esigning/api/Variable.ESIGNING_PROVIDER_OPTIONS.md +1 -2
  355. package/data/packages/platform-esigning/api/Variable.ESIGNING_WEBHOOK_SECRET.md +1 -2
  356. package/data/packages/platform-esigning/api/Variable.PLATFORM_ESIGNING_CONFIG_ENTRIES.md +2 -3
  357. package/data/packages/platform-esigning/api/Variable.SIGNNOW_API_KEY.md +1 -2
  358. package/data/packages/platform-esigning/api/Variable.SIGNNOW_BASE_URL.md +1 -2
  359. package/data/packages/platform-esigning/api/Variable.SIGNNOW_CLIENT_ID.md +1 -2
  360. package/data/packages/platform-esigning/api/Variable.SIGNNOW_CLIENT_SECRET.md +1 -2
  361. package/data/packages/platform-esigning/api/Variable.SIGNNOW_CONFIG_ENTRIES.md +2 -3
  362. package/data/packages/platform-esigning/api/Variable.SIGNNOW_WEBHOOK_SECRET.md +1 -2
  363. package/data/packages/platform-esigning/api/Variable.SignerRoles.md +12 -13
  364. package/data/packages/platform-esigning/api/Variable.SignerStatuses.md +14 -15
  365. package/data/packages/platform-esigning/api/Variable.SigningFieldTypes.md +20 -21
  366. package/data/packages/platform-esigning/api/Variable.SigningRequestStatuses.md +18 -19
  367. package/data/packages/platform-esigning/api/Variable.WebhookEventTypes.md +20 -21
  368. package/data/packages/platform-esigning/api/index.md +65 -66
  369. package/data/packages/platform-intelligence/api/Class.IntelligenceCapabilityRegistrarBase.md +4 -5
  370. package/data/packages/platform-intelligence/api/Class.IntelligenceCapabilityRegistry.md +10 -11
  371. package/data/packages/platform-intelligence/api/Class.IntelligenceModule.md +0 -1
  372. package/data/packages/platform-intelligence/api/Class.IntelligenceTextGenerator.md +10 -11
  373. package/data/packages/platform-intelligence/api/Function.createProviderOptions.md +2 -3
  374. package/data/packages/platform-intelligence/api/Function.loadAnthropicLanguageModel.md +2 -3
  375. package/data/packages/platform-intelligence/api/Function.loadGoogleLanguageModel.md +2 -3
  376. package/data/packages/platform-intelligence/api/Function.loadGrokLanguageModel.md +2 -3
  377. package/data/packages/platform-intelligence/api/Function.loadOpenAILanguageModel.md +2 -3
  378. package/data/packages/platform-intelligence/api/Function.loadProviderFactory.md +3 -4
  379. package/data/packages/platform-intelligence/api/Interface.IIntelligenceArtifact.md +1 -2
  380. package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapability.md +6 -7
  381. package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityMetadata.md +4 -5
  382. package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityPayload.md +2 -3
  383. package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityRegistry.md +10 -11
  384. package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityResult.md +2 -3
  385. package/data/packages/platform-intelligence/api/Interface.IIntelligenceCompletionUsage.md +2 -3
  386. package/data/packages/platform-intelligence/api/Interface.IIntelligenceContext.md +5 -6
  387. package/data/packages/platform-intelligence/api/Interface.IIntelligenceContextBuilder.md +3 -4
  388. package/data/packages/platform-intelligence/api/Interface.IIntelligenceConversationMessageSnapshot.md +4 -5
  389. package/data/packages/platform-intelligence/api/Interface.IIntelligenceConversationSnapshot.md +3 -4
  390. package/data/packages/platform-intelligence/api/Interface.IIntelligenceFollowUpQuestion.md +2 -3
  391. package/data/packages/platform-intelligence/api/Interface.IIntelligenceIntent.md +2 -3
  392. package/data/packages/platform-intelligence/api/Interface.IIntelligenceIntentEntity.md +1 -2
  393. package/data/packages/platform-intelligence/api/Interface.IIntelligenceMessageModel.md +4 -5
  394. package/data/packages/platform-intelligence/api/Interface.IIntelligenceMessagePayload.md +1 -2
  395. package/data/packages/platform-intelligence/api/Interface.IIntelligencePrompt.md +1 -2
  396. package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptMessage.md +1 -2
  397. package/data/packages/platform-intelligence/api/Interface.IIntelligenceProviderConfiguration.md +6 -7
  398. package/data/packages/platform-intelligence/api/Interface.IIntelligenceResponseMessage.md +1 -2
  399. package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextCompletion.md +4 -5
  400. package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextGenerationOptions.md +2 -3
  401. package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextGenerator.md +4 -5
  402. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceConversationMessageRole.md +1 -3
  403. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceLanguageModelLoader.md +2 -3
  404. package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceProviderName.md +1 -2
  405. package/data/packages/platform-intelligence/api/Variable.IntelligenceConversationMessageRoles.md +7 -8
  406. package/data/packages/platform-intelligence/api/Variable.IntelligenceProviderNames.md +10 -11
  407. package/data/packages/platform-intelligence/api/index.md +46 -47
  408. package/data/packages/platform-logging/api/Class.LoggerModule.md +0 -1
  409. package/data/packages/platform-logging/api/Variable.APP_LOG_LEVEL.md +1 -2
  410. package/data/packages/platform-logging/api/Variable.PLATFORM_LOGGING_CONFIG_ENTRIES.md +2 -3
  411. package/data/packages/platform-logging/api/index.md +7 -8
  412. package/data/packages/platform-mailing/api/Class.BlobTemplateFetchStrategy.md +2 -3
  413. package/data/packages/platform-mailing/api/Class.DeliveryStrategyBase.md +11 -12
  414. package/data/packages/platform-mailing/api/Class.FileTemplateFetchStrategy.md +2 -3
  415. package/data/packages/platform-mailing/api/Class.LogDeliveryStrategy.md +13 -14
  416. package/data/packages/platform-mailing/api/Class.MailHealthIndicator.md +4 -5
  417. package/data/packages/platform-mailing/api/Class.MailModule.md +0 -1
  418. package/data/packages/platform-mailing/api/Class.MailService.md +27 -28
  419. package/data/packages/platform-mailing/api/Class.MailTemplateEngine.md +12 -13
  420. package/data/packages/platform-mailing/api/Class.MailVerificationService.md +14 -15
  421. package/data/packages/platform-mailing/api/Class.MailgunDeliveryStrategy.md +13 -14
  422. package/data/packages/platform-mailing/api/Class.PostmarkDeliveryStrategy.md +13 -14
  423. package/data/packages/platform-mailing/api/Class.ResendDeliveryStrategy.md +13 -14
  424. package/data/packages/platform-mailing/api/Class.SendGridDeliveryStrategy.md +13 -14
  425. package/data/packages/platform-mailing/api/Class.SmtpDeliveryStrategy.md +13 -14
  426. package/data/packages/platform-mailing/api/Class.TemplateFetchStrategyBase.md +2 -3
  427. package/data/packages/platform-mailing/api/Interface.IMailEvents.md +0 -1
  428. package/data/packages/platform-mailing/api/Interface.IMailTemplateVariants.md +1 -2
  429. package/data/packages/platform-mailing/api/TypeAlias.MailTemplateFormat.md +1 -2
  430. package/data/packages/platform-mailing/api/Variable.MAILGUN_API_KEY.md +1 -2
  431. package/data/packages/platform-mailing/api/Variable.MAILGUN_CONFIG_ENTRIES.md +2 -3
  432. package/data/packages/platform-mailing/api/Variable.MAILGUN_DOMAIN.md +1 -2
  433. package/data/packages/platform-mailing/api/Variable.MAIL_DELIVERY_STRATEGY.md +1 -2
  434. package/data/packages/platform-mailing/api/Variable.MAIL_DELIVERY_STRATEGY_TOKEN.md +1 -2
  435. package/data/packages/platform-mailing/api/Variable.MAIL_HOST.md +1 -2
  436. package/data/packages/platform-mailing/api/Variable.MAIL_MAILGUN_API_KEY.md +1 -2
  437. package/data/packages/platform-mailing/api/Variable.MAIL_MAILGUN_DOMAIN.md +1 -2
  438. package/data/packages/platform-mailing/api/Variable.MAIL_PORT.md +1 -2
  439. package/data/packages/platform-mailing/api/Variable.MAIL_POSTMARK_API_KEY.md +1 -2
  440. package/data/packages/platform-mailing/api/Variable.MAIL_RESEND_API_KEY.md +1 -2
  441. package/data/packages/platform-mailing/api/Variable.MAIL_SENDER_EMAIL.md +1 -2
  442. package/data/packages/platform-mailing/api/Variable.MAIL_SENDGRID_API_KEY.md +1 -2
  443. package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_HOST.md +1 -2
  444. package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_PASSWORD.md +1 -2
  445. package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_PORT.md +1 -2
  446. package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_SECURE.md +1 -2
  447. package/data/packages/platform-mailing/api/Variable.MAIL_SMTP_USER.md +1 -2
  448. package/data/packages/platform-mailing/api/Variable.MAIL_TEMPLATE_ENGINE_FORMAT.md +1 -2
  449. package/data/packages/platform-mailing/api/Variable.MAIL_TEMPLATE_FETCH_STRATEGY_TOKEN.md +1 -2
  450. package/data/packages/platform-mailing/api/Variable.MAIL_TEMPLATE_STRATEGY.md +1 -2
  451. package/data/packages/platform-mailing/api/Variable.MAIL_USER.md +1 -2
  452. package/data/packages/platform-mailing/api/Variable.PLATFORM_MAILING_CONFIG_ENTRIES.md +2 -3
  453. package/data/packages/platform-mailing/api/Variable.POSTMARK_API_KEY.md +1 -2
  454. package/data/packages/platform-mailing/api/Variable.POSTMARK_CONFIG_ENTRIES.md +2 -3
  455. package/data/packages/platform-mailing/api/Variable.RESEND_API_KEY.md +1 -2
  456. package/data/packages/platform-mailing/api/Variable.RESEND_CONFIG_ENTRIES.md +2 -3
  457. package/data/packages/platform-mailing/api/Variable.SENDGRID_API_KEY.md +1 -2
  458. package/data/packages/platform-mailing/api/Variable.SENDGRID_CONFIG_ENTRIES.md +2 -3
  459. package/data/packages/platform-mailing/api/Variable.SEND_MAIL_EVENT_KEY.md +2 -3
  460. package/data/packages/platform-mailing/api/index.md +54 -55
  461. package/data/packages/platform-mcp/api/Class.McpDiscoveryService.md +8 -9
  462. package/data/packages/platform-mcp/api/Class.McpModule.md +8 -9
  463. package/data/packages/platform-mcp/api/Class.McpRegistryService.md +16 -17
  464. package/data/packages/platform-mcp/api/Class.McpServerService.md +19 -20
  465. package/data/packages/platform-mcp/api/Function.McpPrompt.md +2 -3
  466. package/data/packages/platform-mcp/api/Function.McpResource.md +2 -3
  467. package/data/packages/platform-mcp/api/Function.McpTool.md +2 -3
  468. package/data/packages/platform-mcp/api/Interface.IMcpHandlerMetadata.md +2 -3
  469. package/data/packages/platform-mcp/api/Interface.IMcpModuleAsyncOptions.md +8 -9
  470. package/data/packages/platform-mcp/api/Interface.IMcpModuleOptions.md +3 -4
  471. package/data/packages/platform-mcp/api/Interface.IMcpModuleOptionsFactory.md +3 -4
  472. package/data/packages/platform-mcp/api/Interface.IMcpPromptMetadata.md +3 -4
  473. package/data/packages/platform-mcp/api/Interface.IMcpResourceMetadata.md +4 -5
  474. package/data/packages/platform-mcp/api/Interface.IMcpToolMetadata.md +5 -6
  475. package/data/packages/platform-mcp/api/Interface.IRegisteredPrompt.md +3 -4
  476. package/data/packages/platform-mcp/api/Interface.IRegisteredResource.md +3 -4
  477. package/data/packages/platform-mcp/api/Interface.IRegisteredTool.md +3 -4
  478. package/data/packages/platform-mcp/api/Interface.ISseTransportOptions.md +0 -1
  479. package/data/packages/platform-mcp/api/Interface.IStreamableHttpTransportOptions.md +1 -2
  480. package/data/packages/platform-mcp/api/Variable.MCP_MODULE_OPTIONS.md +1 -2
  481. package/data/packages/platform-mcp/api/index.md +26 -27
  482. package/data/packages/platform-openapi/api/Class.SwaggerFeatureDiscovery.md +5 -6
  483. package/data/packages/platform-openapi/api/Class.SwaggerFeatureRegistry.md +5 -6
  484. package/data/packages/platform-openapi/api/Class.SwaggerMultiDocumentService.md +20 -21
  485. package/data/packages/platform-openapi/api/Class.SwaggerTheme.md +2 -3
  486. package/data/packages/platform-openapi/api/Function.Api.md +13 -14
  487. package/data/packages/platform-openapi/api/Function.SwaggerFeature.md +4 -5
  488. package/data/packages/platform-openapi/api/Function.getRegisteredSwaggerFeatures.md +0 -1
  489. package/data/packages/platform-openapi/api/Function.getSwaggerFeatureMetadata.md +8 -7
  490. package/data/packages/platform-openapi/api/Interface.IFeatureSwaggerConfig.md +5 -6
  491. package/data/packages/platform-openapi/api/Interface.ISwaggerFeatureMetadata.md +5 -6
  492. package/data/packages/platform-openapi/api/Variable.APP_VERSION.md +1 -2
  493. package/data/packages/platform-openapi/api/Variable.PLATFORM_OPENAPI_CONFIG_ENTRIES.md +2 -3
  494. package/data/packages/platform-openapi/api/Variable.SWAGGER_CONTACT_EMAIL.md +1 -2
  495. package/data/packages/platform-openapi/api/Variable.SWAGGER_CONTACT_NAME.md +1 -2
  496. package/data/packages/platform-openapi/api/Variable.SWAGGER_CONTACT_URL.md +1 -2
  497. package/data/packages/platform-openapi/api/Variable.SWAGGER_FEATURE_METADATA_KEY.md +2 -3
  498. package/data/packages/platform-openapi/api/index.md +24 -25
  499. package/data/packages/platform-payments/api/Class.FeatureAccessPort.md +7 -8
  500. package/data/packages/platform-payments/api/Class.FeatureGuard.md +6 -7
  501. package/data/packages/platform-payments/api/Class.FeatureUsageInterceptor.md +7 -8
  502. package/data/packages/platform-payments/api/Class.LemonSqueezyClient.md +24 -25
  503. package/data/packages/platform-payments/api/Class.MollieClient.md +24 -25
  504. package/data/packages/platform-payments/api/Class.PaddleClient.md +24 -25
  505. package/data/packages/platform-payments/api/Class.PaymentClientPort.md +25 -26
  506. package/data/packages/platform-payments/api/Class.PaymentModule.md +2 -3
  507. package/data/packages/platform-payments/api/Class.StripeClient.md +28 -29
  508. package/data/packages/platform-payments/api/Function.RequiresFeature.md +2 -3
  509. package/data/packages/platform-payments/api/Interface.IFeatureAccessResult.md +4 -5
  510. package/data/packages/platform-payments/api/Interface.INormalizedCheckoutSession.md +5 -6
  511. package/data/packages/platform-payments/api/Interface.INormalizedPrice.md +6 -7
  512. package/data/packages/platform-payments/api/Interface.INormalizedSubscription.md +8 -9
  513. package/data/packages/platform-payments/api/Interface.INormalizedWebhookEvent.md +2 -3
  514. package/data/packages/platform-payments/api/Interface.IPaymentModuleOptions.md +3 -4
  515. package/data/packages/platform-payments/api/TypeAlias.SubscriptionStatus.md +9 -10
  516. package/data/packages/platform-payments/api/Variable.FEATURE_KEY_METADATA.md +2 -3
  517. package/data/packages/platform-payments/api/Variable.LEMONSQUEEZY_API_KEY.md +1 -2
  518. package/data/packages/platform-payments/api/Variable.LEMONSQUEEZY_CONFIG_ENTRIES.md +2 -3
  519. package/data/packages/platform-payments/api/Variable.LEMONSQUEEZY_STORE_ID.md +1 -2
  520. package/data/packages/platform-payments/api/Variable.LEMONSQUEEZY_WEBHOOK_SECRET.md +1 -2
  521. package/data/packages/platform-payments/api/Variable.MOLLIE_API_KEY.md +1 -2
  522. package/data/packages/platform-payments/api/Variable.MOLLIE_CONFIG_ENTRIES.md +2 -3
  523. package/data/packages/platform-payments/api/Variable.MOLLIE_WEBHOOK_SECRET.md +1 -2
  524. package/data/packages/platform-payments/api/Variable.PADDLE_API_KEY.md +1 -2
  525. package/data/packages/platform-payments/api/Variable.PADDLE_CONFIG_ENTRIES.md +2 -3
  526. package/data/packages/platform-payments/api/Variable.PADDLE_ENVIRONMENT.md +1 -2
  527. package/data/packages/platform-payments/api/Variable.PADDLE_WEBHOOK_SECRET.md +1 -2
  528. package/data/packages/platform-payments/api/Variable.STRIPE_API_KEY.md +1 -2
  529. package/data/packages/platform-payments/api/Variable.STRIPE_CONFIG_ENTRIES.md +2 -3
  530. package/data/packages/platform-payments/api/Variable.STRIPE_WEBHOOK_SECRET.md +1 -2
  531. package/data/packages/platform-payments/api/index.md +40 -41
  532. package/data/packages/platform-reporting/api/Class.ReportingContributorRegistry.md +3 -4
  533. package/data/packages/platform-reporting/api/Class.ReportingDatasetNotFoundError.md +3 -4
  534. package/data/packages/platform-reporting/api/Class.ReportingFacade.md +8 -9
  535. package/data/packages/platform-reporting/api/Class.ReportingModule.md +0 -1
  536. package/data/packages/platform-reporting/api/Interface.IReportingContributor.md +4 -5
  537. package/data/packages/platform-reporting/api/Interface.IReportingDataset.md +5 -6
  538. package/data/packages/platform-reporting/api/Interface.IReportingDatasetField.md +4 -5
  539. package/data/packages/platform-reporting/api/Interface.IReportingQuery.md +4 -5
  540. package/data/packages/platform-reporting/api/Interface.IReportingQueryFilter.md +2 -3
  541. package/data/packages/platform-reporting/api/Interface.IReportingQueryResult.md +4 -5
  542. package/data/packages/platform-reporting/api/Interface.IReportingQuerySort.md +1 -2
  543. package/data/packages/platform-reporting/api/TypeAlias.ReportingFieldType.md +1 -2
  544. package/data/packages/platform-reporting/api/TypeAlias.ReportingFilterOperator.md +1 -2
  545. package/data/packages/platform-reporting/api/TypeAlias.ReportingQueryResultRow.md +0 -1
  546. package/data/packages/platform-reporting/api/Variable.ReportingFieldTypes.md +12 -13
  547. package/data/packages/platform-reporting/api/Variable.ReportingFilterOperators.md +10 -11
  548. package/data/packages/platform-reporting/api/index.md +23 -24
  549. package/data/packages/platform-telemetry/api/Class.NoopTelemetryFacade.md +22 -23
  550. package/data/packages/platform-telemetry/api/Class.TelemetryCacheMetricsRecorder.md +26 -27
  551. package/data/packages/platform-telemetry/api/Class.TelemetryFacade.md +23 -24
  552. package/data/packages/platform-telemetry/api/Class.TelemetryLoggerService.md +35 -36
  553. package/data/packages/platform-telemetry/api/Class.TelemetryModule.md +2 -3
  554. package/data/packages/platform-telemetry/api/Class.TelemetryRuleEngine.md +4 -5
  555. package/data/packages/platform-telemetry/api/Interface.ITelemetryFacade.md +22 -23
  556. package/data/packages/platform-telemetry/api/Interface.ITelemetryMetricsOptions.md +2 -3
  557. package/data/packages/platform-telemetry/api/Interface.ITelemetryOptions.md +8 -9
  558. package/data/packages/platform-telemetry/api/Interface.ITelemetryTracesOptions.md +2 -3
  559. package/data/packages/platform-telemetry/api/Variable.TELEMETRY_ENABLED.md +1 -2
  560. package/data/packages/platform-telemetry/api/Variable.TELEMETRY_FACADE.md +1 -2
  561. package/data/packages/platform-telemetry/api/Variable.TELEMETRY_OPTIONS.md +1 -2
  562. package/data/packages/platform-telemetry/api/Variable.TELEMETRY_SHUTDOWN.md +1 -2
  563. package/data/packages/platform-telemetry/api/Variable.defaultTelemetryOptions.md +0 -1
  564. package/data/packages/platform-telemetry/api/index.md +20 -21
  565. package/package.json +1 -1
@@ -3,20 +3,19 @@ title: 'Variable: WebhookEventTypes'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
-
7
6
  # Variable: WebhookEventTypes
8
7
 
9
8
  ```ts
10
9
  const WebhookEventTypes: {
11
- SignerCompleted: 'signer.completed';
12
- SignerDeclined: 'signer.declined';
13
- SignerDelivered: 'signer.delivered';
14
- SignerSent: 'signer.sent';
15
- SigningRequestCompleted: 'signing-request.completed';
16
- SigningRequestDeclined: 'signing-request.declined';
17
- SigningRequestExpired: 'signing-request.expired';
18
- SigningRequestSent: 'signing-request.sent';
19
- SigningRequestVoided: 'signing-request.voided';
10
+ SignerCompleted: "signer.completed";
11
+ SignerDeclined: "signer.declined";
12
+ SignerDelivered: "signer.delivered";
13
+ SignerSent: "signer.sent";
14
+ SigningRequestCompleted: "signing-request.completed";
15
+ SigningRequestDeclined: "signing-request.declined";
16
+ SigningRequestExpired: "signing-request.expired";
17
+ SigningRequestSent: "signing-request.sent";
18
+ SigningRequestVoided: "signing-request.voided";
20
19
  };
21
20
  ```
22
21
 
@@ -26,14 +25,14 @@ Represents the type of webhook event emitted by a signing provider.
26
25
 
27
26
  ## Type Declaration
28
27
 
29
- | Name | Type | Default value | Defined in |
30
- | ----------------------------------------------------------------------- | ----------------------------- | ----------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
31
- | <a id="property-signercompleted"></a> `SignerCompleted` | `"signer.completed"` | `'signer.completed'` | [models/WebhookEventType.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/WebhookEventType.ts#L12) |
32
- | <a id="property-signerdeclined"></a> `SignerDeclined` | `"signer.declined"` | `'signer.declined'` | [models/WebhookEventType.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/WebhookEventType.ts#L13) |
33
- | <a id="property-signerdelivered"></a> `SignerDelivered` | `"signer.delivered"` | `'signer.delivered'` | [models/WebhookEventType.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/WebhookEventType.ts#L15) |
34
- | <a id="property-signersent"></a> `SignerSent` | `"signer.sent"` | `'signer.sent'` | [models/WebhookEventType.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/WebhookEventType.ts#L14) |
35
- | <a id="property-signingrequestcompleted"></a> `SigningRequestCompleted` | `"signing-request.completed"` | `'signing-request.completed'` | [models/WebhookEventType.ts:7](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/WebhookEventType.ts#L7) |
36
- | <a id="property-signingrequestdeclined"></a> `SigningRequestDeclined` | `"signing-request.declined"` | `'signing-request.declined'` | [models/WebhookEventType.ts:8](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/WebhookEventType.ts#L8) |
37
- | <a id="property-signingrequestexpired"></a> `SigningRequestExpired` | `"signing-request.expired"` | `'signing-request.expired'` | [models/WebhookEventType.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/WebhookEventType.ts#L10) |
38
- | <a id="property-signingrequestsent"></a> `SigningRequestSent` | `"signing-request.sent"` | `'signing-request.sent'` | [models/WebhookEventType.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/WebhookEventType.ts#L11) |
39
- | <a id="property-signingrequestvoided"></a> `SigningRequestVoided` | `"signing-request.voided"` | `'signing-request.voided'` | [models/WebhookEventType.ts:9](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/WebhookEventType.ts#L9) |
28
+ | Name | Type | Default value | Defined in |
29
+ | ------ | ------ | ------ | ------ |
30
+ | <a id="property-signercompleted"></a> `SignerCompleted` | `"signer.completed"` | `'signer.completed'` | [models/WebhookEventType.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/WebhookEventType.ts#L12) |
31
+ | <a id="property-signerdeclined"></a> `SignerDeclined` | `"signer.declined"` | `'signer.declined'` | [models/WebhookEventType.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/WebhookEventType.ts#L13) |
32
+ | <a id="property-signerdelivered"></a> `SignerDelivered` | `"signer.delivered"` | `'signer.delivered'` | [models/WebhookEventType.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/WebhookEventType.ts#L15) |
33
+ | <a id="property-signersent"></a> `SignerSent` | `"signer.sent"` | `'signer.sent'` | [models/WebhookEventType.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/WebhookEventType.ts#L14) |
34
+ | <a id="property-signingrequestcompleted"></a> `SigningRequestCompleted` | `"signing-request.completed"` | `'signing-request.completed'` | [models/WebhookEventType.ts:7](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/WebhookEventType.ts#L7) |
35
+ | <a id="property-signingrequestdeclined"></a> `SigningRequestDeclined` | `"signing-request.declined"` | `'signing-request.declined'` | [models/WebhookEventType.ts:8](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/WebhookEventType.ts#L8) |
36
+ | <a id="property-signingrequestexpired"></a> `SigningRequestExpired` | `"signing-request.expired"` | `'signing-request.expired'` | [models/WebhookEventType.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/WebhookEventType.ts#L10) |
37
+ | <a id="property-signingrequestsent"></a> `SigningRequestSent` | `"signing-request.sent"` | `'signing-request.sent'` | [models/WebhookEventType.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/WebhookEventType.ts#L11) |
38
+ | <a id="property-signingrequestvoided"></a> `SigningRequestVoided` | `"signing-request.voided"` | `'signing-request.voided'` | [models/WebhookEventType.ts:9](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-esigning/src/models/WebhookEventType.ts#L9) |
@@ -3,83 +3,82 @@ title: '@breadstone/archipel-platform-esigning'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
-
7
6
  # @breadstone/archipel-platform-esigning
8
7
 
9
8
  ## Classes
10
9
 
11
- | Class | Description |
12
- | ---------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
13
- | [EsigningClientPort](Class.EsigningClientPort) | Abstract port for e-signing provider clients. Each provider (DocuSign, Adobe Sign, Dropbox Sign, signNow, Internal) must implement this contract so that the consuming application can switch providers without changing business logic. |
14
- | [EsigningError](Class.EsigningError) | Base error for all e-signing related failures. |
15
- | [EsigningModule](Class.EsigningModule) | NestJS module providing generic e-signing infrastructure. Exposes a configurable signing client and optional persistence tracking. The specific e-signing provider is selected via the options. |
16
- | [EsigningPersistencePort](Class.EsigningPersistencePort) | Abstract port for persisting signing request state. Implement this port in the consuming application to track signing requests in a database. |
17
- | [EsigningService](Class.EsigningService) | Application-level service for e-signing operations. Delegates to the configured [EsigningClientPort](Class.EsigningClientPort) and optionally invokes the [EsigningPersistencePort](Class.EsigningPersistencePort) for state tracking. |
18
- | [InternalEsigningProvider](Class.InternalEsigningProvider) | Built-in e-signing provider that manages signing requests in-memory. This provider fulfills the same contract as external providers and can be used for development, testing, or simple self-managed signing workflows. |
19
- | [SigningProviderError](Class.SigningProviderError) | Thrown when a provider-level operation fails. |
20
- | [SigningRequestNotFoundError](Class.SigningRequestNotFoundError) | Thrown when a signing request cannot be found by the provider. |
21
- | [WebhookVerificationError](Class.WebhookVerificationError) | Thrown when a webhook signature verification fails. |
10
+ | Class | Description |
11
+ | ------ | ------ |
12
+ | [EsigningClientPort](Class.EsigningClientPort) | Abstract port for e-signing provider clients. Each provider (DocuSign, Adobe Sign, Dropbox Sign, signNow, Internal) must implement this contract so that the consuming application can switch providers without changing business logic. |
13
+ | [EsigningError](Class.EsigningError) | Base error for all e-signing related failures. |
14
+ | [EsigningModule](Class.EsigningModule) | NestJS module providing generic e-signing infrastructure. Exposes a configurable signing client and optional persistence tracking. The specific e-signing provider is selected via the options. |
15
+ | [EsigningPersistencePort](Class.EsigningPersistencePort) | Abstract port for persisting signing request state. Implement this port in the consuming application to track signing requests in a database. |
16
+ | [EsigningService](Class.EsigningService) | Application-level service for e-signing operations. Delegates to the configured [EsigningClientPort](Class.EsigningClientPort) and optionally invokes the [EsigningPersistencePort](Class.EsigningPersistencePort) for state tracking. |
17
+ | [InternalEsigningProvider](Class.InternalEsigningProvider) | Built-in e-signing provider that manages signing requests in-memory. This provider fulfills the same contract as external providers and can be used for development, testing, or simple self-managed signing workflows. |
18
+ | [SigningProviderError](Class.SigningProviderError) | Thrown when a provider-level operation fails. |
19
+ | [SigningRequestNotFoundError](Class.SigningRequestNotFoundError) | Thrown when a signing request cannot be found by the provider. |
20
+ | [WebhookVerificationError](Class.WebhookVerificationError) | Thrown when a webhook signature verification fails. |
22
21
 
23
22
  ## Interfaces
24
23
 
25
- | Interface | Description |
26
- | ------------------------------------------------------------------------ | -------------------------------------------------------------------------- |
27
- | [ICreateSigningRequest](Interface.ICreateSigningRequest) | Input for creating a new signing request. |
28
- | [ICreateSigningRequestDocument](Interface.ICreateSigningRequestDocument) | A document to include when creating a signing request. |
29
- | [ICreateSigningRequestSigner](Interface.ICreateSigningRequestSigner) | A signer to include when creating a signing request. |
30
- | [ICreateSigningSessionRequest](Interface.ICreateSigningSessionRequest) | Input for creating a signing session (signing link) for a specific signer. |
31
- | [IEsigningModuleOptions](Interface.IEsigningModuleOptions) | Configuration options for the [EsigningModule](Class.EsigningModule). |
32
- | [IEsigningWebhookEvent](Interface.IEsigningWebhookEvent) | Normalized representation of a webhook event from an e-signing provider. |
33
- | [ISignedDocument](Interface.ISignedDocument) | Normalized representation of a signed (completed) document. |
34
- | [ISigner](Interface.ISigner) | Normalized representation of a signer participating in a signing request. |
35
- | [ISigningDocument](Interface.ISigningDocument) | Normalized representation of a document within a signing request. |
36
- | [ISigningField](Interface.ISigningField) | Normalized representation of a signing field placed on a document. |
37
- | [ISigningRequest](Interface.ISigningRequest) | Normalized representation of a signing request (envelope/agreement). |
38
- | [ISigningSession](Interface.ISigningSession) | Normalized representation of a signing session or signing link. |
24
+ | Interface | Description |
25
+ | ------ | ------ |
26
+ | [ICreateSigningRequest](Interface.ICreateSigningRequest) | Input for creating a new signing request. |
27
+ | [ICreateSigningRequestDocument](Interface.ICreateSigningRequestDocument) | A document to include when creating a signing request. |
28
+ | [ICreateSigningRequestSigner](Interface.ICreateSigningRequestSigner) | A signer to include when creating a signing request. |
29
+ | [ICreateSigningSessionRequest](Interface.ICreateSigningSessionRequest) | Input for creating a signing session (signing link) for a specific signer. |
30
+ | [IEsigningModuleOptions](Interface.IEsigningModuleOptions) | Configuration options for the [EsigningModule](Class.EsigningModule). |
31
+ | [IEsigningWebhookEvent](Interface.IEsigningWebhookEvent) | Normalized representation of a webhook event from an e-signing provider. |
32
+ | [ISignedDocument](Interface.ISignedDocument) | Normalized representation of a signed (completed) document. |
33
+ | [ISigner](Interface.ISigner) | Normalized representation of a signer participating in a signing request. |
34
+ | [ISigningDocument](Interface.ISigningDocument) | Normalized representation of a document within a signing request. |
35
+ | [ISigningField](Interface.ISigningField) | Normalized representation of a signing field placed on a document. |
36
+ | [ISigningRequest](Interface.ISigningRequest) | Normalized representation of a signing request (envelope/agreement). |
37
+ | [ISigningSession](Interface.ISigningSession) | Normalized representation of a signing session or signing link. |
39
38
 
40
39
  ## Type Aliases
41
40
 
42
- | Type Alias | Description |
43
- | ------------------------------------------------------ | ---------------------------------------------------------------------------------- |
44
- | [SignerRole](TypeAlias.SignerRole) | Union type derived from [SignerRoles](Variable.SignerRoles). |
45
- | [SignerStatus](TypeAlias.SignerStatus) | Union type derived from [SignerStatuses](Variable.SignerStatuses). |
46
- | [SigningFieldType](TypeAlias.SigningFieldType) | Union type derived from [SigningFieldTypes](Variable.SigningFieldTypes). |
41
+ | Type Alias | Description |
42
+ | ------ | ------ |
43
+ | [SignerRole](TypeAlias.SignerRole) | Union type derived from [SignerRoles](Variable.SignerRoles). |
44
+ | [SignerStatus](TypeAlias.SignerStatus) | Union type derived from [SignerStatuses](Variable.SignerStatuses). |
45
+ | [SigningFieldType](TypeAlias.SigningFieldType) | Union type derived from [SigningFieldTypes](Variable.SigningFieldTypes). |
47
46
  | [SigningRequestStatus](TypeAlias.SigningRequestStatus) | Union type derived from [SigningRequestStatuses](Variable.SigningRequestStatuses). |
48
- | [WebhookEventType](TypeAlias.WebhookEventType) | Union type derived from [WebhookEventTypes](Variable.WebhookEventTypes). |
47
+ | [WebhookEventType](TypeAlias.WebhookEventType) | Union type derived from [WebhookEventTypes](Variable.WebhookEventTypes). |
49
48
 
50
49
  ## Variables
51
50
 
52
- | Variable | Description |
53
- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------- |
54
- | [ADOBE_SIGN_BASE_URL](Variable.ADOBE_SIGN_BASE_URL) | Adobe Sign base URL. |
55
- | [ADOBE_SIGN_CLIENT_SECRET](Variable.ADOBE_SIGN_CLIENT_SECRET) | Adobe Sign client secret. |
56
- | [ADOBE_SIGN_CONFIG_ENTRIES](Variable.ADOBE_SIGN_CONFIG_ENTRIES) | Configuration entries required by the Adobe Sign e-signing provider. |
57
- | [ADOBE_SIGN_INTEGRATION_KEY](Variable.ADOBE_SIGN_INTEGRATION_KEY) | Adobe Sign integration key. |
58
- | [ADOBE_SIGN_WEBHOOK_CLIENT_ID](Variable.ADOBE_SIGN_WEBHOOK_CLIENT_ID) | Adobe Sign webhook client ID for verification. |
59
- | [DOCUSIGN_ACCOUNT_ID](Variable.DOCUSIGN_ACCOUNT_ID) | DocuSign account ID. |
60
- | [DOCUSIGN_BASE_URL](Variable.DOCUSIGN_BASE_URL) | DocuSign base URL (e.g. https://demo.docusign.net for sandbox). |
61
- | [DOCUSIGN_CONFIG_ENTRIES](Variable.DOCUSIGN_CONFIG_ENTRIES) | Configuration entries required by the DocuSign e-signing provider. |
62
- | [DOCUSIGN_INTEGRATION_KEY](Variable.DOCUSIGN_INTEGRATION_KEY) | DocuSign integration key (client ID). |
63
- | [DOCUSIGN_SECRET_KEY](Variable.DOCUSIGN_SECRET_KEY) | DocuSign secret key (client secret). |
64
- | [DOCUSIGN_WEBHOOK_HMAC_KEY](Variable.DOCUSIGN_WEBHOOK_HMAC_KEY) | DocuSign webhook HMAC key. |
65
- | [DROPBOX_SIGN_API_KEY](Variable.DROPBOX_SIGN_API_KEY) | Dropbox Sign API key. |
66
- | [DROPBOX_SIGN_CLIENT_ID](Variable.DROPBOX_SIGN_CLIENT_ID) | Dropbox Sign client ID. |
67
- | [DROPBOX_SIGN_CONFIG_ENTRIES](Variable.DROPBOX_SIGN_CONFIG_ENTRIES) | Configuration entries required by the Dropbox Sign e-signing provider. |
68
- | [DROPBOX_SIGN_WEBHOOK_SECRET](Variable.DROPBOX_SIGN_WEBHOOK_SECRET) | Dropbox Sign webhook secret. |
69
- | [ESIGNING_API_BASE_URL](Variable.ESIGNING_API_BASE_URL) | Active e-signing provider base URL. |
70
- | [ESIGNING_API_KEY](Variable.ESIGNING_API_KEY) | Active e-signing provider API key. |
71
- | [ESIGNING_PROVIDER](Variable.ESIGNING_PROVIDER) | - |
72
- | [ESIGNING_PROVIDER_OPTIONS](Variable.ESIGNING_PROVIDER_OPTIONS) | - |
73
- | [ESIGNING_WEBHOOK_SECRET](Variable.ESIGNING_WEBHOOK_SECRET) | Active e-signing provider webhook signing secret. |
74
- | [PLATFORM_ESIGNING_CONFIG_ENTRIES](Variable.PLATFORM_ESIGNING_CONFIG_ENTRIES) | All configuration entries required by `platform-esigning`. |
75
- | [SignerRoles](Variable.SignerRoles) | Represents the role of a signer in a signing request. |
76
- | [SignerStatuses](Variable.SignerStatuses) | Represents the status of an individual signer within a signing request. |
77
- | [SigningFieldTypes](Variable.SigningFieldTypes) | Represents the type of a signing field placed on a document. |
78
- | [SigningRequestStatuses](Variable.SigningRequestStatuses) | Represents the lifecycle status of a signing request. |
79
- | [SIGNNOW_API_KEY](Variable.SIGNNOW_API_KEY) | signNow API key (basic token). |
80
- | [SIGNNOW_BASE_URL](Variable.SIGNNOW_BASE_URL) | signNow base URL. |
81
- | [SIGNNOW_CLIENT_ID](Variable.SIGNNOW_CLIENT_ID) | signNow client ID. |
82
- | [SIGNNOW_CLIENT_SECRET](Variable.SIGNNOW_CLIENT_SECRET) | signNow client secret. |
83
- | [SIGNNOW_CONFIG_ENTRIES](Variable.SIGNNOW_CONFIG_ENTRIES) | Configuration entries required by the signNow e-signing provider. |
84
- | [SIGNNOW_WEBHOOK_SECRET](Variable.SIGNNOW_WEBHOOK_SECRET) | signNow webhook callback secret. |
85
- | [WebhookEventTypes](Variable.WebhookEventTypes) | Represents the type of webhook event emitted by a signing provider. |
51
+ | Variable | Description |
52
+ | ------ | ------ |
53
+ | [ADOBE\_SIGN\_BASE\_URL](Variable.ADOBE_SIGN_BASE_URL) | Adobe Sign base URL. |
54
+ | [ADOBE\_SIGN\_CLIENT\_SECRET](Variable.ADOBE_SIGN_CLIENT_SECRET) | Adobe Sign client secret. |
55
+ | [ADOBE\_SIGN\_CONFIG\_ENTRIES](Variable.ADOBE_SIGN_CONFIG_ENTRIES) | Configuration entries required by the Adobe Sign e-signing provider. |
56
+ | [ADOBE\_SIGN\_INTEGRATION\_KEY](Variable.ADOBE_SIGN_INTEGRATION_KEY) | Adobe Sign integration key. |
57
+ | [ADOBE\_SIGN\_WEBHOOK\_CLIENT\_ID](Variable.ADOBE_SIGN_WEBHOOK_CLIENT_ID) | Adobe Sign webhook client ID for verification. |
58
+ | [DOCUSIGN\_ACCOUNT\_ID](Variable.DOCUSIGN_ACCOUNT_ID) | DocuSign account ID. |
59
+ | [DOCUSIGN\_BASE\_URL](Variable.DOCUSIGN_BASE_URL) | DocuSign base URL (e.g. https://demo.docusign.net for sandbox). |
60
+ | [DOCUSIGN\_CONFIG\_ENTRIES](Variable.DOCUSIGN_CONFIG_ENTRIES) | Configuration entries required by the DocuSign e-signing provider. |
61
+ | [DOCUSIGN\_INTEGRATION\_KEY](Variable.DOCUSIGN_INTEGRATION_KEY) | DocuSign integration key (client ID). |
62
+ | [DOCUSIGN\_SECRET\_KEY](Variable.DOCUSIGN_SECRET_KEY) | DocuSign secret key (client secret). |
63
+ | [DOCUSIGN\_WEBHOOK\_HMAC\_KEY](Variable.DOCUSIGN_WEBHOOK_HMAC_KEY) | DocuSign webhook HMAC key. |
64
+ | [DROPBOX\_SIGN\_API\_KEY](Variable.DROPBOX_SIGN_API_KEY) | Dropbox Sign API key. |
65
+ | [DROPBOX\_SIGN\_CLIENT\_ID](Variable.DROPBOX_SIGN_CLIENT_ID) | Dropbox Sign client ID. |
66
+ | [DROPBOX\_SIGN\_CONFIG\_ENTRIES](Variable.DROPBOX_SIGN_CONFIG_ENTRIES) | Configuration entries required by the Dropbox Sign e-signing provider. |
67
+ | [DROPBOX\_SIGN\_WEBHOOK\_SECRET](Variable.DROPBOX_SIGN_WEBHOOK_SECRET) | Dropbox Sign webhook secret. |
68
+ | [ESIGNING\_API\_BASE\_URL](Variable.ESIGNING_API_BASE_URL) | Active e-signing provider base URL. |
69
+ | [ESIGNING\_API\_KEY](Variable.ESIGNING_API_KEY) | Active e-signing provider API key. |
70
+ | [ESIGNING\_PROVIDER](Variable.ESIGNING_PROVIDER) | - |
71
+ | [ESIGNING\_PROVIDER\_OPTIONS](Variable.ESIGNING_PROVIDER_OPTIONS) | - |
72
+ | [ESIGNING\_WEBHOOK\_SECRET](Variable.ESIGNING_WEBHOOK_SECRET) | Active e-signing provider webhook signing secret. |
73
+ | [PLATFORM\_ESIGNING\_CONFIG\_ENTRIES](Variable.PLATFORM_ESIGNING_CONFIG_ENTRIES) | All configuration entries required by `platform-esigning`. |
74
+ | [SignerRoles](Variable.SignerRoles) | Represents the role of a signer in a signing request. |
75
+ | [SignerStatuses](Variable.SignerStatuses) | Represents the status of an individual signer within a signing request. |
76
+ | [SigningFieldTypes](Variable.SigningFieldTypes) | Represents the type of a signing field placed on a document. |
77
+ | [SigningRequestStatuses](Variable.SigningRequestStatuses) | Represents the lifecycle status of a signing request. |
78
+ | [SIGNNOW\_API\_KEY](Variable.SIGNNOW_API_KEY) | signNow API key (basic token). |
79
+ | [SIGNNOW\_BASE\_URL](Variable.SIGNNOW_BASE_URL) | signNow base URL. |
80
+ | [SIGNNOW\_CLIENT\_ID](Variable.SIGNNOW_CLIENT_ID) | signNow client ID. |
81
+ | [SIGNNOW\_CLIENT\_SECRET](Variable.SIGNNOW_CLIENT_SECRET) | signNow client secret. |
82
+ | [SIGNNOW\_CONFIG\_ENTRIES](Variable.SIGNNOW_CONFIG_ENTRIES) | Configuration entries required by the signNow e-signing provider. |
83
+ | [SIGNNOW\_WEBHOOK\_SECRET](Variable.SIGNNOW_WEBHOOK_SECRET) | signNow webhook callback secret. |
84
+ | [WebhookEventTypes](Variable.WebhookEventTypes) | Represents the type of webhook event emitted by a signing provider. |
@@ -3,7 +3,6 @@ title: 'Abstract Class: IntelligenceCapabilityRegistrarBase'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
-
7
6
  # Abstract Class: IntelligenceCapabilityRegistrarBase
8
7
 
9
8
  Defined in: [abstracts/IntelligenceCapabilityRegistrarBase.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/abstracts/IntelligenceCapabilityRegistrarBase.ts#L15)
@@ -29,8 +28,8 @@ Initializes a new instance of the IntelligenceCapabilityRegistrarBase class.
29
28
 
30
29
  #### Parameters
31
30
 
32
- | Parameter | Type | Description |
33
- | ---------- | ------------------------------------------------------------------------ | --------------------------------------------------------- |
31
+ | Parameter | Type | Description |
32
+ | ------ | ------ | ------ |
34
33
  | `registry` | [`IntelligenceCapabilityRegistry`](Class.IntelligenceCapabilityRegistry) | Registry instance that receives contributed capabilities. |
35
34
 
36
35
  #### Returns
@@ -71,7 +70,7 @@ Returns the capabilities that should be registered for the module.
71
70
 
72
71
  readonly [`IIntelligenceCapability`](Interface.IIntelligenceCapability)[]
73
72
 
74
- ---
73
+ ***
75
74
 
76
75
  ### onModuleInit()
77
76
 
@@ -91,5 +90,5 @@ Registers all capabilities returned by [getCapabilities](#getcapabilities).
91
90
  #### Implementation of
92
91
 
93
92
  ```ts
94
- OnModuleInit.onModuleInit;
93
+ OnModuleInit.onModuleInit
95
94
  ```
@@ -3,7 +3,6 @@ title: 'Class: IntelligenceCapabilityRegistry'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
-
7
6
  # Class: IntelligenceCapabilityRegistry
8
7
 
9
8
  Defined in: [IntelligenceCapabilityRegistry.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceCapabilityRegistry.ts#L15)
@@ -48,7 +47,7 @@ A defensive copy of the registered capabilities.
48
47
 
49
48
  [`IIntelligenceCapabilityRegistry`](Interface.IIntelligenceCapabilityRegistry).[`list`](Interface.IIntelligenceCapabilityRegistry#list)
50
49
 
51
- ---
50
+ ***
52
51
 
53
52
  ### register()
54
53
 
@@ -62,8 +61,8 @@ Registers a capability in the registry.
62
61
 
63
62
  #### Parameters
64
63
 
65
- | Parameter | Type | Description |
66
- | ------------ | -------------------------------------------------------------- | --------------------------- |
64
+ | Parameter | Type | Description |
65
+ | ------ | ------ | ------ |
67
66
  | `capability` | [`IIntelligenceCapability`](Interface.IIntelligenceCapability) | The capability to register. |
68
67
 
69
68
  #### Returns
@@ -74,12 +73,12 @@ Registers a capability in the registry.
74
73
 
75
74
  [`IIntelligenceCapabilityRegistry`](Interface.IIntelligenceCapabilityRegistry).[`register`](Interface.IIntelligenceCapabilityRegistry#register)
76
75
 
77
- ---
76
+ ***
78
77
 
79
78
  ### resolve()
80
79
 
81
80
  ```ts
82
- resolve(intent, context):
81
+ resolve(intent, context):
83
82
  | IIntelligenceCapability
84
83
  | null;
85
84
  ```
@@ -90,15 +89,15 @@ Resolves the most suitable capability for the given intent and context.
90
89
 
91
90
  #### Parameters
92
91
 
93
- | Parameter | Type | Description |
94
- | --------- | -------------------------------------------------------- | --------------------------------------- |
95
- | `intent` | [`IIntelligenceIntent`](Interface.IIntelligenceIntent) | The structured intent to match against. |
92
+ | Parameter | Type | Description |
93
+ | ------ | ------ | ------ |
94
+ | `intent` | [`IIntelligenceIntent`](Interface.IIntelligenceIntent) | The structured intent to match against. |
96
95
  | `context` | [`IIntelligenceContext`](Interface.IIntelligenceContext) | The aggregated context for the request. |
97
96
 
98
97
  #### Returns
99
98
 
100
- \| [`IIntelligenceCapability`](Interface.IIntelligenceCapability)
101
- \| `null`
99
+ \| [`IIntelligenceCapability`](Interface.IIntelligenceCapability)
100
+ \| `null`
102
101
 
103
102
  The matching capability, or `null` if none qualifies.
104
103
 
@@ -3,7 +3,6 @@ title: 'Class: IntelligenceModule'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
-
7
6
  # Class: IntelligenceModule
8
7
 
9
8
  Defined in: [IntelligenceModule.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceModule.ts#L18)
@@ -3,10 +3,9 @@ title: 'Class: IntelligenceTextGenerator'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
-
7
6
  # Class: IntelligenceTextGenerator
8
7
 
9
- Defined in: [IntelligenceTextGenerator.ts:31](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceTextGenerator.ts#L31)
8
+ Defined in: [IntelligenceTextGenerator.ts:37](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceTextGenerator.ts#L37)
10
9
 
11
10
  Executes text completions using the configured intelligence provider.
12
11
 
@@ -22,12 +21,12 @@ Executes text completions using the configured intelligence provider.
22
21
  new IntelligenceTextGenerator(configService): IntelligenceTextGenerator;
23
22
  ```
24
23
 
25
- Defined in: [IntelligenceTextGenerator.ts:44](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceTextGenerator.ts#L44)
24
+ Defined in: [IntelligenceTextGenerator.ts:50](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceTextGenerator.ts#L50)
26
25
 
27
26
  #### Parameters
28
27
 
29
- | Parameter | Type |
30
- | --------------- | --------------- |
28
+ | Parameter | Type |
29
+ | ------ | ------ |
31
30
  | `configService` | `ConfigService` |
32
31
 
33
32
  #### Returns
@@ -42,15 +41,15 @@ Defined in: [IntelligenceTextGenerator.ts:44](https://github.com/RueDeRennes/arc
42
41
  generateText(prompt, options?): Promise<IIntelligenceTextCompletion>;
43
42
  ```
44
43
 
45
- Defined in: [IntelligenceTextGenerator.ts:64](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceTextGenerator.ts#L64)
44
+ Defined in: [IntelligenceTextGenerator.ts:70](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceTextGenerator.ts#L70)
46
45
 
47
46
  Generates a completion using the configured provider.
48
47
 
49
48
  #### Parameters
50
49
 
51
- | Parameter | Type | Description |
52
- | ---------- | ------------------------------------------------------------------------------------ | --------------------------------------------------- |
53
- | `prompt` | [`IIntelligencePrompt`](Interface.IIntelligencePrompt) | The assembled prompt payload. |
50
+ | Parameter | Type | Description |
51
+ | ------ | ------ | ------ |
52
+ | `prompt` | [`IIntelligencePrompt`](Interface.IIntelligencePrompt) | The assembled prompt payload. |
54
53
  | `options?` | [`IIntelligenceTextGenerationOptions`](Interface.IIntelligenceTextGenerationOptions) | Optional overrides for the text generation request. |
55
54
 
56
55
  #### Returns
@@ -61,7 +60,7 @@ Generates a completion using the configured provider.
61
60
 
62
61
  [`IIntelligenceTextGenerator`](Interface.IIntelligenceTextGenerator).[`generateText`](Interface.IIntelligenceTextGenerator#generatetext)
63
62
 
64
- ---
63
+ ***
65
64
 
66
65
  ### getConfiguration()
67
66
 
@@ -69,7 +68,7 @@ Generates a completion using the configured provider.
69
68
  getConfiguration(): IIntelligenceProviderConfiguration;
70
69
  ```
71
70
 
72
- Defined in: [IntelligenceTextGenerator.ts:97](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceTextGenerator.ts#L97)
71
+ Defined in: [IntelligenceTextGenerator.ts:103](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/IntelligenceTextGenerator.ts#L103)
73
72
 
74
73
  Returns the resolved provider configuration.
75
74
 
@@ -3,7 +3,6 @@ title: 'Function: createProviderOptions()'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
-
7
6
  # Function: createProviderOptions()
8
7
 
9
8
  ```ts
@@ -16,8 +15,8 @@ Creates the provider options object consumed by the AI SDK model factories.
16
15
 
17
16
  ## Parameters
18
17
 
19
- | Parameter | Type | Description |
20
- | --------------- | ------------------------------------------------------------------------------------ | ------------------------------------ |
18
+ | Parameter | Type | Description |
19
+ | ------ | ------ | ------ |
21
20
  | `configuration` | [`IIntelligenceProviderConfiguration`](Interface.IIntelligenceProviderConfiguration) | The resolved provider configuration. |
22
21
 
23
22
  ## Returns
@@ -3,7 +3,6 @@ title: 'Function: loadAnthropicLanguageModel()'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
-
7
6
  # Function: loadAnthropicLanguageModel()
8
7
 
9
8
  ```ts
@@ -16,8 +15,8 @@ Loads the Anthropic language model based on the resolved provider configuration.
16
15
 
17
16
  ## Parameters
18
17
 
19
- | Parameter | Type | Description |
20
- | --------------- | ------------------------------------------------------------------------------------ | ------------------------------------ |
18
+ | Parameter | Type | Description |
19
+ | ------ | ------ | ------ |
21
20
  | `configuration` | [`IIntelligenceProviderConfiguration`](Interface.IIntelligenceProviderConfiguration) | The resolved provider configuration. |
22
21
 
23
22
  ## Returns
@@ -3,7 +3,6 @@ title: 'Function: loadGoogleLanguageModel()'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
-
7
6
  # Function: loadGoogleLanguageModel()
8
7
 
9
8
  ```ts
@@ -16,8 +15,8 @@ Loads the Google (Gemini) language model based on the resolved provider configur
16
15
 
17
16
  ## Parameters
18
17
 
19
- | Parameter | Type | Description |
20
- | --------------- | ------------------------------------------------------------------------------------ | ------------------------------------ |
18
+ | Parameter | Type | Description |
19
+ | ------ | ------ | ------ |
21
20
  | `configuration` | [`IIntelligenceProviderConfiguration`](Interface.IIntelligenceProviderConfiguration) | The resolved provider configuration. |
22
21
 
23
22
  ## Returns
@@ -3,7 +3,6 @@ title: 'Function: loadGrokLanguageModel()'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
-
7
6
  # Function: loadGrokLanguageModel()
8
7
 
9
8
  ```ts
@@ -16,8 +15,8 @@ Loads the Grok (xAI) language model based on the resolved provider configuration
16
15
 
17
16
  ## Parameters
18
17
 
19
- | Parameter | Type | Description |
20
- | --------------- | ------------------------------------------------------------------------------------ | ------------------------------------ |
18
+ | Parameter | Type | Description |
19
+ | ------ | ------ | ------ |
21
20
  | `configuration` | [`IIntelligenceProviderConfiguration`](Interface.IIntelligenceProviderConfiguration) | The resolved provider configuration. |
22
21
 
23
22
  ## Returns
@@ -3,7 +3,6 @@ title: 'Function: loadOpenAILanguageModel()'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
-
7
6
  # Function: loadOpenAILanguageModel()
8
7
 
9
8
  ```ts
@@ -16,8 +15,8 @@ Loads the OpenAI compatible language model based on the resolved provider config
16
15
 
17
16
  ## Parameters
18
17
 
19
- | Parameter | Type | Description |
20
- | --------------- | ------------------------------------------------------------------------------------ | ------------------------------------ |
18
+ | Parameter | Type | Description |
19
+ | ------ | ------ | ------ |
21
20
  | `configuration` | [`IIntelligenceProviderConfiguration`](Interface.IIntelligenceProviderConfiguration) | The resolved provider configuration. |
22
21
 
23
22
  ## Returns
@@ -3,7 +3,6 @@ title: 'Function: loadProviderFactory()'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
-
7
6
  # Function: loadProviderFactory()
8
7
 
9
8
  ```ts
@@ -16,9 +15,9 @@ Dynamically loads an AI SDK provider factory and returns the exported function r
16
15
 
17
16
  ## Parameters
18
17
 
19
- | Parameter | Type | Description |
20
- | ------------ | -------- | ------------------------------------------------- |
21
- | `moduleName` | `string` | The module that exports the factory function. |
18
+ | Parameter | Type | Description |
19
+ | ------ | ------ | ------ |
20
+ | `moduleName` | `string` | The module that exports the factory function. |
22
21
  | `exportName` | `string` | The named export containing the factory function. |
23
22
 
24
23
  ## Returns
@@ -3,7 +3,6 @@ title: 'Interface: IIntelligenceArtifact'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
-
7
6
  # Interface: IIntelligenceArtifact
8
7
 
9
8
  Defined in: [contracts/IIntelligenceArtifact.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceArtifact.ts#L6)
@@ -22,7 +21,7 @@ Defined in: [contracts/IIntelligenceArtifact.ts:21](https://github.com/RueDeRenn
22
21
 
23
22
  The structured data payload of the artifact.
24
23
 
25
- ---
24
+ ***
26
25
 
27
26
  ### type
28
27
 
@@ -3,7 +3,6 @@ title: 'Interface: IIntelligenceCapability'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
-
7
6
  # Interface: IIntelligenceCapability
8
7
 
9
8
  Defined in: [contracts/IIntelligenceCapability.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceCapability.ts#L16)
@@ -36,9 +35,9 @@ Determines whether this capability can handle the given intent and context.
36
35
 
37
36
  #### Parameters
38
37
 
39
- | Parameter | Type | Description |
40
- | --------- | -------------------------------------------------------- | --------------------------------------- |
41
- | `intent` | [`IIntelligenceIntent`](Interface.IIntelligenceIntent) | The structured intent to evaluate. |
38
+ | Parameter | Type | Description |
39
+ | ------ | ------ | ------ |
40
+ | `intent` | [`IIntelligenceIntent`](Interface.IIntelligenceIntent) | The structured intent to evaluate. |
42
41
  | `context` | [`IIntelligenceContext`](Interface.IIntelligenceContext) | The aggregated context for the request. |
43
42
 
44
43
  #### Returns
@@ -47,7 +46,7 @@ Determines whether this capability can handle the given intent and context.
47
46
 
48
47
  `true` if the capability can handle the intent; otherwise `false`.
49
48
 
50
- ---
49
+ ***
51
50
 
52
51
  ### execute()
53
52
 
@@ -61,8 +60,8 @@ Executes the capability with the given payload.
61
60
 
62
61
  #### Parameters
63
62
 
64
- | Parameter | Type | Description |
65
- | --------- | ---------------------------------------------------------------------------- | ------------------------------------ |
63
+ | Parameter | Type | Description |
64
+ | ------ | ------ | ------ |
66
65
  | `payload` | [`IIntelligenceCapabilityPayload`](Interface.IIntelligenceCapabilityPayload) | The payload forwarded for execution. |
67
66
 
68
67
  #### Returns
@@ -3,7 +3,6 @@ title: 'Interface: IIntelligenceCapabilityMetadata'
3
3
  generated: true
4
4
  editUrl: false
5
5
  ---
6
-
7
6
  # Interface: IIntelligenceCapabilityMetadata
8
7
 
9
8
  Defined in: [contracts/IIntelligenceCapabilityMetadata.ts:6](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-intelligence/src/contracts/IIntelligenceCapabilityMetadata.ts#L6)
@@ -22,7 +21,7 @@ Defined in: [contracts/IIntelligenceCapabilityMetadata.ts:28](https://github.com
22
21
 
23
22
  A brief description of what the capability does.
24
23
 
25
- ---
24
+ ***
26
25
 
27
26
  ### id
28
27
 
@@ -34,7 +33,7 @@ Defined in: [contracts/IIntelligenceCapabilityMetadata.ts:14](https://github.com
34
33
 
35
34
  Unique identifier for the capability.
36
35
 
37
- ---
36
+ ***
38
37
 
39
38
  ### intentName
40
39
 
@@ -46,7 +45,7 @@ Defined in: [contracts/IIntelligenceCapabilityMetadata.ts:42](https://github.com
46
45
 
47
46
  The intent name this capability is designed to handle.
48
47
 
49
- ---
48
+ ***
50
49
 
51
50
  ### name
52
51
 
@@ -58,7 +57,7 @@ Defined in: [contracts/IIntelligenceCapabilityMetadata.ts:21](https://github.com
58
57
 
59
58
  Human-readable name of the capability.
60
59
 
61
- ---
60
+ ***
62
61
 
63
62
  ### priority
64
63