@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>Variable | 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">Variable</a></li></ul><h1>Type Alias Variable</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">type</span> <span class="tsd-kind-type-alias">Variable</span> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-call-signature" href="#createvariable-1">createVariable</a><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">variableId</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">value</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">description</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">expressionType</span><span class="tsd-signature-symbol">?:</span> <a href="Reference.VariableExpressionType.html" class="tsd-signature-type tsd-kind-type-alias">VariableExpressionType</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">noEncode</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</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.VariableSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">VariableSkeleton</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#deletevariable-1">deleteVariable</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">variableId</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.VariableSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">VariableSkeleton</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#exportvariable-1">exportVariable</a><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">variableId</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">noDecode</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</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="../interfaces/Reference.VariablesExportInterface.html" class="tsd-signature-type tsd-kind-interface">VariablesExportInterface</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#exportvariables-1">exportVariables</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">noDecode</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</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="../interfaces/Reference.VariablesExportInterface.html" class="tsd-signature-type tsd-kind-interface">VariablesExportInterface</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#getvariable-1">getVariable</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">variableId</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.VariableSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">VariableSkeleton</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#getvariables-1">getVariables</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.VariableSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">VariableSkeleton</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="#importvariable-1">importVariable</a><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">variableId</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.VariablesExportInterface.html" class="tsd-signature-type tsd-kind-interface">VariablesExportInterface</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.VariableSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">VariableSkeleton</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#importvariables-1">importVariables</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.VariablesExportInterface.html" class="tsd-signature-type tsd-kind-interface">VariablesExportInterface</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.VariableSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">VariableSkeleton</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="#putvariable-1">putVariable</a><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">variableId</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">valueBase64</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">description</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">expressionType</span><span class="tsd-signature-symbol">?:</span> <a href="Reference.VariableExpressionType.html" class="tsd-signature-type tsd-kind-type-alias">VariableExpressionType</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.VariableSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">VariableSkeleton</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#readvariable-1">readVariable</a><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">variableId</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">noDecode</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</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.VariableSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">VariableSkeleton</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#readvariables-1">readVariables</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">noDecode</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</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.VariableSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">VariableSkeleton</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="#resolvevariable-1">resolveVariable</a><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">input</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">variables</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <a href="Reference.VariableSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">VariableSkeleton</a><span class="tsd-signature-symbol">></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><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#setvariabledescription-1">setVariableDescription</a><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">variableId</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">description</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><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#updatevariable-1">updateVariable</a><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">variableId</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">value</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">description</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">expressionType</span><span class="tsd-signature-symbol">?:</span> <a href="Reference.VariableExpressionType.html" class="tsd-signature-type tsd-kind-type-alias">VariableExpressionType</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">noEncode</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</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.VariableSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">VariableSkeleton</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#updatevariabledescription-1">updateVariableDescription</a><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">variableId</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">description</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.VariableSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">VariableSkeleton</a><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/cloud/VariablesOps.ts#L23">ops/cloud/VariablesOps.ts:23</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="#createvariable" 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/>Variable</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>Variable | 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">Variable</a></li></ul><h1>Type Alias Variable</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">type</span> <span class="tsd-kind-type-alias">Variable</span> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-call-signature" href="#createvariable-1">createVariable</a><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">variableId</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">value</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">description</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">expressionType</span><span class="tsd-signature-symbol">?:</span> <a href="Reference.VariableExpressionType.html" class="tsd-signature-type tsd-kind-type-alias">VariableExpressionType</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">noEncode</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</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.VariableSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">VariableSkeleton</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#deletevariable-1">deleteVariable</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">variableId</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.VariableSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">VariableSkeleton</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#exportvariable-1">exportVariable</a><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">variableId</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">noDecode</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</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="../interfaces/Reference.VariablesExportInterface.html" class="tsd-signature-type tsd-kind-interface">VariablesExportInterface</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#exportvariables-1">exportVariables</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">noDecode</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</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="../interfaces/Reference.VariablesExportInterface.html" class="tsd-signature-type tsd-kind-interface">VariablesExportInterface</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#getvariable-1">getVariable</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">variableId</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.VariableSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">VariableSkeleton</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#getvariables-1">getVariables</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.VariableSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">VariableSkeleton</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="#importvariable-1">importVariable</a><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">variableId</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.VariablesExportInterface.html" class="tsd-signature-type tsd-kind-interface">VariablesExportInterface</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.VariableSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">VariableSkeleton</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#importvariables-1">importVariables</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.VariablesExportInterface.html" class="tsd-signature-type tsd-kind-interface">VariablesExportInterface</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.VariableSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">VariableSkeleton</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="#putvariable-1">putVariable</a><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">variableId</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">valueBase64</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">description</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">expressionType</span><span class="tsd-signature-symbol">?:</span> <a href="Reference.VariableExpressionType.html" class="tsd-signature-type tsd-kind-type-alias">VariableExpressionType</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.VariableSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">VariableSkeleton</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#readvariable-1">readVariable</a><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">variableId</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">noDecode</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</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.VariableSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">VariableSkeleton</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#readvariables-1">readVariables</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">noDecode</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</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.VariableSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">VariableSkeleton</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="#resolvevariable-1">resolveVariable</a><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">input</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">variables</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <a href="Reference.VariableSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">VariableSkeleton</a><span class="tsd-signature-symbol">></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><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#setvariabledescription-1">setVariableDescription</a><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">variableId</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">description</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><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#updatevariable-1">updateVariable</a><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">variableId</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">value</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">description</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">expressionType</span><span class="tsd-signature-symbol">?:</span> <a href="Reference.VariableExpressionType.html" class="tsd-signature-type tsd-kind-type-alias">VariableExpressionType</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">noEncode</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</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.VariableSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">VariableSkeleton</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#updatevariabledescription-1">updateVariableDescription</a><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">variableId</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">description</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.VariableSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">VariableSkeleton</a><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/cloud/VariablesOps.ts#L23">ops/cloud/VariablesOps.ts:23</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="#createvariable" 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/>Variable</span></a>
|
|
2
2
|
<a href="#deletevariable" 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/>Variable</span></a>
|
|
3
3
|
<a href="#exportvariable" 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>export<wbr/>Variable</span></a>
|
|
4
4
|
<a href="#exportvariables" 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>export<wbr/>Variables</span></a>
|
|
@@ -20,59 +20,59 @@
|
|
|
20
20
|
</div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">expressionType</span>: <a href="Reference.VariableExpressionType.html" class="tsd-signature-type tsd-kind-type-alias">VariableExpressionType</a></span><div class="tsd-comment tsd-typography"><p>type of the value</p>
|
|
21
21
|
</div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">noEncode</span>: <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>do not encode if passing a pre-encoded (base64) value</p>
|
|
22
22
|
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.VariableSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">VariableSkeleton</a><span class="tsd-signature-symbol">></span></h4><p>a promise that resolves to a variable object</p>
|
|
23
|
-
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/
|
|
23
|
+
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/2532f5e8e6bb6870ab10a382d68f9e33d6f5e7de/src/ops/cloud/VariablesOps.ts#L83">ops/cloud/VariablesOps.ts:83</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="deletevariable"><span>delete<wbr/>Variable</span><a href="#deletevariable" 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="deletevariable-1"><span class="tsd-kind-call-signature">deleteVariable</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">variableId</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.VariableSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">VariableSkeleton</a><span class="tsd-signature-symbol">></span><a href="#deletevariable-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 variable by id/name</p>
|
|
24
24
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">variableId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>variable id/name</p>
|
|
25
25
|
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.VariableSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">VariableSkeleton</a><span class="tsd-signature-symbol">></span></h4><p>a promise that resolves to a variable object</p>
|
|
26
|
-
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/
|
|
26
|
+
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/2532f5e8e6bb6870ab10a382d68f9e33d6f5e7de/src/ops/cloud/VariablesOps.ts#L121">ops/cloud/VariablesOps.ts:121</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="exportvariable"><span>export<wbr/>Variable</span><a href="#exportvariable" 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="exportvariable-1"><span class="tsd-kind-call-signature">exportVariable</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">variableId</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">noDecode</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</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="../interfaces/Reference.VariablesExportInterface.html" class="tsd-signature-type tsd-kind-interface">VariablesExportInterface</a><span class="tsd-signature-symbol">></span><a href="#exportvariable-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 variable. The response can be saved to file as is.</p>
|
|
27
27
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">variableId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>variable id/name</p>
|
|
28
28
|
</div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">noDecode</span>: <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>Do not decode value (default: false)</p>
|
|
29
29
|
</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.VariablesExportInterface.html" class="tsd-signature-type tsd-kind-interface">VariablesExportInterface</a><span class="tsd-signature-symbol">></span></h4><p>Promise resolving to a VariablesExportInterface object.</p>
|
|
30
|
-
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/
|
|
30
|
+
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/2532f5e8e6bb6870ab10a382d68f9e33d6f5e7de/src/ops/cloud/VariablesOps.ts#L46">ops/cloud/VariablesOps.ts:46</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="exportvariables"><span>export<wbr/>Variables</span><a href="#exportvariables" 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="exportvariables-1"><span class="tsd-kind-call-signature">exportVariables</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">noDecode</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</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="../interfaces/Reference.VariablesExportInterface.html" class="tsd-signature-type tsd-kind-interface">VariablesExportInterface</a><span class="tsd-signature-symbol">></span><a href="#exportvariables-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 variables</p>
|
|
31
31
|
</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">noDecode</span>: <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>Do not decode values (default: false)</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.VariablesExportInterface.html" class="tsd-signature-type tsd-kind-interface">VariablesExportInterface</a><span class="tsd-signature-symbol">></span></h4><p>Promise resolving to an VariablesExportInterface 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/cloud/VariablesOps.ts#L55">ops/cloud/VariablesOps.ts:55</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="importvariable"><span>import<wbr/>Variable</span><a href="#importvariable" 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="importvariable-1"><span class="tsd-kind-call-signature">importVariable</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">variableId</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.VariablesExportInterface.html" class="tsd-signature-type tsd-kind-interface">VariablesExportInterface</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.VariableSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">VariableSkeleton</a><span class="tsd-signature-symbol">></span><a href="#importvariable-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 variable by id</p>
|
|
34
34
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">variableId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>variable id/name</p>
|
|
35
35
|
</div></li><li><span><span class="tsd-kind-parameter">importData</span>: <a href="../interfaces/Reference.VariablesExportInterface.html" class="tsd-signature-type tsd-kind-interface">VariablesExportInterface</a></span><div class="tsd-comment tsd-typography"><p>import data</p>
|
|
36
36
|
</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.VariableSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">VariableSkeleton</a><span class="tsd-signature-symbol">></span></h4><p>imported variable object</p>
|
|
37
|
-
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/
|
|
37
|
+
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/2532f5e8e6bb6870ab10a382d68f9e33d6f5e7de/src/ops/cloud/VariablesOps.ts#L62">ops/cloud/VariablesOps.ts:62</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="importvariables"><span>import<wbr/>Variables</span><a href="#importvariables" 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="importvariables-1"><span class="tsd-kind-call-signature">importVariables</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.VariablesExportInterface.html" class="tsd-signature-type tsd-kind-interface">VariablesExportInterface</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.VariableSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">VariableSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#importvariables-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 variables</p>
|
|
38
38
|
</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.VariablesExportInterface.html" class="tsd-signature-type tsd-kind-interface">VariablesExportInterface</a></span><div class="tsd-comment tsd-typography"><p>import data</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.VariableSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">VariableSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><p>array of imported variable objects</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/cloud/VariablesOps.ts#L71">ops/cloud/VariablesOps.ts:71</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="readvariable"><span>read<wbr/>Variable</span><a href="#readvariable" 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="readvariable-1"><span class="tsd-kind-call-signature">readVariable</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">variableId</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">noDecode</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</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.VariableSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">VariableSkeleton</a><span class="tsd-signature-symbol">></span><a href="#readvariable-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 variable by id/name</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">variableId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>variable id/name</p>
|
|
42
42
|
</div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">noDecode</span>: <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>Do not decode value (default: false)</p>
|
|
43
43
|
</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.VariableSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">VariableSkeleton</a><span class="tsd-signature-symbol">></span></h4><p>a promise that resolves to a variable object</p>
|
|
44
|
-
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/
|
|
44
|
+
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/2532f5e8e6bb6870ab10a382d68f9e33d6f5e7de/src/ops/cloud/VariablesOps.ts#L30">ops/cloud/VariablesOps.ts:30</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="readvariables"><span>read<wbr/>Variables</span><a href="#readvariables" 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="readvariables-1"><span class="tsd-kind-call-signature">readVariables</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">noDecode</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</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.VariableSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">VariableSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#readvariables-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Read all variables</p>
|
|
45
45
|
</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">noDecode</span>: <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>Do not decode values (default: false)</p>
|
|
46
46
|
</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.VariableSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">VariableSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><p>a promise that resolves to an array of variable objects</p>
|
|
47
|
-
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/
|
|
47
|
+
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/2532f5e8e6bb6870ab10a382d68f9e33d6f5e7de/src/ops/cloud/VariablesOps.ts#L39">ops/cloud/VariablesOps.ts:39</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="resolvevariable"><span>resolve<wbr/>Variable</span><a href="#resolvevariable" 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="resolvevariable-1"><span class="tsd-kind-call-signature">resolveVariable</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">input</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">variables</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <a href="Reference.VariableSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">VariableSkeleton</a><span class="tsd-signature-symbol">></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><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><a href="#resolvevariable-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>Attempt to resolve a string to an ESV variable in AIC deployments.</p>
|
|
48
48
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">input</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>Input string to be evaluated as a possible ESV.</p>
|
|
49
49
|
</div></li><li><span><span class="tsd-kind-parameter">variables</span>: <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <a href="Reference.VariableSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">VariableSkeleton</a><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>Provide an empty or prepopulated map of ESV variables. The function adds any resolved variables to the map that don't exist.</p>
|
|
50
50
|
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4><p>Returns the resolved value of the ESV or the original input string</p>
|
|
51
|
-
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/
|
|
51
|
+
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/2532f5e8e6bb6870ab10a382d68f9e33d6f5e7de/src/ops/cloud/VariablesOps.ts#L128">ops/cloud/VariablesOps.ts:128</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="updatevariable"><span>update<wbr/>Variable</span><a href="#updatevariable" 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="updatevariable-1"><span class="tsd-kind-call-signature">updateVariable</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">variableId</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">value</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">description</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">expressionType</span><span class="tsd-signature-symbol">?:</span> <a href="Reference.VariableExpressionType.html" class="tsd-signature-type tsd-kind-type-alias">VariableExpressionType</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">noEncode</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</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.VariableSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">VariableSkeleton</a><span class="tsd-signature-symbol">></span><a href="#updatevariable-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 variable</p>
|
|
52
52
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">variableId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>variable id/name</p>
|
|
53
53
|
</div></li><li><span><span class="tsd-kind-parameter">value</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>variable value</p>
|
|
54
54
|
</div></li><li><span><span class="tsd-kind-parameter">description</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>variable description</p>
|
|
55
55
|
</div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">expressionType</span>: <a href="Reference.VariableExpressionType.html" class="tsd-signature-type tsd-kind-type-alias">VariableExpressionType</a></span><div class="tsd-comment tsd-typography"><p>type of the value</p>
|
|
56
56
|
</div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">noEncode</span>: <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>do not encode if passing a pre-encoded (base64) value</p>
|
|
57
57
|
</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.VariableSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">VariableSkeleton</a><span class="tsd-signature-symbol">></span></h4><p>a promise that resolves to a variable object</p>
|
|
58
|
-
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/
|
|
58
|
+
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/2532f5e8e6bb6870ab10a382d68f9e33d6f5e7de/src/ops/cloud/VariablesOps.ts#L99">ops/cloud/VariablesOps.ts:99</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="updatevariabledescription"><span>update<wbr/>Variable<wbr/>Description</span><a href="#updatevariabledescription" 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="updatevariabledescription-1"><span class="tsd-kind-call-signature">updateVariableDescription</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">variableId</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">description</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.VariableSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">VariableSkeleton</a><span class="tsd-signature-symbol">></span><a href="#updatevariabledescription-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 variable description</p>
|
|
59
59
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">variableId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>variable id/name</p>
|
|
60
60
|
</div></li><li><span><span class="tsd-kind-parameter">description</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>variable description</p>
|
|
61
61
|
</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.VariableSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">VariableSkeleton</a><span class="tsd-signature-symbol">></span></h4><p>a promise that resolves to a status object</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/cloud/VariablesOps.ts#L112">ops/cloud/VariablesOps.ts:112</a></li></ul></aside></div></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Deprecated"><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>Deprecated</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getvariable"><span class="deprecated">get<wbr/>Variable</span><a href="#getvariable" 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="getvariable-1"><span class="tsd-kind-call-signature">getVariable</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">variableId</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.VariableSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">VariableSkeleton</a><span class="tsd-signature-symbol">></span><a href="#getvariable-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>Get variable by id/name</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">variableId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>variable id/name</p>
|
|
64
64
|
</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.VariableSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">VariableSkeleton</a><span class="tsd-signature-symbol">></span></h4><p>a promise that resolves to a variable object</p>
|
|
65
65
|
<div class="tsd-comment tsd-typography"><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link" id="deprecated">Deprecated<a href="#deprecated" 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>since v2.0.0 use <a href="#readvariable" class="tsd-kind-method">readVariable</a> instead</p>
|
|
66
66
|
<pre><code class="javascript"><span class="hl-7">readVariable</span><span class="hl-0">(</span><span class="hl-3">variableId</span><span class="hl-0">: </span><span class="hl-3">string</span><span class="hl-0">): </span><span class="hl-10">Promise</span><span class="hl-0"><</span><span class="hl-3">VariableSkeleton</span><span class="hl-0">></span>
|
|
67
67
|
</code><button type="button">Copy</button></pre>
|
|
68
68
|
|
|
69
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/
|
|
69
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/2532f5e8e6bb6870ab10a382d68f9e33d6f5e7de/src/ops/cloud/VariablesOps.ts#L145">ops/cloud/VariablesOps.ts:145</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getvariables"><span class="deprecated">get<wbr/>Variables</span><a href="#getvariables" 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="getvariables-1"><span class="tsd-kind-call-signature">getVariables</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.VariableSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">VariableSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#getvariables-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>Get all variables</p>
|
|
70
70
|
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.VariableSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">VariableSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><p>a promise that resolves to an array of variable objects</p>
|
|
71
71
|
<div class="tsd-comment tsd-typography"><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link" id="deprecated-1">Deprecated<a href="#deprecated-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></h4><p>since v2.0.0 use <a href="#readvariables" class="tsd-kind-method">readVariables</a> instead</p>
|
|
72
72
|
<pre><code class="javascript"><span class="hl-7">readVariables</span><span class="hl-0">(): </span><span class="hl-10">Promise</span><span class="hl-0"><</span><span class="hl-3">VariableSkeleton</span><span class="hl-0">[]></span>
|
|
73
73
|
</code><button type="button">Copy</button></pre>
|
|
74
74
|
|
|
75
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/
|
|
75
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/2532f5e8e6bb6870ab10a382d68f9e33d6f5e7de/src/ops/cloud/VariablesOps.ts#L155">ops/cloud/VariablesOps.ts:155</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="putvariable"><span class="deprecated">put<wbr/>Variable</span><a href="#putvariable" 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="putvariable-1"><span class="tsd-kind-call-signature">putVariable</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">variableId</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">valueBase64</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">description</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">expressionType</span><span class="tsd-signature-symbol">?:</span> <a href="Reference.VariableExpressionType.html" class="tsd-signature-type tsd-kind-type-alias">VariableExpressionType</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.VariableSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">VariableSkeleton</a><span class="tsd-signature-symbol">></span><a href="#putvariable-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 variable</p>
|
|
76
76
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">variableId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>variable id/name</p>
|
|
77
77
|
</div></li><li><span><span class="tsd-kind-parameter">valueBase64</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>base64-encoded variable value</p>
|
|
78
78
|
</div></li><li><span><span class="tsd-kind-parameter">description</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>variable description</p>
|
|
@@ -82,7 +82,7 @@
|
|
|
82
82
|
<pre><code class="javascript"><span class="hl-7">createVariable</span><span class="hl-0">(</span><span class="hl-3">variableId</span><span class="hl-0">: </span><span class="hl-3">string</span><span class="hl-0">, </span><span class="hl-3">value</span><span class="hl-0">: </span><span class="hl-3">string</span><span class="hl-0">, </span><span class="hl-3">description</span><span class="hl-0">: </span><span class="hl-3">string</span><span class="hl-0">, </span><span class="hl-3">expressionType</span><span class="hl-0">?: </span><span class="hl-3">VariableExpressionType</span><span class="hl-0">): </span><span class="hl-10">Promise</span><span class="hl-0"><</span><span class="hl-3">VariableSkeleton</span><span class="hl-0">></span>
|
|
83
83
|
</code><button type="button">Copy</button></pre>
|
|
84
84
|
|
|
85
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/
|
|
85
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/2532f5e8e6bb6870ab10a382d68f9e33d6f5e7de/src/ops/cloud/VariablesOps.ts#L169">ops/cloud/VariablesOps.ts:169</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="setvariabledescription"><span class="deprecated">set<wbr/>Variable<wbr/>Description</span><a href="#setvariabledescription" 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="setvariabledescription-1"><span class="tsd-kind-call-signature">setVariableDescription</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">variableId</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">description</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><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><a href="#setvariabledescription-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>Set variable description</p>
|
|
86
86
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">variableId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>variable id/name</p>
|
|
87
87
|
</div></li><li><span><span class="tsd-kind-parameter">description</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>variable description</p>
|
|
88
88
|
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4><p>a promise that resolves to an empty string</p>
|
|
@@ -90,4 +90,4 @@
|
|
|
90
90
|
<pre><code class="javascript"><span class="hl-7">updateVariableDescription</span><span class="hl-0">(</span><span class="hl-3">variableId</span><span class="hl-0">: </span><span class="hl-3">string</span><span class="hl-0">, </span><span class="hl-3">description</span><span class="hl-0">: </span><span class="hl-3">string</span><span class="hl-0">): </span><span class="hl-10">Promise</span><span class="hl-0"><</span><span class="hl-3">any</span><span class="hl-0">></span>
|
|
91
91
|
</code><button type="button">Copy</button></pre>
|
|
92
92
|
|
|
93
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/
|
|
93
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/2532f5e8e6bb6870ab10a382d68f9e33d6f5e7de/src/ops/cloud/VariablesOps.ts#L186">ops/cloud/VariablesOps.ts:186</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="#createvariable"><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/>Variable</span></a><a href="#deletevariable"><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/>Variable</span></a><a href="#exportvariable"><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/>Variable</span></a><a href="#exportvariables"><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/>Variables</span></a><a href="#importvariable"><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/>Variable</span></a><a href="#importvariables"><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/>Variables</span></a><a href="#readvariable"><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/>Variable</span></a><a href="#readvariables"><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/>Variables</span></a><a href="#resolvevariable"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>resolve<wbr/>Variable</span></a><a href="#updatevariable"><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/>Variable</span></a><a href="#updatevariabledescription"><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/>Variable<wbr/>Description</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Deprecated"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Deprecated</summary><div><a href="#getvariable"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Variable</span></a><a href="#getvariables"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Variables</span></a><a href="#putvariable"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>put<wbr/>Variable</span></a><a href="#setvariabledescription"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Variable<wbr/>Description</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
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>VariableExpressionType | 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">VariableExpressionType</a></li></ul><h1>Type Alias VariableExpressionType</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">VariableExpressionType</span><span class="tsd-signature-symbol">:</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"array"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"base64encodedinlined"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"bool"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"int"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"keyvaluelist"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"list"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"number"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"object"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"string"</span></div><div class="tsd-comment tsd-typography"><p>Variable types</p>
|
|
2
2
|
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-see"><h4 class="tsd-anchor-link" id="see">See<a href="#see" 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><a href="https://backstage.forgerock.com/docs/idcloud/latest/tenants/esvs.html#variable_types">ForgeRock Documentation</a></p>
|
|
3
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/
|
|
3
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/2532f5e8e6bb6870ab10a382d68f9e33d6f5e7de/src/api/cloud/VariablesApi.ts#L39">api/cloud/VariablesApi.ts:39</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav id="tsd-sidebar-links" class="tsd-navigation"><a href="https://github.com/rockcarver/frodo-lib" class="tsd-nav-link">Project Home</a></nav><nav class="tsd-navigation"><a href="../modules.html">Frodo Library - v4.1.4</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer></footer><div class="overlay"></div></body></html>
|
|
@@ -1,2 +1,2 @@
|
|
|
1
1
|
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>VariableSkeleton | 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">VariableSkeleton</a></li></ul><h1>Type Alias VariableSkeleton</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">VariableSkeleton</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/Reference.IdObjectSkeletonInterface.html" class="tsd-signature-type tsd-kind-interface">IdObjectSkeletonInterface</a> <span class="tsd-signature-symbol">&</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">description</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">expressionType</span><span class="tsd-signature-symbol">?:</span> <a href="Reference.VariableExpressionType.html" class="tsd-signature-type tsd-kind-type-alias">VariableExpressionType</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">lastChangeDate</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">lastChangedBy</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">loaded</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">value</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">valueBase64</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>Variable object skeleton</p>
|
|
2
|
-
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/
|
|
2
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/2532f5e8e6bb6870ab10a382d68f9e33d6f5e7de/src/api/cloud/VariablesApi.ts#L53">api/cloud/VariablesApi.ts:53</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav id="tsd-sidebar-links" class="tsd-navigation"><a href="https://github.com/rockcarver/frodo-lib" class="tsd-nav-link">Project Home</a></nav><nav class="tsd-navigation"><a href="../modules.html">Frodo Library - v4.1.4</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer></footer><div class="overlay"></div></body></html>
|