@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.
- package/build.zip +0 -0
- package/docs/classes/FrodoError.html +3 -3
- package/docs/enums/Reference.EnforcementGroup.html +2 -2
- package/docs/enums/Reference.RestartStatus.html +2 -2
- package/docs/functions/applyCapabilityPolicy.html +1 -1
- package/docs/functions/buildCapabilityInventory.html +1 -1
- package/docs/functions/buildToolManifest.html +1 -1
- package/docs/functions/composeCapabilityPolicy.html +1 -1
- package/docs/functions/createMcpService.html +1 -1
- package/docs/functions/createToolRuntime.html +1 -1
- package/docs/functions/inferObjectType.html +1 -1
- package/docs/functions/inferOperationType.html +1 -1
- package/docs/functions/inferRiskClass.html +1 -1
- package/docs/functions/resolveRequestScopedFrodo.html +1 -1
- package/docs/interfaces/Reference.AdminFederationExportInterface.html +2 -2
- package/docs/interfaces/Reference.AgentExportInterface.html +2 -2
- package/docs/interfaces/Reference.AgentGroupExportInterface.html +2 -2
- package/docs/interfaces/Reference.AmConfigEntitiesInterface.html +2 -2
- package/docs/interfaces/Reference.AmConfigEntityInterface.html +2 -2
- package/docs/interfaces/Reference.ApplicationExportInterface.html +9 -9
- package/docs/interfaces/Reference.ApprovalTask.html +2 -2
- package/docs/interfaces/Reference.AuthenticationSettingsExportInterface.html +2 -2
- package/docs/interfaces/Reference.CertificationTemplateDeleteOptions.html +2 -2
- package/docs/interfaces/Reference.CertificationTemplateDeleteSkeleton.html +2 -2
- package/docs/interfaces/Reference.CertificationTemplateExportInterface.html +2 -2
- package/docs/interfaces/Reference.CertificationTemplateExportOptions.html +3 -3
- package/docs/interfaces/Reference.CertificationTemplateImportOptions.html +2 -2
- package/docs/interfaces/Reference.CertificationTemplateSkeleton.html +2 -2
- package/docs/interfaces/Reference.CheckboxField.html +2 -2
- package/docs/interfaces/Reference.CirclesOfTrustExportInterface.html +2 -2
- package/docs/interfaces/Reference.ConfigEntityExportInterface-1.html +2 -2
- package/docs/interfaces/Reference.ConfigEntityExportInterface.html +2 -2
- package/docs/interfaces/Reference.ConfigEntityExportOptions.html +3 -3
- package/docs/interfaces/Reference.ConfigEntityImportOptions.html +4 -4
- package/docs/interfaces/Reference.ConnectionProfileInterface.html +2 -2
- package/docs/interfaces/Reference.ConnectionsFileInterface.html +1 -1
- package/docs/interfaces/Reference.ConnectorExportInterface.html +2 -2
- package/docs/interfaces/Reference.ConnectorExportOptions.html +3 -3
- package/docs/interfaces/Reference.ConnectorImportOptions.html +2 -2
- package/docs/interfaces/Reference.ConnectorServerStatusInterface.html +2 -2
- package/docs/interfaces/Reference.CustomFormField.html +2 -2
- package/docs/interfaces/Reference.CustomNodeExportInterface.html +2 -2
- package/docs/interfaces/Reference.CustomNodeExportOptions.html +2 -2
- package/docs/interfaces/Reference.CustomNodeImportOptions.html +3 -3
- package/docs/interfaces/Reference.DateField.html +2 -2
- package/docs/interfaces/Reference.EmailTask.html +2 -2
- package/docs/interfaces/Reference.EmailTemplateExportInterface.html +2 -2
- package/docs/interfaces/Reference.EmailTemplateNotificationEvent.html +2 -2
- package/docs/interfaces/Reference.EnvInfoInterface.html +2 -2
- package/docs/interfaces/Reference.EventExportInterface.html +2 -2
- package/docs/interfaces/Reference.EventExportOptions.html +2 -2
- package/docs/interfaces/Reference.EventImportOptions.html +2 -2
- package/docs/interfaces/Reference.EventOwner.html +2 -2
- package/docs/interfaces/Reference.EventSkeleton.html +2 -2
- package/docs/interfaces/Reference.ExportMetaData.html +2 -2
- package/docs/interfaces/Reference.FeatureInterface.html +2 -2
- package/docs/interfaces/Reference.FieldRow.html +2 -2
- package/docs/interfaces/Reference.FormTextField.html +2 -2
- package/docs/interfaces/Reference.FulfillmentTask.html +2 -2
- package/docs/interfaces/Reference.FullExportInterface.html +2 -2
- package/docs/interfaces/Reference.FullExportOptions.html +11 -11
- package/docs/interfaces/Reference.FullGlobalExportInterface.html +2 -2
- package/docs/interfaces/Reference.FullImportOptions.html +9 -9
- package/docs/interfaces/Reference.FullRealmExportInterface.html +2 -2
- package/docs/interfaces/Reference.FullService.html +2 -2
- package/docs/interfaces/Reference.GlossarySchemaExportInterface.html +2 -2
- package/docs/interfaces/Reference.GlossarySchemaExportOptions.html +2 -2
- package/docs/interfaces/Reference.GlossarySchemaImportOptions.html +2 -2
- package/docs/interfaces/Reference.GlossarySchemaItemSkeleton.html +2 -2
- package/docs/interfaces/Reference.IdObjectSkeletonInterface.html +2 -2
- package/docs/interfaces/Reference.InnerNodeRefSkeletonInterface.html +2 -2
- package/docs/interfaces/Reference.InternalRoleExportInterface.html +3 -3
- package/docs/interfaces/Reference.JwkInterface.html +2 -2
- package/docs/interfaces/Reference.JwksInterface.html +2 -2
- package/docs/interfaces/Reference.ManagedObjectSchemaArrayProperty.html +2 -2
- package/docs/interfaces/Reference.ManagedObjectSchemaLeafProperty.html +2 -2
- package/docs/interfaces/Reference.ManagedObjectSchemaObjectProperty.html +2 -2
- package/docs/interfaces/Reference.ManagedObjectSchemaRelationshipProperty.html +2 -2
- package/docs/interfaces/Reference.MappingExportInterface.html +2 -2
- package/docs/interfaces/Reference.MappingExportOptions.html +5 -5
- package/docs/interfaces/Reference.MappingImportOptions.html +2 -2
- package/docs/interfaces/Reference.MethodHelpDoc.html +3 -3
- package/docs/interfaces/Reference.MethodParam.html +2 -2
- package/docs/interfaces/Reference.MultiSelectField.html +2 -2
- package/docs/interfaces/Reference.MultiTreeExportInterface.html +2 -2
- package/docs/interfaces/Reference.NoIdObjectSkeletonInterface.html +2 -2
- package/docs/interfaces/Reference.NodeExportInterface.html +2 -2
- package/docs/interfaces/Reference.NodeRefSkeletonInterface.html +2 -2
- package/docs/interfaces/Reference.OAuth2ClientExportInterface.html +2 -2
- package/docs/interfaces/Reference.OAuth2ClientExportOptions.html +3 -3
- package/docs/interfaces/Reference.OAuth2ClientImportOptions.html +2 -2
- package/docs/interfaces/Reference.OAuth2TrustedJwtIssuerExportInterface.html +2 -2
- package/docs/interfaces/Reference.OAuth2TrustedJwtIssuerExportOptions.html +3 -3
- package/docs/interfaces/Reference.OAuth2TrustedJwtIssuerImportOptions.html +2 -2
- package/docs/interfaces/Reference.PatchOperationInterface.html +2 -2
- package/docs/interfaces/Reference.PlatformInfoInterface.html +2 -2
- package/docs/interfaces/Reference.PolicyExportInterface.html +2 -2
- package/docs/interfaces/Reference.PolicyExportOptions.html +4 -4
- package/docs/interfaces/Reference.PolicyImportOptions.html +4 -4
- package/docs/interfaces/Reference.PolicySetExportInterface.html +2 -2
- package/docs/interfaces/Reference.PolicySetExportOptions.html +4 -4
- package/docs/interfaces/Reference.PolicySetImportOptions.html +3 -3
- package/docs/interfaces/Reference.RawExportOptions.html +4 -4
- package/docs/interfaces/Reference.RawImportOptions.html +2 -2
- package/docs/interfaces/Reference.RealmExportInterface.html +2 -2
- package/docs/interfaces/Reference.RequestFormAssignment.html +3 -3
- package/docs/interfaces/Reference.RequestFormEvent.html +2 -2
- package/docs/interfaces/Reference.RequestFormExportInterface.html +2 -2
- package/docs/interfaces/Reference.RequestFormExportOptions.html +3 -3
- package/docs/interfaces/Reference.RequestFormField.html +2 -2
- package/docs/interfaces/Reference.RequestFormForm.html +2 -2
- package/docs/interfaces/Reference.RequestFormImportOptions.html +2 -2
- package/docs/interfaces/Reference.RequestFormSkeleton.html +2 -2
- package/docs/interfaces/Reference.RequestTypeExportInterface.html +2 -2
- package/docs/interfaces/Reference.RequestTypeExportOptions.html +3 -3
- package/docs/interfaces/Reference.RequestTypeImportOptions.html +2 -2
- package/docs/interfaces/Reference.RequestTypeProperty.html +2 -2
- package/docs/interfaces/Reference.RequestTypeSchema.html +2 -2
- package/docs/interfaces/Reference.RequestTypeSchemas.html +2 -2
- package/docs/interfaces/Reference.RequestTypeSkeleton.html +2 -2
- package/docs/interfaces/Reference.ResourceTypeExportInterface.html +2 -2
- package/docs/interfaces/Reference.RoleInfo.html +2 -2
- package/docs/interfaces/Reference.Saml2EntitiesExportOptions.html +2 -2
- package/docs/interfaces/Reference.Saml2EntitiesImportOptions.html +2 -2
- package/docs/interfaces/Reference.Saml2ExportInterface.html +2 -2
- package/docs/interfaces/Reference.ScriptExportInterface.html +2 -2
- package/docs/interfaces/Reference.ScriptExportOptions.html +5 -5
- package/docs/interfaces/Reference.ScriptFilterCondition.html +3 -3
- package/docs/interfaces/Reference.ScriptFilterGroup.html +3 -3
- package/docs/interfaces/Reference.ScriptImportOptions.html +5 -5
- package/docs/interfaces/Reference.ScriptTask.html +2 -2
- package/docs/interfaces/Reference.ScriptTypeExportInterface.html +2 -2
- package/docs/interfaces/Reference.SearchTargetFilterOperation.html +2 -2
- package/docs/interfaces/Reference.SecretStoreExportInterface.html +2 -2
- package/docs/interfaces/Reference.SecretsExportInterface.html +2 -2
- package/docs/interfaces/Reference.SectionField.html +2 -2
- package/docs/interfaces/Reference.SecureConnectionProfileInterface.html +2 -2
- package/docs/interfaces/Reference.SelectField.html +2 -2
- package/docs/interfaces/Reference.ServerExportInterface.html +2 -2
- package/docs/interfaces/Reference.ServerExportOptions.html +2 -2
- package/docs/interfaces/Reference.ServerImportOptions.html +2 -2
- package/docs/interfaces/Reference.ServiceExportInterface.html +2 -2
- package/docs/interfaces/Reference.ServiceImportOptions.html +4 -4
- package/docs/interfaces/Reference.ServiceNextDescendent.html +1 -1
- package/docs/interfaces/Reference.SingleTreeExportInterface.html +2 -2
- package/docs/interfaces/Reference.SiteExportInterface.html +2 -2
- package/docs/interfaces/Reference.SocialIdentityProviderExportOptions.html +3 -3
- package/docs/interfaces/Reference.SocialIdentityProviderImportOptions.html +2 -2
- package/docs/interfaces/Reference.SocialProviderExportInterface.html +2 -2
- package/docs/interfaces/Reference.StateInterface.html +2 -2
- package/docs/interfaces/Reference.StaticNodeRefSkeletonInterface.html +2 -2
- package/docs/interfaces/Reference.StepStaticNode.html +2 -2
- package/docs/interfaces/Reference.SystemObjectPatchOperationInterface.html +2 -2
- package/docs/interfaces/Reference.SystemStatusInterface.html +2 -2
- package/docs/interfaces/Reference.TaskConfiguration.html +2 -2
- package/docs/interfaces/Reference.TextAreaField.html +2 -2
- package/docs/interfaces/Reference.TextField.html +2 -2
- package/docs/interfaces/Reference.ThemeExportInterface.html +2 -2
- package/docs/interfaces/Reference.TokenCacheInterface.html +1 -1
- package/docs/interfaces/Reference.TreeDependencyMapInterface.html +1 -1
- package/docs/interfaces/Reference.TreeExportOptions.html +4 -4
- package/docs/interfaces/Reference.TreeExportResolverInterface.html +1 -1
- package/docs/interfaces/Reference.TreeImportOptions.html +3 -3
- package/docs/interfaces/Reference.UiConfigInterface.html +2 -2
- package/docs/interfaces/Reference.Updates.html +3 -3
- package/docs/interfaces/Reference.UserExportInterface.html +2 -2
- package/docs/interfaces/Reference.UserGroupExportInterface.html +2 -2
- package/docs/interfaces/Reference.UserInfo.html +2 -2
- package/docs/interfaces/Reference.VariablesExportInterface.html +2 -2
- package/docs/interfaces/Reference.ViolationTask.html +2 -2
- package/docs/interfaces/Reference.WaitTask.html +2 -2
- package/docs/interfaces/Reference.WorkflowActor.html +2 -2
- package/docs/interfaces/Reference.WorkflowDeleteOptions.html +2 -2
- package/docs/interfaces/Reference.WorkflowExportInterface.html +2 -2
- package/docs/interfaces/Reference.WorkflowExportOptions.html +5 -5
- package/docs/interfaces/Reference.WorkflowExpression.html +2 -2
- package/docs/interfaces/Reference.WorkflowGroup.html +2 -2
- package/docs/interfaces/Reference.WorkflowImportOptions.html +2 -2
- package/docs/interfaces/Reference.WorkflowNotification.html +2 -2
- package/docs/interfaces/Reference.WorkflowSkeleton.html +2 -2
- package/docs/interfaces/Reference.WorkflowStaticNode.html +2 -2
- package/docs/types/McpCapabilityDescriptor.html +13 -13
- package/docs/types/McpCapabilityInventoryOptions.html +2 -2
- package/docs/types/McpCapabilityKind.html +1 -1
- package/docs/types/McpCapabilityOperationType.html +1 -1
- package/docs/types/McpCapabilityPolicy.html +2 -2
- package/docs/types/McpCapabilityPolicyPresetName.html +1 -1
- package/docs/types/McpCapabilityRiskClass.html +1 -1
- package/docs/types/McpDeploymentType.html +1 -1
- package/docs/types/McpDiscoveryEntry.html +8 -8
- package/docs/types/McpExecutionPaginationMetadata.html +8 -8
- package/docs/types/McpExecutionScopeMetadata.html +5 -5
- package/docs/types/McpGenericExecutionArguments.html +11 -11
- package/docs/types/McpGenericTool.html +7 -7
- package/docs/types/McpObjectTypeEntry.html +15 -15
- package/docs/types/McpRuntimeAdminAccountAuth.html +10 -10
- package/docs/types/McpRuntimeAuth.html +1 -1
- package/docs/types/McpRuntimeRequestContext.html +3 -3
- package/docs/types/McpRuntimeServiceAccountAuth.html +10 -10
- package/docs/types/McpRuntimeStateAuth.html +3 -3
- package/docs/types/McpService.html +7 -7
- package/docs/types/McpServiceOptions.html +6 -6
- package/docs/types/McpServiceToolDefinition.html +4 -4
- package/docs/types/McpSpecialExecutionArguments.html +3 -3
- package/docs/types/McpSpecialTool.html +5 -5
- package/docs/types/McpToolAnnotations.html +2 -2
- package/docs/types/McpToolExecutionMetadata.html +4 -4
- package/docs/types/McpToolExecutionRequest.html +4 -4
- package/docs/types/McpToolExecutionResult.html +5 -5
- package/docs/types/McpToolManifest.html +6 -6
- package/docs/types/McpToolRuntime.html +3 -3
- package/docs/types/McpToolRuntimeOptions.html +5 -5
- package/docs/types/Reference.AIAgentType.html +1 -1
- package/docs/types/Reference.AccessTokenMetaType.html +1 -1
- package/docs/types/Reference.AccessTokenResponseType.html +2 -2
- package/docs/types/Reference.Admin.html +2 -2
- package/docs/types/Reference.AdminFederation.html +12 -12
- package/docs/types/Reference.AdminFederationConfigSkeleton.html +1 -1
- package/docs/types/Reference.Agent.html +59 -59
- package/docs/types/Reference.AgentGroupSkeleton.html +1 -1
- package/docs/types/Reference.AgentSkeleton.html +1 -1
- package/docs/types/Reference.AgentType.html +1 -1
- package/docs/types/Reference.AllFlag.html +1 -1
- package/docs/types/Reference.AllowDuplicatesFlag.html +1 -1
- package/docs/types/Reference.AmConfig.html +4 -4
- package/docs/types/Reference.AmServiceSkeleton.html +1 -1
- package/docs/types/Reference.ApiFactory.html +9 -9
- package/docs/types/Reference.ApiVersion.html +2 -2
- package/docs/types/Reference.Application.html +19 -19
- package/docs/types/Reference.ApplicationExportOptions.html +3 -3
- package/docs/types/Reference.ApplicationGlossarySkeleton.html +1 -1
- package/docs/types/Reference.ApplicationImportOptions.html +2 -2
- package/docs/types/Reference.ApplicationSkeleton.html +1 -1
- package/docs/types/Reference.ApprovalMode.html +1 -1
- package/docs/types/Reference.Authenticate.html +2 -2
- package/docs/types/Reference.AuthenticateSuccessResponse.html +2 -2
- package/docs/types/Reference.AuthenticationSettings.html +5 -5
- package/docs/types/Reference.AuthenticationSettingsSkeleton.html +1 -1
- package/docs/types/Reference.Base64.html +2 -2
- package/docs/types/Reference.CSR.html +17 -17
- package/docs/types/Reference.CSRResponse.html +1 -1
- package/docs/types/Reference.Callback.html +2 -2
- package/docs/types/Reference.CallbackHandler.html +1 -1
- package/docs/types/Reference.CallbackKeyValuePair.html +2 -2
- package/docs/types/Reference.CallbackType.html +1 -1
- package/docs/types/Reference.CertificateResponse.html +1 -1
- package/docs/types/Reference.CertificationTemplate.html +13 -13
- package/docs/types/Reference.CertificationTemplateType.html +1 -1
- package/docs/types/Reference.CircleOfTrustSkeleton.html +1 -1
- package/docs/types/Reference.CirclesOfTrust.html +13 -13
- package/docs/types/Reference.ConditionFilter.html +1 -1
- package/docs/types/Reference.ConditionGroupOperator.html +1 -1
- package/docs/types/Reference.ConditionOperator.html +1 -1
- package/docs/types/Reference.Config.html +3 -3
- package/docs/types/Reference.ConfigSkeleton.html +2 -2
- package/docs/types/Reference.ConnectionProfile.html +13 -13
- package/docs/types/Reference.Connector.html +14 -14
- package/docs/types/Reference.ConnectorSkeleton.html +1 -1
- package/docs/types/Reference.Constants.html +2 -2
- package/docs/types/Reference.ContentSecurityPolicy.html +2 -2
- package/docs/types/Reference.CookieDomains.html +2 -2
- package/docs/types/Reference.CustomDomains.html +2 -2
- package/docs/types/Reference.CustomNodeProperty.html +2 -2
- package/docs/types/Reference.CustomNodeSkeleton.html +1 -1
- package/docs/types/Reference.CustomNodeUsage.html +1 -1
- package/docs/types/Reference.DeleteJourneyStatus.html +2 -2
- package/docs/types/Reference.DeleteJourneysStatus.html +1 -1
- package/docs/types/Reference.DirectConfigurationSessionState.html +2 -2
- package/docs/types/Reference.DirectiveEnabled.html +1 -1
- package/docs/types/Reference.DirectiveFlag.html +1 -1
- package/docs/types/Reference.DirectiveSource.html +1 -1
- package/docs/types/Reference.DirectiveSourceFlag.html +1 -1
- package/docs/types/Reference.EmailTemplate.html +11 -11
- package/docs/types/Reference.EmailTemplateSkeleton.html +1 -1
- package/docs/types/Reference.EngineConfigurationSkeleton.html +1 -1
- package/docs/types/Reference.EntityType.html +1 -1
- package/docs/types/Reference.EnvAIAgent.html +2 -2
- package/docs/types/Reference.EnvCSR.html +8 -8
- package/docs/types/Reference.EnvCertificate.html +11 -11
- package/docs/types/Reference.EnvContentSecurityPolicy.html +5 -5
- package/docs/types/Reference.EnvCookieDomains.html +3 -3
- package/docs/types/Reference.EnvCustomDomains.html +4 -4
- package/docs/types/Reference.EnvDirectConfigurationSession.html +5 -5
- package/docs/types/Reference.EnvFederationEnforcement.html +4 -4
- package/docs/types/Reference.EnvPromotion.html +12 -12
- package/docs/types/Reference.EnvRelease.html +2 -2
- package/docs/types/Reference.EnvSSOCookieConfig.html +4 -4
- package/docs/types/Reference.EnvServiceAccountScopes.html +2 -2
- package/docs/types/Reference.EnvironmentAndSystemPropertySecretStoreSkeleton.html +1 -1
- package/docs/types/Reference.EsvCount.html +2 -2
- package/docs/types/Reference.EsvCountResponse.html +2 -2
- package/docs/types/Reference.EventType.html +1 -1
- package/docs/types/Reference.ExportImport.html +8 -8
- package/docs/types/Reference.FRUtils.html +7 -7
- package/docs/types/Reference.Feature.html +3 -3
- package/docs/types/Reference.FederationEnforcement.html +2 -2
- package/docs/types/Reference.Field.html +1 -1
- package/docs/types/Reference.FieldType.html +1 -1
- package/docs/types/Reference.FileSystemSecretStoreSkeleton.html +1 -1
- package/docs/types/Reference.Frodo.html +7 -7
- package/docs/types/Reference.FrodoCrypto.html +2 -2
- package/docs/types/Reference.FrodoUtils.html +2 -2
- package/docs/types/Reference.GatewayAgentType.html +1 -1
- package/docs/types/Reference.Glossary.html +13 -13
- package/docs/types/Reference.GlossaryItemType.html +1 -1
- package/docs/types/Reference.GlossaryManagedObjectType.html +1 -1
- package/docs/types/Reference.GlossaryObjectType.html +1 -1
- package/docs/types/Reference.GlossarySkeleton.html +1 -1
- package/docs/types/Reference.GoogleKeyManagementServiceSecretStoreSkeleton.html +1 -1
- package/docs/types/Reference.GoogleSecretManagerSecretStoreProviderSkeleton.html +1 -1
- package/docs/types/Reference.HelpUtils.html +3 -3
- package/docs/types/Reference.HsmSecretStoreSkeleton.html +1 -1
- package/docs/types/Reference.IdmConfig.html +16 -16
- package/docs/types/Reference.IdmConfigStub.html +1 -1
- package/docs/types/Reference.IdmCrypto.html +6 -6
- package/docs/types/Reference.IdmScript.html +3 -3
- package/docs/types/Reference.IdmSystem.html +14 -14
- package/docs/types/Reference.Idp.html +12 -12
- package/docs/types/Reference.IgaEvent.html +13 -13
- package/docs/types/Reference.Info.html +2 -2
- package/docs/types/Reference.InternalRole.html +18 -18
- package/docs/types/Reference.InternalRoleSkeleton.html +1 -1
- package/docs/types/Reference.JavaAgentType.html +1 -1
- package/docs/types/Reference.Jose.html +2 -2
- package/docs/types/Reference.Journey.html +26 -26
- package/docs/types/Reference.JourneyClassificationType.html +1 -1
- package/docs/types/Reference.Json.html +7 -7
- package/docs/types/Reference.JwkRsa.html +1 -1
- package/docs/types/Reference.JwkRsaPublic.html +1 -1
- package/docs/types/Reference.KeyStoreSecretStoreSkeleton.html +1 -1
- package/docs/types/Reference.LockResponse.html +2 -2
- package/docs/types/Reference.LockStatus.html +2 -2
- package/docs/types/Reference.Log.html +13 -13
- package/docs/types/Reference.LogApiKey.html +2 -2
- package/docs/types/Reference.LogEventPayloadSkeleton.html +1 -1
- package/docs/types/Reference.LogEventSkeleton.html +1 -1
- package/docs/types/Reference.ManagedObject.html +16 -16
- package/docs/types/Reference.ManagedObjectSchema.html +2 -2
- package/docs/types/Reference.ManagedObjectSchemaLeafPropertyType.html +1 -1
- package/docs/types/Reference.ManagedObjectSchemaOptions.html +4 -4
- package/docs/types/Reference.ManagedObjectSchemaProperty.html +1 -1
- package/docs/types/Reference.ManagedObjectSchemaPropertyBase.html +2 -2
- package/docs/types/Reference.ManagedObjectSchemaPropertyType.html +1 -1
- package/docs/types/Reference.ManagedObjectSchemaRelationshipResourceCollectionItem.html +2 -2
- package/docs/types/Reference.ManagedObjectSchemaRelationshipResourceQuery.html +2 -2
- package/docs/types/Reference.Mapping.html +16 -16
- package/docs/types/Reference.MappingPolicy.html +2 -2
- package/docs/types/Reference.MappingProperty.html +2 -2
- package/docs/types/Reference.MappingSkeleton.html +1 -1
- package/docs/types/Reference.McpCapabilityArgumentMode.html +1 -1
- package/docs/types/Reference.McpCapabilityParameter.html +4 -4
- package/docs/types/Reference.McpCapabilityParameterSchema.html +2 -2
- package/docs/types/Reference.McpCapabilityScope.html +1 -1
- package/docs/types/Reference.McpDiscoveryObjectTypeSupport.html +2 -2
- package/docs/types/Reference.McpDiscoveryOperationDetail.html +2 -2
- package/docs/types/Reference.McpExecutionResultMetadata.html +10 -10
- package/docs/types/Reference.McpIdentitySurface.html +1 -1
- package/docs/types/Reference.Metadata.html +2 -2
- package/docs/types/Reference.Node.html +28 -28
- package/docs/types/Reference.NodeClassificationType.html +1 -1
- package/docs/types/Reference.NodeSkeleton.html +1 -1
- package/docs/types/Reference.NodeVersionFilter.html +10 -10
- package/docs/types/Reference.NoneFlag.html +1 -1
- package/docs/types/Reference.OAuth2Client.html +13 -13
- package/docs/types/Reference.OAuth2ClientSkeleton.html +1 -1
- package/docs/types/Reference.OAuth2ClientType.html +1 -1
- package/docs/types/Reference.OAuth2Oidc.html +2 -2
- package/docs/types/Reference.OAuth2Provider.html +5 -5
- package/docs/types/Reference.OAuth2ProviderSkeleton.html +1 -1
- package/docs/types/Reference.OAuth2ThingType.html +1 -1
- package/docs/types/Reference.OAuth2TrustedJwtIssuer.html +13 -13
- package/docs/types/Reference.OAuth2TrustedJwtIssuerSkeleton.html +1 -1
- package/docs/types/Reference.ObjectInfo.html +1 -1
- package/docs/types/Reference.ObjectPropertyFlag.html +1 -1
- package/docs/types/Reference.ObjectPropertyNativeType.html +1 -1
- package/docs/types/Reference.ObjectPropertySkeleton.html +2 -2
- package/docs/types/Reference.ObjectPropertyType.html +1 -1
- package/docs/types/Reference.ObjectTypeSkeleton.html +2 -2
- package/docs/types/Reference.Organization.html +3 -3
- package/docs/types/Reference.PagedResult.html +2 -2
- package/docs/types/Reference.PlatformInfo.html +1 -1
- package/docs/types/Reference.Policy.html +14 -14
- package/docs/types/Reference.PolicyAgentType.html +1 -1
- package/docs/types/Reference.PolicyCondition.html +1 -1
- package/docs/types/Reference.PolicyConditionType.html +1 -1
- package/docs/types/Reference.PolicySet.html +10 -10
- package/docs/types/Reference.PolicySetSkeleton.html +1 -1
- package/docs/types/Reference.PolicySkeleton.html +1 -1
- package/docs/types/Reference.ProgressIndicatorStatusType.html +1 -1
- package/docs/types/Reference.ProgressIndicatorType.html +1 -1
- package/docs/types/Reference.PromotionConfig.html +2 -2
- package/docs/types/Reference.PromotionConfigChange.html +2 -2
- package/docs/types/Reference.PromotionReport.html +2 -2
- package/docs/types/Reference.PromotionReportStub.html +2 -2
- package/docs/types/Reference.PromotionRequestConfig.html +2 -2
- package/docs/types/Reference.PromotionResponse.html +2 -2
- package/docs/types/Reference.PromotionStatus.html +2 -2
- package/docs/types/Reference.PromotionType.html +1 -1
- package/docs/types/Reference.PropertyType.html +1 -1
- package/docs/types/Reference.RawConfig.html +3 -3
- package/docs/types/Reference.Readable.html +1 -1
- package/docs/types/Reference.Realm.html +12 -12
- package/docs/types/Reference.RealmSkeleton.html +1 -1
- package/docs/types/Reference.Recon.html +6 -6
- package/docs/types/Reference.ReconStatusType.html +1 -1
- package/docs/types/Reference.ReconType.html +1 -1
- package/docs/types/Reference.RefererDirectiveFlag.html +1 -1
- package/docs/types/Reference.Release.html +2 -2
- package/docs/types/Reference.RemoteConsentAgentType.html +1 -1
- package/docs/types/Reference.RequestForm.html +13 -13
- package/docs/types/Reference.RequestFormOperationType.html +1 -1
- package/docs/types/Reference.RequestFormType.html +1 -1
- package/docs/types/Reference.RequestType.html +13 -13
- package/docs/types/Reference.ResourceConfig.html +2 -2
- package/docs/types/Reference.ResourceType.html +15 -15
- package/docs/types/Reference.ResourceTypeSkeleton.html +1 -1
- package/docs/types/Reference.ResultCallback.html +1 -1
- package/docs/types/Reference.RetryEverythingStrategy.html +1 -1
- package/docs/types/Reference.RetryNetworkStrategy.html +1 -1
- package/docs/types/Reference.RetryNothingStrategy.html +1 -1
- package/docs/types/Reference.RetryStrategy.html +1 -1
- package/docs/types/Reference.RollbackConfig.html +2 -2
- package/docs/types/Reference.RollbackResponse.html +2 -2
- package/docs/types/Reference.SSOCookieConfig.html +2 -2
- package/docs/types/Reference.Saml2.html +14 -14
- package/docs/types/Reference.Saml2ProiderLocation.html +1 -1
- package/docs/types/Reference.Saml2ProviderSkeleton.html +1 -1
- package/docs/types/Reference.Saml2ProviderStub.html +1 -1
- package/docs/types/Reference.SandboxDirectiveFlag.html +1 -1
- package/docs/types/Reference.Script.html +15 -15
- package/docs/types/Reference.ScriptContext.html +1 -1
- package/docs/types/Reference.ScriptFilter.html +1 -1
- package/docs/types/Reference.ScriptFlag.html +1 -1
- package/docs/types/Reference.ScriptLanguage.html +1 -1
- package/docs/types/Reference.ScriptSkeleton.html +1 -1
- package/docs/types/Reference.ScriptType.html +7 -7
- package/docs/types/Reference.ScriptTypeExportSkeleton.html +1 -1
- package/docs/types/Reference.ScriptTypeSkeleton.html +1 -1
- package/docs/types/Reference.ScriptValidation.html +2 -2
- package/docs/types/Reference.ScriptingContextSkeleton.html +1 -1
- package/docs/types/Reference.SearchTargetOperator.html +1 -1
- package/docs/types/Reference.Secret.html +18 -18
- package/docs/types/Reference.SecretEncodingType.html +1 -1
- package/docs/types/Reference.SecretSkeleton.html +1 -1
- package/docs/types/Reference.SecretStore.html +18 -18
- package/docs/types/Reference.SecretStoreExportSkeleton.html +1 -1
- package/docs/types/Reference.SecretStoreMappingSkeleton.html +1 -1
- package/docs/types/Reference.SecretStoreSchemaSkeleton.html +2 -2
- package/docs/types/Reference.SecretStoreSkeleton.html +1 -1
- package/docs/types/Reference.SelectFieldObjectType.html +1 -1
- package/docs/types/Reference.SelfFlag.html +1 -1
- package/docs/types/Reference.Server.html +11 -11
- package/docs/types/Reference.ServerExportSkeleton.html +1 -1
- package/docs/types/Reference.ServerPropertiesSkeleton.html +2 -2
- package/docs/types/Reference.ServerSkeleton.html +1 -1
- package/docs/types/Reference.Service.html +10 -10
- package/docs/types/Reference.ServiceAccount.html +5 -5
- package/docs/types/Reference.ServiceAccountScope.html +2 -2
- package/docs/types/Reference.ServiceAccountType.html +1 -1
- package/docs/types/Reference.Session.html +2 -2
- package/docs/types/Reference.SessionInfoType.html +2 -2
- package/docs/types/Reference.SharedAgentType.html +1 -1
- package/docs/types/Reference.Site.html +8 -8
- package/docs/types/Reference.SiteSkeleton.html +1 -1
- package/docs/types/Reference.SoapSTSAgentType.html +1 -1
- package/docs/types/Reference.SocialIdpSkeleton.html +1 -1
- package/docs/types/Reference.SoftwarePublisherType.html +1 -1
- package/docs/types/Reference.Startup.html +4 -4
- package/docs/types/Reference.State.html +10 -10
- package/docs/types/Reference.StepType.html +1 -1
- package/docs/types/Reference.SyncSkeleton.html +1 -1
- package/docs/types/Reference.Theme.html +14 -14
- package/docs/types/Reference.ThemeSkeleton.html +1 -1
- package/docs/types/Reference.TokenCache.html +17 -17
- package/docs/types/Reference.TokenInfoResponseType.html +2 -2
- package/docs/types/Reference.Tokens.html +2 -2
- package/docs/types/Reference.TreeSkeleton.html +1 -1
- package/docs/types/Reference.User.html +14 -14
- package/docs/types/Reference.UserConfigSkeleton.html +2 -2
- package/docs/types/Reference.UserExportSkeleton.html +1 -1
- package/docs/types/Reference.UserGroupSkeleton.html +1 -1
- package/docs/types/Reference.UserSessionMetaType.html +1 -1
- package/docs/types/Reference.UserSkeleton.html +1 -1
- package/docs/types/Reference.Variable.html +16 -16
- package/docs/types/Reference.VariableExpressionType.html +1 -1
- package/docs/types/Reference.VariableSkeleton.html +1 -1
- package/docs/types/Reference.Version.html +2 -2
- package/docs/types/Reference.VersionOfSecretSkeleton.html +1 -1
- package/docs/types/Reference.VersionOfSecretStatus.html +1 -1
- package/docs/types/Reference.WSFed.html +25 -25
- package/docs/types/Reference.WSFedAuthenticationAction.html +2 -2
- package/docs/types/Reference.WSFedAuthenticationPolicy.html +2 -2
- package/docs/types/Reference.WSFedAuthenticationPolicyContract.html +2 -2
- package/docs/types/Reference.WSFedAuthenticationPolicyContractAttribute.html +2 -2
- package/docs/types/Reference.WSFedAuthenticationPolicyContractRequest.html +1 -1
- package/docs/types/Reference.WSFedAuthenticationPolicyNode.html +2 -2
- package/docs/types/Reference.WSFedAuthenticationPolicyRequest.html +1 -1
- package/docs/types/Reference.WSFedFederationInfo.html +2 -2
- package/docs/types/Reference.WSFedIdpAdapter.html +2 -2
- package/docs/types/Reference.WSFedIdpAdapterAttribute.html +2 -2
- package/docs/types/Reference.WSFedIdpAdapterAttributeContractFulfillment.html +2 -2
- package/docs/types/Reference.WSFedIdpAdapterConfigField.html +2 -2
- package/docs/types/Reference.WSFedIdpAdapterConfigTable.html +2 -2
- package/docs/types/Reference.WSFedIdpAdapterConfigTableRow.html +2 -2
- package/docs/types/Reference.WSFedIdpAdapterPluginDescriptorRef.html +2 -2
- package/docs/types/Reference.WSFedSigningKeyPair.html +2 -2
- package/docs/types/Reference.WSFedSigningKeyPairRequest.html +2 -2
- package/docs/types/Reference.WSFedSpConnection.html +1 -1
- package/docs/types/Reference.WebAgentType.html +1 -1
- package/docs/types/Reference.Workflow.html +15 -15
- package/docs/types/Reference.WorkflowGroups.html +1 -1
- package/docs/types/Reference.WorkflowStep.html +1 -1
- package/docs/types/Reference.Writable.html +2 -2
- package/docs/types/Reference.tokenType.html +1 -1
- package/docs/variables/MCP_POLICY_PRESETS.html +1 -1
- package/docs/variables/Reference.DISCOVERY_TOOL_NAME.html +1 -1
- package/docs/variables/frodo.html +1 -1
- package/docs/variables/state.html +1 -1
- package/package.json +1 -1
|
@@ -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>Mapping | 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">Mapping</a></li></ul><h1>Type Alias Mapping</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">type</span> <span class="tsd-kind-type-alias">Mapping</span> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-call-signature" href="#createmapping-1">createMapping</a><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">mappingId</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">mappingData</span><span class="tsd-signature-symbol">:</span> <a href="Reference.MappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">MappingSkeleton</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"><</span><a href="Reference.MappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">MappingSkeleton</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#createmappingexporttemplate-1">createMappingExportTemplate</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/Reference.MappingExportInterface.html" class="tsd-signature-type tsd-kind-interface">MappingExportInterface</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#deletemapping-1">deleteMapping</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">mappingId</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"><</span><a href="Reference.MappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">MappingSkeleton</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#deletemappings-1">deleteMappings</a><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">connectorId</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">moType</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"><</span><a href="Reference.MappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">MappingSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#exportmapping-1">exportMapping</a><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">mappingId</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">options</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/Reference.MappingExportOptions.html" class="tsd-signature-type tsd-kind-interface">MappingExportOptions</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"><</span><a href="../interfaces/Reference.MappingExportInterface.html" class="tsd-signature-type tsd-kind-interface">MappingExportInterface</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#exportmappings-1">exportMappings</a><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/Reference.MappingExportOptions.html" class="tsd-signature-type tsd-kind-interface">MappingExportOptions</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"><</span><a href="../interfaces/Reference.MappingExportInterface.html" class="tsd-signature-type tsd-kind-interface">MappingExportInterface</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#importfirstmapping-1">importFirstMapping</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.MappingExportInterface.html" class="tsd-signature-type tsd-kind-interface">MappingExportInterface</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/Reference.MappingImportOptions.html" class="tsd-signature-type tsd-kind-interface">MappingImportOptions</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"><</span><a href="Reference.MappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">MappingSkeleton</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#importmapping-1">importMapping</a><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">mappingId</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">importData</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/Reference.MappingExportInterface.html" class="tsd-signature-type tsd-kind-interface">MappingExportInterface</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/Reference.MappingImportOptions.html" class="tsd-signature-type tsd-kind-interface">MappingImportOptions</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"><</span><a href="Reference.MappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">MappingSkeleton</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#importmappings-1">importMappings</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.MappingExportInterface.html" class="tsd-signature-type tsd-kind-interface">MappingExportInterface</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/Reference.MappingImportOptions.html" class="tsd-signature-type tsd-kind-interface">MappingImportOptions</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"><</span><a href="Reference.MappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">MappingSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#islegacymapping-1">isLegacyMapping</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">mappingId</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">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#readmapping-1">readMapping</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">mappingId</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"><</span><a href="Reference.MappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">MappingSkeleton</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#readmappings-1">readMappings</a><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">connectorId</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">moType</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"><</span><a href="Reference.MappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">MappingSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#readsyncmappings-1">readSyncMappings</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"><</span><a href="Reference.MappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">MappingSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#updatemapping-1">updateMapping</a><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">mappingId</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">mappingData</span><span class="tsd-signature-symbol">:</span> <a href="Reference.MappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">MappingSkeleton</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"><</span><a href="Reference.MappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">MappingSkeleton</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#updatesyncmappings-1">updateSyncMappings</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">mappings</span><span class="tsd-signature-symbol">:</span> <a href="Reference.MappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">MappingSkeleton</a><span class="tsd-signature-symbol">[]</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"><</span><a href="Reference.MappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">MappingSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></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/MappingOps.ts#L19">ops/MappingOps.ts:19</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="#createmapping" 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/>Mapping</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>Mapping | 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">Mapping</a></li></ul><h1>Type Alias Mapping</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">type</span> <span class="tsd-kind-type-alias">Mapping</span> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-call-signature" href="#createmapping-1">createMapping</a><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">mappingId</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">mappingData</span><span class="tsd-signature-symbol">:</span> <a href="Reference.MappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">MappingSkeleton</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"><</span><a href="Reference.MappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">MappingSkeleton</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#createmappingexporttemplate-1">createMappingExportTemplate</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/Reference.MappingExportInterface.html" class="tsd-signature-type tsd-kind-interface">MappingExportInterface</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#deletemapping-1">deleteMapping</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">mappingId</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"><</span><a href="Reference.MappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">MappingSkeleton</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#deletemappings-1">deleteMappings</a><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">connectorId</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">moType</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"><</span><a href="Reference.MappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">MappingSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#exportmapping-1">exportMapping</a><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">mappingId</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">options</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/Reference.MappingExportOptions.html" class="tsd-signature-type tsd-kind-interface">MappingExportOptions</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"><</span><a href="../interfaces/Reference.MappingExportInterface.html" class="tsd-signature-type tsd-kind-interface">MappingExportInterface</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#exportmappings-1">exportMappings</a><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/Reference.MappingExportOptions.html" class="tsd-signature-type tsd-kind-interface">MappingExportOptions</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"><</span><a href="../interfaces/Reference.MappingExportInterface.html" class="tsd-signature-type tsd-kind-interface">MappingExportInterface</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#importfirstmapping-1">importFirstMapping</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.MappingExportInterface.html" class="tsd-signature-type tsd-kind-interface">MappingExportInterface</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/Reference.MappingImportOptions.html" class="tsd-signature-type tsd-kind-interface">MappingImportOptions</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"><</span><a href="Reference.MappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">MappingSkeleton</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#importmapping-1">importMapping</a><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">mappingId</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">importData</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/Reference.MappingExportInterface.html" class="tsd-signature-type tsd-kind-interface">MappingExportInterface</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/Reference.MappingImportOptions.html" class="tsd-signature-type tsd-kind-interface">MappingImportOptions</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"><</span><a href="Reference.MappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">MappingSkeleton</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#importmappings-1">importMappings</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.MappingExportInterface.html" class="tsd-signature-type tsd-kind-interface">MappingExportInterface</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/Reference.MappingImportOptions.html" class="tsd-signature-type tsd-kind-interface">MappingImportOptions</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"><</span><a href="Reference.MappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">MappingSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#islegacymapping-1">isLegacyMapping</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">mappingId</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">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#readmapping-1">readMapping</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">mappingId</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"><</span><a href="Reference.MappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">MappingSkeleton</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#readmappings-1">readMappings</a><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">connectorId</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">moType</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"><</span><a href="Reference.MappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">MappingSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#readsyncmappings-1">readSyncMappings</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"><</span><a href="Reference.MappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">MappingSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#updatemapping-1">updateMapping</a><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">mappingId</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">mappingData</span><span class="tsd-signature-symbol">:</span> <a href="Reference.MappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">MappingSkeleton</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"><</span><a href="Reference.MappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">MappingSkeleton</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#updatesyncmappings-1">updateSyncMappings</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">mappings</span><span class="tsd-signature-symbol">:</span> <a href="Reference.MappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">MappingSkeleton</a><span class="tsd-signature-symbol">[]</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"><</span><a href="Reference.MappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">MappingSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></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/MappingOps.ts#L19">ops/MappingOps.ts:19</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="#createmapping" 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/>Mapping</span></a>
|
|
2
2
|
<a href="#createmappingexporttemplate" 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/>Mapping<wbr/>Export<wbr/>Template</span></a>
|
|
3
3
|
<a href="#deletemapping" 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/>Mapping</span></a>
|
|
4
4
|
<a href="#deletemappings" 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/>Mappings</span></a>
|
|
@@ -17,52 +17,52 @@
|
|
|
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">mappingId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>id of the mapping (new: 'mapping/<name>', legacy: 'sync/<name>')</p>
|
|
18
18
|
</div></li><li><span><span class="tsd-kind-parameter">mappingData</span>: <a href="Reference.MappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">MappingSkeleton</a></span><div class="tsd-comment tsd-typography"><p>mapping object</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"><</span><a href="Reference.MappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">MappingSkeleton</a><span class="tsd-signature-symbol">></span></h4><p>a promise that resolves to an mapping object</p>
|
|
20
|
-
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/
|
|
20
|
+
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/2532f5e8e6bb6870ab10a382d68f9e33d6f5e7de/src/ops/MappingOps.ts#L52">ops/MappingOps.ts:52</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="createmappingexporttemplate"><span>create<wbr/>Mapping<wbr/>Export<wbr/>Template</span><a href="#createmappingexporttemplate" 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="createmappingexporttemplate-1"><span class="tsd-kind-call-signature">createMappingExportTemplate</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/Reference.MappingExportInterface.html" class="tsd-signature-type tsd-kind-interface">MappingExportInterface</a><a href="#createmappingexporttemplate-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 an empty mapping export template</p>
|
|
21
21
|
</div><h4 class="tsd-returns-title">Returns <a href="../interfaces/Reference.MappingExportInterface.html" class="tsd-signature-type tsd-kind-interface">MappingExportInterface</a></h4><p>an empty mapping export template</p>
|
|
22
|
-
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/
|
|
22
|
+
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/2532f5e8e6bb6870ab10a382d68f9e33d6f5e7de/src/ops/MappingOps.ts#L24">ops/MappingOps.ts:24</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="deletemapping"><span>delete<wbr/>Mapping</span><a href="#deletemapping" 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="deletemapping-1"><span class="tsd-kind-call-signature">deleteMapping</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">mappingId</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"><</span><a href="Reference.MappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">MappingSkeleton</a><span class="tsd-signature-symbol">></span><a href="#deletemapping-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 mapping</p>
|
|
23
23
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">mappingId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>id of the mapping (new: 'mapping/<name>', legacy: 'sync/<name>')</p>
|
|
24
24
|
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.MappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">MappingSkeleton</a><span class="tsd-signature-symbol">></span></h4><p>a promise that resolves an mapping object</p>
|
|
25
|
-
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/
|
|
25
|
+
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/2532f5e8e6bb6870ab10a382d68f9e33d6f5e7de/src/ops/MappingOps.ts#L87">ops/MappingOps.ts:87</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="deletemappings"><span>delete<wbr/>Mappings</span><a href="#deletemappings" 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="deletemappings-1"><span class="tsd-kind-call-signature">deleteMappings</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">connectorId</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">moType</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"><</span><a href="Reference.MappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">MappingSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#deletemappings-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 all mappings</p>
|
|
26
26
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">connectorId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>limit mappings to connector</p>
|
|
27
27
|
</div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">moType</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>limit mappings to managed object type</p>
|
|
28
28
|
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.MappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">MappingSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><p>a promise that resolves to an array of mapping objects</p>
|
|
29
|
-
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/
|
|
29
|
+
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/2532f5e8e6bb6870ab10a382d68f9e33d6f5e7de/src/ops/MappingOps.ts#L78">ops/MappingOps.ts:78</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="exportmapping"><span>export<wbr/>Mapping</span><a href="#exportmapping" 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="exportmapping-1"><span class="tsd-kind-call-signature">exportMapping</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">mappingId</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">options</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/Reference.MappingExportOptions.html" class="tsd-signature-type tsd-kind-interface">MappingExportOptions</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"><</span><a href="../interfaces/Reference.MappingExportInterface.html" class="tsd-signature-type tsd-kind-interface">MappingExportInterface</a><span class="tsd-signature-symbol">></span><a href="#exportmapping-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 mapping</p>
|
|
30
30
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">mappingId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>id of the mapping (new: 'mapping/<name>', legacy: 'sync/<name>')</p>
|
|
31
31
|
</div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../interfaces/Reference.MappingExportOptions.html" class="tsd-signature-type tsd-kind-interface">MappingExportOptions</a></span><div class="tsd-comment tsd-typography"><p>export options</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"><</span><a href="../interfaces/Reference.MappingExportInterface.html" class="tsd-signature-type tsd-kind-interface">MappingExportInterface</a><span class="tsd-signature-symbol">></span></h4><p>a promise that resolves to a MappingExportInterface object</p>
|
|
33
|
-
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/
|
|
33
|
+
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/2532f5e8e6bb6870ab10a382d68f9e33d6f5e7de/src/ops/MappingOps.ts#L94">ops/MappingOps.ts:94</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="exportmappings"><span>export<wbr/>Mappings</span><a href="#exportmappings" 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="exportmappings-1"><span class="tsd-kind-call-signature">exportMappings</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/Reference.MappingExportOptions.html" class="tsd-signature-type tsd-kind-interface">MappingExportOptions</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"><</span><a href="../interfaces/Reference.MappingExportInterface.html" class="tsd-signature-type tsd-kind-interface">MappingExportInterface</a><span class="tsd-signature-symbol">></span><a href="#exportmappings-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 mappings</p>
|
|
34
34
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../interfaces/Reference.MappingExportOptions.html" class="tsd-signature-type tsd-kind-interface">MappingExportOptions</a></span><div class="tsd-comment tsd-typography"><p>export options</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"><</span><a href="../interfaces/Reference.MappingExportInterface.html" class="tsd-signature-type tsd-kind-interface">MappingExportInterface</a><span class="tsd-signature-symbol">></span></h4><p>a promise that resolves to a MappingExportInterface object</p>
|
|
36
|
-
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/
|
|
36
|
+
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/2532f5e8e6bb6870ab10a382d68f9e33d6f5e7de/src/ops/MappingOps.ts#L103">ops/MappingOps.ts:103</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="importfirstmapping"><span>import<wbr/>First<wbr/>Mapping</span><a href="#importfirstmapping" 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="importfirstmapping-1"><span class="tsd-kind-call-signature">importFirstMapping</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.MappingExportInterface.html" class="tsd-signature-type tsd-kind-interface">MappingExportInterface</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/Reference.MappingImportOptions.html" class="tsd-signature-type tsd-kind-interface">MappingImportOptions</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"><</span><a href="Reference.MappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">MappingSkeleton</a><span class="tsd-signature-symbol">></span><a href="#importfirstmapping-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 first mapping</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">importData</span>: <a href="../interfaces/Reference.MappingExportInterface.html" class="tsd-signature-type tsd-kind-interface">MappingExportInterface</a></span><div class="tsd-comment tsd-typography"><p>import data</p>
|
|
38
38
|
</div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../interfaces/Reference.MappingImportOptions.html" class="tsd-signature-type tsd-kind-interface">MappingImportOptions</a></span><div class="tsd-comment tsd-typography"><p>import options</p>
|
|
39
39
|
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.MappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">MappingSkeleton</a><span class="tsd-signature-symbol">></span></h4><p>a promise resolving to a MappingSkeleton object</p>
|
|
40
|
-
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/
|
|
40
|
+
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/2532f5e8e6bb6870ab10a382d68f9e33d6f5e7de/src/ops/MappingOps.ts#L124">ops/MappingOps.ts:124</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="importmapping"><span>import<wbr/>Mapping</span><a href="#importmapping" 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="importmapping-1"><span class="tsd-kind-call-signature">importMapping</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">mappingId</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">importData</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/Reference.MappingExportInterface.html" class="tsd-signature-type tsd-kind-interface">MappingExportInterface</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/Reference.MappingImportOptions.html" class="tsd-signature-type tsd-kind-interface">MappingImportOptions</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"><</span><a href="Reference.MappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">MappingSkeleton</a><span class="tsd-signature-symbol">></span><a href="#importmapping-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 mapping</p>
|
|
41
41
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">mappingId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>id of the mapping (new: 'mapping/<name>', legacy: 'sync/<name>')</p>
|
|
42
42
|
</div></li><li><span><span class="tsd-kind-parameter">importData</span>: <a href="../interfaces/Reference.MappingExportInterface.html" class="tsd-signature-type tsd-kind-interface">MappingExportInterface</a></span><div class="tsd-comment tsd-typography"><p>import data</p>
|
|
43
43
|
</div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../interfaces/Reference.MappingImportOptions.html" class="tsd-signature-type tsd-kind-interface">MappingImportOptions</a></span><div class="tsd-comment tsd-typography"><p>import options</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"><</span><a href="Reference.MappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">MappingSkeleton</a><span class="tsd-signature-symbol">></span></h4><p>a promise resolving to a MappingSkeleton object</p>
|
|
45
|
-
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/
|
|
45
|
+
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/2532f5e8e6bb6870ab10a382d68f9e33d6f5e7de/src/ops/MappingOps.ts#L113">ops/MappingOps.ts:113</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="importmappings"><span>import<wbr/>Mappings</span><a href="#importmappings" 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="importmappings-1"><span class="tsd-kind-call-signature">importMappings</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.MappingExportInterface.html" class="tsd-signature-type tsd-kind-interface">MappingExportInterface</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/Reference.MappingImportOptions.html" class="tsd-signature-type tsd-kind-interface">MappingImportOptions</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"><</span><a href="Reference.MappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">MappingSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#importmappings-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 all mappings</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">importData</span>: <a href="../interfaces/Reference.MappingExportInterface.html" class="tsd-signature-type tsd-kind-interface">MappingExportInterface</a></span><div class="tsd-comment tsd-typography"><p>import data</p>
|
|
47
47
|
</div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../interfaces/Reference.MappingImportOptions.html" class="tsd-signature-type tsd-kind-interface">MappingImportOptions</a></span><div class="tsd-comment tsd-typography"><p>import options</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"><</span><a href="Reference.MappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">MappingSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><p>a promise resolving to an array of MappingSkeleton objects</p>
|
|
49
|
-
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/
|
|
49
|
+
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/2532f5e8e6bb6870ab10a382d68f9e33d6f5e7de/src/ops/MappingOps.ts#L134">ops/MappingOps.ts:134</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="islegacymapping"><span>is<wbr/>Legacy<wbr/>Mapping</span><a href="#islegacymapping" 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="islegacymapping-1"><span class="tsd-kind-call-signature">isLegacyMapping</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">mappingId</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">boolean</span><a href="#islegacymapping-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>Helper that returns a boolean indicating whether the mapping is a legacy mapping or not given the id</p>
|
|
50
50
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">mappingId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>the mapping id</p>
|
|
51
51
|
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p>true if the mapping is a legacy mapping, false otherwise</p>
|
|
52
52
|
<div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws">Throws<a href="#throws" 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></h4><p>if the id is invalid</p>
|
|
53
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/
|
|
53
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/2532f5e8e6bb6870ab10a382d68f9e33d6f5e7de/src/ops/MappingOps.ts#L144">ops/MappingOps.ts:144</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="readmapping"><span>read<wbr/>Mapping</span><a href="#readmapping" 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="readmapping-1"><span class="tsd-kind-call-signature">readMapping</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">mappingId</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"><</span><a href="Reference.MappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">MappingSkeleton</a><span class="tsd-signature-symbol">></span><a href="#readmapping-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 mapping</p>
|
|
54
54
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">mappingId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>id of the mapping (new: 'mapping/<name>', legacy: 'sync/<name>')</p>
|
|
55
55
|
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.MappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">MappingSkeleton</a><span class="tsd-signature-symbol">></span></h4><p>a promise that resolves an mapping object</p>
|
|
56
|
-
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/
|
|
56
|
+
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/2532f5e8e6bb6870ab10a382d68f9e33d6f5e7de/src/ops/MappingOps.ts#L45">ops/MappingOps.ts:45</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="readmappings"><span>read<wbr/>Mappings</span><a href="#readmappings" 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="readmappings-1"><span class="tsd-kind-call-signature">readMappings</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">connectorId</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">moType</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"><</span><a href="Reference.MappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">MappingSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#readmappings-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 mappings</p>
|
|
57
57
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">connectorId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>limit mappings to connector</p>
|
|
58
58
|
</div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">moType</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>limit mappings to managed object type</p>
|
|
59
59
|
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.MappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">MappingSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><p>a promise that resolves to an array of mapping objects</p>
|
|
60
|
-
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/
|
|
60
|
+
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/2532f5e8e6bb6870ab10a382d68f9e33d6f5e7de/src/ops/MappingOps.ts#L36">ops/MappingOps.ts:36</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="readsyncmappings"><span>read<wbr/>Sync<wbr/>Mappings</span><a href="#readsyncmappings" 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="readsyncmappings-1"><span class="tsd-kind-call-signature">readSyncMappings</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"><</span><a href="Reference.MappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">MappingSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#readsyncmappings-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 mappings from sync.json (legacy)</p>
|
|
61
61
|
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.MappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">MappingSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><p>a promise that resolves to an array of mapping objects</p>
|
|
62
|
-
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/
|
|
62
|
+
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/2532f5e8e6bb6870ab10a382d68f9e33d6f5e7de/src/ops/MappingOps.ts#L29">ops/MappingOps.ts:29</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="updatemapping"><span>update<wbr/>Mapping</span><a href="#updatemapping" 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="updatemapping-1"><span class="tsd-kind-call-signature">updateMapping</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">mappingId</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">mappingData</span><span class="tsd-signature-symbol">:</span> <a href="Reference.MappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">MappingSkeleton</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"><</span><a href="Reference.MappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">MappingSkeleton</a><span class="tsd-signature-symbol">></span><a href="#updatemapping-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 or create mapping</p>
|
|
63
63
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">mappingId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>id of the mapping (new: 'mapping/<name>', legacy: 'sync/<name>')</p>
|
|
64
64
|
</div></li><li><span><span class="tsd-kind-parameter">mappingData</span>: <a href="Reference.MappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">MappingSkeleton</a></span><div class="tsd-comment tsd-typography"><p>mapping object</p>
|
|
65
65
|
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.MappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">MappingSkeleton</a><span class="tsd-signature-symbol">></span></h4><p>a promise that resolves to an mapping object</p>
|
|
66
|
-
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/
|
|
66
|
+
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/2532f5e8e6bb6870ab10a382d68f9e33d6f5e7de/src/ops/MappingOps.ts#L62">ops/MappingOps.ts:62</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="updatesyncmappings"><span>update<wbr/>Sync<wbr/>Mappings</span><a href="#updatesyncmappings" 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="updatesyncmappings-1"><span class="tsd-kind-call-signature">updateSyncMappings</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">mappings</span><span class="tsd-signature-symbol">:</span> <a href="Reference.MappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">MappingSkeleton</a><span class="tsd-signature-symbol">[]</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"><</span><a href="Reference.MappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">MappingSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#updatesyncmappings-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 or create mappings in sync.json (legacy)</p>
|
|
67
67
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">mappings</span>: <a href="Reference.MappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">MappingSkeleton</a><span class="tsd-signature-symbol">[]</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.MappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">MappingSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><p>a promise that resolves to an mapping object</p>
|
|
68
|
-
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/
|
|
68
|
+
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/2532f5e8e6bb6870ab10a382d68f9e33d6f5e7de/src/ops/MappingOps.ts#L71">ops/MappingOps.ts:71</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="#createmapping"><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/>Mapping</span></a><a href="#createmappingexporttemplate"><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/>Mapping<wbr/>Export<wbr/>Template</span></a><a href="#deletemapping"><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/>Mapping</span></a><a href="#deletemappings"><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/>Mappings</span></a><a href="#exportmapping"><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/>Mapping</span></a><a href="#exportmappings"><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/>Mappings</span></a><a href="#importfirstmapping"><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/>First<wbr/>Mapping</span></a><a href="#importmapping"><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/>Mapping</span></a><a href="#importmappings"><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/>Mappings</span></a><a href="#islegacymapping"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Legacy<wbr/>Mapping</span></a><a href="#readmapping"><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/>Mapping</span></a><a href="#readmappings"><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/>Mappings</span></a><a href="#readsyncmappings"><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/>Sync<wbr/>Mappings</span></a><a href="#updatemapping"><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/>Mapping</span></a><a href="#updatesyncmappings"><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/>Sync<wbr/>Mappings</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>
|
|
@@ -1,3 +1,3 @@
|
|
|
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>MappingPolicy | 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">MappingPolicy</a></li></ul><h1>Type Alias MappingPolicy</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">type</span> <span class="tsd-kind-type-alias">MappingPolicy</span> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#action">action</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"CREATE"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"DELETE"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"EXCEPTION"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"IGNORE"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"UPDATE"</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#situation">situation</a><span class="tsd-signature-symbol">:</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"ABSENT"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"ALL_GONE"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"AMBIGUOUS"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"CONFIRMED"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"FOUND"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"FOUND_ALREADY_LINKED"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"LINK_ONLY"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"MISSING"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"SOURCE_IGNORED"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"SOURCE_MISSING"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"TARGET_IGNORED"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"UNASSIGNED"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"UNQUALIFIED"</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/
|
|
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>MappingPolicy | 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">MappingPolicy</a></li></ul><h1>Type Alias MappingPolicy</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">type</span> <span class="tsd-kind-type-alias">MappingPolicy</span> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#action">action</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"CREATE"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"DELETE"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"EXCEPTION"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"IGNORE"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"UPDATE"</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#situation">situation</a><span class="tsd-signature-symbol">:</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"ABSENT"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"ALL_GONE"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"AMBIGUOUS"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"CONFIRMED"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"FOUND"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"FOUND_ALREADY_LINKED"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"LINK_ONLY"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"MISSING"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"SOURCE_IGNORED"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"SOURCE_MISSING"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"TARGET_IGNORED"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"UNASSIGNED"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"UNQUALIFIED"</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/MappingOps.ts#L235">ops/MappingOps.ts:235</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">Properties</h3><div class="tsd-index-list"><a href="#action" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>action</span></a>
|
|
2
2
|
<a href="#situation" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>situation</span></a>
|
|
3
|
-
</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-Properties"><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>Properties</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="action"><span>action</span><a href="#action" 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><div class="tsd-signature"><span class="tsd-kind-property">action</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"CREATE"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"DELETE"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"EXCEPTION"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"IGNORE"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"UPDATE"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/
|
|
3
|
+
</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-Properties"><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>Properties</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="action"><span>action</span><a href="#action" 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><div class="tsd-signature"><span class="tsd-kind-property">action</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"CREATE"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"DELETE"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"EXCEPTION"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"IGNORE"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"UPDATE"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/2532f5e8e6bb6870ab10a382d68f9e33d6f5e7de/src/ops/MappingOps.ts#L236">ops/MappingOps.ts:236</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="situation"><span>situation</span><a href="#situation" 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><div class="tsd-signature"><span class="tsd-kind-property">situation</span><span class="tsd-signature-symbol">:</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"ABSENT"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"ALL_GONE"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"AMBIGUOUS"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"CONFIRMED"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"FOUND"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"FOUND_ALREADY_LINKED"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"LINK_ONLY"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"MISSING"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"SOURCE_IGNORED"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"SOURCE_MISSING"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"TARGET_IGNORED"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"UNASSIGNED"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"UNQUALIFIED"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/2532f5e8e6bb6870ab10a382d68f9e33d6f5e7de/src/ops/MappingOps.ts#L237">ops/MappingOps.ts:237</a></li></ul></aside></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-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#action"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>action</span></a><a href="#situation"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>situation</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>
|