@looker/sdk
Version:
1,675 lines • 133 kB
TypeScript
import type { IDictionary, DelimArray } from '@looker/sdk-rtl';
export interface IAccessToken {
access_token?: string;
token_type?: string;
expires_in?: number;
refresh_token?: string | null;
}
export interface IAlert {
applied_dashboard_filters?: IAlertAppliedDashboardFilter[] | null;
comparison_type: ComparisonType;
cron: string;
custom_url_base?: string | null;
custom_url_params?: string | null;
custom_url_label?: string | null;
show_custom_url?: boolean;
custom_title?: string | null;
dashboard_element_id?: string | null;
description?: string | null;
destinations: IAlertDestination[] | null;
field: IAlertField;
followed?: boolean;
followable?: boolean;
id?: string;
is_disabled?: boolean;
disabled_reason?: string | null;
is_public?: boolean;
investigative_content_type?: InvestigativeContentType | null;
investigative_content_id?: string | null;
investigative_content_title?: string | null;
lookml_dashboard_id?: string | null;
lookml_link_id?: string | null;
owner_id: string;
owner_display_name?: string | null;
threshold: number;
time_series_condition_state?: IAlertConditionState;
}
export interface IAlertAppliedDashboardFilter {
filter_title: string | null;
field_name: string;
filter_value: string;
filter_description?: string | null;
}
export interface IAlertConditionState {
previous_time_series_id?: string | null;
latest_time_series_id?: string | null;
}
export interface IAlertDestination {
destination_type: DestinationType;
email_address?: string | null;
action_hub_integration_id?: string | null;
action_hub_form_params_json?: string | null;
}
export interface IAlertField {
title: string;
name: string;
filter?: IAlertFieldFilter[] | null;
}
export interface IAlertFieldFilter {
field_name: string;
field_value: any;
filter_value?: string | null;
}
export interface IAlertNotifications {
notification_id?: string;
alert_condition_id?: string;
user_id?: string;
is_read?: boolean;
field_value?: number | null;
threshold_value?: number | null;
ran_at?: string;
alert?: IMobilePayload;
}
export interface IAlertPatch {
owner_id?: string | null;
is_disabled?: boolean | null;
disabled_reason?: string | null;
is_public?: boolean | null;
threshold?: number | null;
}
export declare enum Align {
left = "left",
right = "right"
}
export interface IApiSession {
can?: IDictionary<boolean>;
workspace_id?: string | null;
sudo_user_id?: string | null;
}
export interface IApiVersion {
looker_release_version?: string;
current_version?: IApiVersionElement;
supported_versions?: IApiVersionElement[];
api_server_url?: string;
web_server_url?: string;
}
export interface IApiVersionElement {
version?: string | null;
full_version?: string | null;
status?: string | null;
swagger_url?: string | null;
}
export interface IArtifact {
key: string;
value: string;
content_type?: string | null;
version?: number;
namespace: string;
created_at: Date;
updated_at: Date;
value_size: number;
created_by_userid: string;
updated_by_userid: string;
}
export interface IArtifactNamespace {
namespace: string;
count: number;
}
export interface IArtifactUsage {
max_size: number;
usage: number;
}
export interface IAssertValidatorErrorItem {
assert_error?: IAssertValidatorTestError;
generic_error?: IGenericError;
}
export interface IAssertValidatorResult {
name?: string;
status?: string;
results?: IAssertValidatorTestedExplore[];
}
export interface IAssertValidatorTestedExplore {
error_count?: number | null;
errors?: IAssertValidatorErrorItem[];
success_count?: string;
successes?: IAssertValidatorTestSuccess[];
}
export interface IAssertValidatorTestError {
model?: string;
explore?: string;
test_name?: string;
explore_url?: string;
lookml_url?: string;
message?: string;
}
export interface IAssertValidatorTestSuccess {
model?: string;
explore?: string;
test_name?: string;
explore_url?: string;
lookml_url?: string;
}
export interface IBackupConfiguration {
can?: IDictionary<boolean>;
type?: string | null;
custom_s3_bucket?: string | null;
custom_s3_bucket_region?: string | null;
custom_s3_key?: string | null;
custom_s3_secret?: string | null;
url?: string | null;
}
export interface IBoard {
can?: IDictionary<boolean>;
content_metadata_id?: string | null;
created_at?: Date | null;
deleted_at?: Date | null;
description?: string | null;
board_sections?: IBoardSection[] | null;
id?: string;
section_order?: string[] | null;
title?: string | null;
updated_at?: Date | null;
user_id?: string | null;
primary_homepage?: boolean;
}
export interface IBoardItem {
can?: IDictionary<boolean>;
content_created_by?: string | null;
content_favorite_id?: string | null;
content_metadata_id?: string | null;
content_updated_at?: string | null;
custom_description?: string | null;
custom_title?: string | null;
custom_url?: string | null;
dashboard_id?: string | null;
description?: string | null;
favorite_count?: number | null;
board_section_id?: string | null;
id?: string;
image_url?: string | null;
location?: string | null;
look_id?: string | null;
lookml_dashboard_id?: string | null;
order?: number | null;
title?: string | null;
url?: string;
use_custom_description?: boolean;
use_custom_title?: boolean;
use_custom_url?: boolean;
view_count?: number | null;
custom_image_data_base64?: string | null;
custom_image_url?: string | null;
use_custom_image?: boolean;
}
export interface IBoardSection {
can?: IDictionary<boolean>;
created_at?: Date | null;
deleted_at?: Date | null;
description?: string | null;
board_id?: string | null;
board_items?: IBoardItem[] | null;
id?: string;
item_order?: string[] | null;
visible_item_order?: string[] | null;
title?: string | null;
updated_at?: Date | null;
}
export declare enum Category {
parameter = "parameter",
filter = "filter",
measure = "measure",
dimension = "dimension"
}
export interface ICIChangeRequest {
change_request_number?: number;
change_request_url?: string;
change_request_name?: string;
change_request_commits_url?: string;
}
export interface ICIGitState {
branch?: string | null;
repository?: string | null;
commit_ref?: string | null;
target?: string | null;
}
export interface ICIRun {
run_id?: string;
created_at?: Date;
started_at?: Date | null;
finished_at?: Date | null;
status_url?: string | null;
status?: string;
git_service?: string | null;
git_state?: ICIGitState;
result?: ICIRunResult;
schedule?: ICIScheduleTrigger;
target_branch?: string | null;
title?: string;
trigger?: string;
change_request?: ICIChangeRequest;
suite_id?: string;
username?: string | null;
}
export interface ICIRunResult {
sql_result?: ISqlValidatorResult;
sql_error?: IGenericError;
assert_result?: IAssertValidatorResult;
assert_error?: IGenericError;
content_result?: IContentValidatorResult;
content_error?: IGenericError;
lookml_result?: ILookMLValidatorResult;
lookml_error?: IGenericError;
generic_error?: IGenericError;
}
export interface ICIScheduleTrigger {
enabled?: boolean;
day?: string | null;
hour?: string | null;
frequency?: string;
}
export interface IColorCollection {
id?: string;
label?: string;
categoricalPalettes?: IDiscretePalette[];
sequentialPalettes?: IContinuousPalette[];
divergingPalettes?: IContinuousPalette[];
}
export interface IColorStop {
color?: string;
offset?: number;
}
export interface IColumnSearch {
schema_name?: string | null;
table_name?: string | null;
column_name?: string | null;
data_type?: string | null;
}
export declare enum ComparisonType {
EQUAL_TO = "EQUAL_TO",
GREATER_THAN = "GREATER_THAN",
GREATER_THAN_OR_EQUAL_TO = "GREATER_THAN_OR_EQUAL_TO",
LESS_THAN = "LESS_THAN",
LESS_THAN_OR_EQUAL_TO = "LESS_THAN_OR_EQUAL_TO",
INCREASES_BY = "INCREASES_BY",
DECREASES_BY = "DECREASES_BY",
CHANGES_BY = "CHANGES_BY"
}
export interface IConnectionFeatures {
dialect_name?: string;
cost_estimate?: boolean;
multiple_databases?: boolean;
column_search?: boolean;
persistent_table_indexes?: boolean;
persistent_derived_tables?: boolean;
turtles?: boolean;
percentile?: boolean;
distinct_percentile?: boolean;
stable_views?: boolean;
milliseconds?: boolean;
microseconds?: boolean;
subtotals?: boolean;
location?: boolean;
timezone?: boolean;
connection_pooling?: boolean;
}
export interface IContentFavorite {
id?: string;
user_id?: string;
content_metadata_id?: string;
look_id?: string | null;
dashboard_id?: string | null;
look?: ILookBasic;
dashboard?: IDashboardBase;
board_id?: string | null;
}
export interface IContentMeta {
can?: IDictionary<boolean>;
id?: string;
name?: string | null;
parent_id?: string | null;
dashboard_id?: string | null;
look_id?: string | null;
folder_id?: string | null;
content_type?: string | null;
inherits?: boolean;
inheriting_id?: string | null;
slug?: string | null;
}
export interface IContentMetaGroupUser {
can?: IDictionary<boolean>;
id?: string;
content_metadata_id?: string | null;
permission_type?: PermissionType | null;
group_id?: string | null;
user_id?: string | null;
}
export interface IContentSearch {
can?: IDictionary<boolean>;
content_id?: string | null;
type?: string | null;
title?: string | null;
description?: string | null;
folder_id?: string | null;
folder_name?: string | null;
view_count?: number | null;
preferred_viewer?: string | null;
model?: string | null;
}
export interface IContentSummary {
can?: IDictionary<boolean>;
id?: string;
content_type?: string | null;
content_id?: string | null;
content_slug?: string | null;
content_url?: string | null;
title?: string | null;
description?: string | null;
last_viewed_at?: Date | null;
user_id?: string | null;
user_full_name?: string | null;
is_scheduled?: boolean;
favorite_count?: number | null;
view_count?: number | null;
favorite_id?: string | null;
weighted_score?: number | null;
group_weighted_score?: number | null;
suggestion_score?: number | null;
preferred_viewer?: string | null;
}
export interface IContentValidation {
content_with_errors?: IContentValidatorError[] | null;
computation_time?: number | null;
total_looks_validated?: number | null;
total_dashboard_elements_validated?: number | null;
total_dashboard_filters_validated?: number | null;
total_scheduled_plans_validated?: number | null;
total_alerts_validated?: number | null;
total_explores_validated?: number | null;
}
export interface IContentValidationAlert {
id?: string;
lookml_dashboard_id?: string | null;
lookml_link_id?: string | null;
custom_url_base?: string | null;
custom_url_params?: string | null;
custom_url_label?: string | null;
show_custom_url?: boolean;
custom_title?: string | null;
}
export interface IContentValidationDashboard {
description?: string | null;
id?: string;
folder?: IContentValidationFolder;
title?: string | null;
url?: string | null;
}
export interface IContentValidationDashboardElement {
body_text?: string | null;
dashboard_id?: string | null;
id?: string;
look_id?: string | null;
note_display?: string | null;
note_state?: string | null;
note_text?: string | null;
note_text_as_html?: string | null;
query_id?: string | null;
subtitle_text?: string | null;
title?: string | null;
title_hidden?: boolean;
title_text?: string | null;
type?: string | null;
rich_content_json?: string | null;
extension_id?: string | null;
}
export interface IContentValidationDashboardFilter {
id?: string;
dashboard_id?: string | null;
name?: string | null;
title?: string | null;
type?: string | null;
default_value?: string | null;
model?: string | null;
explore?: string | null;
dimension?: string | null;
}
export interface IContentValidationError {
message?: string | null;
field_name?: string | null;
model_name?: string | null;
explore_name?: string | null;
removable?: boolean;
}
export interface IContentValidationFolder {
name: string;
id?: string;
}
export interface IContentValidationLook {
id?: string;
title?: string | null;
short_url?: string | null;
folder?: IContentValidationFolder;
}
export interface IContentValidationLookMLDashboard {
id?: string;
title?: string | null;
space_id?: string | null;
}
export interface IContentValidationLookMLDashboardElement {
lookml_link_id?: string | null;
title?: string | null;
}
export interface IContentValidationScheduledPlan {
name?: string | null;
look_id?: string | null;
id?: string;
}
export interface IContentValidatorContentError {
type?: string;
title?: string;
detail?: string;
status?: string | null;
instance?: string | null;
model?: string | null;
explore?: string | null;
field_name?: string;
content_type?: string;
folder?: string | null;
url?: string;
tile_type?: string | null;
tile_title?: string | null;
message?: string;
}
export interface IContentValidatorError {
look?: IContentValidationLook;
dashboard?: IContentValidationDashboard;
dashboard_element?: IContentValidationDashboardElement;
dashboard_filter?: IContentValidationDashboardFilter;
scheduled_plan?: IContentValidationScheduledPlan;
alert?: IContentValidationAlert;
lookml_dashboard?: IContentValidationLookMLDashboard;
lookml_dashboard_element?: IContentValidationLookMLDashboardElement;
errors?: IContentValidationError[] | null;
id?: string;
}
export interface IContentValidatorErrorItem {
content_error?: IContentValidatorContentError;
generic_error?: IGenericError;
}
export interface IContentValidatorResult {
name?: string;
incremental?: boolean;
status?: string;
result?: IContentValidatorTestedExplore[];
}
export interface IContentValidatorTestedExplore {
error_count?: number | null;
errors?: IContentValidatorErrorItem[];
}
export interface IContentView {
can?: IDictionary<boolean>;
id?: string;
look_id?: string | null;
dashboard_id?: string | null;
title?: string | null;
content_metadata_id?: string | null;
user_id?: string | null;
group_id?: string | null;
view_count?: number | null;
favorite_count?: number | null;
last_viewed_at?: string | null;
start_of_week_date?: string | null;
}
export interface IContinuousPalette {
id?: string;
label?: string | null;
type?: string;
stops?: IColorStop[];
}
export interface ICostEstimate {
cost?: number;
cache_hit?: boolean;
cost_unit?: string;
message?: string;
}
export interface ICreateCIRunRequest {
suite_id?: string;
branch?: string | null;
commit?: string | null;
}
export interface ICreateCIRunResponse {
run_id?: string;
status?: string;
}
export interface ICreateCostEstimate {
sql?: string;
}
export interface ICreateCredentialsApi3 {
can?: IDictionary<boolean>;
id?: string;
client_id?: string | null;
created_at?: string | null;
is_disabled?: boolean;
type?: string | null;
client_secret?: string | null;
url?: string | null;
}
export interface ICreateDashboardFilter {
id?: string;
dashboard_id: string | null;
name: string | null;
title: string | null;
type: string | null;
default_value?: string | null;
model?: string | null;
explore?: string | null;
dimension?: string | null;
field?: IDictionary<any> | null;
row?: number | null;
listens_to_filters?: string[] | null;
allow_multiple_values?: boolean;
required?: boolean;
ui_config?: IDictionary<any> | null;
}
export interface ICreateDashboardRenderTask {
dashboard_filters?: string | null;
dashboard_style?: string | null;
}
export interface ICreateEmbedUserRequest {
external_user_id: string;
}
export interface ICreateFolder {
name: string;
parent_id: string;
}
export interface ICreateOAuthApplicationUserStateRequest {
user_id: string;
oauth_application_id: string;
access_token: string;
access_token_expires_at: Date;
refresh_token?: string | null;
refresh_token_expires_at?: Date | null;
}
export interface ICreateOAuthApplicationUserStateResponse {
user_id: string;
oauth_application_id: string;
}
export interface ICreateQueryTask {
can?: IDictionary<boolean>;
query_id: string | null;
result_format: ResultFormat | null;
source?: string | null;
deferred?: boolean;
look_id?: string | null;
dashboard_id?: string | null;
}
export interface ICredentialsApi3 {
can?: IDictionary<boolean>;
id?: string;
client_id?: string | null;
created_at?: string | null;
is_disabled?: boolean;
type?: string | null;
url?: string | null;
}
export interface ICredentialsEmail {
can?: IDictionary<boolean>;
created_at?: string | null;
email?: string | null;
forced_password_reset_at_next_login?: boolean;
user_id?: string | null;
is_disabled?: boolean;
logged_in_at?: string | null;
password_reset_url?: string | null;
account_setup_url?: string | null;
password_reset_url_expired?: boolean;
account_setup_url_expired?: boolean;
type?: string | null;
url?: string | null;
user_url?: string | null;
}
export interface ICredentialsEmailSearch {
can?: IDictionary<boolean>;
created_at?: string | null;
email?: string | null;
forced_password_reset_at_next_login?: boolean;
user_id?: string | null;
is_disabled?: boolean;
logged_in_at?: string | null;
password_reset_url?: string | null;
account_setup_url?: string | null;
password_reset_url_expired?: boolean;
account_setup_url_expired?: boolean;
type?: string | null;
url?: string | null;
user_url?: string | null;
}
export interface ICredentialsEmbed {
can?: IDictionary<boolean>;
created_at?: string | null;
external_group_id?: string | null;
external_user_id?: string | null;
id?: string;
is_disabled?: boolean;
logged_in_at?: string | null;
type?: string | null;
url?: string | null;
}
export interface ICredentialsGoogle {
can?: IDictionary<boolean>;
created_at?: string | null;
domain?: string | null;
email?: string | null;
google_user_id?: string | null;
is_disabled?: boolean;
logged_in_at?: string | null;
type?: string | null;
url?: string | null;
}
export interface ICredentialsLDAP {
can?: IDictionary<boolean>;
created_at?: string | null;
email?: string | null;
is_disabled?: boolean;
ldap_dn?: string | null;
ldap_id?: string | null;
logged_in_at?: string | null;
type?: string | null;
url?: string | null;
}
export interface ICredentialsLookerOpenid {
can?: IDictionary<boolean>;
created_at?: string | null;
email?: string | null;
is_disabled?: boolean;
logged_in_at?: string | null;
logged_in_ip?: string | null;
type?: string | null;
url?: string | null;
user_url?: string | null;
}
export interface ICredentialsOIDC {
can?: IDictionary<boolean>;
created_at?: string | null;
email?: string | null;
is_disabled?: boolean;
logged_in_at?: string | null;
oidc_user_id?: string | null;
type?: string | null;
url?: string | null;
}
export interface ICredentialsSaml {
can?: IDictionary<boolean>;
created_at?: string | null;
email?: string | null;
is_disabled?: boolean;
logged_in_at?: string | null;
saml_user_id?: string | null;
type?: string | null;
url?: string | null;
}
export interface ICredentialsTotp {
can?: IDictionary<boolean>;
created_at?: string | null;
is_disabled?: boolean;
type?: string | null;
verified?: boolean;
url?: string | null;
}
export interface ICustomWelcomeEmail {
enabled?: boolean;
content?: string | null;
subject?: string | null;
header?: string | null;
}
export interface IDashboard {
can?: IDictionary<boolean>;
content_favorite_id?: string | null;
content_metadata_id?: string | null;
description?: string | null;
hidden?: boolean;
id?: string;
model?: ILookModel;
query_timezone?: string | null;
readonly?: boolean;
refresh_interval?: string | null;
refresh_interval_to_i?: number | null;
folder?: IFolderBase;
title?: string | null;
user_id?: string | null;
slug?: string | null;
preferred_viewer?: string | null;
alert_sync_with_dashboard_filter_enabled?: boolean;
background_color?: string | null;
created_at?: Date | null;
crossfilter_enabled?: boolean;
dashboard_elements?: IDashboardElement[] | null;
dashboard_filters?: IDashboardFilter[] | null;
dashboard_layouts?: IDashboardLayout[] | null;
deleted?: boolean;
deleted_at?: Date | null;
deleter_id?: string | null;
edit_uri?: string | null;
enable_viz_full_screen?: boolean;
favorite_count?: number | null;
filters_bar_collapsed?: boolean;
filters_location_top?: boolean;
last_accessed_at?: Date | null;
last_viewed_at?: Date | null;
updated_at?: Date | null;
last_updater_id?: string | null;
last_updater_name?: string | null;
user_name?: string | null;
load_configuration?: string | null;
lookml_link_id?: string | null;
show_filters_bar?: boolean | null;
show_title?: boolean | null;
folder_id?: string | null;
text_tile_text_color?: string | null;
tile_background_color?: string | null;
tile_text_color?: string | null;
title_color?: string | null;
view_count?: number | null;
appearance?: IDashboardAppearance;
url?: string | null;
}
export interface IDashboardAggregateTableLookml {
dashboard_id?: string | null;
aggregate_table_lookml?: string | null;
}
export interface IDashboardAppearance {
page_side_margins?: number | null;
page_background_color?: string | null;
tile_title_alignment?: string | null;
tile_space_between?: number | null;
tile_background_color?: string | null;
tile_shadow?: boolean | null;
key_color?: string | null;
}
export interface IDashboardBase {
can?: IDictionary<boolean>;
content_favorite_id?: string | null;
content_metadata_id?: string | null;
description?: string | null;
hidden?: boolean;
id?: string;
model?: ILookModel;
query_timezone?: string | null;
readonly?: boolean;
refresh_interval?: string | null;
refresh_interval_to_i?: number | null;
folder?: IFolderBase;
title?: string | null;
user_id?: string | null;
slug?: string | null;
preferred_viewer?: string | null;
}
export interface IDashboardElement {
can?: IDictionary<boolean>;
body_text?: string | null;
body_text_as_html?: string | null;
dashboard_id?: string | null;
edit_uri?: string | null;
id?: string;
look?: ILookWithQuery;
look_id?: string | null;
lookml_link_id?: string | null;
merge_result_id?: string | null;
note_display?: string | null;
note_state?: string | null;
note_text?: string | null;
note_text_as_html?: string | null;
query?: IQuery;
query_id?: string | null;
refresh_interval?: string | null;
refresh_interval_to_i?: number | null;
result_maker?: IResultMakerWithIdVisConfigAndDynamicFields;
result_maker_id?: string | null;
subtitle_text?: string | null;
title?: string | null;
title_hidden?: boolean;
title_text?: string | null;
type?: string | null;
alert_count?: number | null;
rich_content_json?: string | null;
title_text_as_html?: string | null;
subtitle_text_as_html?: string | null;
extension_id?: string | null;
}
export interface IDashboardFilter {
can?: IDictionary<boolean>;
id?: string;
dashboard_id?: string | null;
name?: string | null;
title?: string | null;
type?: string | null;
default_value?: string | null;
model?: string | null;
explore?: string | null;
dimension?: string | null;
field?: IDictionary<any> | null;
row?: number | null;
listens_to_filters?: string[] | null;
allow_multiple_values?: boolean;
required?: boolean;
ui_config?: IDictionary<any> | null;
}
export interface IDashboardLayout {
can?: IDictionary<boolean>;
id?: string;
dashboard_id?: string | null;
type?: string | null;
active?: boolean;
column_width?: number | null;
width?: number | null;
deleted?: boolean;
dashboard_title?: string | null;
dashboard_layout_components?: IDashboardLayoutComponent[] | null;
}
export interface IDashboardLayoutComponent {
can?: IDictionary<boolean>;
id?: string;
dashboard_layout_id?: string | null;
dashboard_element_id?: string | null;
row?: number | null;
column?: number | null;
width?: number | null;
height?: number | null;
deleted?: boolean;
element_title?: string | null;
element_title_hidden?: boolean;
vis_type?: string | null;
}
export interface IDashboardLookml {
dashboard_id?: string | null;
folder_id?: string | null;
lookml?: string | null;
}
export interface IDataActionForm {
state?: IDataActionUserState;
fields?: IDataActionFormField[] | null;
}
export interface IDataActionFormField {
name?: string | null;
label?: string | null;
description?: string | null;
type?: string | null;
default?: string | null;
oauth_url?: string | null;
interactive?: boolean;
required?: boolean;
options?: IDataActionFormSelectOption[] | null;
}
export interface IDataActionFormSelectOption {
name?: string | null;
label?: string | null;
}
export interface IDataActionRequest {
action?: IDictionary<any> | null;
form_values?: IDictionary<string> | null;
}
export interface IDataActionResponse {
webhook_id?: string | null;
success?: boolean;
refresh_query?: boolean;
validation_errors?: IValidationError;
message?: string | null;
}
export interface IDataActionUserState {
data?: string | null;
refresh_time?: number | null;
}
export interface IDatagroup {
can?: IDictionary<boolean>;
created_at?: number | null;
id?: string;
model_name?: string | null;
name?: string | null;
stale_before?: number | null;
trigger_check_at?: number | null;
trigger_error?: string | null;
trigger_value?: string | null;
triggered_at?: number | null;
}
export interface IDBConnection {
can?: IDictionary<boolean>;
name?: string;
dialect?: IDialect;
snippets?: ISnippet[];
pdts_enabled?: boolean;
named_driver_version_requested?: string | null;
named_driver_version_actual?: string | null;
host?: string | null;
port?: string | null;
username?: string | null;
password?: string | null;
uses_oauth?: boolean;
uses_key_pair_auth?: boolean;
uses_instance_oauth?: boolean;
certificate?: string | null;
file_type?: string | null;
database?: string | null;
db_timezone?: string | null;
query_timezone?: string | null;
schema?: string | null;
max_connections?: number | null;
max_queries?: number | null;
max_queries_per_user?: number | null;
max_billing_gigabytes?: string | null;
ssl?: boolean;
verify_ssl?: boolean;
tmp_db_name?: string | null;
tmp_db_host?: string | null;
jdbc_additional_params?: string | null;
pool_timeout?: number | null;
dialect_name?: string | null;
supports_data_studio_link?: boolean;
created_at?: string | null;
user_id?: string | null;
example?: boolean;
user_db_credentials?: boolean | null;
user_attribute_fields?: string[] | null;
maintenance_cron?: string | null;
last_regen_at?: string | null;
last_reap_at?: string | null;
sql_runner_precache_tables?: boolean;
sql_writing_with_info_schema?: boolean;
after_connect_statements?: string | null;
pdt_context_override?: IDBConnectionOverride;
managed?: boolean;
custom_local_port?: number | null;
tunnel_id?: string | null;
uses_tns?: boolean | null;
pdt_concurrency?: number | null;
disable_context_comment?: boolean | null;
oauth_application_id?: string | null;
always_retry_failed_builds?: boolean | null;
uses_application_default_credentials?: boolean | null;
impersonated_service_account?: string | null;
cost_estimate_enabled?: boolean | null;
pdt_api_control_enabled?: boolean | null;
connection_pooling?: boolean;
default_bq_connection?: boolean;
bq_storage_project_id?: string | null;
bq_roles_verified?: boolean | null;
p4sa_name?: string | null;
query_holding_disabled?: boolean;
}
export interface IDBConnectionBase {
can?: IDictionary<boolean>;
name?: string;
dialect?: IDialect;
snippets?: ISnippet[];
pdts_enabled?: boolean;
}
export interface IDBConnectionOverride {
context?: string;
host?: string | null;
pdt_host?: string | null;
port?: string | null;
pdt_port?: string | null;
username?: string | null;
pdt_username?: string | null;
password?: string | null;
pdt_password?: string | null;
has_password?: boolean;
certificate?: string | null;
pdt_certificate?: string | null;
file_type?: string | null;
pdt_file_type?: string | null;
database?: string | null;
pdt_database?: string | null;
schema?: string | null;
pdt_schema?: string | null;
jdbc_additional_params?: string | null;
pdt_jdbc_additional_params?: string | null;
after_connect_statements?: string | null;
pdt_after_connect_statements?: string | null;
}
export interface IDBConnectionTestResult {
can?: IDictionary<boolean>;
connection_string?: string | null;
message?: string | null;
name?: string | null;
status?: string | null;
}
export interface IDelegateOauthTest {
name?: string;
installation_target_id?: string;
installation_id?: string;
success?: boolean;
}
export interface IDependencyGraph {
graph_text?: string;
}
export declare enum DependencyStatus {
lock_optional = "lock_optional",
lock_required = "lock_required",
lock_error = "lock_error",
install_none = "install_none"
}
export declare enum DestinationType {
EMAIL = "EMAIL",
ACTION_HUB = "ACTION_HUB"
}
export declare enum DeviceType {
android = "android",
ios = "ios"
}
export interface IDialect {
name?: string;
label?: string;
supports_cost_estimate?: boolean;
cost_estimate_style?: string | null;
persistent_table_indexes?: string;
persistent_table_sortkeys?: string;
persistent_table_distkey?: string;
supports_streaming?: boolean;
automatically_run_sql_runner_snippets?: boolean;
connection_tests?: string[];
supports_inducer?: boolean;
supports_multiple_databases?: boolean;
supports_persistent_derived_tables?: boolean;
has_ssl_support?: boolean;
}
export interface IDialectDriverNamesVersion {
name?: string | null;
display_name?: string | null;
}
export interface IDialectInfo {
can?: IDictionary<boolean>;
default_max_connections?: string | null;
default_port?: string | null;
default_max_queries?: string | null;
default_max_queries_per_user?: string | null;
installed?: boolean;
label?: string | null;
label_for_database_equivalent?: string | null;
label_for_schema_equivalent?: string | null;
name?: string | null;
supported_driver_name?: string | null;
supported_driver_versions?: IDialectDriverNamesVersion[] | null;
supported_options?: IDialectInfoOptions;
}
export interface IDialectInfoOptions {
additional_params?: boolean;
after_connect_statements?: boolean;
analytical_view_dataset?: boolean;
auth?: boolean;
cost_estimate?: boolean;
disable_context_comment?: boolean;
host?: boolean;
instance_name?: boolean;
max_billing_gigabytes?: boolean;
oauth_credentials?: boolean;
pdts_for_oauth?: boolean;
port?: boolean;
project_name?: boolean;
schema?: boolean;
service_account_credentials?: boolean;
ssl?: boolean;
timezone?: boolean;
tmp_table?: boolean;
tns?: boolean;
username?: boolean;
username_required?: boolean;
supports_connection_pooling?: boolean;
}
export interface IDigestEmails {
is_enabled?: boolean;
}
export interface IDigestEmailSend {
configuration_delivered?: boolean;
}
export interface IDiscretePalette {
id?: string;
label?: string | null;
type?: string;
colors?: string[];
}
export interface IEgressIpAddresses {
egress_ip_addresses?: string[] | null;
}
export interface IEmbedConfig {
domain_allowlist?: string[] | null;
alert_url_allowlist?: string[] | null;
alert_url_param_owner?: string | null;
alert_url_label?: string | null;
sso_auth_enabled?: boolean;
embed_cookieless_v2?: boolean;
embed_content_navigation?: boolean;
embed_content_management?: boolean;
strict_sameorigin_for_login?: boolean;
look_filters?: boolean;
hide_look_navigation?: boolean;
embed_enabled?: boolean;
}
export interface IEmbedCookielessSessionAcquire {
session_length?: number | null;
force_logout_login?: boolean;
external_user_id?: string | null;
first_name?: string | null;
last_name?: string | null;
user_timezone?: string | null;
permissions?: string[] | null;
models?: string[] | null;
group_ids?: string[] | null;
external_group_id?: string | null;
user_attributes?: IDictionary<any> | null;
embed_domain?: string | null;
session_reference_token?: string | null;
}
export interface IEmbedCookielessSessionAcquireResponse {
authentication_token?: string | null;
authentication_token_ttl?: number | null;
navigation_token?: string | null;
navigation_token_ttl?: number | null;
api_token?: string | null;
api_token_ttl?: number | null;
session_reference_token?: string | null;
session_reference_token_ttl?: number | null;
}
export interface IEmbedCookielessSessionGenerateTokens {
session_reference_token: string;
navigation_token?: string | null;
api_token?: string | null;
}
export interface IEmbedCookielessSessionGenerateTokensResponse {
navigation_token?: string | null;
navigation_token_ttl?: number | null;
api_token?: string | null;
api_token_ttl?: number | null;
session_reference_token: string;
session_reference_token_ttl?: number | null;
}
export interface IEmbedParams {
target_url: string;
session_length?: number | null;
force_logout_login?: boolean;
}
export interface IEmbedSecret {
algorithm?: string | null;
created_at?: string | null;
enabled?: boolean;
id?: string;
secret?: string | null;
user_id?: string | null;
secret_type?: SecretType;
}
export interface IEmbedSsoParams {
target_url: string;
session_length?: number | null;
force_logout_login?: boolean;
external_user_id?: string | null;
first_name?: string | null;
last_name?: string | null;
user_timezone?: string | null;
permissions?: string[] | null;
models?: string[] | null;
group_ids?: string[] | null;
external_group_id?: string | null;
user_attributes?: IDictionary<any> | null;
secret_id?: string | null;
embed_domain?: string | null;
}
export interface IEmbedUrlResponse {
url?: string;
}
export interface IError {
message: string | null;
documentation_url: string | null;
}
export interface IExternalOauthApplication {
can?: IDictionary<boolean>;
id?: string;
name?: string;
client_id?: string;
client_secret?: string;
tenant_id?: string | null;
dialect_name?: string | null;
created_at?: Date;
}
export declare enum FillStyle {
enumeration = "enumeration",
range = "range"
}
export interface IFolder {
name: string;
parent_id?: string | null;
id?: string;
content_metadata_id?: string | null;
created_at?: Date | null;
creator_id?: string | null;
child_count?: number | null;
external_id?: string | null;
is_embed?: boolean;
is_embed_shared_root?: boolean;
is_embed_users_root?: boolean;
is_personal?: boolean;
is_personal_descendant?: boolean;
is_shared_root?: boolean;
is_users_root?: boolean;
can?: IDictionary<boolean>;
dashboards?: IDashboardBase[] | null;
looks?: ILookWithDashboards[] | null;
}
export interface IFolderBase {
name: string;
parent_id?: string | null;
id?: string;
content_metadata_id?: string | null;
created_at?: Date | null;
creator_id?: string | null;
child_count?: number | null;
external_id?: string | null;
is_embed?: boolean;
is_embed_shared_root?: boolean;
is_embed_users_root?: boolean;
is_personal?: boolean;
is_personal_descendant?: boolean;
is_shared_root?: boolean;
is_users_root?: boolean;
can?: IDictionary<boolean>;
}
export declare enum Format {
topojson = "topojson",
vector_tile_region = "vector_tile_region"
}
export interface IGenericError {
type?: string;
title?: string;
detail?: string;
status?: string | null;
instance?: string | null;
}
export interface IGitBranch {
can?: IDictionary<boolean>;
name?: string | null;
remote?: string | null;
remote_name?: string | null;
error?: string | null;
message?: string | null;
owner_name?: string | null;
readonly?: boolean;
personal?: boolean;
is_local?: boolean;
is_remote?: boolean;
is_production?: boolean;
ahead_count?: number | null;
behind_count?: number | null;
commit_at?: number | null;
ref?: string | null;
remote_ref?: string | null;
}
export interface IGitConnectionTest {
can?: IDictionary<boolean>;
description?: string | null;
id?: string;
}
export interface IGitConnectionTestResult {
can?: IDictionary<boolean>;
id?: string;
message?: string | null;
status?: string | null;
}
export interface IGitStatus {
action?: string | null;
conflict?: boolean;
revertable?: boolean;
text?: string | null;
}
export interface IGroup {
can?: IDictionary<boolean>;
can_add_to_content_metadata?: boolean;
contains_current_user?: boolean;
external_group_id?: string | null;
externally_managed?: boolean;
id?: string;
include_by_default?: boolean;
name?: string | null;
user_count?: number | null;
}
export interface IGroupHierarchy {
can?: IDictionary<boolean>;
can_add_to_content_metadata?: boolean;
contains_current_user?: boolean;
external_group_id?: string | null;
externally_managed?: boolean;
id?: string;
include_by_default?: boolean;
name?: string | null;
user_count?: number | null;
parent_group_ids?: string[] | null;
role_ids?: string[] | null;
}
export interface IGroupIdForGroupInclusion {
group_id?: string | null;
}
export interface IGroupIdForGroupUserInclusion {
user_id?: string | null;
}
export interface IGroupSearch {
can?: IDictionary<boolean>;
can_add_to_content_metadata?: boolean;
contains_current_user?: boolean;
external_group_id?: string | null;
externally_managed?: boolean;
id?: string;
include_by_default?: boolean;
name?: string | null;
user_count?: number | null;
roles?: IRole[] | null;
}
export interface IHomepageItem {
can?: IDictionary<boolean>;
content_created_by?: string | null;
content_favorite_id?: string | null;
content_metadata_id?: string | null;
content_updated_at?: string | null;
custom_description?: string | null;
custom_image_data_base64?: string | null;
custom_image_url?: string | null;
custom_title?: string | null;
custom_url?: string | null;
dashboard_id?: string | null;
description?: string | null;
favorite_count?: number | null;
homepage_section_id?: string | null;
id?: string;
image_url?: string | null;
location?: string | null;
look_id?: string | null;
lookml_dashboard_id?: string | null;
order?: number | null;
section_fetch_time?: number | null;
title?: string | null;
url?: string | null;
use_custom_description?: boolean;
use_custom_image?: boolean;
use_custom_title?: boolean;
use_custom_url?: boolean;
view_count?: number | null;
}
export interface IHomepageSection {
can?: IDictionary<boolean>;
created_at?: Date | null;
deleted_at?: Date | null;
detail_url?: string | null;
homepage_id?: string | null;
homepage_items?: IHomepageItem[] | null;
id?: string;
is_header?: boolean;
item_order?: string[] | null;
title?: string | null;
updated_at?: Date | null;
description?: string | null;
visible_item_order?: string[] | null;
}
export interface IImportedProject {
name?: string | null;
url?: string | null;
ref?: string | null;
is_remote?: boolean;
}
export interface IInstanceConfig {
feature_flags?: IDictionary<boolean>;
license_features?: IDictionary<boolean>;
}
export interface IIntegration {
can?: IDictionary<boolean>;
id?: string;
integration_hub_id?: string;
label?: string;
description?: string | null;
enabled?: boolean;
params?: IIntegrationParam[];
supported_formats?: SupportedFormats[];
supported_action_types?: SupportedActionTypes[];
supported_formattings?: SupportedFormattings[];
supported_visualization_formattings?: SupportedVisualizationFormattings[];
supported_download_settings?: SupportedDownloadSettings[];
icon_url?: string | null;
uses_oauth?: boolean | null;
required_fields?: IIntegrationRequiredField[];
privacy_link?: string | null;
delegate_oauth?: boolean | null;
installed_delegate_oauth_targets?: string[];
}
export interface IIntegrationHub {
can?: IDictionary<boolean>;
id?: string;
url?: string;
label?: string;
official?: boolean;
fetch_error_message?: string | null;
authorization_token?: string | null;
has_authorization_token?: boolean;
legal_agreement_signed?: boolean;
legal_agreement_required?: boolean;
legal_agreement_text?: string | null;
}
export interface IIntegrationParam {
name?: string | null;
label?: string | null;
description?: string | null;
required?: boolean;
has_value?: boolean;
value?: string | null;
user_attribute_name?: string | null;
sensitive?: boolean | null;
per_user?: boolean;
delegate_oauth_url?: string | null;
}
export interface IIntegrationRequiredField {
tag?: string | null;
any_tag?: string[] | null;
all_tags?: string[] | null;
}
export interface IIntegrationTestResult {
success?: boolean;
message?: string | null;
delegate_oauth_result?: IDelegateOauthTest[] | null;
}
export interface IInternalHelpResources {
can?: IDictionary<boolean>;
enabled?: boolean;
}
export interface IInternalHelpResourcesContent {
can?: IDictionary<boolean>;
organization_name?: string | null;
markdown_content?: string | null;
}
export declare enum InvestigativeContentType {
dashboard = "dashboard"
}
export interface IJsonBi {
metadata: IJsonBiMetadata;
rows: string[];
}
export interface IJsonBiBigQueryMetadata {
total_bytes_processed: number;
backend_cache_hit: boolean;
}
export interface IJsonBiField {
sql: string | null;
view: string;
dimension_group: string | null;
category: string;
field_group_label: string | null;
name: string;
type: string;
view_label: string | null;
label: string;
field_group_variant: string;
hidden: boolean;
description: string | null;
}
export interface IJsonBiFields {
dimensions: IJsonBiField[];
measures: IJsonBiField[];
pivots: IJsonBiField[];
table_calculations: IJsonBiTableCalc[];
}
export interface IJsonBiMetadata {
big_query_metadata: IJsonBiBigQueryMetadata;
fields: IJsonBiFields;
pivots: IJsonBiPivots[];
has_subtotals: boolean;
has_totals: boolean;
columns_truncated: string;
filter_expression: string | null;
filters: IDictionary<string>;
sql: string | null;
}
export interface IJsonBiPivots {
key: string;
data: IDictionary<string>;
sort_values: IDictionary<string>;
is_total: boolean;
}
export interface IJsonBiTableCalc {
name: string | null;
label: string | null;
align: string | null;
expression: string | null;
value_format: string | null;
measure: boolean | null;
}
export declare enum Kind {
previous = "previous",
difference = "difference",
relative_change = "relative_change"
}
export interface ILDAPConfig {
can?: IDictionary<boolean>;
alternate_email_login_allowed?: boolean;
auth_password?: string | null;
auth_requires_role?: boolean;
auth_username?: string | null;
connection_host?: string | null;
connection_port?: string | null;
connection_tls?: boolean;
connection_tls_no_verify?: boolean;
default_new_user_group_ids?: string[] | null;
default_new_user_groups?: IGroup[] | null;
default_new_user_role_ids?: string[] | null;
default_new_user_roles?: IRole[] | null;
enabled?: boolean;
force_no_page?: boolean;
groups?: ILDAPGroupRead[] | null;
groups_base_dn?: string | null;
groups_finder_type?: string | null;
groups_member_attribute?: string | null;
groups_objectclasses?: string | null;
groups_user_attribute?: string | null;
groups_with_role_ids?: ILDAPGroupWrite[] | null;
has_auth_password?: boolean;
merge_new_users_by_email?: boolean;
modified_at?: string | null;
modified_by?: string | null;
set_roles_from_groups?: boolean;
test_ldap_password?: string | null;
test_ldap_user?: string | null;
user_attribute_map_email?: string | null;
user_attribute_map_first_name?: string | null;
user_attribute_map_last_name?: string | null;
user_attribute_map_ldap_id?: string | null;
user_attributes?: ILDAPUserAttributeRead[] | null;
user_attributes_with_ids?: ILDAPUserAttributeWrite[] | null;
user_bind_base_dn?: string | null;
user_custom_filter?: string | null;
user_id_attribute_names?: string | null;
user_objectclass?: string | null;
allow_normal_group_membership?: boolean;
allow_roles_from_normal_groups?: boolean;
allow_direct_roles?: boolean;
url?: string | null;
}
export interface ILDAPConfigTestIssue {
severity?: string | null;
message?: string | null;
}
export interface ILDAPConfigTestResult {
details?: string | null;
issues?: ILDAPConfigTestIssue[] | null;
message?: string | null;
status?: string | null;
trace?: string | null;
user?: ILDAPUser;
url?: string | null;
}
export interface ILDAPGroupRead {
id?: string;
looker_group_id?: string | null;
looker_group_name?: string | null;
name?: string | null;
roles?: IRole[] | null;
url?: string | null;
}
export interface ILDAPGroupWrite {
id?: string | null;
looker_group_id?: string | null;
looker_group_name?: string | null;
name?: string | null;
role_ids?: string[] | null;
url?: string | null;
}
export interface ILDAPUser {
all_emails?: string[] | null;
attributes?: IDictionary<string> | null;
email?: string | null;
first_name?: string | null;
groups?: string[] | null;
last_name?: string | null;
ldap_dn?: string | null;
ldap_id?: string | null;
roles?: string[] | null;
url?: string | null;
}
export interface ILDAPUserAttributeRead {
name?: string | null;
required?: boolean;
user_attributes?: IUserAttribute[] | null;
url?: string | null;
}
export interface ILDAPUserAttributeWrite {
name?: string | null;
required?: boolean;
user_attribute_ids?: string[] | null;
url?: string | null;
}
export interface ILegacyFeature {
can?: IDictionary<boolean>;
id?: string;
name?: string | null;
description?: string | null;
enabled_locally?: boolean;
enabled?: boolean;
disallowed_as_of_version?: string | null;
disable_on_upgrade_to_version?: string | null;
end_of_life_version?: string | null;
documentation_url?: string | null;
approximate_disable_date?: Date | null;
approximate_end_of_life_date?: Date | null;
has_disabled_on_upgrade?: boolean;
}
export interface ILocale {
code?: string | null;
native_name?: string | null;
english_name?: string | null;
}
export interface ILocalizationSettings {
default_locale?: string | null;
localization_level?: string | null;
}
export interface ILook {
can?: IDictionary<boolean>;
content_metadata_id?: string | null;
id?: string;
title?: string | null;
user_id?: string | null;
content_favorite_id?: string | null;
created_at?: Date | null;
deleted?: boolean;
deleted_at?: Date | null;
deleter_id?: string | null;
description?: strin