``bayesline.api``
=================

.. currentmodule:: bayesline.api

Description of the public-facing API for bayesline.

.. toctree::
    :maxdepth: 1

    bayesline.api.equity

Core
----
.. autosummary::
   :toctree: _autosummary

   AsyncBayeslineApi
   BayeslineApi
   AsyncBayeslineApi

Authentication API
------------------
.. autosummary::
   :toctree: _autosummary

   ACLEntry
   ACLError
   ACLValidationError
   CreateACLEntry
   CreateGroupMembership
   CreateUserGroup
   CreateUserRole
   GroupCreationError
   GroupDeletionError
   GroupMembership
   GroupMembershipError
   GroupUpdateError
   PermissionDeniedError
   PermissionGrantError
   PermissionLevel
   PrincipalNotFoundError
   PrincipalType
   ResourceNotFoundError
   ResourcePermissionSummary
   ResourceType
   RoleAssignmentError
   RoleType
   UpdateACLEntry
   UpdateUserGroup
   UserGroup
   UserPermissionsSummary
   UserRef
   UserRole
   expand_roles
   role_satisfies
   AsyncPermissionsApi
   PermissionsApi

Settings API
------------
.. autosummary::
   :toctree: _autosummary

   AsyncRegistryBasedApiBase
   AsyncSettingsRegistry
   AsyncTypedSettingsRegistry
   RegistryBasedApiBase
   SettingsIdentifiers
   SettingsRegistry
   TypedSettingsRegistry
   CouldNotDeleteSettingsError
   CouldNotPermissionSettingsError
   CouldNotSaveSettingsError
   DatasetAwareSettings
   DatasetError
   DeleteItemResult
   DeleteResult
   EmptySettingsMenu
   ItemResult
   ItemStatus
   PermissionItemResult
   PermissionResult
   RawSettings
   SaveItemResult
   SaveResult
   SettingInvalid
   SettingNotFound
   SettingNotPermissioned
   SettingResult
   Settings
   SettingsMenu
   SettingsMetaData
   SettingsRegistryError
   SettingsRegistryResult
   SettingsTransferObject
   SettingValid
   expect_valid
   unwrap_valid
   REPORT_SETTINGS_TYPES
   RISKDATASET_SETTINGS_TYPES
   SETTINGS_TYPES
   migrate_raw_json
   parse_stored
   stamp_version
   strip_meta_keys
   validate_migration_chain
   DATASET_KEY

Tasks API
---------
.. autosummary::
   :toctree: _autosummary

   AsyncTask
   AsyncTasksApi
   Task
   TaskError
   TaskProgress
   TaskResponse
   TasksApi
   TaskState