Assets class
Constructors
Assets ({DateTime ?dateCreated , DateTime ?lastUpdated , String ?assetId , String ?userId , required String companyId , String ?connectionId , String ?llmConnectionId , int ?snippetId , int ?industryId , String ?aiJobId , int ?aucId , String ?functionId , AssetsApprovalStatusEnum ?approvalStatus , String ?approvedByUserId , DateTime ?approvedAt , required String name , String ?slug , String ?description , String ?detailedDescription , required AssetsSource_Enum source_ , AssetsAssetTypeEnum ?assetType , Object ?assetSchema , AssetsVisibilityEnum ?visibility , String ?tags , String ?topQuestions , String ?shortCode , String ?restrictedDomains , String ?sqlLogic , String ?sourceSchemaName , String ?sourceTableName , required bool sellInMarketplace , required bool requireCustomization , Object ?vizSpec , AssetsVizChartLibraryEnum ?vizChartLibrary , AssetsVizChartTypeEnum ?vizChartType , String ?vizDepVarColName , String ?vizIndepVarColName , String ?vizSizeColName , String ?vizColorColName , AssetsVizDataAggregationEnum ?vizDataAggregation , AssetsVizSortDirectionEnum ?vizSortDirection , int ?vizDataLimit , AssetsVizColorSchemeEnum ?vizColorScheme , bool ?vizShowLegend , bool ?vizShowGrid , bool ?vizShowTrendline , bool ?vizLineSmoothing , bool ?vizBarStacked , AssetsVizFilterDirectionEnum ?vizFilterDirection , required bool allowParams , required bool acceptTerms , bool ?cached , String ?schedule , DateTime ?nextRun , DateTime ?dataTimePeriodStart , DateTime ?dataTimePeriodEnd , DateTime ?dateCollectionStart , AssetsGeographicCoverageTypeEnum ?geographicCoverageType , String ?geographicCoverageDetails , AssetsDataSourceRefreshFrequencyEnum ?dataSourceRefreshFrequency , int ?rateLimitNumber , AssetsRateLimitPeriodEnum ?rateLimitPeriod , AssetsRateLimitGranularityEnum ?rateLimitGranularity
Returns a new Assets instance.
Properties
acceptTerms ↔ bool
Required.
getter/setter pair
aiJobId ↔ String ?
Links to the AutoInsights job that created this asset
getter/setter pair
allowParams ↔ bool
Required.
getter/setter pair
approvalStatus ↔ AssetsApprovalStatusEnum ?
Approval status for AI-generated assets
getter/setter pair
approvedAt ↔ DateTime ?
When this asset was approved for marketplace
getter/setter pair
approvedByUserId ↔ String ?
User who approved this asset for marketplace
getter/setter pair
assetId ↔ String ?
Unique identifier.
getter/setter pair
assetSchema ↔ Object ?
Stores database table schema data including columns, types, and metadata
getter/setter pair
assetType ↔ AssetsAssetTypeEnum ?
Optional. One of: CALCULATION, VISUALIZATION, DATA.
getter/setter pair
aucId ↔ int ?
Primary use case for this asset, from clustering analysis
getter/setter pair
cached ↔ bool ?
Optional.
getter/setter pair
companyId ↔ String
References companies.company_id — A Spartera seller or buyer company account. See GET /companies for valid values. Required.
getter/setter pair
connectionId ↔ String ?
Optional.
getter/setter pair
dataSourceRefreshFrequency ↔ AssetsDataSourceRefreshFrequencyEnum ?
How often the source data is refreshed
getter/setter pair
dataTimePeriodEnd ↔ DateTime ?
End date of the data time period covered
getter/setter pair
dataTimePeriodStart ↔ DateTime ?
Start date of the data time period covered
getter/setter pair
dateCollectionStart ↔ DateTime ?
When the seller began actively collecting this data. Distinct from data_time_period_start, which describes when the records themselves begin. Backfilled historical data will have date_collection_start > data_time_period_start.
getter/setter pair
dateCreated ↔ DateTime ?
Optional.
getter/setter pair
description ↔ String ?
Optional.
getter/setter pair
detailedDescription ↔ String ?
Long-form HTML description for product pages and SEO
getter/setter pair
functionId ↔ String ?
Optional identifier for routing to specific functions/models at seller endpoint. For GET: appended to URL path. For POST: included in JSON body.
getter/setter pair
geographicCoverageDetails ↔ String ?
Specific regions/countries covered (e.g., 'United States, Canada, Mexico')
getter/setter pair
geographicCoverageType ↔ AssetsGeographicCoverageTypeEnum ?
Type of geographic coverage
getter/setter pair
hashCode → int
The hash code for this object.
no setter override
industryId ↔ int ?
References industries.industry_id — Available industry categories for asset classification. Based on US NAISC codes.. See GET /industries for valid values. Optional.
getter/setter pair
lastUpdated ↔ DateTime ?
Optional.
getter/setter pair
llmConnectionId ↔ String ?
References connections.connection_id — Secure connections from Spartera to your databases and data warehouses. See GET /connections for valid values. Optional.
getter/setter pair
name ↔ String
Required.
getter/setter pair
nextRun ↔ DateTime ?
Optional.
getter/setter pair
rateLimitGranularity ↔ AssetsRateLimitGranularityEnum ?
Granularity level for rate limiting (USER, COMPANY, IP)
getter/setter pair
rateLimitNumber ↔ int ?
Number of requests allowed per period (e.g., 100)
getter/setter pair
rateLimitPeriod ↔ AssetsRateLimitPeriodEnum ?
Time period for rate limiting (second, minute, hour, day)
getter/setter pair
requireCustomization ↔ bool
Whether this asset requires customization before use
getter/setter pair
restrictedDomains ↔ String ?
Semicolon or comma-separated list of domains restricted from accessing this asset
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setter inherited
schedule ↔ String ?
Optional.
getter/setter pair
sellInMarketplace ↔ bool
Required.
getter/setter pair
shortCode ↔ String ?
Short code for tera.ac URL shortener (e.g., 'f78zq1')
getter/setter pair
slug ↔ String ?
Optional.
getter/setter pair
snippetId ↔ int ?
References snippets.snippet_id — Predefined code snippets to accelerate insight creation. See GET /snippets for valid values. Optional.
getter/setter pair
source_ ↔ AssetsSource_Enum
Required. One of: MANUAL, AUTOMATIC.
getter/setter pair
sourceSchemaName ↔ String ?
Optional.
getter/setter pair
sourceTableName ↔ String ?
Optional.
getter/setter pair
sqlLogic ↔ String ?
Optional.
getter/setter pair
tags ↔ String ?
Optional.
getter/setter pair
topQuestions ↔ String ?
Top 3 questions this asset can help answer, in English. Stored as JSON array of strings (1-3 items, 15-200 chars each). Required for marketplace assets.
getter/setter pair
userId ↔ String ?
References users.user_id — An individual user account within a company. See GET /users for valid values. Optional.
getter/setter pair
visibility ↔ AssetsVisibilityEnum ?
Optional. One of: PRIVATE, SHARED.
getter/setter pair
vizBarStacked ↔ bool ?
Stack bars instead of grouping
getter/setter pair
vizChartLibrary ↔ AssetsVizChartLibraryEnum ?
Optional. One of: PLOTLY, MATPLOTLIB, SEABORN.
getter/setter pair
vizChartType ↔ AssetsVizChartTypeEnum ?
Optional. One of: LINE, BAR, PIE, DOUGHNUT, POLAR, … (8 total).
getter/setter pair
vizColorColName ↔ String ?
Optional.
getter/setter pair
vizColorScheme ↔ AssetsVizColorSchemeEnum ?
Optional. One of: Default, Sequential, Diverging, Categorical, Monochrome, … (8 total).
getter/setter pair
vizDataAggregation ↔ AssetsVizDataAggregationEnum ?
Optional. One of: No Aggregation, Sum, Average, Count, Minimum, … (6 total).
getter/setter pair
vizDataLimit ↔ int ?
Optional.
getter/setter pair
vizDepVarColName ↔ String ?
Optional.
getter/setter pair
vizFilterDirection ↔ AssetsVizFilterDirectionEnum ?
Whether data_limit shows TOP or BOTTOM N
getter/setter pair
vizIndepVarColName ↔ String ?
Optional.
getter/setter pair
vizLineSmoothing ↔ bool ?
Enable smoothing for line charts
getter/setter pair
vizShowGrid ↔ bool ?
Show/hide grid lines
getter/setter pair
vizShowLegend ↔ bool ?
Show/hide chart legend
getter/setter pair
vizShowTrendline ↔ bool ?
Show trendline for scatter/line charts
getter/setter pair
vizSizeColName ↔ String ?
Optional.
getter/setter pair
vizSortDirection ↔ AssetsVizSortDirectionEnum ?
Optional. One of: No Sorting, Ascending, Descending.
getter/setter pair
vizSpec ↔ Object ?
Plotly figure JSON describing the visualization. Authored via the visual editor or via API. When populated, takes precedence over the legacy viz_* fields. Shape follows Plotly's figure schema: {data: {type: '...', xsrc: '...', ...}, layout: {...}}. Column references use *src keys (xsrc, ysrc, labelssrc, etc.) and are hydrated with actual data at render time.
getter/setter pair
