@looker/sdk 24.16.1 → 24.18.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,5 +1,5 @@
1
1
  import type { DelimArray, IDictionary, IAPIMethods, ITransportSettings, SDKResponse } from '@looker/sdk-rtl';
2
- import type { IAccessToken, IAlert, IAlertNotifications, IAlertPatch, IApiSession, IApiVersion, IArtifact, IArtifactNamespace, IArtifactUsage, IBackupConfiguration, IBoard, IBoardItem, IBoardSection, IColorCollection, IColumnSearch, IConnectionFeatures, IContentFavorite, IContentMeta, IContentMetaGroupUser, IContentSearch, IContentSummary, IContentValidation, IContentView, ICostEstimate, ICreateCostEstimate, ICreateCredentialsApi3, ICreateEmbedUserRequest, ICreateFolder, ICreateOAuthApplicationUserStateRequest, ICreateOAuthApplicationUserStateResponse, ICredentialsApi3, ICredentialsEmail, ICredentialsEmailSearch, ICredentialsEmbed, ICredentialsGoogle, ICredentialsLDAP, ICredentialsLookerOpenid, ICredentialsOIDC, ICredentialsSaml, ICredentialsTotp, ICustomWelcomeEmail, IDashboard, IDashboardAggregateTableLookml, IDashboardBase, IDashboardElement, IDashboardFilter, IDashboardLayout, IDashboardLayoutComponent, IDashboardLookml, IDataActionForm, IDataActionRequest, IDataActionResponse, IDatagroup, IDBConnection, IDBConnectionTestResult, IDependencyGraph, IDialectInfo, IDigestEmails, IDigestEmailSend, IEgressIpAddresses, IEmbedCookielessSessionAcquire, IEmbedCookielessSessionAcquireResponse, IEmbedCookielessSessionGenerateTokens, IEmbedCookielessSessionGenerateTokensResponse, IEmbedParams, IEmbedSecret, IEmbedSsoParams, IEmbedUrlResponse, IError, IExternalOauthApplication, IFolder, IGitBranch, IGitConnectionTest, IGitConnectionTestResult, IGroup, IGroupHierarchy, IGroupIdForGroupInclusion, IGroupIdForGroupUserInclusion, IGroupSearch, IHomepageSection, IIntegration, IIntegrationHub, IIntegrationTestResult, IInternalHelpResources, IInternalHelpResourcesContent, ILDAPConfig, ILDAPConfigTestResult, ILegacyFeature, ILocale, ILook, ILookmlModel, ILookmlModelExplore, ILookmlTest, ILookmlTestResult, ILookWithQuery, IManifest, IMaterializePDT, IMergeQuery, IMobileSettings, IMobileToken, IModel, IModelFieldSuggestions, IModelSet, IOauthClientApp, IOIDCConfig, IPasswordConfig, IPermission, IPermissionSet, IProject, IProjectFile, IProjectValidation, IProjectValidationCache, IProjectWorkspace, IQuery, IQueryFormats, IQueryTask, IRenderTask, IRepositoryCredential, IRequestActiveThemes, IRequestAlertNotifications, IRequestAllBoardItems, IRequestAllBoardSections, IRequestAllExternalOauthApplications, IRequestAllGroups, IRequestAllGroupUsers, IRequestAllIntegrations, IRequestAllLookmlModels, IRequestAllRoles, IRequestAllScheduledPlans, IRequestAllUserAttributes, IRequestAllUsers, IRequestArtifact, IRequestArtifactNamespaces, IRequestConnectionColumns, IRequestConnectionSchemas, IRequestConnectionSearchColumns, IRequestConnectionTables, IRequestContentSummary, IRequestContentThumbnail, IRequestCreateDashboardElement, IRequestCreateDashboardRenderTask, IRequestCreateQueryTask, IRequestCreateUserCredentialsEmailPasswordReset, IRequestDeployRefToProduction, IRequestFolderChildren, IRequestFolderChildrenSearch, IRequestGraphDerivedTablesForModel, IRequestGraphDerivedTablesForView, IRequestLogin, IRequestLookmlModelExplore, IRequestModelFieldnameSuggestions, IRequestRoleUsers, IRequestRunGitConnectionTest, IRequestRunInlineQuery, IRequestRunLook, IRequestRunLookmlTest, IRequestRunQuery, IRequestScheduledPlansForDashboard, IRequestScheduledPlansForLook, IRequestScheduledPlansForLookmlDashboard, IRequestSearchAlerts, IRequestSearchArtifacts, IRequestSearchBoards, IRequestSearchContent, IRequestSearchContentFavorites, IRequestSearchContentViews, IRequestSearchCredentialsEmail, IRequestSearchDashboardElements, IRequestSearchDashboards, IRequestSearchFolders, IRequestSearchGroups, IRequestSearchGroupsWithHierarchy, IRequestSearchGroupsWithRoles, IRequestSearchLooks, IRequestSearchModelSets, IRequestSearchPermissionSets, IRequestSearchRoles, IRequestSearchRolesWithUserCount, IRequestSearchThemes, IRequestSearchUserLoginLockouts, IRequestSearchUsers, IRequestSearchUsersNames, IRequestStartPdtBuild, IRequestTagRef, IRequestUserAttributeUserValues, IRequestUserRoles, IRole, IRoleSearch, IRunningQueries, ISamlConfig, ISamlMetadataParseResult, IScheduledPlan, ISchema, ISchemaColumns, ISchemaTables, ISession, ISessionConfig, ISetting, ISmtpSettings, ISmtpStatus, ISqlInterfaceQuery, ISqlInterfaceQueryMetadata, ISqlQuery, ISqlQueryCreate, ISshPublicKey, ISshServer, ISshTunnel, ISupportAccessAddEntries, ISupportAccessAllowlistEntry, ISupportAccessEnable, ISupportAccessStatus, ITheme, ITimezone, IUpdateArtifact, IUpdateFolder, IUser, IUserAttribute, IUserAttributeGroupValue, IUserAttributeWithValue, IUserEmailOnly, IUserLoginLockout, IUserPublic, IValidationError, IWelcomeEmailTest, IWhitelabelConfiguration, IWorkspace, IWriteAlert, IWriteApiSession, IWriteBackupConfiguration, IWriteBoard, IWriteBoardItem, IWriteBoardSection, IWriteColorCollection, IWriteContentFavorite, IWriteContentMeta, IWriteCreateDashboardFilter, IWriteCredentialsEmail, IWriteDashboard, IWriteDashboardElement, IWriteDashboardFilter, IWriteDashboardLayout, IWriteDashboardLayoutComponent, IWriteDashboardLookml, IWriteDatagroup, IWriteDBConnection, IWriteEmbedSecret, IWriteExternalOauthApplication, IWriteGitBranch, IWriteGroup, IWriteIntegration, IWriteIntegrationHub, IWriteInternalHelpResources, IWriteInternalHelpResourcesContent, IWriteLDAPConfig, IWriteLegacyFeature, IWriteLookmlModel, IWriteLookWithQuery, IWriteMergeQuery, IWriteMobileToken, IWriteModelSet, IWriteOauthClientApp, IWriteOIDCConfig, IWritePasswordConfig, IWritePermissionSet, IWriteProject, IWriteQuery, IWriteRepositoryCredential, IWriteRole, IWriteSamlConfig, IWriteScheduledPlan, IWriteSessionConfig, IWriteSetting, IWriteSqlInterfaceQueryCreate, IWriteSshServer, IWriteSshTunnel, IWriteTheme, IWriteUser, IWriteUserAttribute, IWriteUserAttributeWithValue, IWriteWhitelabelConfiguration } from './models';
2
+ import type { IAccessToken, IAlert, IAlertNotifications, IAlertPatch, IApiSession, IApiVersion, IArtifact, IArtifactNamespace, IArtifactUsage, IBackupConfiguration, IBoard, IBoardItem, IBoardSection, IColorCollection, IColumnSearch, IConnectionFeatures, IContentFavorite, IContentMeta, IContentMetaGroupUser, IContentSearch, IContentSummary, IContentValidation, IContentView, ICostEstimate, ICreateCostEstimate, ICreateCredentialsApi3, ICreateEmbedUserRequest, ICreateFolder, ICreateOAuthApplicationUserStateRequest, ICreateOAuthApplicationUserStateResponse, ICredentialsApi3, ICredentialsEmail, ICredentialsEmailSearch, ICredentialsEmbed, ICredentialsGoogle, ICredentialsLDAP, ICredentialsLookerOpenid, ICredentialsOIDC, ICredentialsSaml, ICredentialsTotp, ICustomWelcomeEmail, IDashboard, IDashboardAggregateTableLookml, IDashboardBase, IDashboardElement, IDashboardFilter, IDashboardLayout, IDashboardLayoutComponent, IDashboardLookml, IDataActionForm, IDataActionRequest, IDataActionResponse, IDatagroup, IDBConnection, IDBConnectionTestResult, IDependencyGraph, IDialectInfo, IDigestEmails, IDigestEmailSend, IEgressIpAddresses, IEmbedCookielessSessionAcquire, IEmbedCookielessSessionAcquireResponse, IEmbedCookielessSessionGenerateTokens, IEmbedCookielessSessionGenerateTokensResponse, IEmbedParams, IEmbedSecret, IEmbedSsoParams, IEmbedUrlResponse, IError, IExternalOauthApplication, IFolder, IFolderBase, IGitBranch, IGitConnectionTest, IGitConnectionTestResult, IGroup, IGroupHierarchy, IGroupIdForGroupInclusion, IGroupIdForGroupUserInclusion, IGroupSearch, IHomepageSection, IIntegration, IIntegrationHub, IIntegrationTestResult, IInternalHelpResources, IInternalHelpResourcesContent, IJsonBi, ILDAPConfig, ILDAPConfigTestResult, ILegacyFeature, ILocale, ILook, ILookmlModel, ILookmlModelExplore, ILookmlTest, ILookmlTestResult, ILookWithQuery, IManifest, IMaterializePDT, IMergeQuery, IMobileSettings, IMobileToken, IModel, IModelFieldSuggestions, IModelSet, IOauthClientApp, IOIDCConfig, IPasswordConfig, IPermission, IPermissionSet, IProject, IProjectFile, IProjectValidation, IProjectValidationCache, IProjectWorkspace, IQuery, IQueryTask, IRenderTask, IRepositoryCredential, IRequestActiveThemes, IRequestAlertNotifications, IRequestAllBoardItems, IRequestAllBoardSections, IRequestAllExternalOauthApplications, IRequestAllGroups, IRequestAllGroupUsers, IRequestAllIntegrations, IRequestAllLookmlModels, IRequestAllRoles, IRequestAllScheduledPlans, IRequestAllUserAttributes, IRequestAllUsers, IRequestArtifact, IRequestArtifactNamespaces, IRequestConnectionColumns, IRequestConnectionSchemas, IRequestConnectionSearchColumns, IRequestConnectionTables, IRequestContentSummary, IRequestContentThumbnail, IRequestCreateDashboardElement, IRequestCreateDashboardRenderTask, IRequestCreateQueryTask, IRequestCreateUserCredentialsEmailPasswordReset, IRequestDeployRefToProduction, IRequestFolderChildren, IRequestFolderChildrenSearch, IRequestGraphDerivedTablesForModel, IRequestGraphDerivedTablesForView, IRequestLogin, IRequestLookmlModelExplore, IRequestModelFieldnameSuggestions, IRequestRoleUsers, IRequestRunGitConnectionTest, IRequestRunInlineQuery, IRequestRunLook, IRequestRunLookmlTest, IRequestRunQuery, IRequestScheduledPlansForDashboard, IRequestScheduledPlansForLook, IRequestScheduledPlansForLookmlDashboard, IRequestSearchAlerts, IRequestSearchArtifacts, IRequestSearchBoards, IRequestSearchContent, IRequestSearchContentFavorites, IRequestSearchContentViews, IRequestSearchCredentialsEmail, IRequestSearchDashboardElements, IRequestSearchDashboards, IRequestSearchFolders, IRequestSearchGroups, IRequestSearchGroupsWithHierarchy, IRequestSearchGroupsWithRoles, IRequestSearchLooks, IRequestSearchModelSets, IRequestSearchPermissionSets, IRequestSearchRoles, IRequestSearchRolesWithUserCount, IRequestSearchScheduledPlans, IRequestSearchThemes, IRequestSearchUserLoginLockouts, IRequestSearchUsers, IRequestSearchUsersNames, IRequestStartPdtBuild, IRequestTagRef, IRequestUserAttributeUserValues, IRequestUserRoles, IRole, IRoleSearch, IRunningQueries, ISamlConfig, ISamlMetadataParseResult, IScheduledPlan, ISchema, ISchemaColumns, ISchemaTables, ISession, ISessionConfig, ISetting, ISmtpSettings, ISmtpStatus, ISqlInterfaceQuery, ISqlInterfaceQueryMetadata, ISqlQuery, ISqlQueryCreate, ISshPublicKey, ISshServer, ISshTunnel, ISupportAccessAddEntries, ISupportAccessAllowlistEntry, ISupportAccessEnable, ISupportAccessStatus, ITheme, ITimezone, IUpdateArtifact, IUpdateFolder, IUser, IUserAttribute, IUserAttributeGroupValue, IUserAttributeWithValue, IUserEmailOnly, IUserLoginLockout, IUserPublic, IValidationError, IWelcomeEmailTest, IWhitelabelConfiguration, IWorkspace, IWriteAlert, IWriteApiSession, IWriteBackupConfiguration, IWriteBoard, IWriteBoardItem, IWriteBoardSection, IWriteColorCollection, IWriteContentFavorite, IWriteContentMeta, IWriteCreateDashboardFilter, IWriteCredentialsEmail, IWriteDashboard, IWriteDashboardElement, IWriteDashboardFilter, IWriteDashboardLayout, IWriteDashboardLayoutComponent, IWriteDashboardLookml, IWriteDatagroup, IWriteDBConnection, IWriteEmbedSecret, IWriteExternalOauthApplication, IWriteGitBranch, IWriteGroup, IWriteIntegration, IWriteIntegrationHub, IWriteInternalHelpResources, IWriteInternalHelpResourcesContent, IWriteLDAPConfig, IWriteLegacyFeature, IWriteLookmlModel, IWriteLookWithQuery, IWriteMergeQuery, IWriteMobileToken, IWriteModelSet, IWriteOauthClientApp, IWriteOIDCConfig, IWritePasswordConfig, IWritePermissionSet, IWriteProject, IWriteQuery, IWriteRepositoryCredential, IWriteRole, IWriteSamlConfig, IWriteScheduledPlan, IWriteSessionConfig, IWriteSetting, IWriteSqlInterfaceQueryCreate, IWriteSshServer, IWriteSshTunnel, IWriteTheme, IWriteUser, IWriteUserAttribute, IWriteUserAttributeWithValue, IWriteWhitelabelConfiguration } from './models';
3
3
  export interface ILooker40SDK extends IAPIMethods {
4
4
  follow_alert(alert_id: string, options?: Partial<ITransportSettings>): Promise<SDKResponse<void, IError>>;
5
5
  unfollow_alert(alert_id: string, options?: Partial<ITransportSettings>): Promise<SDKResponse<void, IError>>;
@@ -216,7 +216,7 @@ export interface ILooker40SDK extends IAPIMethods {
216
216
  folder(folder_id: string, fields?: string, options?: Partial<ITransportSettings>): Promise<SDKResponse<IFolder, IError>>;
217
217
  update_folder(folder_id: string, body: Partial<IUpdateFolder>, options?: Partial<ITransportSettings>): Promise<SDKResponse<IFolder, IError | IValidationError>>;
218
218
  delete_folder(folder_id: string, options?: Partial<ITransportSettings>): Promise<SDKResponse<string, IError | IValidationError>>;
219
- all_folders(fields?: string, options?: Partial<ITransportSettings>): Promise<SDKResponse<IFolder[], IError>>;
219
+ all_folders(fields?: string, options?: Partial<ITransportSettings>): Promise<SDKResponse<IFolderBase[], IError>>;
220
220
  create_folder(body: Partial<ICreateFolder>, options?: Partial<ITransportSettings>): Promise<SDKResponse<IFolder, IError | IValidationError>>;
221
221
  folder_children(request: IRequestFolderChildren, options?: Partial<ITransportSettings>): Promise<SDKResponse<IFolder[], IError>>;
222
222
  folder_children_search(request: IRequestFolderChildrenSearch, options?: Partial<ITransportSettings>): Promise<SDKResponse<IFolder[], IError>>;
@@ -310,7 +310,7 @@ export interface ILooker40SDK extends IAPIMethods {
310
310
  create_query_task(request: IRequestCreateQueryTask, options?: Partial<ITransportSettings>): Promise<SDKResponse<IQueryTask, IError | IValidationError>>;
311
311
  query_task_multi_results(query_task_ids: DelimArray<string>, options?: Partial<ITransportSettings>): Promise<SDKResponse<IDictionary<any>, IError>>;
312
312
  query_task(query_task_id: string, fields?: string, options?: Partial<ITransportSettings>): Promise<SDKResponse<IQueryTask, IError>>;
313
- query_task_results(query_task_id: string, options?: Partial<ITransportSettings>): Promise<SDKResponse<IQueryTask, IError>>;
313
+ query_task_results(query_task_id: string, options?: Partial<ITransportSettings>): Promise<SDKResponse<string, IError>>;
314
314
  query(query_id: string, fields?: string, options?: Partial<ITransportSettings>): Promise<SDKResponse<IQuery, IError>>;
315
315
  query_for_slug(slug: string, fields?: string, options?: Partial<ITransportSettings>): Promise<SDKResponse<IQuery, IError>>;
316
316
  create_query(body: Partial<IWriteQuery>, fields?: string, options?: Partial<ITransportSettings>): Promise<SDKResponse<IQuery, IError | IValidationError>>;
@@ -361,6 +361,7 @@ export interface ILooker40SDK extends IAPIMethods {
361
361
  all_scheduled_plans(request: IRequestAllScheduledPlans, options?: Partial<ITransportSettings>): Promise<SDKResponse<IScheduledPlan[], IError | IValidationError>>;
362
362
  create_scheduled_plan(body: Partial<IWriteScheduledPlan>, options?: Partial<ITransportSettings>): Promise<SDKResponse<IScheduledPlan, IError | IValidationError>>;
363
363
  scheduled_plan_run_once(body: Partial<IWriteScheduledPlan>, options?: Partial<ITransportSettings>): Promise<SDKResponse<IScheduledPlan, IError | IValidationError>>;
364
+ search_scheduled_plans(request: IRequestSearchScheduledPlans, options?: Partial<ITransportSettings>): Promise<SDKResponse<IScheduledPlan[], IError | IValidationError>>;
364
365
  scheduled_plans_for_look(request: IRequestScheduledPlansForLook, options?: Partial<ITransportSettings>): Promise<SDKResponse<IScheduledPlan[], IError>>;
365
366
  scheduled_plans_for_dashboard(request: IRequestScheduledPlansForDashboard, options?: Partial<ITransportSettings>): Promise<SDKResponse<IScheduledPlan[], IError>>;
366
367
  scheduled_plans_for_lookml_dashboard(request: IRequestScheduledPlansForLookmlDashboard, options?: Partial<ITransportSettings>): Promise<SDKResponse<IScheduledPlan[], IError>>;
@@ -368,7 +369,7 @@ export interface ILooker40SDK extends IAPIMethods {
368
369
  session(options?: Partial<ITransportSettings>): Promise<SDKResponse<IApiSession, IError>>;
369
370
  update_session(body: Partial<IWriteApiSession>, options?: Partial<ITransportSettings>): Promise<SDKResponse<IApiSession, IError | IValidationError>>;
370
371
  sql_interface_metadata(avatica_request?: string, options?: Partial<ITransportSettings>): Promise<SDKResponse<ISqlInterfaceQueryMetadata, IError>>;
371
- run_sql_interface_query(query_id: number, result_format: string, options?: Partial<ITransportSettings>): Promise<SDKResponse<IQueryFormats, IError | IValidationError>>;
372
+ run_sql_interface_query(query_id: number, result_format: string, options?: Partial<ITransportSettings>): Promise<SDKResponse<IJsonBi, IError | IValidationError>>;
372
373
  create_sql_interface_query(body: Partial<IWriteSqlInterfaceQueryCreate>, options?: Partial<ITransportSettings>): Promise<SDKResponse<ISqlInterfaceQuery, IError | IValidationError>>;
373
374
  all_themes(fields?: string, options?: Partial<ITransportSettings>): Promise<SDKResponse<ITheme[], IError>>;
374
375
  create_theme(body: Partial<IWriteTheme>, options?: Partial<ITransportSettings>): Promise<SDKResponse<ITheme, IError | IValidationError>>;