Skip to main content
​
AddedChanged
v0.2.1

​
Added

  • POST /api/v1/deployments/{deploymentId}/dbt-sync operation (DbtSyncPublicController.startDbtSync) — starts a dbt sync for a deployment, optionally on a specific branch. New schemas: StartDbtSyncInput (branchName), DbtSyncResponse (branchName, syncJobId, workflowId).
  • PUT /api/v1/deployments/{deploymentId}/reports/{reportId}/connect-workbook operation (ReportsPublicController.connectReportToWorkbook) — links a report to the caller’s own spreadsheet by recording its placement, and returns the updated Report. Requires only read access to the report. New schema: ConnectReportToWorkbookInput (externalWorkbookId, resultLocation, endResultCell).
  • New SecretsManage and DownloadData RBAC actions, available across all policy action enums (RoleWithAccess.actions, the inherited/resource user & group policy actions, and the update-policy request bodies).
  • AIEngineerSettings now includes chatThreadPolicies. New schemas: ChatThreadPolicyDTO (actions, effect, resourceType, resources), ChatThreadPolicyDTOEffect (allow | deny), ChatThreadPolicyDTOResourceType.
  • GET /api/v1/deployments/{deploymentId}/reports accepts a new search query filter.
  • Report now includes canEdit, canManage, and externalWorkbookPlacements — a report can be placed in multiple spreadsheets. New schema: ReportPlacement (workbookId, resultLocation, endResultCell).
  • ReportSnapshot now includes fillMissingRows. New schema: FillMissingRows (member, excludedDimensions).
  • CreatorMode now includes showGeneratedSql and showSemanticSql toggles.
  • Dashboard now includes restrictDataDownload and useBoardDashboards.
  • UpdatePublishedAiWidgetThreadInput accepts an optional checksum.

​
Changed

  • DashboardConfigInput.widgets is now optional.
​
AddedChangedRemoved
v0.2.0

​
Added

  • POST /api/v1/deployments/{deploymentId}/workbooks/{workbookId}/dashboard/ai-widget-thread operation (WorkbooksPublicController.updatePublishedDashboardAiWidgetThread) — attaches an AI widget thread to a published dashboard and returns the updated Dashboard. New schema: UpdatePublishedAiWidgetThreadInput (threadId, widgetId).
  • DELETE /api/v1/embed-tenants/{embedTenantName}/ operation (EmbedTenantAdminPublicController.deleteEmbedTenant) for deleting an embed tenant.
  • CubePlatformClientConfig.credentials option, forwarded to the underlying fetch to control the credentials mode. Defaults to the browser’s same-origin behaviour; set 'omit' for token-only clients (e.g. signed embedding) that must never authenticate via a cookie.
  • Embed session requests (GenerateSession) accept tenantGroups and tenantGroupDefinitions — per-embed-tenant groups for sharing and organizing content within a single embed tenant (Creator Mode), namespaced separately from the global groups. New embedTenantProfile field with a displayName. New schema: EmbedTenantProfile.
  • AppConfigResponse now includes an embedding field. New schema: EmbedSettings (locale).
  • CreatorMode now includes localizedTitles for per-locale workspace titles. New schema: LocalizedValue (locale, value).
  • GET /api/v1/deployments/{deploymentId}/reports accepts new folderId and externalWorkbookId query filters.
  • UpdateWorkbookInput accepts slug and slugTakeover, and the Workbook response now includes slug.

​
Changed

  • UserAttributeDefinitionDTOType now includes a "boolean" value, and UserAttributeInput.value accepts boolean.

​
Removed

  • BREAKING: removed the GET /api/v1/embed-tenants/{embedTenantName}/user-attributes and DELETE /api/v1/embed-tenants/{embedTenantName}/user-attributes/{id} operations, along with the UserAttribute, UserAttributesConnectionResponse, and UserAttributeDTOType schemas.
  • BREAKING: removed the ephemeralTtlSeconds field from the embed session request (GenerateSession).
​
AddedChanged
v0.1.2

​
Added

  • GET /api/v1/app-config operation (AppThemePublicController.getAppConfig) returning the deployment’s app configuration — appTheme, applyThemeGlobally, and creatorMode. New schemas: AppConfigResponse, AppTheme, CreatorMode.
  • Scheduled notifications can now carry dashboard filters and timeGrains that are applied when the dashboard is run. Available on CreateNotificationInput, UpdateNotificationInput, and the Notification response. New schemas: DashboardFilter, DashboardFilterInput, DashboardFilterOperator, DashboardFilterInputOperator, DashboardTimeGrain, DashboardTimeGrainInput.
  • CreateNotificationInput accepts dashboardPublicId (string) as an alternative to the numeric dashboardId — supply exactly one.
  • GET /notifications accepts new filter query parameters: dashboardPublicId, and recipient filters recipientUserId / recipientEmail (console user) or recipientEmbedTenantName + recipientExternalId (embed user).
  • POST /workbooks/{workbookId}/duplicate accepts an optional DuplicateWorkbookInput body with a shared flag to clone a workbook from the shared workspace. New schema: DuplicateWorkbookInput.
  • Dashboard now includes a fromSharedWorkspace field.
  • Workbook now includes a user field (ResourceOwner).
  • InheritedUserPolicyDto and ResourceUserPolicyDto now include email, firstName, and picture fields.

​
Changed

  • CreateNotificationInput.dashboardId is now optional; identify the target dashboard with either dashboardId or the new dashboardPublicId.
​
AddedChangedDeprecated
v0.1.1

​
Added

  • GET /api/v1/deployments/{deploymentId}/reports now supports cursor-based pagination via the first and after query parameters, and returns an items array alongside a pageInfo cursor block — matching the folders and other list endpoints. (Cursor pagination is not available when sorting by lastViewedAt.)
  • The reports list now accepts name as a sortBy value, in addition to createdAt, updatedAt, and lastViewedAt.
  • NotificationRecipient now includes an optional username field.

​
Changed

  • BREAKING: The reports list response type ReportsFindAllResult is now ReportsListResponse.

​
Deprecated

  • The data and count fields on the reports list response are deprecated in favor of items and pageInfo. They remain populated for backward compatibility.
​
AddedChangedDeprecated
v0.1.0

​
Added

  • GET /api/v1/deployments/{deploymentId}/folders now supports cursor-based pagination via the first and after query parameters, and returns an items array alongside a pageInfo cursor block — matching the other list endpoints.

​
Changed

  • BREAKING: The folders list response type FoldersFindAllResult is now FoldersListResponse.

​
Deprecated

  • The data and count fields on the folders list response are deprecated in favor of items and pageInfo. They remain populated for backward compatibility.
​
AddedDeprecated
v0.0.20

​
Added

  • createCubePlatformClient — the new name for the client factory.
  • Cube Platform-branded type and hook names: CubePlatformClient, CubePlatformClientConfig, PlatformApiSchemas, and the react-query exports CubePlatformApiProvider, useCubePlatformApi, useCubePlatformApiQuery, useCubePlatformApiSuspenseQuery, useCubePlatformApiMutation, useCubePlatformApiLazyQuery, useCubePlatformApiQueryOptions, CubePlatformApiQueryKey, UseCubePlatformApiLazyQueryResult.

​
Deprecated

  • The former CubeCloud* / ConsoleApiSchemas names are deprecated in favor of the CubePlatform* / PlatformApiSchemas equivalents. All remain as aliases and will be removed in a future major version: createCubeCloudApiClient, CubeCloudApiClient, CubeCloudApiClientConfig, ConsoleApiSchemas, CubeCloudApiProvider, CubeCloudApiProviderProps, useCubeCloudApi, useCubeCloudApiQuery, useCubeCloudApiSuspenseQuery, useCubeCloudApiMutation, useCubeCloudApiLazyQuery, useCubeCloudApiQueryOptions, CubeCloudApiQueryKey, UseCubeCloudApiLazyQueryResult.