@qlik/api 0.0.16 → 0.1.0

package/temp-contents.d.mts

@@ -1,167 +0,0 @@
-import { A as ApiCallOptions } from './global.types-5iFvFJvX.mjs';
-import './auth-types-nnUcWhuU.mjs';
-
-/**
- * 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;
-};
-/**
- * This endpoint is used to 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 const 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: number;
-};
-type UploadTempFileHttpError = {
-    data: Errors;
-    headers: Headers;
-    status: number;
-};
-/**
- * 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 const 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 DownloadTempFile200HttpResponse = {
-    data: unknown;
-    headers: Headers;
-    status: 200;
-};
-type DownloadTempFile204HttpResponse = {
-    data: void;
-    headers: Headers;
-    status: 204;
-};
-type DownloadTempFile206HttpResponse = {
-    data: unknown;
-    headers: Headers;
-    status: 206;
-};
-type DownloadTempFileHttpResponse = DownloadTempFile200HttpResponse | DownloadTempFile204HttpResponse | DownloadTempFile206HttpResponse;
-type DownloadTempFileHttpError = {
-    data: Errors;
-    headers: Headers;
-    status: number;
-};
-/**
- * This endpoint is used to 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 const getTempFileDetails: (id: string, options?: ApiCallOptions) => Promise<GetTempFileDetailsHttpResponse>;
-type GetTempFileDetails200HttpResponse = {
-    data: DetailResponse;
-    headers: Headers;
-    status: 200;
-};
-type GetTempFileDetails204HttpResponse = {
-    data: void;
-    headers: Headers;
-    status: 204;
-};
-type GetTempFileDetailsHttpResponse = GetTempFileDetails200HttpResponse | GetTempFileDetails204HttpResponse;
-type GetTempFileDetailsHttpError = {
-    data: Errors;
-    headers: Headers;
-    status: number;
-};
-/**
- * Clears the cache for temp-contents api requests.
- */
-declare function clearCache(): void;
-interface TempContentsAPI {
-    /**
-     * This endpoint is used to 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;
-    /**
-     * This endpoint is used to 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;
-
-export { type DetailResponse, type DownloadTempFile200HttpResponse, type DownloadTempFile204HttpResponse, type DownloadTempFile206HttpResponse, type DownloadTempFileHttpError, type DownloadTempFileHttpResponse, type Error, type Errors, type GetTempFileDetails200HttpResponse, type GetTempFileDetails204HttpResponse, type GetTempFileDetailsHttpError, type GetTempFileDetailsHttpResponse, type TempContentsAPI, type UploadTempFileHttpError, type UploadTempFileHttpResponse, clearCache, tempContentsExport as default, downloadTempFile, getTempFileDetails, uploadTempFile };

package/temp-contents.mjs

@@ -1,41 +0,0 @@
-import {
-  clearApiCache,
-  invokeFetch
-} from "./chunks/3YV6X7S6.mjs";
-import "./chunks/EHAANYDL.mjs";
-import "./chunks/VSY5YIQY.mjs";
-
-// src/public/rest/temp-contents.ts
-var uploadTempFile = async (query, body, options) => invokeFetch("temp-contents", {
-  method: "post",
-  pathTemplate: "/api/v1/temp-contents",
-  query,
-  body,
-  contentType: "application/octet-stream",
-  options
-});
-var downloadTempFile = async (id, query, options) => invokeFetch("temp-contents", {
-  method: "get",
-  pathTemplate: "/api/v1/temp-contents/{id}",
-  pathVariables: { id },
-  query,
-  options
-});
-var getTempFileDetails = async (id, options) => invokeFetch("temp-contents", {
-  method: "get",
-  pathTemplate: "/api/v1/temp-contents/{id}/details",
-  pathVariables: { id },
-  options
-});
-function clearCache() {
-  return clearApiCache("temp-contents");
-}
-var tempContentsExport = { uploadTempFile, downloadTempFile, getTempFileDetails, clearCache };
-var temp_contents_default = tempContentsExport;
-export {
-  clearCache,
-  temp_contents_default as default,
-  downloadTempFile,
-  getTempFileDetails,
-  uploadTempFile
-};

package/tenants.d.mts

@@ -1,300 +0,0 @@
-import { A as ApiCallOptions } from './global.types-5iFvFJvX.mjs';
-import './auth-types-nnUcWhuU.mjs';
-
-/**
- * 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.
- */
-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;
-    /** 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 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 status of the tenant. */
-    status?: "active" | "disabled" | "deleted";
-};
-type TenantCreationRequest = {
-    /** The datacenter where the tenant is located. */
-    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 TenantPatchErrors = {
-    errors?: {
-        /** The error code. */
-        code: string;
-        /** Additional properties relating to the error. */
-        meta?: {
-            /** The error code. */
-            code?: string;
-            /** Summary of the problem. */
-            title?: string;
-        };
-        /** 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;
-    }[];
-};
-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";
-    /** The value to be used for this operation. */
-    value: string | boolean;
-}[];
-/**
- * Creates a Tenant
- *
- * @param body an object with the body content
- * @throws CreateTenantHttpError
- */
-declare const createTenant: (body: TenantCreationRequest, options?: ApiCallOptions) => Promise<CreateTenantHttpResponse>;
-type CreateTenantHttpResponse = {
-    data: Tenant;
-    headers: Headers;
-    status: number;
-};
-type CreateTenantHttpError = {
-    data: Errors;
-    headers: Headers;
-    status: number;
-};
-/**
- * Redirects to current tenant.
- *
- * @throws GetMyTenantHttpError
- */
-declare const getMyTenant: (options?: ApiCallOptions) => Promise<GetMyTenantHttpResponse>;
-type GetMyTenantHttpResponse = {
-    data: Tenant;
-    headers: Headers;
-    status: number;
-};
-type GetMyTenantHttpError = {
-    data: unknown;
-    headers: Headers;
-    status: number;
-};
-/**
- * Retrieve a single tenant by id.
- *
- * @param tenantId The id of the tenant to retrieve
- * @throws GetTenantHttpError
- */
-declare const getTenant: (tenantId: string, options?: ApiCallOptions) => Promise<GetTenantHttpResponse>;
-type GetTenantHttpResponse = {
-    data: Tenant;
-    headers: Headers;
-    status: number;
-};
-type GetTenantHttpError = {
-    data: Errors;
-    headers: Headers;
-    status: number;
-};
-/**
- * Update a tenant by id.
- *
- * @param tenantId The id of the tenant to update
- * @param body an object with the body content
- * @throws PatchTenantHttpError
- */
-declare const patchTenant: (tenantId: string, body: TenantPatchSchema, options?: ApiCallOptions) => Promise<PatchTenantHttpResponse>;
-type PatchTenantHttpResponse = {
-    data: void;
-    headers: Headers;
-    status: number;
-};
-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";
-};
-type PatchTenantHttpError = PatchTenant400HttpError | PatchTenant403HttpError | PatchTenant404HttpError | PatchTenant429HttpError | PatchTenantDefaultHttpError;
-/**
- * Deactivates a tenant.
- *
- * @param tenantId The id of the tenant to deactivate
- * @param body an object with the body content
- * @throws DeactivateTenantHttpError
- */
-declare const deactivateTenant: (tenantId: string, body: TenantDeactivateRequest, options?: ApiCallOptions) => Promise<DeactivateTenantHttpResponse>;
-type DeactivateTenantHttpResponse = {
-    data: TenantDeactivateResponse;
-    headers: Headers;
-    status: number;
-};
-type DeactivateTenantHttpError = {
-    data: Errors;
-    headers: Headers;
-    status: number;
-};
-/**
- * Reactivates a disabled tenant.
- *
- * @param tenantId The id of the tenant to reactivate
- * @param body an object with the body content
- * @throws ReactivateTenantHttpError
- */
-declare const reactivateTenant: (tenantId: string, body: unknown, options?: ApiCallOptions) => Promise<ReactivateTenantHttpResponse>;
-type ReactivateTenantHttpResponse = {
-    data: unknown;
-    headers: Headers;
-    status: number;
-};
-type ReactivateTenantHttpError = {
-    data: Errors;
-    headers: Headers;
-    status: number;
-};
-/**
- * Clears the cache for tenants api requests.
- */
-declare function clearCache(): void;
-interface TenantsAPI {
-    /**
-     * Creates a Tenant
-     *
-     * @param body an object with the body content
-     * @throws CreateTenantHttpError
-     */
-    createTenant: typeof createTenant;
-    /**
-     * Redirects to current tenant.
-     *
-     * @throws GetMyTenantHttpError
-     */
-    getMyTenant: typeof getMyTenant;
-    /**
-     * Retrieve a single tenant by id.
-     *
-     * @param tenantId The id of the tenant to retrieve
-     * @throws GetTenantHttpError
-     */
-    getTenant: typeof getTenant;
-    /**
-     * Update a 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 tenant.
-     *
-     * @param tenantId The id of the tenant to deactivate
-     * @param body an object with the body content
-     * @throws DeactivateTenantHttpError
-     */
-    deactivateTenant: typeof deactivateTenant;
-    /**
-     * Reactivates a disabled tenant.
-     *
-     * @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;
-
-export { type CreateTenantHttpError, type CreateTenantHttpResponse, type DeactivateTenantHttpError, type DeactivateTenantHttpResponse, type Error, type Errors, type GetMyTenantHttpError, type GetMyTenantHttpResponse, type GetTenantHttpError, type GetTenantHttpResponse, type PatchTenant400HttpError, type PatchTenant403HttpError, type PatchTenant404HttpError, type PatchTenant429HttpError, type PatchTenantDefaultHttpError, type PatchTenantHttpError, type PatchTenantHttpResponse, type ReactivateTenantHttpError, type ReactivateTenantHttpResponse, type Tenant, type TenantCreationRequest, type TenantDeactivateRequest, type TenantDeactivateResponse, type TenantPatchErrors, type TenantPatchSchema, type TenantsAPI, clearCache, createTenant, deactivateTenant, tenantsExport as default, getMyTenant, getTenant, patchTenant, reactivateTenant };

package/tenants.mjs

@@ -1,73 +0,0 @@
-import {
-  clearApiCache,
-  invokeFetch
-} from "./chunks/3YV6X7S6.mjs";
-import "./chunks/EHAANYDL.mjs";
-import "./chunks/VSY5YIQY.mjs";
-
-// src/public/rest/tenants.ts
-var createTenant = async (body, options) => invokeFetch("tenants", {
-  method: "post",
-  pathTemplate: "/api/v1/tenants",
-  body,
-  contentType: "application/json",
-  options
-});
-var getMyTenant = async (options) => invokeFetch("tenants", {
-  method: "get",
-  pathTemplate: "/api/v1/tenants/me",
-  options
-});
-var getTenant = async (tenantId, options) => invokeFetch("tenants", {
-  method: "get",
-  pathTemplate: "/api/v1/tenants/{tenantId}",
-  pathVariables: { tenantId },
-  options
-});
-var patchTenant = async (tenantId, body, options) => invokeFetch("tenants", {
-  method: "patch",
-  pathTemplate: "/api/v1/tenants/{tenantId}",
-  pathVariables: { tenantId },
-  body,
-  contentType: "application/json",
-  options
-});
-var deactivateTenant = async (tenantId, body, options) => invokeFetch("tenants", {
-  method: "post",
-  pathTemplate: "/api/v1/tenants/{tenantId}/actions/deactivate",
-  pathVariables: { tenantId },
-  body,
-  contentType: "application/json",
-  options
-});
-var reactivateTenant = async (tenantId, body, options) => invokeFetch("tenants", {
-  method: "post",
-  pathTemplate: "/api/v1/tenants/{tenantId}/actions/reactivate",
-  pathVariables: { tenantId },
-  body,
-  contentType: "application/json",
-  options
-});
-function clearCache() {
-  return clearApiCache("tenants");
-}
-var tenantsExport = {
-  createTenant,
-  getMyTenant,
-  getTenant,
-  patchTenant,
-  deactivateTenant,
-  reactivateTenant,
-  clearCache
-};
-var tenants_default = tenantsExport;
-export {
-  clearCache,
-  createTenant,
-  deactivateTenant,
-  tenants_default as default,
-  getMyTenant,
-  getTenant,
-  patchTenant,
-  reactivateTenant
-};