@qlik/api 2.2.0 → 2.3.0

package/chunks/temp-contents-zDomB-g6.d.ts

@@ -1,168 +0,0 @@
-import { y as ApiCallOptions } from "./auth-types-E99tzdN0.js";
-
-//#region src/public/rest/temp-contents.d.ts
-
-/**
- * An Error object.
- */
-type Error = {
-  /** The API error code. */
-  code: string;
-  /** A human-readable problem description of the issue. */
-  detail?: string;
-  /** Additional properties and information regarding the issue. */
-  meta?: {
-    /** The error type. */
-    errorType?: string;
-    /** Locale */
-    locale?: string;
-    /** The source errors (stack trace). */
-    sourceErrors?: string;
-  };
-  /** Title of the type of API Error. */
-  title: string;
-};
-/**
- * An array of Error objects.
- */
-type Errors = {
-  errors?: Error[];
-  /** A way to trace the source of the error. */
-  traceId?: string;
-};
-type DetailResponse = {
-  /** Datetime-stamp when the resource was created (in UTC). */
-  CreatedAt?: string;
-  /** Identifier for the subject / resource creator. */
-  CreatorID?: string;
-  /** Datetime-stamp when the resource expired (in UTC). */
-  Expires?: string;
-  /** Identifier */
-  ID?: string;
-  /** File name of the file uploaded by the user. */
-  Name?: string;
-  /** Size of resource (in bytes). */
-  Size?: string;
-  /** Time-to-live in seconds. */
-  TTLSeconds?: number;
-  /** Datetime-stamp when the resource was updated (in UTC). */
-  UpdatedAt?: string;
-};
-/**
- * Upload a file as a temporary content resource. It returns a `201 Created` with a location header that contains the location of the created resource. If filename or TTL is not properly set, a `400 Bad request` is returned. For internal issues, a `500 Internal Server Error` is returned.
- *
- * @param query an object with query parameters
- * @param body an object with the body content
- * @throws UploadTempFileHttpError
- */
-declare function uploadTempFile(query: {
-  /** The name of the file to upload. */
-  filename?: string;
-  /** The TTL parameter is used to define the time-to-live for the content resource in seconds.
-   * It defaults to one hour (3600) if no input is provided. Max TTL is 259200 (3 days).' */
-  ttl?: number;
-}, body: BodyInit, options?: ApiCallOptions): Promise<UploadTempFileHttpResponse>;
-type UploadTempFileHttpResponse = {
-  data: void;
-  headers: Headers;
-  status: 201;
-};
-type UploadTempFileHttpError = {
-  data: Errors;
-  headers: Headers;
-  status: 400;
-};
-/**
- * This endpoint is used to retrieve a temporary content file. It returns a valid (`200 OK`) in case the file exists and the user is authorized to view the contents. It returns a `410 Gone` if the file has expired and `404 Not Found` if the criteria is not met.
- *
- * @param id The temporary contents ID.
- * @param query an object with query parameters
- * @throws DownloadTempFileHttpError
- */
-declare function downloadTempFile(id: string, query: {
-  /** Set to "1" to download the file in inline mode. Useful for displaying a preview of the file in a browser. */
-  inline?: string;
-}, options?: ApiCallOptions): Promise<DownloadTempFileHttpResponse>;
-type DownloadTempFileHttpResponse = DownloadTempFile200HttpResponse | DownloadTempFile204HttpResponse | DownloadTempFile206HttpResponse;
-type DownloadTempFile200HttpResponse = {
-  data: unknown;
-  headers: Headers;
-  status: 200;
-};
-type DownloadTempFile204HttpResponse = {
-  data: void;
-  headers: Headers;
-  status: 204;
-};
-type DownloadTempFile206HttpResponse = {
-  data: unknown;
-  headers: Headers;
-  status: 206;
-};
-type DownloadTempFileHttpError = {
-  data: Errors;
-  headers: Headers;
-  status: 400 | 404 | 410 | 416;
-};
-/**
- * Retrieve a summary of the metadata associated with a temporary content resource. It returns a `200 OK` with a model if the temporary resource is valid. It returns a `410 Gone` if the file has expired and `404 Not Found` if the criteria is not met.
- *
- * @param id The temporary contents ID.
- * @throws GetTempFileDetailsHttpError
- */
-declare function getTempFileDetails(id: string, options?: ApiCallOptions): Promise<GetTempFileDetailsHttpResponse>;
-type GetTempFileDetailsHttpResponse = GetTempFileDetails200HttpResponse | GetTempFileDetails204HttpResponse;
-type GetTempFileDetails200HttpResponse = {
-  data: DetailResponse;
-  headers: Headers;
-  status: 200;
-};
-type GetTempFileDetails204HttpResponse = {
-  data: void;
-  headers: Headers;
-  status: 204;
-};
-type GetTempFileDetailsHttpError = {
-  data: Errors;
-  headers: Headers;
-  status: 400 | 404 | 410;
-};
-/**
- * Clears the cache for temp-contents api requests.
- */
-declare function clearCache(): void;
-type TempContentsAPI = {
-  /**
-   * Upload a file as a temporary content resource. It returns a `201 Created` with a location header that contains the location of the created resource. If filename or TTL is not properly set, a `400 Bad request` is returned. For internal issues, a `500 Internal Server Error` is returned.
-   *
-   * @param query an object with query parameters
-   * @param body an object with the body content
-   * @throws UploadTempFileHttpError
-   */
-  uploadTempFile: typeof uploadTempFile;
-  /**
-   * This endpoint is used to retrieve a temporary content file. It returns a valid (`200 OK`) in case the file exists and the user is authorized to view the contents. It returns a `410 Gone` if the file has expired and `404 Not Found` if the criteria is not met.
-   *
-   * @param id The temporary contents ID.
-   * @param query an object with query parameters
-   * @throws DownloadTempFileHttpError
-   */
-  downloadTempFile: typeof downloadTempFile;
-  /**
-   * Retrieve a summary of the metadata associated with a temporary content resource. It returns a `200 OK` with a model if the temporary resource is valid. It returns a `410 Gone` if the file has expired and `404 Not Found` if the criteria is not met.
-   *
-   * @param id The temporary contents ID.
-   * @throws GetTempFileDetailsHttpError
-   */
-  getTempFileDetails: typeof getTempFileDetails;
-  /**
-   * Clears the cache for temp-contents api requests.
-   */
-  clearCache: typeof clearCache;
-};
-/**
- * Functions for the temp-contents api
- */
-declare const tempContentsExport: TempContentsAPI;
-//#endregion
-export { downloadTempFile as _, DownloadTempFileHttpError as a, uploadTempFile as b, Errors as c, GetTempFileDetailsHttpError as d, GetTempFileDetailsHttpResponse as f, clearCache as g, UploadTempFileHttpResponse as h, DownloadTempFile206HttpResponse as i, GetTempFileDetails200HttpResponse as l, UploadTempFileHttpError as m, DownloadTempFile200HttpResponse as n, DownloadTempFileHttpResponse as o, TempContentsAPI as p, DownloadTempFile204HttpResponse as r, Error as s, DetailResponse as t, GetTempFileDetails204HttpResponse as u, getTempFileDetails as v, tempContentsExport as y };

package/chunks/tenants-Bhn86519.d.ts

@@ -1,361 +0,0 @@
-import { y as ApiCallOptions } from "./auth-types-E99tzdN0.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. */
-  source?: {
-    /** 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. */
-  title: string;
-};
-/**
- * The error response object describing the error from the handling of an HTTP request.
- * @example
- * {
- *   errors: [
- *     {
- *       code: "TENANTS-8",
- *       title: "Not found"
- *     }
- *   ],
- *   traceId: "000000000000000079cf1ebeae103de1"
- * }
- */
-type Errors = {
-  /** 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. */
-  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). */
-  readonly lastUpdated?: string;
-  readonly links?: {
-    /** 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. */
-  status?: "active" | "disabled" | "deleted";
-};
-type TenantCreationRequest = {
-  /** The datacenter where the tenant is located.
-   *
-   * Supported locations for commercial licenses:
-   * - `ap-northeast-1`: Japan (jp)
-   * - `ap-southeast-1`: Australia (ap)
-   * - `ap-southeast-2`: Singapore (sg)
-   * - `eu-central-1`: Germany (de)
-   * - `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. */
-  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;
-};
-/**
- * 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. */
-  status?: "disabled";
-};
-type TenantMultipleMetaErrorsDetail = TenantSingleMetaErrorDetail[];
-type TenantPatchErrors = {
-  errors?: {
-    /** 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. */
-      pointer?: string;
-    };
-    /** Summary of the problem. */
-    title: string;
-  }[];
-};
-/**
- * @example
- * [
- *   {
- *     op: "replace",
- *     path: "/name",
- *     value: "Corp"
- *   },
- *   {
- *     op: "replace",
- *     path: "/hostnames/1",
- *     value: "example-tenant.us.qlikcloud.com"
- *   },
- *   {
- *     op: "replace",
- *     path: "/autoAssignCreateSharedSpacesRoleToProfessionals",
- *     value: true
- *   },
- *   {
- *     op: "replace",
- *     path: "/autoAssignPrivateAnalyticsContentCreatorRoleToProfessionals",
- *     value: false
- *   },
- *   {
- *     op: "replace",
- *     path: "/autoAssignDataServicesContributorRoleToProfessionals",
- *     value: true
- *   },
- *   {
- *     op: "replace",
- *     path: "/enableAnalyticCreation",
- *     value: false
- *   }
- * ]
- */
-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. */
-  value: string | boolean;
-}[];
-type TenantSingleMetaErrorDetail = {
-  /** The error code. */
-  code?: string;
-  /** The error summary. */
-  title?: string;
-};
-/**
- * Creates a tenant in the requested region, linked to the provided license key. You must use a regional OAuth client generated via the [My Qlik portal](https://account.myqlik.qlik.com/account) to call this endpoint. Tenant creation, deactivation, and reactivation requests must be sent to the register endpoint in the relevant Qlik Cloud region, e.g. `https://register.us.qlikcloud.com/api/v1/tenants` if interacting with tenants in the `us` region.
- *
- * @param body an object with the body content
- * @throws CreateTenantHttpError
- */
-declare function createTenant(body: TenantCreationRequest, options?: ApiCallOptions): Promise<CreateTenantHttpResponse>;
-type CreateTenantHttpResponse = {
-  data: Tenant;
-  headers: Headers;
-  status: 201;
-};
-type CreateTenantHttpError = {
-  data: Errors;
-  headers: Headers;
-  status: number;
-};
-/**
- * Redirects to current tenant.
- *
- * @throws GetMyTenantHttpError
- */
-declare function getMyTenant(options?: ApiCallOptions): Promise<GetMyTenantHttpResponse>;
-type GetMyTenantHttpResponse = {
-  data: Tenant;
-  headers: Headers;
-  status: 200;
-};
-type GetMyTenantHttpError = {
-  data: unknown;
-  headers: Headers;
-  status: number;
-};
-/**
- * Retrieves a specific tenant by ID.
- *
- * @param tenantId The ID of the tenant to retrieve
- * @throws GetTenantHttpError
- */
-declare function getTenant(tenantId: string, options?: ApiCallOptions): Promise<GetTenantHttpResponse>;
-type GetTenantHttpResponse = {
-  data: Tenant;
-  headers: Headers;
-  status: 200;
-};
-type GetTenantHttpError = {
-  data: Errors;
-  headers: Headers;
-  status: number;
-};
-/**
- * Updates properties of a specific tenant by ID.
- *
- * @param tenantId The ID of the tenant to update
- * @param body an object with the body content
- * @throws PatchTenantHttpError
- */
-declare function patchTenant(tenantId: string, body: TenantPatchSchema, options?: ApiCallOptions): Promise<PatchTenantHttpResponse>;
-type PatchTenantHttpResponse = {
-  data: void;
-  headers: Headers;
-  status: 204;
-};
-type PatchTenantHttpError = PatchTenant400HttpError | PatchTenant403HttpError | PatchTenant404HttpError | PatchTenant429HttpError | PatchTenantdefaultHttpError;
-type PatchTenant400HttpError = {
-  data: TenantPatchErrors;
-  headers: Headers;
-  status: 400;
-};
-type PatchTenant403HttpError = {
-  data: Errors;
-  headers: Headers;
-  status: 403;
-};
-type PatchTenant404HttpError = {
-  data: Errors;
-  headers: Headers;
-  status: 404;
-};
-type PatchTenant429HttpError = {
-  data: Errors;
-  headers: Headers;
-  status: 429;
-};
-type PatchTenantdefaultHttpError = {
-  data: Errors;
-  headers: Headers;
-  status: "default";
-};
-/**
- * Deactivates a specific tenant. Once deactivated, tenant will be deleted on or after `estimatedPurgeDate`. Tenant can be reactivated using `/v1/tenants/{tenantId}/actions/reactivate` until this date. You must use a regional OAuth client generated via the [My Qlik portal](https://account.myqlik.qlik.com/account) to call this endpoint. Tenant creation, deactivation, and reactivation requests must be sent to the register endpoint in the relevant Qlik Cloud region, e.g. `https://register.us.qlikcloud.com/api/v1/tenants/{tenantId}/actions/deactivate` if interacting with tenants in the `us` region.
- *
- * @param tenantId The id of the tenant to deactivate
- * @param body an object with the body content
- * @throws DeactivateTenantHttpError
- */
-declare function deactivateTenant(tenantId: string, body: TenantDeactivateRequest, options?: ApiCallOptions): Promise<DeactivateTenantHttpResponse>;
-type DeactivateTenantHttpResponse = {
-  data: TenantDeactivateResponse;
-  headers: Headers;
-  status: 200;
-};
-type DeactivateTenantHttpError = {
-  data: Errors;
-  headers: Headers;
-  status: number;
-};
-/**
- * Reactivates a deactivated tenant. Tenants can be reactivated until the `estimatedPurgeDate` provided at time of deactivation. You must use a regional OAuth client generated via the [My Qlik portal](https://account.myqlik.qlik.com/account) to call this endpoint. Tenant creation, deactivation, and reactivation requests must be sent to the register endpoint in the relevant Qlik Cloud region, e.g. `https://register.us.qlikcloud.com/api/v1/tenants/{tenantId}/actions/reactivate` if interacting with tenants in the `us` region.
- *
- * @param tenantId The id of the tenant to reactivate
- * @param body an object with the body content
- * @throws ReactivateTenantHttpError
- */
-declare function reactivateTenant(tenantId: string, body: unknown, options?: ApiCallOptions): Promise<ReactivateTenantHttpResponse>;
-type ReactivateTenantHttpResponse = {
-  data: unknown;
-  headers: Headers;
-  status: 200;
-};
-type ReactivateTenantHttpError = {
-  data: Errors;
-  headers: Headers;
-  status: number;
-};
-/**
- * Clears the cache for tenants api requests.
- */
-declare function clearCache(): void;
-type TenantsAPI = {
-  /**
-   * Creates a tenant in the requested region, linked to the provided license key. You must use a regional OAuth client generated via the [My Qlik portal](https://account.myqlik.qlik.com/account) to call this endpoint. Tenant creation, deactivation, and reactivation requests must be sent to the register endpoint in the relevant Qlik Cloud region, e.g. `https://register.us.qlikcloud.com/api/v1/tenants` if interacting with tenants in the `us` region.
-   *
-   * @param body an object with the body content
-   * @throws CreateTenantHttpError
-   */
-  createTenant: typeof createTenant;
-  /**
-   * Redirects to current tenant.
-   *
-   * @throws GetMyTenantHttpError
-   */
-  getMyTenant: typeof getMyTenant;
-  /**
-   * Retrieves a specific tenant by ID.
-   *
-   * @param tenantId The ID of the tenant to retrieve
-   * @throws GetTenantHttpError
-   */
-  getTenant: typeof getTenant;
-  /**
-   * Updates properties of a specific tenant by ID.
-   *
-   * @param tenantId The ID of the tenant to update
-   * @param body an object with the body content
-   * @throws PatchTenantHttpError
-   */
-  patchTenant: typeof patchTenant;
-  /**
-   * Deactivates a specific tenant. Once deactivated, tenant will be deleted on or after `estimatedPurgeDate`. Tenant can be reactivated using `/v1/tenants/{tenantId}/actions/reactivate` until this date. You must use a regional OAuth client generated via the [My Qlik portal](https://account.myqlik.qlik.com/account) to call this endpoint. Tenant creation, deactivation, and reactivation requests must be sent to the register endpoint in the relevant Qlik Cloud region, e.g. `https://register.us.qlikcloud.com/api/v1/tenants/{tenantId}/actions/deactivate` if interacting with tenants in the `us` region.
-   *
-   * @param tenantId The id of the tenant to deactivate
-   * @param body an object with the body content
-   * @throws DeactivateTenantHttpError
-   */
-  deactivateTenant: typeof deactivateTenant;
-  /**
-   * Reactivates a deactivated tenant. Tenants can be reactivated until the `estimatedPurgeDate` provided at time of deactivation. You must use a regional OAuth client generated via the [My Qlik portal](https://account.myqlik.qlik.com/account) to call this endpoint. Tenant creation, deactivation, and reactivation requests must be sent to the register endpoint in the relevant Qlik Cloud region, e.g. `https://register.us.qlikcloud.com/api/v1/tenants/{tenantId}/actions/reactivate` if interacting with tenants in the `us` region.
-   *
-   * @param tenantId The id of the tenant to reactivate
-   * @param body an object with the body content
-   * @throws ReactivateTenantHttpError
-   */
-  reactivateTenant: typeof reactivateTenant;
-  /**
-   * Clears the cache for tenants api requests.
-   */
-  clearCache: typeof clearCache;
-};
-/**
- * Functions for the tenants api
- */
-declare const tenantsExport: TenantsAPI;
-//#endregion
-export { createTenant as A, TenantDeactivateResponse as C, TenantSingleMetaErrorDetail as D, TenantPatchSchema as E, reactivateTenant as F, tenantsExport as I, getMyTenant as M, getTenant as N, TenantsAPI as O, patchTenant as P, TenantDeactivateRequest as S, TenantPatchErrors as T, PatchTenantdefaultHttpError as _, Error as a, Tenant as b, GetMyTenantHttpResponse as c, PatchTenant400HttpError as d, PatchTenant403HttpError as f, PatchTenantHttpResponse as g, PatchTenantHttpError as h, DeactivateTenantHttpResponse as i, deactivateTenant as j, clearCache as k, GetTenantHttpError as l, PatchTenant429HttpError as m, CreateTenantHttpResponse as n, Errors as o, PatchTenant404HttpError as p, DeactivateTenantHttpError as r, GetMyTenantHttpError as s, CreateTenantHttpError as t, GetTenantHttpResponse as u, ReactivateTenantHttpError as v, TenantMultipleMetaErrorsDetail as w, TenantCreationRequest as x, ReactivateTenantHttpResponse as y };