api library

Classes

Alerts
AlertsApi
AlertsInput
AlertsUpdate
AnalyzeCompanyHandleAssetsAssetSlugGet200Response
ApiClient
ApiKeyAuth
ApiKeys
APIKeysApi
ApiKeysInput
ApiKeysUpdate
AssetPriceHistory
AssetPriceHistoryApi
AssetPriceHistoryInput
AssetPriceHistoryUpdate
Assets
AssetsApi
AssetsAssetTypeEnum
Enum type: AssetType
AssetsAssetTypeEnumTypeTransformer
Transformation class that can encode an instance of AssetsAssetTypeEnum to String, and decode dynamic data back to AssetsAssetTypeEnum.
AssetsDataSourceRefreshFrequencyEnum
How often the source data is refreshed (Enum type: DataRefreshFrequency)
AssetsDataSourceRefreshFrequencyEnumTypeTransformer
Transformation class that can encode an instance of AssetsDataSourceRefreshFrequencyEnum to String, and decode dynamic data back to AssetsDataSourceRefreshFrequencyEnum.
AssetsGeographicCoverageTypeEnum
Type of geographic coverage (Enum type: GeographicCoverage)
AssetsGeographicCoverageTypeEnumTypeTransformer
Transformation class that can encode an instance of AssetsGeographicCoverageTypeEnum to String, and decode dynamic data back to AssetsGeographicCoverageTypeEnum.
AssetsInput
AssetsInputAssetTypeEnum
Enum type: AssetType
AssetsInputAssetTypeEnumTypeTransformer
Transformation class that can encode an instance of AssetsInputAssetTypeEnum to String, and decode dynamic data back to AssetsInputAssetTypeEnum.
AssetsInputDataSourceRefreshFrequencyEnum
How often the source data is refreshed (Enum type: DataRefreshFrequency)
AssetsInputDataSourceRefreshFrequencyEnumTypeTransformer
Transformation class that can encode an instance of AssetsInputDataSourceRefreshFrequencyEnum to String, and decode dynamic data back to AssetsInputDataSourceRefreshFrequencyEnum.
AssetsInputGeographicCoverageTypeEnum
Type of geographic coverage (Enum type: GeographicCoverage)
AssetsInputGeographicCoverageTypeEnumTypeTransformer
Transformation class that can encode an instance of AssetsInputGeographicCoverageTypeEnum to String, and decode dynamic data back to AssetsInputGeographicCoverageTypeEnum.
AssetsInputSource_Enum
Enum type: Source
AssetsInputSource_EnumTypeTransformer
Transformation class that can encode an instance of AssetsInputSource_Enum to String, and decode dynamic data back to AssetsInputSource_Enum.
AssetsInputVizChartLibraryEnum
Enum type: PlottingLibrary
AssetsInputVizChartLibraryEnumTypeTransformer
Transformation class that can encode an instance of AssetsInputVizChartLibraryEnum to String, and decode dynamic data back to AssetsInputVizChartLibraryEnum.
AssetsInputVizChartTypeEnum
Enum type: ChartType
AssetsInputVizChartTypeEnumTypeTransformer
Transformation class that can encode an instance of AssetsInputVizChartTypeEnum to String, and decode dynamic data back to AssetsInputVizChartTypeEnum.
AssetsInputVizColorSchemeEnum
Enum type: ColorScheme
AssetsInputVizColorSchemeEnumTypeTransformer
Transformation class that can encode an instance of AssetsInputVizColorSchemeEnum to String, and decode dynamic data back to AssetsInputVizColorSchemeEnum.
AssetsInputVizDataAggregationEnum
Enum type: AggregationType
AssetsInputVizDataAggregationEnumTypeTransformer
Transformation class that can encode an instance of AssetsInputVizDataAggregationEnum to String, and decode dynamic data back to AssetsInputVizDataAggregationEnum.
AssetsInputVizSortDirectionEnum
Enum type: SortDirection
AssetsInputVizSortDirectionEnumTypeTransformer
Transformation class that can encode an instance of AssetsInputVizSortDirectionEnum to String, and decode dynamic data back to AssetsInputVizSortDirectionEnum.
AssetsSource_Enum
Enum type: Source
AssetsSource_EnumTypeTransformer
Transformation class that can encode an instance of AssetsSource_Enum to String, and decode dynamic data back to AssetsSource_Enum.
AssetsUpdate
AssetsUpdateAssetTypeEnum
Enum type: AssetType
AssetsUpdateAssetTypeEnumTypeTransformer
Transformation class that can encode an instance of AssetsUpdateAssetTypeEnum to String, and decode dynamic data back to AssetsUpdateAssetTypeEnum.
AssetsUpdateDataSourceRefreshFrequencyEnum
How often the source data is refreshed (Enum type: DataRefreshFrequency)
AssetsUpdateDataSourceRefreshFrequencyEnumTypeTransformer
Transformation class that can encode an instance of AssetsUpdateDataSourceRefreshFrequencyEnum to String, and decode dynamic data back to AssetsUpdateDataSourceRefreshFrequencyEnum.
AssetsUpdateGeographicCoverageTypeEnum
Type of geographic coverage (Enum type: GeographicCoverage)
AssetsUpdateGeographicCoverageTypeEnumTypeTransformer
Transformation class that can encode an instance of AssetsUpdateGeographicCoverageTypeEnum to String, and decode dynamic data back to AssetsUpdateGeographicCoverageTypeEnum.
AssetsUpdateSource_Enum
Enum type: Source
AssetsUpdateSource_EnumTypeTransformer
Transformation class that can encode an instance of AssetsUpdateSource_Enum to String, and decode dynamic data back to AssetsUpdateSource_Enum.
AssetsUpdateVizChartLibraryEnum
Enum type: PlottingLibrary
AssetsUpdateVizChartLibraryEnumTypeTransformer
Transformation class that can encode an instance of AssetsUpdateVizChartLibraryEnum to String, and decode dynamic data back to AssetsUpdateVizChartLibraryEnum.
AssetsUpdateVizChartTypeEnum
Enum type: ChartType
AssetsUpdateVizChartTypeEnumTypeTransformer
Transformation class that can encode an instance of AssetsUpdateVizChartTypeEnum to String, and decode dynamic data back to AssetsUpdateVizChartTypeEnum.
AssetsUpdateVizColorSchemeEnum
Enum type: ColorScheme
AssetsUpdateVizColorSchemeEnumTypeTransformer
Transformation class that can encode an instance of AssetsUpdateVizColorSchemeEnum to String, and decode dynamic data back to AssetsUpdateVizColorSchemeEnum.
AssetsUpdateVizDataAggregationEnum
Enum type: AggregationType
AssetsUpdateVizDataAggregationEnumTypeTransformer
Transformation class that can encode an instance of AssetsUpdateVizDataAggregationEnum to String, and decode dynamic data back to AssetsUpdateVizDataAggregationEnum.
AssetsUpdateVizSortDirectionEnum
Enum type: SortDirection
AssetsUpdateVizSortDirectionEnumTypeTransformer
Transformation class that can encode an instance of AssetsUpdateVizSortDirectionEnum to String, and decode dynamic data back to AssetsUpdateVizSortDirectionEnum.
AssetsVisibilityEnum
Enum type: Visibility
AssetsVisibilityEnumTypeTransformer
Transformation class that can encode an instance of AssetsVisibilityEnum to String, and decode dynamic data back to AssetsVisibilityEnum.
AssetsVizChartLibraryEnum
Enum type: PlottingLibrary
AssetsVizChartLibraryEnumTypeTransformer
Transformation class that can encode an instance of AssetsVizChartLibraryEnum to String, and decode dynamic data back to AssetsVizChartLibraryEnum.
AssetsVizChartTypeEnum
Enum type: ChartType
AssetsVizChartTypeEnumTypeTransformer
Transformation class that can encode an instance of AssetsVizChartTypeEnum to String, and decode dynamic data back to AssetsVizChartTypeEnum.
AssetsVizColorSchemeEnum
Enum type: ColorScheme
AssetsVizColorSchemeEnumTypeTransformer
Transformation class that can encode an instance of AssetsVizColorSchemeEnum to String, and decode dynamic data back to AssetsVizColorSchemeEnum.
AssetsVizDataAggregationEnum
Enum type: AggregationType
AssetsVizDataAggregationEnumTypeTransformer
Transformation class that can encode an instance of AssetsVizDataAggregationEnum to String, and decode dynamic data back to AssetsVizDataAggregationEnum.
AssetsVizSortDirectionEnum
Enum type: SortDirection
AssetsVizSortDirectionEnumTypeTransformer
Transformation class that can encode an instance of AssetsVizSortDirectionEnum to String, and decode dynamic data back to AssetsVizSortDirectionEnum.
Authentication
CloudProviders
CloudProvidersApi
CloudProvidersGet200Response
CloudProvidersInput
CloudProvidersProviderIdGet200Response
CloudProvidersProviderIdStorageEnginesGet200Response
CloudProvidersUpdate
Companies
CompaniesApi
CompaniesCompanyIdAnalyticsAssetsGet200Response
CompaniesCompanyIdApiKeysApiKeyIdDelete200Response
CompaniesCompanyIdApiKeysApiKeyIdDelete200ResponseData
CompaniesCompanyIdApiKeysApiKeyIdGet200Response
CompaniesCompanyIdApiKeysApiKeyIdPatch200Response
CompaniesCompanyIdApiKeysApiKeyIdPatch200ResponseData
CompaniesCompanyIdApiKeysGet200Response
CompaniesCompanyIdApiKeysPost200Response
CompaniesCompanyIdApiKeysPost200ResponseData
CompaniesCompanyIdAssetsAssetIdDelete200Response
CompaniesCompanyIdAssetsAssetIdDelete200ResponseData
CompaniesCompanyIdAssetsAssetIdPatch200Response
CompaniesCompanyIdAssetsAssetIdPatch200ResponseData
CompaniesCompanyIdAssetsAssetIdPricesAphIdDelete200Response
CompaniesCompanyIdAssetsAssetIdPricesAphIdDelete200ResponseData
CompaniesCompanyIdAssetsAssetIdPricesAphIdGet200Response
CompaniesCompanyIdAssetsAssetIdPricesAphIdPatch200Response
CompaniesCompanyIdAssetsAssetIdPricesAphIdPatch200ResponseData
CompaniesCompanyIdAssetsAssetIdPricesGet200Response
CompaniesCompanyIdAssetsAssetIdPricesPost200Response
CompaniesCompanyIdAssetsAssetIdPricesPost200ResponseData
CompaniesCompanyIdAssetsGet200Response
CompaniesCompanyIdAssetsPost200Response
CompaniesCompanyIdAssetsPost200ResponseData
CompaniesCompanyIdConnectionsConnectionIdDelete200Response
CompaniesCompanyIdConnectionsConnectionIdDelete200ResponseData
CompaniesCompanyIdConnectionsConnectionIdGet200Response
CompaniesCompanyIdConnectionsConnectionIdPatch200Response
CompaniesCompanyIdConnectionsConnectionIdPatch200ResponseData
CompaniesCompanyIdConnectionsGet200Response
CompaniesCompanyIdConnectionsPost200Response
CompaniesCompanyIdConnectionsPost200ResponseData
CompaniesCompanyIdGet200Response
CompaniesCompanyIdPatch200Response
CompaniesCompanyIdPatch200ResponseData
CompaniesCompanyIdUsersGet200Response
CompaniesCompanyIdUsersPost200Response
CompaniesCompanyIdUsersPost200ResponseData
CompaniesCompanyIdUsersUserIdAlertsAlertIdDelete200Response
CompaniesCompanyIdUsersUserIdAlertsAlertIdDelete200ResponseData
CompaniesCompanyIdUsersUserIdAlertsAlertIdPatch200Response
CompaniesCompanyIdUsersUserIdAlertsAlertIdPatch200ResponseData
CompaniesCompanyIdUsersUserIdAlertsAssetAssetIdGet200Response
CompaniesCompanyIdUsersUserIdAlertsGet200Response
CompaniesCompanyIdUsersUserIdAlertsPost200Response
CompaniesCompanyIdUsersUserIdAlertsPost200ResponseData
CompaniesCompanyIdUsersUserIdDelete200Response
CompaniesCompanyIdUsersUserIdDelete200ResponseData
CompaniesCompanyIdUsersUserIdFavoritesCategoryCategoryGet200Response
CompaniesCompanyIdUsersUserIdFavoritesFavoriteIdDelete200Response
CompaniesCompanyIdUsersUserIdFavoritesFavoriteIdDelete200ResponseData
CompaniesCompanyIdUsersUserIdFavoritesFavoriteIdPatch200Response
CompaniesCompanyIdUsersUserIdFavoritesFavoriteIdPatch200ResponseData
CompaniesCompanyIdUsersUserIdFavoritesGet200Response
CompaniesCompanyIdUsersUserIdFavoritesPost200Response
CompaniesCompanyIdUsersUserIdFavoritesPost200ResponseData
CompaniesCompanyIdUsersUserIdGet200Response
CompaniesCompanyIdUsersUserIdPatch200Response
CompaniesCompanyIdUsersUserIdPatch200ResponseData
CompaniesInput
CompaniesUpdate
Connections
ConnectionsApi
ConnectionsCredentialTypeEnum
Enum type: CredentialType
ConnectionsCredentialTypeEnumTypeTransformer
Transformation class that can encode an instance of ConnectionsCredentialTypeEnum to String, and decode dynamic data back to ConnectionsCredentialTypeEnum.
ConnectionsInput
ConnectionsInputCredentialTypeEnum
Enum type: CredentialType
ConnectionsInputCredentialTypeEnumTypeTransformer
Transformation class that can encode an instance of ConnectionsInputCredentialTypeEnum to String, and decode dynamic data back to ConnectionsInputCredentialTypeEnum.
ConnectionsUpdate
ConnectionsUpdateCredentialTypeEnum
Enum type: CredentialType
ConnectionsUpdateCredentialTypeEnumTypeTransformer
Transformation class that can encode an instance of ConnectionsUpdateCredentialTypeEnum to String, and decode dynamic data back to ConnectionsUpdateCredentialTypeEnum.
DeserializationMessage
Primarily intended for use in an isolate.
Error
Favorites
FavoritesApi
FavoritesInput
FavoritesUpdate
HttpBasicAuth
HttpBearerAuth
InlineObject
InlineObject1
InlineObject2
InlineObject3
JobFunctions
JobFunctionsApi
JobFunctionsFunctionIdGet200Response
JobFunctionsGet200Response
JobFunctionsInput
JobFunctionsUpdate
OAuth
QueryParam
StorageEnginesApi
Users
UsersApi
UsersInput
UsersInputStatusEnum
Enum type: StatusCodes
UsersInputStatusEnumTypeTransformer
Transformation class that can encode an instance of UsersInputStatusEnum to String, and decode dynamic data back to UsersInputStatusEnum.
UsersStatusEnum
Enum type: StatusCodes
UsersStatusEnumTypeTransformer
Transformation class that can encode an instance of UsersStatusEnum to String, and decode dynamic data back to UsersStatusEnum.
UsersUpdate
UsersUpdateStatusEnum
Enum type: StatusCodes
UsersUpdateStatusEnumTypeTransformer
Transformation class that can encode an instance of UsersUpdateStatusEnum to String, and decode dynamic data back to UsersUpdateStatusEnum.

Properties

defaultApiClient ApiClient
An ApiClient instance that uses the default values obtained from the OpenAPI specification file.
getter/setter pair

Functions

decodeAsync(DeserializationMessage message) Future
Primarily intended for use in an isolate.
deserializeAsync(DeserializationMessage message) Future
Primarily intended for use in an isolate.
mapCastOfType<K, V>(dynamic map, String key) Map<K, V>?
Returns a valid Map<K, V> found at the specified Map key, null otherwise.
mapDateTime(dynamic map, String key, [String? pattern]) DateTime?
Returns a valid DateTime found at the specified Map key, null otherwise.
mapValueOfType<T>(dynamic map, String key) → T?
Returns a valid T value found at the specified Map key, null otherwise.
parameterToString(dynamic value) String
Format the given parameter object into a String.
serializeAsync(Object? value) Future<String>
Primarily intended for use in an isolate.

Typedefs

HttpBearerAuthProvider = String Function()

Exceptions / Errors

ApiException