@openfort/openfort-node 0.6.26 → 0.6.28
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/dist/apis/accountsApiWrapper.d.ts +8 -0
- package/dist/apis/accountsApiWrapper.js +10 -0
- package/dist/apis/accountsApiWrapper.js.map +1 -1
- package/dist/apis/transactionIntentsApiWrapper.js +1 -1
- package/dist/apis/transactionIntentsApiWrapper.js.map +1 -1
- package/dist/apis/web3ConnectionsApiWrapper.js +1 -1
- package/dist/apis/web3ConnectionsApiWrapper.js.map +1 -1
- package/dist/generated/apis/AccountsApi.d.ts +18 -0
- package/dist/generated/apis/AccountsApi.js +72 -0
- package/dist/generated/apis/AccountsApi.js.map +1 -1
- package/dist/generated/apis/OAuthApi.js +1 -1
- package/dist/generated/apis/OAuthApi.js.map +1 -1
- package/dist/generated/apis/PlayersAuthenticationApi.d.ts +28 -0
- package/dist/generated/apis/PlayersAuthenticationApi.js +90 -0
- package/dist/generated/apis/PlayersAuthenticationApi.js.map +1 -1
- package/dist/generated/apis/PoliciesApi.d.ts +2 -2
- package/dist/generated/apis/PoliciesApi.js +2 -2
- package/dist/generated/apis/PolicyRulesApi.d.ts +2 -2
- package/dist/generated/apis/PolicyRulesApi.js +2 -2
- package/dist/generated/apis/Web3ConnectionsApi.d.ts +5 -5
- package/dist/generated/apis/Web3ConnectionsApi.js +5 -9
- package/dist/generated/apis/Web3ConnectionsApi.js.map +1 -1
- package/dist/generated/models/AuthPlayerResponse.d.ts +3 -2
- package/dist/generated/models/AuthPlayerResponse.js +12 -6
- package/dist/generated/models/AuthPlayerResponse.js.map +1 -1
- package/dist/generated/models/DeployRequest.d.ts +31 -0
- package/dist/generated/models/DeployRequest.js +32 -0
- package/dist/generated/models/DeployRequest.js.map +1 -0
- package/dist/generated/models/GoogleOAuthConfig.d.ts +1 -1
- package/dist/generated/models/OAuthConfig.d.ts +1 -1
- package/dist/generated/models/ObjectSerializer.d.ts +4 -0
- package/dist/generated/models/ObjectSerializer.js +12 -0
- package/dist/generated/models/ObjectSerializer.js.map +1 -1
- package/dist/generated/models/RegisterPlayerEncryptedKeyRequest.d.ts +39 -0
- package/dist/generated/models/RegisterPlayerEncryptedKeyRequest.js +44 -0
- package/dist/generated/models/RegisterPlayerEncryptedKeyRequest.js.map +1 -0
- package/dist/generated/models/RegisterPlayerEncryptedKeyResponse.d.ts +31 -0
- package/dist/generated/models/RegisterPlayerEncryptedKeyResponse.js +50 -0
- package/dist/generated/models/RegisterPlayerEncryptedKeyResponse.js.map +1 -0
- package/dist/generated/models/RetrievePlayerEncryptedKeyResponse.d.ts +33 -0
- package/dist/generated/models/RetrievePlayerEncryptedKeyResponse.js +62 -0
- package/dist/generated/models/RetrievePlayerEncryptedKeyResponse.js.map +1 -0
- package/dist/generated/models/SubmitWeb3ActionRequest.d.ts +4 -0
- package/dist/generated/models/SubmitWeb3ActionRequest.js +6 -0
- package/dist/generated/models/SubmitWeb3ActionRequest.js.map +1 -1
- package/dist/generated/models/Web3ActionResponse.d.ts +10 -1
- package/dist/generated/models/Web3ActionResponse.js +56 -2
- package/dist/generated/models/Web3ActionResponse.js.map +1 -1
- package/dist/generated/models/Web3ConnectionListQueries.d.ts +1 -1
- package/dist/generated/models/all.d.ts +4 -0
- package/dist/generated/models/all.js +4 -0
- package/dist/generated/models/all.js.map +1 -1
- package/dist/generated/types/ObjectParamAPI.d.ts +60 -14
- package/dist/generated/types/ObjectParamAPI.js +26 -2
- package/dist/generated/types/ObjectParamAPI.js.map +1 -1
- package/dist/generated/types/ObservableAPI.d.ts +31 -9
- package/dist/generated/types/ObservableAPI.js +73 -10
- package/dist/generated/types/ObservableAPI.js.map +1 -1
- package/dist/generated/types/PromiseAPI.d.ts +31 -9
- package/dist/generated/types/PromiseAPI.js +37 -10
- package/dist/generated/types/PromiseAPI.js.map +1 -1
- package/dist/models/deployRequest.d.ts +4 -0
- package/dist/models/deployRequest.js +3 -0
- package/dist/models/deployRequest.js.map +1 -0
- package/dist/models/getTransactionIntentRequest.d.ts +1 -0
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/package.json +1 -1
- package/tsconfig.tsbuildinfo +1 -1
- package/docs/.nojekyll +0 -1
- package/docs/assets/highlight.css +0 -78
- package/docs/assets/icons.css +0 -1043
- package/docs/assets/icons.png +0 -0
- package/docs/assets/icons@2x.png +0 -0
- package/docs/assets/main.js +0 -52
- package/docs/assets/search.js +0 -1
- package/docs/assets/style.css +0 -1414
- package/docs/assets/widgets.png +0 -0
- package/docs/assets/widgets@2x.png +0 -0
- package/docs/classes/apis_baseApiWrapper.BaseApiWrapper.html +0 -1
- package/docs/classes/apis_contractsApiWrapper.ContractsApiWrapper.html +0 -21
- package/docs/classes/apis_iamApiWrapper.IamApiWrapper.html +0 -5
- package/docs/classes/apis_inventoriesApiWrapper.InventoriesApiWrapper.html +0 -13
- package/docs/classes/apis_oauthApiWrapper.OAuthApiWrapper.html +0 -5
- package/docs/classes/apis_playersApiWrapper.PlayersApiWrapper.html +0 -45
- package/docs/classes/apis_policiesApiWrapper.PoliciesApiWrapper.html +0 -43
- package/docs/classes/apis_policyRulesApiWrapper.PolicyRulesApiWrapper.html +0 -17
- package/docs/classes/apis_sessionsApiWrapper.SessionsApiWrapper.html +0 -17
- package/docs/classes/apis_settingsApiWrapper.SettingsApiWrapper.html +0 -21
- package/docs/classes/apis_transactionIntentsApiWrapper.TransactionIntentsApiWrapper.html +0 -21
- package/docs/classes/apis_web3ConnectionsApiWrapper.Web3ConnectionsApiWrapper.html +0 -21
- package/docs/classes/generated.AccountInventoryListQueries.html +0 -5
- package/docs/classes/generated.AccountsApi.html +0 -55
- package/docs/classes/generated.ApiException.html +0 -12
- package/docs/classes/generated.AuthenticationApi.html +0 -11
- package/docs/classes/generated.CancelTransferOwnershipRequest.html +0 -3
- package/docs/classes/generated.CompleteRecoveryRequest.html +0 -7
- package/docs/classes/generated.ContractsApi.html +0 -46
- package/docs/classes/generated.CreatePlayerSessionRequest.html +0 -19
- package/docs/classes/generated.GoogleAuthenticationApi.html +0 -7
- package/docs/classes/generated.HttpException.html +0 -6
- package/docs/classes/generated.InventoriesApi.html +0 -71
- package/docs/classes/generated.IsomorphicFetchHttpLibrary.html +0 -1
- package/docs/classes/generated.OAuthApi.html +0 -40
- package/docs/classes/generated.PkAuthentication.html +0 -9
- package/docs/classes/generated.PlayerCancelTransferOwnershipRequest.html +0 -5
- package/docs/classes/generated.PlayerInventoryListQueries.html +0 -9
- package/docs/classes/generated.PlayerTransferOwnershipRequest.html +0 -9
- package/docs/classes/generated.PlayersApi.html +0 -64
- package/docs/classes/generated.PlayersAuthenticationApi.html +0 -11
- package/docs/classes/generated.PoliciesApi.html +0 -63
- package/docs/classes/generated.PolicyRulesApi.html +0 -25
- package/docs/classes/generated.RequestContext.html +0 -20
- package/docs/classes/generated.RequiredError.html +0 -6
- package/docs/classes/generated.ResponseContext.html +0 -9
- package/docs/classes/generated.SelfDecodingBody.html +0 -3
- package/docs/classes/generated.SessionsApi.html +0 -30
- package/docs/classes/generated.SettingsApi.html +0 -25
- package/docs/classes/generated.SignPayloadRequest.html +0 -3
- package/docs/classes/generated.SkAuthentication.html +0 -9
- package/docs/classes/generated.StartRecoveryRequest.html +0 -5
- package/docs/classes/generated.TransactionIntentsApi.html +0 -39
- package/docs/classes/generated.TransferOwnershipRequest.html +0 -5
- package/docs/classes/generated.UpdateContractRequest.html +0 -13
- package/docs/classes/generated.UpdatePolicyRequest.html +0 -7
- package/docs/classes/generated.UpdatePolicyRuleRequest.html +0 -11
- package/docs/classes/generated.UpdateProjectRequest.html +0 -1
- package/docs/classes/generated.Web3ConnectionsApi.html +0 -33
- package/docs/classes/generated_middleware.PromiseMiddlewareWrapper.html +0 -7
- package/docs/classes/generated_rxjsStub.Observable.html +0 -1
- package/docs/classes/generated_servers.ServerConfiguration.html +0 -17
- package/docs/classes/index.Abi.html +0 -1
- package/docs/classes/index.AbiType.html +0 -1
- package/docs/classes/index.AccelbyteOAuthConfig.html +0 -11
- package/docs/classes/index.Account.html +0 -3
- package/docs/classes/index.AccountListQueries.html +0 -9
- package/docs/classes/index.AccountListResponse.html +0 -1
- package/docs/classes/index.AccountPolicyRuleResponse.html +0 -1
- package/docs/classes/index.AccountResponse.html +0 -3
- package/docs/classes/index.ApiAuthorizedNetworkListResponse.html +0 -1
- package/docs/classes/index.ApiAuthorizedNetworkResponse.html +0 -1
- package/docs/classes/index.ApiKeyResponse.html +0 -1
- package/docs/classes/index.AssetInventory.html +0 -3
- package/docs/classes/index.AuthPlayerListQueries.html +0 -7
- package/docs/classes/index.AuthPlayerListResponse.html +0 -1
- package/docs/classes/index.AuthPlayerResponse.html +0 -1
- package/docs/classes/index.AuthPlayerResponsePlayer.html +0 -1
- package/docs/classes/index.AuthResponse.html +0 -5
- package/docs/classes/index.AuthenticatedPlayerResponse.html +0 -3
- package/docs/classes/index.AuthorizeWithOAuthToken200Response.html +0 -5
- package/docs/classes/index.BalanceResponse.html +0 -1
- package/docs/classes/index.ChargeCustomTokenPolicyStrategy.html +0 -1
- package/docs/classes/index.CheckoutRequest.html +0 -3
- package/docs/classes/index.CheckoutResponse.html +0 -1
- package/docs/classes/index.ContractDeleteResponse.html +0 -1
- package/docs/classes/index.ContractListQueries.html +0 -13
- package/docs/classes/index.ContractListResponse.html +0 -1
- package/docs/classes/index.ContractPolicyRuleResponse.html +0 -1
- package/docs/classes/index.ContractPolicyRuleResponseContract.html +0 -3
- package/docs/classes/index.ContractReadQueries.html +0 -5
- package/docs/classes/index.ContractReadResponse.html +0 -1
- package/docs/classes/index.ContractResponse.html +0 -3
- package/docs/classes/index.CountPerIntervalLimitPolicyRuleResponse.html +0 -1
- package/docs/classes/index.CreateAccountRequest.html +0 -11
- package/docs/classes/index.CreateApiAuthorizedNetworkRequest.html +0 -1
- package/docs/classes/index.CreateContractRequest.html +0 -11
- package/docs/classes/index.CreatePlayerAccountRequest.html +0 -9
- package/docs/classes/index.CreatePolicyAllowFunctionRequest.html +0 -11
- package/docs/classes/index.CreatePolicyRequest.html +0 -5
- package/docs/classes/index.CreatePolicyRuleRequest.html +0 -13
- package/docs/classes/index.CreateProjectApiKeyRequest.html +0 -1
- package/docs/classes/index.CreateProjectRequest.html +0 -1
- package/docs/classes/index.CreateSessionRequest.html +0 -21
- package/docs/classes/index.CreateTransactionIntentRequest.html +0 -13
- package/docs/classes/index.CreateWeb3ConnectionRequest.html +0 -7
- package/docs/classes/index.DomainData.html +0 -3
- package/docs/classes/index.EntityIdResponse.html +0 -1
- package/docs/classes/index.EstimateTransactionIntentGasResult.html +0 -25
- package/docs/classes/index.FieldErrorsValue.html +0 -1
- package/docs/classes/index.FirebaseOAuthConfig.html +0 -7
- package/docs/classes/index.FixedRateTokenPolicyStrategy.html +0 -1
- package/docs/classes/index.GasPerIntervalLimitPolicyRuleResponse.html +0 -1
- package/docs/classes/index.GasPerTransactionLimitPolicyRuleResponse.html +0 -1
- package/docs/classes/index.GasReport.html +0 -1
- package/docs/classes/index.GasReportDataInner.html +0 -1
- package/docs/classes/index.GasReportDataInnerPeriod.html +0 -1
- package/docs/classes/index.GasReportDataInnerTransactionIntentsInner.html +0 -1
- package/docs/classes/index.GetSigninUrlResponse.html +0 -1
- package/docs/classes/index.GoogleOAuthConfig.html +0 -11
- package/docs/classes/index.Interaction.html +0 -11
- package/docs/classes/index.InvalidRequestError.html +0 -1
- package/docs/classes/index.InvalidRequestErrorResponse.html +0 -1
- package/docs/classes/index.InventoryListResponse.html +0 -1
- package/docs/classes/index.InventoryResponse.html +0 -1
- package/docs/classes/index.Log.html +0 -1
- package/docs/classes/index.LoginRequest.html +0 -5
- package/docs/classes/index.Money.html +0 -3
- package/docs/classes/index.NextActionPayload.html +0 -1
- package/docs/classes/index.NextActionResponse.html +0 -1
- package/docs/classes/index.OAuthConfig.html +0 -15
- package/docs/classes/index.OAuthConfigListResponse.html +0 -5
- package/docs/classes/index.OAuthRequest.html +0 -5
- package/docs/classes/index.ObsoleteAssetInventory.html +0 -3
- package/docs/classes/index.ObsoleteInventoryResponse.html +0 -1
- package/docs/classes/index.PayForUserPolicyStrategy.html +0 -1
- package/docs/classes/index.PaymasterDepositorCreateRequest.html +0 -5
- package/docs/classes/index.PaymasterDepositorDeleteResponse.html +0 -1
- package/docs/classes/index.PaymasterDepositorGetMessageResponse.html +0 -1
- package/docs/classes/index.PaymasterDepositorListResponse.html +0 -1
- package/docs/classes/index.PaymasterDepositorResponse.html +0 -1
- package/docs/classes/index.PickContractResponseId.html +0 -3
- package/docs/classes/index.PickPlayerResponseId.html +0 -3
- package/docs/classes/index.PlayFabOAuthConfig.html +0 -7
- package/docs/classes/index.Player.html +0 -1
- package/docs/classes/index.PlayerCreateRequest.html +0 -5
- package/docs/classes/index.PlayerDeleteResponse.html +0 -1
- package/docs/classes/index.PlayerInventoryQueries.html +0 -3
- package/docs/classes/index.PlayerListQueries.html +0 -9
- package/docs/classes/index.PlayerListResponse.html +0 -1
- package/docs/classes/index.PlayerMetadataValue.html +0 -1
- package/docs/classes/index.PlayerResponse.html +0 -1
- package/docs/classes/index.PlayerResponseAccountsInner.html +0 -3
- package/docs/classes/index.PlayerResponseTransactionIntentsInner.html +0 -7
- package/docs/classes/index.PlayerUpdateRequest.html +0 -5
- package/docs/classes/index.Policy.html +0 -3
- package/docs/classes/index.PolicyDeleteResponse.html +0 -1
- package/docs/classes/index.PolicyListQueries.html +0 -15
- package/docs/classes/index.PolicyListResponse.html +0 -1
- package/docs/classes/index.PolicyResponse.html +0 -3
- package/docs/classes/index.PolicyResponsePolicyRulesInner.html +0 -1
- package/docs/classes/index.PolicyRuleDeleteResponse.html +0 -1
- package/docs/classes/index.PolicyRuleListQueries.html +0 -9
- package/docs/classes/index.PolicyRuleListResponse.html +0 -1
- package/docs/classes/index.PolicyRuleResponse.html +0 -1
- package/docs/classes/index.PolicyStrategy.html +0 -1
- package/docs/classes/index.PolicyStrategyRequest.html +0 -7
- package/docs/classes/index.PrismaInputJsonValue.html +0 -3
- package/docs/classes/index.ProjectListResponse.html +0 -1
- package/docs/classes/index.ProjectLogs.html +0 -1
- package/docs/classes/index.ProjectResponse.html +0 -1
- package/docs/classes/index.ProjectWebhookRequest.html +0 -1
- package/docs/classes/index.ResponseResponse.html +0 -19
- package/docs/classes/index.RevokeSessionPlayerRequest.html +0 -9
- package/docs/classes/index.RevokeSessionRequest.html +0 -11
- package/docs/classes/index.SessionListQueries.html +0 -9
- package/docs/classes/index.SessionListResponse.html +0 -1
- package/docs/classes/index.SessionResponse.html +0 -1
- package/docs/classes/index.SettingsWebhookUpdateRequest.html +0 -3
- package/docs/classes/index.SignPayloadResponse.html +0 -1
- package/docs/classes/index.SignatureRequest.html +0 -5
- package/docs/classes/index.SignupRequest.html +0 -9
- package/docs/classes/index.SubmitWeb3ActionRequest.html +0 -5
- package/docs/classes/index.TransactionIntent.html +0 -7
- package/docs/classes/index.TransactionIntentListQueries.html +0 -15
- package/docs/classes/index.TransactionIntentListResponse.html +0 -1
- package/docs/classes/index.TransactionIntentResponse.html +0 -7
- package/docs/classes/index.TransactionIntentResponseAccount.html +0 -5
- package/docs/classes/index.TransactionIntentResponsePlayer.html +0 -3
- package/docs/classes/index.TransactionIntentResponsePolicy.html +0 -5
- package/docs/classes/index.TypedDataField.html +0 -1
- package/docs/classes/index.UpdateProjectApiKeyRequest.html +0 -1
- package/docs/classes/index.UserProjectCreateRequest.html +0 -1
- package/docs/classes/index.UserProjectCreateRequestRole.html +0 -1
- package/docs/classes/index.UserProjectDeleteResponse.html +0 -1
- package/docs/classes/index.UserProjectListResponse.html +0 -1
- package/docs/classes/index.UserProjectResponse.html +0 -1
- package/docs/classes/index.UserProjectUpdateRequest.html +0 -1
- package/docs/classes/index.Web3ActionListResponse.html +0 -1
- package/docs/classes/index.Web3ActionResponse.html +0 -3
- package/docs/classes/index.Web3ConnectionListQueries.html +0 -9
- package/docs/classes/index.Web3ConnectionListResponse.html +0 -1
- package/docs/classes/index.Web3ConnectionResponse.html +0 -1
- package/docs/classes/index.Web3ConnectionResponsePlayer.html +0 -3
- package/docs/classes/index.WebhookResponse.html +0 -1
- package/docs/classes/index.default.html +0 -1
- package/docs/classes/models_validationError.ValidationError.html +0 -6
- package/docs/classes/utilities_middleware.Middleware.html +0 -7
- package/docs/classes/utilities_observer.ValidationErrorMessage.html +0 -6
- package/docs/enums/generated.HttpMethod.html +0 -3
- package/docs/enums/models_webHookEvent.WebhookEventType.html +0 -1
- package/docs/index.html +0 -49
- package/docs/interfaces/generated.HttpLibrary.html +0 -1
- package/docs/interfaces/generated.PromiseHttpLibrary.html +0 -1
- package/docs/interfaces/generated.ResponseBody.html +0 -1
- package/docs/interfaces/generated.SecurityAuthentication.html +0 -6
- package/docs/interfaces/generated.TokenProvider.html +0 -1
- package/docs/interfaces/generated_configuration.Configuration.html +0 -1
- package/docs/interfaces/generated_configuration.ConfigurationParameters.html +0 -26
- package/docs/interfaces/generated_middleware.Middleware.html +0 -15
- package/docs/interfaces/generated_middleware.PromiseMiddleware.html +0 -15
- package/docs/interfaces/generated_servers.BaseServerConfiguration.html +0 -1
- package/docs/interfaces/models_accountInventoryListQueries.AccountInventoryListQueries.html +0 -5
- package/docs/interfaces/models_baseListRequest.BaseExpandableListRequest.html +0 -1
- package/docs/interfaces/models_baseListRequest.BaseListRequest.html +0 -1
- package/docs/interfaces/models_cancelTransferOwnershipRequest.CancelTransferOwnershipRequest.html +0 -3
- package/docs/interfaces/models_completeRecoveryRequest.CompleteRecoveryRequest.html +0 -7
- package/docs/interfaces/models_createPlayerSessionRequest.CreatePlayerSessionRequest.html +0 -19
- package/docs/interfaces/models_getAccountInventoryRequest.GetAccountInventoryRequest.html +0 -1
- package/docs/interfaces/models_getAccountRequest.GetAccountRequest.html +0 -1
- package/docs/interfaces/models_getAllowFunctionsRequest.GetAllowFunctionsRequest.html +0 -1
- package/docs/interfaces/models_getContractRequest.GetContractRequest.html +0 -1
- package/docs/interfaces/models_getPlayerByExternalIdRequest.GetPlayerByExternalIdRequest.html +0 -1
- package/docs/interfaces/models_getPlayerInventoryRequest.GetPlayerInventoryRequest.html +0 -1
- package/docs/interfaces/models_getPlayerRequest.GetPlayerRequest.html +0 -1
- package/docs/interfaces/models_getPolicyRequest.GetPolicyRequest.html +0 -1
- package/docs/interfaces/models_getPolicyTotalGasUsageRequest.GetPolicyTotalGasUsageRequest.html +0 -1
- package/docs/interfaces/models_getSessionRequest.GetSessionRequest.html +0 -1
- package/docs/interfaces/models_getTransactionIntentRequest.GetTransactionIntentRequest.html +0 -1
- package/docs/interfaces/models_getWeb3ActionsList.GetWeb3ActionsList.html +0 -1
- package/docs/interfaces/models_getWeb3ConnectionRequest.GetWeb3ConnectionRequest.html +0 -1
- package/docs/interfaces/models_playerCancelTransferOwnershipRequest.PlayerCancelTransferOwnershipRequest.html +0 -5
- package/docs/interfaces/models_playerInventoryListQueries.PlayerInventoryListQueries.html +0 -9
- package/docs/interfaces/models_playerTransferOwnershipRequest.PlayerTransferOwnershipRequest.html +0 -9
- package/docs/interfaces/models_revokePlayerSessionRequest.RevokePlayerSessionRequest.html +0 -9
- package/docs/interfaces/models_signPayloadRequest.SignPayloadRequest.html +0 -3
- package/docs/interfaces/models_signatureSessionRequest.SignatureSessionRequest.html +0 -1
- package/docs/interfaces/models_signatureTransactionIntentRequest.SignatureTransactionIntentRequest.html +0 -1
- package/docs/interfaces/models_startRecoveryRequest.StartRecoveryRequest.html +0 -5
- package/docs/interfaces/models_submitWeb3ActionRequest.CreateSubmitWeb3ActionRequest.html +0 -1
- package/docs/interfaces/models_transferOwnershipRequest.TransferOwnershipRequest.html +0 -5
- package/docs/interfaces/models_updateContractRequest.UpdateContractRequest.html +0 -13
- package/docs/interfaces/models_updatePlayerRequest.UpdatePlayerRequest.html +0 -5
- package/docs/interfaces/models_updatePolicyAllowFunctionRequest.UpdatePolicyAllowFunctionRequest.html +0 -11
- package/docs/interfaces/models_updatePolicyRequest.UpdatePolicyRequest.html +0 -7
- package/docs/interfaces/models_updatePolicyRuleRequest.UpdatePolicyRuleRequest.html +0 -11
- package/docs/interfaces/models_updateProjectRequest.UpdateProjectRequest.html +0 -1
- package/docs/interfaces/models_verifyOAuthTokenRequest.VerifyOAuthTokenRequest.html +0 -3
- package/docs/interfaces/models_webHookEvent.WebHookEvent.html +0 -1
- package/docs/interfaces/utilities_observable.Observable.html +0 -1
- package/docs/interfaces/utilities_observer.ErrorMessage.html +0 -1
- package/docs/interfaces/utilities_observer.Observer.html +0 -11
- package/docs/modules/apis_baseApiWrapper.html +0 -1
- package/docs/modules/apis_contractsApiWrapper.html +0 -1
- package/docs/modules/apis_iamApiWrapper.html +0 -1
- package/docs/modules/apis_inventoriesApiWrapper.html +0 -1
- package/docs/modules/apis_oauthApiWrapper.html +0 -1
- package/docs/modules/apis_playersApiWrapper.html +0 -1
- package/docs/modules/apis_policiesApiWrapper.html +0 -1
- package/docs/modules/apis_policyRulesApiWrapper.html +0 -1
- package/docs/modules/apis_sessionsApiWrapper.html +0 -1
- package/docs/modules/apis_settingsApiWrapper.html +0 -1
- package/docs/modules/apis_transactionIntentsApiWrapper.html +0 -1
- package/docs/modules/apis_web3ConnectionsApiWrapper.html +0 -1
- package/docs/modules/generated.html +0 -7
- package/docs/modules/generated_configuration.html +0 -15
- package/docs/modules/generated_middleware.html +0 -1
- package/docs/modules/generated_rxjsStub.html +0 -1
- package/docs/modules/generated_servers.html +0 -1
- package/docs/modules/generated_util.html +0 -11
- package/docs/modules/index.html +0 -5
- package/docs/modules/models.html +0 -1
- package/docs/modules/models_accountInventoryListQueries.html +0 -1
- package/docs/modules/models_baseListRequest.html +0 -1
- package/docs/modules/models_cancelTransferOwnershipRequest.html +0 -1
- package/docs/modules/models_completeRecoveryRequest.html +0 -1
- package/docs/modules/models_createPlayerSessionRequest.html +0 -1
- package/docs/modules/models_getAccountInventoryRequest.html +0 -1
- package/docs/modules/models_getAccountRequest.html +0 -1
- package/docs/modules/models_getAllowFunctionsRequest.html +0 -1
- package/docs/modules/models_getContractRequest.html +0 -1
- package/docs/modules/models_getPlayerByExternalIdRequest.html +0 -1
- package/docs/modules/models_getPlayerInventoryRequest.html +0 -1
- package/docs/modules/models_getPlayerRequest.html +0 -1
- package/docs/modules/models_getPolicyRequest.html +0 -1
- package/docs/modules/models_getPolicyTotalGasUsageRequest.html +0 -1
- package/docs/modules/models_getSessionRequest.html +0 -1
- package/docs/modules/models_getTransactionIntentRequest.html +0 -1
- package/docs/modules/models_getWeb3ActionsList.html +0 -1
- package/docs/modules/models_getWeb3ConnectionRequest.html +0 -1
- package/docs/modules/models_playerCancelTransferOwnershipRequest.html +0 -1
- package/docs/modules/models_playerInventoryListQueries.html +0 -1
- package/docs/modules/models_playerTransferOwnershipRequest.html +0 -1
- package/docs/modules/models_revokePlayerSessionRequest.html +0 -1
- package/docs/modules/models_signPayloadRequest.html +0 -1
- package/docs/modules/models_signatureSessionRequest.html +0 -1
- package/docs/modules/models_signatureTransactionIntentRequest.html +0 -1
- package/docs/modules/models_startRecoveryRequest.html +0 -1
- package/docs/modules/models_submitWeb3ActionRequest.html +0 -1
- package/docs/modules/models_transferOwnershipRequest.html +0 -1
- package/docs/modules/models_updateContractRequest.html +0 -1
- package/docs/modules/models_updatePlayerRequest.html +0 -1
- package/docs/modules/models_updatePolicyAllowFunctionRequest.html +0 -1
- package/docs/modules/models_updatePolicyRequest.html +0 -1
- package/docs/modules/models_updatePolicyRuleRequest.html +0 -1
- package/docs/modules/models_updateProjectRequest.html +0 -1
- package/docs/modules/models_validationError.html +0 -1
- package/docs/modules/models_verifyOAuthTokenRequest.html +0 -1
- package/docs/modules/models_webHookEvent.html +0 -1
- package/docs/modules/utilities_httpErrorHandler.html +0 -1
- package/docs/modules/utilities_middleware.html +0 -1
- package/docs/modules/utilities_observable.html +0 -1
- package/docs/modules/utilities_observer.html +0 -1
- package/docs/modules.html +0 -1
- package/docs/spec.json +0 -105863
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>PlayersAuthenticationApi | @openfort/openfort-node</title><meta name="description" content="Documentation for @openfort/openfort-node"/><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 async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@openfort/openfort-node</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@openfort/openfort-node</a></li><li><a href="../modules/generated.html">generated</a></li><li><a href="generated.PlayersAuthenticationApi.html">PlayersAuthenticationApi</a></li></ul><h1>Class PlayersAuthenticationApi </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">PlayersAuthenticationApi</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="generated.PlayersAuthenticationApi.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section tsd-is-private tsd-is-private-protected"><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="generated.PlayersAuthenticationApi.html#api" class="tsd-kind-icon">api</a></li></ul></section><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.PlayersAuthenticationApi.html#getAuthenticatedPlayers" class="tsd-kind-icon">get<wbr/>Authenticated<wbr/>Players</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link">constructor<a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">new <wbr/>Players<wbr/>Authentication<wbr/>Api<span class="tsd-signature-symbol">(</span>configuration<span class="tsd-signature-symbol">: </span><a href="../interfaces/generated_configuration.Configuration.html" class="tsd-signature-type" data-tsd-kind="Interface">Configuration</a>, requestFactory<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">PlayersAuthenticationApiRequestFactory</span>, responseProcessor<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">PlayersAuthenticationApiResponseProcessor</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="generated.PlayersAuthenticationApi.html" class="tsd-signature-type" data-tsd-kind="Class">PlayersAuthenticationApi</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/openfort-xyz/openfort-node/blob/28cae6f/src/generated/types/PromiseAPI.ts#L840">src/generated/types/PromiseAPI.ts:840</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>configuration: <a href="../interfaces/generated_configuration.Configuration.html" class="tsd-signature-type" data-tsd-kind="Interface">Configuration</a></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> requestFactory: <span class="tsd-signature-type">PlayersAuthenticationApiRequestFactory</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> responseProcessor: <span class="tsd-signature-type">PlayersAuthenticationApiResponseProcessor</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="generated.PlayersAuthenticationApi.html" class="tsd-signature-type" data-tsd-kind="Class">PlayersAuthenticationApi</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group tsd-is-private tsd-is-private-protected"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="api" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagPrivate">Private</span> api<a href="#api" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">api<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ObservablePlayersAuthenticationApi</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/openfort-xyz/openfort-node/blob/28cae6f/src/generated/types/PromiseAPI.ts#L838">src/generated/types/PromiseAPI.ts:838</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getAuthenticatedPlayers" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Authenticated<wbr/>Players<a href="#getAuthenticatedPlayers" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Authenticated<wbr/>Players<span class="tsd-signature-symbol">(</span>limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, skip<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, order<span class="tsd-signature-symbol">?: </span><a href="../modules/index.html#SortOrder" class="tsd-signature-type" data-tsd-kind="Type alias">SortOrder</a>, email<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, _options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/generated_configuration.Configuration.html" class="tsd-signature-type" data-tsd-kind="Interface">Configuration</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="index.AuthPlayerListResponse.html" class="tsd-signature-type" data-tsd-kind="Class">AuthPlayerListResponse</a><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/openfort-xyz/openfort-node/blob/28cae6f/src/generated/types/PromiseAPI.ts#L855">src/generated/types/PromiseAPI.ts:855</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
2
|
-
<p>List authenticated players.</p>
|
|
3
|
-
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> limit: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
4
|
-
<p>Specifies the maximum number of records to return.</p>
|
|
5
|
-
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> skip: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
6
|
-
<p>Specifies the offset for the first records to return.</p>
|
|
7
|
-
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> order: <a href="../modules/index.html#SortOrder" class="tsd-signature-type" data-tsd-kind="Type alias">SortOrder</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
8
|
-
<p>Specifies the order in which to sort the results.</p>
|
|
9
|
-
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> email: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
10
|
-
<p>Specifies the email address of the user.</p>
|
|
11
|
-
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> _options: <a href="../interfaces/generated_configuration.Configuration.html" class="tsd-signature-type" data-tsd-kind="Interface">Configuration</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="index.AuthPlayerListResponse.html" class="tsd-signature-type" data-tsd-kind="Class">AuthPlayerListResponse</a><span class="tsd-signature-symbol">></span></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Modules</a></li><li class=" tsd-kind-module"><a href="../modules/apis_baseApiWrapper.html">apis/base<wbr/>Api<wbr/>Wrapper</a></li><li class=" tsd-kind-module"><a href="../modules/apis_contractsApiWrapper.html">apis/contracts<wbr/>Api<wbr/>Wrapper</a></li><li class=" tsd-kind-module"><a href="../modules/apis_iamApiWrapper.html">apis/iam<wbr/>Api<wbr/>Wrapper</a></li><li class=" tsd-kind-module"><a href="../modules/apis_inventoriesApiWrapper.html">apis/inventories<wbr/>Api<wbr/>Wrapper</a></li><li class=" tsd-kind-module"><a href="../modules/apis_oauthApiWrapper.html">apis/oauth<wbr/>Api<wbr/>Wrapper</a></li><li class=" tsd-kind-module"><a href="../modules/apis_playersApiWrapper.html">apis/players<wbr/>Api<wbr/>Wrapper</a></li><li class=" tsd-kind-module"><a href="../modules/apis_policiesApiWrapper.html">apis/policies<wbr/>Api<wbr/>Wrapper</a></li><li class=" tsd-kind-module"><a href="../modules/apis_policyRulesApiWrapper.html">apis/policy<wbr/>Rules<wbr/>Api<wbr/>Wrapper</a></li><li class=" tsd-kind-module"><a href="../modules/apis_sessionsApiWrapper.html">apis/sessions<wbr/>Api<wbr/>Wrapper</a></li><li class=" tsd-kind-module"><a href="../modules/apis_settingsApiWrapper.html">apis/settings<wbr/>Api<wbr/>Wrapper</a></li><li class=" tsd-kind-module"><a href="../modules/apis_transactionIntentsApiWrapper.html">apis/transaction<wbr/>Intents<wbr/>Api<wbr/>Wrapper</a></li><li class=" tsd-kind-module"><a href="../modules/apis_web3ConnectionsApiWrapper.html">apis/web3<wbr/>Connections<wbr/>Api<wbr/>Wrapper</a></li><li class="current tsd-kind-module"><a href="../modules/generated.html">generated</a></li><li class=" tsd-kind-module"><a href="../modules/generated_configuration.html">generated/configuration</a></li><li class=" tsd-kind-module"><a href="../modules/generated_middleware.html">generated/middleware</a></li><li class=" tsd-kind-module"><a href="../modules/generated_rxjsStub.html">generated/rxjs<wbr/>Stub</a></li><li class=" tsd-kind-module"><a href="../modules/generated_servers.html">generated/servers</a></li><li class=" tsd-kind-module"><a href="../modules/generated_util.html">generated/util</a></li><li class=" tsd-kind-module"><a href="../modules/index.html">index</a></li><li class=" tsd-kind-module"><a href="../modules/models.html">models</a></li><li class=" tsd-kind-module"><a href="../modules/models_accountInventoryListQueries.html">models/account<wbr/>Inventory<wbr/>List<wbr/>Queries</a></li><li class=" tsd-kind-module"><a href="../modules/models_baseListRequest.html">models/base<wbr/>List<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_cancelTransferOwnershipRequest.html">models/cancel<wbr/>Transfer<wbr/>Ownership<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_completeRecoveryRequest.html">models/complete<wbr/>Recovery<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_createPlayerSessionRequest.html">models/create<wbr/>Player<wbr/>Session<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_getAccountInventoryRequest.html">models/get<wbr/>Account<wbr/>Inventory<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_getAccountRequest.html">models/get<wbr/>Account<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_getAllowFunctionsRequest.html">models/get<wbr/>Allow<wbr/>Functions<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_getContractRequest.html">models/get<wbr/>Contract<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_getPlayerByExternalIdRequest.html">models/get<wbr/>Player<wbr/>By<wbr/>External<wbr/>Id<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_getPlayerInventoryRequest.html">models/get<wbr/>Player<wbr/>Inventory<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_getPlayerRequest.html">models/get<wbr/>Player<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_getPolicyRequest.html">models/get<wbr/>Policy<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_getPolicyTotalGasUsageRequest.html">models/get<wbr/>Policy<wbr/>Total<wbr/>Gas<wbr/>Usage<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_getSessionRequest.html">models/get<wbr/>Session<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_getTransactionIntentRequest.html">models/get<wbr/>Transaction<wbr/>Intent<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_getWeb3ActionsList.html">models/get<wbr/>Web3<wbr/>Actions<wbr/>List</a></li><li class=" tsd-kind-module"><a href="../modules/models_getWeb3ConnectionRequest.html">models/get<wbr/>Web3<wbr/>Connection<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_playerCancelTransferOwnershipRequest.html">models/player<wbr/>Cancel<wbr/>Transfer<wbr/>Ownership<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_playerInventoryListQueries.html">models/player<wbr/>Inventory<wbr/>List<wbr/>Queries</a></li><li class=" tsd-kind-module"><a href="../modules/models_playerTransferOwnershipRequest.html">models/player<wbr/>Transfer<wbr/>Ownership<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_revokePlayerSessionRequest.html">models/revoke<wbr/>Player<wbr/>Session<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_signPayloadRequest.html">models/sign<wbr/>Payload<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_signatureSessionRequest.html">models/signature<wbr/>Session<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_signatureTransactionIntentRequest.html">models/signature<wbr/>Transaction<wbr/>Intent<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_startRecoveryRequest.html">models/start<wbr/>Recovery<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_submitWeb3ActionRequest.html">models/submit<wbr/>Web3<wbr/>Action<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_transferOwnershipRequest.html">models/transfer<wbr/>Ownership<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_updateContractRequest.html">models/update<wbr/>Contract<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_updatePlayerRequest.html">models/update<wbr/>Player<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_updatePolicyAllowFunctionRequest.html">models/update<wbr/>Policy<wbr/>Allow<wbr/>Function<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_updatePolicyRequest.html">models/update<wbr/>Policy<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_updatePolicyRuleRequest.html">models/update<wbr/>Policy<wbr/>Rule<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_updateProjectRequest.html">models/update<wbr/>Project<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_validationError.html">models/validation<wbr/>Error</a></li><li class=" tsd-kind-module"><a href="../modules/models_verifyOAuthTokenRequest.html">models/verifyOAuth<wbr/>Token<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_webHookEvent.html">models/web<wbr/>Hook<wbr/>Event</a></li><li class=" tsd-kind-module"><a href="../modules/utilities_httpErrorHandler.html">utilities/http<wbr/>Error<wbr/>Handler</a></li><li class=" tsd-kind-module"><a href="../modules/utilities_middleware.html">utilities/middleware</a></li><li class=" tsd-kind-module"><a href="../modules/utilities_observable.html">utilities/observable</a></li><li class=" tsd-kind-module"><a href="../modules/utilities_observer.html">utilities/observer</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class tsd-parent-kind-module"><a href="generated.PlayersAuthenticationApi.html" class="tsd-kind-icon">Players<wbr/>Authentication<wbr/>Api</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="generated.PlayersAuthenticationApi.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="generated.PlayersAuthenticationApi.html#api" class="tsd-kind-icon">api</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.PlayersAuthenticationApi.html#getAuthenticatedPlayers" class="tsd-kind-icon">get<wbr/>Authenticated<wbr/>Players</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li><li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li><li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li><li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li><li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li><li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
|
|
@@ -1,63 +0,0 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>PoliciesApi | @openfort/openfort-node</title><meta name="description" content="Documentation for @openfort/openfort-node"/><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 async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@openfort/openfort-node</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@openfort/openfort-node</a></li><li><a href="../modules/generated.html">generated</a></li><li><a href="generated.PoliciesApi.html">PoliciesApi</a></li></ul><h1>Class PoliciesApi </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">PoliciesApi</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="generated.PoliciesApi.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section tsd-is-private tsd-is-private-protected"><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="generated.PoliciesApi.html#api" class="tsd-kind-icon">api</a></li></ul></section><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.PoliciesApi.html#createPolicy" class="tsd-kind-icon">create<wbr/>Policy</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.PoliciesApi.html#createPolicyAllowFunction" class="tsd-kind-icon">create<wbr/>Policy<wbr/>Allow<wbr/>Function</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.PoliciesApi.html#deletePolicy" class="tsd-kind-icon">delete<wbr/>Policy</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.PoliciesApi.html#disablePolicy" class="tsd-kind-icon">disable<wbr/>Policy</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.PoliciesApi.html#enablePolicy" class="tsd-kind-icon">enable<wbr/>Policy</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.PoliciesApi.html#getPolicies" class="tsd-kind-icon">get<wbr/>Policies</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.PoliciesApi.html#getPolicy" class="tsd-kind-icon">get<wbr/>Policy</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.PoliciesApi.html#getPolicyAllowFunctions" class="tsd-kind-icon">get<wbr/>Policy<wbr/>Allow<wbr/>Functions</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.PoliciesApi.html#getPolicyTotalGasUsage" class="tsd-kind-icon">get<wbr/>Policy<wbr/>Total<wbr/>Gas<wbr/>Usage</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.PoliciesApi.html#updatePolicy" class="tsd-kind-icon">update<wbr/>Policy</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.PoliciesApi.html#updatePolicyAllowFunction" class="tsd-kind-icon">update<wbr/>Policy<wbr/>Allow<wbr/>Function</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link">constructor<a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">new <wbr/>Policies<wbr/>Api<span class="tsd-signature-symbol">(</span>configuration<span class="tsd-signature-symbol">: </span><a href="../interfaces/generated_configuration.Configuration.html" class="tsd-signature-type" data-tsd-kind="Interface">Configuration</a>, requestFactory<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">PoliciesApiRequestFactory</span>, responseProcessor<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">PoliciesApiResponseProcessor</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="generated.PoliciesApi.html" class="tsd-signature-type" data-tsd-kind="Class">PoliciesApi</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/openfort-xyz/openfort-node/blob/28cae6f/src/generated/types/PromiseAPI.ts#L871">src/generated/types/PromiseAPI.ts:871</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>configuration: <a href="../interfaces/generated_configuration.Configuration.html" class="tsd-signature-type" data-tsd-kind="Interface">Configuration</a></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> requestFactory: <span class="tsd-signature-type">PoliciesApiRequestFactory</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> responseProcessor: <span class="tsd-signature-type">PoliciesApiResponseProcessor</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="generated.PoliciesApi.html" class="tsd-signature-type" data-tsd-kind="Class">PoliciesApi</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group tsd-is-private tsd-is-private-protected"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="api" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagPrivate">Private</span> api<a href="#api" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">api<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ObservablePoliciesApi</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/openfort-xyz/openfort-node/blob/28cae6f/src/generated/types/PromiseAPI.ts#L869">src/generated/types/PromiseAPI.ts:869</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="createPolicy" class="tsd-anchor"></a><h3 class="tsd-anchor-link">create<wbr/>Policy<a href="#createPolicy" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">create<wbr/>Policy<span class="tsd-signature-symbol">(</span>createPolicyRequest<span class="tsd-signature-symbol">: </span><a href="index.CreatePolicyRequest.html" class="tsd-signature-type" data-tsd-kind="Class">CreatePolicyRequest</a>, _options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/generated_configuration.Configuration.html" class="tsd-signature-type" data-tsd-kind="Interface">Configuration</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="index.PolicyResponse.html" class="tsd-signature-type" data-tsd-kind="Class">PolicyResponse</a><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/openfort-xyz/openfort-node/blob/28cae6f/src/generated/types/PromiseAPI.ts#L883">src/generated/types/PromiseAPI.ts:883</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
2
|
-
<p>Create a policy object.</p>
|
|
3
|
-
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>createPolicyRequest: <a href="index.CreatePolicyRequest.html" class="tsd-signature-type" data-tsd-kind="Class">CreatePolicyRequest</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
4
|
-
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> _options: <a href="../interfaces/generated_configuration.Configuration.html" class="tsd-signature-type" data-tsd-kind="Interface">Configuration</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="index.PolicyResponse.html" class="tsd-signature-type" data-tsd-kind="Class">PolicyResponse</a><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="createPolicyAllowFunction" class="tsd-anchor"></a><h3 class="tsd-anchor-link">create<wbr/>Policy<wbr/>Allow<wbr/>Function<a href="#createPolicyAllowFunction" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">create<wbr/>Policy<wbr/>Allow<wbr/>Function<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, createPolicyAllowFunctionRequest<span class="tsd-signature-symbol">: </span><a href="index.CreatePolicyAllowFunctionRequest.html" class="tsd-signature-type" data-tsd-kind="Class">CreatePolicyAllowFunctionRequest</a>, _options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/generated_configuration.Configuration.html" class="tsd-signature-type" data-tsd-kind="Interface">Configuration</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="index.PolicyRuleResponse.html" class="tsd-signature-type" data-tsd-kind="Class">PolicyRuleResponse</a><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/openfort-xyz/openfort-node/blob/28cae6f/src/generated/types/PromiseAPI.ts#L893">src/generated/types/PromiseAPI.ts:893</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
5
|
-
<p>Create a policy rule object for a policy.</p>
|
|
6
|
-
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>id: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
7
|
-
<p>Specifies the unique policy ID (starts with pol_).</p>
|
|
8
|
-
</div></div></li><li><h5>createPolicyAllowFunctionRequest: <a href="index.CreatePolicyAllowFunctionRequest.html" class="tsd-signature-type" data-tsd-kind="Class">CreatePolicyAllowFunctionRequest</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
9
|
-
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> _options: <a href="../interfaces/generated_configuration.Configuration.html" class="tsd-signature-type" data-tsd-kind="Interface">Configuration</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="index.PolicyRuleResponse.html" class="tsd-signature-type" data-tsd-kind="Class">PolicyRuleResponse</a><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="deletePolicy" class="tsd-anchor"></a><h3 class="tsd-anchor-link">delete<wbr/>Policy<a href="#deletePolicy" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">delete<wbr/>Policy<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, _options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/generated_configuration.Configuration.html" class="tsd-signature-type" data-tsd-kind="Interface">Configuration</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="index.PolicyDeleteResponse.html" class="tsd-signature-type" data-tsd-kind="Class">PolicyDeleteResponse</a><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/openfort-xyz/openfort-node/blob/28cae6f/src/generated/types/PromiseAPI.ts#L902">src/generated/types/PromiseAPI.ts:902</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
10
|
-
<p>Delete a policy object.</p>
|
|
11
|
-
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>id: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
12
|
-
<p>Specifies the unique policy ID (starts with pol_).</p>
|
|
13
|
-
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> _options: <a href="../interfaces/generated_configuration.Configuration.html" class="tsd-signature-type" data-tsd-kind="Interface">Configuration</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="index.PolicyDeleteResponse.html" class="tsd-signature-type" data-tsd-kind="Class">PolicyDeleteResponse</a><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="disablePolicy" class="tsd-anchor"></a><h3 class="tsd-anchor-link">disable<wbr/>Policy<a href="#disablePolicy" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">disable<wbr/>Policy<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, _options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/generated_configuration.Configuration.html" class="tsd-signature-type" data-tsd-kind="Interface">Configuration</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="index.PolicyResponse.html" class="tsd-signature-type" data-tsd-kind="Class">PolicyResponse</a><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/openfort-xyz/openfort-node/blob/28cae6f/src/generated/types/PromiseAPI.ts#L911">src/generated/types/PromiseAPI.ts:911</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
14
|
-
<p>Disable a policy object.</p>
|
|
15
|
-
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>id: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
16
|
-
<p>Specifies the unique policy ID (starts with pol_).</p>
|
|
17
|
-
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> _options: <a href="../interfaces/generated_configuration.Configuration.html" class="tsd-signature-type" data-tsd-kind="Interface">Configuration</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="index.PolicyResponse.html" class="tsd-signature-type" data-tsd-kind="Class">PolicyResponse</a><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="enablePolicy" class="tsd-anchor"></a><h3 class="tsd-anchor-link">enable<wbr/>Policy<a href="#enablePolicy" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">enable<wbr/>Policy<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, _options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/generated_configuration.Configuration.html" class="tsd-signature-type" data-tsd-kind="Interface">Configuration</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="index.PolicyResponse.html" class="tsd-signature-type" data-tsd-kind="Class">PolicyResponse</a><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/openfort-xyz/openfort-node/blob/28cae6f/src/generated/types/PromiseAPI.ts#L920">src/generated/types/PromiseAPI.ts:920</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
18
|
-
<p>Enable a policy object.</p>
|
|
19
|
-
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>id: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
20
|
-
<p>Specifies the unique policy ID (starts with pol_).</p>
|
|
21
|
-
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> _options: <a href="../interfaces/generated_configuration.Configuration.html" class="tsd-signature-type" data-tsd-kind="Interface">Configuration</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="index.PolicyResponse.html" class="tsd-signature-type" data-tsd-kind="Class">PolicyResponse</a><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getPolicies" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Policies<a href="#getPolicies" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Policies<span class="tsd-signature-symbol">(</span>limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, skip<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, order<span class="tsd-signature-symbol">?: </span><a href="../modules/index.html#SortOrder" class="tsd-signature-type" data-tsd-kind="Type alias">SortOrder</a>, expand<span class="tsd-signature-symbol">?: </span><a href="../modules/index.html#PolicyResponseExpandable" class="tsd-signature-type" data-tsd-kind="Type alias">PolicyResponseExpandable</a><span class="tsd-signature-symbol">[]</span>, name<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, deleted<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span>, chainId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, enabled<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span>, _options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/generated_configuration.Configuration.html" class="tsd-signature-type" data-tsd-kind="Interface">Configuration</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="index.PolicyListResponse.html" class="tsd-signature-type" data-tsd-kind="Class">PolicyListResponse</a><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/openfort-xyz/openfort-node/blob/28cae6f/src/generated/types/PromiseAPI.ts#L936">src/generated/types/PromiseAPI.ts:936</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
22
|
-
<p>List policies.</p>
|
|
23
|
-
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> limit: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
24
|
-
<p>Specifies the maximum number of records to return.</p>
|
|
25
|
-
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> skip: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
26
|
-
<p>Specifies the offset for the first records to return.</p>
|
|
27
|
-
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> order: <a href="../modules/index.html#SortOrder" class="tsd-signature-type" data-tsd-kind="Type alias">SortOrder</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
28
|
-
<p>Specifies the order in which to sort the results.</p>
|
|
29
|
-
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> expand: <a href="../modules/index.html#PolicyResponseExpandable" class="tsd-signature-type" data-tsd-kind="Type alias">PolicyResponseExpandable</a><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
30
|
-
<p>Specifies the fields to expand in the response.</p>
|
|
31
|
-
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> name: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
32
|
-
<p>Specifies the name of the policy.</p>
|
|
33
|
-
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> deleted: <span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
34
|
-
<p>Specifies whether to include deleted contracts.</p>
|
|
35
|
-
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> chainId: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
36
|
-
<p>The chain ID of the policy.</p>
|
|
37
|
-
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> enabled: <span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
38
|
-
<p>Specifies whether to include enabled contracts.</p>
|
|
39
|
-
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> _options: <a href="../interfaces/generated_configuration.Configuration.html" class="tsd-signature-type" data-tsd-kind="Interface">Configuration</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="index.PolicyListResponse.html" class="tsd-signature-type" data-tsd-kind="Class">PolicyListResponse</a><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getPolicy" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Policy<a href="#getPolicy" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Policy<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, expand<span class="tsd-signature-symbol">?: </span><a href="../modules/index.html#PolicyResponseExpandable" class="tsd-signature-type" data-tsd-kind="Type alias">PolicyResponseExpandable</a><span class="tsd-signature-symbol">[]</span>, _options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/generated_configuration.Configuration.html" class="tsd-signature-type" data-tsd-kind="Interface">Configuration</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="index.PolicyResponse.html" class="tsd-signature-type" data-tsd-kind="Class">PolicyResponse</a><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/openfort-xyz/openfort-node/blob/28cae6f/src/generated/types/PromiseAPI.ts#L946">src/generated/types/PromiseAPI.ts:946</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
40
|
-
<p>Get a policy object.</p>
|
|
41
|
-
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>id: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
42
|
-
<p>Specifies the unique policy ID (starts with pol_).</p>
|
|
43
|
-
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> expand: <a href="../modules/index.html#PolicyResponseExpandable" class="tsd-signature-type" data-tsd-kind="Type alias">PolicyResponseExpandable</a><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
44
|
-
<p>Specifies the fields to expand.</p>
|
|
45
|
-
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> _options: <a href="../interfaces/generated_configuration.Configuration.html" class="tsd-signature-type" data-tsd-kind="Interface">Configuration</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="index.PolicyResponse.html" class="tsd-signature-type" data-tsd-kind="Class">PolicyResponse</a><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getPolicyAllowFunctions" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Policy<wbr/>Allow<wbr/>Functions<a href="#getPolicyAllowFunctions" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Policy<wbr/>Allow<wbr/>Functions<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, expand<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">"contract"</span><span class="tsd-signature-symbol">[]</span>, _options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/generated_configuration.Configuration.html" class="tsd-signature-type" data-tsd-kind="Interface">Configuration</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="index.PolicyRuleListResponse.html" class="tsd-signature-type" data-tsd-kind="Class">PolicyRuleListResponse</a><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/openfort-xyz/openfort-node/blob/28cae6f/src/generated/types/PromiseAPI.ts#L956">src/generated/types/PromiseAPI.ts:956</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
46
|
-
<p>List policy rules of a policy.</p>
|
|
47
|
-
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>id: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
48
|
-
<p>Specifies the unique policy ID (starts with pol_).</p>
|
|
49
|
-
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> expand: <span class="tsd-signature-type">"contract"</span><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
50
|
-
<p>Specifies the fields to expand.</p>
|
|
51
|
-
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> _options: <a href="../interfaces/generated_configuration.Configuration.html" class="tsd-signature-type" data-tsd-kind="Interface">Configuration</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="index.PolicyRuleListResponse.html" class="tsd-signature-type" data-tsd-kind="Class">PolicyRuleListResponse</a><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getPolicyTotalGasUsage" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Policy<wbr/>Total<wbr/>Gas<wbr/>Usage<a href="#getPolicyTotalGasUsage" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Policy<wbr/>Total<wbr/>Gas<wbr/>Usage<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, _options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/generated_configuration.Configuration.html" class="tsd-signature-type" data-tsd-kind="Interface">Configuration</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="index.GasReport.html" class="tsd-signature-type" data-tsd-kind="Class">GasReport</a><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/openfort-xyz/openfort-node/blob/28cae6f/src/generated/types/PromiseAPI.ts#L965">src/generated/types/PromiseAPI.ts:965</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
52
|
-
<p>List all gas reports of a policy.</p>
|
|
53
|
-
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>id: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
54
|
-
<p>Specifies the unique policy ID (starts with pol_).</p>
|
|
55
|
-
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> _options: <a href="../interfaces/generated_configuration.Configuration.html" class="tsd-signature-type" data-tsd-kind="Interface">Configuration</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="index.GasReport.html" class="tsd-signature-type" data-tsd-kind="Class">GasReport</a><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="updatePolicy" class="tsd-anchor"></a><h3 class="tsd-anchor-link">update<wbr/>Policy<a href="#updatePolicy" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">update<wbr/>Policy<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, updatePolicyRequest<span class="tsd-signature-symbol">: </span><a href="generated.UpdatePolicyRequest.html" class="tsd-signature-type" data-tsd-kind="Class">UpdatePolicyRequest</a>, _options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/generated_configuration.Configuration.html" class="tsd-signature-type" data-tsd-kind="Interface">Configuration</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="index.PolicyResponse.html" class="tsd-signature-type" data-tsd-kind="Class">PolicyResponse</a><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/openfort-xyz/openfort-node/blob/28cae6f/src/generated/types/PromiseAPI.ts#L975">src/generated/types/PromiseAPI.ts:975</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
56
|
-
<p>Update a policy object.</p>
|
|
57
|
-
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>id: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
58
|
-
<p>Specifies the unique policy ID (starts with pol_).</p>
|
|
59
|
-
</div></div></li><li><h5>updatePolicyRequest: <a href="generated.UpdatePolicyRequest.html" class="tsd-signature-type" data-tsd-kind="Class">UpdatePolicyRequest</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
60
|
-
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> _options: <a href="../interfaces/generated_configuration.Configuration.html" class="tsd-signature-type" data-tsd-kind="Interface">Configuration</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="index.PolicyResponse.html" class="tsd-signature-type" data-tsd-kind="Class">PolicyResponse</a><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="updatePolicyAllowFunction" class="tsd-anchor"></a><h3 class="tsd-anchor-link">update<wbr/>Policy<wbr/>Allow<wbr/>Function<a href="#updatePolicyAllowFunction" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">update<wbr/>Policy<wbr/>Allow<wbr/>Function<span class="tsd-signature-symbol">(</span>policy<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, policyRule<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, updatePolicyRuleRequest<span class="tsd-signature-symbol">: </span><a href="generated.UpdatePolicyRuleRequest.html" class="tsd-signature-type" data-tsd-kind="Class">UpdatePolicyRuleRequest</a>, _options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/generated_configuration.Configuration.html" class="tsd-signature-type" data-tsd-kind="Interface">Configuration</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="index.PolicyRuleResponse.html" class="tsd-signature-type" data-tsd-kind="Class">PolicyRuleResponse</a><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/openfort-xyz/openfort-node/blob/28cae6f/src/generated/types/PromiseAPI.ts#L986">src/generated/types/PromiseAPI.ts:986</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
61
|
-
<p>Update a policy rule object of a policy.</p>
|
|
62
|
-
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>policy: <span class="tsd-signature-type">string</span></h5></li><li><h5>policyRule: <span class="tsd-signature-type">string</span></h5></li><li><h5>updatePolicyRuleRequest: <a href="generated.UpdatePolicyRuleRequest.html" class="tsd-signature-type" data-tsd-kind="Class">UpdatePolicyRuleRequest</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
63
|
-
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> _options: <a href="../interfaces/generated_configuration.Configuration.html" class="tsd-signature-type" data-tsd-kind="Interface">Configuration</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="index.PolicyRuleResponse.html" class="tsd-signature-type" data-tsd-kind="Class">PolicyRuleResponse</a><span class="tsd-signature-symbol">></span></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Modules</a></li><li class=" tsd-kind-module"><a href="../modules/apis_baseApiWrapper.html">apis/base<wbr/>Api<wbr/>Wrapper</a></li><li class=" tsd-kind-module"><a href="../modules/apis_contractsApiWrapper.html">apis/contracts<wbr/>Api<wbr/>Wrapper</a></li><li class=" tsd-kind-module"><a href="../modules/apis_iamApiWrapper.html">apis/iam<wbr/>Api<wbr/>Wrapper</a></li><li class=" tsd-kind-module"><a href="../modules/apis_inventoriesApiWrapper.html">apis/inventories<wbr/>Api<wbr/>Wrapper</a></li><li class=" tsd-kind-module"><a href="../modules/apis_oauthApiWrapper.html">apis/oauth<wbr/>Api<wbr/>Wrapper</a></li><li class=" tsd-kind-module"><a href="../modules/apis_playersApiWrapper.html">apis/players<wbr/>Api<wbr/>Wrapper</a></li><li class=" tsd-kind-module"><a href="../modules/apis_policiesApiWrapper.html">apis/policies<wbr/>Api<wbr/>Wrapper</a></li><li class=" tsd-kind-module"><a href="../modules/apis_policyRulesApiWrapper.html">apis/policy<wbr/>Rules<wbr/>Api<wbr/>Wrapper</a></li><li class=" tsd-kind-module"><a href="../modules/apis_sessionsApiWrapper.html">apis/sessions<wbr/>Api<wbr/>Wrapper</a></li><li class=" tsd-kind-module"><a href="../modules/apis_settingsApiWrapper.html">apis/settings<wbr/>Api<wbr/>Wrapper</a></li><li class=" tsd-kind-module"><a href="../modules/apis_transactionIntentsApiWrapper.html">apis/transaction<wbr/>Intents<wbr/>Api<wbr/>Wrapper</a></li><li class=" tsd-kind-module"><a href="../modules/apis_web3ConnectionsApiWrapper.html">apis/web3<wbr/>Connections<wbr/>Api<wbr/>Wrapper</a></li><li class="current tsd-kind-module"><a href="../modules/generated.html">generated</a></li><li class=" tsd-kind-module"><a href="../modules/generated_configuration.html">generated/configuration</a></li><li class=" tsd-kind-module"><a href="../modules/generated_middleware.html">generated/middleware</a></li><li class=" tsd-kind-module"><a href="../modules/generated_rxjsStub.html">generated/rxjs<wbr/>Stub</a></li><li class=" tsd-kind-module"><a href="../modules/generated_servers.html">generated/servers</a></li><li class=" tsd-kind-module"><a href="../modules/generated_util.html">generated/util</a></li><li class=" tsd-kind-module"><a href="../modules/index.html">index</a></li><li class=" tsd-kind-module"><a href="../modules/models.html">models</a></li><li class=" tsd-kind-module"><a href="../modules/models_accountInventoryListQueries.html">models/account<wbr/>Inventory<wbr/>List<wbr/>Queries</a></li><li class=" tsd-kind-module"><a href="../modules/models_baseListRequest.html">models/base<wbr/>List<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_cancelTransferOwnershipRequest.html">models/cancel<wbr/>Transfer<wbr/>Ownership<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_completeRecoveryRequest.html">models/complete<wbr/>Recovery<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_createPlayerSessionRequest.html">models/create<wbr/>Player<wbr/>Session<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_getAccountInventoryRequest.html">models/get<wbr/>Account<wbr/>Inventory<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_getAccountRequest.html">models/get<wbr/>Account<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_getAllowFunctionsRequest.html">models/get<wbr/>Allow<wbr/>Functions<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_getContractRequest.html">models/get<wbr/>Contract<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_getPlayerByExternalIdRequest.html">models/get<wbr/>Player<wbr/>By<wbr/>External<wbr/>Id<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_getPlayerInventoryRequest.html">models/get<wbr/>Player<wbr/>Inventory<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_getPlayerRequest.html">models/get<wbr/>Player<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_getPolicyRequest.html">models/get<wbr/>Policy<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_getPolicyTotalGasUsageRequest.html">models/get<wbr/>Policy<wbr/>Total<wbr/>Gas<wbr/>Usage<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_getSessionRequest.html">models/get<wbr/>Session<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_getTransactionIntentRequest.html">models/get<wbr/>Transaction<wbr/>Intent<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_getWeb3ActionsList.html">models/get<wbr/>Web3<wbr/>Actions<wbr/>List</a></li><li class=" tsd-kind-module"><a href="../modules/models_getWeb3ConnectionRequest.html">models/get<wbr/>Web3<wbr/>Connection<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_playerCancelTransferOwnershipRequest.html">models/player<wbr/>Cancel<wbr/>Transfer<wbr/>Ownership<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_playerInventoryListQueries.html">models/player<wbr/>Inventory<wbr/>List<wbr/>Queries</a></li><li class=" tsd-kind-module"><a href="../modules/models_playerTransferOwnershipRequest.html">models/player<wbr/>Transfer<wbr/>Ownership<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_revokePlayerSessionRequest.html">models/revoke<wbr/>Player<wbr/>Session<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_signPayloadRequest.html">models/sign<wbr/>Payload<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_signatureSessionRequest.html">models/signature<wbr/>Session<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_signatureTransactionIntentRequest.html">models/signature<wbr/>Transaction<wbr/>Intent<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_startRecoveryRequest.html">models/start<wbr/>Recovery<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_submitWeb3ActionRequest.html">models/submit<wbr/>Web3<wbr/>Action<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_transferOwnershipRequest.html">models/transfer<wbr/>Ownership<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_updateContractRequest.html">models/update<wbr/>Contract<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_updatePlayerRequest.html">models/update<wbr/>Player<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_updatePolicyAllowFunctionRequest.html">models/update<wbr/>Policy<wbr/>Allow<wbr/>Function<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_updatePolicyRequest.html">models/update<wbr/>Policy<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_updatePolicyRuleRequest.html">models/update<wbr/>Policy<wbr/>Rule<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_updateProjectRequest.html">models/update<wbr/>Project<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_validationError.html">models/validation<wbr/>Error</a></li><li class=" tsd-kind-module"><a href="../modules/models_verifyOAuthTokenRequest.html">models/verifyOAuth<wbr/>Token<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_webHookEvent.html">models/web<wbr/>Hook<wbr/>Event</a></li><li class=" tsd-kind-module"><a href="../modules/utilities_httpErrorHandler.html">utilities/http<wbr/>Error<wbr/>Handler</a></li><li class=" tsd-kind-module"><a href="../modules/utilities_middleware.html">utilities/middleware</a></li><li class=" tsd-kind-module"><a href="../modules/utilities_observable.html">utilities/observable</a></li><li class=" tsd-kind-module"><a href="../modules/utilities_observer.html">utilities/observer</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class tsd-parent-kind-module"><a href="generated.PoliciesApi.html" class="tsd-kind-icon">Policies<wbr/>Api</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="generated.PoliciesApi.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="generated.PoliciesApi.html#api" class="tsd-kind-icon">api</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.PoliciesApi.html#createPolicy" class="tsd-kind-icon">create<wbr/>Policy</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.PoliciesApi.html#createPolicyAllowFunction" class="tsd-kind-icon">create<wbr/>Policy<wbr/>Allow<wbr/>Function</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.PoliciesApi.html#deletePolicy" class="tsd-kind-icon">delete<wbr/>Policy</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.PoliciesApi.html#disablePolicy" class="tsd-kind-icon">disable<wbr/>Policy</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.PoliciesApi.html#enablePolicy" class="tsd-kind-icon">enable<wbr/>Policy</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.PoliciesApi.html#getPolicies" class="tsd-kind-icon">get<wbr/>Policies</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.PoliciesApi.html#getPolicy" class="tsd-kind-icon">get<wbr/>Policy</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.PoliciesApi.html#getPolicyAllowFunctions" class="tsd-kind-icon">get<wbr/>Policy<wbr/>Allow<wbr/>Functions</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.PoliciesApi.html#getPolicyTotalGasUsage" class="tsd-kind-icon">get<wbr/>Policy<wbr/>Total<wbr/>Gas<wbr/>Usage</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.PoliciesApi.html#updatePolicy" class="tsd-kind-icon">update<wbr/>Policy</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.PoliciesApi.html#updatePolicyAllowFunction" class="tsd-kind-icon">update<wbr/>Policy<wbr/>Allow<wbr/>Function</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li><li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li><li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li><li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li><li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li><li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
|
|
@@ -1,25 +0,0 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>PolicyRulesApi | @openfort/openfort-node</title><meta name="description" content="Documentation for @openfort/openfort-node"/><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 async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@openfort/openfort-node</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@openfort/openfort-node</a></li><li><a href="../modules/generated.html">generated</a></li><li><a href="generated.PolicyRulesApi.html">PolicyRulesApi</a></li></ul><h1>Class PolicyRulesApi </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">PolicyRulesApi</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="generated.PolicyRulesApi.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section tsd-is-private tsd-is-private-protected"><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="generated.PolicyRulesApi.html#api" class="tsd-kind-icon">api</a></li></ul></section><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.PolicyRulesApi.html#createPolicyRules" class="tsd-kind-icon">create<wbr/>Policy<wbr/>Rules</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.PolicyRulesApi.html#deletePolicyRules" class="tsd-kind-icon">delete<wbr/>Policy<wbr/>Rules</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.PolicyRulesApi.html#getPolicyRules" class="tsd-kind-icon">get<wbr/>Policy<wbr/>Rules</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.PolicyRulesApi.html#updatePolicyRules" class="tsd-kind-icon">update<wbr/>Policy<wbr/>Rules</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link">constructor<a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">new <wbr/>Policy<wbr/>Rules<wbr/>Api<span class="tsd-signature-symbol">(</span>configuration<span class="tsd-signature-symbol">: </span><a href="../interfaces/generated_configuration.Configuration.html" class="tsd-signature-type" data-tsd-kind="Interface">Configuration</a>, requestFactory<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">PolicyRulesApiRequestFactory</span>, responseProcessor<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">PolicyRulesApiResponseProcessor</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="generated.PolicyRulesApi.html" class="tsd-signature-type" data-tsd-kind="Class">PolicyRulesApi</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/openfort-xyz/openfort-node/blob/28cae6f/src/generated/types/PromiseAPI.ts#L1002">src/generated/types/PromiseAPI.ts:1002</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>configuration: <a href="../interfaces/generated_configuration.Configuration.html" class="tsd-signature-type" data-tsd-kind="Interface">Configuration</a></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> requestFactory: <span class="tsd-signature-type">PolicyRulesApiRequestFactory</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> responseProcessor: <span class="tsd-signature-type">PolicyRulesApiResponseProcessor</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="generated.PolicyRulesApi.html" class="tsd-signature-type" data-tsd-kind="Class">PolicyRulesApi</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group tsd-is-private tsd-is-private-protected"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="api" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagPrivate">Private</span> api<a href="#api" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">api<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ObservablePolicyRulesApi</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/openfort-xyz/openfort-node/blob/28cae6f/src/generated/types/PromiseAPI.ts#L1000">src/generated/types/PromiseAPI.ts:1000</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="createPolicyRules" class="tsd-anchor"></a><h3 class="tsd-anchor-link">create<wbr/>Policy<wbr/>Rules<a href="#createPolicyRules" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">create<wbr/>Policy<wbr/>Rules<span class="tsd-signature-symbol">(</span>createPolicyRuleRequest<span class="tsd-signature-symbol">: </span><a href="index.CreatePolicyRuleRequest.html" class="tsd-signature-type" data-tsd-kind="Class">CreatePolicyRuleRequest</a>, _options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/generated_configuration.Configuration.html" class="tsd-signature-type" data-tsd-kind="Interface">Configuration</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="index.PolicyRuleResponse.html" class="tsd-signature-type" data-tsd-kind="Class">PolicyRuleResponse</a><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/openfort-xyz/openfort-node/blob/28cae6f/src/generated/types/PromiseAPI.ts#L1014">src/generated/types/PromiseAPI.ts:1014</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
2
|
-
<p>Create a policy rule object.</p>
|
|
3
|
-
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>createPolicyRuleRequest: <a href="index.CreatePolicyRuleRequest.html" class="tsd-signature-type" data-tsd-kind="Class">CreatePolicyRuleRequest</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
4
|
-
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> _options: <a href="../interfaces/generated_configuration.Configuration.html" class="tsd-signature-type" data-tsd-kind="Interface">Configuration</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="index.PolicyRuleResponse.html" class="tsd-signature-type" data-tsd-kind="Class">PolicyRuleResponse</a><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="deletePolicyRules" class="tsd-anchor"></a><h3 class="tsd-anchor-link">delete<wbr/>Policy<wbr/>Rules<a href="#deletePolicyRules" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">delete<wbr/>Policy<wbr/>Rules<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, _options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/generated_configuration.Configuration.html" class="tsd-signature-type" data-tsd-kind="Interface">Configuration</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="index.PolicyRuleDeleteResponse.html" class="tsd-signature-type" data-tsd-kind="Class">PolicyRuleDeleteResponse</a><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/openfort-xyz/openfort-node/blob/28cae6f/src/generated/types/PromiseAPI.ts#L1023">src/generated/types/PromiseAPI.ts:1023</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
5
|
-
<p>Deletes a policy rule object.</p>
|
|
6
|
-
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>id: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
7
|
-
<p>Specifies the unique policy rule ID.</p>
|
|
8
|
-
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> _options: <a href="../interfaces/generated_configuration.Configuration.html" class="tsd-signature-type" data-tsd-kind="Interface">Configuration</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="index.PolicyRuleDeleteResponse.html" class="tsd-signature-type" data-tsd-kind="Class">PolicyRuleDeleteResponse</a><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getPolicyRules" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Policy<wbr/>Rules<a href="#getPolicyRules" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">get<wbr/>Policy<wbr/>Rules<span class="tsd-signature-symbol">(</span>policy<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, skip<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, order<span class="tsd-signature-symbol">?: </span><a href="../modules/index.html#SortOrder" class="tsd-signature-type" data-tsd-kind="Type alias">SortOrder</a>, expand<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">"contract"</span><span class="tsd-signature-symbol">[]</span>, _options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/generated_configuration.Configuration.html" class="tsd-signature-type" data-tsd-kind="Interface">Configuration</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="index.PolicyRuleListResponse.html" class="tsd-signature-type" data-tsd-kind="Class">PolicyRuleListResponse</a><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/openfort-xyz/openfort-node/blob/28cae6f/src/generated/types/PromiseAPI.ts#L1036">src/generated/types/PromiseAPI.ts:1036</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
9
|
-
<p>List policy rules of a policy.</p>
|
|
10
|
-
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>policy: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
11
|
-
<p>Specifies the unique policy ID (starts with pol_).</p>
|
|
12
|
-
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> limit: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
13
|
-
<p>Specifies the maximum number of records to return.</p>
|
|
14
|
-
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> skip: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
15
|
-
<p>Specifies the offset for the first records to return.</p>
|
|
16
|
-
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> order: <a href="../modules/index.html#SortOrder" class="tsd-signature-type" data-tsd-kind="Type alias">SortOrder</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
17
|
-
<p>Specifies the order in which to sort the results.</p>
|
|
18
|
-
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> expand: <span class="tsd-signature-type">"contract"</span><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
19
|
-
<p>Specifies the fields to expand in the response.</p>
|
|
20
|
-
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> _options: <a href="../interfaces/generated_configuration.Configuration.html" class="tsd-signature-type" data-tsd-kind="Interface">Configuration</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="index.PolicyRuleListResponse.html" class="tsd-signature-type" data-tsd-kind="Class">PolicyRuleListResponse</a><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="updatePolicyRules" class="tsd-anchor"></a><h3 class="tsd-anchor-link">update<wbr/>Policy<wbr/>Rules<a href="#updatePolicyRules" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">update<wbr/>Policy<wbr/>Rules<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, updatePolicyRuleRequest<span class="tsd-signature-symbol">: </span><a href="generated.UpdatePolicyRuleRequest.html" class="tsd-signature-type" data-tsd-kind="Class">UpdatePolicyRuleRequest</a>, _options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/generated_configuration.Configuration.html" class="tsd-signature-type" data-tsd-kind="Interface">Configuration</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="index.PolicyRuleResponse.html" class="tsd-signature-type" data-tsd-kind="Class">PolicyRuleResponse</a><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/openfort-xyz/openfort-node/blob/28cae6f/src/generated/types/PromiseAPI.ts#L1046">src/generated/types/PromiseAPI.ts:1046</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
21
|
-
<p>Update a policy rule object.</p>
|
|
22
|
-
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>id: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
23
|
-
<p>Specifies the unique policy rule ID.</p>
|
|
24
|
-
</div></div></li><li><h5>updatePolicyRuleRequest: <a href="generated.UpdatePolicyRuleRequest.html" class="tsd-signature-type" data-tsd-kind="Class">UpdatePolicyRuleRequest</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
25
|
-
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> _options: <a href="../interfaces/generated_configuration.Configuration.html" class="tsd-signature-type" data-tsd-kind="Interface">Configuration</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="index.PolicyRuleResponse.html" class="tsd-signature-type" data-tsd-kind="Class">PolicyRuleResponse</a><span class="tsd-signature-symbol">></span></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Modules</a></li><li class=" tsd-kind-module"><a href="../modules/apis_baseApiWrapper.html">apis/base<wbr/>Api<wbr/>Wrapper</a></li><li class=" tsd-kind-module"><a href="../modules/apis_contractsApiWrapper.html">apis/contracts<wbr/>Api<wbr/>Wrapper</a></li><li class=" tsd-kind-module"><a href="../modules/apis_iamApiWrapper.html">apis/iam<wbr/>Api<wbr/>Wrapper</a></li><li class=" tsd-kind-module"><a href="../modules/apis_inventoriesApiWrapper.html">apis/inventories<wbr/>Api<wbr/>Wrapper</a></li><li class=" tsd-kind-module"><a href="../modules/apis_oauthApiWrapper.html">apis/oauth<wbr/>Api<wbr/>Wrapper</a></li><li class=" tsd-kind-module"><a href="../modules/apis_playersApiWrapper.html">apis/players<wbr/>Api<wbr/>Wrapper</a></li><li class=" tsd-kind-module"><a href="../modules/apis_policiesApiWrapper.html">apis/policies<wbr/>Api<wbr/>Wrapper</a></li><li class=" tsd-kind-module"><a href="../modules/apis_policyRulesApiWrapper.html">apis/policy<wbr/>Rules<wbr/>Api<wbr/>Wrapper</a></li><li class=" tsd-kind-module"><a href="../modules/apis_sessionsApiWrapper.html">apis/sessions<wbr/>Api<wbr/>Wrapper</a></li><li class=" tsd-kind-module"><a href="../modules/apis_settingsApiWrapper.html">apis/settings<wbr/>Api<wbr/>Wrapper</a></li><li class=" tsd-kind-module"><a href="../modules/apis_transactionIntentsApiWrapper.html">apis/transaction<wbr/>Intents<wbr/>Api<wbr/>Wrapper</a></li><li class=" tsd-kind-module"><a href="../modules/apis_web3ConnectionsApiWrapper.html">apis/web3<wbr/>Connections<wbr/>Api<wbr/>Wrapper</a></li><li class="current tsd-kind-module"><a href="../modules/generated.html">generated</a></li><li class=" tsd-kind-module"><a href="../modules/generated_configuration.html">generated/configuration</a></li><li class=" tsd-kind-module"><a href="../modules/generated_middleware.html">generated/middleware</a></li><li class=" tsd-kind-module"><a href="../modules/generated_rxjsStub.html">generated/rxjs<wbr/>Stub</a></li><li class=" tsd-kind-module"><a href="../modules/generated_servers.html">generated/servers</a></li><li class=" tsd-kind-module"><a href="../modules/generated_util.html">generated/util</a></li><li class=" tsd-kind-module"><a href="../modules/index.html">index</a></li><li class=" tsd-kind-module"><a href="../modules/models.html">models</a></li><li class=" tsd-kind-module"><a href="../modules/models_accountInventoryListQueries.html">models/account<wbr/>Inventory<wbr/>List<wbr/>Queries</a></li><li class=" tsd-kind-module"><a href="../modules/models_baseListRequest.html">models/base<wbr/>List<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_cancelTransferOwnershipRequest.html">models/cancel<wbr/>Transfer<wbr/>Ownership<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_completeRecoveryRequest.html">models/complete<wbr/>Recovery<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_createPlayerSessionRequest.html">models/create<wbr/>Player<wbr/>Session<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_getAccountInventoryRequest.html">models/get<wbr/>Account<wbr/>Inventory<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_getAccountRequest.html">models/get<wbr/>Account<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_getAllowFunctionsRequest.html">models/get<wbr/>Allow<wbr/>Functions<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_getContractRequest.html">models/get<wbr/>Contract<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_getPlayerByExternalIdRequest.html">models/get<wbr/>Player<wbr/>By<wbr/>External<wbr/>Id<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_getPlayerInventoryRequest.html">models/get<wbr/>Player<wbr/>Inventory<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_getPlayerRequest.html">models/get<wbr/>Player<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_getPolicyRequest.html">models/get<wbr/>Policy<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_getPolicyTotalGasUsageRequest.html">models/get<wbr/>Policy<wbr/>Total<wbr/>Gas<wbr/>Usage<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_getSessionRequest.html">models/get<wbr/>Session<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_getTransactionIntentRequest.html">models/get<wbr/>Transaction<wbr/>Intent<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_getWeb3ActionsList.html">models/get<wbr/>Web3<wbr/>Actions<wbr/>List</a></li><li class=" tsd-kind-module"><a href="../modules/models_getWeb3ConnectionRequest.html">models/get<wbr/>Web3<wbr/>Connection<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_playerCancelTransferOwnershipRequest.html">models/player<wbr/>Cancel<wbr/>Transfer<wbr/>Ownership<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_playerInventoryListQueries.html">models/player<wbr/>Inventory<wbr/>List<wbr/>Queries</a></li><li class=" tsd-kind-module"><a href="../modules/models_playerTransferOwnershipRequest.html">models/player<wbr/>Transfer<wbr/>Ownership<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_revokePlayerSessionRequest.html">models/revoke<wbr/>Player<wbr/>Session<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_signPayloadRequest.html">models/sign<wbr/>Payload<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_signatureSessionRequest.html">models/signature<wbr/>Session<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_signatureTransactionIntentRequest.html">models/signature<wbr/>Transaction<wbr/>Intent<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_startRecoveryRequest.html">models/start<wbr/>Recovery<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_submitWeb3ActionRequest.html">models/submit<wbr/>Web3<wbr/>Action<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_transferOwnershipRequest.html">models/transfer<wbr/>Ownership<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_updateContractRequest.html">models/update<wbr/>Contract<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_updatePlayerRequest.html">models/update<wbr/>Player<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_updatePolicyAllowFunctionRequest.html">models/update<wbr/>Policy<wbr/>Allow<wbr/>Function<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_updatePolicyRequest.html">models/update<wbr/>Policy<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_updatePolicyRuleRequest.html">models/update<wbr/>Policy<wbr/>Rule<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_updateProjectRequest.html">models/update<wbr/>Project<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_validationError.html">models/validation<wbr/>Error</a></li><li class=" tsd-kind-module"><a href="../modules/models_verifyOAuthTokenRequest.html">models/verifyOAuth<wbr/>Token<wbr/>Request</a></li><li class=" tsd-kind-module"><a href="../modules/models_webHookEvent.html">models/web<wbr/>Hook<wbr/>Event</a></li><li class=" tsd-kind-module"><a href="../modules/utilities_httpErrorHandler.html">utilities/http<wbr/>Error<wbr/>Handler</a></li><li class=" tsd-kind-module"><a href="../modules/utilities_middleware.html">utilities/middleware</a></li><li class=" tsd-kind-module"><a href="../modules/utilities_observable.html">utilities/observable</a></li><li class=" tsd-kind-module"><a href="../modules/utilities_observer.html">utilities/observer</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class tsd-parent-kind-module"><a href="generated.PolicyRulesApi.html" class="tsd-kind-icon">Policy<wbr/>Rules<wbr/>Api</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="generated.PolicyRulesApi.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="generated.PolicyRulesApi.html#api" class="tsd-kind-icon">api</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.PolicyRulesApi.html#createPolicyRules" class="tsd-kind-icon">create<wbr/>Policy<wbr/>Rules</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.PolicyRulesApi.html#deletePolicyRules" class="tsd-kind-icon">delete<wbr/>Policy<wbr/>Rules</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.PolicyRulesApi.html#getPolicyRules" class="tsd-kind-icon">get<wbr/>Policy<wbr/>Rules</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="generated.PolicyRulesApi.html#updatePolicyRules" class="tsd-kind-icon">update<wbr/>Policy<wbr/>Rules</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li><li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li><li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li><li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li><li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li><li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
|