@rockcarver/frodo-lib 4.1.4 → 4.1.4--

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 (519) hide show
  1. package/build.zip +0 -0
  2. package/docs/classes/FrodoError.html +3 -3
  3. package/docs/enums/Reference.EnforcementGroup.html +2 -2
  4. package/docs/enums/Reference.RestartStatus.html +2 -2
  5. package/docs/functions/applyCapabilityPolicy.html +1 -1
  6. package/docs/functions/buildCapabilityInventory.html +1 -1
  7. package/docs/functions/buildToolManifest.html +1 -1
  8. package/docs/functions/composeCapabilityPolicy.html +1 -1
  9. package/docs/functions/createMcpService.html +1 -1
  10. package/docs/functions/createToolRuntime.html +1 -1
  11. package/docs/functions/inferObjectType.html +1 -1
  12. package/docs/functions/inferOperationType.html +1 -1
  13. package/docs/functions/inferRiskClass.html +1 -1
  14. package/docs/functions/resolveRequestScopedFrodo.html +1 -1
  15. package/docs/interfaces/Reference.AdminFederationExportInterface.html +2 -2
  16. package/docs/interfaces/Reference.AgentExportInterface.html +2 -2
  17. package/docs/interfaces/Reference.AgentGroupExportInterface.html +2 -2
  18. package/docs/interfaces/Reference.AmConfigEntitiesInterface.html +2 -2
  19. package/docs/interfaces/Reference.AmConfigEntityInterface.html +2 -2
  20. package/docs/interfaces/Reference.ApplicationExportInterface.html +9 -9
  21. package/docs/interfaces/Reference.ApprovalTask.html +2 -2
  22. package/docs/interfaces/Reference.AuthenticationSettingsExportInterface.html +2 -2
  23. package/docs/interfaces/Reference.CertificationTemplateDeleteOptions.html +2 -2
  24. package/docs/interfaces/Reference.CertificationTemplateDeleteSkeleton.html +2 -2
  25. package/docs/interfaces/Reference.CertificationTemplateExportInterface.html +2 -2
  26. package/docs/interfaces/Reference.CertificationTemplateExportOptions.html +3 -3
  27. package/docs/interfaces/Reference.CertificationTemplateImportOptions.html +2 -2
  28. package/docs/interfaces/Reference.CertificationTemplateSkeleton.html +2 -2
  29. package/docs/interfaces/Reference.CheckboxField.html +2 -2
  30. package/docs/interfaces/Reference.CirclesOfTrustExportInterface.html +2 -2
  31. package/docs/interfaces/Reference.ConfigEntityExportInterface-1.html +2 -2
  32. package/docs/interfaces/Reference.ConfigEntityExportInterface.html +2 -2
  33. package/docs/interfaces/Reference.ConfigEntityExportOptions.html +3 -3
  34. package/docs/interfaces/Reference.ConfigEntityImportOptions.html +4 -4
  35. package/docs/interfaces/Reference.ConnectionProfileInterface.html +2 -2
  36. package/docs/interfaces/Reference.ConnectionsFileInterface.html +1 -1
  37. package/docs/interfaces/Reference.ConnectorExportInterface.html +2 -2
  38. package/docs/interfaces/Reference.ConnectorExportOptions.html +3 -3
  39. package/docs/interfaces/Reference.ConnectorImportOptions.html +2 -2
  40. package/docs/interfaces/Reference.ConnectorServerStatusInterface.html +2 -2
  41. package/docs/interfaces/Reference.CustomFormField.html +2 -2
  42. package/docs/interfaces/Reference.CustomNodeExportInterface.html +2 -2
  43. package/docs/interfaces/Reference.CustomNodeExportOptions.html +2 -2
  44. package/docs/interfaces/Reference.CustomNodeImportOptions.html +3 -3
  45. package/docs/interfaces/Reference.DateField.html +2 -2
  46. package/docs/interfaces/Reference.EmailTask.html +2 -2
  47. package/docs/interfaces/Reference.EmailTemplateExportInterface.html +2 -2
  48. package/docs/interfaces/Reference.EmailTemplateNotificationEvent.html +2 -2
  49. package/docs/interfaces/Reference.EnvInfoInterface.html +2 -2
  50. package/docs/interfaces/Reference.EventExportInterface.html +2 -2
  51. package/docs/interfaces/Reference.EventExportOptions.html +2 -2
  52. package/docs/interfaces/Reference.EventImportOptions.html +2 -2
  53. package/docs/interfaces/Reference.EventOwner.html +2 -2
  54. package/docs/interfaces/Reference.EventSkeleton.html +2 -2
  55. package/docs/interfaces/Reference.ExportMetaData.html +2 -2
  56. package/docs/interfaces/Reference.FeatureInterface.html +2 -2
  57. package/docs/interfaces/Reference.FieldRow.html +2 -2
  58. package/docs/interfaces/Reference.FormTextField.html +2 -2
  59. package/docs/interfaces/Reference.FulfillmentTask.html +2 -2
  60. package/docs/interfaces/Reference.FullExportInterface.html +2 -2
  61. package/docs/interfaces/Reference.FullExportOptions.html +11 -11
  62. package/docs/interfaces/Reference.FullGlobalExportInterface.html +2 -2
  63. package/docs/interfaces/Reference.FullImportOptions.html +9 -9
  64. package/docs/interfaces/Reference.FullRealmExportInterface.html +2 -2
  65. package/docs/interfaces/Reference.FullService.html +2 -2
  66. package/docs/interfaces/Reference.GlossarySchemaExportInterface.html +2 -2
  67. package/docs/interfaces/Reference.GlossarySchemaExportOptions.html +2 -2
  68. package/docs/interfaces/Reference.GlossarySchemaImportOptions.html +2 -2
  69. package/docs/interfaces/Reference.GlossarySchemaItemSkeleton.html +2 -2
  70. package/docs/interfaces/Reference.IdObjectSkeletonInterface.html +2 -2
  71. package/docs/interfaces/Reference.InnerNodeRefSkeletonInterface.html +2 -2
  72. package/docs/interfaces/Reference.InternalRoleExportInterface.html +3 -3
  73. package/docs/interfaces/Reference.JwkInterface.html +2 -2
  74. package/docs/interfaces/Reference.JwksInterface.html +2 -2
  75. package/docs/interfaces/Reference.ManagedObjectSchemaArrayProperty.html +2 -2
  76. package/docs/interfaces/Reference.ManagedObjectSchemaLeafProperty.html +2 -2
  77. package/docs/interfaces/Reference.ManagedObjectSchemaObjectProperty.html +2 -2
  78. package/docs/interfaces/Reference.ManagedObjectSchemaRelationshipProperty.html +2 -2
  79. package/docs/interfaces/Reference.MappingExportInterface.html +2 -2
  80. package/docs/interfaces/Reference.MappingExportOptions.html +5 -5
  81. package/docs/interfaces/Reference.MappingImportOptions.html +2 -2
  82. package/docs/interfaces/Reference.MethodHelpDoc.html +3 -3
  83. package/docs/interfaces/Reference.MethodParam.html +2 -2
  84. package/docs/interfaces/Reference.MultiSelectField.html +2 -2
  85. package/docs/interfaces/Reference.MultiTreeExportInterface.html +2 -2
  86. package/docs/interfaces/Reference.NoIdObjectSkeletonInterface.html +2 -2
  87. package/docs/interfaces/Reference.NodeExportInterface.html +2 -2
  88. package/docs/interfaces/Reference.NodeRefSkeletonInterface.html +2 -2
  89. package/docs/interfaces/Reference.OAuth2ClientExportInterface.html +2 -2
  90. package/docs/interfaces/Reference.OAuth2ClientExportOptions.html +3 -3
  91. package/docs/interfaces/Reference.OAuth2ClientImportOptions.html +2 -2
  92. package/docs/interfaces/Reference.OAuth2TrustedJwtIssuerExportInterface.html +2 -2
  93. package/docs/interfaces/Reference.OAuth2TrustedJwtIssuerExportOptions.html +3 -3
  94. package/docs/interfaces/Reference.OAuth2TrustedJwtIssuerImportOptions.html +2 -2
  95. package/docs/interfaces/Reference.PatchOperationInterface.html +2 -2
  96. package/docs/interfaces/Reference.PlatformInfoInterface.html +2 -2
  97. package/docs/interfaces/Reference.PolicyExportInterface.html +2 -2
  98. package/docs/interfaces/Reference.PolicyExportOptions.html +4 -4
  99. package/docs/interfaces/Reference.PolicyImportOptions.html +4 -4
  100. package/docs/interfaces/Reference.PolicySetExportInterface.html +2 -2
  101. package/docs/interfaces/Reference.PolicySetExportOptions.html +4 -4
  102. package/docs/interfaces/Reference.PolicySetImportOptions.html +3 -3
  103. package/docs/interfaces/Reference.RawExportOptions.html +4 -4
  104. package/docs/interfaces/Reference.RawImportOptions.html +2 -2
  105. package/docs/interfaces/Reference.RealmExportInterface.html +2 -2
  106. package/docs/interfaces/Reference.RequestFormAssignment.html +3 -3
  107. package/docs/interfaces/Reference.RequestFormEvent.html +2 -2
  108. package/docs/interfaces/Reference.RequestFormExportInterface.html +2 -2
  109. package/docs/interfaces/Reference.RequestFormExportOptions.html +3 -3
  110. package/docs/interfaces/Reference.RequestFormField.html +2 -2
  111. package/docs/interfaces/Reference.RequestFormForm.html +2 -2
  112. package/docs/interfaces/Reference.RequestFormImportOptions.html +2 -2
  113. package/docs/interfaces/Reference.RequestFormSkeleton.html +2 -2
  114. package/docs/interfaces/Reference.RequestTypeExportInterface.html +2 -2
  115. package/docs/interfaces/Reference.RequestTypeExportOptions.html +3 -3
  116. package/docs/interfaces/Reference.RequestTypeImportOptions.html +2 -2
  117. package/docs/interfaces/Reference.RequestTypeProperty.html +2 -2
  118. package/docs/interfaces/Reference.RequestTypeSchema.html +2 -2
  119. package/docs/interfaces/Reference.RequestTypeSchemas.html +2 -2
  120. package/docs/interfaces/Reference.RequestTypeSkeleton.html +2 -2
  121. package/docs/interfaces/Reference.ResourceTypeExportInterface.html +2 -2
  122. package/docs/interfaces/Reference.RoleInfo.html +2 -2
  123. package/docs/interfaces/Reference.Saml2EntitiesExportOptions.html +2 -2
  124. package/docs/interfaces/Reference.Saml2EntitiesImportOptions.html +2 -2
  125. package/docs/interfaces/Reference.Saml2ExportInterface.html +2 -2
  126. package/docs/interfaces/Reference.ScriptExportInterface.html +2 -2
  127. package/docs/interfaces/Reference.ScriptExportOptions.html +5 -5
  128. package/docs/interfaces/Reference.ScriptFilterCondition.html +3 -3
  129. package/docs/interfaces/Reference.ScriptFilterGroup.html +3 -3
  130. package/docs/interfaces/Reference.ScriptImportOptions.html +5 -5
  131. package/docs/interfaces/Reference.ScriptTask.html +2 -2
  132. package/docs/interfaces/Reference.ScriptTypeExportInterface.html +2 -2
  133. package/docs/interfaces/Reference.SearchTargetFilterOperation.html +2 -2
  134. package/docs/interfaces/Reference.SecretStoreExportInterface.html +2 -2
  135. package/docs/interfaces/Reference.SecretsExportInterface.html +2 -2
  136. package/docs/interfaces/Reference.SectionField.html +2 -2
  137. package/docs/interfaces/Reference.SecureConnectionProfileInterface.html +2 -2
  138. package/docs/interfaces/Reference.SelectField.html +2 -2
  139. package/docs/interfaces/Reference.ServerExportInterface.html +2 -2
  140. package/docs/interfaces/Reference.ServerExportOptions.html +2 -2
  141. package/docs/interfaces/Reference.ServerImportOptions.html +2 -2
  142. package/docs/interfaces/Reference.ServiceExportInterface.html +2 -2
  143. package/docs/interfaces/Reference.ServiceImportOptions.html +4 -4
  144. package/docs/interfaces/Reference.ServiceNextDescendent.html +1 -1
  145. package/docs/interfaces/Reference.SingleTreeExportInterface.html +2 -2
  146. package/docs/interfaces/Reference.SiteExportInterface.html +2 -2
  147. package/docs/interfaces/Reference.SocialIdentityProviderExportOptions.html +3 -3
  148. package/docs/interfaces/Reference.SocialIdentityProviderImportOptions.html +2 -2
  149. package/docs/interfaces/Reference.SocialProviderExportInterface.html +2 -2
  150. package/docs/interfaces/Reference.StateInterface.html +2 -2
  151. package/docs/interfaces/Reference.StaticNodeRefSkeletonInterface.html +2 -2
  152. package/docs/interfaces/Reference.StepStaticNode.html +2 -2
  153. package/docs/interfaces/Reference.SystemObjectPatchOperationInterface.html +2 -2
  154. package/docs/interfaces/Reference.SystemStatusInterface.html +2 -2
  155. package/docs/interfaces/Reference.TaskConfiguration.html +2 -2
  156. package/docs/interfaces/Reference.TextAreaField.html +2 -2
  157. package/docs/interfaces/Reference.TextField.html +2 -2
  158. package/docs/interfaces/Reference.ThemeExportInterface.html +2 -2
  159. package/docs/interfaces/Reference.TokenCacheInterface.html +1 -1
  160. package/docs/interfaces/Reference.TreeDependencyMapInterface.html +1 -1
  161. package/docs/interfaces/Reference.TreeExportOptions.html +4 -4
  162. package/docs/interfaces/Reference.TreeExportResolverInterface.html +1 -1
  163. package/docs/interfaces/Reference.TreeImportOptions.html +3 -3
  164. package/docs/interfaces/Reference.UiConfigInterface.html +2 -2
  165. package/docs/interfaces/Reference.Updates.html +3 -3
  166. package/docs/interfaces/Reference.UserExportInterface.html +2 -2
  167. package/docs/interfaces/Reference.UserGroupExportInterface.html +2 -2
  168. package/docs/interfaces/Reference.UserInfo.html +2 -2
  169. package/docs/interfaces/Reference.VariablesExportInterface.html +2 -2
  170. package/docs/interfaces/Reference.ViolationTask.html +2 -2
  171. package/docs/interfaces/Reference.WaitTask.html +2 -2
  172. package/docs/interfaces/Reference.WorkflowActor.html +2 -2
  173. package/docs/interfaces/Reference.WorkflowDeleteOptions.html +2 -2
  174. package/docs/interfaces/Reference.WorkflowExportInterface.html +2 -2
  175. package/docs/interfaces/Reference.WorkflowExportOptions.html +5 -5
  176. package/docs/interfaces/Reference.WorkflowExpression.html +2 -2
  177. package/docs/interfaces/Reference.WorkflowGroup.html +2 -2
  178. package/docs/interfaces/Reference.WorkflowImportOptions.html +2 -2
  179. package/docs/interfaces/Reference.WorkflowNotification.html +2 -2
  180. package/docs/interfaces/Reference.WorkflowSkeleton.html +2 -2
  181. package/docs/interfaces/Reference.WorkflowStaticNode.html +2 -2
  182. package/docs/types/McpCapabilityDescriptor.html +13 -13
  183. package/docs/types/McpCapabilityInventoryOptions.html +2 -2
  184. package/docs/types/McpCapabilityKind.html +1 -1
  185. package/docs/types/McpCapabilityOperationType.html +1 -1
  186. package/docs/types/McpCapabilityPolicy.html +2 -2
  187. package/docs/types/McpCapabilityPolicyPresetName.html +1 -1
  188. package/docs/types/McpCapabilityRiskClass.html +1 -1
  189. package/docs/types/McpDeploymentType.html +1 -1
  190. package/docs/types/McpDiscoveryEntry.html +8 -8
  191. package/docs/types/McpExecutionPaginationMetadata.html +8 -8
  192. package/docs/types/McpExecutionScopeMetadata.html +5 -5
  193. package/docs/types/McpGenericExecutionArguments.html +11 -11
  194. package/docs/types/McpGenericTool.html +7 -7
  195. package/docs/types/McpObjectTypeEntry.html +15 -15
  196. package/docs/types/McpRuntimeAdminAccountAuth.html +10 -10
  197. package/docs/types/McpRuntimeAuth.html +1 -1
  198. package/docs/types/McpRuntimeRequestContext.html +3 -3
  199. package/docs/types/McpRuntimeServiceAccountAuth.html +10 -10
  200. package/docs/types/McpRuntimeStateAuth.html +3 -3
  201. package/docs/types/McpService.html +7 -7
  202. package/docs/types/McpServiceOptions.html +6 -6
  203. package/docs/types/McpServiceToolDefinition.html +4 -4
  204. package/docs/types/McpSpecialExecutionArguments.html +3 -3
  205. package/docs/types/McpSpecialTool.html +5 -5
  206. package/docs/types/McpToolAnnotations.html +2 -2
  207. package/docs/types/McpToolExecutionMetadata.html +4 -4
  208. package/docs/types/McpToolExecutionRequest.html +4 -4
  209. package/docs/types/McpToolExecutionResult.html +5 -5
  210. package/docs/types/McpToolManifest.html +6 -6
  211. package/docs/types/McpToolRuntime.html +3 -3
  212. package/docs/types/McpToolRuntimeOptions.html +5 -5
  213. package/docs/types/Reference.AIAgentType.html +1 -1
  214. package/docs/types/Reference.AccessTokenMetaType.html +1 -1
  215. package/docs/types/Reference.AccessTokenResponseType.html +2 -2
  216. package/docs/types/Reference.Admin.html +2 -2
  217. package/docs/types/Reference.AdminFederation.html +12 -12
  218. package/docs/types/Reference.AdminFederationConfigSkeleton.html +1 -1
  219. package/docs/types/Reference.Agent.html +59 -59
  220. package/docs/types/Reference.AgentGroupSkeleton.html +1 -1
  221. package/docs/types/Reference.AgentSkeleton.html +1 -1
  222. package/docs/types/Reference.AgentType.html +1 -1
  223. package/docs/types/Reference.AllFlag.html +1 -1
  224. package/docs/types/Reference.AllowDuplicatesFlag.html +1 -1
  225. package/docs/types/Reference.AmConfig.html +4 -4
  226. package/docs/types/Reference.AmServiceSkeleton.html +1 -1
  227. package/docs/types/Reference.ApiFactory.html +9 -9
  228. package/docs/types/Reference.ApiVersion.html +2 -2
  229. package/docs/types/Reference.Application.html +19 -19
  230. package/docs/types/Reference.ApplicationExportOptions.html +3 -3
  231. package/docs/types/Reference.ApplicationGlossarySkeleton.html +1 -1
  232. package/docs/types/Reference.ApplicationImportOptions.html +2 -2
  233. package/docs/types/Reference.ApplicationSkeleton.html +1 -1
  234. package/docs/types/Reference.ApprovalMode.html +1 -1
  235. package/docs/types/Reference.Authenticate.html +2 -2
  236. package/docs/types/Reference.AuthenticateSuccessResponse.html +2 -2
  237. package/docs/types/Reference.AuthenticationSettings.html +5 -5
  238. package/docs/types/Reference.AuthenticationSettingsSkeleton.html +1 -1
  239. package/docs/types/Reference.Base64.html +2 -2
  240. package/docs/types/Reference.CSR.html +17 -17
  241. package/docs/types/Reference.CSRResponse.html +1 -1
  242. package/docs/types/Reference.Callback.html +2 -2
  243. package/docs/types/Reference.CallbackHandler.html +1 -1
  244. package/docs/types/Reference.CallbackKeyValuePair.html +2 -2
  245. package/docs/types/Reference.CallbackType.html +1 -1
  246. package/docs/types/Reference.CertificateResponse.html +1 -1
  247. package/docs/types/Reference.CertificationTemplate.html +13 -13
  248. package/docs/types/Reference.CertificationTemplateType.html +1 -1
  249. package/docs/types/Reference.CircleOfTrustSkeleton.html +1 -1
  250. package/docs/types/Reference.CirclesOfTrust.html +13 -13
  251. package/docs/types/Reference.ConditionFilter.html +1 -1
  252. package/docs/types/Reference.ConditionGroupOperator.html +1 -1
  253. package/docs/types/Reference.ConditionOperator.html +1 -1
  254. package/docs/types/Reference.Config.html +3 -3
  255. package/docs/types/Reference.ConfigSkeleton.html +2 -2
  256. package/docs/types/Reference.ConnectionProfile.html +13 -13
  257. package/docs/types/Reference.Connector.html +14 -14
  258. package/docs/types/Reference.ConnectorSkeleton.html +1 -1
  259. package/docs/types/Reference.Constants.html +2 -2
  260. package/docs/types/Reference.ContentSecurityPolicy.html +2 -2
  261. package/docs/types/Reference.CookieDomains.html +2 -2
  262. package/docs/types/Reference.CustomDomains.html +2 -2
  263. package/docs/types/Reference.CustomNodeProperty.html +2 -2
  264. package/docs/types/Reference.CustomNodeSkeleton.html +1 -1
  265. package/docs/types/Reference.CustomNodeUsage.html +1 -1
  266. package/docs/types/Reference.DeleteJourneyStatus.html +2 -2
  267. package/docs/types/Reference.DeleteJourneysStatus.html +1 -1
  268. package/docs/types/Reference.DirectConfigurationSessionState.html +2 -2
  269. package/docs/types/Reference.DirectiveEnabled.html +1 -1
  270. package/docs/types/Reference.DirectiveFlag.html +1 -1
  271. package/docs/types/Reference.DirectiveSource.html +1 -1
  272. package/docs/types/Reference.DirectiveSourceFlag.html +1 -1
  273. package/docs/types/Reference.EmailTemplate.html +11 -11
  274. package/docs/types/Reference.EmailTemplateSkeleton.html +1 -1
  275. package/docs/types/Reference.EngineConfigurationSkeleton.html +1 -1
  276. package/docs/types/Reference.EntityType.html +1 -1
  277. package/docs/types/Reference.EnvAIAgent.html +2 -2
  278. package/docs/types/Reference.EnvCSR.html +8 -8
  279. package/docs/types/Reference.EnvCertificate.html +11 -11
  280. package/docs/types/Reference.EnvContentSecurityPolicy.html +5 -5
  281. package/docs/types/Reference.EnvCookieDomains.html +3 -3
  282. package/docs/types/Reference.EnvCustomDomains.html +4 -4
  283. package/docs/types/Reference.EnvDirectConfigurationSession.html +5 -5
  284. package/docs/types/Reference.EnvFederationEnforcement.html +4 -4
  285. package/docs/types/Reference.EnvPromotion.html +12 -12
  286. package/docs/types/Reference.EnvRelease.html +2 -2
  287. package/docs/types/Reference.EnvSSOCookieConfig.html +4 -4
  288. package/docs/types/Reference.EnvServiceAccountScopes.html +2 -2
  289. package/docs/types/Reference.EnvironmentAndSystemPropertySecretStoreSkeleton.html +1 -1
  290. package/docs/types/Reference.EsvCount.html +2 -2
  291. package/docs/types/Reference.EsvCountResponse.html +2 -2
  292. package/docs/types/Reference.EventType.html +1 -1
  293. package/docs/types/Reference.ExportImport.html +8 -8
  294. package/docs/types/Reference.FRUtils.html +7 -7
  295. package/docs/types/Reference.Feature.html +3 -3
  296. package/docs/types/Reference.FederationEnforcement.html +2 -2
  297. package/docs/types/Reference.Field.html +1 -1
  298. package/docs/types/Reference.FieldType.html +1 -1
  299. package/docs/types/Reference.FileSystemSecretStoreSkeleton.html +1 -1
  300. package/docs/types/Reference.Frodo.html +7 -7
  301. package/docs/types/Reference.FrodoCrypto.html +2 -2
  302. package/docs/types/Reference.FrodoUtils.html +2 -2
  303. package/docs/types/Reference.GatewayAgentType.html +1 -1
  304. package/docs/types/Reference.Glossary.html +13 -13
  305. package/docs/types/Reference.GlossaryItemType.html +1 -1
  306. package/docs/types/Reference.GlossaryManagedObjectType.html +1 -1
  307. package/docs/types/Reference.GlossaryObjectType.html +1 -1
  308. package/docs/types/Reference.GlossarySkeleton.html +1 -1
  309. package/docs/types/Reference.GoogleKeyManagementServiceSecretStoreSkeleton.html +1 -1
  310. package/docs/types/Reference.GoogleSecretManagerSecretStoreProviderSkeleton.html +1 -1
  311. package/docs/types/Reference.HelpUtils.html +3 -3
  312. package/docs/types/Reference.HsmSecretStoreSkeleton.html +1 -1
  313. package/docs/types/Reference.IdmConfig.html +16 -16
  314. package/docs/types/Reference.IdmConfigStub.html +1 -1
  315. package/docs/types/Reference.IdmCrypto.html +6 -6
  316. package/docs/types/Reference.IdmScript.html +3 -3
  317. package/docs/types/Reference.IdmSystem.html +14 -14
  318. package/docs/types/Reference.Idp.html +12 -12
  319. package/docs/types/Reference.IgaEvent.html +13 -13
  320. package/docs/types/Reference.Info.html +2 -2
  321. package/docs/types/Reference.InternalRole.html +18 -18
  322. package/docs/types/Reference.InternalRoleSkeleton.html +1 -1
  323. package/docs/types/Reference.JavaAgentType.html +1 -1
  324. package/docs/types/Reference.Jose.html +2 -2
  325. package/docs/types/Reference.Journey.html +26 -26
  326. package/docs/types/Reference.JourneyClassificationType.html +1 -1
  327. package/docs/types/Reference.Json.html +7 -7
  328. package/docs/types/Reference.JwkRsa.html +1 -1
  329. package/docs/types/Reference.JwkRsaPublic.html +1 -1
  330. package/docs/types/Reference.KeyStoreSecretStoreSkeleton.html +1 -1
  331. package/docs/types/Reference.LockResponse.html +2 -2
  332. package/docs/types/Reference.LockStatus.html +2 -2
  333. package/docs/types/Reference.Log.html +13 -13
  334. package/docs/types/Reference.LogApiKey.html +2 -2
  335. package/docs/types/Reference.LogEventPayloadSkeleton.html +1 -1
  336. package/docs/types/Reference.LogEventSkeleton.html +1 -1
  337. package/docs/types/Reference.ManagedObject.html +16 -16
  338. package/docs/types/Reference.ManagedObjectSchema.html +2 -2
  339. package/docs/types/Reference.ManagedObjectSchemaLeafPropertyType.html +1 -1
  340. package/docs/types/Reference.ManagedObjectSchemaOptions.html +4 -4
  341. package/docs/types/Reference.ManagedObjectSchemaProperty.html +1 -1
  342. package/docs/types/Reference.ManagedObjectSchemaPropertyBase.html +2 -2
  343. package/docs/types/Reference.ManagedObjectSchemaPropertyType.html +1 -1
  344. package/docs/types/Reference.ManagedObjectSchemaRelationshipResourceCollectionItem.html +2 -2
  345. package/docs/types/Reference.ManagedObjectSchemaRelationshipResourceQuery.html +2 -2
  346. package/docs/types/Reference.Mapping.html +16 -16
  347. package/docs/types/Reference.MappingPolicy.html +2 -2
  348. package/docs/types/Reference.MappingProperty.html +2 -2
  349. package/docs/types/Reference.MappingSkeleton.html +1 -1
  350. package/docs/types/Reference.McpCapabilityArgumentMode.html +1 -1
  351. package/docs/types/Reference.McpCapabilityParameter.html +4 -4
  352. package/docs/types/Reference.McpCapabilityParameterSchema.html +2 -2
  353. package/docs/types/Reference.McpCapabilityScope.html +1 -1
  354. package/docs/types/Reference.McpDiscoveryObjectTypeSupport.html +2 -2
  355. package/docs/types/Reference.McpDiscoveryOperationDetail.html +2 -2
  356. package/docs/types/Reference.McpExecutionResultMetadata.html +10 -10
  357. package/docs/types/Reference.McpIdentitySurface.html +1 -1
  358. package/docs/types/Reference.Metadata.html +2 -2
  359. package/docs/types/Reference.Node.html +28 -28
  360. package/docs/types/Reference.NodeClassificationType.html +1 -1
  361. package/docs/types/Reference.NodeSkeleton.html +1 -1
  362. package/docs/types/Reference.NodeVersionFilter.html +10 -10
  363. package/docs/types/Reference.NoneFlag.html +1 -1
  364. package/docs/types/Reference.OAuth2Client.html +13 -13
  365. package/docs/types/Reference.OAuth2ClientSkeleton.html +1 -1
  366. package/docs/types/Reference.OAuth2ClientType.html +1 -1
  367. package/docs/types/Reference.OAuth2Oidc.html +2 -2
  368. package/docs/types/Reference.OAuth2Provider.html +5 -5
  369. package/docs/types/Reference.OAuth2ProviderSkeleton.html +1 -1
  370. package/docs/types/Reference.OAuth2ThingType.html +1 -1
  371. package/docs/types/Reference.OAuth2TrustedJwtIssuer.html +13 -13
  372. package/docs/types/Reference.OAuth2TrustedJwtIssuerSkeleton.html +1 -1
  373. package/docs/types/Reference.ObjectInfo.html +1 -1
  374. package/docs/types/Reference.ObjectPropertyFlag.html +1 -1
  375. package/docs/types/Reference.ObjectPropertyNativeType.html +1 -1
  376. package/docs/types/Reference.ObjectPropertySkeleton.html +2 -2
  377. package/docs/types/Reference.ObjectPropertyType.html +1 -1
  378. package/docs/types/Reference.ObjectTypeSkeleton.html +2 -2
  379. package/docs/types/Reference.Organization.html +3 -3
  380. package/docs/types/Reference.PagedResult.html +2 -2
  381. package/docs/types/Reference.PlatformInfo.html +1 -1
  382. package/docs/types/Reference.Policy.html +14 -14
  383. package/docs/types/Reference.PolicyAgentType.html +1 -1
  384. package/docs/types/Reference.PolicyCondition.html +1 -1
  385. package/docs/types/Reference.PolicyConditionType.html +1 -1
  386. package/docs/types/Reference.PolicySet.html +10 -10
  387. package/docs/types/Reference.PolicySetSkeleton.html +1 -1
  388. package/docs/types/Reference.PolicySkeleton.html +1 -1
  389. package/docs/types/Reference.ProgressIndicatorStatusType.html +1 -1
  390. package/docs/types/Reference.ProgressIndicatorType.html +1 -1
  391. package/docs/types/Reference.PromotionConfig.html +2 -2
  392. package/docs/types/Reference.PromotionConfigChange.html +2 -2
  393. package/docs/types/Reference.PromotionReport.html +2 -2
  394. package/docs/types/Reference.PromotionReportStub.html +2 -2
  395. package/docs/types/Reference.PromotionRequestConfig.html +2 -2
  396. package/docs/types/Reference.PromotionResponse.html +2 -2
  397. package/docs/types/Reference.PromotionStatus.html +2 -2
  398. package/docs/types/Reference.PromotionType.html +1 -1
  399. package/docs/types/Reference.PropertyType.html +1 -1
  400. package/docs/types/Reference.RawConfig.html +3 -3
  401. package/docs/types/Reference.Readable.html +1 -1
  402. package/docs/types/Reference.Realm.html +12 -12
  403. package/docs/types/Reference.RealmSkeleton.html +1 -1
  404. package/docs/types/Reference.Recon.html +6 -6
  405. package/docs/types/Reference.ReconStatusType.html +1 -1
  406. package/docs/types/Reference.ReconType.html +1 -1
  407. package/docs/types/Reference.RefererDirectiveFlag.html +1 -1
  408. package/docs/types/Reference.Release.html +2 -2
  409. package/docs/types/Reference.RemoteConsentAgentType.html +1 -1
  410. package/docs/types/Reference.RequestForm.html +13 -13
  411. package/docs/types/Reference.RequestFormOperationType.html +1 -1
  412. package/docs/types/Reference.RequestFormType.html +1 -1
  413. package/docs/types/Reference.RequestType.html +13 -13
  414. package/docs/types/Reference.ResourceConfig.html +2 -2
  415. package/docs/types/Reference.ResourceType.html +15 -15
  416. package/docs/types/Reference.ResourceTypeSkeleton.html +1 -1
  417. package/docs/types/Reference.ResultCallback.html +1 -1
  418. package/docs/types/Reference.RetryEverythingStrategy.html +1 -1
  419. package/docs/types/Reference.RetryNetworkStrategy.html +1 -1
  420. package/docs/types/Reference.RetryNothingStrategy.html +1 -1
  421. package/docs/types/Reference.RetryStrategy.html +1 -1
  422. package/docs/types/Reference.RollbackConfig.html +2 -2
  423. package/docs/types/Reference.RollbackResponse.html +2 -2
  424. package/docs/types/Reference.SSOCookieConfig.html +2 -2
  425. package/docs/types/Reference.Saml2.html +14 -14
  426. package/docs/types/Reference.Saml2ProiderLocation.html +1 -1
  427. package/docs/types/Reference.Saml2ProviderSkeleton.html +1 -1
  428. package/docs/types/Reference.Saml2ProviderStub.html +1 -1
  429. package/docs/types/Reference.SandboxDirectiveFlag.html +1 -1
  430. package/docs/types/Reference.Script.html +15 -15
  431. package/docs/types/Reference.ScriptContext.html +1 -1
  432. package/docs/types/Reference.ScriptFilter.html +1 -1
  433. package/docs/types/Reference.ScriptFlag.html +1 -1
  434. package/docs/types/Reference.ScriptLanguage.html +1 -1
  435. package/docs/types/Reference.ScriptSkeleton.html +1 -1
  436. package/docs/types/Reference.ScriptType.html +7 -7
  437. package/docs/types/Reference.ScriptTypeExportSkeleton.html +1 -1
  438. package/docs/types/Reference.ScriptTypeSkeleton.html +1 -1
  439. package/docs/types/Reference.ScriptValidation.html +2 -2
  440. package/docs/types/Reference.ScriptingContextSkeleton.html +1 -1
  441. package/docs/types/Reference.SearchTargetOperator.html +1 -1
  442. package/docs/types/Reference.Secret.html +18 -18
  443. package/docs/types/Reference.SecretEncodingType.html +1 -1
  444. package/docs/types/Reference.SecretSkeleton.html +1 -1
  445. package/docs/types/Reference.SecretStore.html +18 -18
  446. package/docs/types/Reference.SecretStoreExportSkeleton.html +1 -1
  447. package/docs/types/Reference.SecretStoreMappingSkeleton.html +1 -1
  448. package/docs/types/Reference.SecretStoreSchemaSkeleton.html +2 -2
  449. package/docs/types/Reference.SecretStoreSkeleton.html +1 -1
  450. package/docs/types/Reference.SelectFieldObjectType.html +1 -1
  451. package/docs/types/Reference.SelfFlag.html +1 -1
  452. package/docs/types/Reference.Server.html +11 -11
  453. package/docs/types/Reference.ServerExportSkeleton.html +1 -1
  454. package/docs/types/Reference.ServerPropertiesSkeleton.html +2 -2
  455. package/docs/types/Reference.ServerSkeleton.html +1 -1
  456. package/docs/types/Reference.Service.html +10 -10
  457. package/docs/types/Reference.ServiceAccount.html +5 -5
  458. package/docs/types/Reference.ServiceAccountScope.html +2 -2
  459. package/docs/types/Reference.ServiceAccountType.html +1 -1
  460. package/docs/types/Reference.Session.html +2 -2
  461. package/docs/types/Reference.SessionInfoType.html +2 -2
  462. package/docs/types/Reference.SharedAgentType.html +1 -1
  463. package/docs/types/Reference.Site.html +8 -8
  464. package/docs/types/Reference.SiteSkeleton.html +1 -1
  465. package/docs/types/Reference.SoapSTSAgentType.html +1 -1
  466. package/docs/types/Reference.SocialIdpSkeleton.html +1 -1
  467. package/docs/types/Reference.SoftwarePublisherType.html +1 -1
  468. package/docs/types/Reference.Startup.html +4 -4
  469. package/docs/types/Reference.State.html +10 -10
  470. package/docs/types/Reference.StepType.html +1 -1
  471. package/docs/types/Reference.SyncSkeleton.html +1 -1
  472. package/docs/types/Reference.Theme.html +14 -14
  473. package/docs/types/Reference.ThemeSkeleton.html +1 -1
  474. package/docs/types/Reference.TokenCache.html +17 -17
  475. package/docs/types/Reference.TokenInfoResponseType.html +2 -2
  476. package/docs/types/Reference.Tokens.html +2 -2
  477. package/docs/types/Reference.TreeSkeleton.html +1 -1
  478. package/docs/types/Reference.User.html +14 -14
  479. package/docs/types/Reference.UserConfigSkeleton.html +2 -2
  480. package/docs/types/Reference.UserExportSkeleton.html +1 -1
  481. package/docs/types/Reference.UserGroupSkeleton.html +1 -1
  482. package/docs/types/Reference.UserSessionMetaType.html +1 -1
  483. package/docs/types/Reference.UserSkeleton.html +1 -1
  484. package/docs/types/Reference.Variable.html +16 -16
  485. package/docs/types/Reference.VariableExpressionType.html +1 -1
  486. package/docs/types/Reference.VariableSkeleton.html +1 -1
  487. package/docs/types/Reference.Version.html +2 -2
  488. package/docs/types/Reference.VersionOfSecretSkeleton.html +1 -1
  489. package/docs/types/Reference.VersionOfSecretStatus.html +1 -1
  490. package/docs/types/Reference.WSFed.html +25 -25
  491. package/docs/types/Reference.WSFedAuthenticationAction.html +2 -2
  492. package/docs/types/Reference.WSFedAuthenticationPolicy.html +2 -2
  493. package/docs/types/Reference.WSFedAuthenticationPolicyContract.html +2 -2
  494. package/docs/types/Reference.WSFedAuthenticationPolicyContractAttribute.html +2 -2
  495. package/docs/types/Reference.WSFedAuthenticationPolicyContractRequest.html +1 -1
  496. package/docs/types/Reference.WSFedAuthenticationPolicyNode.html +2 -2
  497. package/docs/types/Reference.WSFedAuthenticationPolicyRequest.html +1 -1
  498. package/docs/types/Reference.WSFedFederationInfo.html +2 -2
  499. package/docs/types/Reference.WSFedIdpAdapter.html +2 -2
  500. package/docs/types/Reference.WSFedIdpAdapterAttribute.html +2 -2
  501. package/docs/types/Reference.WSFedIdpAdapterAttributeContractFulfillment.html +2 -2
  502. package/docs/types/Reference.WSFedIdpAdapterConfigField.html +2 -2
  503. package/docs/types/Reference.WSFedIdpAdapterConfigTable.html +2 -2
  504. package/docs/types/Reference.WSFedIdpAdapterConfigTableRow.html +2 -2
  505. package/docs/types/Reference.WSFedIdpAdapterPluginDescriptorRef.html +2 -2
  506. package/docs/types/Reference.WSFedSigningKeyPair.html +2 -2
  507. package/docs/types/Reference.WSFedSigningKeyPairRequest.html +2 -2
  508. package/docs/types/Reference.WSFedSpConnection.html +1 -1
  509. package/docs/types/Reference.WebAgentType.html +1 -1
  510. package/docs/types/Reference.Workflow.html +15 -15
  511. package/docs/types/Reference.WorkflowGroups.html +1 -1
  512. package/docs/types/Reference.WorkflowStep.html +1 -1
  513. package/docs/types/Reference.Writable.html +2 -2
  514. package/docs/types/Reference.tokenType.html +1 -1
  515. package/docs/variables/MCP_POLICY_PRESETS.html +1 -1
  516. package/docs/variables/Reference.DISCOVERY_TOOL_NAME.html +1 -1
  517. package/docs/variables/frodo.html +1 -1
  518. package/docs/variables/state.html +1 -1
  519. package/package.json +1 -1
package/docs/types/Reference.Realm.html CHANGED
@@ -1,4 +1,4 @@
1
- <!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Realm | Frodo Library - v4.1.4</title><meta name="description" content="Documentation for Frodo Library"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">Frodo Library - v4.1.4</a><div id="tsd-toolbar-links"><a href="https://github.com/rockcarver/frodo-lib">Project Home</a></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/Reference.html">Reference</a></li><li><a href="" aria-current="page">Realm</a></li></ul><h1>Type Alias Realm</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">type</span> <span class="tsd-kind-type-alias">Realm</span> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-call-signature" href="#addcustomdomain-1">addCustomDomain</a><span class="tsd-signature-symbol">(</span><br/>        <span class="tsd-kind-parameter">realmName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>        <span class="tsd-kind-parameter">domain</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="Reference.RealmSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">RealmSkeleton</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-call-signature" href="#createrealm-1">createRealm</a><span class="tsd-signature-symbol">(</span><br/>        <span class="tsd-kind-parameter">realmName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>        <span class="tsd-kind-parameter">realmData</span><span class="tsd-signature-symbol">?:</span> <a href="Reference.RealmSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">RealmSkeleton</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="Reference.RealmSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">RealmSkeleton</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-call-signature" href="#deleterealm-1">deleteRealm</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">realmId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="Reference.RealmSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">RealmSkeleton</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-call-signature" href="#deleterealmbyname-1">deleteRealmByName</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">realmName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="Reference.RealmSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">RealmSkeleton</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-call-signature" href="#exportrealms-1">exportRealms</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/Reference.RealmExportInterface.html" class="tsd-signature-type tsd-kind-interface">RealmExportInterface</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-call-signature" href="#importrealms-1">importRealms</a><span class="tsd-signature-symbol">(</span><br/>        <span class="tsd-kind-parameter">importData</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/Reference.RealmExportInterface.html" class="tsd-signature-type tsd-kind-interface">RealmExportInterface</a><span class="tsd-signature-symbol">,</span><br/>        <span class="tsd-kind-parameter">realmId</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>        <span class="tsd-kind-parameter">realmName</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="Reference.RealmSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">RealmSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-call-signature" href="#readrealm-1">readRealm</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">realmId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="Reference.RealmSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">RealmSkeleton</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-call-signature" href="#readrealmbyname-1">readRealmByName</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">realmName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="Reference.RealmSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">RealmSkeleton</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-call-signature" href="#readrealms-1">readRealms</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="Reference.RealmSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">RealmSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-call-signature" href="#removecustomdomain-1">removeCustomDomain</a><span class="tsd-signature-symbol">(</span><br/>        <span class="tsd-kind-parameter">realmName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>        <span class="tsd-kind-parameter">domain</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="Reference.RealmSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">RealmSkeleton</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-call-signature" href="#updaterealm-1">updateRealm</a><span class="tsd-signature-symbol">(</span><br/>        <span class="tsd-kind-parameter">realmId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>        <span class="tsd-kind-parameter">realmData</span><span class="tsd-signature-symbol">:</span> <a href="Reference.RealmSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">RealmSkeleton</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="Reference.RealmSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">RealmSkeleton</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/cce79e2cc5afe5546cfd870779c4d67d44527a99/src/ops/RealmOps.ts#L21">ops/RealmOps.ts:21</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="#addcustomdomain" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Custom<wbr/>Domain</span></a>
1
+ <!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Realm | Frodo Library - v4.1.4</title><meta name="description" content="Documentation for Frodo Library"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">Frodo Library - v4.1.4</a><div id="tsd-toolbar-links"><a href="https://github.com/rockcarver/frodo-lib">Project Home</a></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/Reference.html">Reference</a></li><li><a href="" aria-current="page">Realm</a></li></ul><h1>Type Alias Realm</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">type</span> <span class="tsd-kind-type-alias">Realm</span> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-call-signature" href="#addcustomdomain-1">addCustomDomain</a><span class="tsd-signature-symbol">(</span><br/>        <span class="tsd-kind-parameter">realmName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>        <span class="tsd-kind-parameter">domain</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="Reference.RealmSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">RealmSkeleton</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-call-signature" href="#createrealm-1">createRealm</a><span class="tsd-signature-symbol">(</span><br/>        <span class="tsd-kind-parameter">realmName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>        <span class="tsd-kind-parameter">realmData</span><span class="tsd-signature-symbol">?:</span> <a href="Reference.RealmSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">RealmSkeleton</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="Reference.RealmSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">RealmSkeleton</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-call-signature" href="#deleterealm-1">deleteRealm</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">realmId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="Reference.RealmSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">RealmSkeleton</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-call-signature" href="#deleterealmbyname-1">deleteRealmByName</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">realmName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="Reference.RealmSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">RealmSkeleton</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-call-signature" href="#exportrealms-1">exportRealms</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/Reference.RealmExportInterface.html" class="tsd-signature-type tsd-kind-interface">RealmExportInterface</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-call-signature" href="#importrealms-1">importRealms</a><span class="tsd-signature-symbol">(</span><br/>        <span class="tsd-kind-parameter">importData</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/Reference.RealmExportInterface.html" class="tsd-signature-type tsd-kind-interface">RealmExportInterface</a><span class="tsd-signature-symbol">,</span><br/>        <span class="tsd-kind-parameter">realmId</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>        <span class="tsd-kind-parameter">realmName</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="Reference.RealmSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">RealmSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-call-signature" href="#readrealm-1">readRealm</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">realmId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="Reference.RealmSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">RealmSkeleton</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-call-signature" href="#readrealmbyname-1">readRealmByName</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">realmName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="Reference.RealmSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">RealmSkeleton</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-call-signature" href="#readrealms-1">readRealms</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="Reference.RealmSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">RealmSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-call-signature" href="#removecustomdomain-1">removeCustomDomain</a><span class="tsd-signature-symbol">(</span><br/>        <span class="tsd-kind-parameter">realmName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>        <span class="tsd-kind-parameter">domain</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="Reference.RealmSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">RealmSkeleton</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-call-signature" href="#updaterealm-1">updateRealm</a><span class="tsd-signature-symbol">(</span><br/>        <span class="tsd-kind-parameter">realmId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>        <span class="tsd-kind-parameter">realmData</span><span class="tsd-signature-symbol">:</span> <a href="Reference.RealmSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">RealmSkeleton</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="Reference.RealmSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">RealmSkeleton</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/2532f5e8e6bb6870ab10a382d68f9e33d6f5e7de/src/ops/RealmOps.ts#L21">ops/RealmOps.ts:21</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="#addcustomdomain" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Custom<wbr/>Domain</span></a>
2
2
  <a href="#createrealm" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Realm</span></a>
3
3
  <a href="#deleterealm" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Realm</span></a>
4
4
  <a href="#deleterealmbyname" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Realm<wbr/>By<wbr/>Name</span></a>
@@ -13,37 +13,37 @@
13
13
  </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">realmName</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>realm name</p>
14
14
  </div></li><li><span><span class="tsd-kind-parameter">domain</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>domain name</p>
15
15
  </div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="Reference.RealmSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">RealmSkeleton</a><span class="tsd-signature-symbol">&gt;</span></h4><p>a promise resolving to a realm object</p>
16
- <aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/cce79e2cc5afe5546cfd870779c4d67d44527a99/src/ops/RealmOps.ts#L94">ops/RealmOps.ts:94</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="createrealm"><span>create<wbr/>Realm</span><a href="#createrealm" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="createrealm-1"><span class="tsd-kind-call-signature">createRealm</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">realmName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">realmData</span><span class="tsd-signature-symbol">?:</span> <a href="Reference.RealmSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">RealmSkeleton</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="Reference.RealmSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">RealmSkeleton</a><span class="tsd-signature-symbol">&gt;</span><a href="#createrealm-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create realm</p>
16
+ <aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/2532f5e8e6bb6870ab10a382d68f9e33d6f5e7de/src/ops/RealmOps.ts#L94">ops/RealmOps.ts:94</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="createrealm"><span>create<wbr/>Realm</span><a href="#createrealm" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="createrealm-1"><span class="tsd-kind-call-signature">createRealm</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">realmName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">realmData</span><span class="tsd-signature-symbol">?:</span> <a href="Reference.RealmSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">RealmSkeleton</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="Reference.RealmSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">RealmSkeleton</a><span class="tsd-signature-symbol">&gt;</span><a href="#createrealm-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create realm</p>
17
17
  </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">realmName</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>realm name</p>
18
18
  </div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">realmData</span>: <a href="Reference.RealmSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">RealmSkeleton</a></span><div class="tsd-comment tsd-typography"><p>realm data</p>
19
19
  </div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="Reference.RealmSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">RealmSkeleton</a><span class="tsd-signature-symbol">&gt;</span></h4><p>a promise resolving to a realm object</p>
20
- <aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/cce79e2cc5afe5546cfd870779c4d67d44527a99/src/ops/RealmOps.ts#L50">ops/RealmOps.ts:50</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="deleterealm"><span>delete<wbr/>Realm</span><a href="#deleterealm" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="deleterealm-1"><span class="tsd-kind-call-signature">deleteRealm</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">realmId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="Reference.RealmSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">RealmSkeleton</a><span class="tsd-signature-symbol">&gt;</span><a href="#deleterealm-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Delete realm</p>
20
+ <aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/2532f5e8e6bb6870ab10a382d68f9e33d6f5e7de/src/ops/RealmOps.ts#L50">ops/RealmOps.ts:50</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="deleterealm"><span>delete<wbr/>Realm</span><a href="#deleterealm" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="deleterealm-1"><span class="tsd-kind-call-signature">deleteRealm</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">realmId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="Reference.RealmSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">RealmSkeleton</a><span class="tsd-signature-symbol">&gt;</span><a href="#deleterealm-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Delete realm</p>
21
21
  </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">realmId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>realm id</p>
22
22
  </div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="Reference.RealmSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">RealmSkeleton</a><span class="tsd-signature-symbol">&gt;</span></h4><p>a promise resolving to a realm object</p>
23
- <aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/cce79e2cc5afe5546cfd870779c4d67d44527a99/src/ops/RealmOps.ts#L81">ops/RealmOps.ts:81</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="deleterealmbyname"><span>delete<wbr/>Realm<wbr/>By<wbr/>Name</span><a href="#deleterealmbyname" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="deleterealmbyname-1"><span class="tsd-kind-call-signature">deleteRealmByName</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">realmName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="Reference.RealmSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">RealmSkeleton</a><span class="tsd-signature-symbol">&gt;</span><a href="#deleterealmbyname-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Delete realm by name</p>
23
+ <aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/2532f5e8e6bb6870ab10a382d68f9e33d6f5e7de/src/ops/RealmOps.ts#L81">ops/RealmOps.ts:81</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="deleterealmbyname"><span>delete<wbr/>Realm<wbr/>By<wbr/>Name</span><a href="#deleterealmbyname" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="deleterealmbyname-1"><span class="tsd-kind-call-signature">deleteRealmByName</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">realmName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="Reference.RealmSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">RealmSkeleton</a><span class="tsd-signature-symbol">&gt;</span><a href="#deleterealmbyname-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Delete realm by name</p>
24
24
  </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">realmName</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>realm name</p>
25
25
  </div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="Reference.RealmSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">RealmSkeleton</a><span class="tsd-signature-symbol">&gt;</span></h4><p>a promise resolving to a realm object</p>
26
- <aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/cce79e2cc5afe5546cfd870779c4d67d44527a99/src/ops/RealmOps.ts#L87">ops/RealmOps.ts:87</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="exportrealms"><span>export<wbr/>Realms</span><a href="#exportrealms" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="exportrealms-1"><span class="tsd-kind-call-signature">exportRealms</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/Reference.RealmExportInterface.html" class="tsd-signature-type tsd-kind-interface">RealmExportInterface</a><span class="tsd-signature-symbol">&gt;</span><a href="#exportrealms-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Export all realms. The response can be saved to file as is.</p>
26
+ <aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/2532f5e8e6bb6870ab10a382d68f9e33d6f5e7de/src/ops/RealmOps.ts#L87">ops/RealmOps.ts:87</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="exportrealms"><span>export<wbr/>Realms</span><a href="#exportrealms" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="exportrealms-1"><span class="tsd-kind-call-signature">exportRealms</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/Reference.RealmExportInterface.html" class="tsd-signature-type tsd-kind-interface">RealmExportInterface</a><span class="tsd-signature-symbol">&gt;</span><a href="#exportrealms-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Export all realms. The response can be saved to file as is.</p>
27
27
  </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/Reference.RealmExportInterface.html" class="tsd-signature-type tsd-kind-interface">RealmExportInterface</a><span class="tsd-signature-symbol">&gt;</span></h4><p>Promise resolving to a RealmExportInterface object.</p>
28
- <aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/cce79e2cc5afe5546cfd870779c4d67d44527a99/src/ops/RealmOps.ts#L43">ops/RealmOps.ts:43</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="importrealms"><span>import<wbr/>Realms</span><a href="#importrealms" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="importrealms-1"><span class="tsd-kind-call-signature">importRealms</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">importData</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/Reference.RealmExportInterface.html" class="tsd-signature-type tsd-kind-interface">RealmExportInterface</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">realmId</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">realmName</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="Reference.RealmSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">RealmSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span><a href="#importrealms-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Import realms</p>
28
+ <aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/2532f5e8e6bb6870ab10a382d68f9e33d6f5e7de/src/ops/RealmOps.ts#L43">ops/RealmOps.ts:43</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="importrealms"><span>import<wbr/>Realms</span><a href="#importrealms" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="importrealms-1"><span class="tsd-kind-call-signature">importRealms</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">importData</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/Reference.RealmExportInterface.html" class="tsd-signature-type tsd-kind-interface">RealmExportInterface</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">realmId</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">realmName</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="Reference.RealmSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">RealmSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span><a href="#importrealms-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Import realms</p>
29
29
  </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">importData</span>: <a href="../interfaces/Reference.RealmExportInterface.html" class="tsd-signature-type tsd-kind-interface">RealmExportInterface</a></span><div class="tsd-comment tsd-typography"><p>realm import data</p>
30
30
  </div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">realmId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>Optional realm id. If supplied, only the realm of that id is imported. Takes priority over realmName if both are provided.</p>
31
31
  </div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">realmName</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>Optional realm name. If supplied, only the realm of that name is imported.</p>
32
32
  </div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="Reference.RealmSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">RealmSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4><p>the imported realms</p>
33
- <aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/cce79e2cc5afe5546cfd870779c4d67d44527a99/src/ops/RealmOps.ts#L71">ops/RealmOps.ts:71</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="readrealm"><span>read<wbr/>Realm</span><a href="#readrealm" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="readrealm-1"><span class="tsd-kind-call-signature">readRealm</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">realmId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="Reference.RealmSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">RealmSkeleton</a><span class="tsd-signature-symbol">&gt;</span><a href="#readrealm-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Read realm</p>
33
+ <aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/2532f5e8e6bb6870ab10a382d68f9e33d6f5e7de/src/ops/RealmOps.ts#L71">ops/RealmOps.ts:71</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="readrealm"><span>read<wbr/>Realm</span><a href="#readrealm" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="readrealm-1"><span class="tsd-kind-call-signature">readRealm</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">realmId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="Reference.RealmSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">RealmSkeleton</a><span class="tsd-signature-symbol">&gt;</span><a href="#readrealm-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Read realm</p>
34
34
  </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">realmId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>realm id</p>
35
35
  </div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="Reference.RealmSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">RealmSkeleton</a><span class="tsd-signature-symbol">&gt;</span></h4><p>a promise resolving to a realm object</p>
36
- <aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/cce79e2cc5afe5546cfd870779c4d67d44527a99/src/ops/RealmOps.ts#L32">ops/RealmOps.ts:32</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="readrealmbyname"><span>read<wbr/>Realm<wbr/>By<wbr/>Name</span><a href="#readrealmbyname" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="readrealmbyname-1"><span class="tsd-kind-call-signature">readRealmByName</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">realmName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="Reference.RealmSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">RealmSkeleton</a><span class="tsd-signature-symbol">&gt;</span><a href="#readrealmbyname-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Read realm by name</p>
36
+ <aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/2532f5e8e6bb6870ab10a382d68f9e33d6f5e7de/src/ops/RealmOps.ts#L32">ops/RealmOps.ts:32</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="readrealmbyname"><span>read<wbr/>Realm<wbr/>By<wbr/>Name</span><a href="#readrealmbyname" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="readrealmbyname-1"><span class="tsd-kind-call-signature">readRealmByName</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">realmName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="Reference.RealmSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">RealmSkeleton</a><span class="tsd-signature-symbol">&gt;</span><a href="#readrealmbyname-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Read realm by name</p>
37
37
  </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">realmName</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>realm name</p>
38
38
  </div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="Reference.RealmSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">RealmSkeleton</a><span class="tsd-signature-symbol">&gt;</span></h4><p>a promise resolving to a realm object</p>
39
- <aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/cce79e2cc5afe5546cfd870779c4d67d44527a99/src/ops/RealmOps.ts#L38">ops/RealmOps.ts:38</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="readrealms"><span>read<wbr/>Realms</span><a href="#readrealms" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="readrealms-1"><span class="tsd-kind-call-signature">readRealms</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="Reference.RealmSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">RealmSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span><a href="#readrealms-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Read all realms</p>
39
+ <aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/2532f5e8e6bb6870ab10a382d68f9e33d6f5e7de/src/ops/RealmOps.ts#L38">ops/RealmOps.ts:38</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="readrealms"><span>read<wbr/>Realms</span><a href="#readrealms" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="readrealms-1"><span class="tsd-kind-call-signature">readRealms</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="Reference.RealmSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">RealmSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span><a href="#readrealms-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Read all realms</p>
40
40
  </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="Reference.RealmSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">RealmSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4><p>a promise resolving to an array of realm objects</p>
41
- <aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/cce79e2cc5afe5546cfd870779c4d67d44527a99/src/ops/RealmOps.ts#L26">ops/RealmOps.ts:26</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="removecustomdomain"><span>remove<wbr/>Custom<wbr/>Domain</span><a href="#removecustomdomain" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="removecustomdomain-1"><span class="tsd-kind-call-signature">removeCustomDomain</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">realmName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">domain</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="Reference.RealmSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">RealmSkeleton</a><span class="tsd-signature-symbol">&gt;</span><a href="#removecustomdomain-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Remove custom DNS domain name (realm DNS alias)</p>
41
+ <aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/2532f5e8e6bb6870ab10a382d68f9e33d6f5e7de/src/ops/RealmOps.ts#L26">ops/RealmOps.ts:26</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="removecustomdomain"><span>remove<wbr/>Custom<wbr/>Domain</span><a href="#removecustomdomain" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="removecustomdomain-1"><span class="tsd-kind-call-signature">removeCustomDomain</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">realmName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">domain</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="Reference.RealmSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">RealmSkeleton</a><span class="tsd-signature-symbol">&gt;</span><a href="#removecustomdomain-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Remove custom DNS domain name (realm DNS alias)</p>
42
42
  </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">realmName</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>realm name</p>
43
43
  </div></li><li><span><span class="tsd-kind-parameter">domain</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>domain name</p>
44
44
  </div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="Reference.RealmSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">RealmSkeleton</a><span class="tsd-signature-symbol">&gt;</span></h4><p>a promise resolving to a realm object</p>
45
- <aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/cce79e2cc5afe5546cfd870779c4d67d44527a99/src/ops/RealmOps.ts#L101">ops/RealmOps.ts:101</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="updaterealm"><span>update<wbr/>Realm</span><a href="#updaterealm" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="updaterealm-1"><span class="tsd-kind-call-signature">updateRealm</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">realmId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">realmData</span><span class="tsd-signature-symbol">:</span> <a href="Reference.RealmSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">RealmSkeleton</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="Reference.RealmSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">RealmSkeleton</a><span class="tsd-signature-symbol">&gt;</span><a href="#updaterealm-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Update realm</p>
45
+ <aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/2532f5e8e6bb6870ab10a382d68f9e33d6f5e7de/src/ops/RealmOps.ts#L101">ops/RealmOps.ts:101</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="updaterealm"><span>update<wbr/>Realm</span><a href="#updaterealm" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="updaterealm-1"><span class="tsd-kind-call-signature">updateRealm</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">realmId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">realmData</span><span class="tsd-signature-symbol">:</span> <a href="Reference.RealmSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">RealmSkeleton</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="Reference.RealmSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">RealmSkeleton</a><span class="tsd-signature-symbol">&gt;</span><a href="#updaterealm-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Update realm</p>
46
46
  </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">realmId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>realm id</p>
47
47
  </div></li><li><span><span class="tsd-kind-parameter">realmData</span>: <a href="Reference.RealmSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">RealmSkeleton</a></span><div class="tsd-comment tsd-typography"><p>realm data</p>
48
48
  </div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="Reference.RealmSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">RealmSkeleton</a><span class="tsd-signature-symbol">&gt;</span></h4><p>a promise resolving to a realm object</p>
49
- <aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/cce79e2cc5afe5546cfd870779c4d67d44527a99/src/ops/RealmOps.ts#L60">ops/RealmOps.ts:60</a></li></ul></aside></div></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#addcustomdomain"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Custom<wbr/>Domain</span></a><a href="#createrealm"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Realm</span></a><a href="#deleterealm"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Realm</span></a><a href="#deleterealmbyname"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Realm<wbr/>By<wbr/>Name</span></a><a href="#exportrealms"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>export<wbr/>Realms</span></a><a href="#importrealms"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>import<wbr/>Realms</span></a><a href="#readrealm"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>read<wbr/>Realm</span></a><a href="#readrealmbyname"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>read<wbr/>Realm<wbr/>By<wbr/>Name</span></a><a href="#readrealms"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>read<wbr/>Realms</span></a><a href="#removecustomdomain"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>remove<wbr/>Custom<wbr/>Domain</span></a><a href="#updaterealm"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update<wbr/>Realm</span></a></div></details></div></details></div><div class="site-menu"><nav id="tsd-sidebar-links" class="tsd-navigation"><a href="https://github.com/rockcarver/frodo-lib" class="tsd-nav-link">Project Home</a></nav><nav class="tsd-navigation"><a href="../modules.html">Frodo Library - v4.1.4</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer></footer><div class="overlay"></div></body></html>
49
+ <aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/2532f5e8e6bb6870ab10a382d68f9e33d6f5e7de/src/ops/RealmOps.ts#L60">ops/RealmOps.ts:60</a></li></ul></aside></div></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#addcustomdomain"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Custom<wbr/>Domain</span></a><a href="#createrealm"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Realm</span></a><a href="#deleterealm"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Realm</span></a><a href="#deleterealmbyname"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Realm<wbr/>By<wbr/>Name</span></a><a href="#exportrealms"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>export<wbr/>Realms</span></a><a href="#importrealms"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>import<wbr/>Realms</span></a><a href="#readrealm"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>read<wbr/>Realm</span></a><a href="#readrealmbyname"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>read<wbr/>Realm<wbr/>By<wbr/>Name</span></a><a href="#readrealms"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>read<wbr/>Realms</span></a><a href="#removecustomdomain"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>remove<wbr/>Custom<wbr/>Domain</span></a><a href="#updaterealm"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update<wbr/>Realm</span></a></div></details></div></details></div><div class="site-menu"><nav id="tsd-sidebar-links" class="tsd-navigation"><a href="https://github.com/rockcarver/frodo-lib" class="tsd-nav-link">Project Home</a></nav><nav class="tsd-navigation"><a href="../modules.html">Frodo Library - v4.1.4</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer></footer><div class="overlay"></div></body></html>
package/docs/types/Reference.RealmSkeleton.html CHANGED
@@ -1 +1 @@
1
- <!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>RealmSkeleton | Frodo Library - v4.1.4</title><meta name="description" content="Documentation for Frodo Library"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">Frodo Library - v4.1.4</a><div id="tsd-toolbar-links"><a href="https://github.com/rockcarver/frodo-lib">Project Home</a></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/Reference.html">Reference</a></li><li><a href="" aria-current="page">RealmSkeleton</a></li></ul><h1>Type Alias RealmSkeleton</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">RealmSkeleton</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/Reference.IdObjectSkeletonInterface.html" class="tsd-signature-type tsd-kind-interface">IdObjectSkeletonInterface</a> <span class="tsd-signature-symbol">&amp;</span> <span class="tsd-signature-symbol">{</span><br/>    <span class="tsd-kind-property">active</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">aliases</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">parentPath</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/cce79e2cc5afe5546cfd870779c4d67d44527a99/src/api/RealmApi.ts#L19">api/RealmApi.ts:19</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav id="tsd-sidebar-links" class="tsd-navigation"><a href="https://github.com/rockcarver/frodo-lib" class="tsd-nav-link">Project Home</a></nav><nav class="tsd-navigation"><a href="../modules.html">Frodo Library - v4.1.4</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer></footer><div class="overlay"></div></body></html>
1
+ <!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>RealmSkeleton | Frodo Library - v4.1.4</title><meta name="description" content="Documentation for Frodo Library"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">Frodo Library - v4.1.4</a><div id="tsd-toolbar-links"><a href="https://github.com/rockcarver/frodo-lib">Project Home</a></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/Reference.html">Reference</a></li><li><a href="" aria-current="page">RealmSkeleton</a></li></ul><h1>Type Alias RealmSkeleton</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">RealmSkeleton</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/Reference.IdObjectSkeletonInterface.html" class="tsd-signature-type tsd-kind-interface">IdObjectSkeletonInterface</a> <span class="tsd-signature-symbol">&amp;</span> <span class="tsd-signature-symbol">{</span><br/>    <span class="tsd-kind-property">active</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">aliases</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">parentPath</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/2532f5e8e6bb6870ab10a382d68f9e33d6f5e7de/src/api/RealmApi.ts#L19">api/RealmApi.ts:19</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav id="tsd-sidebar-links" class="tsd-navigation"><a href="https://github.com/rockcarver/frodo-lib" class="tsd-nav-link">Project Home</a></nav><nav class="tsd-navigation"><a href="../modules.html">Frodo Library - v4.1.4</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer></footer><div class="overlay"></div></body></html>
package/docs/types/Reference.Recon.html CHANGED
@@ -1,4 +1,4 @@
1
- <!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Recon | Frodo Library - v4.1.4</title><meta name="description" content="Documentation for Frodo Library"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">Frodo Library - v4.1.4</a><div id="tsd-toolbar-links"><a href="https://github.com/rockcarver/frodo-lib">Project Home</a></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/Reference.html">Reference</a></li><li><a href="" aria-current="page">Recon</a></li></ul><h1>Type Alias Recon</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">type</span> <span class="tsd-kind-type-alias">Recon</span> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-call-signature" href="#cancelrecon-1">cancelRecon</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">reconId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="Reference.ReconStatusType.html" class="tsd-signature-type tsd-kind-type-alias">ReconStatusType</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-call-signature" href="#readrecon-1">readRecon</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">reconId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="Reference.ReconType.html" class="tsd-signature-type tsd-kind-type-alias">ReconType</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-call-signature" href="#readrecons-1">readRecons</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="Reference.ReconType.html" class="tsd-signature-type tsd-kind-type-alias">ReconType</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-call-signature" href="#startrecon-1">startRecon</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">mappingName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="Reference.ReconStatusType.html" class="tsd-signature-type tsd-kind-type-alias">ReconStatusType</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-call-signature" href="#startreconbyid-1">startReconById</a><span class="tsd-signature-symbol">(</span><br/>        <span class="tsd-kind-parameter">mappingName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>        <span class="tsd-kind-parameter">objectId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="Reference.ReconStatusType.html" class="tsd-signature-type tsd-kind-type-alias">ReconStatusType</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/cce79e2cc5afe5546cfd870779c4d67d44527a99/src/ops/ReconOps.ts#L12">ops/ReconOps.ts:12</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="#cancelrecon" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>cancel<wbr/>Recon</span></a>
1
+ <!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Recon | Frodo Library - v4.1.4</title><meta name="description" content="Documentation for Frodo Library"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">Frodo Library - v4.1.4</a><div id="tsd-toolbar-links"><a href="https://github.com/rockcarver/frodo-lib">Project Home</a></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/Reference.html">Reference</a></li><li><a href="" aria-current="page">Recon</a></li></ul><h1>Type Alias Recon</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">type</span> <span class="tsd-kind-type-alias">Recon</span> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-call-signature" href="#cancelrecon-1">cancelRecon</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">reconId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="Reference.ReconStatusType.html" class="tsd-signature-type tsd-kind-type-alias">ReconStatusType</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-call-signature" href="#readrecon-1">readRecon</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">reconId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="Reference.ReconType.html" class="tsd-signature-type tsd-kind-type-alias">ReconType</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-call-signature" href="#readrecons-1">readRecons</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="Reference.ReconType.html" class="tsd-signature-type tsd-kind-type-alias">ReconType</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-call-signature" href="#startrecon-1">startRecon</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">mappingName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="Reference.ReconStatusType.html" class="tsd-signature-type tsd-kind-type-alias">ReconStatusType</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-call-signature" href="#startreconbyid-1">startReconById</a><span class="tsd-signature-symbol">(</span><br/>        <span class="tsd-kind-parameter">mappingName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>        <span class="tsd-kind-parameter">objectId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="Reference.ReconStatusType.html" class="tsd-signature-type tsd-kind-type-alias">ReconStatusType</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/2532f5e8e6bb6870ab10a382d68f9e33d6f5e7de/src/ops/ReconOps.ts#L12">ops/ReconOps.ts:12</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="#cancelrecon" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>cancel<wbr/>Recon</span></a>
2
2
  <a href="#readrecon" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>read<wbr/>Recon</span></a>
3
3
  <a href="#readrecons" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>read<wbr/>Recons</span></a>
4
4
  <a href="#startrecon" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>start<wbr/>Recon</span></a>
@@ -6,16 +6,16 @@
6
6
  </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Methods</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="cancelrecon"><span>cancel<wbr/>Recon</span><a href="#cancelrecon" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="cancelrecon-1"><span class="tsd-kind-call-signature">cancelRecon</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">reconId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="Reference.ReconStatusType.html" class="tsd-signature-type tsd-kind-type-alias">ReconStatusType</a><span class="tsd-signature-symbol">&gt;</span><a href="#cancelrecon-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Cancel a reconciliation</p>
7
7
  </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">reconId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>id of the recon to cancel</p>
8
8
  </div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="Reference.ReconStatusType.html" class="tsd-signature-type tsd-kind-type-alias">ReconStatusType</a><span class="tsd-signature-symbol">&gt;</span></h4><p>a promise resolving to a recon status object</p>
9
- <aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/cce79e2cc5afe5546cfd870779c4d67d44527a99/src/ops/ReconOps.ts#L45">ops/ReconOps.ts:45</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="readrecon"><span>read<wbr/>Recon</span><a href="#readrecon" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="readrecon-1"><span class="tsd-kind-call-signature">readRecon</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">reconId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="Reference.ReconType.html" class="tsd-signature-type tsd-kind-type-alias">ReconType</a><span class="tsd-signature-symbol">&gt;</span><a href="#readrecon-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Read recon</p>
9
+ <aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/2532f5e8e6bb6870ab10a382d68f9e33d6f5e7de/src/ops/ReconOps.ts#L45">ops/ReconOps.ts:45</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="readrecon"><span>read<wbr/>Recon</span><a href="#readrecon" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="readrecon-1"><span class="tsd-kind-call-signature">readRecon</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">reconId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="Reference.ReconType.html" class="tsd-signature-type tsd-kind-type-alias">ReconType</a><span class="tsd-signature-symbol">&gt;</span><a href="#readrecon-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Read recon</p>
10
10
  </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">reconId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>id of the recon</p>
11
11
  </div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="Reference.ReconType.html" class="tsd-signature-type tsd-kind-type-alias">ReconType</a><span class="tsd-signature-symbol">&gt;</span></h4><p>a promise resolving to a recon object</p>
12
- <aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/cce79e2cc5afe5546cfd870779c4d67d44527a99/src/ops/ReconOps.ts#L23">ops/ReconOps.ts:23</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="readrecons"><span>read<wbr/>Recons</span><a href="#readrecons" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="readrecons-1"><span class="tsd-kind-call-signature">readRecons</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="Reference.ReconType.html" class="tsd-signature-type tsd-kind-type-alias">ReconType</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span><a href="#readrecons-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Read all reconciliation runs</p>
12
+ <aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/2532f5e8e6bb6870ab10a382d68f9e33d6f5e7de/src/ops/ReconOps.ts#L23">ops/ReconOps.ts:23</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="readrecons"><span>read<wbr/>Recons</span><a href="#readrecons" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="readrecons-1"><span class="tsd-kind-call-signature">readRecons</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="Reference.ReconType.html" class="tsd-signature-type tsd-kind-type-alias">ReconType</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span><a href="#readrecons-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Read all reconciliation runs</p>
13
13
  </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="Reference.ReconType.html" class="tsd-signature-type tsd-kind-type-alias">ReconType</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4><p>a promise resolving to an array of recon objects</p>
14
- <aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/cce79e2cc5afe5546cfd870779c4d67d44527a99/src/ops/ReconOps.ts#L17">ops/ReconOps.ts:17</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="startrecon"><span>start<wbr/>Recon</span><a href="#startrecon" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="startrecon-1"><span class="tsd-kind-call-signature">startRecon</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">mappingName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="Reference.ReconStatusType.html" class="tsd-signature-type tsd-kind-type-alias">ReconStatusType</a><span class="tsd-signature-symbol">&gt;</span><a href="#startrecon-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Start a reconciliation</p>
14
+ <aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/2532f5e8e6bb6870ab10a382d68f9e33d6f5e7de/src/ops/ReconOps.ts#L17">ops/ReconOps.ts:17</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="startrecon"><span>start<wbr/>Recon</span><a href="#startrecon" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="startrecon-1"><span class="tsd-kind-call-signature">startRecon</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">mappingName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="Reference.ReconStatusType.html" class="tsd-signature-type tsd-kind-type-alias">ReconStatusType</a><span class="tsd-signature-symbol">&gt;</span><a href="#startrecon-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Start a reconciliation</p>
15
15
  </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">mappingName</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>mapping to reconcile</p>
16
16
  </div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="Reference.ReconStatusType.html" class="tsd-signature-type tsd-kind-type-alias">ReconStatusType</a><span class="tsd-signature-symbol">&gt;</span></h4><p>a promise resolving to a recon status object</p>
17
- <aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/cce79e2cc5afe5546cfd870779c4d67d44527a99/src/ops/ReconOps.ts#L29">ops/ReconOps.ts:29</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="startreconbyid"><span>start<wbr/>Recon<wbr/>By<wbr/>Id</span><a href="#startreconbyid" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="startreconbyid-1"><span class="tsd-kind-call-signature">startReconById</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">mappingName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">objectId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="Reference.ReconStatusType.html" class="tsd-signature-type tsd-kind-type-alias">ReconStatusType</a><span class="tsd-signature-symbol">&gt;</span><a href="#startreconbyid-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Start a reconciliation by Id</p>
17
+ <aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/2532f5e8e6bb6870ab10a382d68f9e33d6f5e7de/src/ops/ReconOps.ts#L29">ops/ReconOps.ts:29</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="startreconbyid"><span>start<wbr/>Recon<wbr/>By<wbr/>Id</span><a href="#startreconbyid" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="startreconbyid-1"><span class="tsd-kind-call-signature">startReconById</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">mappingName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">objectId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="Reference.ReconStatusType.html" class="tsd-signature-type tsd-kind-type-alias">ReconStatusType</a><span class="tsd-signature-symbol">&gt;</span><a href="#startreconbyid-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Start a reconciliation by Id</p>
18
18
  </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">mappingName</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>mapping to reconcile</p>
19
19
  </div></li><li><span><span class="tsd-kind-parameter">objectId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>id of object to reconcile</p>
20
20
  </div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="Reference.ReconStatusType.html" class="tsd-signature-type tsd-kind-type-alias">ReconStatusType</a><span class="tsd-signature-symbol">&gt;</span></h4><p>a promise resolving to a recon status object</p>
21
- <aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/cce79e2cc5afe5546cfd870779c4d67d44527a99/src/ops/ReconOps.ts#L36">ops/ReconOps.ts:36</a></li></ul></aside></div></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#cancelrecon"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>cancel<wbr/>Recon</span></a><a href="#readrecon"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>read<wbr/>Recon</span></a><a href="#readrecons"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>read<wbr/>Recons</span></a><a href="#startrecon"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>start<wbr/>Recon</span></a><a href="#startreconbyid"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>start<wbr/>Recon<wbr/>By<wbr/>Id</span></a></div></details></div></details></div><div class="site-menu"><nav id="tsd-sidebar-links" class="tsd-navigation"><a href="https://github.com/rockcarver/frodo-lib" class="tsd-nav-link">Project Home</a></nav><nav class="tsd-navigation"><a href="../modules.html">Frodo Library - v4.1.4</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer></footer><div class="overlay"></div></body></html>
21
+ <aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/2532f5e8e6bb6870ab10a382d68f9e33d6f5e7de/src/ops/ReconOps.ts#L36">ops/ReconOps.ts:36</a></li></ul></aside></div></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#cancelrecon"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>cancel<wbr/>Recon</span></a><a href="#readrecon"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>read<wbr/>Recon</span></a><a href="#readrecons"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>read<wbr/>Recons</span></a><a href="#startrecon"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>start<wbr/>Recon</span></a><a href="#startreconbyid"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>start<wbr/>Recon<wbr/>By<wbr/>Id</span></a></div></details></div></details></div><div class="site-menu"><nav id="tsd-sidebar-links" class="tsd-navigation"><a href="https://github.com/rockcarver/frodo-lib" class="tsd-nav-link">Project Home</a></nav><nav class="tsd-navigation"><a href="../modules.html">Frodo Library - v4.1.4</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer></footer><div class="overlay"></div></body></html>
package/docs/types/Reference.ReconStatusType.html CHANGED
@@ -1 +1 @@
1
- <!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ReconStatusType | Frodo Library - v4.1.4</title><meta name="description" content="Documentation for Frodo Library"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">Frodo Library - v4.1.4</a><div id="tsd-toolbar-links"><a href="https://github.com/rockcarver/frodo-lib">Project Home</a></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/Reference.html">Reference</a></li><li><a href="" aria-current="page">ReconStatusType</a></li></ul><h1>Type Alias ReconStatusType</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">ReconStatusType</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/Reference.IdObjectSkeletonInterface.html" class="tsd-signature-type tsd-kind-interface">IdObjectSkeletonInterface</a> <span class="tsd-signature-symbol">&amp;</span> <span class="tsd-signature-symbol">{</span><br/>    <span class="tsd-kind-property">action</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;cancel&quot;</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">state</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;ACTIVE&quot;</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">status</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;INITIATED&quot;</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/cce79e2cc5afe5546cfd870779c4d67d44527a99/src/api/ReconApi.ts#L144">api/ReconApi.ts:144</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav id="tsd-sidebar-links" class="tsd-navigation"><a href="https://github.com/rockcarver/frodo-lib" class="tsd-nav-link">Project Home</a></nav><nav class="tsd-navigation"><a href="../modules.html">Frodo Library - v4.1.4</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer></footer><div class="overlay"></div></body></html>
1
+ <!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ReconStatusType | Frodo Library - v4.1.4</title><meta name="description" content="Documentation for Frodo Library"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">Frodo Library - v4.1.4</a><div id="tsd-toolbar-links"><a href="https://github.com/rockcarver/frodo-lib">Project Home</a></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/Reference.html">Reference</a></li><li><a href="" aria-current="page">ReconStatusType</a></li></ul><h1>Type Alias ReconStatusType</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">ReconStatusType</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/Reference.IdObjectSkeletonInterface.html" class="tsd-signature-type tsd-kind-interface">IdObjectSkeletonInterface</a> <span class="tsd-signature-symbol">&amp;</span> <span class="tsd-signature-symbol">{</span><br/>    <span class="tsd-kind-property">action</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;cancel&quot;</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">state</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;ACTIVE&quot;</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">status</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;INITIATED&quot;</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/2532f5e8e6bb6870ab10a382d68f9e33d6f5e7de/src/api/ReconApi.ts#L144">api/ReconApi.ts:144</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav id="tsd-sidebar-links" class="tsd-navigation"><a href="https://github.com/rockcarver/frodo-lib" class="tsd-nav-link">Project Home</a></nav><nav class="tsd-navigation"><a href="../modules.html">Frodo Library - v4.1.4</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer></footer><div class="overlay"></div></body></html>