import { ResponseContext, RequestContext, HttpFile } from '../http/http'; import { Configuration} from '../configuration' import { AIContext } from '../models/AIContext'; import { APIKey } from '../models/APIKey'; import { APIKeyInput } from '../models/APIKeyInput'; import { AccessToken } from '../models/AccessToken'; import { ActionConfig } from '../models/ActionConfig'; import { ActionConfigInput } from '../models/ActionConfigInput'; import { ActionConfigInputCreate } from '../models/ActionConfigInputCreate'; import { ActionDetails } from '../models/ActionDetails'; import { ActionDetailsInput } from '../models/ActionDetailsInput'; import { ActionDetailsInputCreate } from '../models/ActionDetailsInputCreate'; import { ActivateUserRequest } from '../models/ActivateUserRequest'; import { AgentConversation } from '../models/AgentConversation'; import { AnswerContent } from '../models/AnswerContent'; import { AnswerContextInput } from '../models/AnswerContextInput'; import { AnswerDataResponse } from '../models/AnswerDataResponse'; import { AssignChangeAuthorRequest } from '../models/AssignChangeAuthorRequest'; import { AssignTagRequest } from '../models/AssignTagRequest'; import { AssociateMetadataInput } from '../models/AssociateMetadataInput'; import { AssociateMetadataInputCreate } from '../models/AssociateMetadataInputCreate'; import { Authentication } from '../models/Authentication'; import { AuthenticationInput } from '../models/AuthenticationInput'; import { Author } from '../models/Author'; import { AuthorMetadataTypeInput } from '../models/AuthorMetadataTypeInput'; import { AuthorType } from '../models/AuthorType'; import { AwsS3Config } from '../models/AwsS3Config'; import { AwsS3ConfigInput } from '../models/AwsS3ConfigInput'; import { BasicAuth } from '../models/BasicAuth'; import { BasicAuthInput } from '../models/BasicAuthInput'; import { CALLBACK } from '../models/CALLBACK'; import { CALLBACKInput } from '../models/CALLBACKInput'; import { CALLBACKInputMandatory } from '../models/CALLBACKInputMandatory'; import { CalendarResponse } from '../models/CalendarResponse'; import { ChangeUserPasswordRequest } from '../models/ChangeUserPasswordRequest'; import { ChannelHistoryEventInfo } from '../models/ChannelHistoryEventInfo'; import { ChannelHistoryEventInput } from '../models/ChannelHistoryEventInput'; import { ChannelHistoryJob } from '../models/ChannelHistoryJob'; import { ChannelValidationAwsS3Info } from '../models/ChannelValidationAwsS3Info'; import { ChannelValidationDetail } from '../models/ChannelValidationDetail'; import { ClusterNonEmbedAccess } from '../models/ClusterNonEmbedAccess'; import { ClusterNonEmbedAccessInput } from '../models/ClusterNonEmbedAccessInput'; import { Collection } from '../models/Collection'; import { CollectionDeleteResponse } from '../models/CollectionDeleteResponse'; import { CollectionDeleteTypeIdentifiers } from '../models/CollectionDeleteTypeIdentifiers'; import { CollectionEntityIdentifier } from '../models/CollectionEntityIdentifier'; import { CollectionMetadataInput } from '../models/CollectionMetadataInput'; import { CollectionMetadataItem } from '../models/CollectionMetadataItem'; import { CollectionSearchResponse } from '../models/CollectionSearchResponse'; import { Column } from '../models/Column'; import { ColumnSecurityRule } from '../models/ColumnSecurityRule'; import { ColumnSecurityRuleColumn } from '../models/ColumnSecurityRuleColumn'; import { ColumnSecurityRuleGroup } from '../models/ColumnSecurityRuleGroup'; import { ColumnSecurityRuleGroupOperation } from '../models/ColumnSecurityRuleGroupOperation'; import { ColumnSecurityRuleResponse } from '../models/ColumnSecurityRuleResponse'; import { ColumnSecurityRuleSourceTable } from '../models/ColumnSecurityRuleSourceTable'; import { ColumnSecurityRuleTableInput } from '../models/ColumnSecurityRuleTableInput'; import { ColumnSecurityRuleUpdate } from '../models/ColumnSecurityRuleUpdate'; import { CommitBranchRequest } from '../models/CommitBranchRequest'; import { CommitFileType } from '../models/CommitFileType'; import { CommitHistoryResponse } from '../models/CommitHistoryResponse'; import { CommitResponse } from '../models/CommitResponse'; import { CommiterType } from '../models/CommiterType'; import { CommunicationChannelPreferencesResponse } from '../models/CommunicationChannelPreferencesResponse'; import { CommunicationChannelValidateResponse } from '../models/CommunicationChannelValidateResponse'; import { ConfigureCommunicationChannelPreferencesRequest } from '../models/ConfigureCommunicationChannelPreferencesRequest'; import { ConfigureSecuritySettingsRequest } from '../models/ConfigureSecuritySettingsRequest'; import { ConfigureSecuritySettingsRequestClusterPreferences } from '../models/ConfigureSecuritySettingsRequestClusterPreferences'; import { ConnectionConfigurationResponse } from '../models/ConnectionConfigurationResponse'; import { ConnectionConfigurationSearchRequest } from '../models/ConnectionConfigurationSearchRequest'; import { ConnectionInput } from '../models/ConnectionInput'; import { ContextPayloadV2Input } from '../models/ContextPayloadV2Input'; import { Conversation } from '../models/Conversation'; import { ConversationSettingsInput } from '../models/ConversationSettingsInput'; import { ConvertWorksheetToModelRequest } from '../models/ConvertWorksheetToModelRequest'; import { CopyObjectRequest } from '../models/CopyObjectRequest'; import { CreateAgentConversationRequest } from '../models/CreateAgentConversationRequest'; import { CreateAgentConversationRequestConversationSettings } from '../models/CreateAgentConversationRequestConversationSettings'; import { CreateAgentConversationRequestMetadataContext } from '../models/CreateAgentConversationRequestMetadataContext'; import { CreateCalendarRequest } from '../models/CreateCalendarRequest'; import { CreateCalendarRequestTableReference } from '../models/CreateCalendarRequestTableReference'; import { CreateCollectionRequest } from '../models/CreateCollectionRequest'; import { CreateConfigRequest } from '../models/CreateConfigRequest'; import { CreateConnectionConfigurationRequest } from '../models/CreateConnectionConfigurationRequest'; import { CreateConnectionConfigurationRequestPolicyProcessOptions } from '../models/CreateConnectionConfigurationRequestPolicyProcessOptions'; import { CreateConnectionRequest } from '../models/CreateConnectionRequest'; import { CreateConnectionResponse } from '../models/CreateConnectionResponse'; import { CreateConversationRequest } from '../models/CreateConversationRequest'; import { CreateCustomActionRequest } from '../models/CreateCustomActionRequest'; import { CreateCustomActionRequestActionDetails } from '../models/CreateCustomActionRequestActionDetails'; import { CreateCustomActionRequestDefaultActionConfig } from '../models/CreateCustomActionRequestDefaultActionConfig'; import { CreateEmailCustomizationRequest } from '../models/CreateEmailCustomizationRequest'; import { CreateEmailCustomizationRequestTemplateProperties } from '../models/CreateEmailCustomizationRequestTemplateProperties'; import { CreateEmailCustomizationResponse } from '../models/CreateEmailCustomizationResponse'; import { CreateOrgRequest } from '../models/CreateOrgRequest'; import { CreateRoleRequest } from '../models/CreateRoleRequest'; import { CreateScheduleRequest } from '../models/CreateScheduleRequest'; import { CreateScheduleRequestFrequency } from '../models/CreateScheduleRequestFrequency'; import { CreateScheduleRequestLiveboardOptions } from '../models/CreateScheduleRequestLiveboardOptions'; import { CreateScheduleRequestPdfOptions } from '../models/CreateScheduleRequestPdfOptions'; import { CreateScheduleRequestRecipientDetails } from '../models/CreateScheduleRequestRecipientDetails'; import { CreateTagRequest } from '../models/CreateTagRequest'; import { CreateUserGroupRequest } from '../models/CreateUserGroupRequest'; import { CreateUserRequest } from '../models/CreateUserRequest'; import { CreateVariableRequest } from '../models/CreateVariableRequest'; import { CreateWebhookConfigurationRequest } from '../models/CreateWebhookConfigurationRequest'; import { CreateWebhookConfigurationRequestAuthentication } from '../models/CreateWebhookConfigurationRequestAuthentication'; import { CreateWebhookConfigurationRequestSignatureVerification } from '../models/CreateWebhookConfigurationRequestSignatureVerification'; import { CreateWebhookConfigurationRequestStorageDestination } from '../models/CreateWebhookConfigurationRequestStorageDestination'; import { CronExpression } from '../models/CronExpression'; import { CronExpressionInput } from '../models/CronExpressionInput'; import { CspSettings } from '../models/CspSettings'; import { CspSettingsInput } from '../models/CspSettingsInput'; import { CustomActionMetadataTypeInput } from '../models/CustomActionMetadataTypeInput'; import { DataSource } from '../models/DataSource'; import { DataSourceContextInput } from '../models/DataSourceContextInput'; import { DataWarehouseObjectInput } from '../models/DataWarehouseObjectInput'; import { DataWarehouseObjects } from '../models/DataWarehouseObjects'; import { Database } from '../models/Database'; import { DbtSearchResponse } from '../models/DbtSearchResponse'; import { DeactivateUserRequest } from '../models/DeactivateUserRequest'; import { DefaultActionConfig } from '../models/DefaultActionConfig'; import { DefaultActionConfigInput } from '../models/DefaultActionConfigInput'; import { DefaultActionConfigInputCreate } from '../models/DefaultActionConfigInputCreate'; import { DefaultActionConfigSearchInput } from '../models/DefaultActionConfigSearchInput'; import { DeleteCollectionRequest } from '../models/DeleteCollectionRequest'; import { DeleteConfigRequest } from '../models/DeleteConfigRequest'; import { DeleteConnectionConfigurationRequest } from '../models/DeleteConnectionConfigurationRequest'; import { DeleteConnectionRequest } from '../models/DeleteConnectionRequest'; import { DeleteMetadataRequest } from '../models/DeleteMetadataRequest'; import { DeleteMetadataTypeInput } from '../models/DeleteMetadataTypeInput'; import { DeleteOrgEmailCustomizationRequest } from '../models/DeleteOrgEmailCustomizationRequest'; import { DeleteVariablesRequest } from '../models/DeleteVariablesRequest'; import { DeleteWebhookConfigurationsRequest } from '../models/DeleteWebhookConfigurationsRequest'; import { DeployCommitRequest } from '../models/DeployCommitRequest'; import { DeployResponse } from '../models/DeployResponse'; import { EntityHeader } from '../models/EntityHeader'; import { ErrorResponse } from '../models/ErrorResponse'; import { EurekaDataSourceSuggestionResponse } from '../models/EurekaDataSourceSuggestionResponse'; import { EurekaDecomposeQueryResponse } from '../models/EurekaDecomposeQueryResponse'; import { EurekaGetNLInstructionsResponse } from '../models/EurekaGetNLInstructionsResponse'; import { EurekaGetRelevantQuestionsResponse } from '../models/EurekaGetRelevantQuestionsResponse'; import { EurekaLLMDecomposeQueryResponse } from '../models/EurekaLLMDecomposeQueryResponse'; import { EurekaLLMSuggestedQuery } from '../models/EurekaLLMSuggestedQuery'; import { EurekaRelevantQuestion } from '../models/EurekaRelevantQuestion'; import { EurekaSetNLInstructionsResponse } from '../models/EurekaSetNLInstructionsResponse'; import { EventChannelConfig } from '../models/EventChannelConfig'; import { EventChannelConfigInput } from '../models/EventChannelConfigInput'; import { ExcludeMetadataListItemInput } from '../models/ExcludeMetadataListItemInput'; import { ExportAnswerReportRequest } from '../models/ExportAnswerReportRequest'; import { ExportAnswerReportRequestRegionalSettings } from '../models/ExportAnswerReportRequestRegionalSettings'; import { ExportLiveboardReportRequest } from '../models/ExportLiveboardReportRequest'; import { ExportLiveboardReportRequestPdfOptions } from '../models/ExportLiveboardReportRequestPdfOptions'; import { ExportLiveboardReportRequestPngOptions } from '../models/ExportLiveboardReportRequestPngOptions'; import { ExportMetadataTMLBatchedRequest } from '../models/ExportMetadataTMLBatchedRequest'; import { ExportMetadataTMLRequest } from '../models/ExportMetadataTMLRequest'; import { ExportMetadataTMLRequestExportOptions } from '../models/ExportMetadataTMLRequestExportOptions'; import { ExportMetadataTypeInput } from '../models/ExportMetadataTypeInput'; import { ExportOptions } from '../models/ExportOptions'; import { ExternalTableInput } from '../models/ExternalTableInput'; import { FavoriteMetadataInput } from '../models/FavoriteMetadataInput'; import { FavoriteMetadataItem } from '../models/FavoriteMetadataItem'; import { FavoriteObjectOptionsInput } from '../models/FavoriteObjectOptionsInput'; import { FetchAnswerDataRequest } from '../models/FetchAnswerDataRequest'; import { FetchAnswerSqlQueryRequest } from '../models/FetchAnswerSqlQueryRequest'; import { FetchAsyncImportTaskStatusRequest } from '../models/FetchAsyncImportTaskStatusRequest'; import { FetchColumnSecurityRulesRequest } from '../models/FetchColumnSecurityRulesRequest'; import { FetchConnectionDiffStatusResponse } from '../models/FetchConnectionDiffStatusResponse'; import { FetchLiveboardDataRequest } from '../models/FetchLiveboardDataRequest'; import { FetchLiveboardSqlQueryRequest } from '../models/FetchLiveboardSqlQueryRequest'; import { FetchLogsRequest } from '../models/FetchLogsRequest'; import { FetchObjectPrivilegesRequest } from '../models/FetchObjectPrivilegesRequest'; import { FetchPermissionsOfPrincipalsRequest } from '../models/FetchPermissionsOfPrincipalsRequest'; import { FetchPermissionsOnMetadataRequest } from '../models/FetchPermissionsOnMetadataRequest'; import { FilterRules } from '../models/FilterRules'; import { ForceLogoutUsersRequest } from '../models/ForceLogoutUsersRequest'; import { Frequency } from '../models/Frequency'; import { FrequencyInput } from '../models/FrequencyInput'; import { GenerateCSVRequest } from '../models/GenerateCSVRequest'; import { GenericInfo } from '../models/GenericInfo'; import { GetAsyncImportStatusResponse } from '../models/GetAsyncImportStatusResponse'; import { GetCustomAccessTokenRequest } from '../models/GetCustomAccessTokenRequest'; import { GetDataSourceSuggestionsRequest } from '../models/GetDataSourceSuggestionsRequest'; import { GetFullAccessTokenRequest } from '../models/GetFullAccessTokenRequest'; import { GetFullAccessTokenRequestUserParameters } from '../models/GetFullAccessTokenRequestUserParameters'; import { GetNLInstructionsRequest } from '../models/GetNLInstructionsRequest'; import { GetObjectAccessTokenRequest } from '../models/GetObjectAccessTokenRequest'; import { GetRelevantQuestionsRequest } from '../models/GetRelevantQuestionsRequest'; import { GetRelevantQuestionsRequestAiContext } from '../models/GetRelevantQuestionsRequestAiContext'; import { GetRelevantQuestionsRequestMetadataContext } from '../models/GetRelevantQuestionsRequestMetadataContext'; import { GetTokenResponse } from '../models/GetTokenResponse'; import { GroupInfo } from '../models/GroupInfo'; import { GroupObject } from '../models/GroupObject'; import { GroupsImportListInput } from '../models/GroupsImportListInput'; import { HeaderAttributeInput } from '../models/HeaderAttributeInput'; import { HeaderUpdateInput } from '../models/HeaderUpdateInput'; import { ImportEPackAsyncTaskStatus } from '../models/ImportEPackAsyncTaskStatus'; import { ImportMetadataTMLAsyncRequest } from '../models/ImportMetadataTMLAsyncRequest'; import { ImportMetadataTMLRequest } from '../models/ImportMetadataTMLRequest'; import { ImportUser } from '../models/ImportUser'; import { ImportUserGroupsRequest } from '../models/ImportUserGroupsRequest'; import { ImportUserGroupsResponse } from '../models/ImportUserGroupsResponse'; import { ImportUserType } from '../models/ImportUserType'; import { ImportUsersRequest } from '../models/ImportUsersRequest'; import { ImportUsersResponse } from '../models/ImportUsersResponse'; import { InputEurekaNLSRequest } from '../models/InputEurekaNLSRequest'; import { JWTMetadataObject } from '../models/JWTMetadataObject'; import { JWTParameter } from '../models/JWTParameter'; import { JWTUserOptions } from '../models/JWTUserOptions'; import { JWTUserOptionsFull } from '../models/JWTUserOptionsFull'; import { JobRecipient } from '../models/JobRecipient'; import { LBContextInput } from '../models/LBContextInput'; import { LiveboardContent } from '../models/LiveboardContent'; import { LiveboardDataResponse } from '../models/LiveboardDataResponse'; import { LiveboardOptions } from '../models/LiveboardOptions'; import { LiveboardOptionsInput } from '../models/LiveboardOptionsInput'; import { LogResponse } from '../models/LogResponse'; import { LoginRequest } from '../models/LoginRequest'; import { ManageObjectPrivilegeRequest } from '../models/ManageObjectPrivilegeRequest'; import { MetadataAssociationItem } from '../models/MetadataAssociationItem'; import { MetadataContext } from '../models/MetadataContext'; import { MetadataInput } from '../models/MetadataInput'; import { MetadataListItemInput } from '../models/MetadataListItemInput'; import { MetadataObject } from '../models/MetadataObject'; import { MetadataResponse } from '../models/MetadataResponse'; import { MetadataSearchResponse } from '../models/MetadataSearchResponse'; import { MetadataSearchSortOptions } from '../models/MetadataSearchSortOptions'; import { ModelTableList } from '../models/ModelTableList'; import { NLInstructionsInfo } from '../models/NLInstructionsInfo'; import { NLInstructionsInfoInput } from '../models/NLInstructionsInfoInput'; import { ObjectIDAndName } from '../models/ObjectIDAndName'; import { ObjectPrivilegesMetadataInput } from '../models/ObjectPrivilegesMetadataInput'; import { ObjectPrivilegesOfMetadataResponse } from '../models/ObjectPrivilegesOfMetadataResponse'; import { Org } from '../models/Org'; import { OrgChannelConfigInput } from '../models/OrgChannelConfigInput'; import { OrgChannelConfigResponse } from '../models/OrgChannelConfigResponse'; import { OrgDetails } from '../models/OrgDetails'; import { OrgInfo } from '../models/OrgInfo'; import { OrgNonEmbedAccess } from '../models/OrgNonEmbedAccess'; import { OrgNonEmbedAccessInput } from '../models/OrgNonEmbedAccessInput'; import { OrgPreferenceSearchCriteriaInput } from '../models/OrgPreferenceSearchCriteriaInput'; import { OrgResponse } from '../models/OrgResponse'; import { OrgType } from '../models/OrgType'; import { ParameterValues } from '../models/ParameterValues'; import { ParameterizeMetadataFieldsRequest } from '../models/ParameterizeMetadataFieldsRequest'; import { ParameterizeMetadataRequest } from '../models/ParameterizeMetadataRequest'; import { ParametersListItem } from '../models/ParametersListItem'; import { ParametersListItemInput } from '../models/ParametersListItemInput'; import { PdfOptions } from '../models/PdfOptions'; import { PdfOptionsInput } from '../models/PdfOptionsInput'; import { PermissionInput } from '../models/PermissionInput'; import { PermissionOfMetadataResponse } from '../models/PermissionOfMetadataResponse'; import { PermissionOfPrincipalsResponse } from '../models/PermissionOfPrincipalsResponse'; import { PermissionsMetadataTypeInput } from '../models/PermissionsMetadataTypeInput'; import { PngOptionsInput } from '../models/PngOptionsInput'; import { PolicyProcessOptions } from '../models/PolicyProcessOptions'; import { PolicyProcessOptionsInput } from '../models/PolicyProcessOptionsInput'; import { PrincipalsInput } from '../models/PrincipalsInput'; import { PrincipalsListItem } from '../models/PrincipalsListItem'; import { PrincipalsListItemInput } from '../models/PrincipalsListItemInput'; import { PublishMetadataListItem } from '../models/PublishMetadataListItem'; import { PublishMetadataRequest } from '../models/PublishMetadataRequest'; import { PutVariableValuesRequest } from '../models/PutVariableValuesRequest'; import { QueryGetDecomposedQueryRequest } from '../models/QueryGetDecomposedQueryRequest'; import { QueryGetDecomposedQueryRequestNlsRequest } from '../models/QueryGetDecomposedQueryRequestNlsRequest'; import { RecipientDetails } from '../models/RecipientDetails'; import { RecipientDetailsInput } from '../models/RecipientDetailsInput'; import { RegionalSettingsInput } from '../models/RegionalSettingsInput'; import { RepoConfigObject } from '../models/RepoConfigObject'; import { ResetUserPasswordRequest } from '../models/ResetUserPasswordRequest'; import { ResponseActivationURL } from '../models/ResponseActivationURL'; import { ResponseCopyObject } from '../models/ResponseCopyObject'; import { ResponseCustomAction } from '../models/ResponseCustomAction'; import { ResponseFailedEntities } from '../models/ResponseFailedEntities'; import { ResponseFailedEntity } from '../models/ResponseFailedEntity'; import { ResponseIncompleteEntities } from '../models/ResponseIncompleteEntities'; import { ResponseIncompleteEntity } from '../models/ResponseIncompleteEntity'; import { ResponseMessage } from '../models/ResponseMessage'; import { ResponsePostUpgradeFailedEntities } from '../models/ResponsePostUpgradeFailedEntities'; import { ResponsePostUpgradeFailedEntity } from '../models/ResponsePostUpgradeFailedEntity'; import { ResponseSchedule } from '../models/ResponseSchedule'; import { ResponseScheduleRun } from '../models/ResponseScheduleRun'; import { ResponseSuccessfulEntities } from '../models/ResponseSuccessfulEntities'; import { ResponseSuccessfulEntity } from '../models/ResponseSuccessfulEntity'; import { ResponseWorksheetToModelConversion } from '../models/ResponseWorksheetToModelConversion'; import { RevertCommitRequest } from '../models/RevertCommitRequest'; import { RevertResponse } from '../models/RevertResponse'; import { RevertedMetadata } from '../models/RevertedMetadata'; import { RevokeRefreshTokensRequest } from '../models/RevokeRefreshTokensRequest'; import { RevokeRefreshTokensResponse } from '../models/RevokeRefreshTokensResponse'; import { RevokeTokenRequest } from '../models/RevokeTokenRequest'; import { RiseGQLArgWrapper } from '../models/RiseGQLArgWrapper'; import { RiseSetter } from '../models/RiseSetter'; import { Role } from '../models/Role'; import { RoleResponse } from '../models/RoleResponse'; import { RuntimeFilter } from '../models/RuntimeFilter'; import { RuntimeFilters } from '../models/RuntimeFilters'; import { RuntimeParamOverride } from '../models/RuntimeParamOverride'; import { RuntimeParameters } from '../models/RuntimeParameters'; import { RuntimeSort } from '../models/RuntimeSort'; import { RuntimeSorts } from '../models/RuntimeSorts'; import { ScheduleHistoryRunsOptionsInput } from '../models/ScheduleHistoryRunsOptionsInput'; import { SchedulesPdfOptionsInput } from '../models/SchedulesPdfOptionsInput'; import { SchemaObject } from '../models/SchemaObject'; import { Scope } from '../models/Scope'; import { ScriptSrcUrls } from '../models/ScriptSrcUrls'; import { ScriptSrcUrlsInput } from '../models/ScriptSrcUrlsInput'; import { SearchCalendarsRequest } from '../models/SearchCalendarsRequest'; import { SearchCalendarsRequestSortOptions } from '../models/SearchCalendarsRequestSortOptions'; import { SearchChannelHistoryRequest } from '../models/SearchChannelHistoryRequest'; import { SearchChannelHistoryResponse } from '../models/SearchChannelHistoryResponse'; import { SearchCollectionsRequest } from '../models/SearchCollectionsRequest'; import { SearchCollectionsRequestSortOptions } from '../models/SearchCollectionsRequestSortOptions'; import { SearchCommitsRequest } from '../models/SearchCommitsRequest'; import { SearchCommunicationChannelPreferencesRequest } from '../models/SearchCommunicationChannelPreferencesRequest'; import { SearchConfigRequest } from '../models/SearchConfigRequest'; import { SearchConnectionRequest } from '../models/SearchConnectionRequest'; import { SearchConnectionRequestSortOptions } from '../models/SearchConnectionRequestSortOptions'; import { SearchConnectionResponse } from '../models/SearchConnectionResponse'; import { SearchCustomActionsRequest } from '../models/SearchCustomActionsRequest'; import { SearchCustomActionsRequestDefaultActionConfig } from '../models/SearchCustomActionsRequestDefaultActionConfig'; import { SearchDataRequest } from '../models/SearchDataRequest'; import { SearchDataResponse } from '../models/SearchDataResponse'; import { SearchEmailCustomizationRequest } from '../models/SearchEmailCustomizationRequest'; import { SearchMetadataRequest } from '../models/SearchMetadataRequest'; import { SearchMetadataRequestFavoriteObjectOptions } from '../models/SearchMetadataRequestFavoriteObjectOptions'; import { SearchMetadataRequestSortOptions } from '../models/SearchMetadataRequestSortOptions'; import { SearchOrgsRequest } from '../models/SearchOrgsRequest'; import { SearchRoleResponse } from '../models/SearchRoleResponse'; import { SearchRolesRequest } from '../models/SearchRolesRequest'; import { SearchSchedulesRequest } from '../models/SearchSchedulesRequest'; import { SearchSchedulesRequestHistoryRunsOptions } from '../models/SearchSchedulesRequestHistoryRunsOptions'; import { SearchSchedulesRequestSortOptions } from '../models/SearchSchedulesRequestSortOptions'; import { SearchSecuritySettingsRequest } from '../models/SearchSecuritySettingsRequest'; import { SearchTagsRequest } from '../models/SearchTagsRequest'; import { SearchUserGroupsRequest } from '../models/SearchUserGroupsRequest'; import { SearchUserGroupsRequestSortOptions } from '../models/SearchUserGroupsRequestSortOptions'; import { SearchUsersRequest } from '../models/SearchUsersRequest'; import { SearchVariablesRequest } from '../models/SearchVariablesRequest'; import { SearchWebhookConfigurationsRequest } from '../models/SearchWebhookConfigurationsRequest'; import { SearchWebhookConfigurationsRequestSortOptions } from '../models/SearchWebhookConfigurationsRequestSortOptions'; import { SecuritySettingsClusterPreferences } from '../models/SecuritySettingsClusterPreferences'; import { SecuritySettingsClusterPreferencesInput } from '../models/SecuritySettingsClusterPreferencesInput'; import { SecuritySettingsOrgDetails } from '../models/SecuritySettingsOrgDetails'; import { SecuritySettingsOrgPreferences } from '../models/SecuritySettingsOrgPreferences'; import { SecuritySettingsOrgPreferencesInput } from '../models/SecuritySettingsOrgPreferencesInput'; import { SecuritySettingsResponse } from '../models/SecuritySettingsResponse'; import { SendAgentMessageRequest } from '../models/SendAgentMessageRequest'; import { SendAgentMessageResponse } from '../models/SendAgentMessageResponse'; import { SendAgentMessageStreamingRequest } from '../models/SendAgentMessageStreamingRequest'; import { SendMessageRequest } from '../models/SendMessageRequest'; import { SetNLInstructionsRequest } from '../models/SetNLInstructionsRequest'; import { ShareMetadataRequest } from '../models/ShareMetadataRequest'; import { ShareMetadataTypeInput } from '../models/ShareMetadataTypeInput'; import { SharePermissionsInput } from '../models/SharePermissionsInput'; import { SingleAnswerRequest } from '../models/SingleAnswerRequest'; import { SortOption } from '../models/SortOption'; import { SortOptionInput } from '../models/SortOptionInput'; import { SortOptions } from '../models/SortOptions'; import { SortingOptions } from '../models/SortingOptions'; import { SqlQuery } from '../models/SqlQuery'; import { SqlQueryResponse } from '../models/SqlQueryResponse'; import { StorageConfig } from '../models/StorageConfig'; import { StorageConfigInput } from '../models/StorageConfigInput'; import { StorageDestination } from '../models/StorageDestination'; import { StorageDestinationInput } from '../models/StorageDestinationInput'; import { SystemConfig } from '../models/SystemConfig'; import { SystemInfo } from '../models/SystemInfo'; import { SystemOverrideInfo } from '../models/SystemOverrideInfo'; import { Table } from '../models/Table'; import { Tag } from '../models/Tag'; import { TagMetadataTypeInput } from '../models/TagMetadataTypeInput'; import { TemplatePropertiesInputCreate } from '../models/TemplatePropertiesInputCreate'; import { Token } from '../models/Token'; import { TokenAccessScopeObject } from '../models/TokenAccessScopeObject'; import { TokenValidationResponse } from '../models/TokenValidationResponse'; import { URL } from '../models/URL'; import { URLInput } from '../models/URLInput'; import { URLInputMandatory } from '../models/URLInputMandatory'; import { UnassignTagRequest } from '../models/UnassignTagRequest'; import { UnparameterizeMetadataRequest } from '../models/UnparameterizeMetadataRequest'; import { UnpublishMetadataRequest } from '../models/UnpublishMetadataRequest'; import { UpdateCalendarRequest } from '../models/UpdateCalendarRequest'; import { UpdateCalendarRequestTableReference } from '../models/UpdateCalendarRequestTableReference'; import { UpdateCollectionRequest } from '../models/UpdateCollectionRequest'; import { UpdateColumnSecurityRulesRequest } from '../models/UpdateColumnSecurityRulesRequest'; import { UpdateConfigRequest } from '../models/UpdateConfigRequest'; import { UpdateConnectionConfigurationRequest } from '../models/UpdateConnectionConfigurationRequest'; import { UpdateConnectionRequest } from '../models/UpdateConnectionRequest'; import { UpdateConnectionV2Request } from '../models/UpdateConnectionV2Request'; import { UpdateCustomActionRequest } from '../models/UpdateCustomActionRequest'; import { UpdateCustomActionRequestActionDetails } from '../models/UpdateCustomActionRequestActionDetails'; import { UpdateCustomActionRequestDefaultActionConfig } from '../models/UpdateCustomActionRequestDefaultActionConfig'; import { UpdateEmailCustomizationRequest } from '../models/UpdateEmailCustomizationRequest'; import { UpdateMetadataHeaderRequest } from '../models/UpdateMetadataHeaderRequest'; import { UpdateMetadataObjIdRequest } from '../models/UpdateMetadataObjIdRequest'; import { UpdateObjIdInput } from '../models/UpdateObjIdInput'; import { UpdateOrgRequest } from '../models/UpdateOrgRequest'; import { UpdateRoleRequest } from '../models/UpdateRoleRequest'; import { UpdateScheduleRequest } from '../models/UpdateScheduleRequest'; import { UpdateScheduleRequestFrequency } from '../models/UpdateScheduleRequestFrequency'; import { UpdateScheduleRequestLiveboardOptions } from '../models/UpdateScheduleRequestLiveboardOptions'; import { UpdateScheduleRequestPdfOptions } from '../models/UpdateScheduleRequestPdfOptions'; import { UpdateScheduleRequestRecipientDetails } from '../models/UpdateScheduleRequestRecipientDetails'; import { UpdateSystemConfigRequest } from '../models/UpdateSystemConfigRequest'; import { UpdateTagRequest } from '../models/UpdateTagRequest'; import { UpdateUserGroupRequest } from '../models/UpdateUserGroupRequest'; import { UpdateUserRequest } from '../models/UpdateUserRequest'; import { UpdateVariableRequest } from '../models/UpdateVariableRequest'; import { UpdateVariableValuesRequest } from '../models/UpdateVariableValuesRequest'; import { UpdateWebhookConfigurationRequest } from '../models/UpdateWebhookConfigurationRequest'; import { User } from '../models/User'; import { UserGroup } from '../models/UserGroup'; import { UserGroupResponse } from '../models/UserGroupResponse'; import { UserInfo } from '../models/UserInfo'; import { UserObject } from '../models/UserObject'; import { UserParameterOptions } from '../models/UserParameterOptions'; import { UserPrincipal } from '../models/UserPrincipal'; import { ValidateCommunicationChannelRequest } from '../models/ValidateCommunicationChannelRequest'; import { ValidateMergeRequest } from '../models/ValidateMergeRequest'; import { ValidateTokenRequest } from '../models/ValidateTokenRequest'; import { ValueScopeInput } from '../models/ValueScopeInput'; import { Variable } from '../models/Variable'; import { VariableDetailInput } from '../models/VariableDetailInput'; import { VariablePutAssignmentInput } from '../models/VariablePutAssignmentInput'; import { VariableUpdateAssignmentInput } from '../models/VariableUpdateAssignmentInput'; import { VariableUpdateScopeInput } from '../models/VariableUpdateScopeInput'; import { VariableValue } from '../models/VariableValue'; import { VariableValues } from '../models/VariableValues'; import { WebhookAuthApiKey } from '../models/WebhookAuthApiKey'; import { WebhookAuthApiKeyInput } from '../models/WebhookAuthApiKeyInput'; import { WebhookAuthBasicAuth } from '../models/WebhookAuthBasicAuth'; import { WebhookAuthBasicAuthInput } from '../models/WebhookAuthBasicAuthInput'; import { WebhookAuthOAuth2 } from '../models/WebhookAuthOAuth2'; import { WebhookAuthOAuth2Input } from '../models/WebhookAuthOAuth2Input'; import { WebhookAuthentication } from '../models/WebhookAuthentication'; import { WebhookAuthenticationInput } from '../models/WebhookAuthenticationInput'; import { WebhookDeleteFailure } from '../models/WebhookDeleteFailure'; import { WebhookDeleteResponse } from '../models/WebhookDeleteResponse'; import { WebhookKeyValuePair } from '../models/WebhookKeyValuePair'; import { WebhookKeyValuePairInput } from '../models/WebhookKeyValuePairInput'; import { WebhookOrg } from '../models/WebhookOrg'; import { WebhookPagination } from '../models/WebhookPagination'; import { WebhookResponse } from '../models/WebhookResponse'; import { WebhookSearchResponse } from '../models/WebhookSearchResponse'; import { WebhookSignatureVerification } from '../models/WebhookSignatureVerification'; import { WebhookSignatureVerificationInput } from '../models/WebhookSignatureVerificationInput'; import { WebhookSortOptionsInput } from '../models/WebhookSortOptionsInput'; import { WebhookUser } from '../models/WebhookUser'; import { ObservableAIApi } from "./ObservableAPI"; import { AIApiRequestFactory, AIApiResponseProcessor} from "../apis/AIApi"; export interface AIApiCreateAgentConversationRequest { /** * * @type CreateAgentConversationRequest * @memberof AIApicreateAgentConversation */ createAgentConversationRequest: CreateAgentConversationRequest } export interface AIApiCreateConversationRequest { /** * * @type CreateConversationRequest * @memberof AIApicreateConversation */ createConversationRequest: CreateConversationRequest } export interface AIApiGetDataSourceSuggestionsRequest { /** * * @type GetDataSourceSuggestionsRequest * @memberof AIApigetDataSourceSuggestions */ getDataSourceSuggestionsRequest: GetDataSourceSuggestionsRequest } export interface AIApiGetNLInstructionsRequest { /** * * @type GetNLInstructionsRequest * @memberof AIApigetNLInstructions */ getNLInstructionsRequest: GetNLInstructionsRequest } export interface AIApiGetRelevantQuestionsRequest { /** * * @type GetRelevantQuestionsRequest * @memberof AIApigetRelevantQuestions */ getRelevantQuestionsRequest: GetRelevantQuestionsRequest } export interface AIApiQueryGetDecomposedQueryRequest { /** * * @type QueryGetDecomposedQueryRequest * @memberof AIApiqueryGetDecomposedQuery */ queryGetDecomposedQueryRequest: QueryGetDecomposedQueryRequest } export interface AIApiSendAgentMessageRequest { /** * Unique identifier for the conversation (used to track context) * @type string * @memberof AIApisendAgentMessage */ conversationIdentifier: string /** * * @type SendAgentMessageRequest * @memberof AIApisendAgentMessage */ sendAgentMessageRequest: SendAgentMessageRequest } export interface AIApiSendAgentMessageStreamingRequest { /** * * @type SendAgentMessageStreamingRequest * @memberof AIApisendAgentMessageStreaming */ sendAgentMessageStreamingRequest: SendAgentMessageStreamingRequest } export interface AIApiSendMessageRequest { /** * Unique identifier of the conversation. * @type string * @memberof AIApisendMessage */ conversationIdentifier: string /** * * @type SendMessageRequest * @memberof AIApisendMessage */ sendMessageRequest: SendMessageRequest } export interface AIApiSetNLInstructionsRequest { /** * * @type SetNLInstructionsRequest * @memberof AIApisetNLInstructions */ setNLInstructionsRequest: SetNLInstructionsRequest } export interface AIApiSingleAnswerRequest { /** * * @type SingleAnswerRequest * @memberof AIApisingleAnswer */ singleAnswerRequest: SingleAnswerRequest } export class ObjectAIApi { private api: ObservableAIApi public constructor(configuration: Configuration, requestFactory?: AIApiRequestFactory, responseProcessor?: AIApiResponseProcessor) { this.api = new ObservableAIApi(configuration, requestFactory, responseProcessor); } /** * Version: 26.2.0.cl or later Creates a new Spotter agent conversation based on the provided context and settings. The endpoint was in Beta from 26.2.0.cl through 26.4.0.cl. Requires `CAN_USE_SPOTTER` privilege and at least view access to the metadata object specified in the request. #### Usage guidelines The request must include the `metadata_context` parameter to define the conversation context. The context type can be one of: - `DATA_SOURCE` *(available from 26.5.0.cl)*: targets a specific data source. Provide `data_source_identifier` in `data_source_context` for a single data source, or `data_source_identifiers` for multi-data-source context. The deprecated `guid` field is accepted for backwards compatibility. - `AUTO_MODE` *(available from 26.5.0.cl)*: automatically discovers and selects the most relevant datasets for the user\'s queries. > **Note for callers on versions 26.2.0.cl – 26.4.0.cl (Beta):** use the lowercase `data_source` enum value with the `guid` field instead of the above. Example: `{ \"type\": \"data_source\", \"data_source_context\": { \"guid\": \"\" } }`. The `conversation_settings` parameter controls which Spotter capabilities are enabled for the conversation: - `enable_contextual_change_analysis` (default: `true`, **deprecated from 26.2.0.cl**) — always enabled in Spotter 3; setting this to `false` has no effect on versions >= 26.2.0.cl - `enable_natural_language_answer_generation` (default: `true`, **deprecated from 26.2.0.cl**) — always enabled in Spotter 3; setting this to `false` has no effect on versions >= 26.2.0.cl - `enable_reasoning` (default: `true`, **deprecated from 26.2.0.cl**) — always enabled in Spotter 3; setting this to `false` has no effect on versions >= 26.2.0.cl - `enable_save_chat` (default: `false`, *available from 26.5.0.cl*) — enables saving the conversation for later retrieval via conversation history If the request is successful, the response includes a unique `conversation_identifier` that must be passed to `sendAgentConversationMessage` or `sendAgentConversationMessageStreaming` to send messages within this conversation. The response also includes `conversation_id` with the same value for backwards compatibility; use `conversation_identifier` for new integrations. #### Example request ```json { \"metadata_context\": { \"type\": \"DATA_SOURCE\", \"data_source_context\": { \"data_source_identifier\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\" } }, \"conversation_settings\": {} } ``` #### Error responses | Code | Description | | ---- | --------------------------------------------------------------------------------------------------------------------------------------- | | 401 | Unauthorized — authentication token is missing, expired, or invalid. | | 403 | Forbidden — the authenticated user does not have `CAN_USE_SPOTTER` privilege or lacks view permission on the specified metadata object. | > ###### Note: > > - This endpoint was in Beta from 26.2.0.cl through 26.4.0.cl and is Generally Available from version 26.5.0.cl. > - This endpoint requires Spotter - please contact ThoughtSpot support to enable Spotter on your cluster. * @param param the request object */ public createAgentConversation(param: AIApiCreateAgentConversationRequest, options?: Configuration): Promise { return this.api.createAgentConversation(param.createAgentConversationRequest, options).toPromise(); } /** * Version: 10.4.0.cl or later Creates a new conversation session tied to a specific data model for AI-driven natural language querying. Requires `CAN_USE_SPOTTER` privilege and at least view access to the metadata object specified in the request. #### Usage guidelines The request must include: - `metadata_identifier`: the unique ID of the data source that provides context for the conversation Optionally, you can provide: - `tokens`: a token string to set initial context for the conversation (e.g., `\"[sales],[item type],[state]\"`) If the request is successful, ThoughtSpot returns a unique `conversation_identifier` that must be passed to `sendMessage` to continue the conversation. #### Error responses | Code | Description | |------|-------------| | 401 | Unauthorized — authentication token is missing, expired, or invalid. | | 403 | Forbidden — the authenticated user does not have `CAN_USE_SPOTTER` privilege or lacks view permission on the specified metadata object. | > ###### Note: > * This endpoint is currently in Beta. Breaking changes may be introduced before the endpoint is made Generally Available. > * This endpoint requires Spotter - please contact ThoughtSpot support to enable Spotter on your cluster. * @param param the request object */ public createConversation(param: AIApiCreateConversationRequest, options?: Configuration): Promise { return this.api.createConversation(param.createConversationRequest, options).toPromise(); } /** * Version: 10.15.0.cl or later Suggests the most relevant data sources for a given natural language query, ranked by confidence with LLM-generated reasoning. Requires `CAN_USE_SPOTTER` privilege and at least view-level access to the underlying metadata entities referenced in the response. #### Usage guidelines The request must include: - `query`: the natural language question to find relevant data sources for If the request is successful, the API returns a ranked list of suggested data sources, each containing: - `confidence`: a float score indicating the model\'s confidence in the relevance of the suggestion - `details`: metadata about the data source - `data_source_identifier`: the unique ID of the data source - `data_source_name`: the display name of the data source - `description`: a description of the data source - `reasoning`: LLM-generated rationale explaining why the data source was recommended #### Error responses | Code | Description | |------|--------------------------------------------------------------------------------------------------------------------------------------------| | 401 | Unauthorized — authentication token is missing, expired, or invalid. | | 403 | Forbidden — the authenticated user does not have `CAN_USE_SPOTTER` privilege or lacks view permission on the underlying metadata entities. | > ###### Note: > * This endpoint is currently in Beta. Breaking changes may be introduced before it is made Generally Available. > * This endpoint requires Spotter — please contact ThoughtSpot Support to enable Spotter on your cluster. * @param param the request object */ public getDataSourceSuggestions(param: AIApiGetDataSourceSuggestionsRequest, options?: Configuration): Promise { return this.api.getDataSourceSuggestions(param.getDataSourceSuggestionsRequest, options).toPromise(); } /** * Version: 10.15.0.cl or later Retrieves existing natural language (NL) instructions configured for a specific data model. These instructions guide the AI system in understanding data context and generating more accurate responses. Requires `CAN_USE_SPOTTER` privilege, at least view access on the data model, and a bearer token corresponding to the org where the data model exists. #### Usage guidelines The request must include: - `data_source_identifier`: the unique ID of the data model to retrieve instructions for If the request is successful, the API returns: - `nl_instructions_info`: an array of instruction objects, each containing: - `instructions`: the configured text instructions for AI processing - `scope`: the scope of the instruction — currently only `GLOBAL` is supported #### Instructions scope - **GLOBAL**: Instructions that apply globally across the system on the given data-model (currently only global instructions are supported) #### Error responses | Code | Description | |------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | 401 | Unauthorized — authentication token is missing, expired, or invalid. | | 403 | Forbidden — the authenticated user does not have `CAN_USE_SPOTTER` privilege, lacks view access on the data model, or the bearer token does not correspond to the org where the data model exists. | > ###### Note: > > - To use this API, the user needs at least view access on the data model, and must use the bearer token corresponding to the org where the data model exists. > - This endpoint is currently in Beta. Breaking changes may be introduced before the endpoint is made Generally Available. > - Available from version 10.15.0.cl and later. > - This endpoint requires Spotter — please contact ThoughtSpot Support to enable Spotter on your cluster. > - Use this API to review currently configured instructions before modifying them with `setNLInstructions`. * @param param the request object */ public getNLInstructions(param: AIApiGetNLInstructionsRequest, options?: Configuration): Promise { return this.api.getNLInstructions(param.getNLInstructionsRequest, options).toPromise(); } /** * Version: 10.13.0.cl or later Breaks down a natural language query into a series of smaller analytical sub-questions, each mapped to a relevant data source. Requires `CAN_USE_SPOTTER` privilege and at least view-level access to the referenced metadata objects. #### Usage guidelines The request must include: - `query`: the natural language question to decompose into analytical sub-questions - `metadata_context`: at least one of the following context identifiers to guide question generation: - `conversation_identifier` — an existing conversation session ID - `answer_identifiers` — a list of Answer GUIDs - `liveboard_identifiers` — a list of Liveboard GUIDs - `data_source_identifiers` — a list of data source GUIDs Optional parameters for refining the output: - `ai_context`: additional context to improve response quality - `content` — supplementary text or CSV data as string input - `instructions` — custom text instructions for the AI system - `limit_relevant_questions`: maximum number of questions to return (default: `5`) - `bypass_cache`: if `true`, forces fresh computation instead of returning cached results If the request is successful, the API returns a list of relevant analytical questions, each containing: - `query`: the generated sub-question - `data_source_identifier`: the unique ID of the data source the question targets - `data_source_name`: the display name of the corresponding data source #### Error responses | Code | Description | |------|---------------------------------------------------------------------------------------------------------------------------------------| | 401 | Unauthorized — authentication token is missing, expired, or invalid. | | 403 | Forbidden — the authenticated user does not have `CAN_USE_SPOTTER` privilege or lacks view access to the referenced metadata objects. | > ###### Note: > * This endpoint is currently in Beta. Breaking changes may be introduced before the endpoint is made Generally Available. > * This endpoint requires Spotter - please contact ThoughtSpot support to enable Spotter on your cluster. * @param param the request object */ public getRelevantQuestions(param: AIApiGetRelevantQuestionsRequest, options?: Configuration): Promise { return this.api.getRelevantQuestions(param.getRelevantQuestionsRequest, options).toPromise(); } /** * Version: 10.7.0.cl or later **Deprecated** — Use `getRelevantQuestions` instead (available from 10.13.0.cl). Breaks down a topical or goal-oriented natural language question into smaller, actionable analytical sub-questions, each mapped to a relevant data source for independent execution. Requires `CAN_USE_SPOTTER` privilege and at least view-level access to the referenced metadata objects. #### Usage guidelines The request accepts the following parameters: - `nlsRequest`: contains the user `query` to decompose, along with optional `instructions` and `bypassCache` flag - `worksheetIds`: list of data source identifiers to scope the decomposition - `answerIds`: list of Answer GUIDs whose data guides the response - `liveboardIds`: list of Liveboard GUIDs whose data guides the response - `conversationId`: an existing conversation session ID for context continuity - `content`: supplementary text or CSV data to improve response quality - `maxDecomposedQueries`: maximum number of sub-questions to return (default: `5`) If the request is successful, the API returns a `decomposedQueryResponse` containing a list of `decomposedQueries`, each with: - `query`: the generated analytical sub-question - `worksheetId`: the unique ID of the data source the question targets - `worksheetName`: the display name of the corresponding data source #### Error responses | Code | Description | |------|---------------------------------------------------------------------------------------------------------------------------------------| | 401 | Unauthorized — authentication token is missing, expired, or invalid. | | 403 | Forbidden — the authenticated user does not have `CAN_USE_SPOTTER` privilege or lacks view access to the referenced metadata objects. | > ###### Note: > * This endpoint is deprecated since 10.13.0.cl. Use `getRelevantQuestions` for new integrations. > * This endpoint is currently in Beta. Breaking changes may be introduced before the endpoint is made Generally Available. > * This endpoint requires Spotter — please contact ThoughtSpot support to enable Spotter on your cluster. * @param param the request object */ public queryGetDecomposedQuery(param: AIApiQueryGetDecomposedQueryRequest, options?: Configuration): Promise { return this.api.queryGetDecomposedQuery(param.queryGetDecomposedQueryRequest, options).toPromise(); } /** * Version: 10.15.0.cl or later **Deprecated** — Use `sendAgentConversationMessage` instead. Send natural language messages to an existing Spotter agent conversation and returns the complete response synchronously. Requires `CAN_USE_SPOTTER` privilege and access to the metadata object associated with the conversation. The user must have access to the conversation session referenced by `conversation_identifier`. A conversation must first be created using the `createAgentConversation` API. #### Usage guidelines The request must include: - `conversation_identifier`: the unique session ID returned by `createAgentConversation`, used for context continuity and message tracking - `messages`: an array of one or more text messages to send to the agent The API returns an array of response objects, each containing: - `type`: the kind of response — `text`, `answer`, or `error` - `message`: the main content of the response - `metadata`: additional information depending on the message type (e.g., answer metadata includes analytics and visualization details) #### Error responses | Code | Description | |------|----------------------------------------------------------------------------------------------------------------------------------| | 401 | Unauthorized — authentication token is missing, expired, or invalid. | | 403 | Forbidden — the authenticated user does not have `CAN_USE_SPOTTER` privilege or lacks permission on the referenced conversation. | > ###### Note: > > - This endpoint is deprecated. Use `sendAgentConversationMessage` for new integrations. > - This endpoint is currently in Beta. Breaking changes may be introduced before the endpoint is made Generally Available. > - This endpoint requires Spotter - please contact ThoughtSpot support to enable Spotter on your cluster. * @param param the request object */ public sendAgentMessage(param: AIApiSendAgentMessageRequest, options?: Configuration): Promise { return this.api.sendAgentMessage(param.conversationIdentifier, param.sendAgentMessageRequest, options).toPromise(); } /** * Version: 10.13.0.cl or later **Deprecated** — Use `sendAgentConversationMessageStreaming` instead. Sends one or more natural language messages to an existing Spotter agent conversation and returns the response as a real-time Server-Sent Events stream. Requires `CAN_USE_SPOTTER` privilege and access to the metadata object associated with the conversation. The user must have access to the conversation session referenced by `conversation_identifier`. A conversation must first be created using the `createAgentConversation` API. #### Usage guidelines The request must include: - `conversation_identifier`: the unique session ID returned by `createAgentConversation`, used for context continuity and message tracking - `messages`: an array of one or more text messages to send to the agent If the request is valid, the API returns a Server-Sent Events (SSE) stream. Each line has the form `data: [{\"type\": \"...\", ...}]` — a JSON array of event objects. Event types include: - `ack`: confirms receipt of the request (`node_id`) - `conv_title`: conversation title (`title`, `conv_id`) - `notification`: status updates on operations (`group_id`, `metadata`, `code` — e.g. `TOOL_CALL_NOTIFICATION`, `nls_start`, `FINAL_RESPONSE_NOTIFICATION`) - `text-chunk`: incremental content chunks (`id`, `group_id`, `metadata` with `format` and `type` such as `thinking` or `text`, `content`) - `text`: full text block with same structure as `text-chunk` - `answer`: structured answer with metadata (`id`, `group_id`, `metadata` with `sage_query`, `session_id`, `title`, etc., `title`) - `error`: if a failure occurs #### Error responses | Code | Description | |------|----------------------------------------------------------------------------------------------------------------------------------| | 401 | Unauthorized — authentication token is missing, expired, or invalid. | | 403 | Forbidden — the authenticated user does not have `CAN_USE_SPOTTER` privilege or lacks permission on the referenced conversation. | > ###### Note: > > - This endpoint is deprecated. Use `sendAgentConversationMessageStreaming` for new integrations. > - This endpoint is currently in Beta. Breaking changes may be introduced before the endpoint is made Generally Available. > - This endpoint requires Spotter - please contact ThoughtSpot support to enable Spotter on your cluster. > - The streaming protocol uses Server-Sent Events (SSE). * @param param the request object */ public sendAgentMessageStreaming(param: AIApiSendAgentMessageStreamingRequest, options?: Configuration): Promise { return this.api.sendAgentMessageStreaming(param.sendAgentMessageStreamingRequest, options).toPromise(); } /** * Version: 10.4.0.cl or later Sends a follow-up message to an existing conversation within the context of a data model. Requires `CAN_USE_SPOTTER` privilege and at least view access to the metadata object specified in the request. A conversation must first be created using the `createConversation` API. #### Usage guidelines The request must include: - `conversation_identifier`: the unique session ID returned by `createConversation` - `metadata_identifier`: the unique ID of the data source used for the conversation - `message`: a natural language string with the follow-up question If the request is successful, the API returns an array of response messages, each containing: - `session_identifier`: the unique ID of the generated response - `generation_number`: the generation number of the response - `message_type`: the type of the response (e.g., `TSAnswer`) - `visualization_type`: the generated visualization type (`Chart`, `Table`, or `Undefined`) - `tokens` / `display_tokens`: the search tokens and user-friendly display tokens for the response #### Error responses | Code | Description | |------|-----------------------------------------------------------------------------------------------------------------------------------------| | 401 | Unauthorized — authentication token is missing, expired, or invalid. | | 403 | Forbidden — the authenticated user does not have `CAN_USE_SPOTTER` privilege or lacks view permission on the specified metadata object. | > ###### Note: > * This endpoint is currently in Beta. Breaking changes may be introduced before the endpoint is made Generally Available. > * This endpoint requires Spotter - please contact ThoughtSpot support to enable Spotter on your cluster. * @param param the request object */ public sendMessage(param: AIApiSendMessageRequest, options?: Configuration): Promise> { return this.api.sendMessage(param.conversationIdentifier, param.sendMessageRequest, options).toPromise(); } /** * Version: 10.15.0.cl or later This API allows users to set natural language (NL) instructions for a specific data-model to improve AI-generated answers and query processing. These instructions help guide the AI system to better understand the data context and provide more accurate responses. Requires `CAN_USE_SPOTTER` privilege, either edit access or `SPOTTER_COACHING_PRIVILEGE` on the data model, and a bearer token corresponding to the org where the data model exists. #### Usage guidelines To set NL instructions for a data-model, the request must include: - `data_source_identifier`: The unique ID of the data-model for which to set NL instructions - `nl_instructions_info`: An array of instruction objects, each containing: - `instructions`: Array of text instructions for the LLM - `scope`: The scope of the instruction (`GLOBAL`). Currently only `GLOBAL` is supported. It can be extended to data-model-user scope in future. #### Instructions scope - **GLOBAL**: instructions that apply to all users querying this data model If the request is successful, the API returns: - `success`: a boolean indicating whether the operation completed successfully #### Error responses | Code | Description | |------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | 401 | Unauthorized — authentication token is missing, expired, or invalid. | | 403 | Forbidden — the authenticated user does not have `CAN_USE_SPOTTER` privilege, lacks edit access or `SPOTTER_COACHING_PRIVILEGE` on the data model, or the bearer token does not correspond to the org where the data model exists. | > ###### Note: > > - To use this API, the user needs either edit access or `SPOTTER_COACHING_PRIVILEGE` on the data model, and must use the bearer token corresponding to the org where the data model exists. > - This endpoint is currently in Beta. Breaking changes may be introduced before the endpoint is made Generally Available. > - Available from version 10.15.0.cl and later. > - This endpoint requires Spotter — please contact ThoughtSpot Support to enable Spotter on your cluster. > - Instructions help improve the accuracy and relevance of AI-generated responses for the specified data-model. * @param param the request object */ public setNLInstructions(param: AIApiSetNLInstructionsRequest, options?: Configuration): Promise { return this.api.setNLInstructions(param.setNLInstructionsRequest, options).toPromise(); } /** * Version: 10.4.0.cl or later Processes a natural language query against a specified data model and returns a single AI-generated answer without requiring a conversation session. Requires `CAN_USE_SPOTTER` privilege and at least view access to the metadata object specified in the request. #### Usage guidelines The request must include: - `query`: a natural language question (e.g., \"What were total sales last quarter?\") - `metadata_identifier`: the unique ID of the data source to query against If the request is successful, the API returns a response message containing: - `session_identifier`: the unique ID of the generated response - `generation_number`: the generation number of the response - `message_type`: the type of the response (e.g., `TSAnswer`) - `visualization_type`: the generated visualization type (`Chart`, `Table`, or `Undefined`) - `tokens` / `display_tokens`: the search tokens and user-friendly display tokens for the response #### Error responses | Code | Description | |------|-----------------------------------------------------------------------------------------------------------------------------------------| | 401 | Unauthorized — authentication token is missing, expired, or invalid. | | 403 | Forbidden — the authenticated user does not have `CAN_USE_SPOTTER` privilege or lacks view permission on the specified metadata object. | > ###### Note: > * This endpoint is currently in Beta. Breaking changes may be introduced before the endpoint is made Generally Available. > * This endpoint requires Spotter - please contact ThoughtSpot support to enable Spotter on your cluster. * @param param the request object */ public singleAnswer(param: AIApiSingleAnswerRequest, options?: Configuration): Promise { return this.api.singleAnswer(param.singleAnswerRequest, options).toPromise(); } } import { ObservableAuthenticationApi } from "./ObservableAPI"; import { AuthenticationApiRequestFactory, AuthenticationApiResponseProcessor} from "../apis/AuthenticationApi"; export interface AuthenticationApiGetCurrentUserInfoRequest { } export interface AuthenticationApiGetCurrentUserTokenRequest { } export interface AuthenticationApiGetCustomAccessTokenRequest { /** * * @type GetCustomAccessTokenRequest * @memberof AuthenticationApigetCustomAccessToken */ getCustomAccessTokenRequest: GetCustomAccessTokenRequest } export interface AuthenticationApiGetFullAccessTokenRequest { /** * * @type GetFullAccessTokenRequest * @memberof AuthenticationApigetFullAccessToken */ getFullAccessTokenRequest: GetFullAccessTokenRequest } export interface AuthenticationApiGetObjectAccessTokenRequest { /** * * @type GetObjectAccessTokenRequest * @memberof AuthenticationApigetObjectAccessToken */ getObjectAccessTokenRequest: GetObjectAccessTokenRequest } export interface AuthenticationApiLoginRequest { /** * * @type LoginRequest * @memberof AuthenticationApilogin */ loginRequest: LoginRequest } export interface AuthenticationApiLogoutRequest { } export interface AuthenticationApiRevokeTokenRequest { /** * * @type RevokeTokenRequest * @memberof AuthenticationApirevokeToken */ revokeTokenRequest: RevokeTokenRequest } export interface AuthenticationApiValidateTokenRequest { /** * * @type ValidateTokenRequest * @memberof AuthenticationApivalidateToken */ validateTokenRequest: ValidateTokenRequest } export class ObjectAuthenticationApi { private api: ObservableAuthenticationApi public constructor(configuration: Configuration, requestFactory?: AuthenticationApiRequestFactory, responseProcessor?: AuthenticationApiResponseProcessor) { this.api = new ObservableAuthenticationApi(configuration, requestFactory, responseProcessor); } /** * Version: 9.0.0.cl or later Retrieves details of the current user session for the token provided in the request header. Any ThoughtSpot user can access this endpoint and send an API request. The data returned in the API response varies according to user\'s privilege and object access permissions. **NOTE**: In ThoughtSpot, users with cluster administration privileges can access all Orgs by default. However, unless the administrator is explicitly added to an Org, the Orgs list in the session information returned by the API will include only the Primary Org. To include other Orgs in the API response, you must explicitly add the administrator to each Org in the Admin settings page in the UI or via user REST API. * @param param the request object */ public getCurrentUserInfo(param: AuthenticationApiGetCurrentUserInfoRequest = {}, options?: Configuration): Promise { return this.api.getCurrentUserInfo( options).toPromise(); } /** * Version: 9.4.0.cl or later Retrieves details of the current session token for the bearer token provided in the request header. This API endpoint does not create a new token. Instead, it returns details about the token, including the token string, creation time, expiration time, and the associated user. Use this endpoint to introspect your current session token, debug authentication issues, or when a frontend application needs session token details. Any ThoughtSpot user with a valid bearer token can access this endpoint and send an API request * @param param the request object */ public getCurrentUserToken(param: AuthenticationApiGetCurrentUserTokenRequest = {}, options?: Configuration): Promise { return this.api.getCurrentUserToken( options).toPromise(); } /** * Version: 10.4.0.cl or later Creates an authentication token that provides values for the formula variables in the Row Level Security (RLS) rules for a given user. Recommended for use cases that require Attribute-based access control (ABAC) via RLS. #### Required privileges To add a new user and assign privileges during auto-creation, the `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege is required. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled, the `CONTROL_TRUSTED_AUTH` (**Can Enable or Disable Trusted Authentication**) privilege and edit access to the data source are required. To configure formula variables for all Orgs on your instance or the Primary Org, cluster administration privileges are required. Org administrators can configure formula variables for their respective Orgs. If Role-Based Access Control (RBAC) is enabled, users with the `CAN_MANAGE_VARIABLES` (**Can manage variables**) role privilege can also create and manage variables for their Org context. #### Usage guidelines You can generate a token by providing a `username` and `password`, or by using a `secret_key`. To generate a `secret_key`, the administrator must enable [Trusted authentication](https://developers.thoughtspot.com/docs/trusted-auth-secret-key) in the **Develop** > **Customizations** > **Security Settings** page. **Note**: * When both `password` and `secret_key` are included in the API request, `password` takes precedence. * If [Multi-Factor Authentication (MFA)](https://docs.thoughtspot.com/cloud/latest/authentication-local-mfa) is enabled on your instance, the API login request with `username` and `password` returns an error. You can switch to token-based authentication with `secret_key` or contact ThoughtSpot Support for assistance. The token obtained from ThoughtSpot is valid for 5 minutes by default. You can configure the token expiration time as required. #### ABAC via RLS To implement ABAC via RLS and assign security entitlements to users during session creation, generate a token with custom variable values. The values set in the authentication token are applied to the formula variables referenced in RLS rules at the table level, which determines the data each user can access based on their entitlements. The variable values can be configured to persist for a specific set of Models in user sessions initiated with the token, allowing different RLS rules to be set for different data models. Once defined, the rules are added to the user\'s `variable_values` object, after which all sessions will use the persisted values. For more information, see [ABAC via tokens Documentation](https://developers.thoughtspot.com/docs/abac-via-rls-variables). ##### Formula variables Before defining variable values, ensure the variables are created and available on your instance. To create a formula variable, you can use the **Create variable** (`/api/rest/2.0/template/variables/create`) REST API endpoint, with the variable `type` set as `Formula_Variable` in the API request. The API doesn\'t support `\"persist_option\": \"RESET\"` and `\"persist_option\": \"NONE\"` when `variable_values` are defined in the request. If you are using `variable_values` for token generation, you must use other supported persist options such as `APPEND` or `REPLACE`. If you want to use `RESET` or `NONE`, do not pass any `variable_values`. In such cases, `variable_values` will remain unaffected. #### Supported objects The supported object type is `LOGICAL_TABLE`. When using `object_id` with `variable_values`, models are supported. #### Just-in-time provisioning For [just-in-time user creation and provisioning](https://developers.thoughtspot.com/docs/just-in-time-provisioning), specify the following attributes in the API request: * `auto_create` * `username` * `display_name` * `email` * `groups` Set `auto_create` to `true` if the username does not exist in ThoughtSpot. If the username already exists in ThoughtSpot and `auto_create` is set to `true`, user properties such as display name, email, Org and group entitlements will not be updated with new values. Setting `auto_create` to `true` does not create formula variables. Hence, this setting will not be applicable to `variable_values`. #### Important point to note All options in the token creation APIs that define user access to data in ThoughtSpot will take effect during token creation, not when the token is used for authentication. For example, `auto_create:true` will create the user when the authentication token is created. Persist options such as `APPEND` and `REPLACE` will persist `variable_values` on the user profile when the token is created. * @param param the request object */ public getCustomAccessToken(param: AuthenticationApiGetCustomAccessTokenRequest, options?: Configuration): Promise { return this.api.getCustomAccessToken(param.getCustomAccessTokenRequest, options).toPromise(); } /** * Version: 9.0.0.cl or later Generates an authentication token for creating a full session in ThoughtSpot for a given user. Recommended for use cases that do not require Attribute-based access control (ABAC) via Row Level Security (RLS). #### Usage guidelines You can generate a token for a user by providing a `username` and `password`, or by using the `secret_key` generated for your instance. To generate a `secret_key`, the administrator must enable [Trusted authentication](https://developers.thoughtspot.com/docs/trusted-auth-secret-key) in the **Develop** > **Customizations** > **Security Settings** page. **Note**: * When both `password` and `secret_key` are included in the API request, `password` takes precedence. * If [Multi-Factor Authentication (MFA)](https://docs.thoughtspot.com/cloud/latest/authentication-local-mfa) is enabled on your instance, the API login request with `username` and `password` returns an error. You can switch to token-based authentication with `secret_key` or contact ThoughtSpot Support for assistance. The token obtained from ThoughtSpot is valid for 5 minutes by default. You can configure the token expiration time as required. #### Just-in-time provisioning For [just-in-time user creation and provisioning](https://developers.thoughtspot.com/docs/just-in-time-provisioning), specify the following attributes in the API request: * `auto_create` * `username` * `display_name` * `email` * `group_identifiers` Set `auto_create` to `true` if the username does not exist in ThoughtSpot. If the user already exists in ThoughtSpot and `auto_create` is set to `true`, user properties such as display name, email and group assignment will be updated. To add a new user and assign privileges during auto-creation, the `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege is required. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled, the `CONTROL_TRUSTED_AUTH` (**Can Enable or Disable Trusted Authentication**) privilege is required. #### Important point to note All options in the token creation APIs that define user access to data in ThoughtSpot will take effect during token creation, not when the token is used for authentication. For example, `auto_create:true` will create the user when the authentication token is created. * @param param the request object */ public getFullAccessToken(param: AuthenticationApiGetFullAccessTokenRequest, options?: Configuration): Promise { return this.api.getFullAccessToken(param.getFullAccessTokenRequest, options).toPromise(); } /** * Version: 9.0.0.cl or later Generates an authentication token that provides access to a specific metadata object. This object list is intersected with the list of objects the user is allowed to access via group membership. For more information, see [Object security](https://docs.thoughtspot.com/cloud/latest/security-data-object#object_security). #### Usage guidelines You can generate a token for a user by providing a `username` and `password`, or by using the `secret_key` generated for your instance. To generate a `secret_key`, the administrator must enable [Trusted authentication](https://developers.thoughtspot.com/docs/trusted-auth-secret-key) in the **Develop** > **Customizations** > **Security Settings** page. **Note**: * When both `password` and `secret_key` are included in the API request, `password` takes precedence. * If [Multi-Factor Authentication (MFA)](https://docs.thoughtspot.com/cloud/latest/authentication-local-mfa) is enabled on your instance, the API login request with `username` and `password` returns an error. You can switch to token-based authentication with `secret_key` or contact ThoughtSpot Support for assistance. The token obtained from ThoughtSpot is valid for 5 minutes by default. You can configure the token expiration time as required. #### Just-in-time provisioning For [just-in-time user creation and provisioning](https://developers.thoughtspot.com/docs/just-in-time-provisioning), specify the following attributes in the API request: * `auto_create` * `username` * `display_name` * `email` * `group_identifiers` Set `auto_create` to `true` if the user is not available in ThoughtSpot. If the user already exists in ThoughtSpot and the `auto_create` parameter is set to `true`, user properties such as display name, email, and group assignment will be updated. To add a new user and assign privileges, the `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege is required. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled, the `CONTROL_TRUSTED_AUTH`(**Can Enable or Disable Trusted Authentication**) privilege is required. #### Important point to note All options in the token creation APIs that define user access to data in ThoughtSpot will take effect during token creation, not when the token is used for authentication. For example, `auto_create:true` will create the user when the authentication token is created. * @param param the request object */ public getObjectAccessToken(param: AuthenticationApiGetObjectAccessTokenRequest, options?: Configuration): Promise { return this.api.getObjectAccessToken(param.getObjectAccessTokenRequest, options).toPromise(); } /** * Version: 9.0.0.cl or later Creates a login session for a ThoughtSpot user with Basic authentication. In Basic authentication method, REST clients log in to ThoughtSpot using `username` and `password` attributes. On a multi-tenant cluster with Orgs, users can pass the ID of the Org in the API request to log in to a specific Org context. **Note**: If Multi-Factor Authentication (MFA) is enabled on your instance, the API login request with basic authentication (`username` and `password` ) returns an error. Contact ThoughtSpot Support for assistance. A successful login returns a session cookie that can be used in your subsequent API requests. * @param param the request object */ public login(param: AuthenticationApiLoginRequest, options?: Configuration): Promise { return this.api.login(param.loginRequest, options).toPromise(); } /** * Version: 9.0.0.cl or later Logs out a user from their current session. * @param param the request object */ public logout(param: AuthenticationApiLogoutRequest = {}, options?: Configuration): Promise { return this.api.logout( options).toPromise(); } /** * Version: 9.0.0.cl or later Revokes the authentication token issued for current user session. The token of your current session expires when you make a call to the `/api/rest/2.0/auth/token/revoke` endpoint. the users will not be able to access ThoughtSpot objects until a new token is obtained. To restart your session, request for a new token from ThoughtSpot. See [Get Full Access Token](#/http/api-endpoints/authentication/get-full-access-token). * @param param the request object */ public revokeToken(param: AuthenticationApiRevokeTokenRequest, options?: Configuration): Promise { return this.api.revokeToken(param.revokeTokenRequest, options).toPromise(); } /** * Version: 9.12.0.cl or later Validates the authentication token specified in the API request. If your token is not valid, [Get a new token](#/http/api-endpoints/authentication/get-full-access-token). * @param param the request object */ public validateToken(param: AuthenticationApiValidateTokenRequest, options?: Configuration): Promise { return this.api.validateToken(param.validateTokenRequest, options).toPromise(); } } import { ObservableCollectionsApi } from "./ObservableAPI"; import { CollectionsApiRequestFactory, CollectionsApiResponseProcessor} from "../apis/CollectionsApi"; export interface CollectionsApiCreateCollectionRequest { /** * * @type CreateCollectionRequest * @memberof CollectionsApicreateCollection */ createCollectionRequest: CreateCollectionRequest } export interface CollectionsApiDeleteCollectionRequest { /** * * @type DeleteCollectionRequest * @memberof CollectionsApideleteCollection */ deleteCollectionRequest: DeleteCollectionRequest } export interface CollectionsApiSearchCollectionsRequest { /** * * @type SearchCollectionsRequest * @memberof CollectionsApisearchCollections */ searchCollectionsRequest: SearchCollectionsRequest } export interface CollectionsApiUpdateCollectionRequest { /** * Unique GUID of the collection. Note: Collection names cannot be used as identifiers since duplicate names are allowed. * @type string * @memberof CollectionsApiupdateCollection */ collectionIdentifier: string /** * * @type UpdateCollectionRequest * @memberof CollectionsApiupdateCollection */ updateCollectionRequest: UpdateCollectionRequest } export class ObjectCollectionsApi { private api: ObservableCollectionsApi public constructor(configuration: Configuration, requestFactory?: CollectionsApiRequestFactory, responseProcessor?: CollectionsApiResponseProcessor) { this.api = new ObservableCollectionsApi(configuration, requestFactory, responseProcessor); } /** * Version: 26.4.0.cl or later Creates a new collection in ThoughtSpot. Collections allow you to organize and group related metadata objects such as Liveboards, Answers, worksheets, and other data objects. You can also create nested collections (sub-collections) to build a hierarchical structure. #### Supported operations The API endpoint lets you perform the following operations: * Create a new collection * Add metadata objects (Liveboards, Answers, Logical Tables) to the collection * Create nested collections by adding sub-collections * @param param the request object */ public createCollection(param: CollectionsApiCreateCollectionRequest, options?: Configuration): Promise { return this.api.createCollection(param.createCollectionRequest, options).toPromise(); } /** * Version: 26.4.0.cl or later Deletes one or more collections from ThoughtSpot. #### Delete options * **delete_children**: When set to `true`, deletes the child objects (metadata items) within the collection that the user has access to. Objects that the user does not have permission to delete will be skipped. * **dry_run**: When set to `true`, performs a preview of the deletion operation without actually deleting anything. The response shows what would be deleted, allowing you to review before committing the deletion. #### Response The response includes: * **metadata_deleted**: List of metadata objects that were successfully deleted * **metadata_skipped**: List of metadata objects that were skipped due to lack of permissions or other constraints * @param param the request object */ public deleteCollection(param: CollectionsApiDeleteCollectionRequest, options?: Configuration): Promise { return this.api.deleteCollection(param.deleteCollectionRequest, options).toPromise(); } /** * Version: 26.4.0.cl or later Gets a list of collections available in ThoughtSpot. To get details of a specific collection, specify the collection GUID or name. You can also filter the API response based on the collection name pattern, author, and other criteria. #### Search options * **name_pattern**: Use \'%\' as a wildcard character to match collection names * **collection_identifiers**: Search for specific collections by their GUIDs or names * **include_metadata**: When set to `true`, includes the metadata objects within each collection in the response **NOTE**: If the API returns an empty list, consider increasing the value of the `record_size` parameter. To search across all available collections, set `record_size` to `-1`. * @param param the request object */ public searchCollections(param: CollectionsApiSearchCollectionsRequest, options?: Configuration): Promise { return this.api.searchCollections(param.searchCollectionsRequest, options).toPromise(); } /** * Version: 26.4.0.cl or later Updates an existing collection in ThoughtSpot. #### Supported operations This API endpoint lets you perform the following operations: * Update collection name and description * Change visibility settings * Add metadata objects to the collection (operation: ADD) * Remove metadata objects from the collection (operation: REMOVE) * Replace all metadata objects in the collection (operation: REPLACE) #### Operation types * **ADD**: Adds the specified metadata objects to the existing collection without removing current items * **REMOVE**: Removes only the specified metadata objects from the collection * **REPLACE**: Replaces all existing metadata objects with the specified items (default behavior) * @param param the request object */ public updateCollection(param: CollectionsApiUpdateCollectionRequest, options?: Configuration): Promise { return this.api.updateCollection(param.collectionIdentifier, param.updateCollectionRequest, options).toPromise(); } } import { ObservableConnectionConfigurationsApi } from "./ObservableAPI"; import { ConnectionConfigurationsApiRequestFactory, ConnectionConfigurationsApiResponseProcessor} from "../apis/ConnectionConfigurationsApi"; export interface ConnectionConfigurationsApiConnectionConfigurationSearchRequest { /** * * @type ConnectionConfigurationSearchRequest * @memberof ConnectionConfigurationsApiconnectionConfigurationSearch */ connectionConfigurationSearchRequest: ConnectionConfigurationSearchRequest } export interface ConnectionConfigurationsApiCreateConnectionConfigurationRequest { /** * * @type CreateConnectionConfigurationRequest * @memberof ConnectionConfigurationsApicreateConnectionConfiguration */ createConnectionConfigurationRequest: CreateConnectionConfigurationRequest } export interface ConnectionConfigurationsApiDeleteConnectionConfigurationRequest { /** * * @type DeleteConnectionConfigurationRequest * @memberof ConnectionConfigurationsApideleteConnectionConfiguration */ deleteConnectionConfigurationRequest: DeleteConnectionConfigurationRequest } export interface ConnectionConfigurationsApiUpdateConnectionConfigurationRequest { /** * Unique ID or name of the configuration. * @type string * @memberof ConnectionConfigurationsApiupdateConnectionConfiguration */ configurationIdentifier: string /** * * @type UpdateConnectionConfigurationRequest * @memberof ConnectionConfigurationsApiupdateConnectionConfiguration */ updateConnectionConfigurationRequest: UpdateConnectionConfigurationRequest } export class ObjectConnectionConfigurationsApi { private api: ObservableConnectionConfigurationsApi public constructor(configuration: Configuration, requestFactory?: ConnectionConfigurationsApiRequestFactory, responseProcessor?: ConnectionConfigurationsApiResponseProcessor) { this.api = new ObservableConnectionConfigurationsApi(configuration, requestFactory, responseProcessor); } /** * Version: 10.12.0.cl or later Gets connection configuration objects. Requires `DATAMANAGEMENT` (**Can manage data**) and edit permissions to the connection object, or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**) privilege is required. #### Usage guidelines * To get a list of all configurations available in the ThoughtSpot system, send the API request with only the connection name or GUID in the request body. * To fetch details of a configuration object, specify the configuration object name or GUID. * @param param the request object */ public connectionConfigurationSearch(param: ConnectionConfigurationsApiConnectionConfigurationSearchRequest, options?: Configuration): Promise> { return this.api.connectionConfigurationSearch(param.connectionConfigurationSearchRequest, options).toPromise(); } /** * Version: 10.12.0.cl or later Creates an additional configuration to an existing connection to a data warehouse. Requires `DATAMANAGEMENT` (**Can manage data**) or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**) privilege is required. #### Usage guidelines * A JSON map of configuration attributes in `configuration`. The following example shows the configuration attributes: ``` { \"user\":\"DEV_USER\", \"password\":\"TestConn123\", \"role\":\"DEV\", \"warehouse\":\"DEV_WH\" } ``` * If the `policy_type` is `PRINCIPALS`, then `policy_principals` is a required field. * If the `policy_type` is `PROCESSES`, then `policy_processes` is a required field. * If the `policy_type` is `NO_POLICY`, then `policy_principals` and `policy_processes` are not required fields. #### Parameterized Connection Support For parameterized connections that use OAuth authentication, only the same_as_parent and policy_process_options attributes are allowed in the API request. These attributes are not applicable to connections that are not parameterized. * @param param the request object */ public createConnectionConfiguration(param: ConnectionConfigurationsApiCreateConnectionConfigurationRequest, options?: Configuration): Promise { return this.api.createConnectionConfiguration(param.createConnectionConfigurationRequest, options).toPromise(); } /** * Version: 10.12.0.cl or later Deletes connection configuration objects. Requires `DATAMANAGEMENT` (**Can manage data**) and edit permissions to the connection object, or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**) privilege is required. * @param param the request object */ public deleteConnectionConfiguration(param: ConnectionConfigurationsApiDeleteConnectionConfigurationRequest, options?: Configuration): Promise { return this.api.deleteConnectionConfiguration(param.deleteConnectionConfigurationRequest, options).toPromise(); } /** * Version: 10.12.0.cl or later Updates a connection configuration object. Requires `DATAMANAGEMENT` (**Can manage data**) and edit permissions to the connection object, or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**) privilege is required. #### Supported operations This API endpoint lets you perform the following operations in a single API request: * Edit the name or description of the configuration * Edit the configuration properties * Edit the `policy_type` * Edit the type of authentication * Enable or disable a configuration #### Parameterized Connection Support For parameterized oauth based connections, only the `same_as_parent` and `policy_process_options` attributes are allowed. These attributes are not applicable to connections that are not parameterized. **NOTE**: When updating a configuration where `disabled` is `true`, you must reset `disabled` to `true` in your update request payload. If not explicitly set again, the API will default `disabled` to `false`. * @param param the request object */ public updateConnectionConfiguration(param: ConnectionConfigurationsApiUpdateConnectionConfigurationRequest, options?: Configuration): Promise { return this.api.updateConnectionConfiguration(param.configurationIdentifier, param.updateConnectionConfigurationRequest, options).toPromise(); } } import { ObservableConnectionsApi } from "./ObservableAPI"; import { ConnectionsApiRequestFactory, ConnectionsApiResponseProcessor} from "../apis/ConnectionsApi"; export interface ConnectionsApiCreateConnectionRequest { /** * * @type CreateConnectionRequest * @memberof ConnectionsApicreateConnection */ createConnectionRequest: CreateConnectionRequest } export interface ConnectionsApiDeleteConnectionRequest { /** * * @type DeleteConnectionRequest * @memberof ConnectionsApideleteConnection */ deleteConnectionRequest: DeleteConnectionRequest } export interface ConnectionsApiDeleteConnectionV2Request { /** * Unique ID or name of the connection. * @type string * @memberof ConnectionsApideleteConnectionV2 */ connectionIdentifier: string } export interface ConnectionsApiDownloadConnectionMetadataChangesRequest { /** * GUID of the connection * @type string * @memberof ConnectionsApidownloadConnectionMetadataChanges */ connectionIdentifier: string } export interface ConnectionsApiFetchConnectionDiffStatusRequest { /** * GUID of the connection * @type string * @memberof ConnectionsApifetchConnectionDiffStatus */ connectionIdentifier: string } export interface ConnectionsApiRevokeRefreshTokensRequest { /** * Unique ID or name of the connection whose refresh tokens need to be revoked. All the users associated with the connection will have their refresh tokens revoked except the author. * @type string * @memberof ConnectionsApirevokeRefreshTokens */ connectionIdentifier: string /** * * @type RevokeRefreshTokensRequest * @memberof ConnectionsApirevokeRefreshTokens */ revokeRefreshTokensRequest: RevokeRefreshTokensRequest } export interface ConnectionsApiSearchConnectionRequest { /** * * @type SearchConnectionRequest * @memberof ConnectionsApisearchConnection */ searchConnectionRequest: SearchConnectionRequest } export interface ConnectionsApiUpdateConnectionRequest { /** * * @type UpdateConnectionRequest * @memberof ConnectionsApiupdateConnection */ updateConnectionRequest: UpdateConnectionRequest } export interface ConnectionsApiUpdateConnectionV2Request { /** * Unique ID or name of the connection. * @type string * @memberof ConnectionsApiupdateConnectionV2 */ connectionIdentifier: string /** * * @type UpdateConnectionV2Request * @memberof ConnectionsApiupdateConnectionV2 */ updateConnectionV2Request: UpdateConnectionV2Request } export class ObjectConnectionsApi { private api: ObservableConnectionsApi public constructor(configuration: Configuration, requestFactory?: ConnectionsApiRequestFactory, responseProcessor?: ConnectionsApiResponseProcessor) { this.api = new ObservableConnectionsApi(configuration, requestFactory, responseProcessor); } /** * Version: 9.2.0.cl or later Creates a connection to a data warehouse for live query services. Requires `DATAMANAGEMENT` (**Can manage data**) or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**) privilege is required. #### Create a connection without tables To create a connection without tables: 1. Pass these parameters in your API request. * Name of the connection. * Type of the data warehouse to connect to. * A JSON map of configuration attributes in `data_warehouse_config`. The following example shows the configuration attributes for a SnowFlake connection: ``` { \"configuration\":{ \"accountName\":\"thoughtspot_partner\", \"user\":\"tsadmin\", \"password\":\"TestConn123\", \"role\":\"sysadmin\", \"warehouse\":\"MEDIUM_WH\" }, \"authenticationType\": \"SERVICE_ACCOUNT\", \"externalDatabases\":[ ] } ``` 2. Set `validate` to `false`. **NOTE:** If the `authentication_type` is anything other than SERVICE_ACCOUNT, you must explicitly provide the authenticationType property in the payload. If you do not specify authenticationType, the API will default to SERVICE_ACCOUNT as the authentication type. #### Create a connection with tables If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**) and `CAN_MANAGE_WORKSHEET_VIEWS_TABLES` (**Can manage data models**) privilege is required. To create a connection with tables: 1. Pass these parameters in your API request. * Name of the connection. * Type of the data warehouse to connect to. * A JSON map of configuration attributes, database details, and table properties in `data_warehouse_config` as shown in the following example: ``` { \"configuration\":{ \"accountName\":\"thoughtspot_partner\", \"user\":\"tsadmin\", \"password\":\"TestConn123\", \"role\":\"sysadmin\", \"warehouse\":\"MEDIUM_WH\" }, \"authenticationType\": \"SERVICE_ACCOUNT\", \"externalDatabases\":[ { \"name\":\"AllDatatypes\", \"isAutoCreated\":false, \"schemas\":[ { \"name\":\"alldatatypes\", \"tables\":[ { \"name\":\"allDatatypes\", \"type\":\"TABLE\", \"description\":\"\", \"selected\":true, \"linked\":true, \"columns\":[ { \"name\":\"CNUMBER\", \"type\":\"INT64\", \"canImport\":true, \"selected\":true, \"isLinkedActive\":true, \"isImported\":false, \"tableName\":\"allDatatypes\", \"schemaName\":\"alldatatypes\", \"dbName\":\"AllDatatypes\" }, { \"name\":\"CDECIMAL\", \"type\":\"INT64\", \"canImport\":true, \"selected\":true, \"isLinkedActive\":true, \"isImported\":false, \"tableName\":\"allDatatypes\", \"schemaName\":\"alldatatypes\", \"dbName\":\"AllDatatypes\" } ] } ] } ] } ] } ``` 2. Set `validate` to `true`. **NOTE:** If the `authentication_type` is anything other than SERVICE_ACCOUNT, you must explicitly provide the authenticationType property in the payload. If you do not specify authenticationType, the API will default to SERVICE_ACCOUNT as the authentication type. * @param param the request object */ public createConnection(param: ConnectionsApiCreateConnectionRequest, options?: Configuration): Promise { return this.api.createConnection(param.createConnectionRequest, options).toPromise(); } /** * Version: 9.2.0.cl or later **Important**: This endpoint is deprecated and will be removed from ThoughtSpot in September 2025. ThoughtSpot strongly recommends using the [Delete Connection V2](#/http/api-endpoints/connections/delete-connection-v2) endpoint to delete your connection objects. #### Usage guidelines Deletes a connection object. Requires `DATAMANAGEMENT` (**Can manage data**) and edit permissions to the connection object, or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**) privilege is required. **Note**: If a connection has dependent objects, make sure you remove its associations before the delete operation. * @param param the request object */ public deleteConnection(param: ConnectionsApiDeleteConnectionRequest, options?: Configuration): Promise { return this.api.deleteConnection(param.deleteConnectionRequest, options).toPromise(); } /** * Version: 10.4.0.cl or later Deletes a connection object. **Note**: If a connection has dependent objects, make sure you remove its associations before the delete operation. Requires `DATAMANAGEMENT` (**Can manage data**) and edit permissions to the connection object, or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**) privilege is required. * @param param the request object */ public deleteConnectionV2(param: ConnectionsApiDeleteConnectionV2Request, options?: Configuration): Promise { return this.api.deleteConnectionV2(param.connectionIdentifier, options).toPromise(); } /** * Version: 9.9.0.cl or later Exports the difference in connection metadata between CDW and ThoughtSpot Requires `DATAMANAGEMENT` (**Can manage data**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the following Data control privileges may be required: - `CAN_MANAGE_CUSTOM_CALENDAR`(**Can manage custom calendars**) - `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**) - `CAN_MANAGE_WORKSHEET_VIEWS_TABLES` (**Can manage data models**) To download the connection metadata difference between ThoughtSpot and CDW, pass the connection GUID as `connection_identifier` in the API request. * @param param the request object */ public downloadConnectionMetadataChanges(param: ConnectionsApiDownloadConnectionMetadataChangesRequest, options?: Configuration): Promise { return this.api.downloadConnectionMetadataChanges(param.connectionIdentifier, options).toPromise(); } /** * Version: 9.9.0.cl or later Validates the difference in connection metadata between CDW and ThoughtSpot. Requires `DATAMANAGEMENT` (**Can manage data**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the following Data control privileges may be required: - `CAN_MANAGE_CUSTOM_CALENDAR`(**Can manage custom calendars**) - `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**) - `CAN_MANAGE_WORKSHEET_VIEWS_TABLES` (**Can manage data models**) Returns a boolean indicating whether there is any difference between the connection metadata at ThoughtSpot and CDW. To get the connection metadata difference status, pass the connection GUID as `connection_identifier` in the API request. * @param param the request object */ public fetchConnectionDiffStatus(param: ConnectionsApiFetchConnectionDiffStatusRequest, options?: Configuration): Promise { return this.api.fetchConnectionDiffStatus(param.connectionIdentifier, options).toPromise(); } /** * Version: 26.2.0.cl or later Revokes OAuth refresh tokens for users who no longer require access to a data warehouse connection. When a token is revoked, the affected user\'s session for that connection is terminated, and they must re-authenticate to regain access. Requires `ADMINISTRATION` (**Can administer ThoughtSpot**) or `DATAMANAGEMENT` (**Can manage data**) privileges. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on the ThoughtSpot instance, users with `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**) privilege can also make API requests to revoke tokens for connection users. #### Usage guidelines You can specify different combinations of identifiers to control which refresh tokens are revoked. - **connection_identifier**: Revokes refresh tokens for all users of the connection, except the connection author. - **connection_identifier** and **user_identifiers**: Revokes refresh tokens only for the users specified in the request. If the name or ID of the connection author is included in the request, their token will also be revoked. - **connection_identifier** and **configuration_identifiers**: Revokes refresh tokens for all users on the specified configurations, except the configuration author. - **connection_identifier**, **configuration_identifiers**, and **user_identifiers**: Revokes refresh tokens for the specified users on the specified configurations. - **connection_identifier** and **org_identifiers**: Revokes refresh tokens for the specified Orgs. Applicable only for published connections. - **connection_identifier**, **org_identifiers**, and **user_identifiers**: Revokes refresh tokens for the specified users in the specified Orgs. Applicable only for published connections. **NOTE**: The `org_identifiers` parameter is only applicable for published connections. Using this parameter for unpublished connections will result in an error. Ensure that the connections are published before making the API request. * @param param the request object */ public revokeRefreshTokens(param: ConnectionsApiRevokeRefreshTokensRequest, options?: Configuration): Promise { return this.api.revokeRefreshTokens(param.connectionIdentifier, param.revokeRefreshTokensRequest, options).toPromise(); } /** * Version: 9.2.0.cl or later Gets connection objects. Requires `DATAMANAGEMENT` (**Can manage data**) or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**) privilege is required. - To get a list of all connections available in the ThoughtSpot system, send the API request without any attributes in the request body. - To get the connection objects for a specific type of data warehouse, specify the type in `data_warehouse_types`. - To fetch details of a connection object, specify the connection object GUID or name. The `name_pattern` attribute allows passing partial text with `%` for a wildcard match. - To get details of the database, schemas, tables, or columns from a data connection object, specify `data_warehouse_object_type`. - To get a specific database, schema, table, or column from a connection object, define the object type in `data_warehouse_object_type` and object properties in the `data_warehouse_objects` array. For example, to search for a column, you must pass the database, schema, and table names in the API request. Note that in the following example, object properties are set in a hierarchical order (`database` > `schema` > `table` > `column`). ``` { \"connections\": [ { \"identifier\": \"b9d1f2ef-fa65-4a4b-994e-30fa2d57b0c2\", \"data_warehouse_objects\": [ { \"database\": \"NEBULADEV\", \"schema\": \"INFORMATION_SCHEMA\", \"table\": \"APPLICABLE_ROLES\", \"column\": \"ROLE_NAME\" } ] } ], \"data_warehouse_object_type\": \"COLUMN\" } ``` - To fetch data by `configuration`, specify `data_warehouse_object_type`. For example, to fetch columns from the `DEVELOPMENT` database, specify the `data_warehouse_object_type` as `DATABASE` and define the `configuration` string as `{\"database\":\"DEVELOPMENT\"}`. To get column data for a specific table, specify the table, for example,`{\"database\":\"RETAILAPPAREL\",\"table\":\"PIPES\"}`. - To query connections by `authentication_type`, specify `data_warehouse_object_type`. Supported values for `authentication_type` are: - `SERVICE_ACCOUNT`: For connections that require service account credentials to authenticate to the Cloud Data Warehouse and fetch data. - `OAUTH`: For connections that require OAuth credentials to authenticate to the Cloud Data Warehouse and fetch data. Teradata, Oracle, and Presto Cloud Data Warehouses do not support the OAuth authentication type. - `IAM`: For connections that have the IAM OAuth set up. This authentication type is supported on Amazon Redshift connections only. - `EXTOAUTH`: For connections that have External OAuth set up. ThoughtSpot supports external [OAuth with Microsoft Azure Active Directory (AD)](https://docs.thoughtspot.com/cloud/latest/ connections-snowflake-azure-ad-oauth) and [Okta for Snowflake data connections](https://docs.thoughtspot.com/cloud/latest/connections-snowflake-okta-oauth). - `KEY_PAIR`: For connections that require Key Pair account credentials to authenticate to the Cloud Data Warehouse and fetch data. This authentication type is supported on Snowflake connections only. - `OAUTH_WITH_PKCE`: For connections that require OAuth with PKCE account credentials to authenticate to the Cloud Data Warehouse and fetch data. This authentication type is supported on Snowflake, Starburst, Databricks, Denodo connections only. - `EXTOAUTH_WITH_PKCE`: For connections that require External OAuth With PKCE account credentials to authenticate to the Cloud Data Warehouse and fetch data. This authentication type is supported on Snowflake connections only. - `OAUTH_WITH_PEZ`: For connections that require OAuth With PEZ account credentials to authenticate to the Cloud Data Warehouse and fetch data. This authentication type is supported on Amazon Redshift connections only. - `OAUTH_WITH_SERVICE_PRINCIPAL`: For connections that require OAuth With Service Principal account credentials to authenticate to the Cloud Data Warehouse and fetch data. This authentication type is supported on Databricks connections only. - `PERSONAL_ACCESS_TOKEN`: For connections that require Personal Access Token account credentials to authenticate to the Cloud Data Warehouse and fetch data. This authentication type is supported on Databricks connections only. - `OAUTH_CLIENT_CREDENTIALS`: For connections that require OAuth Client Credentials to authenticate to the Cloud Data Warehouse and fetch data. This authentication type is supported on Snowflake connections only. - To include more details about connection objects in the API response, set `include_details` to `true`. - You can also sort the output by field names and filter connections by tags. **NOTE**: When filtering connection records by parameters other than `data_warehouse_types` or `tag_identifiers`, ensure that you set `record_size` to `-1` and `record_offset` to `0` for precise results. * @param param the request object */ public searchConnection(param: ConnectionsApiSearchConnectionRequest, options?: Configuration): Promise> { return this.api.searchConnection(param.searchConnectionRequest, options).toPromise(); } /** * Version: 9.2.0.cl or later **Important**: This endpoint is deprecated and will be removed from ThoughtSpot in September 2025. ThoughtSpot strongly recommends using the [Update connection V2](#/http/api-endpoints/connections/update-connection-v2) endpoint to update your connection objects. #### Usage guidelines Updates a connection object. Requires `DATAMANAGEMENT` (**Can manage data**) and edit permissions to the connection object, or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**) privilege is required. To update a connection object, pass these parameters in your API request: 1. GUID of the connection object. 2. If you are updating tables or database schema of a connection object: a. Add the updated JSON map of metadata with database, schema, and tables in `data_warehouse_config`. b. Set `validate` to `true`. 3. If you are updating a configuration attribute, connection name, or description, you can set `validate` to `false`. * @param param the request object */ public updateConnection(param: ConnectionsApiUpdateConnectionRequest, options?: Configuration): Promise { return this.api.updateConnection(param.updateConnectionRequest, options).toPromise(); } /** * Version: 10.4.0.cl or later Updates a connection object. Requires `DATAMANAGEMENT` (**Can manage data**) and edit permissions to the connection object, or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**) privilege is required. To update a connection object, pass these parameters in your API request: 1. GUID of the connection object. 2. If you are updating tables or database schema of a connection object: a. Add the updated JSON map of metadata with database, schema, and tables in `data_warehouse_config`. b. Set `validate` to `true`. **NOTE:** If the `authentication_type` is anything other than SERVICE_ACCOUNT, you must explicitly provide the authenticationType property in the payload. If you do not specify authenticationType, the API will default to SERVICE_ACCOUNT as the authentication type. * A JSON map of configuration attributes, database details, and table properties in `data_warehouse_config` as shown in the following example: * This is an example of updating a single table in a empty connection: ``` { \"authenticationType\": \"SERVICE_ACCOUNT\", \"externalDatabases\": [ { \"name\": \"DEVELOPMENT\", \"isAutoCreated\": false, \"schemas\": [ { \"name\": \"TS_dataset\", \"tables\": [ { \"name\": \"DEMORENAME\", \"type\": \"TABLE\", \"description\": \"\", \"selected\": true, \"linked\": true, \"gid\": 0, \"datasetId\": \"-1\", \"subType\": \"\", \"reportId\": \"\", \"viewId\": \"\", \"columns\": [ { \"name\": \"Col1\", \"type\": \"VARCHAR\", \"canImport\": true, \"selected\": true, \"description\": \"\", \"isLinkedActive\": true, \"isAggregate\": false }, { \"name\": \"Col2\", \"type\": \"VARCHAR\", \"canImport\": true, \"selected\": true, \"description\": \"\", \"isLinkedActive\": true, \"isAggregate\": false }, { \"name\": \"Col3\", \"type\": \"VARCHAR\", \"canImport\": true, \"selected\": true, \"description\": \"\", \"isLinkedActive\": true, \"isAggregate\": false }, { \"name\": \"Col312\", \"type\": \"VARCHAR\", \"canImport\": true, \"selected\": true, \"description\": \"\", \"isLinkedActive\": true, \"isAggregate\": false }, { \"name\": \"Col4\", \"type\": \"VARCHAR\", \"canImport\": true, \"selected\": true, \"description\": \"\", \"isLinkedActive\": true, \"isAggregate\": false } ], \"relationships\": [] } ] } ] } ], \"configuration\": { \"password\": \"\", \"database\": \"DEVELOPMENT\", \"role\": \"DEV\", \"accountName\": \"thoughtspot_partner\", \"warehouse\": \"DEMO_WH\", \"user\": \"DEV_USER\" } } ``` * This is an example of updating a single table in an existing connection with tables: ``` { \"authenticationType\": \"SERVICE_ACCOUNT\", \"externalDatabases\": [ { \"name\": \"DEVELOPMENT\", \"isAutoCreated\": false, \"schemas\": [ { \"name\": \"TS_dataset\", \"tables\": [ { \"name\": \"CUSTOMER\", \"type\": \"TABLE\", \"description\": \"\", \"selected\": true, \"linked\": true, \"gid\": 0, \"datasetId\": \"-1\", \"subType\": \"\", \"reportId\": \"\", \"viewId\": \"\", \"columns\": [], \"relationships\": [] }, { \"name\": \"tpch5k_falcon_default_schema_users\", \"type\": \"TABLE\", \"description\": \"\", \"selected\": true, \"linked\": true, \"gid\": 0, \"datasetId\": \"-1\", \"subType\": \"\", \"reportId\": \"\", \"viewId\": \"\", \"columns\": [ { \"name\": \"user_id\", \"type\": \"INT64\", \"canImport\": true, \"selected\": true, \"description\": \"\", \"isLinkedActive\": true, \"isAggregate\": false }, { \"name\": \"product_id\", \"type\": \"INT64\", \"canImport\": true, \"selected\": true, \"description\": \"\", \"isLinkedActive\": true, \"isAggregate\": false }, { \"name\": \"user_cost\", \"type\": \"INT64\", \"canImport\": true, \"selected\": true, \"description\": \"\", \"isLinkedActive\": true, \"isAggregate\": false } ], \"relationships\": [] } ] } ] } ], \"configuration\": { \"password\": \"\", \"database\": \"DEVELOPMENT\", \"role\": \"DEV\", \"accountName\": \"thoughtspot_partner\", \"warehouse\": \"DEMO_WH\", \"user\": \"DEV_USER\" } } ``` 3. If you are updating a configuration attribute, connection name, or description, you can set `validate` to `false`. **NOTE:** If the `authentication_type` is anything other than SERVICE_ACCOUNT, you must explicitly provide the authenticationType property in the payload. If you do not specify authenticationType, the API will default to SERVICE_ACCOUNT as the authentication type. * A JSON map of configuration attributes in `data_warehouse_config`. The following example shows the configuration attributes for a Snowflake connection: ``` { \"configuration\":{ \"accountName\":\"thoughtspot_partner\", \"user\":\"tsadmin\", \"password\":\"TestConn123\", \"role\":\"sysadmin\", \"warehouse\":\"MEDIUM_WH\" }, \"externalDatabases\":[ ] } ``` * @param param the request object */ public updateConnectionV2(param: ConnectionsApiUpdateConnectionV2Request, options?: Configuration): Promise { return this.api.updateConnectionV2(param.connectionIdentifier, param.updateConnectionV2Request, options).toPromise(); } } import { ObservableCustomActionApi } from "./ObservableAPI"; import { CustomActionApiRequestFactory, CustomActionApiResponseProcessor} from "../apis/CustomActionApi"; export interface CustomActionApiCreateCustomActionRequest { /** * * @type CreateCustomActionRequest * @memberof CustomActionApicreateCustomAction */ createCustomActionRequest: CreateCustomActionRequest } export interface CustomActionApiDeleteCustomActionRequest { /** * Unique ID or name of the custom action. * @type string * @memberof CustomActionApideleteCustomAction */ customActionIdentifier: string } export interface CustomActionApiSearchCustomActionsRequest { /** * * @type SearchCustomActionsRequest * @memberof CustomActionApisearchCustomActions */ searchCustomActionsRequest: SearchCustomActionsRequest } export interface CustomActionApiUpdateCustomActionRequest { /** * Unique ID or name of the custom action. * @type string * @memberof CustomActionApiupdateCustomAction */ customActionIdentifier: string /** * * @type UpdateCustomActionRequest * @memberof CustomActionApiupdateCustomAction */ updateCustomActionRequest: UpdateCustomActionRequest } export class ObjectCustomActionApi { private api: ObservableCustomActionApi public constructor(configuration: Configuration, requestFactory?: CustomActionApiRequestFactory, responseProcessor?: CustomActionApiResponseProcessor) { this.api = new ObservableCustomActionApi(configuration, requestFactory, responseProcessor); } /** * Version: 9.6.0.cl or later Creates a custom action that appears as a menu action on a saved Answer or Liveboard visualization. Requires `DEVELOPER` (**Has Developer privilege**) or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `DEVELOPER` (**Has developer privilege**) privilege is required. #### Usage Guidelines The API lets you create the following types of custom actions: * URL-based action Allows pushing data to an external URL. * Callback action Triggers a callback to the host application and initiates a response payload on an embedded ThoughtSpot instance. By default, custom actions are visible to only administrator or developer users. To make a custom action available to other users, and specify the groups in `group_identifiers`. By default, the custom action is set as a _global_ action on all visualizations and saved Answers. To assign a custom action to specific Liveboard visualization, saved Answer, or Worksheet, set `visibility` to `false` in `default_action_config` property and specify the GUID or name of the object in `associate_metadata`. For more information, see [Custom actions](https://developers.thoughtspot.com/docs/custom-action-intro). * @param param the request object */ public createCustomAction(param: CustomActionApiCreateCustomActionRequest, options?: Configuration): Promise { return this.api.createCustomAction(param.createCustomActionRequest, options).toPromise(); } /** * Version: 9.6.0.cl or later Removes the custom action specified in the API request. Requires `DEVELOPER` (**Has Developer privilege**) or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `DEVELOPER` (**Has developer privilege**) privilege is required. * @param param the request object */ public deleteCustomAction(param: CustomActionApiDeleteCustomActionRequest, options?: Configuration): Promise { return this.api.deleteCustomAction(param.customActionIdentifier, options).toPromise(); } /** * Version: 9.6.0.cl or later Gets custom actions configured on the cluster. Requires `DEVELOPER` (**Has Developer privilege**) or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `DEVELOPER` (**Has developer privilege**) privilege is required. * @param param the request object */ public searchCustomActions(param: CustomActionApiSearchCustomActionsRequest, options?: Configuration): Promise> { return this.api.searchCustomActions(param.searchCustomActionsRequest, options).toPromise(); } /** * Version: 9.6.0.cl or later Updates a custom action. Requires `DEVELOPER` (**Has Developer privilege**) or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `DEVELOPER` (**Has developer privilege**) privilege is required. #### Usage Guidelines The API allows you to modify the following properties: * Name of the custom action * Action availability to groups * Association to metadata objects * Authentication settings for a URL-based action For more information, see [Custom actions](https://developers.thoughtspot.com/docs/custom-action-intro). * @param param the request object */ public updateCustomAction(param: CustomActionApiUpdateCustomActionRequest, options?: Configuration): Promise { return this.api.updateCustomAction(param.customActionIdentifier, param.updateCustomActionRequest, options).toPromise(); } } import { ObservableCustomCalendarsApi } from "./ObservableAPI"; import { CustomCalendarsApiRequestFactory, CustomCalendarsApiResponseProcessor} from "../apis/CustomCalendarsApi"; export interface CustomCalendarsApiCreateCalendarRequest { /** * * @type CreateCalendarRequest * @memberof CustomCalendarsApicreateCalendar */ createCalendarRequest: CreateCalendarRequest } export interface CustomCalendarsApiDeleteCalendarRequest { /** * Unique ID or name of the Calendar. * @type string * @memberof CustomCalendarsApideleteCalendar */ calendarIdentifier: string } export interface CustomCalendarsApiGenerateCSVRequest { /** * * @type GenerateCSVRequest * @memberof CustomCalendarsApigenerateCSV */ generateCSVRequest: GenerateCSVRequest } export interface CustomCalendarsApiSearchCalendarsRequest { /** * * @type SearchCalendarsRequest * @memberof CustomCalendarsApisearchCalendars */ searchCalendarsRequest: SearchCalendarsRequest } export interface CustomCalendarsApiUpdateCalendarRequest { /** * Unique Id or name of the calendar. * @type string * @memberof CustomCalendarsApiupdateCalendar */ calendarIdentifier: string /** * * @type UpdateCalendarRequest * @memberof CustomCalendarsApiupdateCalendar */ updateCalendarRequest: UpdateCalendarRequest } export class ObjectCustomCalendarsApi { private api: ObservableCustomCalendarsApi public constructor(configuration: Configuration, requestFactory?: CustomCalendarsApiRequestFactory, responseProcessor?: CustomCalendarsApiResponseProcessor) { this.api = new ObservableCustomCalendarsApi(configuration, requestFactory, responseProcessor); } /** * Version: 10.12.0.cl or later Creates a new [custom calendar](https://docs.thoughtspot.com/cloud/latest/connections-cust-cal). Requires `DATAMANAGEMENT` (**Can manage data**) or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your ThoughtSpot instance, the `CAN_MANAGE_CUSTOM_CALENDAR` (**Can manage custom calendars**) privilege is required. #### Usage guidelines You can create a custom calendar from scratch or an existing Table in ThoughtSpot. For both methods of calendar creation, the following parameters are required: * Name of the custom calendar. * Calendar creation method. To create a calendar from an existing table, specify the method: - `FROM_EXISTING_TABLE` - Creates calendar from the table reference provided in the API request. - `FROM_INPUT_PARAMS` - Creates a calendar from the parameters defined in the API request. * Connection ID and Table name * Database and schema name attributes: For most Cloud Data Warehouse (CDW) connectors, both `database_name` and `schema_name` attributes are required. However, the attribute requirements are conditional and vary based on the connector type and its metadata structure. For example, for connectors such as Teradata, MySQL, SingleSore, Amazon Aurora MySQL, Amazon RDS MySQL, Oracle, and GCP_MYSQL, the `schema_name` is required, whereas the `database_name` attribute is not. Similarly, connectors such as ClickHouse require you to specify the `database_name` and the schema specification in such cases is optional. **NOTE**: If you are creating a calendar from an existing table, ensure that the referenced table matches the required DDL for custom calendars. If the schema does not match, the API returns an error. ##### Calendar type The API allows you to create the following types of calendars: * `MONTH_OFFSET`. The default calendar type. A `MONTH_OFFSET` calendar is offset by a few months from the standard calendar months (January to December) and the year begins with the month defined in the request. For example, if the `month_offset` value is set as `April`, the calendar year begins in April. * `4-4-5`. Each quarter in the calendar will include two 4-week months followed by one 5-week month. * `4-5-4`. Each quarter in the calendar will include two 4-week months with a 5-week month between. * `5-4-4`. Each quarter begins with a 5-week month, followed by two 4-week months. To start and end the calendar on a specific date, specify the dates in the `MM/DD/YYYY` format. For `MONTH_OFFSET` calendars, ensure that the `start_date` matches the month specified in the `month_offset` attribute. You can also set the starting day of the week and customize the prefixes for year and quarter labels. #### Examples To create a calendar from an existing table: ``` { \"name\": \"MyCustomCalendar1\", \"table_reference\": { \"connection_identifier\": \"4db8ea22-2ff4-4224-b05a-26674717e468\", \"table_name\": \"MyCalendarTable\", \"database_name\": \"RETAILAPPAREL\", \"schema_name\": \"PUBLIC\" }, \"creation_method\": \"FROM_EXISTING_TABLE\", } ``` To create a calendar from scratch: ``` { \"name\": \"MyCustomCalendar1\", \"table_reference\": { \"connection_identifier\": \"4db8ea22-2ff4-4224-b05a-26674717e468\", \"table_name\": \"MyCalendarTable\", \"database_name\": \"RETAILAPPAREL\", \"schema_name\": \"PUBLIC\" }, \"creation_method\": \"FROM_INPUT_PARAMS\", \"calendar_type\": \"MONTH_OFFSET\", \"month_offset\": \"April\", \"start_day_of_week\": \"Monday\", \"quarter_name_prefix\": \"Q\", \"year_name_prefix\": \"FY\", \"start_date\": \"04/01/2025\", \"end_date\": \"04/31/2025\" } ``` * @param param the request object */ public createCalendar(param: CustomCalendarsApiCreateCalendarRequest, options?: Configuration): Promise { return this.api.createCalendar(param.createCalendarRequest, options).toPromise(); } /** * Version: 10.12.0.cl or later Deletes a [custom calendar](https://docs.thoughtspot.com/cloud/latest/connections-cust-cal). Requires `DATAMANAGEMENT` (**Can manage data**) or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your ThoughtSpot instance, the `CAN_MANAGE_CUSTOM_CALENDAR` (**Can manage custom calendars**) privilege is required. #### Usage guidelines To delete a custom calendar, specify the calendar ID as a path parameter in the request URL. * @param param the request object */ public deleteCalendar(param: CustomCalendarsApiDeleteCalendarRequest, options?: Configuration): Promise { return this.api.deleteCalendar(param.calendarIdentifier, options).toPromise(); } /** * Version: 10.12.0.cl or later Exports a [custom calendar](https://docs.thoughtspot.com/cloud/latest/connections-cust-cal) in the CSV format. Requires `DATAMANAGEMENT` (**Can manage data**) or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your ThoughtSpot instance, the `CAN_MANAGE_CUSTOM_CALENDAR` (**Can manage custom calendars**) privilege is required. #### Usage guidelines Use this API to download a custom calendar in the CSV file format. In your API request, specify the following parameters. * Start and end date of the calendar. For \"month offset\" calendars, the start date must match the month defined in the `month_offset` attribute. You can also specify optional parameters such as the starting day of the week and prefixes for the quarter and year labels. * @param param the request object */ public generateCSV(param: CustomCalendarsApiGenerateCSVRequest, options?: Configuration): Promise { return this.api.generateCSV(param.generateCSVRequest, options).toPromise(); } /** * Version: 10.12.0.cl or later Gets a list of [custom calendars](https://docs.thoughtspot.com/cloud/latest/connections-cust-cal). Requires `DATAMANAGEMENT` (**Can manage data**) or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your ThoughtSpot instance, the `CAN_MANAGE_CUSTOM_CALENDAR` (**Can manage custom calendars**) privilege is required. #### Usage guidelines By default, the API returns a list of custom calendars for all connection objects. To retrieve custom calendar details for a particular connection, specify the connection ID. You can also use other search parameters such as `name_pattern` and `sort_options` as search filters. The `name_pattern` parameter filters and returns only those objects that match the specified pattern. Use `%` as a wildcard for pattern matching. * @param param the request object */ public searchCalendars(param: CustomCalendarsApiSearchCalendarsRequest, options?: Configuration): Promise> { return this.api.searchCalendars(param.searchCalendarsRequest, options).toPromise(); } /** * Version: 10.12.0.cl or later Updates the properties of a [custom calendar](https://docs.thoughtspot.com/cloud/latest/connections-cust-cal). Requires `DATAMANAGEMENT` (**Can manage data**) or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your ThoughtSpot instance, the `CAN_MANAGE_CUSTOM_CALENDAR` (**Can manage custom calendars**) privilege is required. #### Usage guidelines You can update the properties of a calendar using one of the following methods: * `FROM_INPUT_PARAMS` to update the calendar properties with the values defined in the API request. * `FROM_EXISTING_TABLE` Creates a calendar from the parameters defined in the API request. To update a custom calendar, specify the calendar ID as a path parameter in the request URL and the following parameters in the request body: * Connection ID and Table name * Database and schema name attributes: For most Cloud Data Warehouse (CDW) connectors, both `database_name` and `schema_name` attributes are required. However, the attribute requirements are conditional and vary based on the connector type and its metadata structure. For example, for connectors such as Teradata, MySQL, SingleSore, Amazon Aurora MySQL, Amazon RDS MySQL, Oracle, and GCP_MYSQL, the `schema_name` is required, whereas the `database_name` attribute is not. Similarly, connectors such as ClickHouse require you to specify the `database_name` and the schema specification in such cases is optional. The API allows you to modify the calendar type, month offset value, start and end date, starting day of the week, and prefixes assigned to the year and quarter labels. #### Examples Update a custom calendar using an existing Table in ThoughtSpot: ``` { \"update_method\": \"FROM_EXISTING_TABLE\", \"table_reference\": { \"connection_identifier\": \"Connection1\", \"database_name\": \"db1\", \"table_name\": \"custom_calendar_2025\", \"schame_name\": \"schemaVar\" } } ``` Update a custom calendar with the attributes defined in the API request: ``` { \"update_method\": \"FROM_INPUT_PARAMS\", \"table_reference\": { \"connection_identifier\": \"Connection1\", \"database_name\": \"db1\", \"table_name\": \"custom_calendar_2025\", \"schame_name\": \"schemaVar\" }, \"month_offset\": \"August\", \"start_day_of_week\": \"Monday\", \"start_date\": \"08/01/2025\", \"end_date\": \"07/31/2026\" } ``` * @param param the request object */ public updateCalendar(param: CustomCalendarsApiUpdateCalendarRequest, options?: Configuration): Promise { return this.api.updateCalendar(param.calendarIdentifier, param.updateCalendarRequest, options).toPromise(); } } import { ObservableDBTApi } from "./ObservableAPI"; import { DBTApiRequestFactory, DBTApiResponseProcessor} from "../apis/DBTApi"; export interface DBTApiDbtConnectionRequest { /** * Name of the connection. * @type string * @memberof DBTApidbtConnection */ connectionName: string /** * Name of the Database. * @type string * @memberof DBTApidbtConnection */ databaseName: string /** * Mention type of Import * @type string * @memberof DBTApidbtConnection */ importType?: string /** * Access token is mandatory when Import_Type is DBT_CLOUD. * @type string * @memberof DBTApidbtConnection */ accessToken?: string /** * DBT URL is mandatory when Import_Type is DBT_CLOUD. * @type string * @memberof DBTApidbtConnection */ dbtUrl?: string /** * Account ID is mandatory when Import_Type is DBT_CLOUD * @type string * @memberof DBTApidbtConnection */ accountId?: string /** * Project ID is mandatory when Import_Type is DBT_CLOUD * @type string * @memberof DBTApidbtConnection */ projectId?: string /** * DBT Environment ID\\\" * @type string * @memberof DBTApidbtConnection */ dbtEnvId?: string /** * Name of the project * @type string * @memberof DBTApidbtConnection */ projectName?: string /** * Upload DBT Manifest and Catalog artifact files as a ZIP file. This field is Mandatory when Import Type is \\\'ZIP_FILE\\\' * @type HttpFile * @memberof DBTApidbtConnection */ fileContent?: HttpFile } export interface DBTApiDbtGenerateSyncTmlRequest { /** * Unique ID of the DBT connection. * @type string * @memberof DBTApidbtGenerateSyncTml */ dbtConnectionIdentifier: string /** * Upload DBT Manifest and Catalog artifact files as a ZIP file. This field is mandatory if the connection was created with import_type ‘ZIP_FILE’ * @type HttpFile * @memberof DBTApidbtGenerateSyncTml */ fileContent?: HttpFile } export interface DBTApiDbtGenerateTmlRequest { /** * Unique ID of the DBT connection. * @type string * @memberof DBTApidbtGenerateTml */ dbtConnectionIdentifier: string /** * List of Models and their respective Tables Example: \\\'[{\\\"model_name\\\": \\\"model_name\\\", \\\"tables\\\": [\\\"table_name\\\"]}]\\\' * @type string * @memberof DBTApidbtGenerateTml */ modelTables: string /** * Mention the worksheet tmls to import * @type string * @memberof DBTApidbtGenerateTml */ importWorksheets: string /** * List of worksheets is mandatory when import_Worksheets is type SELECTED Example: [\\\"worksheet_name\\\"] * @type string * @memberof DBTApidbtGenerateTml */ worksheets?: string /** * Upload DBT Manifest and Catalog artifact files as a ZIP file. This field is mandatory if the connection was created with import_type ‘ZIP_FILE’ * @type HttpFile * @memberof DBTApidbtGenerateTml */ fileContent?: HttpFile } export interface DBTApiDbtSearchRequest { } export interface DBTApiDeleteDbtConnectionRequest { /** * Unique ID of the DBT Connection. * @type string * @memberof DBTApideleteDbtConnection */ dbtConnectionIdentifier: string } export interface DBTApiUpdateDbtConnectionRequest { /** * Unique ID of the DBT Connection. * @type string * @memberof DBTApiupdateDbtConnection */ dbtConnectionIdentifier: string /** * Name of the connection. * @type string * @memberof DBTApiupdateDbtConnection */ connectionName?: string /** * Name of the Database. * @type string * @memberof DBTApiupdateDbtConnection */ databaseName?: string /** * Mention type of Import * @type string * @memberof DBTApiupdateDbtConnection */ importType?: string /** * Access token is mandatory when Import_Type is DBT_CLOUD. * @type string * @memberof DBTApiupdateDbtConnection */ accessToken?: string /** * DBT URL is mandatory when Import_Type is DBT_CLOUD. * @type string * @memberof DBTApiupdateDbtConnection */ dbtUrl?: string /** * Account ID is mandatory when Import_Type is DBT_CLOUD * @type string * @memberof DBTApiupdateDbtConnection */ accountId?: string /** * Project ID is mandatory when Import_Type is DBT_CLOUD * @type string * @memberof DBTApiupdateDbtConnection */ projectId?: string /** * DBT Environment ID\\\" * @type string * @memberof DBTApiupdateDbtConnection */ dbtEnvId?: string /** * Name of the project * @type string * @memberof DBTApiupdateDbtConnection */ projectName?: string /** * Upload DBT Manifest and Catalog artifact files as a ZIP file. This field is Mandatory when Import Type is \\\'ZIP_FILE\\\' * @type HttpFile * @memberof DBTApiupdateDbtConnection */ fileContent?: HttpFile } export class ObjectDBTApi { private api: ObservableDBTApi public constructor(configuration: Configuration, requestFactory?: DBTApiRequestFactory, responseProcessor?: DBTApiResponseProcessor) { this.api = new ObservableDBTApi(configuration, requestFactory, responseProcessor); } /** * Version: 9.9.0.cl or later Creates a DBT connection object in ThoughtSpot. Requires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege or `DATAMANAGEMENT` (**Can manage data**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the following Data control privileges may be required: - `CAN_MANAGE_CUSTOM_CALENDAR`(**Can manage custom calendars**) - `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**) - `CAN_MANAGE_WORKSHEET_VIEWS_TABLES` (**Can manage data models**) #### About create DBT connection DBT connection in ThoughtSpot is used by the user to define DBT credentials for cloud . The API needs embrace connection, embrace database name, DBT url, import type, DBT account identifier, DBT project identifier, DBT access token and environment details (or) embrace connection, embrace database name, import type, file_content to create a connection object. To know more about DBT, see ThoughtSpot Product Documentation. * @param param the request object */ public dbtConnection(param: DBTApiDbtConnectionRequest, options?: Configuration): Promise { return this.api.dbtConnection(param.connectionName, param.databaseName, param.importType, param.accessToken, param.dbtUrl, param.accountId, param.projectId, param.dbtEnvId, param.projectName, param.fileContent, options).toPromise(); } /** * Version: 9.9.0.cl or later Resynchronize the existing list of models, tables, worksheet tml’s and import them to Thoughtspot based on the DBT connection object. Requires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege or `DATAMANAGEMENT` (**Can manage data**) privilege, along with an existing DBT connection. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the following data control privileges may be required: - `CAN_MANAGE_CUSTOM_CALENDAR`(**Can manage custom calendars**) - `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**) - `CAN_MANAGE_WORKSHEET_VIEWS_TABLES` (**Can manage data models**) * @param param the request object */ public dbtGenerateSyncTml(param: DBTApiDbtGenerateSyncTmlRequest, options?: Configuration): Promise { return this.api.dbtGenerateSyncTml(param.dbtConnectionIdentifier, param.fileContent, options).toPromise(); } /** * Version: 9.9.0.cl or later Generate required table and worksheet and import them. Requires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege or `DATAMANAGEMENT` (**Can manage data**) privilege, along with an existing DBT connection. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the following data control privileges may be required: - `CAN_MANAGE_CUSTOM_CALENDAR`(**Can manage custom calendars**) - `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**) - `CAN_MANAGE_WORKSHEET_VIEWS_TABLES` (**Can manage data models**) #### About generate TML Models and Worksheets to be imported can be selected by the user as part of the API. * @param param the request object */ public dbtGenerateTml(param: DBTApiDbtGenerateTmlRequest, options?: Configuration): Promise { return this.api.dbtGenerateTml(param.dbtConnectionIdentifier, param.modelTables, param.importWorksheets, param.worksheets, param.fileContent, options).toPromise(); } /** * Version: 9.9.0.cl or later Gets a list of DBT connection objects by user and organization, available on the ThoughtSpot system. Requires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege or `DATAMANAGEMENT` (**Can manage data**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the following Data control privileges may be required: - `CAN_MANAGE_CUSTOM_CALENDAR`(**Can manage custom calendars**) - `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**) - `CAN_MANAGE_WORKSHEET_VIEWS_TABLES` (**Can manage data models**) #### About search DBT connection To get details of a specific DBT connection identifier, database connection identifier, database connection name, database name, project name, project identifier, environment identifier , import type and author. * @param param the request object */ public dbtSearch(param: DBTApiDbtSearchRequest = {}, options?: Configuration): Promise> { return this.api.dbtSearch( options).toPromise(); } /** * Version: 9.9.0.cl or later Removes the specified DBT connection object from the ThoughtSpot system. Requires `ADMINISTRATION` (**Can administer ThoughtSpot**) or `DATAMANAGEMENT` (**Can manage data ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the following Data control privileges may be required: - `CAN_MANAGE_CUSTOM_CALENDAR`(**Can manage custom calendars**) - `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**) - `CAN_MANAGE_WORKSHEET_VIEWS_TABLES` (**Can manage data models**) * @param param the request object */ public deleteDbtConnection(param: DBTApiDeleteDbtConnectionRequest, options?: Configuration): Promise { return this.api.deleteDbtConnection(param.dbtConnectionIdentifier, options).toPromise(); } /** * Version: 9.9.0.cl or later Updates a DBT connection object. Requires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege or `DATAMANAGEMENT` (**Can manage data ThoughtSpot**) privilege, along with an existing DBT connection. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the following data control privileges may be required: - `CAN_MANAGE_CUSTOM_CALENDAR`(**Can manage custom calendars**) - `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**) - `CAN_MANAGE_WORKSHEET_VIEWS_TABLES` (**Can manage data models**) #### About update DBT connection You can modify DBT connection object properties such as embrace connection name, embrace database name, import type, account identifier, access token, project identifier and environment (or) embrace connection, embrace database name, import type, file_content settings. * @param param the request object */ public updateDbtConnection(param: DBTApiUpdateDbtConnectionRequest, options?: Configuration): Promise { return this.api.updateDbtConnection(param.dbtConnectionIdentifier, param.connectionName, param.databaseName, param.importType, param.accessToken, param.dbtUrl, param.accountId, param.projectId, param.dbtEnvId, param.projectName, param.fileContent, options).toPromise(); } } import { ObservableDataApi } from "./ObservableAPI"; import { DataApiRequestFactory, DataApiResponseProcessor} from "../apis/DataApi"; export interface DataApiFetchAnswerDataRequest { /** * * @type FetchAnswerDataRequest * @memberof DataApifetchAnswerData */ fetchAnswerDataRequest: FetchAnswerDataRequest } export interface DataApiFetchLiveboardDataRequest { /** * * @type FetchLiveboardDataRequest * @memberof DataApifetchLiveboardData */ fetchLiveboardDataRequest: FetchLiveboardDataRequest } export interface DataApiSearchDataRequest { /** * * @type SearchDataRequest * @memberof DataApisearchData */ searchDataRequest: SearchDataRequest } export class ObjectDataApi { private api: ObservableDataApi public constructor(configuration: Configuration, requestFactory?: DataApiRequestFactory, responseProcessor?: DataApiResponseProcessor) { this.api = new ObservableDataApi(configuration, requestFactory, responseProcessor); } /** * Version: 9.0.0.cl or later Fetches data from a saved Answer. Requires at least view access to the saved Answer. The `record_size` attribute determines the number of records to retrieve in an API call. For more information about pagination, record size, and maximum row limit, see [Pagination and record size settings](https://developers.thoughtspot.com/docs/fetch-data-and-report-apis#_pagination_settings_for_data_and_report_apis). * @param param the request object */ public fetchAnswerData(param: DataApiFetchAnswerDataRequest, options?: Configuration): Promise { return this.api.fetchAnswerData(param.fetchAnswerDataRequest, options).toPromise(); } /** * Version: 9.0.0.cl or later Gets data from a Liveboard object and its visualization. Requires at least view access to the Liveboard. #### Usage guidelines In the request body, specify the GUID or name of the Liveboard. To get data for specific visualizations, add the GUIDs or names of the visualizations in the API request. To include unsaved changes in the report, pass the `transient_pinboard_content` script generated from the `getExportRequestForCurrentPinboard` method in the Visual Embed SDK. Upon successful execution, the API returns the report with unsaved changes. If the new Liveboard experience mode, the transient content includes ad hoc changes to visualizations such as sorting, toggling of legends, and data drill down. For more information, and see [Liveboard data API](https://developers.thoughtspot.com/docs/fetch-data-and-report-apis#_fetch_liveboard_data_api). * @param param the request object */ public fetchLiveboardData(param: DataApiFetchLiveboardDataRequest, options?: Configuration): Promise { return this.api.fetchLiveboardData(param.fetchLiveboardDataRequest, options).toPromise(); } /** * Version: 9.0.0.cl or later Generates an Answer from a given data source. Requires at least view access to the data source object (Worksheet or View). #### Usage guidelines To search data, specify the data source GUID in `logical_table_identifier`. The data source can be a Worksheet, View, Table, or SQL view. Pass search tokens in the `query_string` attribute in the API request as shown in the following example: ``` { \"query_string\": \"[sales] by [store]\", \"logical_table_identifier\": \"cd252e5c-b552-49a8-821d-3eadaa049cca\", } ``` For more information about the `query_string` format and data source attribute, see [Search data API](https://developers.thoughtspot.com/docs/fetch-data-and-report-apis#_search_data_api). The `record_size` attribute determines the number of records to retrieve in an API call. For more information about pagination, record size, and maximum row limit, see [Pagination and record size settings](https://developers.thoughtspot.com/docs/fetch-data-and-report-apis#_pagination_settings_for_data_and_report_api). * @param param the request object */ public searchData(param: DataApiSearchDataRequest, options?: Configuration): Promise { return this.api.searchData(param.searchDataRequest, options).toPromise(); } } import { ObservableEmailCustomizationApi } from "./ObservableAPI"; import { EmailCustomizationApiRequestFactory, EmailCustomizationApiResponseProcessor} from "../apis/EmailCustomizationApi"; export interface EmailCustomizationApiCreateEmailCustomizationRequest { /** * * @type CreateEmailCustomizationRequest * @memberof EmailCustomizationApicreateEmailCustomization */ createEmailCustomizationRequest: CreateEmailCustomizationRequest } export interface EmailCustomizationApiDeleteEmailCustomizationRequest { /** * Unique ID or name of the email customization. * @type string * @memberof EmailCustomizationApideleteEmailCustomization */ templateIdentifier: string } export interface EmailCustomizationApiDeleteOrgEmailCustomizationRequest { /** * * @type DeleteOrgEmailCustomizationRequest * @memberof EmailCustomizationApideleteOrgEmailCustomization */ deleteOrgEmailCustomizationRequest: DeleteOrgEmailCustomizationRequest } export interface EmailCustomizationApiSearchEmailCustomizationRequest { /** * * @type SearchEmailCustomizationRequest * @memberof EmailCustomizationApisearchEmailCustomization */ searchEmailCustomizationRequest: SearchEmailCustomizationRequest } export interface EmailCustomizationApiUpdateEmailCustomizationRequest { /** * * @type UpdateEmailCustomizationRequest * @memberof EmailCustomizationApiupdateEmailCustomization */ updateEmailCustomizationRequest: UpdateEmailCustomizationRequest } export interface EmailCustomizationApiValidateEmailCustomizationRequest { } export class ObjectEmailCustomizationApi { private api: ObservableEmailCustomizationApi public constructor(configuration: Configuration, requestFactory?: EmailCustomizationApiRequestFactory, responseProcessor?: EmailCustomizationApiResponseProcessor) { this.api = new ObservableEmailCustomizationApi(configuration, requestFactory, responseProcessor); } /** * Version: 10.10.0.cl or later Creates a customization configuration for the notification email. #### Pre-requisites Requires `DEVELOPER` (**has developer privilege**) or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `DEVELOPER` (**Has developer privilege**) privilege is required. **NOTE**:This endpoint in currently in beta. Contact ThoughtSpot support to enable this on your instance. #### Usage guidelines To create a custom configuration pass these parameters in your API request: - A JSON map of configuration attributes `template_properties`. The following example shows a sample set of customization configuration: ``` { { \"cta_button_bg_color\": \"#444DEA\", \"cta_text_font_color\": \"#FFFFFF\", \"primary_bg_color\": \"#D3DEF0\", \"logo_url\": \"https://storage.pardot.com/710713/1642089901EbkRibJq/TS_fullworkmark_darkmode.png\", \"font_family\": \"\", \"product_name\": \"ThoughtSpot\", \"footer_address\": \"444 Castro St, Suite 1000 Mountain View, CA 94041\", \"footer_phone\": \"(800) 508-7008\", \"replacement_value_for_liveboard\": \"Dashboard\", \"replacement_value_for_answer\": \"Chart\", \"replacement_value_for_spot_iq\": \"AI Insights\", \"hide_footer_phone\": false, \"hide_footer_address\": false, \"hide_product_name\": false, \"hide_manage_notification\": false, \"hide_mobile_app_nudge\": false, \"hide_privacy_policy\": false, \"hide_ts_vocabulary_definitions\": false, \"hide_error_message\": false, \"hide_unsubscribe_link\": false, \"hide_notification_status\": false, \"hide_modify_alert\": false, \"company_website_url\": \"https://your-website.com/\", \"company_privacy_policy_url\" : \"https://link-to-privacy-policy.com/\", \"contact_support_url\": \"https://link-to-contact-support.com/\", \"hide_contact_support_url\": false, \"hide_logo_url\" : false } } ``` * @param param the request object */ public createEmailCustomization(param: EmailCustomizationApiCreateEmailCustomizationRequest, options?: Configuration): Promise { return this.api.createEmailCustomization(param.createEmailCustomizationRequest, options).toPromise(); } /** * Version: 10.10.0.cl or later Deletes the configuration for the email customization. #### Pre-requisites Requires `DEVELOPER` (**has developer privilege**) or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `DEVELOPER` (**Has developer privilege**) privilege is required. **NOTE**:This endpoint in currently in beta. Contact ThoughtSpot support to enable this on your instance. #### Usage guidelines - Call the search API endpoint to get the `template_identifier` from the response. - Use that `template_identifier` as a parameter in this API request. * @param param the request object */ public deleteEmailCustomization(param: EmailCustomizationApiDeleteEmailCustomizationRequest, options?: Configuration): Promise { return this.api.deleteEmailCustomization(param.templateIdentifier, options).toPromise(); } /** * Version: 10.12.0.cl or later Deletes the configuration for the email customization. #### Pre-requisites Requires `DEVELOPER` (**has developer privilege**) or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `DEVELOPER` (**Has developer privilege**) privilege is required. **NOTE**:This endpoint in currently in beta. Contact ThoughtSpot support to enable this on your instance. #### Usage guidelines - Call the search API endpoint to get the `org_identifier` from the response. - Use that `org_identifier` as a parameter in this API request. * @param param the request object */ public deleteOrgEmailCustomization(param: EmailCustomizationApiDeleteOrgEmailCustomizationRequest, options?: Configuration): Promise { return this.api.deleteOrgEmailCustomization(param.deleteOrgEmailCustomizationRequest, options).toPromise(); } /** * Version: 10.10.0.cl or later Search the email customization configuration if any set for the ThoughtSpot system. #### Pre-requisites Requires `DEVELOPER` (**has developer privilege**) or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `DEVELOPER` (**Has developer privilege**) privilege is required. **NOTE**:This endpoint in currently in beta. Contact ThoughtSpot support to enable this on your instance. * @param param the request object */ public searchEmailCustomization(param: EmailCustomizationApiSearchEmailCustomizationRequest, options?: Configuration): Promise> { return this.api.searchEmailCustomization(param.searchEmailCustomizationRequest, options).toPromise(); } /** * Version: 10.12.0.cl or later Updates a customization configuration for the notification email. #### Pre-requisites Requires `DEVELOPER` (**has developer privilege**) or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `DEVELOPER` (**Has developer privilege**) privilege is required. **NOTE**:This endpoint in currently in beta. Contact ThoughtSpot support to enable this on your instance. #### Usage guidelines To update a custom configuration pass these parameters in your API request: - A JSON map of configuration attributes `template_properties`. The following example shows a sample set of customization configuration: ``` { { \"cta_button_bg_color\": \"#444DEA\", \"cta_text_font_color\": \"#FFFFFF\", \"primary_bg_color\": \"#D3DEF0\", \"logo_url\": \"https://storage.pardot.com/710713/1642089901EbkRibJq/TS_fullworkmark_darkmode.png\", \"font_family\": \"\", \"product_name\": \"ThoughtSpot\", \"footer_address\": \"444 Castro St, Suite 1000 Mountain View, CA 94041\", \"footer_phone\": \"(800) 508-7008\", \"replacement_value_for_liveboard\": \"Dashboard\", \"replacement_value_for_answer\": \"Chart\", \"replacement_value_for_spot_iq\": \"AI Insights\", \"hide_footer_phone\": false, \"hide_footer_address\": false, \"hide_product_name\": false, \"hide_manage_notification\": false, \"hide_mobile_app_nudge\": false, \"hide_privacy_policy\": false, \"hide_ts_vocabulary_definitions\": false, \"hide_error_message\": false, \"hide_unsubscribe_link\": false, \"hide_notification_status\": false, \"hide_modify_alert\": false, \"company_website_url\": \"https://your-website.com/\", \"company_privacy_policy_url\" : \"https://link-to-privacy-policy.com/\", \"contact_support_url\": \"https://link-to-contact-support.com/\", \"hide_contact_support_url\": false, \"hide_logo_url\" : false } } ``` * @param param the request object */ public updateEmailCustomization(param: EmailCustomizationApiUpdateEmailCustomizationRequest, options?: Configuration): Promise { return this.api.updateEmailCustomization(param.updateEmailCustomizationRequest, options).toPromise(); } /** * Version: 10.10.0.cl or later Validates the email customization configuration if any set for the ThoughtSpot system. #### Pre-requisites Requires `DEVELOPER` (**has developer privilege**) or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `DEVELOPER` (**Has developer privilege**) privilege is required. **NOTE**:This endpoint in currently in beta. Contact ThoughtSpot support to enable this on your instance. * @param param the request object */ public validateEmailCustomization(param: EmailCustomizationApiValidateEmailCustomizationRequest = {}, options?: Configuration): Promise { return this.api.validateEmailCustomization( options).toPromise(); } } import { ObservableGroupsApi } from "./ObservableAPI"; import { GroupsApiRequestFactory, GroupsApiResponseProcessor} from "../apis/GroupsApi"; export interface GroupsApiCreateUserGroupRequest { /** * * @type CreateUserGroupRequest * @memberof GroupsApicreateUserGroup */ createUserGroupRequest: CreateUserGroupRequest } export interface GroupsApiDeleteUserGroupRequest { /** * GUID or name of the group. * @type string * @memberof GroupsApideleteUserGroup */ groupIdentifier: string } export interface GroupsApiImportUserGroupsRequest { /** * * @type ImportUserGroupsRequest * @memberof GroupsApiimportUserGroups */ importUserGroupsRequest: ImportUserGroupsRequest } export interface GroupsApiSearchUserGroupsRequest { /** * * @type SearchUserGroupsRequest * @memberof GroupsApisearchUserGroups */ searchUserGroupsRequest: SearchUserGroupsRequest } export interface GroupsApiUpdateUserGroupRequest { /** * GUID or name of the group. * @type string * @memberof GroupsApiupdateUserGroup */ groupIdentifier: string /** * * @type UpdateUserGroupRequest * @memberof GroupsApiupdateUserGroup */ updateUserGroupRequest: UpdateUserGroupRequest } export class ObjectGroupsApi { private api: ObservableGroupsApi public constructor(configuration: Configuration, requestFactory?: GroupsApiRequestFactory, responseProcessor?: GroupsApiResponseProcessor) { this.api = new ObservableGroupsApi(configuration, requestFactory, responseProcessor); } /** * Version: 9.0.0.cl or later Creates a group object in ThoughtSpot. Requires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `GROUP_ADMINISTRATION` (**Can manage groups**) privilege is required. #### About groups Groups in ThoughtSpot are used by the administrators to define privileges and organize users based on their roles and access requirements. To know more about groups and privileges, see [ThoughtSpot Product Documentation](https://docs.thoughtspot.com/cloud/latest/groups-privileges). #### Supported operations The API endpoint lets you perform the following operations: * Assign privileges * Add users * Define sharing visibility * Add sub-groups * Assign a default Liveboard * @param param the request object */ public createUserGroup(param: GroupsApiCreateUserGroupRequest, options?: Configuration): Promise { return this.api.createUserGroup(param.createUserGroupRequest, options).toPromise(); } /** * Version: 9.0.0.cl or later Removes the specified group object from the ThoughtSpot system. Requires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `GROUP_ADMINISTRATION` (**Can manage groups**) privilege is required. * @param param the request object */ public deleteUserGroup(param: GroupsApiDeleteUserGroupRequest, options?: Configuration): Promise { return this.api.deleteUserGroup(param.groupIdentifier, options).toPromise(); } /** * Version: 9.0.0.cl or later Imports group objects from external databases into ThoughtSpot. Requires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `GROUP_ADMINISTRATION` (**Can manage groups**) privilege is required. During the import operation: * If the specified group is not available in ThoughtSpot, it will be added to ThoughtSpot. * If `delete_unspecified_groups` is set to `true`, the groups not specified in the API request, excluding administrator and system user groups, are deleted. * If the specified groups are already available in ThoughtSpot, the object properties of these groups are modified and synchronized as per the input data in the API request. A successful API call returns the object that represents the changes made in the ThoughtSpot system. * @param param the request object */ public importUserGroups(param: GroupsApiImportUserGroupsRequest, options?: Configuration): Promise { return this.api.importUserGroups(param.importUserGroupsRequest, options).toPromise(); } /** * Version: 9.0.0.cl or later Gets a list of user group objects from the ThoughtSpot system. To get details of a specific user group, specify the user group GUID or name. You can also filter the API response based on User ID, Org ID, Role ID, type of group, sharing visibility, privileges assigned to the group, and the Liveboard IDs assigned to the users in the group. Available to all users. Users with `ADMINISTRATION` (**Can administer ThoughtSpot**) privileges can view all users properties. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `GROUP_ADMINISTRATION` (**Can manage groups**) privilege is required. **NOTE**: If you do not get precise results, try setting `record_size` to `-1` and `record_offset` to `0`. * @param param the request object */ public searchUserGroups(param: GroupsApiSearchUserGroupsRequest, options?: Configuration): Promise> { return this.api.searchUserGroups(param.searchUserGroupsRequest, options).toPromise(); } /** * Version: 9.0.0.cl or later Updates the properties of a group object in ThoughtSpot. Requires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `GROUP_ADMINISTRATION` (**Can manage groups**) privilege is required. #### Supported operations This API endpoint lets you perform the following operations in a single API request: * Edit [privileges](https://developers.thoughtspot.com/docs/?pageid=api-user-management#group-privileges) * Add or remove users * Change sharing visibility settings * Add or remove sub-groups * Assign a default Liveboard or update the existing settings * @param param the request object */ public updateUserGroup(param: GroupsApiUpdateUserGroupRequest, options?: Configuration): Promise { return this.api.updateUserGroup(param.groupIdentifier, param.updateUserGroupRequest, options).toPromise(); } } import { ObservableJobsApi } from "./ObservableAPI"; import { JobsApiRequestFactory, JobsApiResponseProcessor} from "../apis/JobsApi"; export interface JobsApiSearchChannelHistoryRequest { /** * * @type SearchChannelHistoryRequest * @memberof JobsApisearchChannelHistory */ searchChannelHistoryRequest: SearchChannelHistoryRequest } export class ObjectJobsApi { private api: ObservableJobsApi public constructor(configuration: Configuration, requestFactory?: JobsApiRequestFactory, responseProcessor?: JobsApiResponseProcessor) { this.api = new ObservableJobsApi(configuration, requestFactory, responseProcessor); } /** * Version: 26.4.0.cl or later Searches delivery history for communication channels such as webhooks. Returns channel-level delivery status for each job execution record. Use this to monitor channel health and delivery success rates across events. Requires `ADMINISTRATION` (**Can administer ThoughtSpot**) or `DEVELOPER` (**Has developer privilege**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, users with `CAN_MANAGE_WEBHOOKS` (**Can manage webhooks**) privilege are also authorized to perform this action. **NOTE**: When `channel_type` is `WEBHOOK`, the following constraints apply: - `job_ids`, `channel_identifiers`, and `events` each accept at most one element. - When `job_ids` is provided, it is used as the sole lookup key and other filter fields are ignored. - When `job_ids` is not provided, `channel_identifiers` and `events` are both required. Each must contain exactly one element, and the event object must include the `identifier` field. - Records older than the configured retention period are not returned. * @param param the request object */ public searchChannelHistory(param: JobsApiSearchChannelHistoryRequest, options?: Configuration): Promise { return this.api.searchChannelHistory(param.searchChannelHistoryRequest, options).toPromise(); } } import { ObservableLogApi } from "./ObservableAPI"; import { LogApiRequestFactory, LogApiResponseProcessor} from "../apis/LogApi"; export interface LogApiFetchLogsRequest { /** * * @type FetchLogsRequest * @memberof LogApifetchLogs */ fetchLogsRequest: FetchLogsRequest } export class ObjectLogApi { private api: ObservableLogApi public constructor(configuration: Configuration, requestFactory?: LogApiRequestFactory, responseProcessor?: LogApiResponseProcessor) { this.api = new ObservableLogApi(configuration, requestFactory, responseProcessor); } /** * Version: 9.0.0.cl or later Fetches security audit logs. Requires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the [Admin Control](https://developers.thoughtspot.com/docs/rbac#_admin_control) privileges are required. #### Usage guidelines By default, the API retrieves logs for the last 24 hours. You can set a custom duration in EPOCH time. Make sure the log duration specified in your API request doesn’t exceed 24 hours. If you must fetch logs for a longer time range, modify the duration and make multiple sequential API requests. Upon successful execution, the API returns logs with the following information: * timestamp of the event * event ID * event type * name and GUID of the user * IP address of ThoughtSpot instance For more information see [Audit logs Documentation](https://developers.thoughtspot.com/docs/audit-logs). * @param param the request object */ public fetchLogs(param: LogApiFetchLogsRequest, options?: Configuration): Promise> { return this.api.fetchLogs(param.fetchLogsRequest, options).toPromise(); } } import { ObservableMetadataApi } from "./ObservableAPI"; import { MetadataApiRequestFactory, MetadataApiResponseProcessor} from "../apis/MetadataApi"; export interface MetadataApiConvertWorksheetToModelRequest { /** * * @type ConvertWorksheetToModelRequest * @memberof MetadataApiconvertWorksheetToModel */ convertWorksheetToModelRequest: ConvertWorksheetToModelRequest } export interface MetadataApiCopyObjectRequest { /** * * @type CopyObjectRequest * @memberof MetadataApicopyObject */ copyObjectRequest: CopyObjectRequest } export interface MetadataApiDeleteMetadataRequest { /** * * @type DeleteMetadataRequest * @memberof MetadataApideleteMetadata */ deleteMetadataRequest: DeleteMetadataRequest } export interface MetadataApiExportMetadataTMLRequest { /** * * @type ExportMetadataTMLRequest * @memberof MetadataApiexportMetadataTML */ exportMetadataTMLRequest: ExportMetadataTMLRequest } export interface MetadataApiExportMetadataTMLBatchedRequest { /** * * @type ExportMetadataTMLBatchedRequest * @memberof MetadataApiexportMetadataTMLBatched */ exportMetadataTMLBatchedRequest: ExportMetadataTMLBatchedRequest } export interface MetadataApiFetchAnswerSqlQueryRequest { /** * * @type FetchAnswerSqlQueryRequest * @memberof MetadataApifetchAnswerSqlQuery */ fetchAnswerSqlQueryRequest: FetchAnswerSqlQueryRequest } export interface MetadataApiFetchAsyncImportTaskStatusRequest { /** * * @type FetchAsyncImportTaskStatusRequest * @memberof MetadataApifetchAsyncImportTaskStatus */ fetchAsyncImportTaskStatusRequest: FetchAsyncImportTaskStatusRequest } export interface MetadataApiFetchLiveboardSqlQueryRequest { /** * * @type FetchLiveboardSqlQueryRequest * @memberof MetadataApifetchLiveboardSqlQuery */ fetchLiveboardSqlQueryRequest: FetchLiveboardSqlQueryRequest } export interface MetadataApiImportMetadataTMLRequest { /** * * @type ImportMetadataTMLRequest * @memberof MetadataApiimportMetadataTML */ importMetadataTMLRequest: ImportMetadataTMLRequest } export interface MetadataApiImportMetadataTMLAsyncRequest { /** * * @type ImportMetadataTMLAsyncRequest * @memberof MetadataApiimportMetadataTMLAsync */ importMetadataTMLAsyncRequest: ImportMetadataTMLAsyncRequest } export interface MetadataApiParameterizeMetadataRequest { /** * * @type ParameterizeMetadataRequest * @memberof MetadataApiparameterizeMetadata */ parameterizeMetadataRequest: ParameterizeMetadataRequest } export interface MetadataApiParameterizeMetadataFieldsRequest { /** * * @type ParameterizeMetadataFieldsRequest * @memberof MetadataApiparameterizeMetadataFields */ parameterizeMetadataFieldsRequest: ParameterizeMetadataFieldsRequest } export interface MetadataApiSearchMetadataRequest { /** * * @type SearchMetadataRequest * @memberof MetadataApisearchMetadata */ searchMetadataRequest: SearchMetadataRequest } export interface MetadataApiUnparameterizeMetadataRequest { /** * * @type UnparameterizeMetadataRequest * @memberof MetadataApiunparameterizeMetadata */ unparameterizeMetadataRequest: UnparameterizeMetadataRequest } export interface MetadataApiUpdateMetadataHeaderRequest { /** * * @type UpdateMetadataHeaderRequest * @memberof MetadataApiupdateMetadataHeader */ updateMetadataHeaderRequest: UpdateMetadataHeaderRequest } export interface MetadataApiUpdateMetadataObjIdRequest { /** * * @type UpdateMetadataObjIdRequest * @memberof MetadataApiupdateMetadataObjId */ updateMetadataObjIdRequest: UpdateMetadataObjIdRequest } export class ObjectMetadataApi { private api: ObservableMetadataApi public constructor(configuration: Configuration, requestFactory?: MetadataApiRequestFactory, responseProcessor?: MetadataApiResponseProcessor) { this.api = new ObservableMetadataApi(configuration, requestFactory, responseProcessor); } /** * Convert worksheets to models Version: 10.6.0.cl or later ## Prerequisites - **Privileges Required:** - `DATAMANAGEMENT` (Can manage data) or `ADMINISTRATION` (Can administer ThoughtSpot). - **Additional Privileges (if RBAC is enabled):** - `CAN_MANAGE_WORKSHEET_VIEWS_TABLES` (Can manage data models). --- ## Usage Guidelines ### Parameters 1. **worksheet_ids** - **Description:** A comma-separated list of GUIDs (Globally Unique Identifiers) specifying the Worksheets to be converted. - **Usage:** - Used only when `convert_all` is set to `false`. - Leave empty or omit when `convert_all` is set to `true`. 2. **exclude_worksheet_ids** - **Description:** A comma-separated list of GUIDs specifying Worksheets to be excluded from conversion. - **Usage:** - Useful when `convert_all` is set to `true` and specific Worksheets should not be converted. 3. **convert_all** - **Description:** Sets the scope of conversion. - **Options:** - `true`: Converts all Worksheets in the system, except those specified in `exclude_worksheet_ids`. - `false`: Converts only the Worksheets listed in `worksheet_ids`. 4. **apply_changes** - **Description:** Specifies whether to apply changes directly to ThoughtSpot or to generate a preview before applying any changes.Used for validation of conversion. - **Options:** - `true`: Applies conversion changes directly to ThoughtSpot. - `false`: Generates only a preview of the changes and does not apply any changes to ThoughtSpot --- ## Best Practices 1. **Backup Before Conversion:** Always export metadata as a backup before initiating the conversion process 2. **Partial Conversion for Testing:** Test the conversion process by setting `convert_all` to `false` and specifying a small number of `worksheet_ids`. 3. **Verify Dependencies:** Check for dependent objects, such as Tables and Connections, to avoid invalid references. 4. **Review Changes:** Use `apply_changes: false` to preview the impact of the conversion before applying changes. --- ## Examples ### Convert Specific Worksheets ```json { \"worksheet_ids\": [\"guid1\", \"guid2\", \"guid3\"], \"exclude_worksheet_ids\": [], \"convert_all\": false, \"apply_changes\": true } ``` ### Convert All Accessible Worksheets ```json { \"worksheet_ids\": [], \"exclude_worksheet_ids\": [], \"convert_all\": true, \"apply_changes\": true } ``` ### Exclude Specific Worksheets While Converting All Accessible Worksheets ```json { \"worksheet_ids\": [], \"exclude_worksheet_ids\": [\"abc\"], \"convert_all\": true, \"apply_changes\": true } ``` * @param param the request object */ public convertWorksheetToModel(param: MetadataApiConvertWorksheetToModelRequest, options?: Configuration): Promise { return this.api.convertWorksheetToModel(param.convertWorksheetToModelRequest, options).toPromise(); } /** * Makes a copy of an Answer or Liveboard Version: 10.3.0.cl or later Creates a copy of a metadata object. Requires at least view access to the metadata object being copied. Upon successful execution, the API creates a copy of the metadata object specified in the API request and returns the ID of the new object. * @param param the request object */ public copyObject(param: MetadataApiCopyObjectRequest, options?: Configuration): Promise { return this.api.copyObject(param.copyObjectRequest, options).toPromise(); } /** * Version: 9.0.0.cl or later Removes the specified metadata object from the ThoughtSpot system. Requires edit access to the metadata object. * @param param the request object */ public deleteMetadata(param: MetadataApiDeleteMetadataRequest, options?: Configuration): Promise { return this.api.deleteMetadata(param.deleteMetadataRequest, options).toPromise(); } /** * Version: 9.0.0.cl or later Exports the [TML](https://docs.thoughtspot.com/cloud/latest/tml) representation of metadata objects in JSON or YAML format. Requires `DATADOWNLOADING` (**Can download Data**) and at least view access to the metadata object. #### Usage guidelines * You can export one or several objects by passing metadata object GUIDs in the `metadata` array. * When exporting TML content for a Liveboard or Answer object, you can set `export_associated` to `true` to retrieve TML content for underlying Worksheets, Tables, or Views, including the GUID of each object within the headers. When `export_associated` is set to `true`, consider retrieving one metadata object at a time. * Set `export_fqns` to `true` to add FQNs of the referenced objects in the TML content. For example, if you send an API request to retrieve TML for a Liveboard and its associated objects, the API returns the TML content with FQNs of the referenced Worksheet. Exporting TML with FQNs is useful if ThoughtSpot has multiple objects with the same name and you want to eliminate ambiguity when importing TML files into ThoughtSpot. It eliminates the need for adding FQNs of the referenced objects manually during the import operation. * To export only the TML of feedbacks associated with an object, set the GUID of the object as `identifier`, and set the `type` as `FEEDBACK` in the `metadata` array. * To export the TML of an object along with the feedbacks associated with it, set the GUID of the object as `identifier`, set the `type` as `LOGIAL_TABLE` in the `metadata` array, and set `export_with_associated_feedbacks` in `export_options` to true. For more information, see [TML Documentation](https://developers.thoughtspot.com/docs/tml#_export_a_tml). For more information on feedbacks, see [Feedback Documentation](https://docs.thoughtspot.com/cloud/latest/sage-feedback). * @param param the request object */ public exportMetadataTML(param: MetadataApiExportMetadataTMLRequest, options?: Configuration): Promise> { return this.api.exportMetadataTML(param.exportMetadataTMLRequest, options).toPromise(); } /** * Version: 10.1.0.cl or later Exports the [TML](https://docs.thoughtspot.com/cloud/latest/tml) representation of metadata objects in JSON or YAML format. ### **Permissions Required** Requires `DATAMANAGEMENT` (**Can manage data**) and `USERMANAGEMENT` (**Can manage users**) privileges. #### **Usage Guidelines** This API is only applicable for `USER`, `GROUP`, and `ROLES` metadata types. - `batch_offset` Indicates the starting position within the complete dataset from which the API should begin returning objects. Useful for paginating results efficiently. - `batch_size` Specifies the number of objects or items to retrieve in a single request. Helps control response size for better performance. - `edoc_format` Defines the format of the TML content. The exported metadata can be in JSON or YAML format. - `export_dependent` Specifies whether to include dependent metadata objects in the export. Ensures related objects are also retrieved if needed. - `all_orgs_override` Indicates whether the export operation applies across all organizations. Useful for multi-tenant environments where cross-org exports are required. * @param param the request object */ public exportMetadataTMLBatched(param: MetadataApiExportMetadataTMLBatchedRequest, options?: Configuration): Promise { return this.api.exportMetadataTMLBatched(param.exportMetadataTMLBatchedRequest, options).toPromise(); } /** * Version: 9.0.0.cl or later Fetches the underlying SQL query data for an Answer object. Requires at least view access to the Answer object. Upon successful execution, the API returns the SQL queries for the specified object as shown in this example: ``` { \"metadata_id\":\"8fbe44a8-46ad-4b16-8d39-184b2fada490\", \"metadata_name\":\"Total sales\", \"metadata_type\":\"ANSWER\", \"sql_queries\":[ { \"metadata_id\":\"8fbe44a8-46ad-4b16-8d39-184b2fada490\", \"metadata_name\":\"Total sales -test\", \"sql_query\":\"SELECT \\n \\\"ta_1\\\".\\\"REGION\\\" \\\"ca_1\\\", \\n \\\"ta_2\\\".\\\"PRODUCTNAME\\\" \\\"ca_2\\\", \\n \\\"ta_1\\\".\\\"STORENAME\\\" \\\"ca_3\\\", \\n CASE\\n WHEN sum(\\\"ta_3\\\".\\\"SALES\\\") IS NOT NULL THEN sum(\\\"ta_3\\\".\\\"SALES\\\")\\n ELSE 0\\n END \\\"ca_4\\\", \\n CASE\\n WHEN sum(\\\"ta_3\\\".\\\"QUANTITYPURCHASED\\\") IS NOT NULL THEN sum(\\\"ta_3\\\".\\\"QUANTITYPURCHASED\\\")\\n ELSE 0\\n END \\\"ca_5\\\"\\nFROM \\\"RETAILAPPAREL\\\".\\\"PUBLIC\\\".\\\"FACT_RETAPP_SALES\\\" \\\"ta_3\\\"\\n JOIN \\\"RETAILAPPAREL\\\".\\\"PUBLIC\\\".\\\"DIM_RETAPP_STORES\\\" \\\"ta_1\\\"\\n ON \\\"ta_3\\\".\\\"STOREID\\\" = \\\"ta_1\\\".\\\"STOREID\\\"\\n JOIN \\\"RETAILAPPAREL\\\".\\\"PUBLIC\\\".\\\"DIM_RETAPP_PRODUCTS\\\" \\\"ta_2\\\"\\n ON \\\"ta_3\\\".\\\"PRODUCTID\\\" = \\\"ta_2\\\".\\\"PRODUCTID\\\"\\nGROUP BY \\n \\\"ca_1\\\", \\n \\\"ca_2\\\", \\n \\\"ca_3\\\"\\n\" } ] } ``` * @param param the request object */ public fetchAnswerSqlQuery(param: MetadataApiFetchAnswerSqlQueryRequest, options?: Configuration): Promise { return this.api.fetchAnswerSqlQuery(param.fetchAnswerSqlQueryRequest, options).toPromise(); } /** * Version: 10.4.0.cl or later Gets information about the status of the TML async import task scheduled using the `/api/rest/2.0/metadata/tml/async/import` API call. To fetch the task details, specify the ID of the TML async import task. Requires access to the task ID. The API allows users who initiated the asynchronous TML import via `/api/rest/2.0/metadata/tml/async/import` to view the status of their tasks. Users with administration privilege can view the status of all import tasks initiated by the users in their Org. #### Usage guidelines See [TML API Documentation](https://developers.thoughtspot.com/docs/tml#_fetch_status_of_the_tml_import_task) for usage guidelines. * @param param the request object */ public fetchAsyncImportTaskStatus(param: MetadataApiFetchAsyncImportTaskStatusRequest, options?: Configuration): Promise { return this.api.fetchAsyncImportTaskStatus(param.fetchAsyncImportTaskStatusRequest, options).toPromise(); } /** * Version: 9.0.0.cl or later Fetches the underlying SQL query data for a Liveboard object and its visualizations. Requires at least view access to the Liveboard object. To get SQL query data for a Liveboard, specify the GUID of the Liveboard. Optionally, you can add an array of visualization GUIDs to retrieve the SQL query data for visualizations in the Liveboard. Upon successful execution, the API returns the SQL queries for the specified object as shown in this example: ``` { \"metadata_id\": \"fa68ae91-7588-4136-bacd-d71fb12dda69\", \"metadata_name\": \"Total Sales\", \"metadata_type\": \"LIVEBOARD\", \"sql_queries\": [ { \"metadata_id\": \"b3b6d2b9-089a-490c-8e16-b144650b7843\", \"metadata_name\": \"Total quantity purchased, Total sales by region\", \"sql_query\": \"SELECT \\n \\\"ta_1\\\".\\\"REGION\\\" \\\"ca_1\\\", \\n CASE\\n WHEN sum(\\\"ta_2\\\".\\\"QUANTITYPURCHASED\\\") IS NOT NULL THEN sum(\\\"ta_2\\\".\\\"QUANTITYPURCHASED\\\")\\n ELSE 0\\n END \\\"ca_2\\\", \\n CASE\\n WHEN sum(\\\"ta_2\\\".\\\"SALES\\\") IS NOT NULL THEN sum(\\\"ta_2\\\".\\\"SALES\\\")\\n ELSE 0\\n END \\\"ca_3\\\"\\nFROM \\\"RETAILAPPAREL\\\".\\\"PUBLIC\\\".\\\"FACT_RETAPP_SALES\\\" \\\"ta_2\\\"\\n JOIN \\\"RETAILAPPAREL\\\".\\\"PUBLIC\\\".\\\"DIM_RETAPP_STORES\\\" \\\"ta_1\\\"\\n ON \\\"ta_2\\\".\\\"STOREID\\\" = \\\"ta_1\\\".\\\"STOREID\\\"\\nGROUP BY \\\"ca_1\\\"\" } ] } ``` * @param param the request object */ public fetchLiveboardSqlQuery(param: MetadataApiFetchLiveboardSqlQueryRequest, options?: Configuration): Promise { return this.api.fetchLiveboardSqlQuery(param.fetchLiveboardSqlQueryRequest, options).toPromise(); } /** * Version: 9.0.0.cl or later Imports [TML](https://docs.thoughtspot.com/cloud/latest/tml) files into ThoughtSpot. Requires `DATAMANAGEMENT` (**Can manage data**) or `ADMINISTRATION` (**Can administer ThoughtsSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the following Data control privileges may be required: - `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**) - `CAN_MANAGE_WORKSHEET_VIEWS_TABLES` (**Can manage data models**) #### Usage guidelines * Import all related objects in a single TML Import API call. For example, Tables that use the same Connection object and Worksheets connected to these Tables. * Include the `fqn` property to distinguish objects that have the same name. For example, if you have multiple Connections or Worksheets with the same name on ThoughtSpot and the Connection or Worksheet referenced in your TML file does not have a unique name to distinguish, it may result in invalid object references. Adding `fqn` helps ThoughtSpot differentiate a Table from another with the same name. We recommend [exporting TML with FQNs](#/http/api-endpoints/metadata/export-metadata-tml) and using these during the import operation. * You can upload multiple TML files at a time. If you import a Worksheet along with Liveboards, Answers, and other dependent objects in a single API call, the imported objects will be immediately available for use. When you import only a Worksheet object, it may take some time for the Worksheet to become available in the ThoughtSpot system. Please wait for a few minutes, and then proceed to create an Answer and Liveboard from the newly imported Worksheet. For more information, see [TML Documentation](https://developers.thoughtspot.com/docs/tml#_import_a_tml). * @param param the request object */ public importMetadataTML(param: MetadataApiImportMetadataTMLRequest, options?: Configuration): Promise> { return this.api.importMetadataTML(param.importMetadataTMLRequest, options).toPromise(); } /** * Version: 10.4.0.cl or later Schedules a task to import [TML](https://docs.thoughtspot.com/cloud/latest/tml) files into ThoughtSpot. You can use this API endpoint to process TML objects asynchronously when importing TMLs of large and complex metadata objects into ThoughtSpot. Unlike the synchronous import TML operation, the API processes TML data in the background and returns a task ID, which can be used to check the status of the import task via `/api/rest/2.0/metadata/tml/async/status` API endpoint. Requires `DATAMANAGEMENT` (**Can manage data**) or `ADMINISTRATION` (**Can administer ThoughtsSpot**) privilege, and edit access to the TML objects. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the following Data control privileges may be required: - `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**) - `CAN_MANAGE_WORKSHEET_VIEWS_TABLES` (**Can manage data models**) #### Usage guidelines See [Async TML API Documentation](https://developers.thoughtspot.com/docs/tml#_import_tml_objects_asynchronously) for usage guidelines. * @param param the request object */ public importMetadataTMLAsync(param: MetadataApiImportMetadataTMLAsyncRequest, options?: Configuration): Promise { return this.api.importMetadataTMLAsync(param.importMetadataTMLAsyncRequest, options).toPromise(); } /** * Parameterize fields in metadata objects. Version: 10.9.0.cl or later **Note:** This API endpoint is deprecated and will be removed from ThoughtSpot in a future release. Use [POST /api/rest/2.0/metadata/parameterize-fields](/api/rest/2.0/metadata/parameterize-fields) instead. Allows parameterizing fields in metadata objects in ThoughtSpot. Requires appropriate permissions to modify the metadata object. The API endpoint allows parameterizing the following types of metadata objects: * Logical Tables * Connections * Connection Configs For a Logical Table the field type must be `ATTRIBUTE` and field name can be one of: * databaseName * schemaName * tableName For a Connection or Connection Config, the field type is always `CONNECTION_PROPERTY`. In this case, field_name specifies the exact property of the Connection or Connection Config that needs to be parameterized. For Connection Config, the only supported field name is: * impersonate_user * @param param the request object */ public parameterizeMetadata(param: MetadataApiParameterizeMetadataRequest, options?: Configuration): Promise { return this.api.parameterizeMetadata(param.parameterizeMetadataRequest, options).toPromise(); } /** * Parameterize multiple fields of metadata objects. For example [schemaName, databaseName] for LOGICAL_TABLE. Version: 26.4.0.cl or later Allows parameterizing multiple fields of metadata objects in ThoughtSpot. For example, you can parameterize [schemaName, databaseName] for LOGICAL_TABLE. Requires appropriate permissions to modify the metadata object. The API endpoint allows parameterizing the following types of metadata objects: * Logical Tables * Connections * Connection Configs For a Logical Table, the field type must be `ATTRIBUTE` and field names can include: * databaseName * schemaName * tableName For a Connection or Connection Config, the field type is always `CONNECTION_PROPERTY`. In this case, field_names specifies the exact properties of the Connection or Connection Config that need to be parameterized. For Connection Config, supported field names include: * impersonate_user You can parameterize multiple fields at once by providing an array of field names. * @param param the request object */ public parameterizeMetadataFields(param: MetadataApiParameterizeMetadataFieldsRequest, options?: Configuration): Promise { return this.api.parameterizeMetadataFields(param.parameterizeMetadataFieldsRequest, options).toPromise(); } /** * Version: 9.0.0.cl or later Gets a list of metadata objects available on the ThoughtSpot system. This API endpoint is available to all users who have view access to the object. Users with `ADMINISTRATION` (**Can administer ThoughtSpot**) privileges can view data for all metadata objects, including users and groups. #### Usage guidelines - To get all metadata objects, send the API request without any attributes. - To get metadata objects of a specific type, set the `type` attribute. For example, to fetch a Worksheet, set the type as `LOGICAL_TABLE`. - To filter metadata objects within type `LOGICAL_TABLE`, set the `subtypes` attribute. For example, to fetch a Worksheet, set the type as `LOGICAL_TABLE` & subtypes as `[WORKSHEET]`. - To get a specific metadata object, specify the GUID. - To customize your search and filter the API response, you can use several parameters. You can search for objects created or modified by specific users, by tags applied to the objects, or by using the include parameters like `include_auto_created_objects`, `include_dependent_objects`, `include_headers`, `include_incomplete_objects`, and so on. You can also define sorting options to sort the data retrieved in the API response. - To get discoverable objects when linientmodel is enabled you can use `include_discoverable_objects` as true else false. Default value is true. - For liveboard metadata type, to get the newer format, set the `liveboard_response_format` as V2. Default value is V1. - To retrieve only objects that are published, set the `include_only_published_objects` as true. Default value is false. **NOTE**: The following parameters support pagination of metadata records: - `tag_identifiers` - `type` - `subtypes` - `created_by_user_identifiers` - `modified_by_user_identifiers` - `owned_by_user_identifiers` - `exclude_objects` - `include_auto_created_objects` - `favorite_object_options` - `include_only_published_objects` If you are using other parameters to search metadata, set `record_size` to `-1` and `record_offset` to `0`. * @param param the request object */ public searchMetadata(param: MetadataApiSearchMetadataRequest, options?: Configuration): Promise> { return this.api.searchMetadata(param.searchMetadataRequest, options).toPromise(); } /** * Remove parameterization from fields in metadata objects. Version: 10.9.0.cl or later Allows removing parameterization from fields in metadata objects in ThoughtSpot. Requires appropriate permissions to modify the metadata object. The API endpoint allows unparameterizing the following types of metadata objects: * Logical Tables * Connections * Connection Configs For a Logical Table the field type must be `ATTRIBUTE` and field name can be one of: * databaseName * schemaName * tableName For a Connection or Connection Config, the field type is always `CONNECTION_PROPERTY`. In this case, field_name specifies the exact property of the Connection or Connection Config that needs to be unparameterized. For Connection Config, the only supported field name is: * impersonate_user * @param param the request object */ public unparameterizeMetadata(param: MetadataApiUnparameterizeMetadataRequest, options?: Configuration): Promise { return this.api.unparameterizeMetadata(param.unparameterizeMetadataRequest, options).toPromise(); } /** * Update header attributes for a given list of header objects. Version: 10.6.0.cl or later ## Prerequisites - **Privileges Required:** - `DATAMANAGEMENT` (Can manage data) or `ADMINISTRATION` (Can administer ThoughtSpot). - **Additional Privileges (if RBAC is enabled):** - `ORG_ADMINISTRATION` (Can manage orgs). --- ## Usage Guidelines ### Parameters 1. **headers_update** - **Description:** List of header objects with their attributes to be updated. Each object contains a list of attributes to be updated in the header. - **Usage:** - You must provide either `identifier` or `obj_identifier`, but not both. Both fields cannot be empty. - When `org_identifier` is set to `-1`, only the `identifier` value is accepted; `obj_identifier` is not allowed. 2. **org_identifier** - **Description:** GUID (Globally Unique Identifier) or name of the organization. - **Usage:** - Leaving this field empty assumes that the changes should be applied to the current organization - Provide `org_guid` or `org_name` to uniquely identify the organization where changes need to be applied. . - Provide `-1` if changes have to be applied across all the org. --- ## Note Currently, this API is enabled only for updating the `obj_identifier` attribute. Only `text` will be allowed in attribute\'s value. ## Best Practices 1. **Backup Before Conversion:** Always export metadata as a backup before initiating the update process --- ## Examples ### Only `identifier` is given ```json { \"headers_update\": [ { \"identifier\": \"guid_1\", \"obj_identifier\": \"\", \"type\": \"LOGICAL_COLUMN\", \"attributes\": [ { \"name\": \"obj_id\", \"value\": \"custom_object_id\" } ] } ], \"org_identifier\": \"orgGuid\" } ``` ### Only `obj_identifier` is given ```json { \"headers_update\": [ { \"obj_identifier\": \"custom_object_id\", \"type\": \"ANSWER\", \"attributes\": [ { \"name\": \"obj_id\", \"value\": \"custom_object_id\" } ] } ], \"org_identifier\": \"orgName\" } ``` ### Executing update for all org `-1` ```json { \"headers_update\": [ { \"identifier\": \"guid_1\", \"type\": \"ANSWER\", \"attributes\": [ { \"name\": \"obj_id\", \"value\": \"custom_object_id\" } ] } ], \"org_identifier\": -1 } ``` ### Optional `type` is not provided ```json { \"headers_update\": [ { \"identifier\": \"guid_1\", \"attributes\": [ { \"name\": \"obj_id\", \"value\": \"custom_object_id\" } ] } ], \"org_identifier\": -1 } ``` * @param param the request object */ public updateMetadataHeader(param: MetadataApiUpdateMetadataHeaderRequest, options?: Configuration): Promise { return this.api.updateMetadataHeader(param.updateMetadataHeaderRequest, options).toPromise(); } /** * Update object IDs for given metadata objects. Version: 10.8.0.cl or later ## Prerequisites - **Privileges Required:** - `DATAMANAGEMENT` (Can manage data) or `ADMINISTRATION` (Can administer ThoughtSpot). - **Additional Privileges (if RBAC is enabled):** - `ORG_ADMINISTRATION` (Can manage orgs). --- ## Usage Guidelines ### Parameters 1. **metadata** - **Description:** List of metadata objects to update their object IDs. - **Usage:** - Use either `current_obj_id` alone OR use `metadata_identifier` with `type` (when needed). - When using `metadata_identifier`, the `type` field is required if using a name instead of a GUID. - The `new_obj_id` field is always required. --- ## Note This API is specifically designed for updating object IDs of metadata objects. It internally uses the header update mechanism to perform the changes. ## Best Practices 1. **Backup Before Update:** Always export metadata as a backup before initiating the update process. 2. **Validation:** - When using `current_obj_id`, ensure it matches the existing object ID exactly. - When using `metadata_identifier` with a name, ensure the `type` is specified correctly. - Verify that the `new_obj_id` follows your naming conventions and is unique within your system. --- ## Examples ### Using current_obj_id ```json { \"metadata\": [ { \"current_obj_id\": \"existing_object_id\", \"new_obj_id\": \"new_object_id\" } ] } ``` ### Using metadata_identifier with GUID ```json { \"metadata\": [ { \"metadata_identifier\": \"01234567-89ab-cdef-0123-456789abcdef\", \"new_obj_id\": \"new_object_id\" } ] } ``` ### Using metadata_identifier with name and type ```json { \"metadata\": [ { \"metadata_identifier\": \"My Answer\", \"type\": \"ANSWER\", \"new_obj_id\": \"new_object_id\" } ] } ``` ### Multiple objects update ```json { \"metadata\": [ { \"current_obj_id\": \"existing_object_id_1\", \"new_obj_id\": \"new_object_id_1\" }, { \"metadata_identifier\": \"My Worksheet\", \"type\": \"LOGICAL_TABLE\", \"new_obj_id\": \"new_object_id_2\" } ] } ``` * @param param the request object */ public updateMetadataObjId(param: MetadataApiUpdateMetadataObjIdRequest, options?: Configuration): Promise { return this.api.updateMetadataObjId(param.updateMetadataObjIdRequest, options).toPromise(); } } import { ObservableOrgsApi } from "./ObservableAPI"; import { OrgsApiRequestFactory, OrgsApiResponseProcessor} from "../apis/OrgsApi"; export interface OrgsApiCreateOrgRequest { /** * * @type CreateOrgRequest * @memberof OrgsApicreateOrg */ createOrgRequest: CreateOrgRequest } export interface OrgsApiDeleteOrgRequest { /** * ID or name of the Org * @type string * @memberof OrgsApideleteOrg */ orgIdentifier: string } export interface OrgsApiSearchOrgsRequest { /** * * @type SearchOrgsRequest * @memberof OrgsApisearchOrgs */ searchOrgsRequest: SearchOrgsRequest } export interface OrgsApiUpdateOrgRequest { /** * ID or name of the Org * @type string * @memberof OrgsApiupdateOrg */ orgIdentifier: string /** * * @type UpdateOrgRequest * @memberof OrgsApiupdateOrg */ updateOrgRequest: UpdateOrgRequest } export class ObjectOrgsApi { private api: ObservableOrgsApi public constructor(configuration: Configuration, requestFactory?: OrgsApiRequestFactory, responseProcessor?: OrgsApiResponseProcessor) { this.api = new ObservableOrgsApi(configuration, requestFactory, responseProcessor); } /** * Version: 9.0.0.cl or later Creates an Org object. To use this API, the [Orgs](https://docs.thoughtspot.com/cloud/latest/orgs-overview) feature must be enabled in your cluster. Requires cluster administration (**Can administer Org**) privileges. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `ORG_ADMINISTRATION` (**Can manage Orgs**) privilege is required. * @param param the request object */ public createOrg(param: OrgsApiCreateOrgRequest, options?: Configuration): Promise { return this.api.createOrg(param.createOrgRequest, options).toPromise(); } /** * Version: 9.0.0.cl or later Deletes an Org object from the ThoughtSpot system. Requires cluster administration (**Can administer Org**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `ORG_ADMINISTRATION` (**Can manage Orgs**) privilege is required. When you delete an Org, all its users and objects created in that Org context are removed. However, if the users in the deleted Org also exists in other Orgs, they are removed only from the deleted Org. * @param param the request object */ public deleteOrg(param: OrgsApiDeleteOrgRequest, options?: Configuration): Promise { return this.api.deleteOrg(param.orgIdentifier, options).toPromise(); } /** * Version: 9.0.0.cl or later Gets a list of Orgs configured on the ThoughtSpot system. To get details of a specific Org, specify the Org ID or name. You can also pass parameters such as status, visibility, and user identifiers to get a specific list of Orgs. Requires cluster administration (**Can administer Org**) privileges. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `ORG_ADMINISTRATION` (**Can manage Orgs**) privilege is required. * @param param the request object */ public searchOrgs(param: OrgsApiSearchOrgsRequest, options?: Configuration): Promise> { return this.api.searchOrgs(param.searchOrgsRequest, options).toPromise(); } /** * Version: 9.0.0.cl or later Updates an Org object. You can modify Org properties such as name, description, and user associations. Requires cluster administration (**Can administer Org**) privileges. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `ORG_ADMINISTRATION` (**Can manage Orgs**) privilege is required. * @param param the request object */ public updateOrg(param: OrgsApiUpdateOrgRequest, options?: Configuration): Promise { return this.api.updateOrg(param.orgIdentifier, param.updateOrgRequest, options).toPromise(); } } import { ObservableReportsApi } from "./ObservableAPI"; import { ReportsApiRequestFactory, ReportsApiResponseProcessor} from "../apis/ReportsApi"; export interface ReportsApiExportAnswerReportRequest { /** * * @type ExportAnswerReportRequest * @memberof ReportsApiexportAnswerReport */ exportAnswerReportRequest: ExportAnswerReportRequest } export interface ReportsApiExportLiveboardReportRequest { /** * * @type ExportLiveboardReportRequest * @memberof ReportsApiexportLiveboardReport */ exportLiveboardReportRequest: ExportLiveboardReportRequest } export class ObjectReportsApi { private api: ObservableReportsApi public constructor(configuration: Configuration, requestFactory?: ReportsApiRequestFactory, responseProcessor?: ReportsApiResponseProcessor) { this.api = new ObservableReportsApi(configuration, requestFactory, responseProcessor); } /** * Version: 9.0.0.cl or later Exports an Answer in the given file format. You can download the Answer data as a PDF, PNG, CSV, or XLSX file. Requires at least view access to the Answer. #### Usage guidelines In the request body, the GUID or name of the Answer and set `file_format`. The default file format is CSV. **NOTE**: * The downloadable file returned in API response file is extensionless. Please rename the downloaded file by typing in the relevant extension. * HTML rendering is not supported for PDF exports of Answers with tables. Optionally, you can define [runtime overrides](https://developers.thoughtspot.com/docs/fetch-data-and-report-apis#_runtime_overrides) to apply to the Answer data. * @param param the request object */ public exportAnswerReport(param: ReportsApiExportAnswerReportRequest, options?: Configuration): Promise { return this.api.exportAnswerReport(param.exportAnswerReportRequest, options).toPromise(); } /** * Version: 9.0.0.cl or later Exports a Liveboard and its visualizations in PDF, PNG, CSV, or XLSX file format. The default `file_format` is CSV. Requires at least view access to the Liveboard. #### Usage guidelines In the request body, specify the GUID or name of the Liveboard. To generate a Liveboard report with specific visualizations, add GUIDs or names of the visualizations. **NOTE**: * The downloadable file returned in API response file is extensionless. Please rename the downloaded file by typing in the relevant extension. * Optionally, you can define [runtime overrides](https://developers.thoughtspot.com/docs/fetch-data-and-report-apis#_runtime_overrides) to apply to the Answer data. * To include unsaved changes in the report, pass the `transient_pinboard_content` script generated from the `getExportRequestForCurrentPinboard` method in the Visual Embed SDK. Upon successful execution, the API returns the report with unsaved changes, including ad hoc changes to visualizations. For more information, see [Liveboard Report API](https://developers.thoughtspot.com/docs/fetch-data-and-report-apis#_liveboard_report_api). * Starting with ThoughtSpot Cloud 10.9.0.cl release, the Liveboard can be exported in the PNG format in the resolution of your choice. To enable this on your instance, contact ThoughtSpot support. When this feature is enabled, the options `include_cover_page`,`include_filter_page` within the `png_options` will not be available for PNG exports. * Starting with the ThoughtSpot Cloud 26.2.0.cl release, * Liveboards can be exported in CSV format. * All visualizations within a Liveboard can be exported as individual CSV files. * When exporting multiple visualizations or the entire Liveboard, the system returns the report as a compressed ZIP file containing the separate CSV files for each visualization. * Liveboards can also be exported in XLSX format. * All selected visualizations are consolidated into a single Excel workbook (.xlsx), with each visualization placed in its own worksheet (tab). * XLSX exports are limited to a maximum of 255 worksheets (tabs) per workbook. * @param param the request object */ public exportLiveboardReport(param: ReportsApiExportLiveboardReportRequest, options?: Configuration): Promise { return this.api.exportLiveboardReport(param.exportLiveboardReportRequest, options).toPromise(); } } import { ObservableRolesApi } from "./ObservableAPI"; import { RolesApiRequestFactory, RolesApiResponseProcessor} from "../apis/RolesApi"; export interface RolesApiCreateRoleRequest { /** * * @type CreateRoleRequest * @memberof RolesApicreateRole */ createRoleRequest: CreateRoleRequest } export interface RolesApiDeleteRoleRequest { /** * Unique ID or name of the Role. ReadOnly roles cannot be deleted. * @type string * @memberof RolesApideleteRole */ roleIdentifier: string } export interface RolesApiSearchRolesRequest { /** * * @type SearchRolesRequest * @memberof RolesApisearchRoles */ searchRolesRequest: SearchRolesRequest } export interface RolesApiUpdateRoleRequest { /** * Unique ID or name of the Role. * @type string * @memberof RolesApiupdateRole */ roleIdentifier: string /** * * @type UpdateRoleRequest * @memberof RolesApiupdateRole */ updateRoleRequest: UpdateRoleRequest } export class ObjectRolesApi { private api: ObservableRolesApi public constructor(configuration: Configuration, requestFactory?: RolesApiRequestFactory, responseProcessor?: RolesApiResponseProcessor) { this.api = new ObservableRolesApi(configuration, requestFactory, responseProcessor); } /** * Version: 9.5.0.cl or later Creates a Role object in ThoughtSpot. Available only if [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance. To create a Role, the `ROLE_ADMINISTRATION` (**Can manage roles**) privilege is required. * @param param the request object */ public createRole(param: RolesApiCreateRoleRequest, options?: Configuration): Promise { return this.api.createRole(param.createRoleRequest, options).toPromise(); } /** * Version: 9.5.0.cl or later Deletes a Role object from the ThoughtSpot system. Available only if [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance. To delete a Role, the `ROLE_ADMINISTRATION` (**Can manage roles**) privilege is required. * @param param the request object */ public deleteRole(param: RolesApiDeleteRoleRequest, options?: Configuration): Promise { return this.api.deleteRole(param.roleIdentifier, options).toPromise(); } /** * Version: 9.5.0.cl or later Gets a list of Role objects from the ThoughtSpot system. Available if [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance. To search for Roles, the `ROLE_ADMINISTRATION` (**Can manage roles**) privilege is required. To get details of a specific Role object, specify the GUID or name. You can also filter the API response based on user group and Org identifiers, privileges assigned to the Role, and deprecation status. * @param param the request object */ public searchRoles(param: RolesApiSearchRolesRequest, options?: Configuration): Promise> { return this.api.searchRoles(param.searchRolesRequest, options).toPromise(); } /** * Version: 9.5.0.cl or later Updates the properties of a Role object. Available only if [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance. To update a Role, the `ROLE_ADMINISTRATION` (**Can manage roles**) privilege is required. * @param param the request object */ public updateRole(param: RolesApiUpdateRoleRequest, options?: Configuration): Promise { return this.api.updateRole(param.roleIdentifier, param.updateRoleRequest, options).toPromise(); } } import { ObservableSchedulesApi } from "./ObservableAPI"; import { SchedulesApiRequestFactory, SchedulesApiResponseProcessor} from "../apis/SchedulesApi"; export interface SchedulesApiCreateScheduleRequest { /** * * @type CreateScheduleRequest * @memberof SchedulesApicreateSchedule */ createScheduleRequest: CreateScheduleRequest } export interface SchedulesApiDeleteScheduleRequest { /** * Unique ID or name of the scheduled job. * @type string * @memberof SchedulesApideleteSchedule */ scheduleIdentifier: string } export interface SchedulesApiSearchSchedulesRequest { /** * * @type SearchSchedulesRequest * @memberof SchedulesApisearchSchedules */ searchSchedulesRequest: SearchSchedulesRequest } export interface SchedulesApiUpdateScheduleRequest { /** * Unique ID or name of the schedule. * @type string * @memberof SchedulesApiupdateSchedule */ scheduleIdentifier: string /** * * @type UpdateScheduleRequest * @memberof SchedulesApiupdateSchedule */ updateScheduleRequest: UpdateScheduleRequest } export class ObjectSchedulesApi { private api: ObservableSchedulesApi public constructor(configuration: Configuration, requestFactory?: SchedulesApiRequestFactory, responseProcessor?: SchedulesApiResponseProcessor) { this.api = new ObservableSchedulesApi(configuration, requestFactory, responseProcessor); } /** * Create schedule. Version: 9.4.0.cl or later Creates a Liveboard schedule job. Requires at least edit access to Liveboards. To create a schedule on behalf of another user, you need `ADMINISTRATION` (**Can administer Org**) or `JOBSCHEDULING` (**Can schedule for others**) privilege and edit access to the Liveboard. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `JOBSCHEDULING` (**Can schedule for others**) privilege is required. #### Usage guidelines * The description text is mandatory. The description text appears as **Description: ** in the Liveboard schedule email notifications. * For Liveboards with both charts and tables, schedule creation is only supported in PDF and XLS formats. Schedules created in CSV formats for such Liveboards will fail to run. If `PDF` is set as the `file_format`, enable `pdf_options` to get the correct attachment. Not doing so may cause the attachment to be rendered empty. * To include only specific visualizations, specify the visualization GUIDs in the `visualization_identifiers` array. * You can schedule a Liveboard job to run periodically by setting frequency parameters. You can set the schedule to run daily, weekly, monthly or every n minutes or hours. The scheduled job can also be configured to run at a specific time of the day or on specific days of the week or month. Please ensure that when setting the schedule frequency for _minute of the object_, only values that are multiples of 5 are included. * If the `frequency` parameters are defined, you can set the time zone to a value that matches your server\'s time zone. For example, `US/Central`, `Etc/UTC`, `CET`. The default time zone is `America/Los_Angeles`. For more information about Liveboard jobs, see [ThoughtSpot Product Documentation](https://docs.thoughtspot.com/cloud/latest/liveboard-schedule). * @param param the request object */ public createSchedule(param: SchedulesApiCreateScheduleRequest, options?: Configuration): Promise { return this.api.createSchedule(param.createScheduleRequest, options).toPromise(); } /** * Deletes a scheduled job. Version: 9.4.0.cl or later Deletes a scheduled Liveboard job. Requires at least edit access to Liveboard or `ADMINISTRATION` (**Can administer Org**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `JOBSCHEDULING` (**Can schedule for others**) privilege is required. * @param param the request object */ public deleteSchedule(param: SchedulesApiDeleteScheduleRequest, options?: Configuration): Promise { return this.api.deleteSchedule(param.scheduleIdentifier, options).toPromise(); } /** * Search Schedules Version: 9.4.0.cl or later Gets a list of scheduled jobs configured for a Liveboard. To get details of a specific scheduled job, specify the name or GUID of the scheduled job. Requires at least view access to Liveboards. **NOTE**: When filtering schedules by parameters other than `metadata`, set `record_size` to `-1` and `record_offset` to `0` for accurate results. * @param param the request object */ public searchSchedules(param: SchedulesApiSearchSchedulesRequest, options?: Configuration): Promise> { return this.api.searchSchedules(param.searchSchedulesRequest, options).toPromise(); } /** * Update schedule. Version: 9.4.0.cl or later Updates a scheduled Liveboard job. Requires at least edit access to Liveboards. To update a schedule on behalf of another user, you need `ADMINISTRATION` (**Can administer Org**) or `JOBSCHEDULING` (**Can schedule for others**) privilege and edit access to the Liveboard. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `JOBSCHEDULING` (**Can schedule for others**) privilege is required. The API endpoint allows you to pause a scheduled job, change the status of a paused job. You can also edit the recipients list, frequency of the job, format of the file to send to the recipients in email notifications, PDF options, and time zone setting. * @param param the request object */ public updateSchedule(param: SchedulesApiUpdateScheduleRequest, options?: Configuration): Promise { return this.api.updateSchedule(param.scheduleIdentifier, param.updateScheduleRequest, options).toPromise(); } } import { ObservableSecurityApi } from "./ObservableAPI"; import { SecurityApiRequestFactory, SecurityApiResponseProcessor} from "../apis/SecurityApi"; export interface SecurityApiAssignChangeAuthorRequest { /** * * @type AssignChangeAuthorRequest * @memberof SecurityApiassignChangeAuthor */ assignChangeAuthorRequest: AssignChangeAuthorRequest } export interface SecurityApiFetchColumnSecurityRulesRequest { /** * * @type FetchColumnSecurityRulesRequest * @memberof SecurityApifetchColumnSecurityRules */ fetchColumnSecurityRulesRequest: FetchColumnSecurityRulesRequest } export interface SecurityApiFetchObjectPrivilegesRequest { /** * * @type FetchObjectPrivilegesRequest * @memberof SecurityApifetchObjectPrivileges */ fetchObjectPrivilegesRequest: FetchObjectPrivilegesRequest } export interface SecurityApiFetchPermissionsOfPrincipalsRequest { /** * * @type FetchPermissionsOfPrincipalsRequest * @memberof SecurityApifetchPermissionsOfPrincipals */ fetchPermissionsOfPrincipalsRequest: FetchPermissionsOfPrincipalsRequest } export interface SecurityApiFetchPermissionsOnMetadataRequest { /** * * @type FetchPermissionsOnMetadataRequest * @memberof SecurityApifetchPermissionsOnMetadata */ fetchPermissionsOnMetadataRequest: FetchPermissionsOnMetadataRequest } export interface SecurityApiManageObjectPrivilegeRequest { /** * * @type ManageObjectPrivilegeRequest * @memberof SecurityApimanageObjectPrivilege */ manageObjectPrivilegeRequest: ManageObjectPrivilegeRequest } export interface SecurityApiPublishMetadataRequest { /** * * @type PublishMetadataRequest * @memberof SecurityApipublishMetadata */ publishMetadataRequest: PublishMetadataRequest } export interface SecurityApiShareMetadataRequest { /** * * @type ShareMetadataRequest * @memberof SecurityApishareMetadata */ shareMetadataRequest: ShareMetadataRequest } export interface SecurityApiUnpublishMetadataRequest { /** * * @type UnpublishMetadataRequest * @memberof SecurityApiunpublishMetadata */ unpublishMetadataRequest: UnpublishMetadataRequest } export interface SecurityApiUpdateColumnSecurityRulesRequest { /** * * @type UpdateColumnSecurityRulesRequest * @memberof SecurityApiupdateColumnSecurityRules */ updateColumnSecurityRulesRequest: UpdateColumnSecurityRulesRequest } export class ObjectSecurityApi { private api: ObservableSecurityApi public constructor(configuration: Configuration, requestFactory?: SecurityApiRequestFactory, responseProcessor?: SecurityApiResponseProcessor) { this.api = new ObservableSecurityApi(configuration, requestFactory, responseProcessor); } /** * Version: 9.0.0.cl or later Transfers the ownership of one or several objects from one user to another. Requires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `USER_ADMINISTRATION` (**Can manage users**) privilege and edit access to the objects are required. * @param param the request object */ public assignChangeAuthor(param: SecurityApiAssignChangeAuthorRequest, options?: Configuration): Promise { return this.api.assignChangeAuthor(param.assignChangeAuthorRequest, options).toPromise(); } /** * Version: 10.12.0.cl or later Fetches column security rules for specified tables. This API endpoint retrieves column-level security rules configured for tables. It returns information about which columns are secured and which groups have access to those columns. #### Usage guidelines - Provide an array of table identifiers using either `identifier` (GUID or name) or `obj_identifier` (object ID) - At least one of `identifier` or `obj_identifier` must be provided for each table - The API returns column security rules for all specified tables - Users must have appropriate permissions to access security rules for the specified tables #### Required permissions - `ADMINISTRATION` - Can administer ThoughtSpot - `DATAMANAGEMENT` - Can manage data - `CAN_MANAGE_WORKSHEET_VIEWS_TABLES` - Can manage worksheet views and tables #### Example request ```json { \"tables\": [ { \"identifier\": \"table-guid\", \"obj_identifier\": \"table-object-id\" } ] } ``` #### Response format The API returns an array of `ColumnSecurityRuleResponse` objects wrapped in a `data` field. Each `ColumnSecurityRuleResponse` object contains: - Table information (GUID and object ID) - Array of column security rules with column details, group access, and source table information #### Example response ```json { \"data\": [ { \"guid\": \"table-guid\", \"objId\": \"table-object-id\", \"columnSecurityRules\": [ { \"column\": { \"id\": \"col_123\", \"name\": \"Salary\" }, \"groups\": [ { \"id\": \"group_1\", \"name\": \"HR Department\" } ], \"sourceTableDetails\": { \"id\": \"source-table-guid\", \"name\": \"Employee_Data\" } } ] } ] } ``` * @param param the request object */ public fetchColumnSecurityRules(param: SecurityApiFetchColumnSecurityRulesRequest, options?: Configuration): Promise> { return this.api.fetchColumnSecurityRules(param.fetchColumnSecurityRulesRequest, options).toPromise(); } /** * Version: 26.3.0.cl or later This API fetches the object privileges present for the given list of principals (user or group), on the given set of objects. It supports pagination, which can be enabled and configured using the request parameters. It provides users access to certain features based on privilege based access control. #### Usage guidelines - Specify the `type` (`USER` or `USER_GROUP`) and `identifier` (either GUID or name) of the principals for which you want to retrieve object privilege information in the `principals` array. - Specify the `type` (`LOGICAL_TABLE`) and `identifier` (either GUID or name) of the metadata objects for which you want to retrieve object privilege information in the `metadata` array. Only `LOGICAL_TABLE` metadata type is supported for now. It may be extended for other metadata types in future. - To control the offset from where principals have to be fetched, use `record_offset`. When `record_offset` is 0, information is fetched from the beginning. - To control the number of principals to be fetched, use `record_size`. Default `record_size` is 20. - Ensure `record_offset` for a subsequent request is one more than the value of `record_size` of the previous request. - Ensure using correct Authorization Bearer Token corresponding to specific user & org. #### Example request ```json { \"principals\": [ { \"type\": \"type-1\", \"identifier\": \"principal-guid-or-name-1\" }, { \"type\": \"type-2\", \"identifier\": \"principal-guid-or-name-2\" } ], \"metadata\": [ { \"type\": \"metadata-type-1\", \"identifier\": \"metadata-guid-or-name-1\" }, { \"type\": \"metadata-type-2\", \"identifier\": \"metadata-guid-or-name-2\" } ], \"record_offset\": 0, \"record_size\": 20 } ``` #### Response format The API returns an array of `metadata_object_privileges` objects wrapped in JSON. Each `metadata_object_privileges` object contains: - Metadata information (GUID, name and type) - Array of `principal_object_privilege_info`. - Each `principal_object_privilege_info` contains: - Principal type. All principals of this type are listed as described below. - Array of `principal_object_privileges`. - Each `principal_object_privileges` contains: - Principal information (GUID, name, subtype) - List of applied object level privileges. #### Example response ```json { \"metadata_object_privileges\": [ { \"metadata_id\": \"metadata-guid-1\", \"metadata_name\": \"metadata-name-1\", \"metadata_type\": \"metadata-type-1\", \"principal_object_privilege_info\": [ { \"principal_type\": \"principal-type-1\", \"principal_object_privileges\": [ { \"principal_id\": \"principal-guid-1\", \"principal_name\": \"principal-name-1\", \"principal_sub_type\": \"principal-sub-type-1\", \"object_privileges\": \"[object-privilege-1, object-privilege-2]\" }, { \"principal_id\": \"principal-guid-2\", \"principal_name\": \"principal-name-2\", \"principal_sub_type\": \"principal-sub-type-2\", \"object_privileges\": \"[object-privilege-1, object-privilege-2]\" } ] }, { \"principal_type\": \"principal-type-2\", \"principal_object_privileges\": [ { \"principal_id\": \"principal-guid-3\", \"principal_name\": \"principal-guid-4\", \"principal_sub_type\": \"principal-sub-type-4\", \"object_privileges\": \"[object-privilege-1]\" } ] } ] }, { \"metadata_id\": \"metadata-guid-2\", \"metadata_name\": \"metadata-name-2\", \"metadata_type\": \"metadata-type-2\", \"principal_object_privilege_info\": [ { \"principal_type\": \"principal-type-1\", \"principal_object_privileges\": [ { \"principal_id\": \"principal-guid-1\", \"principal_name\": \"principal-name-1\", \"principal_sub_type\": \"principal-sub-type-1\", \"object_privileges\": \"[object-privilege-3, object-privilege-4]\" }, { \"principal_id\": \"principal-guid-2\", \"principal_name\": \"principal-name-2\", \"principal_sub_type\": \"principal-sub-type-2\", \"object_privileges\": \"[object-privilege-4]\" } ] } ] } ] } ``` * @param param the request object */ public fetchObjectPrivileges(param: SecurityApiFetchObjectPrivilegesRequest, options?: Configuration): Promise { return this.api.fetchObjectPrivileges(param.fetchObjectPrivilegesRequest, options).toPromise(); } /** * Version: 9.0.0.cl or later Fetches object permission details for a given principal object such as a user and group. Requires view access to the metadata object. #### Usage guidelines * To get a list of all metadata objects that a user or group can access, specify the `type` and GUID or name of the principal. * To get permission details for a specific object, add the `type` and GUID or name of the metadata object to your API request. Upon successful execution, the API returns a list of metadata objects and permission details for each object. * @param param the request object */ public fetchPermissionsOfPrincipals(param: SecurityApiFetchPermissionsOfPrincipalsRequest, options?: Configuration): Promise { return this.api.fetchPermissionsOfPrincipals(param.fetchPermissionsOfPrincipalsRequest, options).toPromise(); } /** * Version: 9.0.0.cl or later Fetches permission details for a given metadata object. Requires view access to the metadata object. #### Usage guidelines * To fetch a list of users and groups for a metadata object, specify `type` and GUID or name of the metadata object. * To get permission details for a specific user or group, add `type` and GUID or name of the principal object to your API request. Upon successful execution, the API returns permission details and principal information for the object specified in the API request. * @param param the request object */ public fetchPermissionsOnMetadata(param: SecurityApiFetchPermissionsOnMetadataRequest, options?: Configuration): Promise { return this.api.fetchPermissionsOnMetadata(param.fetchPermissionsOnMetadataRequest, options).toPromise(); } /** * Version: 26.3.0.cl or later This API allows the addition or deletion of object level privileges for a set of users and groups, on a set of metadata objects. It provides users to access certain features based on privilege based access control. #### Usage guidelines - Specify the `operation`. The supported operations are: `ADD`, `REMOVE`. - Specify the type of the objects on which the object privileges are being provided in `metadata_type`. Only `LOGICAL_TABLE` metadata type is supported for now. It may be extended for other metadata types in future. - Specify the list of object privilege types in the `object_privilege_types` array. The supported object privilege types are: `SPOTTER_COACHING_PRIVILEGE`. - Specify the identifiers (either GUID or name) for the metadata objects in the `metadata_identifiers` array. - Specify the `type` (`USER` or `USER_GROUP`) and `identifier` (either GUID or name) of the principals to which you want to apply the given operation and given object privileges in the `principals` array. - Ensure using correct Authorization Bearer Token corresponding to specific user & org. #### Example request ```json { \"operation\": \"operation-type\", \"metadata_type\": \"metadata-type\", \"object_privilege_types\": [\"privilege-type-1\", \"privilege-type-2\"], \"metadata_identifiers\": [\"metadata-guid-or-name-1\", \"metadata-guid-or-name-1\"], \"principals\": [ { \"type\": \"type-1\", \"identifier\": \"principal-guid-or-name-1\" }, { \"type\": \"type-2\", \"identifier\": \"principal-guid-or-name-2\" } ] } ``` > ###### Note: > * Only admin users, users with edit access and users with coaching privilege on a given data-model can add or remove principals related to SPOTTER_COACHING_PRIVILEGE * @param param the request object */ public manageObjectPrivilege(param: SecurityApiManageObjectPrivilegeRequest, options?: Configuration): Promise { return this.api.manageObjectPrivilege(param.manageObjectPrivilegeRequest, options).toPromise(); } /** * Version: 10.9.0.cl or later Allows publishing metadata objects across organizations in ThoughtSpot. Requires ADMINISTRATION role and TENANT scope. The API endpoint allows publishing the following types of metadata objects: * Liveboards * Answers * Logical Tables This API will essentially share the objects along with it\'s dependencies to the org admins of the orgs to which it is being published. * @param param the request object */ public publishMetadata(param: SecurityApiPublishMetadataRequest, options?: Configuration): Promise { return this.api.publishMetadata(param.publishMetadataRequest, options).toPromise(); } /** * Version: 9.0.0.cl or later Allows sharing one or several metadata objects with users and groups in ThoughtSpot. Requires edit access to the metadata object. #### Supported metadata objects: * Liveboards * Visualizations * Answers * Models * Views * Connections #### Object permissions You can provide `READ_ONLY` or `MODIFY` access when sharing an object with another user or group. The `READ_ONLY` permission grants view access to the shared object, whereas `MODIFY` provides edit access. To prevent a user or group from accessing the shared object, specify the GUID or name of the principal and set `shareMode` to `NO_ACCESS`. #### Sharing a visualization * Sharing a visualization implicitly shares the entire Liveboard with the recipient. * Object permissions set for a shared visualization also apply to the Liveboard unless overridden by another API request or via UI. * If email notifications for object sharing are enabled, a notification with a link to the shared visualization will be sent to the recipient’s email address. Although this link opens the shared visualization, recipients can also access other visualizations in the Liveboard. * @param param the request object */ public shareMetadata(param: SecurityApiShareMetadataRequest, options?: Configuration): Promise { return this.api.shareMetadata(param.shareMetadataRequest, options).toPromise(); } /** * Version: 10.9.0.cl or later Allows unpublishing metadata objects from organizations in ThoughtSpot. Requires ADMINISTRATION role and TENANT scope. The API endpoint allows unpublishing the following types of metadata objects: * Liveboards * Answers * Logical Tables When unpublishing objects, you can: * Include dependencies by setting `include_dependencies` to true - this will unpublish all dependent objects if no other published object is using them * Force unpublish by setting `force` to true - this will break all dependent objects in the unpublished organizations * @param param the request object */ public unpublishMetadata(param: SecurityApiUnpublishMetadataRequest, options?: Configuration): Promise { return this.api.unpublishMetadata(param.unpublishMetadataRequest, options).toPromise(); } /** * Version: 10.12.0.cl or later Creates, updates, or deletes column security rules for specified tables. This API endpoint allows you to create, update, or delete column-level security rules on columns of a table. The operation follows an \"all or none\" policy: if defining security rules for any of the provided columns fails, the entire operation will be rolled back, and no rules will be created. #### Usage guidelines - Provide table identifier using either `identifier` (GUID or name) or `obj_identifier` (object ID) - Use `clear_csr: true` to remove all column security rules from the table - For each column, specify the security rule using `column_security_rules` array - Use `is_unsecured: true` to mark a specific column as unprotected - Use `group_access` operations to manage group associations: - `ADD`: Add groups to the column\'s access list - `REMOVE`: Remove groups from the column\'s access list - `REPLACE`: Replace all existing groups with the specified groups #### Required permissions - `ADMINISTRATION` - Can administer ThoughtSpot - `DATAMANAGEMENT` - Can manage data (if RBAC is disabled) - `CAN_MANAGE_WORKSHEET_VIEWS_TABLES` - Can manage worksheet views and tables (if RBAC is enabled) #### Example request ```json { \"identifier\": \"table-guid\", \"obj_identifier\": \"table-object-id\", \"clear_csr\": false, \"column_security_rules\": [ { \"column_identifier\": \"col id or col name\", \"is_unsecured\": false, \"group_access\": [ { \"operation\": \"ADD\", \"group_identifiers\": [\"hr_group_id\", \"hr_group_name\", \"finance_group_id\"] } ] }, { \"column_identifier\": \"col id or col name\", \"is_unsecured\": true }, { \"column_identifier\": \"col id or col name\", \"is_unsecured\": false, \"group_access\": [ { \"operation\": \"REPLACE\", \"group_identifiers\": [\"management_group_id\", \"management_group_name\"] } ] } ] } ``` #### Request Body Schema - `identifier` (string, optional): GUID or name of the table for which we want to create column security rules - `obj_identifier` (string, optional): The object ID of the table - `clear_csr` (boolean, optional): If true, then all the secured columns will be marked as unprotected, and all the group associations will be removed - `column_security_rules` (array of objects, required): An array where each object defines the security rule for a specific column Each column security rule object contains: - `column_identifier` (string, required): Column identifier (col_id or name) - `is_unsecured` (boolean, optional): If true, the column will be marked as unprotected and all groups associated with it will be removed - `group_access` (array of objects, optional): Array of group operation objects Each group operation object contains: - `operation` (string, required): Operation type - ADD, REMOVE, or REPLACE - `group_identifiers` (array of strings, required): Array of group identifiers (name or GUID) on which the operation will be performed #### Response This API does not return any response body. A successful operation returns HTTP 200 status code. #### Operation Types - **ADD**: Adds the specified groups to the column\'s access list - **REMOVE**: Removes the specified groups from the column\'s access list - **REPLACE**: Replaces all existing groups with the specified groups * @param param the request object */ public updateColumnSecurityRules(param: SecurityApiUpdateColumnSecurityRulesRequest, options?: Configuration): Promise { return this.api.updateColumnSecurityRules(param.updateColumnSecurityRulesRequest, options).toPromise(); } } import { ObservableSystemApi } from "./ObservableAPI"; import { SystemApiRequestFactory, SystemApiResponseProcessor} from "../apis/SystemApi"; export interface SystemApiConfigureCommunicationChannelPreferencesRequest { /** * * @type ConfigureCommunicationChannelPreferencesRequest * @memberof SystemApiconfigureCommunicationChannelPreferences */ configureCommunicationChannelPreferencesRequest: ConfigureCommunicationChannelPreferencesRequest } export interface SystemApiConfigureSecuritySettingsRequest { /** * * @type ConfigureSecuritySettingsRequest * @memberof SystemApiconfigureSecuritySettings */ configureSecuritySettingsRequest: ConfigureSecuritySettingsRequest } export interface SystemApiGetSystemConfigRequest { } export interface SystemApiGetSystemInformationRequest { } export interface SystemApiGetSystemOverrideInfoRequest { } export interface SystemApiSearchCommunicationChannelPreferencesRequest { /** * * @type SearchCommunicationChannelPreferencesRequest * @memberof SystemApisearchCommunicationChannelPreferences */ searchCommunicationChannelPreferencesRequest: SearchCommunicationChannelPreferencesRequest } export interface SystemApiSearchSecuritySettingsRequest { /** * * @type SearchSecuritySettingsRequest * @memberof SystemApisearchSecuritySettings */ searchSecuritySettingsRequest: SearchSecuritySettingsRequest } export interface SystemApiUpdateSystemConfigRequest { /** * * @type UpdateSystemConfigRequest * @memberof SystemApiupdateSystemConfig */ updateSystemConfigRequest: UpdateSystemConfigRequest } export interface SystemApiValidateCommunicationChannelRequest { /** * * @type ValidateCommunicationChannelRequest * @memberof SystemApivalidateCommunicationChannel */ validateCommunicationChannelRequest: ValidateCommunicationChannelRequest } export class ObjectSystemApi { private api: ObservableSystemApi public constructor(configuration: Configuration, requestFactory?: SystemApiRequestFactory, responseProcessor?: SystemApiResponseProcessor) { this.api = new ObservableSystemApi(configuration, requestFactory, responseProcessor); } /** * Version: 10.14.0.cl or later Configure communication channel preferences. - Use `cluster_preferences` to update the default preferences for your ThoughtSpot application instance. - If your instance has [Orgs](https://docs.thoughtspot.com/cloud/latest/orgs-overview), use `org_preferences` to specify Org-specific preferences that override the defaults. Requires `ADMINISTRATION` (**Can administer ThoughtSpot**) or `DEVELOPER` (**Has developer privilege**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, users with `APPLICATION_ADMINISTRATION` (**Can manage application settings**) privilege are also authorized to perform this action. * @param param the request object */ public configureCommunicationChannelPreferences(param: SystemApiConfigureCommunicationChannelPreferencesRequest, options?: Configuration): Promise { return this.api.configureCommunicationChannelPreferences(param.configureCommunicationChannelPreferencesRequest, options).toPromise(); } /** * Version: 26.2.0.cl or later Configure security settings for your ThoughtSpot application instance. - Use `cluster_preferences` to update cluster-level security settings including CORS whitelisted URLs, CSP settings, SAML redirect URLs, partitioned cookies, and non-embed access configuration. - Use `org_preferences` to configure Org-specific security settings. If your instance has [Orgs](https://docs.thoughtspot.com/cloud/latest/orgs-overview), this allows configuring CORS and non-embed access settings specific to the Org. Requires `ADMINISTRATION` (**Can administer ThoughtSpot**) or `DEVELOPER` (**Has developer privilege**) privilege. Cluster-level SAML and script-src settings require `ADMINISTRATION` privilege. See [Security Settings](https://developers.thoughtspot.com/docs/security-settings) for more details. * @param param the request object */ public configureSecuritySettings(param: SystemApiConfigureSecuritySettingsRequest, options?: Configuration): Promise { return this.api.configureSecuritySettings(param.configureSecuritySettingsRequest, options).toPromise(); } /** * Version: 9.0.0.cl or later Retrieves the current configuration details of the cluster. If the request is successful, the API returns a list configuration settings applied on the cluster. Requires `ADMINISTRATION`(**Can administer ThoughtSpot**) privilege to view these complete configuration settings of the cluster. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `SYSTEM_INFO_ADMINISTRATION` (**Can view system activities**) privilege is required. This API does not require any parameters to be passed in the request. * @param param the request object */ public getSystemConfig(param: SystemApiGetSystemConfigRequest = {}, options?: Configuration): Promise { return this.api.getSystemConfig( options).toPromise(); } /** * Version: 9.0.0.cl or later Gets system information such as the release version, locale, time zone, deployment environment, date format, and date time format of the cluster. Requires `ADMINISTRATION` (**Can administer ThoughtSpot**) privileges. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `SYSTEM_INFO_ADMINISTRATION` (**Can view system activities**) privilege is required. This API does not require any parameters to be passed in the request. * @param param the request object */ public getSystemInformation(param: SystemApiGetSystemInformationRequest = {}, options?: Configuration): Promise { return this.api.getSystemInformation( options).toPromise(); } /** * Version: 9.2.0.cl or later Gets a list of configuration overrides applied on the cluster. Requires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `APPLICATION_ADMINISTRATION` (**Can manage application settings**) privilege is required. This API does not require any parameters to be passed in the request. * @param param the request object */ public getSystemOverrideInfo(param: SystemApiGetSystemOverrideInfoRequest = {}, options?: Configuration): Promise { return this.api.getSystemOverrideInfo( options).toPromise(); } /** * Version: 10.14.0.cl or later Fetch communication channel preferences. - Use `cluster_preferences` to fetch the default preferences for your ThoughtSpot application instance. - If your instance has [Orgs](https://docs.thoughtspot.com/cloud/latest/orgs-overview), use `org_preferences` to fetch any Org-specific preferences that override the defaults. Requires `ADMINISTRATION` (**Can administer ThoughtSpot**) or `DEVELOPER` (**Has developer privilege**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, users with `APPLICATION_ADMINISTRATION` (**Can manage application settings**) privilege are also authorized to perform this action. * @param param the request object */ public searchCommunicationChannelPreferences(param: SystemApiSearchCommunicationChannelPreferencesRequest, options?: Configuration): Promise { return this.api.searchCommunicationChannelPreferences(param.searchCommunicationChannelPreferencesRequest, options).toPromise(); } /** * Version: 26.2.0.cl or later Fetch security settings for your ThoughtSpot application instance. - Use `scope: CLUSTER` to retrieve cluster-level security settings, including CORS and CSP allowlists, SAML redirect URLs, and settings that control access to non-embedded pages. - Use `scope: ORG` to retrieve Org-level security settings. If your instance has [Orgs](https://docs.thoughtspot.com/cloud/latest/orgs-overview), this returns CORS and non-embed access settings specific to the Org. - If `scope` is not specified, returns both cluster and Org-specific settings based on user privileges. Requires `ADMINISTRATION` (**Can administer ThoughtSpot**) or `DEVELOPER` (**Has developer privilege**) privilege. See [Security Settings](https://developers.thoughtspot.com/docs/security-settings) for more details. * @param param the request object */ public searchSecuritySettings(param: SystemApiSearchSecuritySettingsRequest, options?: Configuration): Promise { return this.api.searchSecuritySettings(param.searchSecuritySettingsRequest, options).toPromise(); } /** * Version: 9.2.0.cl or later Updates the current configuration of the cluster. You must send the configuration data in JSON format. Requires `ADMINISTRATION` (**Can administer ThoughtSpot**) privileges. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `APPLICATION_ADMINISTRATION` (**Can manage application settings**) privilege is required. * @param param the request object */ public updateSystemConfig(param: SystemApiUpdateSystemConfigRequest, options?: Configuration): Promise { return this.api.updateSystemConfig(param.updateSystemConfigRequest, options).toPromise(); } /** * Version: 26.4.0.cl or later Validates a communication channel configuration to ensure it is properly set up and can receive events. - Use `channel_type` to specify the type of communication channel to validate (e.g., WEBHOOK). - Use `channel_identifier` to provide the unique identifier or name for the communication channel. - Use `event_type` to specify the event type to validate for this channel. Requires `ADMINISTRATION` (**Can administer ThoughtSpot**) or `DEVELOPER` (**Has developer privilege**) privilege. For webhook channels, users with `CAN_MANAGE_WEBHOOKS` (**Can manage webhooks**) privilege are also authorized to perform this action. * @param param the request object */ public validateCommunicationChannel(param: SystemApiValidateCommunicationChannelRequest, options?: Configuration): Promise { return this.api.validateCommunicationChannel(param.validateCommunicationChannelRequest, options).toPromise(); } } import { ObservableTagsApi } from "./ObservableAPI"; import { TagsApiRequestFactory, TagsApiResponseProcessor} from "../apis/TagsApi"; export interface TagsApiAssignTagRequest { /** * * @type AssignTagRequest * @memberof TagsApiassignTag */ assignTagRequest: AssignTagRequest } export interface TagsApiCreateTagRequest { /** * * @type CreateTagRequest * @memberof TagsApicreateTag */ createTagRequest: CreateTagRequest } export interface TagsApiDeleteTagRequest { /** * Tag identifier Tag name or Tag id. * @type string * @memberof TagsApideleteTag */ tagIdentifier: string } export interface TagsApiSearchTagsRequest { /** * * @type SearchTagsRequest * @memberof TagsApisearchTags */ searchTagsRequest: SearchTagsRequest } export interface TagsApiUnassignTagRequest { /** * * @type UnassignTagRequest * @memberof TagsApiunassignTag */ unassignTagRequest: UnassignTagRequest } export interface TagsApiUpdateTagRequest { /** * Name or Id of the tag. * @type string * @memberof TagsApiupdateTag */ tagIdentifier: string /** * * @type UpdateTagRequest * @memberof TagsApiupdateTag */ updateTagRequest: UpdateTagRequest } export class ObjectTagsApi { private api: ObservableTagsApi public constructor(configuration: Configuration, requestFactory?: TagsApiRequestFactory, responseProcessor?: TagsApiResponseProcessor) { this.api = new ObservableTagsApi(configuration, requestFactory, responseProcessor); } /** * Version: 9.0.0.cl or later Assigns tags to Liveboards, Answers, Tables, and Worksheets. Requires edit access to the metadata object. * @param param the request object */ public assignTag(param: TagsApiAssignTagRequest, options?: Configuration): Promise { return this.api.assignTag(param.assignTagRequest, options).toPromise(); } /** * Version: 9.0.0.cl or later Creates a tag object. Tags are labels that identify a metadata object. For example, you can create a tag to designate subject areas, such as sales, HR, marketing, and finance. Requires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `TAGMANAGEMENT` (**Can manage tags**) privilege is required to create, edit, and delete tags. * @param param the request object */ public createTag(param: TagsApiCreateTagRequest, options?: Configuration): Promise { return this.api.createTag(param.createTagRequest, options).toPromise(); } /** * Version: 9.0.0.cl or later Deletes a tag object from the ThoughtSpot system Requires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `TAGMANAGEMENT` (**Can manage tags**) privilege is required to create, edit, and delete tags. * @param param the request object */ public deleteTag(param: TagsApiDeleteTagRequest, options?: Configuration): Promise { return this.api.deleteTag(param.tagIdentifier, options).toPromise(); } /** * Version: 9.0.0.cl or later Gets a list of tag objects available on the ThoughtSpot system. To get details of a specific tag object, specify the GUID or name. Any authenticated user can search for tag objects. * @param param the request object */ public searchTags(param: TagsApiSearchTagsRequest, options?: Configuration): Promise> { return this.api.searchTags(param.searchTagsRequest, options).toPromise(); } /** * Version: 9.0.0.cl or later Removes the tags applied to a Liveboard, Answer, Table, or Worksheet. Requires edit access to the metadata object. * @param param the request object */ public unassignTag(param: TagsApiUnassignTagRequest, options?: Configuration): Promise { return this.api.unassignTag(param.unassignTagRequest, options).toPromise(); } /** * Version: 9.0.0.cl or later Updates a tag object. You can modify the `name` and `color` properties of a tag object. Requires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `TAGMANAGEMENT` (**Can manage tags**) privilege is required to create, edit, and delete tags. * @param param the request object */ public updateTag(param: TagsApiUpdateTagRequest, options?: Configuration): Promise { return this.api.updateTag(param.tagIdentifier, param.updateTagRequest, options).toPromise(); } } import { ObservableThoughtSpotRestApi } from "./ObservableAPI"; import { ThoughtSpotRestApiRequestFactory, ThoughtSpotRestApiResponseProcessor} from "../apis/ThoughtSpotRestApi"; export interface ThoughtSpotRestApiActivateUserRequest { /** * * @type ActivateUserRequest * @memberof ThoughtSpotRestApiactivateUser */ activateUserRequest: ActivateUserRequest } export interface ThoughtSpotRestApiAssignChangeAuthorRequest { /** * * @type AssignChangeAuthorRequest * @memberof ThoughtSpotRestApiassignChangeAuthor */ assignChangeAuthorRequest: AssignChangeAuthorRequest } export interface ThoughtSpotRestApiAssignTagRequest { /** * * @type AssignTagRequest * @memberof ThoughtSpotRestApiassignTag */ assignTagRequest: AssignTagRequest } export interface ThoughtSpotRestApiChangeUserPasswordRequest { /** * * @type ChangeUserPasswordRequest * @memberof ThoughtSpotRestApichangeUserPassword */ changeUserPasswordRequest: ChangeUserPasswordRequest } export interface ThoughtSpotRestApiCommitBranchRequest { /** * * @type CommitBranchRequest * @memberof ThoughtSpotRestApicommitBranch */ commitBranchRequest: CommitBranchRequest } export interface ThoughtSpotRestApiConfigureCommunicationChannelPreferencesRequest { /** * * @type ConfigureCommunicationChannelPreferencesRequest * @memberof ThoughtSpotRestApiconfigureCommunicationChannelPreferences */ configureCommunicationChannelPreferencesRequest: ConfigureCommunicationChannelPreferencesRequest } export interface ThoughtSpotRestApiConfigureSecuritySettingsRequest { /** * * @type ConfigureSecuritySettingsRequest * @memberof ThoughtSpotRestApiconfigureSecuritySettings */ configureSecuritySettingsRequest: ConfigureSecuritySettingsRequest } export interface ThoughtSpotRestApiConnectionConfigurationSearchRequest { /** * * @type ConnectionConfigurationSearchRequest * @memberof ThoughtSpotRestApiconnectionConfigurationSearch */ connectionConfigurationSearchRequest: ConnectionConfigurationSearchRequest } export interface ThoughtSpotRestApiConvertWorksheetToModelRequest { /** * * @type ConvertWorksheetToModelRequest * @memberof ThoughtSpotRestApiconvertWorksheetToModel */ convertWorksheetToModelRequest: ConvertWorksheetToModelRequest } export interface ThoughtSpotRestApiCopyObjectRequest { /** * * @type CopyObjectRequest * @memberof ThoughtSpotRestApicopyObject */ copyObjectRequest: CopyObjectRequest } export interface ThoughtSpotRestApiCreateAgentConversationRequest { /** * * @type CreateAgentConversationRequest * @memberof ThoughtSpotRestApicreateAgentConversation */ createAgentConversationRequest: CreateAgentConversationRequest } export interface ThoughtSpotRestApiCreateCalendarRequest { /** * * @type CreateCalendarRequest * @memberof ThoughtSpotRestApicreateCalendar */ createCalendarRequest: CreateCalendarRequest } export interface ThoughtSpotRestApiCreateCollectionRequest { /** * * @type CreateCollectionRequest * @memberof ThoughtSpotRestApicreateCollection */ createCollectionRequest: CreateCollectionRequest } export interface ThoughtSpotRestApiCreateConfigRequest { /** * * @type CreateConfigRequest * @memberof ThoughtSpotRestApicreateConfig */ createConfigRequest: CreateConfigRequest } export interface ThoughtSpotRestApiCreateConnectionRequest { /** * * @type CreateConnectionRequest * @memberof ThoughtSpotRestApicreateConnection */ createConnectionRequest: CreateConnectionRequest } export interface ThoughtSpotRestApiCreateConnectionConfigurationRequest { /** * * @type CreateConnectionConfigurationRequest * @memberof ThoughtSpotRestApicreateConnectionConfiguration */ createConnectionConfigurationRequest: CreateConnectionConfigurationRequest } export interface ThoughtSpotRestApiCreateConversationRequest { /** * * @type CreateConversationRequest * @memberof ThoughtSpotRestApicreateConversation */ createConversationRequest: CreateConversationRequest } export interface ThoughtSpotRestApiCreateCustomActionRequest { /** * * @type CreateCustomActionRequest * @memberof ThoughtSpotRestApicreateCustomAction */ createCustomActionRequest: CreateCustomActionRequest } export interface ThoughtSpotRestApiCreateEmailCustomizationRequest { /** * * @type CreateEmailCustomizationRequest * @memberof ThoughtSpotRestApicreateEmailCustomization */ createEmailCustomizationRequest: CreateEmailCustomizationRequest } export interface ThoughtSpotRestApiCreateOrgRequest { /** * * @type CreateOrgRequest * @memberof ThoughtSpotRestApicreateOrg */ createOrgRequest: CreateOrgRequest } export interface ThoughtSpotRestApiCreateRoleRequest { /** * * @type CreateRoleRequest * @memberof ThoughtSpotRestApicreateRole */ createRoleRequest: CreateRoleRequest } export interface ThoughtSpotRestApiCreateScheduleRequest { /** * * @type CreateScheduleRequest * @memberof ThoughtSpotRestApicreateSchedule */ createScheduleRequest: CreateScheduleRequest } export interface ThoughtSpotRestApiCreateTagRequest { /** * * @type CreateTagRequest * @memberof ThoughtSpotRestApicreateTag */ createTagRequest: CreateTagRequest } export interface ThoughtSpotRestApiCreateUserRequest { /** * * @type CreateUserRequest * @memberof ThoughtSpotRestApicreateUser */ createUserRequest: CreateUserRequest } export interface ThoughtSpotRestApiCreateUserGroupRequest { /** * * @type CreateUserGroupRequest * @memberof ThoughtSpotRestApicreateUserGroup */ createUserGroupRequest: CreateUserGroupRequest } export interface ThoughtSpotRestApiCreateVariableRequest { /** * * @type CreateVariableRequest * @memberof ThoughtSpotRestApicreateVariable */ createVariableRequest: CreateVariableRequest } export interface ThoughtSpotRestApiCreateWebhookConfigurationRequest { /** * * @type CreateWebhookConfigurationRequest * @memberof ThoughtSpotRestApicreateWebhookConfiguration */ createWebhookConfigurationRequest: CreateWebhookConfigurationRequest } export interface ThoughtSpotRestApiDbtConnectionRequest { /** * Name of the connection. * @type string * @memberof ThoughtSpotRestApidbtConnection */ connectionName: string /** * Name of the Database. * @type string * @memberof ThoughtSpotRestApidbtConnection */ databaseName: string /** * Mention type of Import * @type string * @memberof ThoughtSpotRestApidbtConnection */ importType?: string /** * Access token is mandatory when Import_Type is DBT_CLOUD. * @type string * @memberof ThoughtSpotRestApidbtConnection */ accessToken?: string /** * DBT URL is mandatory when Import_Type is DBT_CLOUD. * @type string * @memberof ThoughtSpotRestApidbtConnection */ dbtUrl?: string /** * Account ID is mandatory when Import_Type is DBT_CLOUD * @type string * @memberof ThoughtSpotRestApidbtConnection */ accountId?: string /** * Project ID is mandatory when Import_Type is DBT_CLOUD * @type string * @memberof ThoughtSpotRestApidbtConnection */ projectId?: string /** * DBT Environment ID\\\" * @type string * @memberof ThoughtSpotRestApidbtConnection */ dbtEnvId?: string /** * Name of the project * @type string * @memberof ThoughtSpotRestApidbtConnection */ projectName?: string /** * Upload DBT Manifest and Catalog artifact files as a ZIP file. This field is Mandatory when Import Type is \\\'ZIP_FILE\\\' * @type HttpFile * @memberof ThoughtSpotRestApidbtConnection */ fileContent?: HttpFile } export interface ThoughtSpotRestApiDbtGenerateSyncTmlRequest { /** * Unique ID of the DBT connection. * @type string * @memberof ThoughtSpotRestApidbtGenerateSyncTml */ dbtConnectionIdentifier: string /** * Upload DBT Manifest and Catalog artifact files as a ZIP file. This field is mandatory if the connection was created with import_type ‘ZIP_FILE’ * @type HttpFile * @memberof ThoughtSpotRestApidbtGenerateSyncTml */ fileContent?: HttpFile } export interface ThoughtSpotRestApiDbtGenerateTmlRequest { /** * Unique ID of the DBT connection. * @type string * @memberof ThoughtSpotRestApidbtGenerateTml */ dbtConnectionIdentifier: string /** * List of Models and their respective Tables Example: \\\'[{\\\"model_name\\\": \\\"model_name\\\", \\\"tables\\\": [\\\"table_name\\\"]}]\\\' * @type string * @memberof ThoughtSpotRestApidbtGenerateTml */ modelTables: string /** * Mention the worksheet tmls to import * @type string * @memberof ThoughtSpotRestApidbtGenerateTml */ importWorksheets: string /** * List of worksheets is mandatory when import_Worksheets is type SELECTED Example: [\\\"worksheet_name\\\"] * @type string * @memberof ThoughtSpotRestApidbtGenerateTml */ worksheets?: string /** * Upload DBT Manifest and Catalog artifact files as a ZIP file. This field is mandatory if the connection was created with import_type ‘ZIP_FILE’ * @type HttpFile * @memberof ThoughtSpotRestApidbtGenerateTml */ fileContent?: HttpFile } export interface ThoughtSpotRestApiDbtSearchRequest { } export interface ThoughtSpotRestApiDeactivateUserRequest { /** * * @type DeactivateUserRequest * @memberof ThoughtSpotRestApideactivateUser */ deactivateUserRequest: DeactivateUserRequest } export interface ThoughtSpotRestApiDeleteCalendarRequest { /** * Unique ID or name of the Calendar. * @type string * @memberof ThoughtSpotRestApideleteCalendar */ calendarIdentifier: string } export interface ThoughtSpotRestApiDeleteCollectionRequest { /** * * @type DeleteCollectionRequest * @memberof ThoughtSpotRestApideleteCollection */ deleteCollectionRequest: DeleteCollectionRequest } export interface ThoughtSpotRestApiDeleteConfigRequest { /** * * @type DeleteConfigRequest * @memberof ThoughtSpotRestApideleteConfig */ deleteConfigRequest: DeleteConfigRequest } export interface ThoughtSpotRestApiDeleteConnectionRequest { /** * * @type DeleteConnectionRequest * @memberof ThoughtSpotRestApideleteConnection */ deleteConnectionRequest: DeleteConnectionRequest } export interface ThoughtSpotRestApiDeleteConnectionConfigurationRequest { /** * * @type DeleteConnectionConfigurationRequest * @memberof ThoughtSpotRestApideleteConnectionConfiguration */ deleteConnectionConfigurationRequest: DeleteConnectionConfigurationRequest } export interface ThoughtSpotRestApiDeleteConnectionV2Request { /** * Unique ID or name of the connection. * @type string * @memberof ThoughtSpotRestApideleteConnectionV2 */ connectionIdentifier: string } export interface ThoughtSpotRestApiDeleteCustomActionRequest { /** * Unique ID or name of the custom action. * @type string * @memberof ThoughtSpotRestApideleteCustomAction */ customActionIdentifier: string } export interface ThoughtSpotRestApiDeleteDbtConnectionRequest { /** * Unique ID of the DBT Connection. * @type string * @memberof ThoughtSpotRestApideleteDbtConnection */ dbtConnectionIdentifier: string } export interface ThoughtSpotRestApiDeleteEmailCustomizationRequest { /** * Unique ID or name of the email customization. * @type string * @memberof ThoughtSpotRestApideleteEmailCustomization */ templateIdentifier: string } export interface ThoughtSpotRestApiDeleteMetadataRequest { /** * * @type DeleteMetadataRequest * @memberof ThoughtSpotRestApideleteMetadata */ deleteMetadataRequest: DeleteMetadataRequest } export interface ThoughtSpotRestApiDeleteOrgRequest { /** * ID or name of the Org * @type string * @memberof ThoughtSpotRestApideleteOrg */ orgIdentifier: string } export interface ThoughtSpotRestApiDeleteOrgEmailCustomizationRequest { /** * * @type DeleteOrgEmailCustomizationRequest * @memberof ThoughtSpotRestApideleteOrgEmailCustomization */ deleteOrgEmailCustomizationRequest: DeleteOrgEmailCustomizationRequest } export interface ThoughtSpotRestApiDeleteRoleRequest { /** * Unique ID or name of the Role. ReadOnly roles cannot be deleted. * @type string * @memberof ThoughtSpotRestApideleteRole */ roleIdentifier: string } export interface ThoughtSpotRestApiDeleteScheduleRequest { /** * Unique ID or name of the scheduled job. * @type string * @memberof ThoughtSpotRestApideleteSchedule */ scheduleIdentifier: string } export interface ThoughtSpotRestApiDeleteTagRequest { /** * Tag identifier Tag name or Tag id. * @type string * @memberof ThoughtSpotRestApideleteTag */ tagIdentifier: string } export interface ThoughtSpotRestApiDeleteUserRequest { /** * GUID / name of the user * @type string * @memberof ThoughtSpotRestApideleteUser */ userIdentifier: string } export interface ThoughtSpotRestApiDeleteUserGroupRequest { /** * GUID or name of the group. * @type string * @memberof ThoughtSpotRestApideleteUserGroup */ groupIdentifier: string } export interface ThoughtSpotRestApiDeleteVariableRequest { /** * Unique id or name of the variable * @type string * @memberof ThoughtSpotRestApideleteVariable */ identifier: string } export interface ThoughtSpotRestApiDeleteVariablesRequest { /** * * @type DeleteVariablesRequest * @memberof ThoughtSpotRestApideleteVariables */ deleteVariablesRequest: DeleteVariablesRequest } export interface ThoughtSpotRestApiDeleteWebhookConfigurationsRequest { /** * * @type DeleteWebhookConfigurationsRequest * @memberof ThoughtSpotRestApideleteWebhookConfigurations */ deleteWebhookConfigurationsRequest: DeleteWebhookConfigurationsRequest } export interface ThoughtSpotRestApiDeployCommitRequest { /** * * @type DeployCommitRequest * @memberof ThoughtSpotRestApideployCommit */ deployCommitRequest: DeployCommitRequest } export interface ThoughtSpotRestApiDownloadConnectionMetadataChangesRequest { /** * GUID of the connection * @type string * @memberof ThoughtSpotRestApidownloadConnectionMetadataChanges */ connectionIdentifier: string } export interface ThoughtSpotRestApiExportAnswerReportRequest { /** * * @type ExportAnswerReportRequest * @memberof ThoughtSpotRestApiexportAnswerReport */ exportAnswerReportRequest: ExportAnswerReportRequest } export interface ThoughtSpotRestApiExportLiveboardReportRequest { /** * * @type ExportLiveboardReportRequest * @memberof ThoughtSpotRestApiexportLiveboardReport */ exportLiveboardReportRequest: ExportLiveboardReportRequest } export interface ThoughtSpotRestApiExportMetadataTMLRequest { /** * * @type ExportMetadataTMLRequest * @memberof ThoughtSpotRestApiexportMetadataTML */ exportMetadataTMLRequest: ExportMetadataTMLRequest } export interface ThoughtSpotRestApiExportMetadataTMLBatchedRequest { /** * * @type ExportMetadataTMLBatchedRequest * @memberof ThoughtSpotRestApiexportMetadataTMLBatched */ exportMetadataTMLBatchedRequest: ExportMetadataTMLBatchedRequest } export interface ThoughtSpotRestApiFetchAnswerDataRequest { /** * * @type FetchAnswerDataRequest * @memberof ThoughtSpotRestApifetchAnswerData */ fetchAnswerDataRequest: FetchAnswerDataRequest } export interface ThoughtSpotRestApiFetchAnswerSqlQueryRequest { /** * * @type FetchAnswerSqlQueryRequest * @memberof ThoughtSpotRestApifetchAnswerSqlQuery */ fetchAnswerSqlQueryRequest: FetchAnswerSqlQueryRequest } export interface ThoughtSpotRestApiFetchAsyncImportTaskStatusRequest { /** * * @type FetchAsyncImportTaskStatusRequest * @memberof ThoughtSpotRestApifetchAsyncImportTaskStatus */ fetchAsyncImportTaskStatusRequest: FetchAsyncImportTaskStatusRequest } export interface ThoughtSpotRestApiFetchColumnSecurityRulesRequest { /** * * @type FetchColumnSecurityRulesRequest * @memberof ThoughtSpotRestApifetchColumnSecurityRules */ fetchColumnSecurityRulesRequest: FetchColumnSecurityRulesRequest } export interface ThoughtSpotRestApiFetchConnectionDiffStatusRequest { /** * GUID of the connection * @type string * @memberof ThoughtSpotRestApifetchConnectionDiffStatus */ connectionIdentifier: string } export interface ThoughtSpotRestApiFetchLiveboardDataRequest { /** * * @type FetchLiveboardDataRequest * @memberof ThoughtSpotRestApifetchLiveboardData */ fetchLiveboardDataRequest: FetchLiveboardDataRequest } export interface ThoughtSpotRestApiFetchLiveboardSqlQueryRequest { /** * * @type FetchLiveboardSqlQueryRequest * @memberof ThoughtSpotRestApifetchLiveboardSqlQuery */ fetchLiveboardSqlQueryRequest: FetchLiveboardSqlQueryRequest } export interface ThoughtSpotRestApiFetchLogsRequest { /** * * @type FetchLogsRequest * @memberof ThoughtSpotRestApifetchLogs */ fetchLogsRequest: FetchLogsRequest } export interface ThoughtSpotRestApiFetchObjectPrivilegesRequest { /** * * @type FetchObjectPrivilegesRequest * @memberof ThoughtSpotRestApifetchObjectPrivileges */ fetchObjectPrivilegesRequest: FetchObjectPrivilegesRequest } export interface ThoughtSpotRestApiFetchPermissionsOfPrincipalsRequest { /** * * @type FetchPermissionsOfPrincipalsRequest * @memberof ThoughtSpotRestApifetchPermissionsOfPrincipals */ fetchPermissionsOfPrincipalsRequest: FetchPermissionsOfPrincipalsRequest } export interface ThoughtSpotRestApiFetchPermissionsOnMetadataRequest { /** * * @type FetchPermissionsOnMetadataRequest * @memberof ThoughtSpotRestApifetchPermissionsOnMetadata */ fetchPermissionsOnMetadataRequest: FetchPermissionsOnMetadataRequest } export interface ThoughtSpotRestApiForceLogoutUsersRequest { /** * * @type ForceLogoutUsersRequest * @memberof ThoughtSpotRestApiforceLogoutUsers */ forceLogoutUsersRequest: ForceLogoutUsersRequest } export interface ThoughtSpotRestApiGenerateCSVRequest { /** * * @type GenerateCSVRequest * @memberof ThoughtSpotRestApigenerateCSV */ generateCSVRequest: GenerateCSVRequest } export interface ThoughtSpotRestApiGetCurrentUserInfoRequest { } export interface ThoughtSpotRestApiGetCurrentUserTokenRequest { } export interface ThoughtSpotRestApiGetCustomAccessTokenRequest { /** * * @type GetCustomAccessTokenRequest * @memberof ThoughtSpotRestApigetCustomAccessToken */ getCustomAccessTokenRequest: GetCustomAccessTokenRequest } export interface ThoughtSpotRestApiGetDataSourceSuggestionsRequest { /** * * @type GetDataSourceSuggestionsRequest * @memberof ThoughtSpotRestApigetDataSourceSuggestions */ getDataSourceSuggestionsRequest: GetDataSourceSuggestionsRequest } export interface ThoughtSpotRestApiGetFullAccessTokenRequest { /** * * @type GetFullAccessTokenRequest * @memberof ThoughtSpotRestApigetFullAccessToken */ getFullAccessTokenRequest: GetFullAccessTokenRequest } export interface ThoughtSpotRestApiGetNLInstructionsRequest { /** * * @type GetNLInstructionsRequest * @memberof ThoughtSpotRestApigetNLInstructions */ getNLInstructionsRequest: GetNLInstructionsRequest } export interface ThoughtSpotRestApiGetObjectAccessTokenRequest { /** * * @type GetObjectAccessTokenRequest * @memberof ThoughtSpotRestApigetObjectAccessToken */ getObjectAccessTokenRequest: GetObjectAccessTokenRequest } export interface ThoughtSpotRestApiGetRelevantQuestionsRequest { /** * * @type GetRelevantQuestionsRequest * @memberof ThoughtSpotRestApigetRelevantQuestions */ getRelevantQuestionsRequest: GetRelevantQuestionsRequest } export interface ThoughtSpotRestApiGetSystemConfigRequest { } export interface ThoughtSpotRestApiGetSystemInformationRequest { } export interface ThoughtSpotRestApiGetSystemOverrideInfoRequest { } export interface ThoughtSpotRestApiImportMetadataTMLRequest { /** * * @type ImportMetadataTMLRequest * @memberof ThoughtSpotRestApiimportMetadataTML */ importMetadataTMLRequest: ImportMetadataTMLRequest } export interface ThoughtSpotRestApiImportMetadataTMLAsyncRequest { /** * * @type ImportMetadataTMLAsyncRequest * @memberof ThoughtSpotRestApiimportMetadataTMLAsync */ importMetadataTMLAsyncRequest: ImportMetadataTMLAsyncRequest } export interface ThoughtSpotRestApiImportUserGroupsRequest { /** * * @type ImportUserGroupsRequest * @memberof ThoughtSpotRestApiimportUserGroups */ importUserGroupsRequest: ImportUserGroupsRequest } export interface ThoughtSpotRestApiImportUsersRequest { /** * * @type ImportUsersRequest * @memberof ThoughtSpotRestApiimportUsers */ importUsersRequest: ImportUsersRequest } export interface ThoughtSpotRestApiLoginRequest { /** * * @type LoginRequest * @memberof ThoughtSpotRestApilogin */ loginRequest: LoginRequest } export interface ThoughtSpotRestApiLogoutRequest { } export interface ThoughtSpotRestApiManageObjectPrivilegeRequest { /** * * @type ManageObjectPrivilegeRequest * @memberof ThoughtSpotRestApimanageObjectPrivilege */ manageObjectPrivilegeRequest: ManageObjectPrivilegeRequest } export interface ThoughtSpotRestApiParameterizeMetadataRequest { /** * * @type ParameterizeMetadataRequest * @memberof ThoughtSpotRestApiparameterizeMetadata */ parameterizeMetadataRequest: ParameterizeMetadataRequest } export interface ThoughtSpotRestApiParameterizeMetadataFieldsRequest { /** * * @type ParameterizeMetadataFieldsRequest * @memberof ThoughtSpotRestApiparameterizeMetadataFields */ parameterizeMetadataFieldsRequest: ParameterizeMetadataFieldsRequest } export interface ThoughtSpotRestApiPublishMetadataRequest { /** * * @type PublishMetadataRequest * @memberof ThoughtSpotRestApipublishMetadata */ publishMetadataRequest: PublishMetadataRequest } export interface ThoughtSpotRestApiPutVariableValuesRequest { /** * Unique ID or name of the variable * @type string * @memberof ThoughtSpotRestApiputVariableValues */ identifier: string /** * * @type PutVariableValuesRequest * @memberof ThoughtSpotRestApiputVariableValues */ putVariableValuesRequest: PutVariableValuesRequest } export interface ThoughtSpotRestApiQueryGetDecomposedQueryRequest { /** * * @type QueryGetDecomposedQueryRequest * @memberof ThoughtSpotRestApiqueryGetDecomposedQuery */ queryGetDecomposedQueryRequest: QueryGetDecomposedQueryRequest } export interface ThoughtSpotRestApiResetUserPasswordRequest { /** * * @type ResetUserPasswordRequest * @memberof ThoughtSpotRestApiresetUserPassword */ resetUserPasswordRequest: ResetUserPasswordRequest } export interface ThoughtSpotRestApiRevertCommitRequest { /** * Commit id to which the object should be reverted * @type string * @memberof ThoughtSpotRestApirevertCommit */ commitId: string /** * * @type RevertCommitRequest * @memberof ThoughtSpotRestApirevertCommit */ revertCommitRequest: RevertCommitRequest } export interface ThoughtSpotRestApiRevokeRefreshTokensRequest { /** * Unique ID or name of the connection whose refresh tokens need to be revoked. All the users associated with the connection will have their refresh tokens revoked except the author. * @type string * @memberof ThoughtSpotRestApirevokeRefreshTokens */ connectionIdentifier: string /** * * @type RevokeRefreshTokensRequest * @memberof ThoughtSpotRestApirevokeRefreshTokens */ revokeRefreshTokensRequest: RevokeRefreshTokensRequest } export interface ThoughtSpotRestApiRevokeTokenRequest { /** * * @type RevokeTokenRequest * @memberof ThoughtSpotRestApirevokeToken */ revokeTokenRequest: RevokeTokenRequest } export interface ThoughtSpotRestApiSearchCalendarsRequest { /** * * @type SearchCalendarsRequest * @memberof ThoughtSpotRestApisearchCalendars */ searchCalendarsRequest: SearchCalendarsRequest } export interface ThoughtSpotRestApiSearchChannelHistoryRequest { /** * * @type SearchChannelHistoryRequest * @memberof ThoughtSpotRestApisearchChannelHistory */ searchChannelHistoryRequest: SearchChannelHistoryRequest } export interface ThoughtSpotRestApiSearchCollectionsRequest { /** * * @type SearchCollectionsRequest * @memberof ThoughtSpotRestApisearchCollections */ searchCollectionsRequest: SearchCollectionsRequest } export interface ThoughtSpotRestApiSearchCommitsRequest { /** * * @type SearchCommitsRequest * @memberof ThoughtSpotRestApisearchCommits */ searchCommitsRequest: SearchCommitsRequest } export interface ThoughtSpotRestApiSearchCommunicationChannelPreferencesRequest { /** * * @type SearchCommunicationChannelPreferencesRequest * @memberof ThoughtSpotRestApisearchCommunicationChannelPreferences */ searchCommunicationChannelPreferencesRequest: SearchCommunicationChannelPreferencesRequest } export interface ThoughtSpotRestApiSearchConfigRequest { /** * * @type SearchConfigRequest * @memberof ThoughtSpotRestApisearchConfig */ searchConfigRequest: SearchConfigRequest } export interface ThoughtSpotRestApiSearchConnectionRequest { /** * * @type SearchConnectionRequest * @memberof ThoughtSpotRestApisearchConnection */ searchConnectionRequest: SearchConnectionRequest } export interface ThoughtSpotRestApiSearchCustomActionsRequest { /** * * @type SearchCustomActionsRequest * @memberof ThoughtSpotRestApisearchCustomActions */ searchCustomActionsRequest: SearchCustomActionsRequest } export interface ThoughtSpotRestApiSearchDataRequest { /** * * @type SearchDataRequest * @memberof ThoughtSpotRestApisearchData */ searchDataRequest: SearchDataRequest } export interface ThoughtSpotRestApiSearchEmailCustomizationRequest { /** * * @type SearchEmailCustomizationRequest * @memberof ThoughtSpotRestApisearchEmailCustomization */ searchEmailCustomizationRequest: SearchEmailCustomizationRequest } export interface ThoughtSpotRestApiSearchMetadataRequest { /** * * @type SearchMetadataRequest * @memberof ThoughtSpotRestApisearchMetadata */ searchMetadataRequest: SearchMetadataRequest } export interface ThoughtSpotRestApiSearchOrgsRequest { /** * * @type SearchOrgsRequest * @memberof ThoughtSpotRestApisearchOrgs */ searchOrgsRequest: SearchOrgsRequest } export interface ThoughtSpotRestApiSearchRolesRequest { /** * * @type SearchRolesRequest * @memberof ThoughtSpotRestApisearchRoles */ searchRolesRequest: SearchRolesRequest } export interface ThoughtSpotRestApiSearchSchedulesRequest { /** * * @type SearchSchedulesRequest * @memberof ThoughtSpotRestApisearchSchedules */ searchSchedulesRequest: SearchSchedulesRequest } export interface ThoughtSpotRestApiSearchSecuritySettingsRequest { /** * * @type SearchSecuritySettingsRequest * @memberof ThoughtSpotRestApisearchSecuritySettings */ searchSecuritySettingsRequest: SearchSecuritySettingsRequest } export interface ThoughtSpotRestApiSearchTagsRequest { /** * * @type SearchTagsRequest * @memberof ThoughtSpotRestApisearchTags */ searchTagsRequest: SearchTagsRequest } export interface ThoughtSpotRestApiSearchUserGroupsRequest { /** * * @type SearchUserGroupsRequest * @memberof ThoughtSpotRestApisearchUserGroups */ searchUserGroupsRequest: SearchUserGroupsRequest } export interface ThoughtSpotRestApiSearchUsersRequest { /** * * @type SearchUsersRequest * @memberof ThoughtSpotRestApisearchUsers */ searchUsersRequest: SearchUsersRequest } export interface ThoughtSpotRestApiSearchVariablesRequest { /** * * @type SearchVariablesRequest * @memberof ThoughtSpotRestApisearchVariables */ searchVariablesRequest: SearchVariablesRequest } export interface ThoughtSpotRestApiSearchWebhookConfigurationsRequest { /** * * @type SearchWebhookConfigurationsRequest * @memberof ThoughtSpotRestApisearchWebhookConfigurations */ searchWebhookConfigurationsRequest: SearchWebhookConfigurationsRequest } export interface ThoughtSpotRestApiSendAgentMessageRequest { /** * Unique identifier for the conversation (used to track context) * @type string * @memberof ThoughtSpotRestApisendAgentMessage */ conversationIdentifier: string /** * * @type SendAgentMessageRequest * @memberof ThoughtSpotRestApisendAgentMessage */ sendAgentMessageRequest: SendAgentMessageRequest } export interface ThoughtSpotRestApiSendAgentMessageStreamingRequest { /** * * @type SendAgentMessageStreamingRequest * @memberof ThoughtSpotRestApisendAgentMessageStreaming */ sendAgentMessageStreamingRequest: SendAgentMessageStreamingRequest } export interface ThoughtSpotRestApiSendMessageRequest { /** * Unique identifier of the conversation. * @type string * @memberof ThoughtSpotRestApisendMessage */ conversationIdentifier: string /** * * @type SendMessageRequest * @memberof ThoughtSpotRestApisendMessage */ sendMessageRequest: SendMessageRequest } export interface ThoughtSpotRestApiSetNLInstructionsRequest { /** * * @type SetNLInstructionsRequest * @memberof ThoughtSpotRestApisetNLInstructions */ setNLInstructionsRequest: SetNLInstructionsRequest } export interface ThoughtSpotRestApiShareMetadataRequest { /** * * @type ShareMetadataRequest * @memberof ThoughtSpotRestApishareMetadata */ shareMetadataRequest: ShareMetadataRequest } export interface ThoughtSpotRestApiSingleAnswerRequest { /** * * @type SingleAnswerRequest * @memberof ThoughtSpotRestApisingleAnswer */ singleAnswerRequest: SingleAnswerRequest } export interface ThoughtSpotRestApiUnassignTagRequest { /** * * @type UnassignTagRequest * @memberof ThoughtSpotRestApiunassignTag */ unassignTagRequest: UnassignTagRequest } export interface ThoughtSpotRestApiUnparameterizeMetadataRequest { /** * * @type UnparameterizeMetadataRequest * @memberof ThoughtSpotRestApiunparameterizeMetadata */ unparameterizeMetadataRequest: UnparameterizeMetadataRequest } export interface ThoughtSpotRestApiUnpublishMetadataRequest { /** * * @type UnpublishMetadataRequest * @memberof ThoughtSpotRestApiunpublishMetadata */ unpublishMetadataRequest: UnpublishMetadataRequest } export interface ThoughtSpotRestApiUpdateCalendarRequest { /** * Unique Id or name of the calendar. * @type string * @memberof ThoughtSpotRestApiupdateCalendar */ calendarIdentifier: string /** * * @type UpdateCalendarRequest * @memberof ThoughtSpotRestApiupdateCalendar */ updateCalendarRequest: UpdateCalendarRequest } export interface ThoughtSpotRestApiUpdateCollectionRequest { /** * Unique GUID of the collection. Note: Collection names cannot be used as identifiers since duplicate names are allowed. * @type string * @memberof ThoughtSpotRestApiupdateCollection */ collectionIdentifier: string /** * * @type UpdateCollectionRequest * @memberof ThoughtSpotRestApiupdateCollection */ updateCollectionRequest: UpdateCollectionRequest } export interface ThoughtSpotRestApiUpdateColumnSecurityRulesRequest { /** * * @type UpdateColumnSecurityRulesRequest * @memberof ThoughtSpotRestApiupdateColumnSecurityRules */ updateColumnSecurityRulesRequest: UpdateColumnSecurityRulesRequest } export interface ThoughtSpotRestApiUpdateConfigRequest { /** * * @type UpdateConfigRequest * @memberof ThoughtSpotRestApiupdateConfig */ updateConfigRequest: UpdateConfigRequest } export interface ThoughtSpotRestApiUpdateConnectionRequest { /** * * @type UpdateConnectionRequest * @memberof ThoughtSpotRestApiupdateConnection */ updateConnectionRequest: UpdateConnectionRequest } export interface ThoughtSpotRestApiUpdateConnectionConfigurationRequest { /** * Unique ID or name of the configuration. * @type string * @memberof ThoughtSpotRestApiupdateConnectionConfiguration */ configurationIdentifier: string /** * * @type UpdateConnectionConfigurationRequest * @memberof ThoughtSpotRestApiupdateConnectionConfiguration */ updateConnectionConfigurationRequest: UpdateConnectionConfigurationRequest } export interface ThoughtSpotRestApiUpdateConnectionV2Request { /** * Unique ID or name of the connection. * @type string * @memberof ThoughtSpotRestApiupdateConnectionV2 */ connectionIdentifier: string /** * * @type UpdateConnectionV2Request * @memberof ThoughtSpotRestApiupdateConnectionV2 */ updateConnectionV2Request: UpdateConnectionV2Request } export interface ThoughtSpotRestApiUpdateCustomActionRequest { /** * Unique ID or name of the custom action. * @type string * @memberof ThoughtSpotRestApiupdateCustomAction */ customActionIdentifier: string /** * * @type UpdateCustomActionRequest * @memberof ThoughtSpotRestApiupdateCustomAction */ updateCustomActionRequest: UpdateCustomActionRequest } export interface ThoughtSpotRestApiUpdateDbtConnectionRequest { /** * Unique ID of the DBT Connection. * @type string * @memberof ThoughtSpotRestApiupdateDbtConnection */ dbtConnectionIdentifier: string /** * Name of the connection. * @type string * @memberof ThoughtSpotRestApiupdateDbtConnection */ connectionName?: string /** * Name of the Database. * @type string * @memberof ThoughtSpotRestApiupdateDbtConnection */ databaseName?: string /** * Mention type of Import * @type string * @memberof ThoughtSpotRestApiupdateDbtConnection */ importType?: string /** * Access token is mandatory when Import_Type is DBT_CLOUD. * @type string * @memberof ThoughtSpotRestApiupdateDbtConnection */ accessToken?: string /** * DBT URL is mandatory when Import_Type is DBT_CLOUD. * @type string * @memberof ThoughtSpotRestApiupdateDbtConnection */ dbtUrl?: string /** * Account ID is mandatory when Import_Type is DBT_CLOUD * @type string * @memberof ThoughtSpotRestApiupdateDbtConnection */ accountId?: string /** * Project ID is mandatory when Import_Type is DBT_CLOUD * @type string * @memberof ThoughtSpotRestApiupdateDbtConnection */ projectId?: string /** * DBT Environment ID\\\" * @type string * @memberof ThoughtSpotRestApiupdateDbtConnection */ dbtEnvId?: string /** * Name of the project * @type string * @memberof ThoughtSpotRestApiupdateDbtConnection */ projectName?: string /** * Upload DBT Manifest and Catalog artifact files as a ZIP file. This field is Mandatory when Import Type is \\\'ZIP_FILE\\\' * @type HttpFile * @memberof ThoughtSpotRestApiupdateDbtConnection */ fileContent?: HttpFile } export interface ThoughtSpotRestApiUpdateEmailCustomizationRequest { /** * * @type UpdateEmailCustomizationRequest * @memberof ThoughtSpotRestApiupdateEmailCustomization */ updateEmailCustomizationRequest: UpdateEmailCustomizationRequest } export interface ThoughtSpotRestApiUpdateMetadataHeaderRequest { /** * * @type UpdateMetadataHeaderRequest * @memberof ThoughtSpotRestApiupdateMetadataHeader */ updateMetadataHeaderRequest: UpdateMetadataHeaderRequest } export interface ThoughtSpotRestApiUpdateMetadataObjIdRequest { /** * * @type UpdateMetadataObjIdRequest * @memberof ThoughtSpotRestApiupdateMetadataObjId */ updateMetadataObjIdRequest: UpdateMetadataObjIdRequest } export interface ThoughtSpotRestApiUpdateOrgRequest { /** * ID or name of the Org * @type string * @memberof ThoughtSpotRestApiupdateOrg */ orgIdentifier: string /** * * @type UpdateOrgRequest * @memberof ThoughtSpotRestApiupdateOrg */ updateOrgRequest: UpdateOrgRequest } export interface ThoughtSpotRestApiUpdateRoleRequest { /** * Unique ID or name of the Role. * @type string * @memberof ThoughtSpotRestApiupdateRole */ roleIdentifier: string /** * * @type UpdateRoleRequest * @memberof ThoughtSpotRestApiupdateRole */ updateRoleRequest: UpdateRoleRequest } export interface ThoughtSpotRestApiUpdateScheduleRequest { /** * Unique ID or name of the schedule. * @type string * @memberof ThoughtSpotRestApiupdateSchedule */ scheduleIdentifier: string /** * * @type UpdateScheduleRequest * @memberof ThoughtSpotRestApiupdateSchedule */ updateScheduleRequest: UpdateScheduleRequest } export interface ThoughtSpotRestApiUpdateSystemConfigRequest { /** * * @type UpdateSystemConfigRequest * @memberof ThoughtSpotRestApiupdateSystemConfig */ updateSystemConfigRequest: UpdateSystemConfigRequest } export interface ThoughtSpotRestApiUpdateTagRequest { /** * Name or Id of the tag. * @type string * @memberof ThoughtSpotRestApiupdateTag */ tagIdentifier: string /** * * @type UpdateTagRequest * @memberof ThoughtSpotRestApiupdateTag */ updateTagRequest: UpdateTagRequest } export interface ThoughtSpotRestApiUpdateUserRequest { /** * GUID / name of the user * @type string * @memberof ThoughtSpotRestApiupdateUser */ userIdentifier: string /** * * @type UpdateUserRequest * @memberof ThoughtSpotRestApiupdateUser */ updateUserRequest: UpdateUserRequest } export interface ThoughtSpotRestApiUpdateUserGroupRequest { /** * GUID or name of the group. * @type string * @memberof ThoughtSpotRestApiupdateUserGroup */ groupIdentifier: string /** * * @type UpdateUserGroupRequest * @memberof ThoughtSpotRestApiupdateUserGroup */ updateUserGroupRequest: UpdateUserGroupRequest } export interface ThoughtSpotRestApiUpdateVariableRequest { /** * Unique id or name of the variable to update. * @type string * @memberof ThoughtSpotRestApiupdateVariable */ identifier: string /** * * @type UpdateVariableRequest * @memberof ThoughtSpotRestApiupdateVariable */ updateVariableRequest: UpdateVariableRequest } export interface ThoughtSpotRestApiUpdateVariableValuesRequest { /** * * @type UpdateVariableValuesRequest * @memberof ThoughtSpotRestApiupdateVariableValues */ updateVariableValuesRequest: UpdateVariableValuesRequest } export interface ThoughtSpotRestApiUpdateWebhookConfigurationRequest { /** * Unique ID or name of the webhook configuration. * @type string * @memberof ThoughtSpotRestApiupdateWebhookConfiguration */ webhookIdentifier: string /** * * @type UpdateWebhookConfigurationRequest * @memberof ThoughtSpotRestApiupdateWebhookConfiguration */ updateWebhookConfigurationRequest: UpdateWebhookConfigurationRequest } export interface ThoughtSpotRestApiValidateCommunicationChannelRequest { /** * * @type ValidateCommunicationChannelRequest * @memberof ThoughtSpotRestApivalidateCommunicationChannel */ validateCommunicationChannelRequest: ValidateCommunicationChannelRequest } export interface ThoughtSpotRestApiValidateEmailCustomizationRequest { } export interface ThoughtSpotRestApiValidateMergeRequest { /** * * @type ValidateMergeRequest * @memberof ThoughtSpotRestApivalidateMerge */ validateMergeRequest: ValidateMergeRequest } export interface ThoughtSpotRestApiValidateTokenRequest { /** * * @type ValidateTokenRequest * @memberof ThoughtSpotRestApivalidateToken */ validateTokenRequest: ValidateTokenRequest } export class ObjectThoughtSpotRestApi { private api: ObservableThoughtSpotRestApi public constructor(configuration: Configuration, requestFactory?: ThoughtSpotRestApiRequestFactory, responseProcessor?: ThoughtSpotRestApiResponseProcessor) { this.api = new ObservableThoughtSpotRestApi(configuration, requestFactory, responseProcessor); } /** * Version: 9.7.0.cl or later Activates a deactivated user account. Requires `ADMINISTRATION` (**Can administer Thoughtspot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `USER_ADMINISTRATION` (**Can manage users**) privilege is required. To activate an inactive user account, the API request body must include the following information: - Username or the GUID of the user account. - Auth token generated for the deactivated user. The auth token is sent in the API response when a user is deactivated. - Password for the user account. * @param param the request object */ public activateUser(param: ThoughtSpotRestApiActivateUserRequest, options?: Configuration): Promise { return this.api.activateUser(param.activateUserRequest, options).toPromise(); } /** * Version: 9.0.0.cl or later Transfers the ownership of one or several objects from one user to another. Requires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `USER_ADMINISTRATION` (**Can manage users**) privilege and edit access to the objects are required. * @param param the request object */ public assignChangeAuthor(param: ThoughtSpotRestApiAssignChangeAuthorRequest, options?: Configuration): Promise { return this.api.assignChangeAuthor(param.assignChangeAuthorRequest, options).toPromise(); } /** * Version: 9.0.0.cl or later Assigns tags to Liveboards, Answers, Tables, and Worksheets. Requires edit access to the metadata object. * @param param the request object */ public assignTag(param: ThoughtSpotRestApiAssignTagRequest, options?: Configuration): Promise { return this.api.assignTag(param.assignTagRequest, options).toPromise(); } /** * Version: 9.0.0.cl or later Updates the current password of the user. Requires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `USER_ADMINISTRATION` (**Can manage users**) privilege is required. * @param param the request object */ public changeUserPassword(param: ThoughtSpotRestApiChangeUserPasswordRequest, options?: Configuration): Promise { return this.api.changeUserPassword(param.changeUserPasswordRequest, options).toPromise(); } /** * Version: 9.2.0.cl or later Commits TML files of metadata objects to the Git branch configured on your instance. Requires at least edit access to objects used in the commit operation. Before using this endpoint to push your commits: * Enable Git integration on your instance. * Make sure the Git repository and branch details are configured on your instance. For more information, see [Git integration documentation](https://developers.thoughtspot.com/docs/git-integration). * @param param the request object */ public commitBranch(param: ThoughtSpotRestApiCommitBranchRequest, options?: Configuration): Promise { return this.api.commitBranch(param.commitBranchRequest, options).toPromise(); } /** * Version: 10.14.0.cl or later Configure communication channel preferences. - Use `cluster_preferences` to update the default preferences for your ThoughtSpot application instance. - If your instance has [Orgs](https://docs.thoughtspot.com/cloud/latest/orgs-overview), use `org_preferences` to specify Org-specific preferences that override the defaults. Requires `ADMINISTRATION` (**Can administer ThoughtSpot**) or `DEVELOPER` (**Has developer privilege**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, users with `APPLICATION_ADMINISTRATION` (**Can manage application settings**) privilege are also authorized to perform this action. * @param param the request object */ public configureCommunicationChannelPreferences(param: ThoughtSpotRestApiConfigureCommunicationChannelPreferencesRequest, options?: Configuration): Promise { return this.api.configureCommunicationChannelPreferences(param.configureCommunicationChannelPreferencesRequest, options).toPromise(); } /** * Version: 26.2.0.cl or later Configure security settings for your ThoughtSpot application instance. - Use `cluster_preferences` to update cluster-level security settings including CORS whitelisted URLs, CSP settings, SAML redirect URLs, partitioned cookies, and non-embed access configuration. - Use `org_preferences` to configure Org-specific security settings. If your instance has [Orgs](https://docs.thoughtspot.com/cloud/latest/orgs-overview), this allows configuring CORS and non-embed access settings specific to the Org. Requires `ADMINISTRATION` (**Can administer ThoughtSpot**) or `DEVELOPER` (**Has developer privilege**) privilege. Cluster-level SAML and script-src settings require `ADMINISTRATION` privilege. See [Security Settings](https://developers.thoughtspot.com/docs/security-settings) for more details. * @param param the request object */ public configureSecuritySettings(param: ThoughtSpotRestApiConfigureSecuritySettingsRequest, options?: Configuration): Promise { return this.api.configureSecuritySettings(param.configureSecuritySettingsRequest, options).toPromise(); } /** * Version: 10.12.0.cl or later Gets connection configuration objects. Requires `DATAMANAGEMENT` (**Can manage data**) and edit permissions to the connection object, or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**) privilege is required. #### Usage guidelines * To get a list of all configurations available in the ThoughtSpot system, send the API request with only the connection name or GUID in the request body. * To fetch details of a configuration object, specify the configuration object name or GUID. * @param param the request object */ public connectionConfigurationSearch(param: ThoughtSpotRestApiConnectionConfigurationSearchRequest, options?: Configuration): Promise> { return this.api.connectionConfigurationSearch(param.connectionConfigurationSearchRequest, options).toPromise(); } /** * Convert worksheets to models Version: 10.6.0.cl or later ## Prerequisites - **Privileges Required:** - `DATAMANAGEMENT` (Can manage data) or `ADMINISTRATION` (Can administer ThoughtSpot). - **Additional Privileges (if RBAC is enabled):** - `CAN_MANAGE_WORKSHEET_VIEWS_TABLES` (Can manage data models). --- ## Usage Guidelines ### Parameters 1. **worksheet_ids** - **Description:** A comma-separated list of GUIDs (Globally Unique Identifiers) specifying the Worksheets to be converted. - **Usage:** - Used only when `convert_all` is set to `false`. - Leave empty or omit when `convert_all` is set to `true`. 2. **exclude_worksheet_ids** - **Description:** A comma-separated list of GUIDs specifying Worksheets to be excluded from conversion. - **Usage:** - Useful when `convert_all` is set to `true` and specific Worksheets should not be converted. 3. **convert_all** - **Description:** Sets the scope of conversion. - **Options:** - `true`: Converts all Worksheets in the system, except those specified in `exclude_worksheet_ids`. - `false`: Converts only the Worksheets listed in `worksheet_ids`. 4. **apply_changes** - **Description:** Specifies whether to apply changes directly to ThoughtSpot or to generate a preview before applying any changes.Used for validation of conversion. - **Options:** - `true`: Applies conversion changes directly to ThoughtSpot. - `false`: Generates only a preview of the changes and does not apply any changes to ThoughtSpot --- ## Best Practices 1. **Backup Before Conversion:** Always export metadata as a backup before initiating the conversion process 2. **Partial Conversion for Testing:** Test the conversion process by setting `convert_all` to `false` and specifying a small number of `worksheet_ids`. 3. **Verify Dependencies:** Check for dependent objects, such as Tables and Connections, to avoid invalid references. 4. **Review Changes:** Use `apply_changes: false` to preview the impact of the conversion before applying changes. --- ## Examples ### Convert Specific Worksheets ```json { \"worksheet_ids\": [\"guid1\", \"guid2\", \"guid3\"], \"exclude_worksheet_ids\": [], \"convert_all\": false, \"apply_changes\": true } ``` ### Convert All Accessible Worksheets ```json { \"worksheet_ids\": [], \"exclude_worksheet_ids\": [], \"convert_all\": true, \"apply_changes\": true } ``` ### Exclude Specific Worksheets While Converting All Accessible Worksheets ```json { \"worksheet_ids\": [], \"exclude_worksheet_ids\": [\"abc\"], \"convert_all\": true, \"apply_changes\": true } ``` * @param param the request object */ public convertWorksheetToModel(param: ThoughtSpotRestApiConvertWorksheetToModelRequest, options?: Configuration): Promise { return this.api.convertWorksheetToModel(param.convertWorksheetToModelRequest, options).toPromise(); } /** * Makes a copy of an Answer or Liveboard Version: 10.3.0.cl or later Creates a copy of a metadata object. Requires at least view access to the metadata object being copied. Upon successful execution, the API creates a copy of the metadata object specified in the API request and returns the ID of the new object. * @param param the request object */ public copyObject(param: ThoughtSpotRestApiCopyObjectRequest, options?: Configuration): Promise { return this.api.copyObject(param.copyObjectRequest, options).toPromise(); } /** * Version: 26.2.0.cl or later Creates a new Spotter agent conversation based on the provided context and settings. The endpoint was in Beta from 26.2.0.cl through 26.4.0.cl. Requires `CAN_USE_SPOTTER` privilege and at least view access to the metadata object specified in the request. #### Usage guidelines The request must include the `metadata_context` parameter to define the conversation context. The context type can be one of: - `DATA_SOURCE` *(available from 26.5.0.cl)*: targets a specific data source. Provide `data_source_identifier` in `data_source_context` for a single data source, or `data_source_identifiers` for multi-data-source context. The deprecated `guid` field is accepted for backwards compatibility. - `AUTO_MODE` *(available from 26.5.0.cl)*: automatically discovers and selects the most relevant datasets for the user\'s queries. > **Note for callers on versions 26.2.0.cl – 26.4.0.cl (Beta):** use the lowercase `data_source` enum value with the `guid` field instead of the above. Example: `{ \"type\": \"data_source\", \"data_source_context\": { \"guid\": \"\" } }`. The `conversation_settings` parameter controls which Spotter capabilities are enabled for the conversation: - `enable_contextual_change_analysis` (default: `true`, **deprecated from 26.2.0.cl**) — always enabled in Spotter 3; setting this to `false` has no effect on versions >= 26.2.0.cl - `enable_natural_language_answer_generation` (default: `true`, **deprecated from 26.2.0.cl**) — always enabled in Spotter 3; setting this to `false` has no effect on versions >= 26.2.0.cl - `enable_reasoning` (default: `true`, **deprecated from 26.2.0.cl**) — always enabled in Spotter 3; setting this to `false` has no effect on versions >= 26.2.0.cl - `enable_save_chat` (default: `false`, *available from 26.5.0.cl*) — enables saving the conversation for later retrieval via conversation history If the request is successful, the response includes a unique `conversation_identifier` that must be passed to `sendAgentConversationMessage` or `sendAgentConversationMessageStreaming` to send messages within this conversation. The response also includes `conversation_id` with the same value for backwards compatibility; use `conversation_identifier` for new integrations. #### Example request ```json { \"metadata_context\": { \"type\": \"DATA_SOURCE\", \"data_source_context\": { \"data_source_identifier\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\" } }, \"conversation_settings\": {} } ``` #### Error responses | Code | Description | | ---- | --------------------------------------------------------------------------------------------------------------------------------------- | | 401 | Unauthorized — authentication token is missing, expired, or invalid. | | 403 | Forbidden — the authenticated user does not have `CAN_USE_SPOTTER` privilege or lacks view permission on the specified metadata object. | > ###### Note: > > - This endpoint was in Beta from 26.2.0.cl through 26.4.0.cl and is Generally Available from version 26.5.0.cl. > - This endpoint requires Spotter - please contact ThoughtSpot support to enable Spotter on your cluster. * @param param the request object */ public createAgentConversation(param: ThoughtSpotRestApiCreateAgentConversationRequest, options?: Configuration): Promise { return this.api.createAgentConversation(param.createAgentConversationRequest, options).toPromise(); } /** * Version: 10.12.0.cl or later Creates a new [custom calendar](https://docs.thoughtspot.com/cloud/latest/connections-cust-cal). Requires `DATAMANAGEMENT` (**Can manage data**) or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your ThoughtSpot instance, the `CAN_MANAGE_CUSTOM_CALENDAR` (**Can manage custom calendars**) privilege is required. #### Usage guidelines You can create a custom calendar from scratch or an existing Table in ThoughtSpot. For both methods of calendar creation, the following parameters are required: * Name of the custom calendar. * Calendar creation method. To create a calendar from an existing table, specify the method: - `FROM_EXISTING_TABLE` - Creates calendar from the table reference provided in the API request. - `FROM_INPUT_PARAMS` - Creates a calendar from the parameters defined in the API request. * Connection ID and Table name * Database and schema name attributes: For most Cloud Data Warehouse (CDW) connectors, both `database_name` and `schema_name` attributes are required. However, the attribute requirements are conditional and vary based on the connector type and its metadata structure. For example, for connectors such as Teradata, MySQL, SingleSore, Amazon Aurora MySQL, Amazon RDS MySQL, Oracle, and GCP_MYSQL, the `schema_name` is required, whereas the `database_name` attribute is not. Similarly, connectors such as ClickHouse require you to specify the `database_name` and the schema specification in such cases is optional. **NOTE**: If you are creating a calendar from an existing table, ensure that the referenced table matches the required DDL for custom calendars. If the schema does not match, the API returns an error. ##### Calendar type The API allows you to create the following types of calendars: * `MONTH_OFFSET`. The default calendar type. A `MONTH_OFFSET` calendar is offset by a few months from the standard calendar months (January to December) and the year begins with the month defined in the request. For example, if the `month_offset` value is set as `April`, the calendar year begins in April. * `4-4-5`. Each quarter in the calendar will include two 4-week months followed by one 5-week month. * `4-5-4`. Each quarter in the calendar will include two 4-week months with a 5-week month between. * `5-4-4`. Each quarter begins with a 5-week month, followed by two 4-week months. To start and end the calendar on a specific date, specify the dates in the `MM/DD/YYYY` format. For `MONTH_OFFSET` calendars, ensure that the `start_date` matches the month specified in the `month_offset` attribute. You can also set the starting day of the week and customize the prefixes for year and quarter labels. #### Examples To create a calendar from an existing table: ``` { \"name\": \"MyCustomCalendar1\", \"table_reference\": { \"connection_identifier\": \"4db8ea22-2ff4-4224-b05a-26674717e468\", \"table_name\": \"MyCalendarTable\", \"database_name\": \"RETAILAPPAREL\", \"schema_name\": \"PUBLIC\" }, \"creation_method\": \"FROM_EXISTING_TABLE\", } ``` To create a calendar from scratch: ``` { \"name\": \"MyCustomCalendar1\", \"table_reference\": { \"connection_identifier\": \"4db8ea22-2ff4-4224-b05a-26674717e468\", \"table_name\": \"MyCalendarTable\", \"database_name\": \"RETAILAPPAREL\", \"schema_name\": \"PUBLIC\" }, \"creation_method\": \"FROM_INPUT_PARAMS\", \"calendar_type\": \"MONTH_OFFSET\", \"month_offset\": \"April\", \"start_day_of_week\": \"Monday\", \"quarter_name_prefix\": \"Q\", \"year_name_prefix\": \"FY\", \"start_date\": \"04/01/2025\", \"end_date\": \"04/31/2025\" } ``` * @param param the request object */ public createCalendar(param: ThoughtSpotRestApiCreateCalendarRequest, options?: Configuration): Promise { return this.api.createCalendar(param.createCalendarRequest, options).toPromise(); } /** * Version: 26.4.0.cl or later Creates a new collection in ThoughtSpot. Collections allow you to organize and group related metadata objects such as Liveboards, Answers, worksheets, and other data objects. You can also create nested collections (sub-collections) to build a hierarchical structure. #### Supported operations The API endpoint lets you perform the following operations: * Create a new collection * Add metadata objects (Liveboards, Answers, Logical Tables) to the collection * Create nested collections by adding sub-collections * @param param the request object */ public createCollection(param: ThoughtSpotRestApiCreateCollectionRequest, options?: Configuration): Promise { return this.api.createCollection(param.createCollectionRequest, options).toPromise(); } /** * Version: 9.2.0.cl or later Allows you to connect a ThoughtSpot instance to a Git repository. Requires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance on your instance, the `CAN_SETUP_VERSION_CONTROL` (**Can set up version control**) privilege. You can use this API endpoint to connect your ThoughtSpot development and production environments to the development and production branches of a Git repository. Before using this endpoint to connect your ThoughtSpot instance to a Git repository, check the following prerequisites: * You have a Git repository. If you are using GitHub, make sure you have a valid account and an access token to connect ThoughtSpot to GitHub. For information about generating a token, see [GitHub Documentation](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens). * Your access token has `repo` scope that grants full access to public and private repositories. * Your Git repository has a branch that can be configured as a default branch in ThoughtSpot. For more information, see [Git integration documentation](https://developers.thoughtspot.com/docs/?pageid=git-integration). **Note**: ThoughtSpot supports only GitHub / itHub Enterprise for CI/CD. * @param param the request object */ public createConfig(param: ThoughtSpotRestApiCreateConfigRequest, options?: Configuration): Promise { return this.api.createConfig(param.createConfigRequest, options).toPromise(); } /** * Version: 9.2.0.cl or later Creates a connection to a data warehouse for live query services. Requires `DATAMANAGEMENT` (**Can manage data**) or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**) privilege is required. #### Create a connection without tables To create a connection without tables: 1. Pass these parameters in your API request. * Name of the connection. * Type of the data warehouse to connect to. * A JSON map of configuration attributes in `data_warehouse_config`. The following example shows the configuration attributes for a SnowFlake connection: ``` { \"configuration\":{ \"accountName\":\"thoughtspot_partner\", \"user\":\"tsadmin\", \"password\":\"TestConn123\", \"role\":\"sysadmin\", \"warehouse\":\"MEDIUM_WH\" }, \"authenticationType\": \"SERVICE_ACCOUNT\", \"externalDatabases\":[ ] } ``` 2. Set `validate` to `false`. **NOTE:** If the `authentication_type` is anything other than SERVICE_ACCOUNT, you must explicitly provide the authenticationType property in the payload. If you do not specify authenticationType, the API will default to SERVICE_ACCOUNT as the authentication type. #### Create a connection with tables If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**) and `CAN_MANAGE_WORKSHEET_VIEWS_TABLES` (**Can manage data models**) privilege is required. To create a connection with tables: 1. Pass these parameters in your API request. * Name of the connection. * Type of the data warehouse to connect to. * A JSON map of configuration attributes, database details, and table properties in `data_warehouse_config` as shown in the following example: ``` { \"configuration\":{ \"accountName\":\"thoughtspot_partner\", \"user\":\"tsadmin\", \"password\":\"TestConn123\", \"role\":\"sysadmin\", \"warehouse\":\"MEDIUM_WH\" }, \"authenticationType\": \"SERVICE_ACCOUNT\", \"externalDatabases\":[ { \"name\":\"AllDatatypes\", \"isAutoCreated\":false, \"schemas\":[ { \"name\":\"alldatatypes\", \"tables\":[ { \"name\":\"allDatatypes\", \"type\":\"TABLE\", \"description\":\"\", \"selected\":true, \"linked\":true, \"columns\":[ { \"name\":\"CNUMBER\", \"type\":\"INT64\", \"canImport\":true, \"selected\":true, \"isLinkedActive\":true, \"isImported\":false, \"tableName\":\"allDatatypes\", \"schemaName\":\"alldatatypes\", \"dbName\":\"AllDatatypes\" }, { \"name\":\"CDECIMAL\", \"type\":\"INT64\", \"canImport\":true, \"selected\":true, \"isLinkedActive\":true, \"isImported\":false, \"tableName\":\"allDatatypes\", \"schemaName\":\"alldatatypes\", \"dbName\":\"AllDatatypes\" } ] } ] } ] } ] } ``` 2. Set `validate` to `true`. **NOTE:** If the `authentication_type` is anything other than SERVICE_ACCOUNT, you must explicitly provide the authenticationType property in the payload. If you do not specify authenticationType, the API will default to SERVICE_ACCOUNT as the authentication type. * @param param the request object */ public createConnection(param: ThoughtSpotRestApiCreateConnectionRequest, options?: Configuration): Promise { return this.api.createConnection(param.createConnectionRequest, options).toPromise(); } /** * Version: 10.12.0.cl or later Creates an additional configuration to an existing connection to a data warehouse. Requires `DATAMANAGEMENT` (**Can manage data**) or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**) privilege is required. #### Usage guidelines * A JSON map of configuration attributes in `configuration`. The following example shows the configuration attributes: ``` { \"user\":\"DEV_USER\", \"password\":\"TestConn123\", \"role\":\"DEV\", \"warehouse\":\"DEV_WH\" } ``` * If the `policy_type` is `PRINCIPALS`, then `policy_principals` is a required field. * If the `policy_type` is `PROCESSES`, then `policy_processes` is a required field. * If the `policy_type` is `NO_POLICY`, then `policy_principals` and `policy_processes` are not required fields. #### Parameterized Connection Support For parameterized connections that use OAuth authentication, only the same_as_parent and policy_process_options attributes are allowed in the API request. These attributes are not applicable to connections that are not parameterized. * @param param the request object */ public createConnectionConfiguration(param: ThoughtSpotRestApiCreateConnectionConfigurationRequest, options?: Configuration): Promise { return this.api.createConnectionConfiguration(param.createConnectionConfigurationRequest, options).toPromise(); } /** * Version: 10.4.0.cl or later Creates a new conversation session tied to a specific data model for AI-driven natural language querying. Requires `CAN_USE_SPOTTER` privilege and at least view access to the metadata object specified in the request. #### Usage guidelines The request must include: - `metadata_identifier`: the unique ID of the data source that provides context for the conversation Optionally, you can provide: - `tokens`: a token string to set initial context for the conversation (e.g., `\"[sales],[item type],[state]\"`) If the request is successful, ThoughtSpot returns a unique `conversation_identifier` that must be passed to `sendMessage` to continue the conversation. #### Error responses | Code | Description | |------|-------------| | 401 | Unauthorized — authentication token is missing, expired, or invalid. | | 403 | Forbidden — the authenticated user does not have `CAN_USE_SPOTTER` privilege or lacks view permission on the specified metadata object. | > ###### Note: > * This endpoint is currently in Beta. Breaking changes may be introduced before the endpoint is made Generally Available. > * This endpoint requires Spotter - please contact ThoughtSpot support to enable Spotter on your cluster. * @param param the request object */ public createConversation(param: ThoughtSpotRestApiCreateConversationRequest, options?: Configuration): Promise { return this.api.createConversation(param.createConversationRequest, options).toPromise(); } /** * Version: 9.6.0.cl or later Creates a custom action that appears as a menu action on a saved Answer or Liveboard visualization. Requires `DEVELOPER` (**Has Developer privilege**) or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `DEVELOPER` (**Has developer privilege**) privilege is required. #### Usage Guidelines The API lets you create the following types of custom actions: * URL-based action Allows pushing data to an external URL. * Callback action Triggers a callback to the host application and initiates a response payload on an embedded ThoughtSpot instance. By default, custom actions are visible to only administrator or developer users. To make a custom action available to other users, and specify the groups in `group_identifiers`. By default, the custom action is set as a _global_ action on all visualizations and saved Answers. To assign a custom action to specific Liveboard visualization, saved Answer, or Worksheet, set `visibility` to `false` in `default_action_config` property and specify the GUID or name of the object in `associate_metadata`. For more information, see [Custom actions](https://developers.thoughtspot.com/docs/custom-action-intro). * @param param the request object */ public createCustomAction(param: ThoughtSpotRestApiCreateCustomActionRequest, options?: Configuration): Promise { return this.api.createCustomAction(param.createCustomActionRequest, options).toPromise(); } /** * Version: 10.10.0.cl or later Creates a customization configuration for the notification email. #### Pre-requisites Requires `DEVELOPER` (**has developer privilege**) or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `DEVELOPER` (**Has developer privilege**) privilege is required. **NOTE**:This endpoint in currently in beta. Contact ThoughtSpot support to enable this on your instance. #### Usage guidelines To create a custom configuration pass these parameters in your API request: - A JSON map of configuration attributes `template_properties`. The following example shows a sample set of customization configuration: ``` { { \"cta_button_bg_color\": \"#444DEA\", \"cta_text_font_color\": \"#FFFFFF\", \"primary_bg_color\": \"#D3DEF0\", \"logo_url\": \"https://storage.pardot.com/710713/1642089901EbkRibJq/TS_fullworkmark_darkmode.png\", \"font_family\": \"\", \"product_name\": \"ThoughtSpot\", \"footer_address\": \"444 Castro St, Suite 1000 Mountain View, CA 94041\", \"footer_phone\": \"(800) 508-7008\", \"replacement_value_for_liveboard\": \"Dashboard\", \"replacement_value_for_answer\": \"Chart\", \"replacement_value_for_spot_iq\": \"AI Insights\", \"hide_footer_phone\": false, \"hide_footer_address\": false, \"hide_product_name\": false, \"hide_manage_notification\": false, \"hide_mobile_app_nudge\": false, \"hide_privacy_policy\": false, \"hide_ts_vocabulary_definitions\": false, \"hide_error_message\": false, \"hide_unsubscribe_link\": false, \"hide_notification_status\": false, \"hide_modify_alert\": false, \"company_website_url\": \"https://your-website.com/\", \"company_privacy_policy_url\" : \"https://link-to-privacy-policy.com/\", \"contact_support_url\": \"https://link-to-contact-support.com/\", \"hide_contact_support_url\": false, \"hide_logo_url\" : false } } ``` * @param param the request object */ public createEmailCustomization(param: ThoughtSpotRestApiCreateEmailCustomizationRequest, options?: Configuration): Promise { return this.api.createEmailCustomization(param.createEmailCustomizationRequest, options).toPromise(); } /** * Version: 9.0.0.cl or later Creates an Org object. To use this API, the [Orgs](https://docs.thoughtspot.com/cloud/latest/orgs-overview) feature must be enabled in your cluster. Requires cluster administration (**Can administer Org**) privileges. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `ORG_ADMINISTRATION` (**Can manage Orgs**) privilege is required. * @param param the request object */ public createOrg(param: ThoughtSpotRestApiCreateOrgRequest, options?: Configuration): Promise { return this.api.createOrg(param.createOrgRequest, options).toPromise(); } /** * Version: 9.5.0.cl or later Creates a Role object in ThoughtSpot. Available only if [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance. To create a Role, the `ROLE_ADMINISTRATION` (**Can manage roles**) privilege is required. * @param param the request object */ public createRole(param: ThoughtSpotRestApiCreateRoleRequest, options?: Configuration): Promise { return this.api.createRole(param.createRoleRequest, options).toPromise(); } /** * Create schedule. Version: 9.4.0.cl or later Creates a Liveboard schedule job. Requires at least edit access to Liveboards. To create a schedule on behalf of another user, you need `ADMINISTRATION` (**Can administer Org**) or `JOBSCHEDULING` (**Can schedule for others**) privilege and edit access to the Liveboard. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `JOBSCHEDULING` (**Can schedule for others**) privilege is required. #### Usage guidelines * The description text is mandatory. The description text appears as **Description: ** in the Liveboard schedule email notifications. * For Liveboards with both charts and tables, schedule creation is only supported in PDF and XLS formats. Schedules created in CSV formats for such Liveboards will fail to run. If `PDF` is set as the `file_format`, enable `pdf_options` to get the correct attachment. Not doing so may cause the attachment to be rendered empty. * To include only specific visualizations, specify the visualization GUIDs in the `visualization_identifiers` array. * You can schedule a Liveboard job to run periodically by setting frequency parameters. You can set the schedule to run daily, weekly, monthly or every n minutes or hours. The scheduled job can also be configured to run at a specific time of the day or on specific days of the week or month. Please ensure that when setting the schedule frequency for _minute of the object_, only values that are multiples of 5 are included. * If the `frequency` parameters are defined, you can set the time zone to a value that matches your server\'s time zone. For example, `US/Central`, `Etc/UTC`, `CET`. The default time zone is `America/Los_Angeles`. For more information about Liveboard jobs, see [ThoughtSpot Product Documentation](https://docs.thoughtspot.com/cloud/latest/liveboard-schedule). * @param param the request object */ public createSchedule(param: ThoughtSpotRestApiCreateScheduleRequest, options?: Configuration): Promise { return this.api.createSchedule(param.createScheduleRequest, options).toPromise(); } /** * Version: 9.0.0.cl or later Creates a tag object. Tags are labels that identify a metadata object. For example, you can create a tag to designate subject areas, such as sales, HR, marketing, and finance. Requires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `TAGMANAGEMENT` (**Can manage tags**) privilege is required to create, edit, and delete tags. * @param param the request object */ public createTag(param: ThoughtSpotRestApiCreateTagRequest, options?: Configuration): Promise { return this.api.createTag(param.createTagRequest, options).toPromise(); } /** * Version: 9.0.0.cl or later Creates a user in ThoughtSpot. The API endpoint allows you to configure several user properties such as email address, account status, share notification preferences, and sharing visibility. You can provision the user to [groups](https://docs.thoughtspot.com/cloud/latest/groups-privileges) and [Orgs](https://docs.thoughtspot.com/cloud/latest/orgs-overview). You can also add Liveboard, Answer, and Worksheet objects to the user’s favorites list, assign a default Liveboard for the user, and set user preferences. Requires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `USER_ADMINISTRATION` (**Can manage users**) privilege is required. * @param param the request object */ public createUser(param: ThoughtSpotRestApiCreateUserRequest, options?: Configuration): Promise { return this.api.createUser(param.createUserRequest, options).toPromise(); } /** * Version: 9.0.0.cl or later Creates a group object in ThoughtSpot. Requires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `GROUP_ADMINISTRATION` (**Can manage groups**) privilege is required. #### About groups Groups in ThoughtSpot are used by the administrators to define privileges and organize users based on their roles and access requirements. To know more about groups and privileges, see [ThoughtSpot Product Documentation](https://docs.thoughtspot.com/cloud/latest/groups-privileges). #### Supported operations The API endpoint lets you perform the following operations: * Assign privileges * Add users * Define sharing visibility * Add sub-groups * Assign a default Liveboard * @param param the request object */ public createUserGroup(param: ThoughtSpotRestApiCreateUserGroupRequest, options?: Configuration): Promise { return this.api.createUserGroup(param.createUserGroupRequest, options).toPromise(); } /** * Create a variable which can be used for parameterizing metadata objects Version: 10.14.0.cl or later Allows creating a variable which can be used for parameterizing metadata objects in ThoughtSpot. Requires ADMINISTRATION role and TENANT scope. The CAN_MANAGE_VARIABLES permission allows you to manage Formula Variables in the current organization scope. The API endpoint supports the following types of variables: * CONNECTION_PROPERTY - For connection properties * TABLE_MAPPING - For table mappings * CONNECTION_PROPERTY_PER_PRINCIPAL - For connection properties per principal. In order to use this please contact support to enable this. * FORMULA_VARIABLE - For Formula variables, introduced in 10.15.0.cl When creating a variable, you need to specify: * The variable type * A unique name for the variable * Whether the variable contains sensitive values (defaults to false) * The data type of the variable, only specify for formula variables (defaults to null) The operation will fail if: * The user lacks required permissions * The variable name already exists * The variable type is invalid * @param param the request object */ public createVariable(param: ThoughtSpotRestApiCreateVariableRequest, options?: Configuration): Promise { return this.api.createVariable(param.createVariableRequest, options).toPromise(); } /** * Version: 10.14.0.cl or later Creates a new webhook configuration to receive notifications for specified events. The webhook will be triggered when the configured events occur in the system. Requires `ADMINISTRATION` (**Can administer ThoughtSpot**) or `DEVELOPER` (**Has developer privilege**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, users with `CAN_MANAGE_WEBHOOKS` (**Can manage webhooks**) privilege are also authorized to perform this action. * @param param the request object */ public createWebhookConfiguration(param: ThoughtSpotRestApiCreateWebhookConfigurationRequest, options?: Configuration): Promise { return this.api.createWebhookConfiguration(param.createWebhookConfigurationRequest, options).toPromise(); } /** * Version: 9.9.0.cl or later Creates a DBT connection object in ThoughtSpot. Requires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege or `DATAMANAGEMENT` (**Can manage data**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the following Data control privileges may be required: - `CAN_MANAGE_CUSTOM_CALENDAR`(**Can manage custom calendars**) - `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**) - `CAN_MANAGE_WORKSHEET_VIEWS_TABLES` (**Can manage data models**) #### About create DBT connection DBT connection in ThoughtSpot is used by the user to define DBT credentials for cloud . The API needs embrace connection, embrace database name, DBT url, import type, DBT account identifier, DBT project identifier, DBT access token and environment details (or) embrace connection, embrace database name, import type, file_content to create a connection object. To know more about DBT, see ThoughtSpot Product Documentation. * @param param the request object */ public dbtConnection(param: ThoughtSpotRestApiDbtConnectionRequest, options?: Configuration): Promise { return this.api.dbtConnection(param.connectionName, param.databaseName, param.importType, param.accessToken, param.dbtUrl, param.accountId, param.projectId, param.dbtEnvId, param.projectName, param.fileContent, options).toPromise(); } /** * Version: 9.9.0.cl or later Resynchronize the existing list of models, tables, worksheet tml’s and import them to Thoughtspot based on the DBT connection object. Requires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege or `DATAMANAGEMENT` (**Can manage data**) privilege, along with an existing DBT connection. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the following data control privileges may be required: - `CAN_MANAGE_CUSTOM_CALENDAR`(**Can manage custom calendars**) - `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**) - `CAN_MANAGE_WORKSHEET_VIEWS_TABLES` (**Can manage data models**) * @param param the request object */ public dbtGenerateSyncTml(param: ThoughtSpotRestApiDbtGenerateSyncTmlRequest, options?: Configuration): Promise { return this.api.dbtGenerateSyncTml(param.dbtConnectionIdentifier, param.fileContent, options).toPromise(); } /** * Version: 9.9.0.cl or later Generate required table and worksheet and import them. Requires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege or `DATAMANAGEMENT` (**Can manage data**) privilege, along with an existing DBT connection. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the following data control privileges may be required: - `CAN_MANAGE_CUSTOM_CALENDAR`(**Can manage custom calendars**) - `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**) - `CAN_MANAGE_WORKSHEET_VIEWS_TABLES` (**Can manage data models**) #### About generate TML Models and Worksheets to be imported can be selected by the user as part of the API. * @param param the request object */ public dbtGenerateTml(param: ThoughtSpotRestApiDbtGenerateTmlRequest, options?: Configuration): Promise { return this.api.dbtGenerateTml(param.dbtConnectionIdentifier, param.modelTables, param.importWorksheets, param.worksheets, param.fileContent, options).toPromise(); } /** * Version: 9.9.0.cl or later Gets a list of DBT connection objects by user and organization, available on the ThoughtSpot system. Requires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege or `DATAMANAGEMENT` (**Can manage data**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the following Data control privileges may be required: - `CAN_MANAGE_CUSTOM_CALENDAR`(**Can manage custom calendars**) - `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**) - `CAN_MANAGE_WORKSHEET_VIEWS_TABLES` (**Can manage data models**) #### About search DBT connection To get details of a specific DBT connection identifier, database connection identifier, database connection name, database name, project name, project identifier, environment identifier , import type and author. * @param param the request object */ public dbtSearch(param: ThoughtSpotRestApiDbtSearchRequest = {}, options?: Configuration): Promise> { return this.api.dbtSearch( options).toPromise(); } /** * Version: 9.7.0.cl or later Deactivates a user account. Requires `ADMINISTRATION` (**Can administer Thoughtspot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `USER_ADMINISTRATION` (**Can manage users**) privilege is required. To deactivate a user account, the API request body must include the following information: - Username or the GUID of the user account - Base URL of the ThoughtSpot instance If the API request is successful, ThoughtSpot returns the activation URL in the response. The activation URL is valid for 14 days and can be used to re-activate the account and reset the password of the deactivated account. * @param param the request object */ public deactivateUser(param: ThoughtSpotRestApiDeactivateUserRequest, options?: Configuration): Promise { return this.api.deactivateUser(param.deactivateUserRequest, options).toPromise(); } /** * Version: 10.12.0.cl or later Deletes a [custom calendar](https://docs.thoughtspot.com/cloud/latest/connections-cust-cal). Requires `DATAMANAGEMENT` (**Can manage data**) or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your ThoughtSpot instance, the `CAN_MANAGE_CUSTOM_CALENDAR` (**Can manage custom calendars**) privilege is required. #### Usage guidelines To delete a custom calendar, specify the calendar ID as a path parameter in the request URL. * @param param the request object */ public deleteCalendar(param: ThoughtSpotRestApiDeleteCalendarRequest, options?: Configuration): Promise { return this.api.deleteCalendar(param.calendarIdentifier, options).toPromise(); } /** * Version: 26.4.0.cl or later Deletes one or more collections from ThoughtSpot. #### Delete options * **delete_children**: When set to `true`, deletes the child objects (metadata items) within the collection that the user has access to. Objects that the user does not have permission to delete will be skipped. * **dry_run**: When set to `true`, performs a preview of the deletion operation without actually deleting anything. The response shows what would be deleted, allowing you to review before committing the deletion. #### Response The response includes: * **metadata_deleted**: List of metadata objects that were successfully deleted * **metadata_skipped**: List of metadata objects that were skipped due to lack of permissions or other constraints * @param param the request object */ public deleteCollection(param: ThoughtSpotRestApiDeleteCollectionRequest, options?: Configuration): Promise { return this.api.deleteCollection(param.deleteCollectionRequest, options).toPromise(); } /** * Version: 9.2.0.cl or later Deletes Git repository configuration from your ThoughtSpot instance. Requires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance on your instance, the `CAN_SETUP_VERSION_CONTROL` (**Can set up version control**) privilege. * @param param the request object */ public deleteConfig(param: ThoughtSpotRestApiDeleteConfigRequest, options?: Configuration): Promise { return this.api.deleteConfig(param.deleteConfigRequest, options).toPromise(); } /** * Version: 9.2.0.cl or later **Important**: This endpoint is deprecated and will be removed from ThoughtSpot in September 2025. ThoughtSpot strongly recommends using the [Delete Connection V2](#/http/api-endpoints/connections/delete-connection-v2) endpoint to delete your connection objects. #### Usage guidelines Deletes a connection object. Requires `DATAMANAGEMENT` (**Can manage data**) and edit permissions to the connection object, or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**) privilege is required. **Note**: If a connection has dependent objects, make sure you remove its associations before the delete operation. * @param param the request object */ public deleteConnection(param: ThoughtSpotRestApiDeleteConnectionRequest, options?: Configuration): Promise { return this.api.deleteConnection(param.deleteConnectionRequest, options).toPromise(); } /** * Version: 10.12.0.cl or later Deletes connection configuration objects. Requires `DATAMANAGEMENT` (**Can manage data**) and edit permissions to the connection object, or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**) privilege is required. * @param param the request object */ public deleteConnectionConfiguration(param: ThoughtSpotRestApiDeleteConnectionConfigurationRequest, options?: Configuration): Promise { return this.api.deleteConnectionConfiguration(param.deleteConnectionConfigurationRequest, options).toPromise(); } /** * Version: 10.4.0.cl or later Deletes a connection object. **Note**: If a connection has dependent objects, make sure you remove its associations before the delete operation. Requires `DATAMANAGEMENT` (**Can manage data**) and edit permissions to the connection object, or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**) privilege is required. * @param param the request object */ public deleteConnectionV2(param: ThoughtSpotRestApiDeleteConnectionV2Request, options?: Configuration): Promise { return this.api.deleteConnectionV2(param.connectionIdentifier, options).toPromise(); } /** * Version: 9.6.0.cl or later Removes the custom action specified in the API request. Requires `DEVELOPER` (**Has Developer privilege**) or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `DEVELOPER` (**Has developer privilege**) privilege is required. * @param param the request object */ public deleteCustomAction(param: ThoughtSpotRestApiDeleteCustomActionRequest, options?: Configuration): Promise { return this.api.deleteCustomAction(param.customActionIdentifier, options).toPromise(); } /** * Version: 9.9.0.cl or later Removes the specified DBT connection object from the ThoughtSpot system. Requires `ADMINISTRATION` (**Can administer ThoughtSpot**) or `DATAMANAGEMENT` (**Can manage data ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the following Data control privileges may be required: - `CAN_MANAGE_CUSTOM_CALENDAR`(**Can manage custom calendars**) - `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**) - `CAN_MANAGE_WORKSHEET_VIEWS_TABLES` (**Can manage data models**) * @param param the request object */ public deleteDbtConnection(param: ThoughtSpotRestApiDeleteDbtConnectionRequest, options?: Configuration): Promise { return this.api.deleteDbtConnection(param.dbtConnectionIdentifier, options).toPromise(); } /** * Version: 10.10.0.cl or later Deletes the configuration for the email customization. #### Pre-requisites Requires `DEVELOPER` (**has developer privilege**) or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `DEVELOPER` (**Has developer privilege**) privilege is required. **NOTE**:This endpoint in currently in beta. Contact ThoughtSpot support to enable this on your instance. #### Usage guidelines - Call the search API endpoint to get the `template_identifier` from the response. - Use that `template_identifier` as a parameter in this API request. * @param param the request object */ public deleteEmailCustomization(param: ThoughtSpotRestApiDeleteEmailCustomizationRequest, options?: Configuration): Promise { return this.api.deleteEmailCustomization(param.templateIdentifier, options).toPromise(); } /** * Version: 9.0.0.cl or later Removes the specified metadata object from the ThoughtSpot system. Requires edit access to the metadata object. * @param param the request object */ public deleteMetadata(param: ThoughtSpotRestApiDeleteMetadataRequest, options?: Configuration): Promise { return this.api.deleteMetadata(param.deleteMetadataRequest, options).toPromise(); } /** * Version: 9.0.0.cl or later Deletes an Org object from the ThoughtSpot system. Requires cluster administration (**Can administer Org**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `ORG_ADMINISTRATION` (**Can manage Orgs**) privilege is required. When you delete an Org, all its users and objects created in that Org context are removed. However, if the users in the deleted Org also exists in other Orgs, they are removed only from the deleted Org. * @param param the request object */ public deleteOrg(param: ThoughtSpotRestApiDeleteOrgRequest, options?: Configuration): Promise { return this.api.deleteOrg(param.orgIdentifier, options).toPromise(); } /** * Version: 10.12.0.cl or later Deletes the configuration for the email customization. #### Pre-requisites Requires `DEVELOPER` (**has developer privilege**) or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `DEVELOPER` (**Has developer privilege**) privilege is required. **NOTE**:This endpoint in currently in beta. Contact ThoughtSpot support to enable this on your instance. #### Usage guidelines - Call the search API endpoint to get the `org_identifier` from the response. - Use that `org_identifier` as a parameter in this API request. * @param param the request object */ public deleteOrgEmailCustomization(param: ThoughtSpotRestApiDeleteOrgEmailCustomizationRequest, options?: Configuration): Promise { return this.api.deleteOrgEmailCustomization(param.deleteOrgEmailCustomizationRequest, options).toPromise(); } /** * Version: 9.5.0.cl or later Deletes a Role object from the ThoughtSpot system. Available only if [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance. To delete a Role, the `ROLE_ADMINISTRATION` (**Can manage roles**) privilege is required. * @param param the request object */ public deleteRole(param: ThoughtSpotRestApiDeleteRoleRequest, options?: Configuration): Promise { return this.api.deleteRole(param.roleIdentifier, options).toPromise(); } /** * Deletes a scheduled job. Version: 9.4.0.cl or later Deletes a scheduled Liveboard job. Requires at least edit access to Liveboard or `ADMINISTRATION` (**Can administer Org**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `JOBSCHEDULING` (**Can schedule for others**) privilege is required. * @param param the request object */ public deleteSchedule(param: ThoughtSpotRestApiDeleteScheduleRequest, options?: Configuration): Promise { return this.api.deleteSchedule(param.scheduleIdentifier, options).toPromise(); } /** * Version: 9.0.0.cl or later Deletes a tag object from the ThoughtSpot system Requires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `TAGMANAGEMENT` (**Can manage tags**) privilege is required to create, edit, and delete tags. * @param param the request object */ public deleteTag(param: ThoughtSpotRestApiDeleteTagRequest, options?: Configuration): Promise { return this.api.deleteTag(param.tagIdentifier, options).toPromise(); } /** * Version: 9.0.0.cl or later Deletes a user from the ThoughtSpot system. If you want to remove a user from a specific Org but not from ThoughtSpot, update the group and Org mapping properties of the user object via a POST API call to the [/api/rest/2.0/users/{user_identifier}/update](#/http/api-endpoints/users/update-user) endpoint. Requires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `USER_ADMINISTRATION` (**Can manage users**) privilege is required. * @param param the request object */ public deleteUser(param: ThoughtSpotRestApiDeleteUserRequest, options?: Configuration): Promise { return this.api.deleteUser(param.userIdentifier, options).toPromise(); } /** * Version: 9.0.0.cl or later Removes the specified group object from the ThoughtSpot system. Requires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `GROUP_ADMINISTRATION` (**Can manage groups**) privilege is required. * @param param the request object */ public deleteUserGroup(param: ThoughtSpotRestApiDeleteUserGroupRequest, options?: Configuration): Promise { return this.api.deleteUserGroup(param.groupIdentifier, options).toPromise(); } /** * Delete a variable Version: 10.14.0.cl or later **Note:** This API endpoint is deprecated and will be removed from ThoughtSpot in a future release. Use [POST /api/rest/2.0/template/variables/delete](/api/rest/2.0/template/variables/delete) instead. Allows deleting a variable from ThoughtSpot. Requires ADMINISTRATION role and TENANT scope. The CAN_MANAGE_VARIABLES permission allows you to manage Formula Variables in the current organization scope. The API endpoint requires: * The variable identifier (ID or name) The operation will fail if: * The user lacks required permissions * The variable doesn\'t exist * The variable is being used by other objects * @param param the request object */ public deleteVariable(param: ThoughtSpotRestApiDeleteVariableRequest, options?: Configuration): Promise { return this.api.deleteVariable(param.identifier, options).toPromise(); } /** * Delete variable(s) Version: 26.4.0.cl or later Allows deleting multiple variables from ThoughtSpot. Requires ADMINISTRATION role and TENANT scope. The CAN_MANAGE_VARIABLES permission allows you to manage Formula Variables in the current organization scope. The API endpoint requires: * The variable identifiers (IDs or names) The operation will fail if: * The user lacks required permissions * Any of the variables don\'t exist * Any of the variables are being used by other objects * @param param the request object */ public deleteVariables(param: ThoughtSpotRestApiDeleteVariablesRequest, options?: Configuration): Promise { return this.api.deleteVariables(param.deleteVariablesRequest, options).toPromise(); } /** * Version: 10.14.0.cl or later Deletes one or more webhook configurations by their unique id or name. Returns status of each deletion operation, including successfully deleted webhooks and any failures with error details. Requires `ADMINISTRATION` (**Can administer ThoughtSpot**) or `DEVELOPER` (**Has developer privilege**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, users with `CAN_MANAGE_WEBHOOKS` (**Can manage webhooks**) privilege are also authorized to perform this action. * @param param the request object */ public deleteWebhookConfigurations(param: ThoughtSpotRestApiDeleteWebhookConfigurationsRequest, options?: Configuration): Promise { return this.api.deleteWebhookConfigurations(param.deleteWebhookConfigurationsRequest, options).toPromise(); } /** * Version: 9.2.0.cl or later Allows you to deploy a commit and publish TML content to your ThoughtSpot instance. Requires at least edit access to the objects used in the deploy operation. The API deploys the head of the branch unless a `commit_id` is specified in the API request. If the branch name is not defined in the request, the default branch is considered for deploying commits. For more information, see [Git integration documentation](https://developers.thoughtspot.com/docs/git-integration). * @param param the request object */ public deployCommit(param: ThoughtSpotRestApiDeployCommitRequest, options?: Configuration): Promise> { return this.api.deployCommit(param.deployCommitRequest, options).toPromise(); } /** * Version: 9.9.0.cl or later Exports the difference in connection metadata between CDW and ThoughtSpot Requires `DATAMANAGEMENT` (**Can manage data**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the following Data control privileges may be required: - `CAN_MANAGE_CUSTOM_CALENDAR`(**Can manage custom calendars**) - `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**) - `CAN_MANAGE_WORKSHEET_VIEWS_TABLES` (**Can manage data models**) To download the connection metadata difference between ThoughtSpot and CDW, pass the connection GUID as `connection_identifier` in the API request. * @param param the request object */ public downloadConnectionMetadataChanges(param: ThoughtSpotRestApiDownloadConnectionMetadataChangesRequest, options?: Configuration): Promise { return this.api.downloadConnectionMetadataChanges(param.connectionIdentifier, options).toPromise(); } /** * Version: 9.0.0.cl or later Exports an Answer in the given file format. You can download the Answer data as a PDF, PNG, CSV, or XLSX file. Requires at least view access to the Answer. #### Usage guidelines In the request body, the GUID or name of the Answer and set `file_format`. The default file format is CSV. **NOTE**: * The downloadable file returned in API response file is extensionless. Please rename the downloaded file by typing in the relevant extension. * HTML rendering is not supported for PDF exports of Answers with tables. Optionally, you can define [runtime overrides](https://developers.thoughtspot.com/docs/fetch-data-and-report-apis#_runtime_overrides) to apply to the Answer data. * @param param the request object */ public exportAnswerReport(param: ThoughtSpotRestApiExportAnswerReportRequest, options?: Configuration): Promise { return this.api.exportAnswerReport(param.exportAnswerReportRequest, options).toPromise(); } /** * Version: 9.0.0.cl or later Exports a Liveboard and its visualizations in PDF, PNG, CSV, or XLSX file format. The default `file_format` is CSV. Requires at least view access to the Liveboard. #### Usage guidelines In the request body, specify the GUID or name of the Liveboard. To generate a Liveboard report with specific visualizations, add GUIDs or names of the visualizations. **NOTE**: * The downloadable file returned in API response file is extensionless. Please rename the downloaded file by typing in the relevant extension. * Optionally, you can define [runtime overrides](https://developers.thoughtspot.com/docs/fetch-data-and-report-apis#_runtime_overrides) to apply to the Answer data. * To include unsaved changes in the report, pass the `transient_pinboard_content` script generated from the `getExportRequestForCurrentPinboard` method in the Visual Embed SDK. Upon successful execution, the API returns the report with unsaved changes, including ad hoc changes to visualizations. For more information, see [Liveboard Report API](https://developers.thoughtspot.com/docs/fetch-data-and-report-apis#_liveboard_report_api). * Starting with ThoughtSpot Cloud 10.9.0.cl release, the Liveboard can be exported in the PNG format in the resolution of your choice. To enable this on your instance, contact ThoughtSpot support. When this feature is enabled, the options `include_cover_page`,`include_filter_page` within the `png_options` will not be available for PNG exports. * Starting with the ThoughtSpot Cloud 26.2.0.cl release, * Liveboards can be exported in CSV format. * All visualizations within a Liveboard can be exported as individual CSV files. * When exporting multiple visualizations or the entire Liveboard, the system returns the report as a compressed ZIP file containing the separate CSV files for each visualization. * Liveboards can also be exported in XLSX format. * All selected visualizations are consolidated into a single Excel workbook (.xlsx), with each visualization placed in its own worksheet (tab). * XLSX exports are limited to a maximum of 255 worksheets (tabs) per workbook. * @param param the request object */ public exportLiveboardReport(param: ThoughtSpotRestApiExportLiveboardReportRequest, options?: Configuration): Promise { return this.api.exportLiveboardReport(param.exportLiveboardReportRequest, options).toPromise(); } /** * Version: 9.0.0.cl or later Exports the [TML](https://docs.thoughtspot.com/cloud/latest/tml) representation of metadata objects in JSON or YAML format. Requires `DATADOWNLOADING` (**Can download Data**) and at least view access to the metadata object. #### Usage guidelines * You can export one or several objects by passing metadata object GUIDs in the `metadata` array. * When exporting TML content for a Liveboard or Answer object, you can set `export_associated` to `true` to retrieve TML content for underlying Worksheets, Tables, or Views, including the GUID of each object within the headers. When `export_associated` is set to `true`, consider retrieving one metadata object at a time. * Set `export_fqns` to `true` to add FQNs of the referenced objects in the TML content. For example, if you send an API request to retrieve TML for a Liveboard and its associated objects, the API returns the TML content with FQNs of the referenced Worksheet. Exporting TML with FQNs is useful if ThoughtSpot has multiple objects with the same name and you want to eliminate ambiguity when importing TML files into ThoughtSpot. It eliminates the need for adding FQNs of the referenced objects manually during the import operation. * To export only the TML of feedbacks associated with an object, set the GUID of the object as `identifier`, and set the `type` as `FEEDBACK` in the `metadata` array. * To export the TML of an object along with the feedbacks associated with it, set the GUID of the object as `identifier`, set the `type` as `LOGIAL_TABLE` in the `metadata` array, and set `export_with_associated_feedbacks` in `export_options` to true. For more information, see [TML Documentation](https://developers.thoughtspot.com/docs/tml#_export_a_tml). For more information on feedbacks, see [Feedback Documentation](https://docs.thoughtspot.com/cloud/latest/sage-feedback). * @param param the request object */ public exportMetadataTML(param: ThoughtSpotRestApiExportMetadataTMLRequest, options?: Configuration): Promise> { return this.api.exportMetadataTML(param.exportMetadataTMLRequest, options).toPromise(); } /** * Version: 10.1.0.cl or later Exports the [TML](https://docs.thoughtspot.com/cloud/latest/tml) representation of metadata objects in JSON or YAML format. ### **Permissions Required** Requires `DATAMANAGEMENT` (**Can manage data**) and `USERMANAGEMENT` (**Can manage users**) privileges. #### **Usage Guidelines** This API is only applicable for `USER`, `GROUP`, and `ROLES` metadata types. - `batch_offset` Indicates the starting position within the complete dataset from which the API should begin returning objects. Useful for paginating results efficiently. - `batch_size` Specifies the number of objects or items to retrieve in a single request. Helps control response size for better performance. - `edoc_format` Defines the format of the TML content. The exported metadata can be in JSON or YAML format. - `export_dependent` Specifies whether to include dependent metadata objects in the export. Ensures related objects are also retrieved if needed. - `all_orgs_override` Indicates whether the export operation applies across all organizations. Useful for multi-tenant environments where cross-org exports are required. * @param param the request object */ public exportMetadataTMLBatched(param: ThoughtSpotRestApiExportMetadataTMLBatchedRequest, options?: Configuration): Promise { return this.api.exportMetadataTMLBatched(param.exportMetadataTMLBatchedRequest, options).toPromise(); } /** * Version: 9.0.0.cl or later Fetches data from a saved Answer. Requires at least view access to the saved Answer. The `record_size` attribute determines the number of records to retrieve in an API call. For more information about pagination, record size, and maximum row limit, see [Pagination and record size settings](https://developers.thoughtspot.com/docs/fetch-data-and-report-apis#_pagination_settings_for_data_and_report_apis). * @param param the request object */ public fetchAnswerData(param: ThoughtSpotRestApiFetchAnswerDataRequest, options?: Configuration): Promise { return this.api.fetchAnswerData(param.fetchAnswerDataRequest, options).toPromise(); } /** * Version: 9.0.0.cl or later Fetches the underlying SQL query data for an Answer object. Requires at least view access to the Answer object. Upon successful execution, the API returns the SQL queries for the specified object as shown in this example: ``` { \"metadata_id\":\"8fbe44a8-46ad-4b16-8d39-184b2fada490\", \"metadata_name\":\"Total sales\", \"metadata_type\":\"ANSWER\", \"sql_queries\":[ { \"metadata_id\":\"8fbe44a8-46ad-4b16-8d39-184b2fada490\", \"metadata_name\":\"Total sales -test\", \"sql_query\":\"SELECT \\n \\\"ta_1\\\".\\\"REGION\\\" \\\"ca_1\\\", \\n \\\"ta_2\\\".\\\"PRODUCTNAME\\\" \\\"ca_2\\\", \\n \\\"ta_1\\\".\\\"STORENAME\\\" \\\"ca_3\\\", \\n CASE\\n WHEN sum(\\\"ta_3\\\".\\\"SALES\\\") IS NOT NULL THEN sum(\\\"ta_3\\\".\\\"SALES\\\")\\n ELSE 0\\n END \\\"ca_4\\\", \\n CASE\\n WHEN sum(\\\"ta_3\\\".\\\"QUANTITYPURCHASED\\\") IS NOT NULL THEN sum(\\\"ta_3\\\".\\\"QUANTITYPURCHASED\\\")\\n ELSE 0\\n END \\\"ca_5\\\"\\nFROM \\\"RETAILAPPAREL\\\".\\\"PUBLIC\\\".\\\"FACT_RETAPP_SALES\\\" \\\"ta_3\\\"\\n JOIN \\\"RETAILAPPAREL\\\".\\\"PUBLIC\\\".\\\"DIM_RETAPP_STORES\\\" \\\"ta_1\\\"\\n ON \\\"ta_3\\\".\\\"STOREID\\\" = \\\"ta_1\\\".\\\"STOREID\\\"\\n JOIN \\\"RETAILAPPAREL\\\".\\\"PUBLIC\\\".\\\"DIM_RETAPP_PRODUCTS\\\" \\\"ta_2\\\"\\n ON \\\"ta_3\\\".\\\"PRODUCTID\\\" = \\\"ta_2\\\".\\\"PRODUCTID\\\"\\nGROUP BY \\n \\\"ca_1\\\", \\n \\\"ca_2\\\", \\n \\\"ca_3\\\"\\n\" } ] } ``` * @param param the request object */ public fetchAnswerSqlQuery(param: ThoughtSpotRestApiFetchAnswerSqlQueryRequest, options?: Configuration): Promise { return this.api.fetchAnswerSqlQuery(param.fetchAnswerSqlQueryRequest, options).toPromise(); } /** * Version: 10.4.0.cl or later Gets information about the status of the TML async import task scheduled using the `/api/rest/2.0/metadata/tml/async/import` API call. To fetch the task details, specify the ID of the TML async import task. Requires access to the task ID. The API allows users who initiated the asynchronous TML import via `/api/rest/2.0/metadata/tml/async/import` to view the status of their tasks. Users with administration privilege can view the status of all import tasks initiated by the users in their Org. #### Usage guidelines See [TML API Documentation](https://developers.thoughtspot.com/docs/tml#_fetch_status_of_the_tml_import_task) for usage guidelines. * @param param the request object */ public fetchAsyncImportTaskStatus(param: ThoughtSpotRestApiFetchAsyncImportTaskStatusRequest, options?: Configuration): Promise { return this.api.fetchAsyncImportTaskStatus(param.fetchAsyncImportTaskStatusRequest, options).toPromise(); } /** * Version: 10.12.0.cl or later Fetches column security rules for specified tables. This API endpoint retrieves column-level security rules configured for tables. It returns information about which columns are secured and which groups have access to those columns. #### Usage guidelines - Provide an array of table identifiers using either `identifier` (GUID or name) or `obj_identifier` (object ID) - At least one of `identifier` or `obj_identifier` must be provided for each table - The API returns column security rules for all specified tables - Users must have appropriate permissions to access security rules for the specified tables #### Required permissions - `ADMINISTRATION` - Can administer ThoughtSpot - `DATAMANAGEMENT` - Can manage data - `CAN_MANAGE_WORKSHEET_VIEWS_TABLES` - Can manage worksheet views and tables #### Example request ```json { \"tables\": [ { \"identifier\": \"table-guid\", \"obj_identifier\": \"table-object-id\" } ] } ``` #### Response format The API returns an array of `ColumnSecurityRuleResponse` objects wrapped in a `data` field. Each `ColumnSecurityRuleResponse` object contains: - Table information (GUID and object ID) - Array of column security rules with column details, group access, and source table information #### Example response ```json { \"data\": [ { \"guid\": \"table-guid\", \"objId\": \"table-object-id\", \"columnSecurityRules\": [ { \"column\": { \"id\": \"col_123\", \"name\": \"Salary\" }, \"groups\": [ { \"id\": \"group_1\", \"name\": \"HR Department\" } ], \"sourceTableDetails\": { \"id\": \"source-table-guid\", \"name\": \"Employee_Data\" } } ] } ] } ``` * @param param the request object */ public fetchColumnSecurityRules(param: ThoughtSpotRestApiFetchColumnSecurityRulesRequest, options?: Configuration): Promise> { return this.api.fetchColumnSecurityRules(param.fetchColumnSecurityRulesRequest, options).toPromise(); } /** * Version: 9.9.0.cl or later Validates the difference in connection metadata between CDW and ThoughtSpot. Requires `DATAMANAGEMENT` (**Can manage data**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the following Data control privileges may be required: - `CAN_MANAGE_CUSTOM_CALENDAR`(**Can manage custom calendars**) - `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**) - `CAN_MANAGE_WORKSHEET_VIEWS_TABLES` (**Can manage data models**) Returns a boolean indicating whether there is any difference between the connection metadata at ThoughtSpot and CDW. To get the connection metadata difference status, pass the connection GUID as `connection_identifier` in the API request. * @param param the request object */ public fetchConnectionDiffStatus(param: ThoughtSpotRestApiFetchConnectionDiffStatusRequest, options?: Configuration): Promise { return this.api.fetchConnectionDiffStatus(param.connectionIdentifier, options).toPromise(); } /** * Version: 9.0.0.cl or later Gets data from a Liveboard object and its visualization. Requires at least view access to the Liveboard. #### Usage guidelines In the request body, specify the GUID or name of the Liveboard. To get data for specific visualizations, add the GUIDs or names of the visualizations in the API request. To include unsaved changes in the report, pass the `transient_pinboard_content` script generated from the `getExportRequestForCurrentPinboard` method in the Visual Embed SDK. Upon successful execution, the API returns the report with unsaved changes. If the new Liveboard experience mode, the transient content includes ad hoc changes to visualizations such as sorting, toggling of legends, and data drill down. For more information, and see [Liveboard data API](https://developers.thoughtspot.com/docs/fetch-data-and-report-apis#_fetch_liveboard_data_api). * @param param the request object */ public fetchLiveboardData(param: ThoughtSpotRestApiFetchLiveboardDataRequest, options?: Configuration): Promise { return this.api.fetchLiveboardData(param.fetchLiveboardDataRequest, options).toPromise(); } /** * Version: 9.0.0.cl or later Fetches the underlying SQL query data for a Liveboard object and its visualizations. Requires at least view access to the Liveboard object. To get SQL query data for a Liveboard, specify the GUID of the Liveboard. Optionally, you can add an array of visualization GUIDs to retrieve the SQL query data for visualizations in the Liveboard. Upon successful execution, the API returns the SQL queries for the specified object as shown in this example: ``` { \"metadata_id\": \"fa68ae91-7588-4136-bacd-d71fb12dda69\", \"metadata_name\": \"Total Sales\", \"metadata_type\": \"LIVEBOARD\", \"sql_queries\": [ { \"metadata_id\": \"b3b6d2b9-089a-490c-8e16-b144650b7843\", \"metadata_name\": \"Total quantity purchased, Total sales by region\", \"sql_query\": \"SELECT \\n \\\"ta_1\\\".\\\"REGION\\\" \\\"ca_1\\\", \\n CASE\\n WHEN sum(\\\"ta_2\\\".\\\"QUANTITYPURCHASED\\\") IS NOT NULL THEN sum(\\\"ta_2\\\".\\\"QUANTITYPURCHASED\\\")\\n ELSE 0\\n END \\\"ca_2\\\", \\n CASE\\n WHEN sum(\\\"ta_2\\\".\\\"SALES\\\") IS NOT NULL THEN sum(\\\"ta_2\\\".\\\"SALES\\\")\\n ELSE 0\\n END \\\"ca_3\\\"\\nFROM \\\"RETAILAPPAREL\\\".\\\"PUBLIC\\\".\\\"FACT_RETAPP_SALES\\\" \\\"ta_2\\\"\\n JOIN \\\"RETAILAPPAREL\\\".\\\"PUBLIC\\\".\\\"DIM_RETAPP_STORES\\\" \\\"ta_1\\\"\\n ON \\\"ta_2\\\".\\\"STOREID\\\" = \\\"ta_1\\\".\\\"STOREID\\\"\\nGROUP BY \\\"ca_1\\\"\" } ] } ``` * @param param the request object */ public fetchLiveboardSqlQuery(param: ThoughtSpotRestApiFetchLiveboardSqlQueryRequest, options?: Configuration): Promise { return this.api.fetchLiveboardSqlQuery(param.fetchLiveboardSqlQueryRequest, options).toPromise(); } /** * Version: 9.0.0.cl or later Fetches security audit logs. Requires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the [Admin Control](https://developers.thoughtspot.com/docs/rbac#_admin_control) privileges are required. #### Usage guidelines By default, the API retrieves logs for the last 24 hours. You can set a custom duration in EPOCH time. Make sure the log duration specified in your API request doesn’t exceed 24 hours. If you must fetch logs for a longer time range, modify the duration and make multiple sequential API requests. Upon successful execution, the API returns logs with the following information: * timestamp of the event * event ID * event type * name and GUID of the user * IP address of ThoughtSpot instance For more information see [Audit logs Documentation](https://developers.thoughtspot.com/docs/audit-logs). * @param param the request object */ public fetchLogs(param: ThoughtSpotRestApiFetchLogsRequest, options?: Configuration): Promise> { return this.api.fetchLogs(param.fetchLogsRequest, options).toPromise(); } /** * Version: 26.3.0.cl or later This API fetches the object privileges present for the given list of principals (user or group), on the given set of objects. It supports pagination, which can be enabled and configured using the request parameters. It provides users access to certain features based on privilege based access control. #### Usage guidelines - Specify the `type` (`USER` or `USER_GROUP`) and `identifier` (either GUID or name) of the principals for which you want to retrieve object privilege information in the `principals` array. - Specify the `type` (`LOGICAL_TABLE`) and `identifier` (either GUID or name) of the metadata objects for which you want to retrieve object privilege information in the `metadata` array. Only `LOGICAL_TABLE` metadata type is supported for now. It may be extended for other metadata types in future. - To control the offset from where principals have to be fetched, use `record_offset`. When `record_offset` is 0, information is fetched from the beginning. - To control the number of principals to be fetched, use `record_size`. Default `record_size` is 20. - Ensure `record_offset` for a subsequent request is one more than the value of `record_size` of the previous request. - Ensure using correct Authorization Bearer Token corresponding to specific user & org. #### Example request ```json { \"principals\": [ { \"type\": \"type-1\", \"identifier\": \"principal-guid-or-name-1\" }, { \"type\": \"type-2\", \"identifier\": \"principal-guid-or-name-2\" } ], \"metadata\": [ { \"type\": \"metadata-type-1\", \"identifier\": \"metadata-guid-or-name-1\" }, { \"type\": \"metadata-type-2\", \"identifier\": \"metadata-guid-or-name-2\" } ], \"record_offset\": 0, \"record_size\": 20 } ``` #### Response format The API returns an array of `metadata_object_privileges` objects wrapped in JSON. Each `metadata_object_privileges` object contains: - Metadata information (GUID, name and type) - Array of `principal_object_privilege_info`. - Each `principal_object_privilege_info` contains: - Principal type. All principals of this type are listed as described below. - Array of `principal_object_privileges`. - Each `principal_object_privileges` contains: - Principal information (GUID, name, subtype) - List of applied object level privileges. #### Example response ```json { \"metadata_object_privileges\": [ { \"metadata_id\": \"metadata-guid-1\", \"metadata_name\": \"metadata-name-1\", \"metadata_type\": \"metadata-type-1\", \"principal_object_privilege_info\": [ { \"principal_type\": \"principal-type-1\", \"principal_object_privileges\": [ { \"principal_id\": \"principal-guid-1\", \"principal_name\": \"principal-name-1\", \"principal_sub_type\": \"principal-sub-type-1\", \"object_privileges\": \"[object-privilege-1, object-privilege-2]\" }, { \"principal_id\": \"principal-guid-2\", \"principal_name\": \"principal-name-2\", \"principal_sub_type\": \"principal-sub-type-2\", \"object_privileges\": \"[object-privilege-1, object-privilege-2]\" } ] }, { \"principal_type\": \"principal-type-2\", \"principal_object_privileges\": [ { \"principal_id\": \"principal-guid-3\", \"principal_name\": \"principal-guid-4\", \"principal_sub_type\": \"principal-sub-type-4\", \"object_privileges\": \"[object-privilege-1]\" } ] } ] }, { \"metadata_id\": \"metadata-guid-2\", \"metadata_name\": \"metadata-name-2\", \"metadata_type\": \"metadata-type-2\", \"principal_object_privilege_info\": [ { \"principal_type\": \"principal-type-1\", \"principal_object_privileges\": [ { \"principal_id\": \"principal-guid-1\", \"principal_name\": \"principal-name-1\", \"principal_sub_type\": \"principal-sub-type-1\", \"object_privileges\": \"[object-privilege-3, object-privilege-4]\" }, { \"principal_id\": \"principal-guid-2\", \"principal_name\": \"principal-name-2\", \"principal_sub_type\": \"principal-sub-type-2\", \"object_privileges\": \"[object-privilege-4]\" } ] } ] } ] } ``` * @param param the request object */ public fetchObjectPrivileges(param: ThoughtSpotRestApiFetchObjectPrivilegesRequest, options?: Configuration): Promise { return this.api.fetchObjectPrivileges(param.fetchObjectPrivilegesRequest, options).toPromise(); } /** * Version: 9.0.0.cl or later Fetches object permission details for a given principal object such as a user and group. Requires view access to the metadata object. #### Usage guidelines * To get a list of all metadata objects that a user or group can access, specify the `type` and GUID or name of the principal. * To get permission details for a specific object, add the `type` and GUID or name of the metadata object to your API request. Upon successful execution, the API returns a list of metadata objects and permission details for each object. * @param param the request object */ public fetchPermissionsOfPrincipals(param: ThoughtSpotRestApiFetchPermissionsOfPrincipalsRequest, options?: Configuration): Promise { return this.api.fetchPermissionsOfPrincipals(param.fetchPermissionsOfPrincipalsRequest, options).toPromise(); } /** * Version: 9.0.0.cl or later Fetches permission details for a given metadata object. Requires view access to the metadata object. #### Usage guidelines * To fetch a list of users and groups for a metadata object, specify `type` and GUID or name of the metadata object. * To get permission details for a specific user or group, add `type` and GUID or name of the principal object to your API request. Upon successful execution, the API returns permission details and principal information for the object specified in the API request. * @param param the request object */ public fetchPermissionsOnMetadata(param: ThoughtSpotRestApiFetchPermissionsOnMetadataRequest, options?: Configuration): Promise { return this.api.fetchPermissionsOnMetadata(param.fetchPermissionsOnMetadataRequest, options).toPromise(); } /** * Version: 9.0.0.cl or later Enforces logout on current user sessions. Use this API with caution as it may invalidate active user sessions and force users to re-login. Make sure you specify the usernames or GUIDs. If you pass null values in the API call, all user sessions on your cluster become invalid, and the users are forced to re-login. Requires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `USER_ADMINISTRATION` (**Can manage users**) privilege is required. * @param param the request object */ public forceLogoutUsers(param: ThoughtSpotRestApiForceLogoutUsersRequest, options?: Configuration): Promise { return this.api.forceLogoutUsers(param.forceLogoutUsersRequest, options).toPromise(); } /** * Version: 10.12.0.cl or later Exports a [custom calendar](https://docs.thoughtspot.com/cloud/latest/connections-cust-cal) in the CSV format. Requires `DATAMANAGEMENT` (**Can manage data**) or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your ThoughtSpot instance, the `CAN_MANAGE_CUSTOM_CALENDAR` (**Can manage custom calendars**) privilege is required. #### Usage guidelines Use this API to download a custom calendar in the CSV file format. In your API request, specify the following parameters. * Start and end date of the calendar. For \"month offset\" calendars, the start date must match the month defined in the `month_offset` attribute. You can also specify optional parameters such as the starting day of the week and prefixes for the quarter and year labels. * @param param the request object */ public generateCSV(param: ThoughtSpotRestApiGenerateCSVRequest, options?: Configuration): Promise { return this.api.generateCSV(param.generateCSVRequest, options).toPromise(); } /** * Version: 9.0.0.cl or later Retrieves details of the current user session for the token provided in the request header. Any ThoughtSpot user can access this endpoint and send an API request. The data returned in the API response varies according to user\'s privilege and object access permissions. **NOTE**: In ThoughtSpot, users with cluster administration privileges can access all Orgs by default. However, unless the administrator is explicitly added to an Org, the Orgs list in the session information returned by the API will include only the Primary Org. To include other Orgs in the API response, you must explicitly add the administrator to each Org in the Admin settings page in the UI or via user REST API. * @param param the request object */ public getCurrentUserInfo(param: ThoughtSpotRestApiGetCurrentUserInfoRequest = {}, options?: Configuration): Promise { return this.api.getCurrentUserInfo( options).toPromise(); } /** * Version: 9.4.0.cl or later Retrieves details of the current session token for the bearer token provided in the request header. This API endpoint does not create a new token. Instead, it returns details about the token, including the token string, creation time, expiration time, and the associated user. Use this endpoint to introspect your current session token, debug authentication issues, or when a frontend application needs session token details. Any ThoughtSpot user with a valid bearer token can access this endpoint and send an API request * @param param the request object */ public getCurrentUserToken(param: ThoughtSpotRestApiGetCurrentUserTokenRequest = {}, options?: Configuration): Promise { return this.api.getCurrentUserToken( options).toPromise(); } /** * Version: 10.4.0.cl or later Creates an authentication token that provides values for the formula variables in the Row Level Security (RLS) rules for a given user. Recommended for use cases that require Attribute-based access control (ABAC) via RLS. #### Required privileges To add a new user and assign privileges during auto-creation, the `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege is required. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled, the `CONTROL_TRUSTED_AUTH` (**Can Enable or Disable Trusted Authentication**) privilege and edit access to the data source are required. To configure formula variables for all Orgs on your instance or the Primary Org, cluster administration privileges are required. Org administrators can configure formula variables for their respective Orgs. If Role-Based Access Control (RBAC) is enabled, users with the `CAN_MANAGE_VARIABLES` (**Can manage variables**) role privilege can also create and manage variables for their Org context. #### Usage guidelines You can generate a token by providing a `username` and `password`, or by using a `secret_key`. To generate a `secret_key`, the administrator must enable [Trusted authentication](https://developers.thoughtspot.com/docs/trusted-auth-secret-key) in the **Develop** > **Customizations** > **Security Settings** page. **Note**: * When both `password` and `secret_key` are included in the API request, `password` takes precedence. * If [Multi-Factor Authentication (MFA)](https://docs.thoughtspot.com/cloud/latest/authentication-local-mfa) is enabled on your instance, the API login request with `username` and `password` returns an error. You can switch to token-based authentication with `secret_key` or contact ThoughtSpot Support for assistance. The token obtained from ThoughtSpot is valid for 5 minutes by default. You can configure the token expiration time as required. #### ABAC via RLS To implement ABAC via RLS and assign security entitlements to users during session creation, generate a token with custom variable values. The values set in the authentication token are applied to the formula variables referenced in RLS rules at the table level, which determines the data each user can access based on their entitlements. The variable values can be configured to persist for a specific set of Models in user sessions initiated with the token, allowing different RLS rules to be set for different data models. Once defined, the rules are added to the user\'s `variable_values` object, after which all sessions will use the persisted values. For more information, see [ABAC via tokens Documentation](https://developers.thoughtspot.com/docs/abac-via-rls-variables). ##### Formula variables Before defining variable values, ensure the variables are created and available on your instance. To create a formula variable, you can use the **Create variable** (`/api/rest/2.0/template/variables/create`) REST API endpoint, with the variable `type` set as `Formula_Variable` in the API request. The API doesn\'t support `\"persist_option\": \"RESET\"` and `\"persist_option\": \"NONE\"` when `variable_values` are defined in the request. If you are using `variable_values` for token generation, you must use other supported persist options such as `APPEND` or `REPLACE`. If you want to use `RESET` or `NONE`, do not pass any `variable_values`. In such cases, `variable_values` will remain unaffected. #### Supported objects The supported object type is `LOGICAL_TABLE`. When using `object_id` with `variable_values`, models are supported. #### Just-in-time provisioning For [just-in-time user creation and provisioning](https://developers.thoughtspot.com/docs/just-in-time-provisioning), specify the following attributes in the API request: * `auto_create` * `username` * `display_name` * `email` * `groups` Set `auto_create` to `true` if the username does not exist in ThoughtSpot. If the username already exists in ThoughtSpot and `auto_create` is set to `true`, user properties such as display name, email, Org and group entitlements will not be updated with new values. Setting `auto_create` to `true` does not create formula variables. Hence, this setting will not be applicable to `variable_values`. #### Important point to note All options in the token creation APIs that define user access to data in ThoughtSpot will take effect during token creation, not when the token is used for authentication. For example, `auto_create:true` will create the user when the authentication token is created. Persist options such as `APPEND` and `REPLACE` will persist `variable_values` on the user profile when the token is created. * @param param the request object */ public getCustomAccessToken(param: ThoughtSpotRestApiGetCustomAccessTokenRequest, options?: Configuration): Promise { return this.api.getCustomAccessToken(param.getCustomAccessTokenRequest, options).toPromise(); } /** * Version: 10.15.0.cl or later Suggests the most relevant data sources for a given natural language query, ranked by confidence with LLM-generated reasoning. Requires `CAN_USE_SPOTTER` privilege and at least view-level access to the underlying metadata entities referenced in the response. #### Usage guidelines The request must include: - `query`: the natural language question to find relevant data sources for If the request is successful, the API returns a ranked list of suggested data sources, each containing: - `confidence`: a float score indicating the model\'s confidence in the relevance of the suggestion - `details`: metadata about the data source - `data_source_identifier`: the unique ID of the data source - `data_source_name`: the display name of the data source - `description`: a description of the data source - `reasoning`: LLM-generated rationale explaining why the data source was recommended #### Error responses | Code | Description | |------|--------------------------------------------------------------------------------------------------------------------------------------------| | 401 | Unauthorized — authentication token is missing, expired, or invalid. | | 403 | Forbidden — the authenticated user does not have `CAN_USE_SPOTTER` privilege or lacks view permission on the underlying metadata entities. | > ###### Note: > * This endpoint is currently in Beta. Breaking changes may be introduced before it is made Generally Available. > * This endpoint requires Spotter — please contact ThoughtSpot Support to enable Spotter on your cluster. * @param param the request object */ public getDataSourceSuggestions(param: ThoughtSpotRestApiGetDataSourceSuggestionsRequest, options?: Configuration): Promise { return this.api.getDataSourceSuggestions(param.getDataSourceSuggestionsRequest, options).toPromise(); } /** * Version: 9.0.0.cl or later Generates an authentication token for creating a full session in ThoughtSpot for a given user. Recommended for use cases that do not require Attribute-based access control (ABAC) via Row Level Security (RLS). #### Usage guidelines You can generate a token for a user by providing a `username` and `password`, or by using the `secret_key` generated for your instance. To generate a `secret_key`, the administrator must enable [Trusted authentication](https://developers.thoughtspot.com/docs/trusted-auth-secret-key) in the **Develop** > **Customizations** > **Security Settings** page. **Note**: * When both `password` and `secret_key` are included in the API request, `password` takes precedence. * If [Multi-Factor Authentication (MFA)](https://docs.thoughtspot.com/cloud/latest/authentication-local-mfa) is enabled on your instance, the API login request with `username` and `password` returns an error. You can switch to token-based authentication with `secret_key` or contact ThoughtSpot Support for assistance. The token obtained from ThoughtSpot is valid for 5 minutes by default. You can configure the token expiration time as required. #### Just-in-time provisioning For [just-in-time user creation and provisioning](https://developers.thoughtspot.com/docs/just-in-time-provisioning), specify the following attributes in the API request: * `auto_create` * `username` * `display_name` * `email` * `group_identifiers` Set `auto_create` to `true` if the username does not exist in ThoughtSpot. If the user already exists in ThoughtSpot and `auto_create` is set to `true`, user properties such as display name, email and group assignment will be updated. To add a new user and assign privileges during auto-creation, the `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege is required. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled, the `CONTROL_TRUSTED_AUTH` (**Can Enable or Disable Trusted Authentication**) privilege is required. #### Important point to note All options in the token creation APIs that define user access to data in ThoughtSpot will take effect during token creation, not when the token is used for authentication. For example, `auto_create:true` will create the user when the authentication token is created. * @param param the request object */ public getFullAccessToken(param: ThoughtSpotRestApiGetFullAccessTokenRequest, options?: Configuration): Promise { return this.api.getFullAccessToken(param.getFullAccessTokenRequest, options).toPromise(); } /** * Version: 10.15.0.cl or later Retrieves existing natural language (NL) instructions configured for a specific data model. These instructions guide the AI system in understanding data context and generating more accurate responses. Requires `CAN_USE_SPOTTER` privilege, at least view access on the data model, and a bearer token corresponding to the org where the data model exists. #### Usage guidelines The request must include: - `data_source_identifier`: the unique ID of the data model to retrieve instructions for If the request is successful, the API returns: - `nl_instructions_info`: an array of instruction objects, each containing: - `instructions`: the configured text instructions for AI processing - `scope`: the scope of the instruction — currently only `GLOBAL` is supported #### Instructions scope - **GLOBAL**: Instructions that apply globally across the system on the given data-model (currently only global instructions are supported) #### Error responses | Code | Description | |------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | 401 | Unauthorized — authentication token is missing, expired, or invalid. | | 403 | Forbidden — the authenticated user does not have `CAN_USE_SPOTTER` privilege, lacks view access on the data model, or the bearer token does not correspond to the org where the data model exists. | > ###### Note: > > - To use this API, the user needs at least view access on the data model, and must use the bearer token corresponding to the org where the data model exists. > - This endpoint is currently in Beta. Breaking changes may be introduced before the endpoint is made Generally Available. > - Available from version 10.15.0.cl and later. > - This endpoint requires Spotter — please contact ThoughtSpot Support to enable Spotter on your cluster. > - Use this API to review currently configured instructions before modifying them with `setNLInstructions`. * @param param the request object */ public getNLInstructions(param: ThoughtSpotRestApiGetNLInstructionsRequest, options?: Configuration): Promise { return this.api.getNLInstructions(param.getNLInstructionsRequest, options).toPromise(); } /** * Version: 9.0.0.cl or later Generates an authentication token that provides access to a specific metadata object. This object list is intersected with the list of objects the user is allowed to access via group membership. For more information, see [Object security](https://docs.thoughtspot.com/cloud/latest/security-data-object#object_security). #### Usage guidelines You can generate a token for a user by providing a `username` and `password`, or by using the `secret_key` generated for your instance. To generate a `secret_key`, the administrator must enable [Trusted authentication](https://developers.thoughtspot.com/docs/trusted-auth-secret-key) in the **Develop** > **Customizations** > **Security Settings** page. **Note**: * When both `password` and `secret_key` are included in the API request, `password` takes precedence. * If [Multi-Factor Authentication (MFA)](https://docs.thoughtspot.com/cloud/latest/authentication-local-mfa) is enabled on your instance, the API login request with `username` and `password` returns an error. You can switch to token-based authentication with `secret_key` or contact ThoughtSpot Support for assistance. The token obtained from ThoughtSpot is valid for 5 minutes by default. You can configure the token expiration time as required. #### Just-in-time provisioning For [just-in-time user creation and provisioning](https://developers.thoughtspot.com/docs/just-in-time-provisioning), specify the following attributes in the API request: * `auto_create` * `username` * `display_name` * `email` * `group_identifiers` Set `auto_create` to `true` if the user is not available in ThoughtSpot. If the user already exists in ThoughtSpot and the `auto_create` parameter is set to `true`, user properties such as display name, email, and group assignment will be updated. To add a new user and assign privileges, the `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege is required. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled, the `CONTROL_TRUSTED_AUTH`(**Can Enable or Disable Trusted Authentication**) privilege is required. #### Important point to note All options in the token creation APIs that define user access to data in ThoughtSpot will take effect during token creation, not when the token is used for authentication. For example, `auto_create:true` will create the user when the authentication token is created. * @param param the request object */ public getObjectAccessToken(param: ThoughtSpotRestApiGetObjectAccessTokenRequest, options?: Configuration): Promise { return this.api.getObjectAccessToken(param.getObjectAccessTokenRequest, options).toPromise(); } /** * Version: 10.13.0.cl or later Breaks down a natural language query into a series of smaller analytical sub-questions, each mapped to a relevant data source. Requires `CAN_USE_SPOTTER` privilege and at least view-level access to the referenced metadata objects. #### Usage guidelines The request must include: - `query`: the natural language question to decompose into analytical sub-questions - `metadata_context`: at least one of the following context identifiers to guide question generation: - `conversation_identifier` — an existing conversation session ID - `answer_identifiers` — a list of Answer GUIDs - `liveboard_identifiers` — a list of Liveboard GUIDs - `data_source_identifiers` — a list of data source GUIDs Optional parameters for refining the output: - `ai_context`: additional context to improve response quality - `content` — supplementary text or CSV data as string input - `instructions` — custom text instructions for the AI system - `limit_relevant_questions`: maximum number of questions to return (default: `5`) - `bypass_cache`: if `true`, forces fresh computation instead of returning cached results If the request is successful, the API returns a list of relevant analytical questions, each containing: - `query`: the generated sub-question - `data_source_identifier`: the unique ID of the data source the question targets - `data_source_name`: the display name of the corresponding data source #### Error responses | Code | Description | |------|---------------------------------------------------------------------------------------------------------------------------------------| | 401 | Unauthorized — authentication token is missing, expired, or invalid. | | 403 | Forbidden — the authenticated user does not have `CAN_USE_SPOTTER` privilege or lacks view access to the referenced metadata objects. | > ###### Note: > * This endpoint is currently in Beta. Breaking changes may be introduced before the endpoint is made Generally Available. > * This endpoint requires Spotter - please contact ThoughtSpot support to enable Spotter on your cluster. * @param param the request object */ public getRelevantQuestions(param: ThoughtSpotRestApiGetRelevantQuestionsRequest, options?: Configuration): Promise { return this.api.getRelevantQuestions(param.getRelevantQuestionsRequest, options).toPromise(); } /** * Version: 9.0.0.cl or later Retrieves the current configuration details of the cluster. If the request is successful, the API returns a list configuration settings applied on the cluster. Requires `ADMINISTRATION`(**Can administer ThoughtSpot**) privilege to view these complete configuration settings of the cluster. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `SYSTEM_INFO_ADMINISTRATION` (**Can view system activities**) privilege is required. This API does not require any parameters to be passed in the request. * @param param the request object */ public getSystemConfig(param: ThoughtSpotRestApiGetSystemConfigRequest = {}, options?: Configuration): Promise { return this.api.getSystemConfig( options).toPromise(); } /** * Version: 9.0.0.cl or later Gets system information such as the release version, locale, time zone, deployment environment, date format, and date time format of the cluster. Requires `ADMINISTRATION` (**Can administer ThoughtSpot**) privileges. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `SYSTEM_INFO_ADMINISTRATION` (**Can view system activities**) privilege is required. This API does not require any parameters to be passed in the request. * @param param the request object */ public getSystemInformation(param: ThoughtSpotRestApiGetSystemInformationRequest = {}, options?: Configuration): Promise { return this.api.getSystemInformation( options).toPromise(); } /** * Version: 9.2.0.cl or later Gets a list of configuration overrides applied on the cluster. Requires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `APPLICATION_ADMINISTRATION` (**Can manage application settings**) privilege is required. This API does not require any parameters to be passed in the request. * @param param the request object */ public getSystemOverrideInfo(param: ThoughtSpotRestApiGetSystemOverrideInfoRequest = {}, options?: Configuration): Promise { return this.api.getSystemOverrideInfo( options).toPromise(); } /** * Version: 9.0.0.cl or later Imports [TML](https://docs.thoughtspot.com/cloud/latest/tml) files into ThoughtSpot. Requires `DATAMANAGEMENT` (**Can manage data**) or `ADMINISTRATION` (**Can administer ThoughtsSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the following Data control privileges may be required: - `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**) - `CAN_MANAGE_WORKSHEET_VIEWS_TABLES` (**Can manage data models**) #### Usage guidelines * Import all related objects in a single TML Import API call. For example, Tables that use the same Connection object and Worksheets connected to these Tables. * Include the `fqn` property to distinguish objects that have the same name. For example, if you have multiple Connections or Worksheets with the same name on ThoughtSpot and the Connection or Worksheet referenced in your TML file does not have a unique name to distinguish, it may result in invalid object references. Adding `fqn` helps ThoughtSpot differentiate a Table from another with the same name. We recommend [exporting TML with FQNs](#/http/api-endpoints/metadata/export-metadata-tml) and using these during the import operation. * You can upload multiple TML files at a time. If you import a Worksheet along with Liveboards, Answers, and other dependent objects in a single API call, the imported objects will be immediately available for use. When you import only a Worksheet object, it may take some time for the Worksheet to become available in the ThoughtSpot system. Please wait for a few minutes, and then proceed to create an Answer and Liveboard from the newly imported Worksheet. For more information, see [TML Documentation](https://developers.thoughtspot.com/docs/tml#_import_a_tml). * @param param the request object */ public importMetadataTML(param: ThoughtSpotRestApiImportMetadataTMLRequest, options?: Configuration): Promise> { return this.api.importMetadataTML(param.importMetadataTMLRequest, options).toPromise(); } /** * Version: 10.4.0.cl or later Schedules a task to import [TML](https://docs.thoughtspot.com/cloud/latest/tml) files into ThoughtSpot. You can use this API endpoint to process TML objects asynchronously when importing TMLs of large and complex metadata objects into ThoughtSpot. Unlike the synchronous import TML operation, the API processes TML data in the background and returns a task ID, which can be used to check the status of the import task via `/api/rest/2.0/metadata/tml/async/status` API endpoint. Requires `DATAMANAGEMENT` (**Can manage data**) or `ADMINISTRATION` (**Can administer ThoughtsSpot**) privilege, and edit access to the TML objects. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the following Data control privileges may be required: - `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**) - `CAN_MANAGE_WORKSHEET_VIEWS_TABLES` (**Can manage data models**) #### Usage guidelines See [Async TML API Documentation](https://developers.thoughtspot.com/docs/tml#_import_tml_objects_asynchronously) for usage guidelines. * @param param the request object */ public importMetadataTMLAsync(param: ThoughtSpotRestApiImportMetadataTMLAsyncRequest, options?: Configuration): Promise { return this.api.importMetadataTMLAsync(param.importMetadataTMLAsyncRequest, options).toPromise(); } /** * Version: 9.0.0.cl or later Imports group objects from external databases into ThoughtSpot. Requires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `GROUP_ADMINISTRATION` (**Can manage groups**) privilege is required. During the import operation: * If the specified group is not available in ThoughtSpot, it will be added to ThoughtSpot. * If `delete_unspecified_groups` is set to `true`, the groups not specified in the API request, excluding administrator and system user groups, are deleted. * If the specified groups are already available in ThoughtSpot, the object properties of these groups are modified and synchronized as per the input data in the API request. A successful API call returns the object that represents the changes made in the ThoughtSpot system. * @param param the request object */ public importUserGroups(param: ThoughtSpotRestApiImportUserGroupsRequest, options?: Configuration): Promise { return this.api.importUserGroups(param.importUserGroupsRequest, options).toPromise(); } /** * Version: 9.0.0.cl or later Imports user data from external databases into ThoughtSpot. During the user import operation: * If the specified users are not available in ThoughtSpot, the users are created and assigned a default password. Defining a `default_password` in the API request is optional. * If `delete_unspecified_users` is set to `true`, the users not specified in the API request, excluding the `tsadmin`, `guest`, `system` and `su` users, are deleted. * If the specified user objects are already available in ThoughtSpot, the object properties are updated and synchronized as per the input data in the API request. A successful API call returns the object that represents the changes made in the ThoughtSpot system. Requires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `USER_ADMINISTRATION` (**Can manage users**) privilege is required. * @param param the request object */ public importUsers(param: ThoughtSpotRestApiImportUsersRequest, options?: Configuration): Promise { return this.api.importUsers(param.importUsersRequest, options).toPromise(); } /** * Version: 9.0.0.cl or later Creates a login session for a ThoughtSpot user with Basic authentication. In Basic authentication method, REST clients log in to ThoughtSpot using `username` and `password` attributes. On a multi-tenant cluster with Orgs, users can pass the ID of the Org in the API request to log in to a specific Org context. **Note**: If Multi-Factor Authentication (MFA) is enabled on your instance, the API login request with basic authentication (`username` and `password` ) returns an error. Contact ThoughtSpot Support for assistance. A successful login returns a session cookie that can be used in your subsequent API requests. * @param param the request object */ public login(param: ThoughtSpotRestApiLoginRequest, options?: Configuration): Promise { return this.api.login(param.loginRequest, options).toPromise(); } /** * Version: 9.0.0.cl or later Logs out a user from their current session. * @param param the request object */ public logout(param: ThoughtSpotRestApiLogoutRequest = {}, options?: Configuration): Promise { return this.api.logout( options).toPromise(); } /** * Version: 26.3.0.cl or later This API allows the addition or deletion of object level privileges for a set of users and groups, on a set of metadata objects. It provides users to access certain features based on privilege based access control. #### Usage guidelines - Specify the `operation`. The supported operations are: `ADD`, `REMOVE`. - Specify the type of the objects on which the object privileges are being provided in `metadata_type`. Only `LOGICAL_TABLE` metadata type is supported for now. It may be extended for other metadata types in future. - Specify the list of object privilege types in the `object_privilege_types` array. The supported object privilege types are: `SPOTTER_COACHING_PRIVILEGE`. - Specify the identifiers (either GUID or name) for the metadata objects in the `metadata_identifiers` array. - Specify the `type` (`USER` or `USER_GROUP`) and `identifier` (either GUID or name) of the principals to which you want to apply the given operation and given object privileges in the `principals` array. - Ensure using correct Authorization Bearer Token corresponding to specific user & org. #### Example request ```json { \"operation\": \"operation-type\", \"metadata_type\": \"metadata-type\", \"object_privilege_types\": [\"privilege-type-1\", \"privilege-type-2\"], \"metadata_identifiers\": [\"metadata-guid-or-name-1\", \"metadata-guid-or-name-1\"], \"principals\": [ { \"type\": \"type-1\", \"identifier\": \"principal-guid-or-name-1\" }, { \"type\": \"type-2\", \"identifier\": \"principal-guid-or-name-2\" } ] } ``` > ###### Note: > * Only admin users, users with edit access and users with coaching privilege on a given data-model can add or remove principals related to SPOTTER_COACHING_PRIVILEGE * @param param the request object */ public manageObjectPrivilege(param: ThoughtSpotRestApiManageObjectPrivilegeRequest, options?: Configuration): Promise { return this.api.manageObjectPrivilege(param.manageObjectPrivilegeRequest, options).toPromise(); } /** * Parameterize fields in metadata objects. Version: 10.9.0.cl or later **Note:** This API endpoint is deprecated and will be removed from ThoughtSpot in a future release. Use [POST /api/rest/2.0/metadata/parameterize-fields](/api/rest/2.0/metadata/parameterize-fields) instead. Allows parameterizing fields in metadata objects in ThoughtSpot. Requires appropriate permissions to modify the metadata object. The API endpoint allows parameterizing the following types of metadata objects: * Logical Tables * Connections * Connection Configs For a Logical Table the field type must be `ATTRIBUTE` and field name can be one of: * databaseName * schemaName * tableName For a Connection or Connection Config, the field type is always `CONNECTION_PROPERTY`. In this case, field_name specifies the exact property of the Connection or Connection Config that needs to be parameterized. For Connection Config, the only supported field name is: * impersonate_user * @param param the request object */ public parameterizeMetadata(param: ThoughtSpotRestApiParameterizeMetadataRequest, options?: Configuration): Promise { return this.api.parameterizeMetadata(param.parameterizeMetadataRequest, options).toPromise(); } /** * Parameterize multiple fields of metadata objects. For example [schemaName, databaseName] for LOGICAL_TABLE. Version: 26.4.0.cl or later Allows parameterizing multiple fields of metadata objects in ThoughtSpot. For example, you can parameterize [schemaName, databaseName] for LOGICAL_TABLE. Requires appropriate permissions to modify the metadata object. The API endpoint allows parameterizing the following types of metadata objects: * Logical Tables * Connections * Connection Configs For a Logical Table, the field type must be `ATTRIBUTE` and field names can include: * databaseName * schemaName * tableName For a Connection or Connection Config, the field type is always `CONNECTION_PROPERTY`. In this case, field_names specifies the exact properties of the Connection or Connection Config that need to be parameterized. For Connection Config, supported field names include: * impersonate_user You can parameterize multiple fields at once by providing an array of field names. * @param param the request object */ public parameterizeMetadataFields(param: ThoughtSpotRestApiParameterizeMetadataFieldsRequest, options?: Configuration): Promise { return this.api.parameterizeMetadataFields(param.parameterizeMetadataFieldsRequest, options).toPromise(); } /** * Version: 10.9.0.cl or later Allows publishing metadata objects across organizations in ThoughtSpot. Requires ADMINISTRATION role and TENANT scope. The API endpoint allows publishing the following types of metadata objects: * Liveboards * Answers * Logical Tables This API will essentially share the objects along with it\'s dependencies to the org admins of the orgs to which it is being published. * @param param the request object */ public publishMetadata(param: ThoughtSpotRestApiPublishMetadataRequest, options?: Configuration): Promise { return this.api.publishMetadata(param.publishMetadataRequest, options).toPromise(); } /** * Update values for a variable Version: 26.4.0.cl or later Allows updating values for a specific variable in ThoughtSpot. Requires ADMINISTRATION role. The CAN_MANAGE_VARIABLES permission allows you to manage Formula Variables in the current organization scope. The API endpoint allows: * Adding new values to the variable * Replacing existing values * Deleting values from the variable * Resetting all values When updating variable values, you need to specify: * The variable identifier (ID or name) * The values to add/replace/remove * The operation to perform (ADD, REPLACE, REMOVE, RESET) Behaviour based on operation type: * ADD - Adds values to the variable if this is a list type variable, else same as replace. * REPLACE - Replaces all values of a given set of constraints with the current set of values. * REMOVE - Removes any values which match the set of conditions of the variables if this is a list type variable, else clears value. * RESET - Removes all constraints for the given variable, scope is ignored * @param param the request object */ public putVariableValues(param: ThoughtSpotRestApiPutVariableValuesRequest, options?: Configuration): Promise { return this.api.putVariableValues(param.identifier, param.putVariableValuesRequest, options).toPromise(); } /** * Version: 10.7.0.cl or later **Deprecated** — Use `getRelevantQuestions` instead (available from 10.13.0.cl). Breaks down a topical or goal-oriented natural language question into smaller, actionable analytical sub-questions, each mapped to a relevant data source for independent execution. Requires `CAN_USE_SPOTTER` privilege and at least view-level access to the referenced metadata objects. #### Usage guidelines The request accepts the following parameters: - `nlsRequest`: contains the user `query` to decompose, along with optional `instructions` and `bypassCache` flag - `worksheetIds`: list of data source identifiers to scope the decomposition - `answerIds`: list of Answer GUIDs whose data guides the response - `liveboardIds`: list of Liveboard GUIDs whose data guides the response - `conversationId`: an existing conversation session ID for context continuity - `content`: supplementary text or CSV data to improve response quality - `maxDecomposedQueries`: maximum number of sub-questions to return (default: `5`) If the request is successful, the API returns a `decomposedQueryResponse` containing a list of `decomposedQueries`, each with: - `query`: the generated analytical sub-question - `worksheetId`: the unique ID of the data source the question targets - `worksheetName`: the display name of the corresponding data source #### Error responses | Code | Description | |------|---------------------------------------------------------------------------------------------------------------------------------------| | 401 | Unauthorized — authentication token is missing, expired, or invalid. | | 403 | Forbidden — the authenticated user does not have `CAN_USE_SPOTTER` privilege or lacks view access to the referenced metadata objects. | > ###### Note: > * This endpoint is deprecated since 10.13.0.cl. Use `getRelevantQuestions` for new integrations. > * This endpoint is currently in Beta. Breaking changes may be introduced before the endpoint is made Generally Available. > * This endpoint requires Spotter — please contact ThoughtSpot support to enable Spotter on your cluster. * @param param the request object */ public queryGetDecomposedQuery(param: ThoughtSpotRestApiQueryGetDecomposedQueryRequest, options?: Configuration): Promise { return this.api.queryGetDecomposedQuery(param.queryGetDecomposedQueryRequest, options).toPromise(); } /** * Version: 9.0.0.cl or later Resets the password of a user account. Administrators can reset password on behalf of a user. Requires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `USER_ADMINISTRATION` (**Can manage users**) privilege is required. * @param param the request object */ public resetUserPassword(param: ThoughtSpotRestApiResetUserPasswordRequest, options?: Configuration): Promise { return this.api.resetUserPassword(param.resetUserPasswordRequest, options).toPromise(); } /** * Version: 9.2.0.cl or later Reverts TML objects to a previous commit specified in the API request. Requires at least edit access to objects. In the API request, specify the `commit_id`. If the branch name is not specified in the request, the API will consider the default branch configured on your instance. By default, the API reverts all objects. If the revert operation fails for one of the objects provided in the commit, the API returns an error and does not revert any object. For more information, see [Git integration documentation](https://developers.thoughtspot.com/docs/git-integration). * @param param the request object */ public revertCommit(param: ThoughtSpotRestApiRevertCommitRequest, options?: Configuration): Promise { return this.api.revertCommit(param.commitId, param.revertCommitRequest, options).toPromise(); } /** * Version: 26.2.0.cl or later Revokes OAuth refresh tokens for users who no longer require access to a data warehouse connection. When a token is revoked, the affected user\'s session for that connection is terminated, and they must re-authenticate to regain access. Requires `ADMINISTRATION` (**Can administer ThoughtSpot**) or `DATAMANAGEMENT` (**Can manage data**) privileges. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on the ThoughtSpot instance, users with `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**) privilege can also make API requests to revoke tokens for connection users. #### Usage guidelines You can specify different combinations of identifiers to control which refresh tokens are revoked. - **connection_identifier**: Revokes refresh tokens for all users of the connection, except the connection author. - **connection_identifier** and **user_identifiers**: Revokes refresh tokens only for the users specified in the request. If the name or ID of the connection author is included in the request, their token will also be revoked. - **connection_identifier** and **configuration_identifiers**: Revokes refresh tokens for all users on the specified configurations, except the configuration author. - **connection_identifier**, **configuration_identifiers**, and **user_identifiers**: Revokes refresh tokens for the specified users on the specified configurations. - **connection_identifier** and **org_identifiers**: Revokes refresh tokens for the specified Orgs. Applicable only for published connections. - **connection_identifier**, **org_identifiers**, and **user_identifiers**: Revokes refresh tokens for the specified users in the specified Orgs. Applicable only for published connections. **NOTE**: The `org_identifiers` parameter is only applicable for published connections. Using this parameter for unpublished connections will result in an error. Ensure that the connections are published before making the API request. * @param param the request object */ public revokeRefreshTokens(param: ThoughtSpotRestApiRevokeRefreshTokensRequest, options?: Configuration): Promise { return this.api.revokeRefreshTokens(param.connectionIdentifier, param.revokeRefreshTokensRequest, options).toPromise(); } /** * Version: 9.0.0.cl or later Revokes the authentication token issued for current user session. The token of your current session expires when you make a call to the `/api/rest/2.0/auth/token/revoke` endpoint. the users will not be able to access ThoughtSpot objects until a new token is obtained. To restart your session, request for a new token from ThoughtSpot. See [Get Full Access Token](#/http/api-endpoints/authentication/get-full-access-token). * @param param the request object */ public revokeToken(param: ThoughtSpotRestApiRevokeTokenRequest, options?: Configuration): Promise { return this.api.revokeToken(param.revokeTokenRequest, options).toPromise(); } /** * Version: 10.12.0.cl or later Gets a list of [custom calendars](https://docs.thoughtspot.com/cloud/latest/connections-cust-cal). Requires `DATAMANAGEMENT` (**Can manage data**) or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your ThoughtSpot instance, the `CAN_MANAGE_CUSTOM_CALENDAR` (**Can manage custom calendars**) privilege is required. #### Usage guidelines By default, the API returns a list of custom calendars for all connection objects. To retrieve custom calendar details for a particular connection, specify the connection ID. You can also use other search parameters such as `name_pattern` and `sort_options` as search filters. The `name_pattern` parameter filters and returns only those objects that match the specified pattern. Use `%` as a wildcard for pattern matching. * @param param the request object */ public searchCalendars(param: ThoughtSpotRestApiSearchCalendarsRequest, options?: Configuration): Promise> { return this.api.searchCalendars(param.searchCalendarsRequest, options).toPromise(); } /** * Version: 26.4.0.cl or later Searches delivery history for communication channels such as webhooks. Returns channel-level delivery status for each job execution record. Use this to monitor channel health and delivery success rates across events. Requires `ADMINISTRATION` (**Can administer ThoughtSpot**) or `DEVELOPER` (**Has developer privilege**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, users with `CAN_MANAGE_WEBHOOKS` (**Can manage webhooks**) privilege are also authorized to perform this action. **NOTE**: When `channel_type` is `WEBHOOK`, the following constraints apply: - `job_ids`, `channel_identifiers`, and `events` each accept at most one element. - When `job_ids` is provided, it is used as the sole lookup key and other filter fields are ignored. - When `job_ids` is not provided, `channel_identifiers` and `events` are both required. Each must contain exactly one element, and the event object must include the `identifier` field. - Records older than the configured retention period are not returned. * @param param the request object */ public searchChannelHistory(param: ThoughtSpotRestApiSearchChannelHistoryRequest, options?: Configuration): Promise { return this.api.searchChannelHistory(param.searchChannelHistoryRequest, options).toPromise(); } /** * Version: 26.4.0.cl or later Gets a list of collections available in ThoughtSpot. To get details of a specific collection, specify the collection GUID or name. You can also filter the API response based on the collection name pattern, author, and other criteria. #### Search options * **name_pattern**: Use \'%\' as a wildcard character to match collection names * **collection_identifiers**: Search for specific collections by their GUIDs or names * **include_metadata**: When set to `true`, includes the metadata objects within each collection in the response **NOTE**: If the API returns an empty list, consider increasing the value of the `record_size` parameter. To search across all available collections, set `record_size` to `-1`. * @param param the request object */ public searchCollections(param: ThoughtSpotRestApiSearchCollectionsRequest, options?: Configuration): Promise { return this.api.searchCollections(param.searchCollectionsRequest, options).toPromise(); } /** * Version: 9.2.0.cl or later Gets a list of commits for a given metadata object. Requires `DATAMANAGEMENT` (**Can manage data**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance on your instance, the `CAN_MANAGE_WORKSHEET_VIEWS_TABLES` (**Can manage data models**) privilege and edit access to the metadata objects. * @param param the request object */ public searchCommits(param: ThoughtSpotRestApiSearchCommitsRequest, options?: Configuration): Promise> { return this.api.searchCommits(param.searchCommitsRequest, options).toPromise(); } /** * Version: 10.14.0.cl or later Fetch communication channel preferences. - Use `cluster_preferences` to fetch the default preferences for your ThoughtSpot application instance. - If your instance has [Orgs](https://docs.thoughtspot.com/cloud/latest/orgs-overview), use `org_preferences` to fetch any Org-specific preferences that override the defaults. Requires `ADMINISTRATION` (**Can administer ThoughtSpot**) or `DEVELOPER` (**Has developer privilege**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, users with `APPLICATION_ADMINISTRATION` (**Can manage application settings**) privilege are also authorized to perform this action. * @param param the request object */ public searchCommunicationChannelPreferences(param: ThoughtSpotRestApiSearchCommunicationChannelPreferencesRequest, options?: Configuration): Promise { return this.api.searchCommunicationChannelPreferences(param.searchCommunicationChannelPreferencesRequest, options).toPromise(); } /** * Version: 9.2.0.cl or later Gets Git repository connections configured on the ThoughtSpot instance. Requires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance on your instance, the `CAN_SETUP_VERSION_CONTROL` (**Can set up version control**) privilege. * @param param the request object */ public searchConfig(param: ThoughtSpotRestApiSearchConfigRequest, options?: Configuration): Promise> { return this.api.searchConfig(param.searchConfigRequest, options).toPromise(); } /** * Version: 9.2.0.cl or later Gets connection objects. Requires `DATAMANAGEMENT` (**Can manage data**) or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**) privilege is required. - To get a list of all connections available in the ThoughtSpot system, send the API request without any attributes in the request body. - To get the connection objects for a specific type of data warehouse, specify the type in `data_warehouse_types`. - To fetch details of a connection object, specify the connection object GUID or name. The `name_pattern` attribute allows passing partial text with `%` for a wildcard match. - To get details of the database, schemas, tables, or columns from a data connection object, specify `data_warehouse_object_type`. - To get a specific database, schema, table, or column from a connection object, define the object type in `data_warehouse_object_type` and object properties in the `data_warehouse_objects` array. For example, to search for a column, you must pass the database, schema, and table names in the API request. Note that in the following example, object properties are set in a hierarchical order (`database` > `schema` > `table` > `column`). ``` { \"connections\": [ { \"identifier\": \"b9d1f2ef-fa65-4a4b-994e-30fa2d57b0c2\", \"data_warehouse_objects\": [ { \"database\": \"NEBULADEV\", \"schema\": \"INFORMATION_SCHEMA\", \"table\": \"APPLICABLE_ROLES\", \"column\": \"ROLE_NAME\" } ] } ], \"data_warehouse_object_type\": \"COLUMN\" } ``` - To fetch data by `configuration`, specify `data_warehouse_object_type`. For example, to fetch columns from the `DEVELOPMENT` database, specify the `data_warehouse_object_type` as `DATABASE` and define the `configuration` string as `{\"database\":\"DEVELOPMENT\"}`. To get column data for a specific table, specify the table, for example,`{\"database\":\"RETAILAPPAREL\",\"table\":\"PIPES\"}`. - To query connections by `authentication_type`, specify `data_warehouse_object_type`. Supported values for `authentication_type` are: - `SERVICE_ACCOUNT`: For connections that require service account credentials to authenticate to the Cloud Data Warehouse and fetch data. - `OAUTH`: For connections that require OAuth credentials to authenticate to the Cloud Data Warehouse and fetch data. Teradata, Oracle, and Presto Cloud Data Warehouses do not support the OAuth authentication type. - `IAM`: For connections that have the IAM OAuth set up. This authentication type is supported on Amazon Redshift connections only. - `EXTOAUTH`: For connections that have External OAuth set up. ThoughtSpot supports external [OAuth with Microsoft Azure Active Directory (AD)](https://docs.thoughtspot.com/cloud/latest/ connections-snowflake-azure-ad-oauth) and [Okta for Snowflake data connections](https://docs.thoughtspot.com/cloud/latest/connections-snowflake-okta-oauth). - `KEY_PAIR`: For connections that require Key Pair account credentials to authenticate to the Cloud Data Warehouse and fetch data. This authentication type is supported on Snowflake connections only. - `OAUTH_WITH_PKCE`: For connections that require OAuth with PKCE account credentials to authenticate to the Cloud Data Warehouse and fetch data. This authentication type is supported on Snowflake, Starburst, Databricks, Denodo connections only. - `EXTOAUTH_WITH_PKCE`: For connections that require External OAuth With PKCE account credentials to authenticate to the Cloud Data Warehouse and fetch data. This authentication type is supported on Snowflake connections only. - `OAUTH_WITH_PEZ`: For connections that require OAuth With PEZ account credentials to authenticate to the Cloud Data Warehouse and fetch data. This authentication type is supported on Amazon Redshift connections only. - `OAUTH_WITH_SERVICE_PRINCIPAL`: For connections that require OAuth With Service Principal account credentials to authenticate to the Cloud Data Warehouse and fetch data. This authentication type is supported on Databricks connections only. - `PERSONAL_ACCESS_TOKEN`: For connections that require Personal Access Token account credentials to authenticate to the Cloud Data Warehouse and fetch data. This authentication type is supported on Databricks connections only. - `OAUTH_CLIENT_CREDENTIALS`: For connections that require OAuth Client Credentials to authenticate to the Cloud Data Warehouse and fetch data. This authentication type is supported on Snowflake connections only. - To include more details about connection objects in the API response, set `include_details` to `true`. - You can also sort the output by field names and filter connections by tags. **NOTE**: When filtering connection records by parameters other than `data_warehouse_types` or `tag_identifiers`, ensure that you set `record_size` to `-1` and `record_offset` to `0` for precise results. * @param param the request object */ public searchConnection(param: ThoughtSpotRestApiSearchConnectionRequest, options?: Configuration): Promise> { return this.api.searchConnection(param.searchConnectionRequest, options).toPromise(); } /** * Version: 9.6.0.cl or later Gets custom actions configured on the cluster. Requires `DEVELOPER` (**Has Developer privilege**) or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `DEVELOPER` (**Has developer privilege**) privilege is required. * @param param the request object */ public searchCustomActions(param: ThoughtSpotRestApiSearchCustomActionsRequest, options?: Configuration): Promise> { return this.api.searchCustomActions(param.searchCustomActionsRequest, options).toPromise(); } /** * Version: 9.0.0.cl or later Generates an Answer from a given data source. Requires at least view access to the data source object (Worksheet or View). #### Usage guidelines To search data, specify the data source GUID in `logical_table_identifier`. The data source can be a Worksheet, View, Table, or SQL view. Pass search tokens in the `query_string` attribute in the API request as shown in the following example: ``` { \"query_string\": \"[sales] by [store]\", \"logical_table_identifier\": \"cd252e5c-b552-49a8-821d-3eadaa049cca\", } ``` For more information about the `query_string` format and data source attribute, see [Search data API](https://developers.thoughtspot.com/docs/fetch-data-and-report-apis#_search_data_api). The `record_size` attribute determines the number of records to retrieve in an API call. For more information about pagination, record size, and maximum row limit, see [Pagination and record size settings](https://developers.thoughtspot.com/docs/fetch-data-and-report-apis#_pagination_settings_for_data_and_report_api). * @param param the request object */ public searchData(param: ThoughtSpotRestApiSearchDataRequest, options?: Configuration): Promise { return this.api.searchData(param.searchDataRequest, options).toPromise(); } /** * Version: 10.10.0.cl or later Search the email customization configuration if any set for the ThoughtSpot system. #### Pre-requisites Requires `DEVELOPER` (**has developer privilege**) or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `DEVELOPER` (**Has developer privilege**) privilege is required. **NOTE**:This endpoint in currently in beta. Contact ThoughtSpot support to enable this on your instance. * @param param the request object */ public searchEmailCustomization(param: ThoughtSpotRestApiSearchEmailCustomizationRequest, options?: Configuration): Promise> { return this.api.searchEmailCustomization(param.searchEmailCustomizationRequest, options).toPromise(); } /** * Version: 9.0.0.cl or later Gets a list of metadata objects available on the ThoughtSpot system. This API endpoint is available to all users who have view access to the object. Users with `ADMINISTRATION` (**Can administer ThoughtSpot**) privileges can view data for all metadata objects, including users and groups. #### Usage guidelines - To get all metadata objects, send the API request without any attributes. - To get metadata objects of a specific type, set the `type` attribute. For example, to fetch a Worksheet, set the type as `LOGICAL_TABLE`. - To filter metadata objects within type `LOGICAL_TABLE`, set the `subtypes` attribute. For example, to fetch a Worksheet, set the type as `LOGICAL_TABLE` & subtypes as `[WORKSHEET]`. - To get a specific metadata object, specify the GUID. - To customize your search and filter the API response, you can use several parameters. You can search for objects created or modified by specific users, by tags applied to the objects, or by using the include parameters like `include_auto_created_objects`, `include_dependent_objects`, `include_headers`, `include_incomplete_objects`, and so on. You can also define sorting options to sort the data retrieved in the API response. - To get discoverable objects when linientmodel is enabled you can use `include_discoverable_objects` as true else false. Default value is true. - For liveboard metadata type, to get the newer format, set the `liveboard_response_format` as V2. Default value is V1. - To retrieve only objects that are published, set the `include_only_published_objects` as true. Default value is false. **NOTE**: The following parameters support pagination of metadata records: - `tag_identifiers` - `type` - `subtypes` - `created_by_user_identifiers` - `modified_by_user_identifiers` - `owned_by_user_identifiers` - `exclude_objects` - `include_auto_created_objects` - `favorite_object_options` - `include_only_published_objects` If you are using other parameters to search metadata, set `record_size` to `-1` and `record_offset` to `0`. * @param param the request object */ public searchMetadata(param: ThoughtSpotRestApiSearchMetadataRequest, options?: Configuration): Promise> { return this.api.searchMetadata(param.searchMetadataRequest, options).toPromise(); } /** * Version: 9.0.0.cl or later Gets a list of Orgs configured on the ThoughtSpot system. To get details of a specific Org, specify the Org ID or name. You can also pass parameters such as status, visibility, and user identifiers to get a specific list of Orgs. Requires cluster administration (**Can administer Org**) privileges. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `ORG_ADMINISTRATION` (**Can manage Orgs**) privilege is required. * @param param the request object */ public searchOrgs(param: ThoughtSpotRestApiSearchOrgsRequest, options?: Configuration): Promise> { return this.api.searchOrgs(param.searchOrgsRequest, options).toPromise(); } /** * Version: 9.5.0.cl or later Gets a list of Role objects from the ThoughtSpot system. Available if [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance. To search for Roles, the `ROLE_ADMINISTRATION` (**Can manage roles**) privilege is required. To get details of a specific Role object, specify the GUID or name. You can also filter the API response based on user group and Org identifiers, privileges assigned to the Role, and deprecation status. * @param param the request object */ public searchRoles(param: ThoughtSpotRestApiSearchRolesRequest, options?: Configuration): Promise> { return this.api.searchRoles(param.searchRolesRequest, options).toPromise(); } /** * Search Schedules Version: 9.4.0.cl or later Gets a list of scheduled jobs configured for a Liveboard. To get details of a specific scheduled job, specify the name or GUID of the scheduled job. Requires at least view access to Liveboards. **NOTE**: When filtering schedules by parameters other than `metadata`, set `record_size` to `-1` and `record_offset` to `0` for accurate results. * @param param the request object */ public searchSchedules(param: ThoughtSpotRestApiSearchSchedulesRequest, options?: Configuration): Promise> { return this.api.searchSchedules(param.searchSchedulesRequest, options).toPromise(); } /** * Version: 26.2.0.cl or later Fetch security settings for your ThoughtSpot application instance. - Use `scope: CLUSTER` to retrieve cluster-level security settings, including CORS and CSP allowlists, SAML redirect URLs, and settings that control access to non-embedded pages. - Use `scope: ORG` to retrieve Org-level security settings. If your instance has [Orgs](https://docs.thoughtspot.com/cloud/latest/orgs-overview), this returns CORS and non-embed access settings specific to the Org. - If `scope` is not specified, returns both cluster and Org-specific settings based on user privileges. Requires `ADMINISTRATION` (**Can administer ThoughtSpot**) or `DEVELOPER` (**Has developer privilege**) privilege. See [Security Settings](https://developers.thoughtspot.com/docs/security-settings) for more details. * @param param the request object */ public searchSecuritySettings(param: ThoughtSpotRestApiSearchSecuritySettingsRequest, options?: Configuration): Promise { return this.api.searchSecuritySettings(param.searchSecuritySettingsRequest, options).toPromise(); } /** * Version: 9.0.0.cl or later Gets a list of tag objects available on the ThoughtSpot system. To get details of a specific tag object, specify the GUID or name. Any authenticated user can search for tag objects. * @param param the request object */ public searchTags(param: ThoughtSpotRestApiSearchTagsRequest, options?: Configuration): Promise> { return this.api.searchTags(param.searchTagsRequest, options).toPromise(); } /** * Version: 9.0.0.cl or later Gets a list of user group objects from the ThoughtSpot system. To get details of a specific user group, specify the user group GUID or name. You can also filter the API response based on User ID, Org ID, Role ID, type of group, sharing visibility, privileges assigned to the group, and the Liveboard IDs assigned to the users in the group. Available to all users. Users with `ADMINISTRATION` (**Can administer ThoughtSpot**) privileges can view all users properties. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `GROUP_ADMINISTRATION` (**Can manage groups**) privilege is required. **NOTE**: If you do not get precise results, try setting `record_size` to `-1` and `record_offset` to `0`. * @param param the request object */ public searchUserGroups(param: ThoughtSpotRestApiSearchUserGroupsRequest, options?: Configuration): Promise> { return this.api.searchUserGroups(param.searchUserGroupsRequest, options).toPromise(); } /** * Version: 9.0.0.cl or later Gets a list of users available on the ThoughtSpot system. To get details of a specific user, specify the user GUID or name. You can also filter the API response based on groups, Org ID, user visibility, account status, user type, and user preference settings and favorites. Available to all users. Users with `ADMINISTRATION` (**Can administer ThoughtSpot**) privileges can view all users properties. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `USER_ADMINISTRATION` (**Can manage users**) privilege is required. **NOTE**: If the API returns an empty list, consider increasing the value of the `record_size` parameter. To search across all available users, set `record_size` to `-1`. * @param param the request object */ public searchUsers(param: ThoughtSpotRestApiSearchUsersRequest, options?: Configuration): Promise> { return this.api.searchUsers(param.searchUsersRequest, options).toPromise(); } /** * Search variables Version: 10.14.0.cl or later Allows searching for variables in ThoughtSpot. Requires ADMINISTRATION role. The CAN_MANAGE_VARIABLES permission allows you to manage Formula Variables in the current organization scope. The API endpoint supports searching variables by: * Variable identifier (ID or name) * Variable type * Name pattern (case-insensitive, supports % for wildcard) The search results can be formatted in three ways: * METADATA - Returns only variable metadata (default) * METADATA_AND_VALUES - Returns variable metadata and values The values can be filtered by scope: * org_identifier * principal_identifier * model_identifier * @param param the request object */ public searchVariables(param: ThoughtSpotRestApiSearchVariablesRequest, options?: Configuration): Promise> { return this.api.searchVariables(param.searchVariablesRequest, options).toPromise(); } /** * Version: 10.14.0.cl or later Searches for webhook configurations based on various criteria such as Org, webhook identifier, event type, with support for pagination and sorting. Returns matching webhook configurations with their complete details. Requires `ADMINISTRATION` (**Can administer ThoughtSpot**) or `DEVELOPER` (**Has developer privilege**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, users with `CAN_MANAGE_WEBHOOKS` (**Can manage webhooks**) privilege are also authorized to perform this action. * @param param the request object */ public searchWebhookConfigurations(param: ThoughtSpotRestApiSearchWebhookConfigurationsRequest, options?: Configuration): Promise { return this.api.searchWebhookConfigurations(param.searchWebhookConfigurationsRequest, options).toPromise(); } /** * Version: 10.15.0.cl or later **Deprecated** — Use `sendAgentConversationMessage` instead. Send natural language messages to an existing Spotter agent conversation and returns the complete response synchronously. Requires `CAN_USE_SPOTTER` privilege and access to the metadata object associated with the conversation. The user must have access to the conversation session referenced by `conversation_identifier`. A conversation must first be created using the `createAgentConversation` API. #### Usage guidelines The request must include: - `conversation_identifier`: the unique session ID returned by `createAgentConversation`, used for context continuity and message tracking - `messages`: an array of one or more text messages to send to the agent The API returns an array of response objects, each containing: - `type`: the kind of response — `text`, `answer`, or `error` - `message`: the main content of the response - `metadata`: additional information depending on the message type (e.g., answer metadata includes analytics and visualization details) #### Error responses | Code | Description | |------|----------------------------------------------------------------------------------------------------------------------------------| | 401 | Unauthorized — authentication token is missing, expired, or invalid. | | 403 | Forbidden — the authenticated user does not have `CAN_USE_SPOTTER` privilege or lacks permission on the referenced conversation. | > ###### Note: > > - This endpoint is deprecated. Use `sendAgentConversationMessage` for new integrations. > - This endpoint is currently in Beta. Breaking changes may be introduced before the endpoint is made Generally Available. > - This endpoint requires Spotter - please contact ThoughtSpot support to enable Spotter on your cluster. * @param param the request object */ public sendAgentMessage(param: ThoughtSpotRestApiSendAgentMessageRequest, options?: Configuration): Promise { return this.api.sendAgentMessage(param.conversationIdentifier, param.sendAgentMessageRequest, options).toPromise(); } /** * Version: 10.13.0.cl or later **Deprecated** — Use `sendAgentConversationMessageStreaming` instead. Sends one or more natural language messages to an existing Spotter agent conversation and returns the response as a real-time Server-Sent Events stream. Requires `CAN_USE_SPOTTER` privilege and access to the metadata object associated with the conversation. The user must have access to the conversation session referenced by `conversation_identifier`. A conversation must first be created using the `createAgentConversation` API. #### Usage guidelines The request must include: - `conversation_identifier`: the unique session ID returned by `createAgentConversation`, used for context continuity and message tracking - `messages`: an array of one or more text messages to send to the agent If the request is valid, the API returns a Server-Sent Events (SSE) stream. Each line has the form `data: [{\"type\": \"...\", ...}]` — a JSON array of event objects. Event types include: - `ack`: confirms receipt of the request (`node_id`) - `conv_title`: conversation title (`title`, `conv_id`) - `notification`: status updates on operations (`group_id`, `metadata`, `code` — e.g. `TOOL_CALL_NOTIFICATION`, `nls_start`, `FINAL_RESPONSE_NOTIFICATION`) - `text-chunk`: incremental content chunks (`id`, `group_id`, `metadata` with `format` and `type` such as `thinking` or `text`, `content`) - `text`: full text block with same structure as `text-chunk` - `answer`: structured answer with metadata (`id`, `group_id`, `metadata` with `sage_query`, `session_id`, `title`, etc., `title`) - `error`: if a failure occurs #### Error responses | Code | Description | |------|----------------------------------------------------------------------------------------------------------------------------------| | 401 | Unauthorized — authentication token is missing, expired, or invalid. | | 403 | Forbidden — the authenticated user does not have `CAN_USE_SPOTTER` privilege or lacks permission on the referenced conversation. | > ###### Note: > > - This endpoint is deprecated. Use `sendAgentConversationMessageStreaming` for new integrations. > - This endpoint is currently in Beta. Breaking changes may be introduced before the endpoint is made Generally Available. > - This endpoint requires Spotter - please contact ThoughtSpot support to enable Spotter on your cluster. > - The streaming protocol uses Server-Sent Events (SSE). * @param param the request object */ public sendAgentMessageStreaming(param: ThoughtSpotRestApiSendAgentMessageStreamingRequest, options?: Configuration): Promise { return this.api.sendAgentMessageStreaming(param.sendAgentMessageStreamingRequest, options).toPromise(); } /** * Version: 10.4.0.cl or later Sends a follow-up message to an existing conversation within the context of a data model. Requires `CAN_USE_SPOTTER` privilege and at least view access to the metadata object specified in the request. A conversation must first be created using the `createConversation` API. #### Usage guidelines The request must include: - `conversation_identifier`: the unique session ID returned by `createConversation` - `metadata_identifier`: the unique ID of the data source used for the conversation - `message`: a natural language string with the follow-up question If the request is successful, the API returns an array of response messages, each containing: - `session_identifier`: the unique ID of the generated response - `generation_number`: the generation number of the response - `message_type`: the type of the response (e.g., `TSAnswer`) - `visualization_type`: the generated visualization type (`Chart`, `Table`, or `Undefined`) - `tokens` / `display_tokens`: the search tokens and user-friendly display tokens for the response #### Error responses | Code | Description | |------|-----------------------------------------------------------------------------------------------------------------------------------------| | 401 | Unauthorized — authentication token is missing, expired, or invalid. | | 403 | Forbidden — the authenticated user does not have `CAN_USE_SPOTTER` privilege or lacks view permission on the specified metadata object. | > ###### Note: > * This endpoint is currently in Beta. Breaking changes may be introduced before the endpoint is made Generally Available. > * This endpoint requires Spotter - please contact ThoughtSpot support to enable Spotter on your cluster. * @param param the request object */ public sendMessage(param: ThoughtSpotRestApiSendMessageRequest, options?: Configuration): Promise> { return this.api.sendMessage(param.conversationIdentifier, param.sendMessageRequest, options).toPromise(); } /** * Version: 10.15.0.cl or later This API allows users to set natural language (NL) instructions for a specific data-model to improve AI-generated answers and query processing. These instructions help guide the AI system to better understand the data context and provide more accurate responses. Requires `CAN_USE_SPOTTER` privilege, either edit access or `SPOTTER_COACHING_PRIVILEGE` on the data model, and a bearer token corresponding to the org where the data model exists. #### Usage guidelines To set NL instructions for a data-model, the request must include: - `data_source_identifier`: The unique ID of the data-model for which to set NL instructions - `nl_instructions_info`: An array of instruction objects, each containing: - `instructions`: Array of text instructions for the LLM - `scope`: The scope of the instruction (`GLOBAL`). Currently only `GLOBAL` is supported. It can be extended to data-model-user scope in future. #### Instructions scope - **GLOBAL**: instructions that apply to all users querying this data model If the request is successful, the API returns: - `success`: a boolean indicating whether the operation completed successfully #### Error responses | Code | Description | |------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | 401 | Unauthorized — authentication token is missing, expired, or invalid. | | 403 | Forbidden — the authenticated user does not have `CAN_USE_SPOTTER` privilege, lacks edit access or `SPOTTER_COACHING_PRIVILEGE` on the data model, or the bearer token does not correspond to the org where the data model exists. | > ###### Note: > > - To use this API, the user needs either edit access or `SPOTTER_COACHING_PRIVILEGE` on the data model, and must use the bearer token corresponding to the org where the data model exists. > - This endpoint is currently in Beta. Breaking changes may be introduced before the endpoint is made Generally Available. > - Available from version 10.15.0.cl and later. > - This endpoint requires Spotter — please contact ThoughtSpot Support to enable Spotter on your cluster. > - Instructions help improve the accuracy and relevance of AI-generated responses for the specified data-model. * @param param the request object */ public setNLInstructions(param: ThoughtSpotRestApiSetNLInstructionsRequest, options?: Configuration): Promise { return this.api.setNLInstructions(param.setNLInstructionsRequest, options).toPromise(); } /** * Version: 9.0.0.cl or later Allows sharing one or several metadata objects with users and groups in ThoughtSpot. Requires edit access to the metadata object. #### Supported metadata objects: * Liveboards * Visualizations * Answers * Models * Views * Connections #### Object permissions You can provide `READ_ONLY` or `MODIFY` access when sharing an object with another user or group. The `READ_ONLY` permission grants view access to the shared object, whereas `MODIFY` provides edit access. To prevent a user or group from accessing the shared object, specify the GUID or name of the principal and set `shareMode` to `NO_ACCESS`. #### Sharing a visualization * Sharing a visualization implicitly shares the entire Liveboard with the recipient. * Object permissions set for a shared visualization also apply to the Liveboard unless overridden by another API request or via UI. * If email notifications for object sharing are enabled, a notification with a link to the shared visualization will be sent to the recipient’s email address. Although this link opens the shared visualization, recipients can also access other visualizations in the Liveboard. * @param param the request object */ public shareMetadata(param: ThoughtSpotRestApiShareMetadataRequest, options?: Configuration): Promise { return this.api.shareMetadata(param.shareMetadataRequest, options).toPromise(); } /** * Version: 10.4.0.cl or later Processes a natural language query against a specified data model and returns a single AI-generated answer without requiring a conversation session. Requires `CAN_USE_SPOTTER` privilege and at least view access to the metadata object specified in the request. #### Usage guidelines The request must include: - `query`: a natural language question (e.g., \"What were total sales last quarter?\") - `metadata_identifier`: the unique ID of the data source to query against If the request is successful, the API returns a response message containing: - `session_identifier`: the unique ID of the generated response - `generation_number`: the generation number of the response - `message_type`: the type of the response (e.g., `TSAnswer`) - `visualization_type`: the generated visualization type (`Chart`, `Table`, or `Undefined`) - `tokens` / `display_tokens`: the search tokens and user-friendly display tokens for the response #### Error responses | Code | Description | |------|-----------------------------------------------------------------------------------------------------------------------------------------| | 401 | Unauthorized — authentication token is missing, expired, or invalid. | | 403 | Forbidden — the authenticated user does not have `CAN_USE_SPOTTER` privilege or lacks view permission on the specified metadata object. | > ###### Note: > * This endpoint is currently in Beta. Breaking changes may be introduced before the endpoint is made Generally Available. > * This endpoint requires Spotter - please contact ThoughtSpot support to enable Spotter on your cluster. * @param param the request object */ public singleAnswer(param: ThoughtSpotRestApiSingleAnswerRequest, options?: Configuration): Promise { return this.api.singleAnswer(param.singleAnswerRequest, options).toPromise(); } /** * Version: 9.0.0.cl or later Removes the tags applied to a Liveboard, Answer, Table, or Worksheet. Requires edit access to the metadata object. * @param param the request object */ public unassignTag(param: ThoughtSpotRestApiUnassignTagRequest, options?: Configuration): Promise { return this.api.unassignTag(param.unassignTagRequest, options).toPromise(); } /** * Remove parameterization from fields in metadata objects. Version: 10.9.0.cl or later Allows removing parameterization from fields in metadata objects in ThoughtSpot. Requires appropriate permissions to modify the metadata object. The API endpoint allows unparameterizing the following types of metadata objects: * Logical Tables * Connections * Connection Configs For a Logical Table the field type must be `ATTRIBUTE` and field name can be one of: * databaseName * schemaName * tableName For a Connection or Connection Config, the field type is always `CONNECTION_PROPERTY`. In this case, field_name specifies the exact property of the Connection or Connection Config that needs to be unparameterized. For Connection Config, the only supported field name is: * impersonate_user * @param param the request object */ public unparameterizeMetadata(param: ThoughtSpotRestApiUnparameterizeMetadataRequest, options?: Configuration): Promise { return this.api.unparameterizeMetadata(param.unparameterizeMetadataRequest, options).toPromise(); } /** * Version: 10.9.0.cl or later Allows unpublishing metadata objects from organizations in ThoughtSpot. Requires ADMINISTRATION role and TENANT scope. The API endpoint allows unpublishing the following types of metadata objects: * Liveboards * Answers * Logical Tables When unpublishing objects, you can: * Include dependencies by setting `include_dependencies` to true - this will unpublish all dependent objects if no other published object is using them * Force unpublish by setting `force` to true - this will break all dependent objects in the unpublished organizations * @param param the request object */ public unpublishMetadata(param: ThoughtSpotRestApiUnpublishMetadataRequest, options?: Configuration): Promise { return this.api.unpublishMetadata(param.unpublishMetadataRequest, options).toPromise(); } /** * Version: 10.12.0.cl or later Updates the properties of a [custom calendar](https://docs.thoughtspot.com/cloud/latest/connections-cust-cal). Requires `DATAMANAGEMENT` (**Can manage data**) or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your ThoughtSpot instance, the `CAN_MANAGE_CUSTOM_CALENDAR` (**Can manage custom calendars**) privilege is required. #### Usage guidelines You can update the properties of a calendar using one of the following methods: * `FROM_INPUT_PARAMS` to update the calendar properties with the values defined in the API request. * `FROM_EXISTING_TABLE` Creates a calendar from the parameters defined in the API request. To update a custom calendar, specify the calendar ID as a path parameter in the request URL and the following parameters in the request body: * Connection ID and Table name * Database and schema name attributes: For most Cloud Data Warehouse (CDW) connectors, both `database_name` and `schema_name` attributes are required. However, the attribute requirements are conditional and vary based on the connector type and its metadata structure. For example, for connectors such as Teradata, MySQL, SingleSore, Amazon Aurora MySQL, Amazon RDS MySQL, Oracle, and GCP_MYSQL, the `schema_name` is required, whereas the `database_name` attribute is not. Similarly, connectors such as ClickHouse require you to specify the `database_name` and the schema specification in such cases is optional. The API allows you to modify the calendar type, month offset value, start and end date, starting day of the week, and prefixes assigned to the year and quarter labels. #### Examples Update a custom calendar using an existing Table in ThoughtSpot: ``` { \"update_method\": \"FROM_EXISTING_TABLE\", \"table_reference\": { \"connection_identifier\": \"Connection1\", \"database_name\": \"db1\", \"table_name\": \"custom_calendar_2025\", \"schame_name\": \"schemaVar\" } } ``` Update a custom calendar with the attributes defined in the API request: ``` { \"update_method\": \"FROM_INPUT_PARAMS\", \"table_reference\": { \"connection_identifier\": \"Connection1\", \"database_name\": \"db1\", \"table_name\": \"custom_calendar_2025\", \"schame_name\": \"schemaVar\" }, \"month_offset\": \"August\", \"start_day_of_week\": \"Monday\", \"start_date\": \"08/01/2025\", \"end_date\": \"07/31/2026\" } ``` * @param param the request object */ public updateCalendar(param: ThoughtSpotRestApiUpdateCalendarRequest, options?: Configuration): Promise { return this.api.updateCalendar(param.calendarIdentifier, param.updateCalendarRequest, options).toPromise(); } /** * Version: 26.4.0.cl or later Updates an existing collection in ThoughtSpot. #### Supported operations This API endpoint lets you perform the following operations: * Update collection name and description * Change visibility settings * Add metadata objects to the collection (operation: ADD) * Remove metadata objects from the collection (operation: REMOVE) * Replace all metadata objects in the collection (operation: REPLACE) #### Operation types * **ADD**: Adds the specified metadata objects to the existing collection without removing current items * **REMOVE**: Removes only the specified metadata objects from the collection * **REPLACE**: Replaces all existing metadata objects with the specified items (default behavior) * @param param the request object */ public updateCollection(param: ThoughtSpotRestApiUpdateCollectionRequest, options?: Configuration): Promise { return this.api.updateCollection(param.collectionIdentifier, param.updateCollectionRequest, options).toPromise(); } /** * Version: 10.12.0.cl or later Creates, updates, or deletes column security rules for specified tables. This API endpoint allows you to create, update, or delete column-level security rules on columns of a table. The operation follows an \"all or none\" policy: if defining security rules for any of the provided columns fails, the entire operation will be rolled back, and no rules will be created. #### Usage guidelines - Provide table identifier using either `identifier` (GUID or name) or `obj_identifier` (object ID) - Use `clear_csr: true` to remove all column security rules from the table - For each column, specify the security rule using `column_security_rules` array - Use `is_unsecured: true` to mark a specific column as unprotected - Use `group_access` operations to manage group associations: - `ADD`: Add groups to the column\'s access list - `REMOVE`: Remove groups from the column\'s access list - `REPLACE`: Replace all existing groups with the specified groups #### Required permissions - `ADMINISTRATION` - Can administer ThoughtSpot - `DATAMANAGEMENT` - Can manage data (if RBAC is disabled) - `CAN_MANAGE_WORKSHEET_VIEWS_TABLES` - Can manage worksheet views and tables (if RBAC is enabled) #### Example request ```json { \"identifier\": \"table-guid\", \"obj_identifier\": \"table-object-id\", \"clear_csr\": false, \"column_security_rules\": [ { \"column_identifier\": \"col id or col name\", \"is_unsecured\": false, \"group_access\": [ { \"operation\": \"ADD\", \"group_identifiers\": [\"hr_group_id\", \"hr_group_name\", \"finance_group_id\"] } ] }, { \"column_identifier\": \"col id or col name\", \"is_unsecured\": true }, { \"column_identifier\": \"col id or col name\", \"is_unsecured\": false, \"group_access\": [ { \"operation\": \"REPLACE\", \"group_identifiers\": [\"management_group_id\", \"management_group_name\"] } ] } ] } ``` #### Request Body Schema - `identifier` (string, optional): GUID or name of the table for which we want to create column security rules - `obj_identifier` (string, optional): The object ID of the table - `clear_csr` (boolean, optional): If true, then all the secured columns will be marked as unprotected, and all the group associations will be removed - `column_security_rules` (array of objects, required): An array where each object defines the security rule for a specific column Each column security rule object contains: - `column_identifier` (string, required): Column identifier (col_id or name) - `is_unsecured` (boolean, optional): If true, the column will be marked as unprotected and all groups associated with it will be removed - `group_access` (array of objects, optional): Array of group operation objects Each group operation object contains: - `operation` (string, required): Operation type - ADD, REMOVE, or REPLACE - `group_identifiers` (array of strings, required): Array of group identifiers (name or GUID) on which the operation will be performed #### Response This API does not return any response body. A successful operation returns HTTP 200 status code. #### Operation Types - **ADD**: Adds the specified groups to the column\'s access list - **REMOVE**: Removes the specified groups from the column\'s access list - **REPLACE**: Replaces all existing groups with the specified groups * @param param the request object */ public updateColumnSecurityRules(param: ThoughtSpotRestApiUpdateColumnSecurityRulesRequest, options?: Configuration): Promise { return this.api.updateColumnSecurityRules(param.updateColumnSecurityRulesRequest, options).toPromise(); } /** * Version: 9.2.0.cl or later Updates Git repository configuration settings. Requires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance on your instance, the `CAN_SETUP_VERSION_CONTROL` (**Can set up version control**) privilege. * @param param the request object */ public updateConfig(param: ThoughtSpotRestApiUpdateConfigRequest, options?: Configuration): Promise { return this.api.updateConfig(param.updateConfigRequest, options).toPromise(); } /** * Version: 9.2.0.cl or later **Important**: This endpoint is deprecated and will be removed from ThoughtSpot in September 2025. ThoughtSpot strongly recommends using the [Update connection V2](#/http/api-endpoints/connections/update-connection-v2) endpoint to update your connection objects. #### Usage guidelines Updates a connection object. Requires `DATAMANAGEMENT` (**Can manage data**) and edit permissions to the connection object, or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**) privilege is required. To update a connection object, pass these parameters in your API request: 1. GUID of the connection object. 2. If you are updating tables or database schema of a connection object: a. Add the updated JSON map of metadata with database, schema, and tables in `data_warehouse_config`. b. Set `validate` to `true`. 3. If you are updating a configuration attribute, connection name, or description, you can set `validate` to `false`. * @param param the request object */ public updateConnection(param: ThoughtSpotRestApiUpdateConnectionRequest, options?: Configuration): Promise { return this.api.updateConnection(param.updateConnectionRequest, options).toPromise(); } /** * Version: 10.12.0.cl or later Updates a connection configuration object. Requires `DATAMANAGEMENT` (**Can manage data**) and edit permissions to the connection object, or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**) privilege is required. #### Supported operations This API endpoint lets you perform the following operations in a single API request: * Edit the name or description of the configuration * Edit the configuration properties * Edit the `policy_type` * Edit the type of authentication * Enable or disable a configuration #### Parameterized Connection Support For parameterized oauth based connections, only the `same_as_parent` and `policy_process_options` attributes are allowed. These attributes are not applicable to connections that are not parameterized. **NOTE**: When updating a configuration where `disabled` is `true`, you must reset `disabled` to `true` in your update request payload. If not explicitly set again, the API will default `disabled` to `false`. * @param param the request object */ public updateConnectionConfiguration(param: ThoughtSpotRestApiUpdateConnectionConfigurationRequest, options?: Configuration): Promise { return this.api.updateConnectionConfiguration(param.configurationIdentifier, param.updateConnectionConfigurationRequest, options).toPromise(); } /** * Version: 10.4.0.cl or later Updates a connection object. Requires `DATAMANAGEMENT` (**Can manage data**) and edit permissions to the connection object, or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**) privilege is required. To update a connection object, pass these parameters in your API request: 1. GUID of the connection object. 2. If you are updating tables or database schema of a connection object: a. Add the updated JSON map of metadata with database, schema, and tables in `data_warehouse_config`. b. Set `validate` to `true`. **NOTE:** If the `authentication_type` is anything other than SERVICE_ACCOUNT, you must explicitly provide the authenticationType property in the payload. If you do not specify authenticationType, the API will default to SERVICE_ACCOUNT as the authentication type. * A JSON map of configuration attributes, database details, and table properties in `data_warehouse_config` as shown in the following example: * This is an example of updating a single table in a empty connection: ``` { \"authenticationType\": \"SERVICE_ACCOUNT\", \"externalDatabases\": [ { \"name\": \"DEVELOPMENT\", \"isAutoCreated\": false, \"schemas\": [ { \"name\": \"TS_dataset\", \"tables\": [ { \"name\": \"DEMORENAME\", \"type\": \"TABLE\", \"description\": \"\", \"selected\": true, \"linked\": true, \"gid\": 0, \"datasetId\": \"-1\", \"subType\": \"\", \"reportId\": \"\", \"viewId\": \"\", \"columns\": [ { \"name\": \"Col1\", \"type\": \"VARCHAR\", \"canImport\": true, \"selected\": true, \"description\": \"\", \"isLinkedActive\": true, \"isAggregate\": false }, { \"name\": \"Col2\", \"type\": \"VARCHAR\", \"canImport\": true, \"selected\": true, \"description\": \"\", \"isLinkedActive\": true, \"isAggregate\": false }, { \"name\": \"Col3\", \"type\": \"VARCHAR\", \"canImport\": true, \"selected\": true, \"description\": \"\", \"isLinkedActive\": true, \"isAggregate\": false }, { \"name\": \"Col312\", \"type\": \"VARCHAR\", \"canImport\": true, \"selected\": true, \"description\": \"\", \"isLinkedActive\": true, \"isAggregate\": false }, { \"name\": \"Col4\", \"type\": \"VARCHAR\", \"canImport\": true, \"selected\": true, \"description\": \"\", \"isLinkedActive\": true, \"isAggregate\": false } ], \"relationships\": [] } ] } ] } ], \"configuration\": { \"password\": \"\", \"database\": \"DEVELOPMENT\", \"role\": \"DEV\", \"accountName\": \"thoughtspot_partner\", \"warehouse\": \"DEMO_WH\", \"user\": \"DEV_USER\" } } ``` * This is an example of updating a single table in an existing connection with tables: ``` { \"authenticationType\": \"SERVICE_ACCOUNT\", \"externalDatabases\": [ { \"name\": \"DEVELOPMENT\", \"isAutoCreated\": false, \"schemas\": [ { \"name\": \"TS_dataset\", \"tables\": [ { \"name\": \"CUSTOMER\", \"type\": \"TABLE\", \"description\": \"\", \"selected\": true, \"linked\": true, \"gid\": 0, \"datasetId\": \"-1\", \"subType\": \"\", \"reportId\": \"\", \"viewId\": \"\", \"columns\": [], \"relationships\": [] }, { \"name\": \"tpch5k_falcon_default_schema_users\", \"type\": \"TABLE\", \"description\": \"\", \"selected\": true, \"linked\": true, \"gid\": 0, \"datasetId\": \"-1\", \"subType\": \"\", \"reportId\": \"\", \"viewId\": \"\", \"columns\": [ { \"name\": \"user_id\", \"type\": \"INT64\", \"canImport\": true, \"selected\": true, \"description\": \"\", \"isLinkedActive\": true, \"isAggregate\": false }, { \"name\": \"product_id\", \"type\": \"INT64\", \"canImport\": true, \"selected\": true, \"description\": \"\", \"isLinkedActive\": true, \"isAggregate\": false }, { \"name\": \"user_cost\", \"type\": \"INT64\", \"canImport\": true, \"selected\": true, \"description\": \"\", \"isLinkedActive\": true, \"isAggregate\": false } ], \"relationships\": [] } ] } ] } ], \"configuration\": { \"password\": \"\", \"database\": \"DEVELOPMENT\", \"role\": \"DEV\", \"accountName\": \"thoughtspot_partner\", \"warehouse\": \"DEMO_WH\", \"user\": \"DEV_USER\" } } ``` 3. If you are updating a configuration attribute, connection name, or description, you can set `validate` to `false`. **NOTE:** If the `authentication_type` is anything other than SERVICE_ACCOUNT, you must explicitly provide the authenticationType property in the payload. If you do not specify authenticationType, the API will default to SERVICE_ACCOUNT as the authentication type. * A JSON map of configuration attributes in `data_warehouse_config`. The following example shows the configuration attributes for a Snowflake connection: ``` { \"configuration\":{ \"accountName\":\"thoughtspot_partner\", \"user\":\"tsadmin\", \"password\":\"TestConn123\", \"role\":\"sysadmin\", \"warehouse\":\"MEDIUM_WH\" }, \"externalDatabases\":[ ] } ``` * @param param the request object */ public updateConnectionV2(param: ThoughtSpotRestApiUpdateConnectionV2Request, options?: Configuration): Promise { return this.api.updateConnectionV2(param.connectionIdentifier, param.updateConnectionV2Request, options).toPromise(); } /** * Version: 9.6.0.cl or later Updates a custom action. Requires `DEVELOPER` (**Has Developer privilege**) or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `DEVELOPER` (**Has developer privilege**) privilege is required. #### Usage Guidelines The API allows you to modify the following properties: * Name of the custom action * Action availability to groups * Association to metadata objects * Authentication settings for a URL-based action For more information, see [Custom actions](https://developers.thoughtspot.com/docs/custom-action-intro). * @param param the request object */ public updateCustomAction(param: ThoughtSpotRestApiUpdateCustomActionRequest, options?: Configuration): Promise { return this.api.updateCustomAction(param.customActionIdentifier, param.updateCustomActionRequest, options).toPromise(); } /** * Version: 9.9.0.cl or later Updates a DBT connection object. Requires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege or `DATAMANAGEMENT` (**Can manage data ThoughtSpot**) privilege, along with an existing DBT connection. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the following data control privileges may be required: - `CAN_MANAGE_CUSTOM_CALENDAR`(**Can manage custom calendars**) - `CAN_CREATE_OR_EDIT_CONNECTIONS` (**Can create/edit Connections**) - `CAN_MANAGE_WORKSHEET_VIEWS_TABLES` (**Can manage data models**) #### About update DBT connection You can modify DBT connection object properties such as embrace connection name, embrace database name, import type, account identifier, access token, project identifier and environment (or) embrace connection, embrace database name, import type, file_content settings. * @param param the request object */ public updateDbtConnection(param: ThoughtSpotRestApiUpdateDbtConnectionRequest, options?: Configuration): Promise { return this.api.updateDbtConnection(param.dbtConnectionIdentifier, param.connectionName, param.databaseName, param.importType, param.accessToken, param.dbtUrl, param.accountId, param.projectId, param.dbtEnvId, param.projectName, param.fileContent, options).toPromise(); } /** * Version: 10.12.0.cl or later Updates a customization configuration for the notification email. #### Pre-requisites Requires `DEVELOPER` (**has developer privilege**) or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `DEVELOPER` (**Has developer privilege**) privilege is required. **NOTE**:This endpoint in currently in beta. Contact ThoughtSpot support to enable this on your instance. #### Usage guidelines To update a custom configuration pass these parameters in your API request: - A JSON map of configuration attributes `template_properties`. The following example shows a sample set of customization configuration: ``` { { \"cta_button_bg_color\": \"#444DEA\", \"cta_text_font_color\": \"#FFFFFF\", \"primary_bg_color\": \"#D3DEF0\", \"logo_url\": \"https://storage.pardot.com/710713/1642089901EbkRibJq/TS_fullworkmark_darkmode.png\", \"font_family\": \"\", \"product_name\": \"ThoughtSpot\", \"footer_address\": \"444 Castro St, Suite 1000 Mountain View, CA 94041\", \"footer_phone\": \"(800) 508-7008\", \"replacement_value_for_liveboard\": \"Dashboard\", \"replacement_value_for_answer\": \"Chart\", \"replacement_value_for_spot_iq\": \"AI Insights\", \"hide_footer_phone\": false, \"hide_footer_address\": false, \"hide_product_name\": false, \"hide_manage_notification\": false, \"hide_mobile_app_nudge\": false, \"hide_privacy_policy\": false, \"hide_ts_vocabulary_definitions\": false, \"hide_error_message\": false, \"hide_unsubscribe_link\": false, \"hide_notification_status\": false, \"hide_modify_alert\": false, \"company_website_url\": \"https://your-website.com/\", \"company_privacy_policy_url\" : \"https://link-to-privacy-policy.com/\", \"contact_support_url\": \"https://link-to-contact-support.com/\", \"hide_contact_support_url\": false, \"hide_logo_url\" : false } } ``` * @param param the request object */ public updateEmailCustomization(param: ThoughtSpotRestApiUpdateEmailCustomizationRequest, options?: Configuration): Promise { return this.api.updateEmailCustomization(param.updateEmailCustomizationRequest, options).toPromise(); } /** * Update header attributes for a given list of header objects. Version: 10.6.0.cl or later ## Prerequisites - **Privileges Required:** - `DATAMANAGEMENT` (Can manage data) or `ADMINISTRATION` (Can administer ThoughtSpot). - **Additional Privileges (if RBAC is enabled):** - `ORG_ADMINISTRATION` (Can manage orgs). --- ## Usage Guidelines ### Parameters 1. **headers_update** - **Description:** List of header objects with their attributes to be updated. Each object contains a list of attributes to be updated in the header. - **Usage:** - You must provide either `identifier` or `obj_identifier`, but not both. Both fields cannot be empty. - When `org_identifier` is set to `-1`, only the `identifier` value is accepted; `obj_identifier` is not allowed. 2. **org_identifier** - **Description:** GUID (Globally Unique Identifier) or name of the organization. - **Usage:** - Leaving this field empty assumes that the changes should be applied to the current organization - Provide `org_guid` or `org_name` to uniquely identify the organization where changes need to be applied. . - Provide `-1` if changes have to be applied across all the org. --- ## Note Currently, this API is enabled only for updating the `obj_identifier` attribute. Only `text` will be allowed in attribute\'s value. ## Best Practices 1. **Backup Before Conversion:** Always export metadata as a backup before initiating the update process --- ## Examples ### Only `identifier` is given ```json { \"headers_update\": [ { \"identifier\": \"guid_1\", \"obj_identifier\": \"\", \"type\": \"LOGICAL_COLUMN\", \"attributes\": [ { \"name\": \"obj_id\", \"value\": \"custom_object_id\" } ] } ], \"org_identifier\": \"orgGuid\" } ``` ### Only `obj_identifier` is given ```json { \"headers_update\": [ { \"obj_identifier\": \"custom_object_id\", \"type\": \"ANSWER\", \"attributes\": [ { \"name\": \"obj_id\", \"value\": \"custom_object_id\" } ] } ], \"org_identifier\": \"orgName\" } ``` ### Executing update for all org `-1` ```json { \"headers_update\": [ { \"identifier\": \"guid_1\", \"type\": \"ANSWER\", \"attributes\": [ { \"name\": \"obj_id\", \"value\": \"custom_object_id\" } ] } ], \"org_identifier\": -1 } ``` ### Optional `type` is not provided ```json { \"headers_update\": [ { \"identifier\": \"guid_1\", \"attributes\": [ { \"name\": \"obj_id\", \"value\": \"custom_object_id\" } ] } ], \"org_identifier\": -1 } ``` * @param param the request object */ public updateMetadataHeader(param: ThoughtSpotRestApiUpdateMetadataHeaderRequest, options?: Configuration): Promise { return this.api.updateMetadataHeader(param.updateMetadataHeaderRequest, options).toPromise(); } /** * Update object IDs for given metadata objects. Version: 10.8.0.cl or later ## Prerequisites - **Privileges Required:** - `DATAMANAGEMENT` (Can manage data) or `ADMINISTRATION` (Can administer ThoughtSpot). - **Additional Privileges (if RBAC is enabled):** - `ORG_ADMINISTRATION` (Can manage orgs). --- ## Usage Guidelines ### Parameters 1. **metadata** - **Description:** List of metadata objects to update their object IDs. - **Usage:** - Use either `current_obj_id` alone OR use `metadata_identifier` with `type` (when needed). - When using `metadata_identifier`, the `type` field is required if using a name instead of a GUID. - The `new_obj_id` field is always required. --- ## Note This API is specifically designed for updating object IDs of metadata objects. It internally uses the header update mechanism to perform the changes. ## Best Practices 1. **Backup Before Update:** Always export metadata as a backup before initiating the update process. 2. **Validation:** - When using `current_obj_id`, ensure it matches the existing object ID exactly. - When using `metadata_identifier` with a name, ensure the `type` is specified correctly. - Verify that the `new_obj_id` follows your naming conventions and is unique within your system. --- ## Examples ### Using current_obj_id ```json { \"metadata\": [ { \"current_obj_id\": \"existing_object_id\", \"new_obj_id\": \"new_object_id\" } ] } ``` ### Using metadata_identifier with GUID ```json { \"metadata\": [ { \"metadata_identifier\": \"01234567-89ab-cdef-0123-456789abcdef\", \"new_obj_id\": \"new_object_id\" } ] } ``` ### Using metadata_identifier with name and type ```json { \"metadata\": [ { \"metadata_identifier\": \"My Answer\", \"type\": \"ANSWER\", \"new_obj_id\": \"new_object_id\" } ] } ``` ### Multiple objects update ```json { \"metadata\": [ { \"current_obj_id\": \"existing_object_id_1\", \"new_obj_id\": \"new_object_id_1\" }, { \"metadata_identifier\": \"My Worksheet\", \"type\": \"LOGICAL_TABLE\", \"new_obj_id\": \"new_object_id_2\" } ] } ``` * @param param the request object */ public updateMetadataObjId(param: ThoughtSpotRestApiUpdateMetadataObjIdRequest, options?: Configuration): Promise { return this.api.updateMetadataObjId(param.updateMetadataObjIdRequest, options).toPromise(); } /** * Version: 9.0.0.cl or later Updates an Org object. You can modify Org properties such as name, description, and user associations. Requires cluster administration (**Can administer Org**) privileges. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `ORG_ADMINISTRATION` (**Can manage Orgs**) privilege is required. * @param param the request object */ public updateOrg(param: ThoughtSpotRestApiUpdateOrgRequest, options?: Configuration): Promise { return this.api.updateOrg(param.orgIdentifier, param.updateOrgRequest, options).toPromise(); } /** * Version: 9.5.0.cl or later Updates the properties of a Role object. Available only if [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance. To update a Role, the `ROLE_ADMINISTRATION` (**Can manage roles**) privilege is required. * @param param the request object */ public updateRole(param: ThoughtSpotRestApiUpdateRoleRequest, options?: Configuration): Promise { return this.api.updateRole(param.roleIdentifier, param.updateRoleRequest, options).toPromise(); } /** * Update schedule. Version: 9.4.0.cl or later Updates a scheduled Liveboard job. Requires at least edit access to Liveboards. To update a schedule on behalf of another user, you need `ADMINISTRATION` (**Can administer Org**) or `JOBSCHEDULING` (**Can schedule for others**) privilege and edit access to the Liveboard. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `JOBSCHEDULING` (**Can schedule for others**) privilege is required. The API endpoint allows you to pause a scheduled job, change the status of a paused job. You can also edit the recipients list, frequency of the job, format of the file to send to the recipients in email notifications, PDF options, and time zone setting. * @param param the request object */ public updateSchedule(param: ThoughtSpotRestApiUpdateScheduleRequest, options?: Configuration): Promise { return this.api.updateSchedule(param.scheduleIdentifier, param.updateScheduleRequest, options).toPromise(); } /** * Version: 9.2.0.cl or later Updates the current configuration of the cluster. You must send the configuration data in JSON format. Requires `ADMINISTRATION` (**Can administer ThoughtSpot**) privileges. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `APPLICATION_ADMINISTRATION` (**Can manage application settings**) privilege is required. * @param param the request object */ public updateSystemConfig(param: ThoughtSpotRestApiUpdateSystemConfigRequest, options?: Configuration): Promise { return this.api.updateSystemConfig(param.updateSystemConfigRequest, options).toPromise(); } /** * Version: 9.0.0.cl or later Updates a tag object. You can modify the `name` and `color` properties of a tag object. Requires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `TAGMANAGEMENT` (**Can manage tags**) privilege is required to create, edit, and delete tags. * @param param the request object */ public updateTag(param: ThoughtSpotRestApiUpdateTagRequest, options?: Configuration): Promise { return this.api.updateTag(param.tagIdentifier, param.updateTagRequest, options).toPromise(); } /** * Version: 9.0.0.cl or later Updates the properties of a user object. You can modify user properties such as username, email, and share notification settings. You can also assign new groups and Orgs, remove the user from a group or Org, reset password, and modify user preferences. Requires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `USER_ADMINISTRATION` (**Can manage users**) privilege is required. * @param param the request object */ public updateUser(param: ThoughtSpotRestApiUpdateUserRequest, options?: Configuration): Promise { return this.api.updateUser(param.userIdentifier, param.updateUserRequest, options).toPromise(); } /** * Version: 9.0.0.cl or later Updates the properties of a group object in ThoughtSpot. Requires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `GROUP_ADMINISTRATION` (**Can manage groups**) privilege is required. #### Supported operations This API endpoint lets you perform the following operations in a single API request: * Edit [privileges](https://developers.thoughtspot.com/docs/?pageid=api-user-management#group-privileges) * Add or remove users * Change sharing visibility settings * Add or remove sub-groups * Assign a default Liveboard or update the existing settings * @param param the request object */ public updateUserGroup(param: ThoughtSpotRestApiUpdateUserGroupRequest, options?: Configuration): Promise { return this.api.updateUserGroup(param.groupIdentifier, param.updateUserGroupRequest, options).toPromise(); } /** * Update a variable\'s name Version: 10.14.0.cl or later Allows updating a variable\'s name in ThoughtSpot. Requires ADMINISTRATION role and TENANT scope. The CAN_MANAGE_VARIABLES permission allows you to manage Formula Variables in the current organization scope. The API endpoint allows updating: * The variable name * @param param the request object */ public updateVariable(param: ThoughtSpotRestApiUpdateVariableRequest, options?: Configuration): Promise { return this.api.updateVariable(param.identifier, param.updateVariableRequest, options).toPromise(); } /** * Update values for multiple variables Version: 10.14.0.cl or later **Note:** This API endpoint is deprecated and will be removed from ThoughtSpot in a future release. Use [POST /api/rest/2.0/template/variables/{identifier}/update-values](/api/rest/2.0/template/variables/%7Bidentifier%7D/update-values) instead. Allows updating values for multiple variables in ThoughtSpot. Requires ADMINISTRATION role. The CAN_MANAGE_VARIABLES permission allows you to manage Formula Variables in the current organization scope. The API endpoint allows: * Adding new values to variables * Replacing existing values * Deleting values from variables When updating variable values, you need to specify: * The variable identifiers * The values to add/replace/remove for each variable * The operation to perform (ADD, REPLACE, REMOVE, RESET) Behaviour based on operation type: * ADD - Adds values to the variable if this is a list type variable, else same as replace. * REPLACE - Replaces all values of a given set of constraints with the current set of values. * REMOVE - Removes any values which match the set of conditions of the variables if this is a list type variable, else clears value. * RESET - Removes all constrains for a given variable, scope is ignored * @param param the request object */ public updateVariableValues(param: ThoughtSpotRestApiUpdateVariableValuesRequest, options?: Configuration): Promise { return this.api.updateVariableValues(param.updateVariableValuesRequest, options).toPromise(); } /** * Version: 10.14.0.cl or later Updates an existing webhook configuration by its unique id or name. Only the provided fields will be updated. Requires `ADMINISTRATION` (**Can administer ThoughtSpot**) or `DEVELOPER` (**Has developer privilege**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, users with `CAN_MANAGE_WEBHOOKS` (**Can manage webhooks**) privilege are also authorized to perform this action. * @param param the request object */ public updateWebhookConfiguration(param: ThoughtSpotRestApiUpdateWebhookConfigurationRequest, options?: Configuration): Promise { return this.api.updateWebhookConfiguration(param.webhookIdentifier, param.updateWebhookConfigurationRequest, options).toPromise(); } /** * Version: 26.4.0.cl or later Validates a communication channel configuration to ensure it is properly set up and can receive events. - Use `channel_type` to specify the type of communication channel to validate (e.g., WEBHOOK). - Use `channel_identifier` to provide the unique identifier or name for the communication channel. - Use `event_type` to specify the event type to validate for this channel. Requires `ADMINISTRATION` (**Can administer ThoughtSpot**) or `DEVELOPER` (**Has developer privilege**) privilege. For webhook channels, users with `CAN_MANAGE_WEBHOOKS` (**Can manage webhooks**) privilege are also authorized to perform this action. * @param param the request object */ public validateCommunicationChannel(param: ThoughtSpotRestApiValidateCommunicationChannelRequest, options?: Configuration): Promise { return this.api.validateCommunicationChannel(param.validateCommunicationChannelRequest, options).toPromise(); } /** * Version: 10.10.0.cl or later Validates the email customization configuration if any set for the ThoughtSpot system. #### Pre-requisites Requires `DEVELOPER` (**has developer privilege**) or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `DEVELOPER` (**Has developer privilege**) privilege is required. **NOTE**:This endpoint in currently in beta. Contact ThoughtSpot support to enable this on your instance. * @param param the request object */ public validateEmailCustomization(param: ThoughtSpotRestApiValidateEmailCustomizationRequest = {}, options?: Configuration): Promise { return this.api.validateEmailCustomization( options).toPromise(); } /** * Version: 9.2.0.cl or later Validates the content of your source branch against the objects in your destination environment. Before merging content from your source branch to the destination branch, run this API operation from your destination environment and ensure that the changes from the source branch function in the destination environment. Requires `DATAMANAGEMENT` (**Can manage data**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance on your instance, the `CAN_MANAGE_WORKSHEET_VIEWS_TABLES` (**Can manage data models**) privilege and edit access to the metadata objects. * @param param the request object */ public validateMerge(param: ThoughtSpotRestApiValidateMergeRequest, options?: Configuration): Promise> { return this.api.validateMerge(param.validateMergeRequest, options).toPromise(); } /** * Version: 9.12.0.cl or later Validates the authentication token specified in the API request. If your token is not valid, [Get a new token](#/http/api-endpoints/authentication/get-full-access-token). * @param param the request object */ public validateToken(param: ThoughtSpotRestApiValidateTokenRequest, options?: Configuration): Promise { return this.api.validateToken(param.validateTokenRequest, options).toPromise(); } } import { ObservableUsersApi } from "./ObservableAPI"; import { UsersApiRequestFactory, UsersApiResponseProcessor} from "../apis/UsersApi"; export interface UsersApiActivateUserRequest { /** * * @type ActivateUserRequest * @memberof UsersApiactivateUser */ activateUserRequest: ActivateUserRequest } export interface UsersApiChangeUserPasswordRequest { /** * * @type ChangeUserPasswordRequest * @memberof UsersApichangeUserPassword */ changeUserPasswordRequest: ChangeUserPasswordRequest } export interface UsersApiCreateUserRequest { /** * * @type CreateUserRequest * @memberof UsersApicreateUser */ createUserRequest: CreateUserRequest } export interface UsersApiDeactivateUserRequest { /** * * @type DeactivateUserRequest * @memberof UsersApideactivateUser */ deactivateUserRequest: DeactivateUserRequest } export interface UsersApiDeleteUserRequest { /** * GUID / name of the user * @type string * @memberof UsersApideleteUser */ userIdentifier: string } export interface UsersApiForceLogoutUsersRequest { /** * * @type ForceLogoutUsersRequest * @memberof UsersApiforceLogoutUsers */ forceLogoutUsersRequest: ForceLogoutUsersRequest } export interface UsersApiImportUsersRequest { /** * * @type ImportUsersRequest * @memberof UsersApiimportUsers */ importUsersRequest: ImportUsersRequest } export interface UsersApiResetUserPasswordRequest { /** * * @type ResetUserPasswordRequest * @memberof UsersApiresetUserPassword */ resetUserPasswordRequest: ResetUserPasswordRequest } export interface UsersApiSearchUsersRequest { /** * * @type SearchUsersRequest * @memberof UsersApisearchUsers */ searchUsersRequest: SearchUsersRequest } export interface UsersApiUpdateUserRequest { /** * GUID / name of the user * @type string * @memberof UsersApiupdateUser */ userIdentifier: string /** * * @type UpdateUserRequest * @memberof UsersApiupdateUser */ updateUserRequest: UpdateUserRequest } export class ObjectUsersApi { private api: ObservableUsersApi public constructor(configuration: Configuration, requestFactory?: UsersApiRequestFactory, responseProcessor?: UsersApiResponseProcessor) { this.api = new ObservableUsersApi(configuration, requestFactory, responseProcessor); } /** * Version: 9.7.0.cl or later Activates a deactivated user account. Requires `ADMINISTRATION` (**Can administer Thoughtspot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `USER_ADMINISTRATION` (**Can manage users**) privilege is required. To activate an inactive user account, the API request body must include the following information: - Username or the GUID of the user account. - Auth token generated for the deactivated user. The auth token is sent in the API response when a user is deactivated. - Password for the user account. * @param param the request object */ public activateUser(param: UsersApiActivateUserRequest, options?: Configuration): Promise { return this.api.activateUser(param.activateUserRequest, options).toPromise(); } /** * Version: 9.0.0.cl or later Updates the current password of the user. Requires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `USER_ADMINISTRATION` (**Can manage users**) privilege is required. * @param param the request object */ public changeUserPassword(param: UsersApiChangeUserPasswordRequest, options?: Configuration): Promise { return this.api.changeUserPassword(param.changeUserPasswordRequest, options).toPromise(); } /** * Version: 9.0.0.cl or later Creates a user in ThoughtSpot. The API endpoint allows you to configure several user properties such as email address, account status, share notification preferences, and sharing visibility. You can provision the user to [groups](https://docs.thoughtspot.com/cloud/latest/groups-privileges) and [Orgs](https://docs.thoughtspot.com/cloud/latest/orgs-overview). You can also add Liveboard, Answer, and Worksheet objects to the user’s favorites list, assign a default Liveboard for the user, and set user preferences. Requires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `USER_ADMINISTRATION` (**Can manage users**) privilege is required. * @param param the request object */ public createUser(param: UsersApiCreateUserRequest, options?: Configuration): Promise { return this.api.createUser(param.createUserRequest, options).toPromise(); } /** * Version: 9.7.0.cl or later Deactivates a user account. Requires `ADMINISTRATION` (**Can administer Thoughtspot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `USER_ADMINISTRATION` (**Can manage users**) privilege is required. To deactivate a user account, the API request body must include the following information: - Username or the GUID of the user account - Base URL of the ThoughtSpot instance If the API request is successful, ThoughtSpot returns the activation URL in the response. The activation URL is valid for 14 days and can be used to re-activate the account and reset the password of the deactivated account. * @param param the request object */ public deactivateUser(param: UsersApiDeactivateUserRequest, options?: Configuration): Promise { return this.api.deactivateUser(param.deactivateUserRequest, options).toPromise(); } /** * Version: 9.0.0.cl or later Deletes a user from the ThoughtSpot system. If you want to remove a user from a specific Org but not from ThoughtSpot, update the group and Org mapping properties of the user object via a POST API call to the [/api/rest/2.0/users/{user_identifier}/update](#/http/api-endpoints/users/update-user) endpoint. Requires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `USER_ADMINISTRATION` (**Can manage users**) privilege is required. * @param param the request object */ public deleteUser(param: UsersApiDeleteUserRequest, options?: Configuration): Promise { return this.api.deleteUser(param.userIdentifier, options).toPromise(); } /** * Version: 9.0.0.cl or later Enforces logout on current user sessions. Use this API with caution as it may invalidate active user sessions and force users to re-login. Make sure you specify the usernames or GUIDs. If you pass null values in the API call, all user sessions on your cluster become invalid, and the users are forced to re-login. Requires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `USER_ADMINISTRATION` (**Can manage users**) privilege is required. * @param param the request object */ public forceLogoutUsers(param: UsersApiForceLogoutUsersRequest, options?: Configuration): Promise { return this.api.forceLogoutUsers(param.forceLogoutUsersRequest, options).toPromise(); } /** * Version: 9.0.0.cl or later Imports user data from external databases into ThoughtSpot. During the user import operation: * If the specified users are not available in ThoughtSpot, the users are created and assigned a default password. Defining a `default_password` in the API request is optional. * If `delete_unspecified_users` is set to `true`, the users not specified in the API request, excluding the `tsadmin`, `guest`, `system` and `su` users, are deleted. * If the specified user objects are already available in ThoughtSpot, the object properties are updated and synchronized as per the input data in the API request. A successful API call returns the object that represents the changes made in the ThoughtSpot system. Requires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `USER_ADMINISTRATION` (**Can manage users**) privilege is required. * @param param the request object */ public importUsers(param: UsersApiImportUsersRequest, options?: Configuration): Promise { return this.api.importUsers(param.importUsersRequest, options).toPromise(); } /** * Version: 9.0.0.cl or later Resets the password of a user account. Administrators can reset password on behalf of a user. Requires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `USER_ADMINISTRATION` (**Can manage users**) privilege is required. * @param param the request object */ public resetUserPassword(param: UsersApiResetUserPasswordRequest, options?: Configuration): Promise { return this.api.resetUserPassword(param.resetUserPasswordRequest, options).toPromise(); } /** * Version: 9.0.0.cl or later Gets a list of users available on the ThoughtSpot system. To get details of a specific user, specify the user GUID or name. You can also filter the API response based on groups, Org ID, user visibility, account status, user type, and user preference settings and favorites. Available to all users. Users with `ADMINISTRATION` (**Can administer ThoughtSpot**) privileges can view all users properties. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `USER_ADMINISTRATION` (**Can manage users**) privilege is required. **NOTE**: If the API returns an empty list, consider increasing the value of the `record_size` parameter. To search across all available users, set `record_size` to `-1`. * @param param the request object */ public searchUsers(param: UsersApiSearchUsersRequest, options?: Configuration): Promise> { return this.api.searchUsers(param.searchUsersRequest, options).toPromise(); } /** * Version: 9.0.0.cl or later Updates the properties of a user object. You can modify user properties such as username, email, and share notification settings. You can also assign new groups and Orgs, remove the user from a group or Org, reset password, and modify user preferences. Requires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, the `USER_ADMINISTRATION` (**Can manage users**) privilege is required. * @param param the request object */ public updateUser(param: UsersApiUpdateUserRequest, options?: Configuration): Promise { return this.api.updateUser(param.userIdentifier, param.updateUserRequest, options).toPromise(); } } import { ObservableVariableApi } from "./ObservableAPI"; import { VariableApiRequestFactory, VariableApiResponseProcessor} from "../apis/VariableApi"; export interface VariableApiCreateVariableRequest { /** * * @type CreateVariableRequest * @memberof VariableApicreateVariable */ createVariableRequest: CreateVariableRequest } export interface VariableApiDeleteVariableRequest { /** * Unique id or name of the variable * @type string * @memberof VariableApideleteVariable */ identifier: string } export interface VariableApiDeleteVariablesRequest { /** * * @type DeleteVariablesRequest * @memberof VariableApideleteVariables */ deleteVariablesRequest: DeleteVariablesRequest } export interface VariableApiPutVariableValuesRequest { /** * Unique ID or name of the variable * @type string * @memberof VariableApiputVariableValues */ identifier: string /** * * @type PutVariableValuesRequest * @memberof VariableApiputVariableValues */ putVariableValuesRequest: PutVariableValuesRequest } export interface VariableApiSearchVariablesRequest { /** * * @type SearchVariablesRequest * @memberof VariableApisearchVariables */ searchVariablesRequest: SearchVariablesRequest } export interface VariableApiUpdateVariableRequest { /** * Unique id or name of the variable to update. * @type string * @memberof VariableApiupdateVariable */ identifier: string /** * * @type UpdateVariableRequest * @memberof VariableApiupdateVariable */ updateVariableRequest: UpdateVariableRequest } export interface VariableApiUpdateVariableValuesRequest { /** * * @type UpdateVariableValuesRequest * @memberof VariableApiupdateVariableValues */ updateVariableValuesRequest: UpdateVariableValuesRequest } export class ObjectVariableApi { private api: ObservableVariableApi public constructor(configuration: Configuration, requestFactory?: VariableApiRequestFactory, responseProcessor?: VariableApiResponseProcessor) { this.api = new ObservableVariableApi(configuration, requestFactory, responseProcessor); } /** * Create a variable which can be used for parameterizing metadata objects Version: 10.14.0.cl or later Allows creating a variable which can be used for parameterizing metadata objects in ThoughtSpot. Requires ADMINISTRATION role and TENANT scope. The CAN_MANAGE_VARIABLES permission allows you to manage Formula Variables in the current organization scope. The API endpoint supports the following types of variables: * CONNECTION_PROPERTY - For connection properties * TABLE_MAPPING - For table mappings * CONNECTION_PROPERTY_PER_PRINCIPAL - For connection properties per principal. In order to use this please contact support to enable this. * FORMULA_VARIABLE - For Formula variables, introduced in 10.15.0.cl When creating a variable, you need to specify: * The variable type * A unique name for the variable * Whether the variable contains sensitive values (defaults to false) * The data type of the variable, only specify for formula variables (defaults to null) The operation will fail if: * The user lacks required permissions * The variable name already exists * The variable type is invalid * @param param the request object */ public createVariable(param: VariableApiCreateVariableRequest, options?: Configuration): Promise { return this.api.createVariable(param.createVariableRequest, options).toPromise(); } /** * Delete a variable Version: 10.14.0.cl or later **Note:** This API endpoint is deprecated and will be removed from ThoughtSpot in a future release. Use [POST /api/rest/2.0/template/variables/delete](/api/rest/2.0/template/variables/delete) instead. Allows deleting a variable from ThoughtSpot. Requires ADMINISTRATION role and TENANT scope. The CAN_MANAGE_VARIABLES permission allows you to manage Formula Variables in the current organization scope. The API endpoint requires: * The variable identifier (ID or name) The operation will fail if: * The user lacks required permissions * The variable doesn\'t exist * The variable is being used by other objects * @param param the request object */ public deleteVariable(param: VariableApiDeleteVariableRequest, options?: Configuration): Promise { return this.api.deleteVariable(param.identifier, options).toPromise(); } /** * Delete variable(s) Version: 26.4.0.cl or later Allows deleting multiple variables from ThoughtSpot. Requires ADMINISTRATION role and TENANT scope. The CAN_MANAGE_VARIABLES permission allows you to manage Formula Variables in the current organization scope. The API endpoint requires: * The variable identifiers (IDs or names) The operation will fail if: * The user lacks required permissions * Any of the variables don\'t exist * Any of the variables are being used by other objects * @param param the request object */ public deleteVariables(param: VariableApiDeleteVariablesRequest, options?: Configuration): Promise { return this.api.deleteVariables(param.deleteVariablesRequest, options).toPromise(); } /** * Update values for a variable Version: 26.4.0.cl or later Allows updating values for a specific variable in ThoughtSpot. Requires ADMINISTRATION role. The CAN_MANAGE_VARIABLES permission allows you to manage Formula Variables in the current organization scope. The API endpoint allows: * Adding new values to the variable * Replacing existing values * Deleting values from the variable * Resetting all values When updating variable values, you need to specify: * The variable identifier (ID or name) * The values to add/replace/remove * The operation to perform (ADD, REPLACE, REMOVE, RESET) Behaviour based on operation type: * ADD - Adds values to the variable if this is a list type variable, else same as replace. * REPLACE - Replaces all values of a given set of constraints with the current set of values. * REMOVE - Removes any values which match the set of conditions of the variables if this is a list type variable, else clears value. * RESET - Removes all constraints for the given variable, scope is ignored * @param param the request object */ public putVariableValues(param: VariableApiPutVariableValuesRequest, options?: Configuration): Promise { return this.api.putVariableValues(param.identifier, param.putVariableValuesRequest, options).toPromise(); } /** * Search variables Version: 10.14.0.cl or later Allows searching for variables in ThoughtSpot. Requires ADMINISTRATION role. The CAN_MANAGE_VARIABLES permission allows you to manage Formula Variables in the current organization scope. The API endpoint supports searching variables by: * Variable identifier (ID or name) * Variable type * Name pattern (case-insensitive, supports % for wildcard) The search results can be formatted in three ways: * METADATA - Returns only variable metadata (default) * METADATA_AND_VALUES - Returns variable metadata and values The values can be filtered by scope: * org_identifier * principal_identifier * model_identifier * @param param the request object */ public searchVariables(param: VariableApiSearchVariablesRequest, options?: Configuration): Promise> { return this.api.searchVariables(param.searchVariablesRequest, options).toPromise(); } /** * Update a variable\'s name Version: 10.14.0.cl or later Allows updating a variable\'s name in ThoughtSpot. Requires ADMINISTRATION role and TENANT scope. The CAN_MANAGE_VARIABLES permission allows you to manage Formula Variables in the current organization scope. The API endpoint allows updating: * The variable name * @param param the request object */ public updateVariable(param: VariableApiUpdateVariableRequest, options?: Configuration): Promise { return this.api.updateVariable(param.identifier, param.updateVariableRequest, options).toPromise(); } /** * Update values for multiple variables Version: 10.14.0.cl or later **Note:** This API endpoint is deprecated and will be removed from ThoughtSpot in a future release. Use [POST /api/rest/2.0/template/variables/{identifier}/update-values](/api/rest/2.0/template/variables/%7Bidentifier%7D/update-values) instead. Allows updating values for multiple variables in ThoughtSpot. Requires ADMINISTRATION role. The CAN_MANAGE_VARIABLES permission allows you to manage Formula Variables in the current organization scope. The API endpoint allows: * Adding new values to variables * Replacing existing values * Deleting values from variables When updating variable values, you need to specify: * The variable identifiers * The values to add/replace/remove for each variable * The operation to perform (ADD, REPLACE, REMOVE, RESET) Behaviour based on operation type: * ADD - Adds values to the variable if this is a list type variable, else same as replace. * REPLACE - Replaces all values of a given set of constraints with the current set of values. * REMOVE - Removes any values which match the set of conditions of the variables if this is a list type variable, else clears value. * RESET - Removes all constrains for a given variable, scope is ignored * @param param the request object */ public updateVariableValues(param: VariableApiUpdateVariableValuesRequest, options?: Configuration): Promise { return this.api.updateVariableValues(param.updateVariableValuesRequest, options).toPromise(); } } import { ObservableVersionControlApi } from "./ObservableAPI"; import { VersionControlApiRequestFactory, VersionControlApiResponseProcessor} from "../apis/VersionControlApi"; export interface VersionControlApiCommitBranchRequest { /** * * @type CommitBranchRequest * @memberof VersionControlApicommitBranch */ commitBranchRequest: CommitBranchRequest } export interface VersionControlApiCreateConfigRequest { /** * * @type CreateConfigRequest * @memberof VersionControlApicreateConfig */ createConfigRequest: CreateConfigRequest } export interface VersionControlApiDeleteConfigRequest { /** * * @type DeleteConfigRequest * @memberof VersionControlApideleteConfig */ deleteConfigRequest: DeleteConfigRequest } export interface VersionControlApiDeployCommitRequest { /** * * @type DeployCommitRequest * @memberof VersionControlApideployCommit */ deployCommitRequest: DeployCommitRequest } export interface VersionControlApiRevertCommitRequest { /** * Commit id to which the object should be reverted * @type string * @memberof VersionControlApirevertCommit */ commitId: string /** * * @type RevertCommitRequest * @memberof VersionControlApirevertCommit */ revertCommitRequest: RevertCommitRequest } export interface VersionControlApiSearchCommitsRequest { /** * * @type SearchCommitsRequest * @memberof VersionControlApisearchCommits */ searchCommitsRequest: SearchCommitsRequest } export interface VersionControlApiSearchConfigRequest { /** * * @type SearchConfigRequest * @memberof VersionControlApisearchConfig */ searchConfigRequest: SearchConfigRequest } export interface VersionControlApiUpdateConfigRequest { /** * * @type UpdateConfigRequest * @memberof VersionControlApiupdateConfig */ updateConfigRequest: UpdateConfigRequest } export interface VersionControlApiValidateMergeRequest { /** * * @type ValidateMergeRequest * @memberof VersionControlApivalidateMerge */ validateMergeRequest: ValidateMergeRequest } export class ObjectVersionControlApi { private api: ObservableVersionControlApi public constructor(configuration: Configuration, requestFactory?: VersionControlApiRequestFactory, responseProcessor?: VersionControlApiResponseProcessor) { this.api = new ObservableVersionControlApi(configuration, requestFactory, responseProcessor); } /** * Version: 9.2.0.cl or later Commits TML files of metadata objects to the Git branch configured on your instance. Requires at least edit access to objects used in the commit operation. Before using this endpoint to push your commits: * Enable Git integration on your instance. * Make sure the Git repository and branch details are configured on your instance. For more information, see [Git integration documentation](https://developers.thoughtspot.com/docs/git-integration). * @param param the request object */ public commitBranch(param: VersionControlApiCommitBranchRequest, options?: Configuration): Promise { return this.api.commitBranch(param.commitBranchRequest, options).toPromise(); } /** * Version: 9.2.0.cl or later Allows you to connect a ThoughtSpot instance to a Git repository. Requires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance on your instance, the `CAN_SETUP_VERSION_CONTROL` (**Can set up version control**) privilege. You can use this API endpoint to connect your ThoughtSpot development and production environments to the development and production branches of a Git repository. Before using this endpoint to connect your ThoughtSpot instance to a Git repository, check the following prerequisites: * You have a Git repository. If you are using GitHub, make sure you have a valid account and an access token to connect ThoughtSpot to GitHub. For information about generating a token, see [GitHub Documentation](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens). * Your access token has `repo` scope that grants full access to public and private repositories. * Your Git repository has a branch that can be configured as a default branch in ThoughtSpot. For more information, see [Git integration documentation](https://developers.thoughtspot.com/docs/?pageid=git-integration). **Note**: ThoughtSpot supports only GitHub / itHub Enterprise for CI/CD. * @param param the request object */ public createConfig(param: VersionControlApiCreateConfigRequest, options?: Configuration): Promise { return this.api.createConfig(param.createConfigRequest, options).toPromise(); } /** * Version: 9.2.0.cl or later Deletes Git repository configuration from your ThoughtSpot instance. Requires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance on your instance, the `CAN_SETUP_VERSION_CONTROL` (**Can set up version control**) privilege. * @param param the request object */ public deleteConfig(param: VersionControlApiDeleteConfigRequest, options?: Configuration): Promise { return this.api.deleteConfig(param.deleteConfigRequest, options).toPromise(); } /** * Version: 9.2.0.cl or later Allows you to deploy a commit and publish TML content to your ThoughtSpot instance. Requires at least edit access to the objects used in the deploy operation. The API deploys the head of the branch unless a `commit_id` is specified in the API request. If the branch name is not defined in the request, the default branch is considered for deploying commits. For more information, see [Git integration documentation](https://developers.thoughtspot.com/docs/git-integration). * @param param the request object */ public deployCommit(param: VersionControlApiDeployCommitRequest, options?: Configuration): Promise> { return this.api.deployCommit(param.deployCommitRequest, options).toPromise(); } /** * Version: 9.2.0.cl or later Reverts TML objects to a previous commit specified in the API request. Requires at least edit access to objects. In the API request, specify the `commit_id`. If the branch name is not specified in the request, the API will consider the default branch configured on your instance. By default, the API reverts all objects. If the revert operation fails for one of the objects provided in the commit, the API returns an error and does not revert any object. For more information, see [Git integration documentation](https://developers.thoughtspot.com/docs/git-integration). * @param param the request object */ public revertCommit(param: VersionControlApiRevertCommitRequest, options?: Configuration): Promise { return this.api.revertCommit(param.commitId, param.revertCommitRequest, options).toPromise(); } /** * Version: 9.2.0.cl or later Gets a list of commits for a given metadata object. Requires `DATAMANAGEMENT` (**Can manage data**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance on your instance, the `CAN_MANAGE_WORKSHEET_VIEWS_TABLES` (**Can manage data models**) privilege and edit access to the metadata objects. * @param param the request object */ public searchCommits(param: VersionControlApiSearchCommitsRequest, options?: Configuration): Promise> { return this.api.searchCommits(param.searchCommitsRequest, options).toPromise(); } /** * Version: 9.2.0.cl or later Gets Git repository connections configured on the ThoughtSpot instance. Requires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance on your instance, the `CAN_SETUP_VERSION_CONTROL` (**Can set up version control**) privilege. * @param param the request object */ public searchConfig(param: VersionControlApiSearchConfigRequest, options?: Configuration): Promise> { return this.api.searchConfig(param.searchConfigRequest, options).toPromise(); } /** * Version: 9.2.0.cl or later Updates Git repository configuration settings. Requires `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance on your instance, the `CAN_SETUP_VERSION_CONTROL` (**Can set up version control**) privilege. * @param param the request object */ public updateConfig(param: VersionControlApiUpdateConfigRequest, options?: Configuration): Promise { return this.api.updateConfig(param.updateConfigRequest, options).toPromise(); } /** * Version: 9.2.0.cl or later Validates the content of your source branch against the objects in your destination environment. Before merging content from your source branch to the destination branch, run this API operation from your destination environment and ensure that the changes from the source branch function in the destination environment. Requires `DATAMANAGEMENT` (**Can manage data**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance on your instance, the `CAN_MANAGE_WORKSHEET_VIEWS_TABLES` (**Can manage data models**) privilege and edit access to the metadata objects. * @param param the request object */ public validateMerge(param: VersionControlApiValidateMergeRequest, options?: Configuration): Promise> { return this.api.validateMerge(param.validateMergeRequest, options).toPromise(); } } import { ObservableWebhooksApi } from "./ObservableAPI"; import { WebhooksApiRequestFactory, WebhooksApiResponseProcessor} from "../apis/WebhooksApi"; export interface WebhooksApiCreateWebhookConfigurationRequest { /** * * @type CreateWebhookConfigurationRequest * @memberof WebhooksApicreateWebhookConfiguration */ createWebhookConfigurationRequest: CreateWebhookConfigurationRequest } export interface WebhooksApiDeleteWebhookConfigurationsRequest { /** * * @type DeleteWebhookConfigurationsRequest * @memberof WebhooksApideleteWebhookConfigurations */ deleteWebhookConfigurationsRequest: DeleteWebhookConfigurationsRequest } export interface WebhooksApiSearchWebhookConfigurationsRequest { /** * * @type SearchWebhookConfigurationsRequest * @memberof WebhooksApisearchWebhookConfigurations */ searchWebhookConfigurationsRequest: SearchWebhookConfigurationsRequest } export interface WebhooksApiUpdateWebhookConfigurationRequest { /** * Unique ID or name of the webhook configuration. * @type string * @memberof WebhooksApiupdateWebhookConfiguration */ webhookIdentifier: string /** * * @type UpdateWebhookConfigurationRequest * @memberof WebhooksApiupdateWebhookConfiguration */ updateWebhookConfigurationRequest: UpdateWebhookConfigurationRequest } export class ObjectWebhooksApi { private api: ObservableWebhooksApi public constructor(configuration: Configuration, requestFactory?: WebhooksApiRequestFactory, responseProcessor?: WebhooksApiResponseProcessor) { this.api = new ObservableWebhooksApi(configuration, requestFactory, responseProcessor); } /** * Version: 10.14.0.cl or later Creates a new webhook configuration to receive notifications for specified events. The webhook will be triggered when the configured events occur in the system. Requires `ADMINISTRATION` (**Can administer ThoughtSpot**) or `DEVELOPER` (**Has developer privilege**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, users with `CAN_MANAGE_WEBHOOKS` (**Can manage webhooks**) privilege are also authorized to perform this action. * @param param the request object */ public createWebhookConfiguration(param: WebhooksApiCreateWebhookConfigurationRequest, options?: Configuration): Promise { return this.api.createWebhookConfiguration(param.createWebhookConfigurationRequest, options).toPromise(); } /** * Version: 10.14.0.cl or later Deletes one or more webhook configurations by their unique id or name. Returns status of each deletion operation, including successfully deleted webhooks and any failures with error details. Requires `ADMINISTRATION` (**Can administer ThoughtSpot**) or `DEVELOPER` (**Has developer privilege**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, users with `CAN_MANAGE_WEBHOOKS` (**Can manage webhooks**) privilege are also authorized to perform this action. * @param param the request object */ public deleteWebhookConfigurations(param: WebhooksApiDeleteWebhookConfigurationsRequest, options?: Configuration): Promise { return this.api.deleteWebhookConfigurations(param.deleteWebhookConfigurationsRequest, options).toPromise(); } /** * Version: 10.14.0.cl or later Searches for webhook configurations based on various criteria such as Org, webhook identifier, event type, with support for pagination and sorting. Returns matching webhook configurations with their complete details. Requires `ADMINISTRATION` (**Can administer ThoughtSpot**) or `DEVELOPER` (**Has developer privilege**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, users with `CAN_MANAGE_WEBHOOKS` (**Can manage webhooks**) privilege are also authorized to perform this action. * @param param the request object */ public searchWebhookConfigurations(param: WebhooksApiSearchWebhookConfigurationsRequest, options?: Configuration): Promise { return this.api.searchWebhookConfigurations(param.searchWebhookConfigurationsRequest, options).toPromise(); } /** * Version: 10.14.0.cl or later Updates an existing webhook configuration by its unique id or name. Only the provided fields will be updated. Requires `ADMINISTRATION` (**Can administer ThoughtSpot**) or `DEVELOPER` (**Has developer privilege**) privilege. If [Role-Based Access Control (RBAC)](https://developers.thoughtspot.com/docs/rbac) is enabled on your instance, users with `CAN_MANAGE_WEBHOOKS` (**Can manage webhooks**) privilege are also authorized to perform this action. * @param param the request object */ public updateWebhookConfiguration(param: WebhooksApiUpdateWebhookConfigurationRequest, options?: Configuration): Promise { return this.api.updateWebhookConfiguration(param.webhookIdentifier, param.updateWebhookConfigurationRequest, options).toPromise(); } }