@qlik/api 2.3.1 → 2.4.0

package/assistants.js

@@ -1,5 +1,5 @@
-import "./chunks/public-runtime-modules-BqxAMJ9M.js";
-import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-CckTK7bh.js";
+import "./chunks/public-runtime-modules-2KfyI2qM.js";
+import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-DMAi6Fg3.js";
 
 //#region src/public/rest/assistants.ts
 /**
@@ -582,7 +582,6 @@ const assistantsExport = {
 	patchAssistant,
 	clearCache
 };
-var assistants_default = assistantsExport;
 
 //#endregion
-export { clearCache, createAssistant, createAssistantStarter, createAssistantThread, createAssistantThreadInteraction, createAssistantThreadInteractionFeedback, createAssistantThreadInteractionReview, assistants_default as default, deleteAssistant, deleteAssistantStarter, deleteAssistantStarterFollowup, deleteAssistantThread, deleteAssistantThreadInteraction, getAssistant, getAssistantFeedback, getAssistantSources, getAssistantStarter, getAssistantStarters, getAssistantThread, getAssistantThreadInteraction, getAssistantThreadInteractions, getAssistantThreads, getAssistants, invokeAssistantThread, patchAssistant, patchAssistantThread, patchAssistantThreadInteractionFeedback, searchAssistant, streamAssistantThread, updateAssistantStarter, updateAssistantStarterFollowup };
+export { clearCache, createAssistant, createAssistantStarter, createAssistantThread, createAssistantThreadInteraction, createAssistantThreadInteractionFeedback, createAssistantThreadInteractionReview, assistantsExport as default, deleteAssistant, deleteAssistantStarter, deleteAssistantStarterFollowup, deleteAssistantThread, deleteAssistantThreadInteraction, getAssistant, getAssistantFeedback, getAssistantSources, getAssistantStarter, getAssistantStarters, getAssistantThread, getAssistantThreadInteraction, getAssistantThreadInteractions, getAssistantThreads, getAssistants, invokeAssistantThread, patchAssistant, patchAssistantThread, patchAssistantThreadInteractionFeedback, searchAssistant, streamAssistantThread, updateAssistantStarter, updateAssistantStarterFollowup };

package/audits.d.ts

@@ -1,27 +1,17 @@
-import { S as DownloadableBlob, y as ApiCallOptions } from "./chunks/auth-types-YrlH_R9f.js";
-import "./chunks/invoke-fetch-C1Z0RJYU.js";
+import { ApiCallOptions, DownloadableBlob } from "./invoke-fetch-types.js";
+import "./chunks/invoke-fetch-DFc3yzaj.js";
 
 //#region src/public/rest/audits.d.ts
 type ArchiveItem = {
-  /** The type that content is encoded in, always "application/json". */
-  contentType?: string;
-  /** Additional information about the event's details. The structure depends on the type and version of the event. */
-  data?: unknown;
-  /** The event's unique identifier. */
-  eventId?: string;
-  /** The RFC3339 datetime when the event happened. */
-  eventTime?: string;
-  /** The type of event that describes committed action. */
-  eventType?: string;
-  /** The version of the event type. */
-  eventTypeVersion?: string;
-  /** The availability of the properties depends on the event and the context it was triggered in. */
-  extensions?: EventExtensions;
-  /** The source of the event message, usually the producing service. */
-  source?: string;
-  /** The ID of the tenant that owns the item. This is populated using the JWT. */
-  tenantId?: string;
-  /** The ID of the user who performed the action that triggered the event. */
+  /** The type that content is encoded in, always "application/json". */contentType?: string; /** Additional information about the event's details. The structure depends on the type and version of the event. */
+  data?: unknown; /** The event's unique identifier. */
+  eventId?: string; /** The RFC3339 datetime when the event happened. */
+  eventTime?: string; /** The type of event that describes committed action. */
+  eventType?: string; /** The version of the event type. */
+  eventTypeVersion?: string; /** The availability of the properties depends on the event and the context it was triggered in. */
+  extensions?: EventExtensions; /** The source of the event message, usually the producing service. */
+  source?: string; /** The ID of the tenant that owns the item. This is populated using the JWT. */
+  tenantId?: string; /** The ID of the user who performed the action that triggered the event. */
   userId?: string;
 };
 type ErrorResponse = {
@@ -36,70 +26,46 @@ type ErrorResponse = {
  * The availability of the properties depends on the event and the context it was triggered in.
  */
 type EventExtensions = {
-  /** Specifies the entity performing the action on behalf of another party listed as triggering the action. */
-  actor?: {
-    /** Opaque value identifying impersonating entity. */
-    sub?: string;
-    /** The type of the impersonating entity. */
+  /** Specifies the entity performing the action on behalf of another party listed as triggering the action. */actor?: {
+    /** Opaque value identifying impersonating entity. */sub?: string; /** The type of the impersonating entity. */
     subType?: string;
-  };
-  /** Id of the owner of the resource affected by the eventContext. */
-  ownerId?: string;
-  /** Id of the space related to the action performed on the eventContext. */
-  spaceId?: string;
-  /** If the event originated from a sub resource the topLevelResourceId contains the id of the top level resource associated with the sub resource. */
-  topLevelResourceId?: string;
-  /** Might be present if the action is of type "updated" and should contain information about the changes made to the resource. */
+  }; /** Id of the owner of the resource affected by the eventContext. */
+  ownerId?: string; /** Id of the space related to the action performed on the eventContext. */
+  spaceId?: string; /** If the event originated from a sub resource the topLevelResourceId contains the id of the top level resource associated with the sub resource. */
+  topLevelResourceId?: string; /** Might be present if the action is of type "updated" and should contain information about the changes made to the resource. */
   updates?: unknown;
 };
 type GetArchiveResult = {
-  /** List of archived events. The structure of the events depend on their type and version. */
-  data?: ArchiveItem[];
+  /** List of archived events. The structure of the events depend on their type and version. */data?: ArchiveItem[];
 };
 type GetByIDResult = {
-  /** The type that content is encoded in, always "application/json". */
-  contentType?: string;
-  /** Additional information about the event's details. The structure depends on the type and version of the event. */
-  data?: unknown;
-  /** The event's unique identifier. */
-  eventId?: string;
-  /** The RFC3339 datetime when the event happened. */
-  eventTime?: string;
-  /** The type of event that describes committed action. */
-  eventType?: string;
-  /** The version of the event type. */
-  eventTypeVersion?: string;
-  /** The availability of the properties depends on the event and the context it was triggered in. */
-  extensions?: EventExtensions;
-  /** The resource item's unique identifier. */
+  /** The type that content is encoded in, always "application/json". */contentType?: string; /** Additional information about the event's details. The structure depends on the type and version of the event. */
+  data?: unknown; /** The event's unique identifier. */
+  eventId?: string; /** The RFC3339 datetime when the event happened. */
+  eventTime?: string; /** The type of event that describes committed action. */
+  eventType?: string; /** The version of the event type. */
+  eventTypeVersion?: string; /** The availability of the properties depends on the event and the context it was triggered in. */
+  extensions?: EventExtensions; /** The resource item's unique identifier. */
   id?: string;
-  links?: GetLinks;
-  /** The source of the event message, usually the producing service. */
-  source?: string;
-  /** The ID of the tenant that owns the item. This is populated using the JWT. */
-  tenantId?: string;
-  /** The ID of the user who performed the action that triggered the event. */
+  links?: GetLinks; /** The source of the event message, usually the producing service. */
+  source?: string; /** The ID of the tenant that owns the item. This is populated using the JWT. */
+  tenantId?: string; /** The ID of the user who performed the action that triggered the event. */
   userId?: string;
 };
 type GetLinks = {
   self?: Href;
 };
 type GetObjectsResult = {
-  /** List of requested resources. */
-  data?: string[];
+  /** List of requested resources. */data?: string[];
   links?: ListLinks;
 };
 type GetResult = {
-  /** List of audit items. */
-  data?: GetByIDResult[];
+  /** List of audit items. */data?: GetByIDResult[];
   links?: ListLinks;
 };
 type GetSettingsResult = {
-  /** Server configuration options. */
-  data?: {
-    /** Is Long Term Storage archiving enabled?. */
-    ArchiveEnabled?: boolean;
-    /** The events TTL in seconds. */
+  /** Server configuration options. */data?: {
+    /** Is Long Term Storage archiving enabled?. */ArchiveEnabled?: boolean; /** The events TTL in seconds. */
     EventTTL?: number;
   };
 };
@@ -118,23 +84,14 @@ type Href = {
  * @throws GetAuditsHttpError
  */
 declare function getAudits(query: {
-  /** The start/end time interval formatted in ISO 8601 to search by eventTime. For example, "?eventTime=2021-07-14T18:41:15.00Z/2021-07-14T18:41:15.99Z". */
-  eventTime?: string;
-  /** The case-sensitive string used to search by eventType. Retrieve a list of possible eventTypes with `/v1/audits/types`. */
-  eventType?: string;
-  /** The comma separated list of audit unique identifiers. */
-  id?: string;
-  /** The maximum number of resources to return for a request. */
-  limit?: number;
-  /** The cursor to the next page of resources. Provide either the next or prev cursor, but not both. */
-  next?: string;
-  /** The cursor to the previous page of resources. Provide either the next or prev cursor, but not both. */
-  prev?: string;
-  /** The property of a resource to sort on (default sort is -eventTime). The supported properties are source, eventType, and eventTime. A property must be prefixed by + or - to indicate ascending or descending sort order respectively. */
-  sort?: string;
-  /** The case-sensitive string used to search by source. Retrieve a list of possible sources with `/v1/audits/sources`. */
-  source?: string;
-  /** The case-sensitive string used to search by userId. */
+  /** The start/end time interval formatted in ISO 8601 to search by eventTime. For example, "?eventTime=2021-07-14T18:41:15.00Z/2021-07-14T18:41:15.99Z". */eventTime?: string; /** The case-sensitive string used to search by eventType. Retrieve a list of possible eventTypes with `/v1/audits/types`. */
+  eventType?: string; /** The comma separated list of audit unique identifiers. */
+  id?: string; /** The maximum number of resources to return for a request. */
+  limit?: number; /** The cursor to the next page of resources. Provide either the next or prev cursor, but not both. */
+  next?: string; /** The cursor to the previous page of resources. Provide either the next or prev cursor, but not both. */
+  prev?: string; /** The property of a resource to sort on (default sort is -eventTime). The supported properties are source, eventType, and eventTime. A property must be prefixed by + or - to indicate ascending or descending sort order respectively. */
+  sort?: string; /** The case-sensitive string used to search by source. Retrieve a list of possible sources with `/v1/audits/sources`. */
+  source?: string; /** The case-sensitive string used to search by userId. */
   userId?: string;
 }, options?: ApiCallOptions): Promise<GetAuditsHttpResponse>;
 type GetAuditsHttpResponse = {
@@ -173,8 +130,7 @@ type FetchConsumptionAppAuditsHttpError = {
  * @throws GetArchivedAuditsHttpError
  */
 declare function getArchivedAudits(query: {
-  /** Date to be used as filter and criteria during extraction. */
-  date: string;
+  /** Date to be used as filter and criteria during extraction. */date: string;
 }, options?: ApiCallOptions): Promise<GetArchivedAuditsHttpResponse>;
 type GetArchivedAuditsHttpResponse = {
   data: GetArchiveResult;

package/audits.js

@@ -1,5 +1,5 @@
-import "./chunks/public-runtime-modules-BqxAMJ9M.js";
-import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-CckTK7bh.js";
+import "./chunks/public-runtime-modules-2KfyI2qM.js";
+import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-DMAi6Fg3.js";
 
 //#region src/public/rest/audits.ts
 /**
@@ -112,7 +112,6 @@ const auditsExport = {
 	getAudit,
 	clearCache
 };
-var audits_default = auditsExport;
 
 //#endregion
-export { clearCache, audits_default as default, fetchConsumptionAppAudits, getArchivedAudits, getAudit, getAuditSources, getAuditTypes, getAudits, getAuditsSettings };
+export { clearCache, auditsExport as default, fetchConsumptionAppAudits, getArchivedAudits, getAudit, getAuditSources, getAuditTypes, getAudits, getAuditsSettings };

package/auth-types.d.ts

@@ -1,2 +1,111 @@
-import { _ as hostConfigCommonProperties, a as Credentials, c as GetWebResourceAuthParamsProps, d as HostConfig, f as HostConfigCommon, g as authTypesThatCanBeOmitted, h as WebSocketAuthParams, i as AuthenticationErrorAction, l as GetWebSocketAuthParamsProps, m as WebResourceAuthParams, n as AuthType, o as GetRemoteAuthDataProps, p as RestCallAuthParams, r as AuthTypeThatCanBeOmitted, s as GetRestCallAuthParamsProps, t as AuthModule, u as HandleAuthenticationErrorProps } from "./chunks/auth-types-YrlH_R9f.js";
+import "./global-types.js";
+
+//#region src/auth/auth-types.d.ts
+/** Credentials setting for http requests */
+type Credentials = "include" | "same-origin" | "omit";
+/** Props for function getRestCallAuthParams */
+type GetRestCallAuthParamsProps<A extends AuthType = AuthType> = {
+  hostConfig: HostConfig<A>; /** The HTTP method in the outgoing REST call */
+  method: string;
+};
+/** Http request parameters for auth to use when making a rest call based on a host config */
+type RestCallAuthParams = {
+  headers: Record<string, string>;
+  queryParams: Record<string, string>;
+  credentials: Credentials;
+};
+/** Props for function getWebsocketAuthParams */
+type GetWebSocketAuthParamsProps<A extends AuthType = AuthType> = {
+  hostConfig: HostConfig<A>;
+};
+/** Websocket auth parameters to use when setting up a websocket based on a host config */
+type WebSocketAuthParams = {
+  /** Note that headers are only applied in NodeJS environments and NOT in the browser */headers?: Record<string, string>;
+  queryParams?: Record<string, string>;
+};
+/** Props for function getWebResourceAuthParams */
+type GetWebResourceAuthParamsProps<A extends AuthType = AuthType> = {
+  hostConfig: HostConfig<A>;
+};
+/** Web resource auth parameters to use when fetching a web resource with a host config */
+type WebResourceAuthParams = {
+  queryParams: Record<string, string>;
+};
+type GetRemoteAuthDataProps<A extends AuthType = AuthType> = {
+  hostConfig: HostConfig<A>;
+  queryParams?: Record<string, string>;
+};
+/** Props for function handleAuthenticationError */
+type HandleAuthenticationErrorProps<A extends AuthType = AuthType> = {
+  /** host config for connecting to a host */hostConfig: HostConfig<A>; /** HTTP status of the response */
+  status: number; /** Body of the error response */
+  errorBody?: Record<string, unknown>; /** HTTP response headers */
+  headers: Headers; /** Set to true if it is possible to perform a retry. This will be true for the first call, and false if the call is actually a retry */
+  canRetry: boolean;
+};
+/** Action to take when error occurs during authentication */
+type AuthenticationErrorAction = {
+  /**
+   * If set to true the request will be retried and its AuthParams will be fetched again
+   */
+  retry?: boolean;
+  /**
+   * Set to true to prevent the api call result promise from ever resolving.
+   * Typically used when redirecting the window to a login page to prevent
+   * transient errors from happening in the page while the browser is loading the login page.
+   */
+  preventDefault?: boolean;
+};
+/** A typed string array with extracted required properties from a type */
+type RequiredKeys<T> = { [K in keyof T]-?: {} extends Pick<T, K> ? never : K }[keyof T];
+/** A typed string array with extracted optional properties from a type */
+type OptionalKeys<T> = { [K in keyof T]-?: {} extends Pick<T, K> ? K : never }[keyof T];
+/** An authentication module for a specific authentication format, like oauth, cookies etc */
+type AuthModule<A extends AuthType = AuthType> = {
+  /** Properties required for this auth module */requiredProps?: RequiredKeys<HostConfig<A>>[]; /** Properties that are optional for this auth module */
+  optionalProps?: OptionalKeys<HostConfig<A>>[]; /** Get auth params for rest api calls */
+  getRestCallAuthParams: (props: GetRestCallAuthParamsProps<A>) => Promise<RestCallAuthParams>; /** Get auth params for websocket api calls */
+  getWebSocketAuthParams: (props: GetWebSocketAuthParamsProps<A>) => Promise<WebSocketAuthParams>; /** Get auth params for web resource request */
+  getWebResourceAuthParams?: (props: GetWebResourceAuthParamsProps<A>) => Promise<WebResourceAuthParams>; /** Callback for when auth error happens */
+  handleAuthenticationError: (props: HandleAuthenticationErrorProps<A>) => Promise<AuthenticationErrorAction>; /** Runtime check for validating host config */
+  validateHostConfig?: (hostConfig: Record<string, unknown>) => boolean;
+};
+/** Valid strings for known authentication types */
+type AuthType = keyof QlikAuthModules;
+/** Configuration object for connecting and authenticating with Qlik platform(s) */
+type HostConfig<A extends AuthType = AuthType> = { [K in keyof QlikAuthModules]: QlikAuthModuleConfigUnion<K> & HostConfigCommon }[A];
+type QlikAuthModuleConfigUnion<K extends keyof QlikAuthModules> = (K extends keyof ImplicitQlikAuthModules ? {
+  authType?: K;
+} : {
+  authType: K;
+}) & QlikAuthModules[K]["config"];
+type HostConfigCommon = {
+  /** The URL to the cloud tenant or windows server. If scheme is excluded https is used. May include a virtual proxy prefix on windows. Any trailing slashes are stripped. */host?: string;
+  autoRedirect?: boolean;
+  authRedirectUserConfirmation?: () => Promise<void>;
+  /**
+   * Optional parameter that can be used to point to a Qlik Cloud tenant domain from which the embed runtime should be loaded. If omitted the host parameter will be used.
+   */
+  embedRuntimeUrl?: string;
+  onAuthFailed?: (props: {
+    message: string;
+  }) => unknown;
+};
+/**
+ * These properties are always allowed in the host config, even if they are not defined in the HostConfig interface
+ * for the specific auth module.
+ */
+declare const hostConfigCommonProperties: (keyof HostConfig)[];
+/** The keys in this interface are used to determine what auth types that are allowed to be set to undefined */
+interface ImplicitQlikAuthModules {
+  apikey: object;
+  oauth2: object;
+  cookie: object;
+  windowscookie: object;
+  reference: object;
+  anonymous: object;
+}
+type AuthTypeThatCanBeOmitted = keyof ImplicitQlikAuthModules;
+declare const authTypesThatCanBeOmitted: AuthTypeThatCanBeOmitted[];
+//#endregion
 export { AuthModule, AuthType, AuthTypeThatCanBeOmitted, AuthenticationErrorAction, Credentials, GetRemoteAuthDataProps, GetRestCallAuthParamsProps, GetWebResourceAuthParamsProps, GetWebSocketAuthParamsProps, HandleAuthenticationErrorProps, HostConfig, HostConfigCommon, RestCallAuthParams, WebResourceAuthParams, WebSocketAuthParams, authTypesThatCanBeOmitted, hostConfigCommonProperties };

package/auth-types.js

@@ -1,3 +1,24 @@
-import { n as hostConfigCommonProperties, t as authTypesThatCanBeOmitted } from "./chunks/auth-types-h43TVDpB.js";
+//#region src/auth/auth-types.ts
+/**
+* These properties are always allowed in the host config, even if they are not defined in the HostConfig interface
+* for the specific auth module.
+*/
+const hostConfigCommonProperties = [
+	"authType",
+	"autoRedirect",
+	"authRedirectUserConfirmation",
+	"embedRuntimeUrl",
+	"host",
+	"onAuthFailed"
+];
+const authTypesThatCanBeOmitted = [
+	"apikey",
+	"oauth2",
+	"cookie",
+	"windowscookie",
+	"reference",
+	"anonymous"
+];
 
+//#endregion
 export { authTypesThatCanBeOmitted, hostConfigCommonProperties };

package/auth.d.ts

@@ -1,7 +1,6 @@
-import { _ as hostConfigCommonProperties, a as Credentials, c as GetWebResourceAuthParamsProps, d as HostConfig, f as HostConfigCommon, g as authTypesThatCanBeOmitted, h as WebSocketAuthParams, i as AuthenticationErrorAction, l as GetWebSocketAuthParamsProps, m as WebResourceAuthParams, n as AuthType, o as GetRemoteAuthDataProps, p as RestCallAuthParams, r as AuthTypeThatCanBeOmitted, s as GetRestCallAuthParamsProps, t as AuthModule, u as HandleAuthenticationErrorProps } from "./chunks/auth-types-YrlH_R9f.js";
+import { AuthModule, AuthType, AuthTypeThatCanBeOmitted, AuthenticationErrorAction, Credentials, GetRemoteAuthDataProps, GetRestCallAuthParamsProps, GetWebResourceAuthParamsProps, GetWebSocketAuthParamsProps, HandleAuthenticationErrorProps, HostConfig, HostConfigCommon, RestCallAuthParams, WebResourceAuthParams, WebSocketAuthParams, authTypesThatCanBeOmitted, hostConfigCommonProperties } from "./auth-types.js";
 
 //#region src/public/auth.d.ts
-
 /**
  * Registers an auth module that can handle authentication. An auth module is used by specifying its name as authType in the HostConfig passed in to api calls.
  * @param name the name of the module

package/auth.js

@@ -1,4 +1,4 @@
-import { t as getAuthRuntimeModule } from "./chunks/public-runtime-modules-BqxAMJ9M.js";
+import { t as getAuthRuntimeModule } from "./chunks/public-runtime-modules-2KfyI2qM.js";
 
 //#region src/public/auth.ts
 /**

package/automation-connections.d.ts

@@ -1,95 +1,62 @@
-import { y as ApiCallOptions } from "./chunks/auth-types-YrlH_R9f.js";
-import "./chunks/invoke-fetch-C1Z0RJYU.js";
+import { ApiCallOptions } from "./invoke-fetch-types.js";
+import "./chunks/invoke-fetch-DFc3yzaj.js";
 
 //#region src/public/rest/automation-connections.d.ts
 type AutomationConnectionChangeOwnerObject = {
-  /** The unique identifier of the new owner. */
-  userId?: string;
+  /** The unique identifier of the new owner. */userId?: string;
 };
 type AutomationConnectionChangeSpaceObject = {
-  /** The unique identifier of the new space. */
-  spaceId?: string;
+  /** The unique identifier of the new space. */spaceId?: string;
 };
 type AutomationConnectionCheckObject = {
-  /** The connection status of the automation connection. When true, the automation connection is connected. */
-  isConnected?: boolean;
+  /** The connection status of the automation connection. When true, the automation connection is connected. */isConnected?: boolean;
 };
 type AutomationConnectionCreationObject = {
-  /** The unique identifier of the connector from which the automation connection is created. */
-  connectorId: string;
-  /** The name of the created automation connection. */
+  /** The unique identifier of the connector from which the automation connection is created. */connectorId: string; /** The name of the created automation connection. */
   name?: string;
-  params?: AutomationConnectionParamCreateObject[];
-  /** The unique identifier of the space in which the automation connection is created. */
+  params?: AutomationConnectionParamCreateObject[]; /** The unique identifier of the space in which the automation connection is created. */
   spaceId?: string;
 };
 type AutomationConnectionDetailObject = {
-  /** The unique identifier of the automation connector. */
-  connectorId?: string;
-  /** The timestamp when the automation connection was created. */
-  createdAt?: string;
-  /** This contains the error message if a connection is being created with an issue. */
-  error?: unknown;
-  /** The unique identifier of the automation connection. */
-  id?: string;
-  /** The connection status of the automation connection. When true, the automation connection is connected. */
-  isConnected?: boolean;
-  /** The name of the automation connection. */
-  name?: string;
-  /** The name of the OAuth account associated with the automation connection. */
-  oauthAccountName?: string;
-  /** The unique identifier of the owner of the automation connection. */
+  /** The unique identifier of the automation connector. */connectorId?: string; /** The timestamp when the automation connection was created. */
+  createdAt?: string; /** This contains the error message if a connection is being created with an issue. */
+  error?: unknown; /** The unique identifier of the automation connection. */
+  id?: string; /** The connection status of the automation connection. When true, the automation connection is connected. */
+  isConnected?: boolean; /** The name of the automation connection. */
+  name?: string; /** The name of the OAuth account associated with the automation connection. */
+  oauthAccountName?: string; /** The unique identifier of the owner of the automation connection. */
   ownerId?: string;
-  params?: AutomationConnectionParamObject[];
-  /** The redirect of the OAuth account. */
-  redirect?: string;
-  /** The space ID of the automation connection. */
-  spaceId?: string;
-  /** The timestamp when the automation connection was updated. */
+  params?: AutomationConnectionParamObject[]; /** The redirect of the OAuth account. */
+  redirect?: string; /** The space ID of the automation connection. */
+  spaceId?: string; /** The timestamp when the automation connection was updated. */
   updatedAt?: string;
 };
 type AutomationConnectionParamCreateObject = {
-  /** The name of the automation connection parameter. */
-  name?: string;
-  /** The value of the automation connection parameter option. */
+  /** The name of the automation connection parameter. */name?: string; /** The value of the automation connection parameter option. */
   value?: string;
 };
 type AutomationConnectionParamObject = {
-  /** The documentation of the automation connection parameter. */
-  documentation?: string;
-  /** The example value of the automation connection parameter. */
-  exampleValue?: string;
-  /** The field type of the automation connection parameter. */
-  fieldType?: string;
-  /** The unique identifier of the automation connection parameter. */
-  id?: string;
-  /** When true, the parameter is optional. */
-  isOptional?: boolean;
-  /** The metadata of the automation connection parameter. */
-  meta?: unknown[];
-  /** The name of the automation connection parameter. */
-  name?: string;
-  /** The order that the automation connection configuration fields should be displayed in. */
+  /** The documentation of the automation connection parameter. */documentation?: string; /** The example value of the automation connection parameter. */
+  exampleValue?: string; /** The field type of the automation connection parameter. */
+  fieldType?: string; /** The unique identifier of the automation connection parameter. */
+  id?: string; /** When true, the parameter is optional. */
+  isOptional?: boolean; /** The metadata of the automation connection parameter. */
+  meta?: unknown[]; /** The name of the automation connection parameter. */
+  name?: string; /** The order that the automation connection configuration fields should be displayed in. */
   order?: number;
-  paramOptions?: AutomationConnectionParamOptionObject[];
-  /** The value of the automation connection parameter. */
+  paramOptions?: AutomationConnectionParamOptionObject[]; /** The value of the automation connection parameter. */
   value?: string;
 };
 type AutomationConnectionParamOptionObject = {
-  /** The unique identifier of the automation connection parameter option. */
-  id?: string;
-  /** The value of the automation connection parameter option. */
+  /** The unique identifier of the automation connection parameter option. */id?: string; /** The value of the automation connection parameter option. */
   value?: string;
 };
 type AutomationConnectionParamPutObject = {
-  /** The unique identifier of the automation connection parameter option. */
-  id?: string;
-  /** The value of the automation connection parameter option. */
+  /** The unique identifier of the automation connection parameter option. */id?: string; /** The value of the automation connection parameter option. */
   value?: string;
 };
 type AutomationConnectionPutRequestObject = {
-  /** The new name of the automation connection to be renamed to. */
-  name?: string;
+  /** The new name of the automation connection to be renamed to. */name?: string;
   params?: AutomationConnectionParamPutObject[];
 };
 type AutomationConnectionsList = {
@@ -97,34 +64,22 @@ type AutomationConnectionsList = {
   links?: Links;
 };
 type AutomationConnectionsListObject = {
-  /** The unique identifier of the connector the automation connection is created from. */
-  connectorId?: string;
-  /** The timestamp when the automation connection is created. */
-  createdAt?: string;
-  /** The unique identifier of an automation connection. */
-  id?: string;
-  /** Returns true if the automtion connection is connected. */
-  isConnected?: boolean;
-  /** The name of an automation connection. */
-  name?: string;
-  /** The unique identifier of the owner of the automation connection. */
-  ownerId?: string;
-  /** The space ID of the automation connection. */
-  spaceId?: string;
-  /** The timestamp when the automation connection is updated. */
+  /** The unique identifier of the connector the automation connection is created from. */connectorId?: string; /** The timestamp when the automation connection is created. */
+  createdAt?: string; /** The unique identifier of an automation connection. */
+  id?: string; /** Returns true if the automtion connection is connected. */
+  isConnected?: boolean; /** The name of an automation connection. */
+  name?: string; /** The unique identifier of the owner of the automation connection. */
+  ownerId?: string; /** The space ID of the automation connection. */
+  spaceId?: string; /** The timestamp when the automation connection is updated. */
   updatedAt?: string;
 };
 type Error = {
-  /** The unique code for the error */
-  code: string;
-  /** May be used to provide additional details */
-  detail?: string;
-  /** A summary of what went wrong */
+  /** The unique code for the error */code: string; /** May be used to provide additional details */
+  detail?: string; /** A summary of what went wrong */
   title: string;
 };
 type ErrorResponse = {
-  errors?: Error[];
-  /** A way to trace the source of the error. */
+  errors?: Error[]; /** A way to trace the source of the error. */
   traceId?: string;
 };
 type Links = {
@@ -132,8 +87,7 @@ type Links = {
   prev?: PaginationLink;
 };
 type PaginationLink = {
-  /** The URL to a resource request */
-  href?: string;
+  /** The URL to a resource request */href?: string;
 };
 /**
  * Retrieves a list of automation connections
@@ -142,13 +96,9 @@ type PaginationLink = {
  * @throws GetAutomationConnectionsHttpError
  */
 declare function getAutomationConnections(query: {
-  /** Filters the result based on the specified criteria: name, connectorId, ownerId, or spaceId. */
-  filter?: string;
-  /** The number of automation connections to retrieve. */
-  limit?: number;
-  /** When true, list all connections. Restricted to tenant admins and analytics admins. */
-  listAll?: boolean;
-  /** The field to sort by, with +- prefix indicating sort order. (?sort=-name => sort on the name field using descending order) */
+  /** Filters the result based on the specified criteria: name, connectorId, ownerId, or spaceId. */filter?: string; /** The number of automation connections to retrieve. */
+  limit?: number; /** When true, list all connections. Restricted to tenant admins and analytics admins. */
+  listAll?: boolean; /** The field to sort by, with +- prefix indicating sort order. (?sort=-name => sort on the name field using descending order) */
   sort?: "id" | "name" | "createdAt" | "updatedAt" | "+id" | "+name" | "+createdAt" | "+updatedAt" | "-id" | "-name" | "-createdAt" | "-updatedAt";
 }, options?: ApiCallOptions): Promise<GetAutomationConnectionsHttpResponse>;
 type GetAutomationConnectionsHttpResponse = {
@@ -188,8 +138,7 @@ type CreateAutomationConnectionHttpError = {
  * @throws DeleteAutomationConnectionHttpError
  */
 declare function deleteAutomationConnection(id: string, query: {
-  /** When true, the automation connection will be deleted regardless of its usage by any automations. */
-  forced?: boolean;
+  /** When true, the automation connection will be deleted regardless of its usage by any automations. */forced?: boolean;
 }, options?: ApiCallOptions): Promise<DeleteAutomationConnectionHttpResponse>;
 type DeleteAutomationConnectionHttpResponse = {
   data: void;

package/automation-connections.js

@@ -1,5 +1,5 @@
-import "./chunks/public-runtime-modules-BqxAMJ9M.js";
-import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-CckTK7bh.js";
+import "./chunks/public-runtime-modules-2KfyI2qM.js";
+import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-DMAi6Fg3.js";
 
 //#region src/public/rest/automation-connections.ts
 /**
@@ -146,7 +146,6 @@ const automationConnectionsExport = {
 	checkAutomationConnection,
 	clearCache
 };
-var automation_connections_default = automationConnectionsExport;
 
 //#endregion
-export { changeOwnerAutomationConnection, changeSpaceAutomationConnection, checkAutomationConnection, clearCache, createAutomationConnection, automation_connections_default as default, deleteAutomationConnection, getAutomationConnection, getAutomationConnections, updateAutomationConnection };
+export { changeOwnerAutomationConnection, changeSpaceAutomationConnection, checkAutomationConnection, clearCache, createAutomationConnection, automationConnectionsExport as default, deleteAutomationConnection, getAutomationConnection, getAutomationConnections, updateAutomationConnection };