@qlik/api 2.3.0 → 2.4.0

package/tenant-settings.d.ts

@@ -0,0 +1,298 @@
+import { ApiCallOptions } from "./invoke-fetch-types.js";
+import "./chunks/invoke-fetch-DFc3yzaj.js";
+
+//#region src/public/rest/tenant-settings.d.ts
+type CustomizeNoAccess = {
+  linkEnabled: boolean;
+  linkLabel?: string;
+  linkUrl?: string;
+  message?: string;
+};
+type Error = {
+  errors?: {
+    /** Error code. */readonly code?: number; /** Error cause. */
+    readonly title?: string;
+  }[];
+};
+type ErrorResponse400 = {
+  errors?: {
+    code?: string;
+    detail?: string;
+    status?: number;
+    title?: string;
+  }[];
+  traceId?: string;
+};
+type ErrorResponse401 = {
+  errors?: {
+    code?: string;
+    detail?: string;
+    status?: number;
+    title?: string;
+  }[];
+  traceId?: string;
+};
+type ErrorResponse403 = {
+  errors?: {
+    code?: string;
+    detail?: string;
+    status?: number;
+    title?: string;
+  }[];
+  traceId?: string;
+};
+type ErrorResponse500 = {
+  errors?: {
+    code?: string;
+    detail?: string;
+    status?: number;
+    title?: string;
+  }[];
+  traceId?: string;
+};
+type JSONPatchRequestAddReplaceTest = {
+  /** The operation to perform. */op: "add" | "replace" | "test"; /** A JSON Pointer path. */
+  path: string; /** The value to add, replace or test. */
+  value: unknown;
+};
+type JSONPatchRequestMoveCopy = {
+  /** A JSON Pointer path. */from: string; /** The operation to perform. */
+  op: "move" | "copy"; /** A JSON Pointer path. */
+  path: string;
+};
+type JSONPatchRequestRemove = {
+  /** The operation to perform. */op: "remove"; /** A JSON Pointer path. */
+  path: string;
+};
+type PatchRequest = (JSONPatchRequestAddReplaceTest | JSONPatchRequestRemove | JSONPatchRequestMoveCopy)[];
+/**
+ * Set the release cadence
+ */
+type ReleaseCadenceConfig = "monthly" | "continuous";
+/**
+ * Set to true to enable cross-region inference, false to disable. Defaults to false.
+ */
+type SetCrossRegionDataProcessing = {
+  /** Set to true to enable cross-region inference, false to disable. */value: SetCrossRegionDataProcessingConfig;
+};
+/**
+ * Set to true to enable cross-region inference, false to disable.
+ */
+type SetCrossRegionDataProcessingConfig = boolean;
+type StartPage = "analytics-hub" | "data-integration-hub" | "management-console";
+type StartPageConfigConsole = {
+  route?: "/console";
+  value?: "management-console";
+};
+type StartPageConfigCreationHub = {
+  route?: "/analytics";
+  value?: "analytics-creation-hub";
+};
+type StartPageConfigHub = {
+  route?: "/insights";
+  value?: "analytics-hub";
+};
+type StartPageConfigQdi = {
+  route?: "/qdi";
+  value?: "data-integration-hub";
+};
+/**
+ * Create a new tenant settings entry for the tenant ID specified in the JWT. At least one of preferredStartPage or customizeNoAccess must be provided.
+ */
+type TenantSettingsCreateDefinition = {
+  customizeNoAccess?: CustomizeNoAccess;
+  preferredStartPage?: StartPage;
+};
+type TenantSettingsDefinition = {
+  readonly createdAt: string; /** userId of the user who created the settings */
+  createdBy: string; /** Set to true to enable cross-region inference, false to disable. */
+  crossRegionDataProcessing?: SetCrossRegionDataProcessingConfig;
+  customizeNoAccess?: CustomizeNoAccess;
+  readonly id: string;
+  preferredStartPage?: StartPageConfigHub | StartPageConfigCreationHub | StartPageConfigQdi | StartPageConfigConsole; /** Set the release cadence */
+  releaseCadence?: ReleaseCadenceConfig;
+  readonly tenantId: string;
+  readonly updatedAt: string; /** userId of the user who last modified the settings */
+  updatedBy?: string;
+};
+type TenantStartPagesResponse = {
+  defaultValue: "analytics-hub";
+  values: (StartPageConfigHub | StartPageConfigCreationHub | StartPageConfigQdi)[];
+};
+/**
+ * Deletes the tenant settings associated with the tenant ID specified in JWT. This is access controlled by the permission admin.tenant-settings:delete.
+ *
+ * @throws DeleteTenantSettingsHttpError
+ */
+declare function deleteTenantSettings(options?: ApiCallOptions): Promise<DeleteTenantSettingsHttpResponse>;
+type DeleteTenantSettingsHttpResponse = {
+  data: void;
+  headers: Headers;
+  status: 204;
+};
+type DeleteTenantSettingsHttpError = {
+  data: Error;
+  headers: Headers;
+  status: number;
+};
+/**
+ * Retrieves tenant settings associated with the tenant ID specified in JWT. This is access controlled by the permission admin.tenant-settings:read.
+ *
+ * @throws GetTenantSettingsHttpError
+ */
+declare function getTenantSettings(options?: ApiCallOptions): Promise<GetTenantSettingsHttpResponse>;
+type GetTenantSettingsHttpResponse = {
+  data: TenantSettingsDefinition;
+  headers: Headers;
+  status: 200;
+};
+type GetTenantSettingsHttpError = {
+  data: Error;
+  headers: Headers;
+  status: number;
+};
+/**
+ * Updates existing tenant settings. This is access controlled by the permission admin.tenant-settings:update.
+ *
+ * @param body an object with the body content
+ * @throws UpdateTenantSettingsHttpError
+ */
+declare function updateTenantSettings(body: PatchRequest, options?: ApiCallOptions): Promise<UpdateTenantSettingsHttpResponse>;
+type UpdateTenantSettingsHttpResponse = {
+  data: TenantSettingsDefinition;
+  headers: Headers;
+  status: 200;
+};
+type UpdateTenantSettingsHttpError = {
+  data: Error;
+  headers: Headers;
+  status: number;
+};
+/**
+ * Creates a new tenant settings entry for the tenant ID specified in the JWT. This is access controlled by the permission admin.tenant-settings:create.
+ *
+ * @param body an object with the body content
+ * @throws CreateTenantSettingsHttpError
+ */
+declare function createTenantSettings(body: TenantSettingsCreateDefinition, options?: ApiCallOptions): Promise<CreateTenantSettingsHttpResponse>;
+type CreateTenantSettingsHttpResponse = {
+  data: TenantSettingsDefinition;
+  headers: Headers;
+  status: 201;
+};
+type CreateTenantSettingsHttpError = CreateTenantSettings400HttpError | CreateTenantSettings401HttpError | CreateTenantSettings403HttpError | CreateTenantSettings500HttpError | CreateTenantSettingsdefaultHttpError;
+type CreateTenantSettings400HttpError = {
+  data: ErrorResponse400;
+  headers: Headers;
+  status: 400;
+};
+type CreateTenantSettings401HttpError = {
+  data: ErrorResponse401;
+  headers: Headers;
+  status: 401;
+};
+type CreateTenantSettings403HttpError = {
+  data: ErrorResponse403;
+  headers: Headers;
+  status: 403;
+};
+type CreateTenantSettings500HttpError = {
+  data: ErrorResponse500;
+  headers: Headers;
+  status: 500;
+};
+type CreateTenantSettingsdefaultHttpError = {
+  data: Error;
+  headers: Headers;
+  status: "default";
+};
+/**
+ * Sets the cross region inference setting for the tenant. Creates tenant settings if none exist, or updates existing settings. This is access controlled by the permission admin.tenant-settings:update.
+ * When cross-region processing is required, you must include an additional header x-qlik-consent-verified: true in your API requests to confirm that you have the authority to enable this feature and accept the associated terms.
+ *
+ * @param body an object with the body content
+ * @throws ToggleCrossRegionDataProcessingTenantSettingsHttpError
+ */
+declare function toggleCrossRegionDataProcessingTenantSettings(body: SetCrossRegionDataProcessing, options?: ApiCallOptions): Promise<ToggleCrossRegionDataProcessingTenantSettingsHttpResponse>;
+type ToggleCrossRegionDataProcessingTenantSettingsHttpResponse = {
+  data: TenantSettingsDefinition;
+  headers: Headers;
+  status: 200;
+};
+type ToggleCrossRegionDataProcessingTenantSettingsHttpError = {
+  data: Error;
+  headers: Headers;
+  status: number;
+};
+/**
+ * Retrieves start pages for the tenant settings.
+ *
+ * @throws GetStartPagesHttpError
+ */
+declare function getStartPages(options?: ApiCallOptions): Promise<GetStartPagesHttpResponse>;
+type GetStartPagesHttpResponse = {
+  data: TenantStartPagesResponse;
+  headers: Headers;
+  status: 200;
+};
+type GetStartPagesHttpError = {
+  data: Error;
+  headers: Headers;
+  status: number;
+};
+/**
+ * Clears the cache for tenant-settings api requests.
+ */
+declare function clearCache(): void;
+type TenantSettingsAPI = {
+  /**
+   * Deletes the tenant settings associated with the tenant ID specified in JWT. This is access controlled by the permission admin.tenant-settings:delete.
+   *
+   * @throws DeleteTenantSettingsHttpError
+   */
+  deleteTenantSettings: typeof deleteTenantSettings;
+  /**
+   * Retrieves tenant settings associated with the tenant ID specified in JWT. This is access controlled by the permission admin.tenant-settings:read.
+   *
+   * @throws GetTenantSettingsHttpError
+   */
+  getTenantSettings: typeof getTenantSettings;
+  /**
+   * Updates existing tenant settings. This is access controlled by the permission admin.tenant-settings:update.
+   *
+   * @param body an object with the body content
+   * @throws UpdateTenantSettingsHttpError
+   */
+  updateTenantSettings: typeof updateTenantSettings;
+  /**
+   * Creates a new tenant settings entry for the tenant ID specified in the JWT. This is access controlled by the permission admin.tenant-settings:create.
+   *
+   * @param body an object with the body content
+   * @throws CreateTenantSettingsHttpError
+   */
+  createTenantSettings: typeof createTenantSettings;
+  /**
+   * Sets the cross region inference setting for the tenant. Creates tenant settings if none exist, or updates existing settings. This is access controlled by the permission admin.tenant-settings:update.
+   * When cross-region processing is required, you must include an additional header x-qlik-consent-verified: true in your API requests to confirm that you have the authority to enable this feature and accept the associated terms.
+   *
+   * @param body an object with the body content
+   * @throws ToggleCrossRegionDataProcessingTenantSettingsHttpError
+   */
+  toggleCrossRegionDataProcessingTenantSettings: typeof toggleCrossRegionDataProcessingTenantSettings;
+  /**
+   * Retrieves start pages for the tenant settings.
+   *
+   * @throws GetStartPagesHttpError
+   */
+  getStartPages: typeof getStartPages;
+  /**
+   * Clears the cache for tenant-settings api requests.
+   */
+  clearCache: typeof clearCache;
+};
+/**
+ * Functions for the tenant-settings api
+ */
+declare const tenantSettingsExport: TenantSettingsAPI;
+//#endregion
+export { CreateTenantSettings400HttpError, CreateTenantSettings401HttpError, CreateTenantSettings403HttpError, CreateTenantSettings500HttpError, CreateTenantSettingsHttpError, CreateTenantSettingsHttpResponse, CreateTenantSettingsdefaultHttpError, CustomizeNoAccess, DeleteTenantSettingsHttpError, DeleteTenantSettingsHttpResponse, Error, ErrorResponse400, ErrorResponse401, ErrorResponse403, ErrorResponse500, GetStartPagesHttpError, GetStartPagesHttpResponse, GetTenantSettingsHttpError, GetTenantSettingsHttpResponse, JSONPatchRequestAddReplaceTest, JSONPatchRequestMoveCopy, JSONPatchRequestRemove, PatchRequest, ReleaseCadenceConfig, SetCrossRegionDataProcessing, SetCrossRegionDataProcessingConfig, StartPage, StartPageConfigConsole, StartPageConfigCreationHub, StartPageConfigHub, StartPageConfigQdi, TenantSettingsAPI, TenantSettingsCreateDefinition, TenantSettingsDefinition, TenantStartPagesResponse, ToggleCrossRegionDataProcessingTenantSettingsHttpError, ToggleCrossRegionDataProcessingTenantSettingsHttpResponse, UpdateTenantSettingsHttpError, UpdateTenantSettingsHttpResponse, clearCache, createTenantSettings, tenantSettingsExport as default, deleteTenantSettings, getStartPages, getTenantSettings, toggleCrossRegionDataProcessingTenantSettings, updateTenantSettings };

package/tenant-settings.js

@@ -0,0 +1,107 @@
+import "./chunks/public-runtime-modules-2KfyI2qM.js";
+import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-DMAi6Fg3.js";
+
+//#region src/public/rest/tenant-settings.ts
+/**
+* Deletes the tenant settings associated with the tenant ID specified in JWT. This is access controlled by the permission admin.tenant-settings:delete.
+*
+* @throws DeleteTenantSettingsHttpError
+*/
+async function deleteTenantSettings(options) {
+	return invokeFetch("tenant-settings", {
+		method: "delete",
+		pathTemplate: "/api/v1/tenant-settings",
+		options
+	});
+}
+/**
+* Retrieves tenant settings associated with the tenant ID specified in JWT. This is access controlled by the permission admin.tenant-settings:read.
+*
+* @throws GetTenantSettingsHttpError
+*/
+async function getTenantSettings(options) {
+	return invokeFetch("tenant-settings", {
+		method: "get",
+		pathTemplate: "/api/v1/tenant-settings",
+		options
+	});
+}
+/**
+* Updates existing tenant settings. This is access controlled by the permission admin.tenant-settings:update.
+*
+* @param body an object with the body content
+* @throws UpdateTenantSettingsHttpError
+*/
+async function updateTenantSettings(body, options) {
+	return invokeFetch("tenant-settings", {
+		method: "patch",
+		pathTemplate: "/api/v1/tenant-settings",
+		body,
+		contentType: "application/json",
+		options
+	});
+}
+/**
+* Creates a new tenant settings entry for the tenant ID specified in the JWT. This is access controlled by the permission admin.tenant-settings:create.
+*
+* @param body an object with the body content
+* @throws CreateTenantSettingsHttpError
+*/
+async function createTenantSettings(body, options) {
+	return invokeFetch("tenant-settings", {
+		method: "post",
+		pathTemplate: "/api/v1/tenant-settings",
+		body,
+		contentType: "application/json",
+		options
+	});
+}
+/**
+* Sets the cross region inference setting for the tenant. Creates tenant settings if none exist, or updates existing settings. This is access controlled by the permission admin.tenant-settings:update.
+* When cross-region processing is required, you must include an additional header x-qlik-consent-verified: true in your API requests to confirm that you have the authority to enable this feature and accept the associated terms.
+*
+* @param body an object with the body content
+* @throws ToggleCrossRegionDataProcessingTenantSettingsHttpError
+*/
+async function toggleCrossRegionDataProcessingTenantSettings(body, options) {
+	return invokeFetch("tenant-settings", {
+		method: "post",
+		pathTemplate: "/api/v1/tenant-settings/actions/toggle-cross-region-data-processing",
+		body,
+		contentType: "application/json",
+		options
+	});
+}
+/**
+* Retrieves start pages for the tenant settings.
+*
+* @throws GetStartPagesHttpError
+*/
+async function getStartPages(options) {
+	return invokeFetch("tenant-settings", {
+		method: "get",
+		pathTemplate: "/api/v1/tenant-settings/start-pages",
+		options
+	});
+}
+/**
+* Clears the cache for tenant-settings api requests.
+*/
+function clearCache() {
+	return clearApiCache("tenant-settings");
+}
+/**
+* Functions for the tenant-settings api
+*/
+const tenantSettingsExport = {
+	deleteTenantSettings,
+	getTenantSettings,
+	updateTenantSettings,
+	createTenantSettings,
+	toggleCrossRegionDataProcessingTenantSettings,
+	getStartPages,
+	clearCache
+};
+
+//#endregion
+export { clearCache, createTenantSettings, tenantSettingsExport as default, deleteTenantSettings, getStartPages, getTenantSettings, toggleCrossRegionDataProcessingTenantSettings, updateTenantSettings };

package/tenants.d.ts

@@ -1,27 +1,19 @@
-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/tenants.d.ts
 /**
  * An error object describing the error.
  */
 type Error = {
-  /** The error code. */
-  code: string;
-  /** A human-readable explanation specific to this occurrence of the error. */
-  detail?: string;
-  /** Additional properties relating to the error. */
-  meta?: unknown;
-  /** References to the source of the error. */
+  /** The error code. */code: string; /** A human-readable explanation specific to this occurrence of the error. */
+  detail?: string; /** Additional properties relating to the error. */
+  meta?: unknown; /** References to the source of the error. */
   source?: {
-    /** The URI query parameter that caused the error. */
-    parameter?: string;
-    /** A JSON Pointer to the property that caused the error. */
+    /** The URI query parameter that caused the error. */parameter?: string; /** A JSON Pointer to the property that caused the error. */
     pointer?: string;
-  };
-  /** The HTTP status code. */
-  status: string;
-  /** Summary of the problem. */
+  }; /** The HTTP status code. */
+  status: string; /** Summary of the problem. */
   title: string;
 };
 /**
@@ -38,41 +30,28 @@ type Error = {
  * }
  */
 type Errors = {
-  /** An array of errors related to the operation. */
-  errors?: Error[];
-  /** A unique identifier for tracing the error. */
+  /** An array of errors related to the operation. */errors?: Error[]; /** A unique identifier for tracing the error. */
   traceId?: string;
 };
 type Tenant = {
   autoAssignCreateSharedSpacesRoleToProfessionals?: boolean;
   autoAssignDataServicesContributorRoleToProfessionals?: boolean;
-  autoAssignPrivateAnalyticsContentCreatorRoleToProfessionals?: boolean;
-  /** The timestamp for when the tenant record was created (1970-01-01T00:00:00.001Z for static tenants). */
-  readonly created?: string;
-  /** The user ID who created the tenant. */
-  createdByUser?: string;
-  /** The datacenter where the tenant is located. */
+  autoAssignPrivateAnalyticsContentCreatorRoleToProfessionals?: boolean; /** The timestamp for when the tenant record was created (1970-01-01T00:00:00.001Z for static tenants). */
+  readonly created?: string; /** The user ID who created the tenant. */
+  createdByUser?: string; /** The datacenter where the tenant is located. */
   datacenter?: string;
   enableAnalyticCreation?: boolean;
-  enableAppOpeningFeedback?: boolean;
-  /** List of case insensitive hostnames that are mapped to the tenant. The first record maps to the display name and the subsequent entries are aliases. */
-  hostnames?: string[];
-  /** The unique tenant identifier. */
-  readonly id: string;
-  /** The timestamp for when the tenant record was last updated (1970-01-01T00:00:00.001Z for static tenants). */
+  enableAppOpeningFeedback?: boolean; /** List of case insensitive hostnames that are mapped to the tenant. The first record maps to the display name and the subsequent entries are aliases. */
+  hostnames?: string[]; /** The unique tenant identifier. */
+  readonly id: string; /** The timestamp for when the tenant record was last updated (1970-01-01T00:00:00.001Z for static tenants). */
   readonly lastUpdated?: string;
   readonly links?: {
-    /** A link to this tenant. */
-    self: {
-      /** URL that defines the resource. */
-      href: string;
+    /** A link to this tenant. */self: {
+      /** URL that defines the resource. */href: string;
     };
-  };
-  /** The display name of the tenant. */
-  name: string;
-  /** The region where the tenant is located. */
-  readonly region?: string;
-  /** The status of the tenant. */
+  }; /** The display name of the tenant. */
+  name: string; /** The region where the tenant is located. */
+  readonly region?: string; /** The status of the tenant. */
   status?: "active" | "disabled" | "deleted";
 };
 type TenantCreationRequest = {
@@ -86,42 +65,32 @@ type TenantCreationRequest = {
    * - `eu-west-1`: Ireland (eu)
    * - `eu-west-2`: United Kingdom (uk)
    * - `us-east-1`: United States of America (us) */
-  datacenter?: string;
-  /** The signed license key of the license that will be associated with the created tenant. */
+  datacenter?: string; /** The signed license key of the license that will be associated with the created tenant. */
   licenseKey?: string;
 };
 /**
  * A request to deactivate a tenant.
  */
 type TenantDeactivateRequest = {
-  /** Sets the number of days to purge the tenant after deactivation. Only available to OEMs. */
-  purgeAfterDays?: number;
+  /** Sets the number of days to purge the tenant after deactivation. Only available to OEMs. */purgeAfterDays?: number;
 };
 /**
  * The result of tenant deactivation.
  */
 type TenantDeactivateResponse = {
-  /** The estimated date time of when tenant will be purged. */
-  estimatedPurgeDate?: string;
-  /** The unique tenant identifier. */
-  readonly id?: string;
-  /** The status of the tenant. */
+  /** The estimated date time of when tenant will be purged. */estimatedPurgeDate?: string; /** The unique tenant identifier. */
+  readonly id?: string; /** The status of the tenant. */
   status?: "disabled";
 };
 type TenantMultipleMetaErrorsDetail = TenantSingleMetaErrorDetail[];
 type TenantPatchErrors = {
   errors?: {
-    /** The error code. */
-    code: string;
-    meta?: TenantSingleMetaErrorDetail | TenantMultipleMetaErrorsDetail;
-    /** References to the source of the error. */
+    /** The error code. */code: string;
+    meta?: TenantSingleMetaErrorDetail | TenantMultipleMetaErrorsDetail; /** References to the source of the error. */
     source?: {
-      /** The URI query parameter that caused the error. */
-      parameter?: string;
-      /** A JSON Pointer to the property that caused the error. */
+      /** The URI query parameter that caused the error. */parameter?: string; /** A JSON Pointer to the property that caused the error. */
       pointer?: string;
-    };
-    /** Summary of the problem. */
+    }; /** Summary of the problem. */
     title: string;
   }[];
 };
@@ -161,17 +130,12 @@ type TenantPatchErrors = {
  * ]
  */
 type TenantPatchSchema = {
-  /** The operation to be performed. */
-  op: "replace";
-  /** A JSON Pointer value that references a location within the target document where the operation is performed. */
-  path: "/name" | "/hostnames/1" | "/autoAssignCreateSharedSpacesRoleToProfessionals" | "/autoAssignPrivateAnalyticsContentCreatorRoleToProfessionals" | "/autoAssignDataServicesContributorRoleToProfessionals" | "/enableAnalyticCreation" | "/enableAppOpeningFeedback";
-  /** The value to be used for this operation. */
+  /** The operation to be performed. */op: "replace"; /** A JSON Pointer value that references a location within the target document where the operation is performed. */
+  path: "/name" | "/hostnames/1" | "/autoAssignCreateSharedSpacesRoleToProfessionals" | "/autoAssignPrivateAnalyticsContentCreatorRoleToProfessionals" | "/autoAssignDataServicesContributorRoleToProfessionals" | "/enableAnalyticCreation" | "/enableAppOpeningFeedback"; /** The value to be used for this operation. */
   value: string | boolean;
 }[];
 type TenantSingleMetaErrorDetail = {
-  /** The error code. */
-  code?: string;
-  /** The error summary. */
+  /** The error code. */code?: string; /** The error summary. */
   title?: string;
 };
 /**

package/tenants.js

@@ -1,5 +1,5 @@
-import "./chunks/public-runtime-modules-QhLPeQr5.js";
-import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-B7lGscuQ.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/tenants.ts
 /**
@@ -112,7 +112,6 @@ const tenantsExport = {
 	reactivateTenant,
 	clearCache
 };
-var tenants_default = tenantsExport;
 
 //#endregion
-export { clearCache, createTenant, deactivateTenant, tenants_default as default, getMyTenant, getTenant, patchTenant, reactivateTenant };
+export { clearCache, createTenant, deactivateTenant, tenantsExport as default, getMyTenant, getTenant, patchTenant, reactivateTenant };