@qlik/api 2.2.0 → 2.3.0

package/transports.d.ts

@@ -1,4 +1,435 @@
-import "./chunks/auth-types-E99tzdN0.js";
-import "./chunks/invoke-fetch-CbU2Dgqr.js";
-import { A as SmtpCheck, B as VerifyEmailConfigConnectionHttpError, C as PatchEmailConfigdefaultHttpError, D as SendTestEmailHttpResponse, E as SendTestEmailHttpError, F as UpdateEmailConfigError, G as getEmailConfig, H as VerifyEmailConfigConnectiondefaultHttpError, I as ValidateEmailConfigHttpError, J as transportsExport, K as patchEmailConfig, L as ValidateEmailConfigHttpResponse, M as SmtpResult, N as TenantAdminError, O as SendTestEmaildefaultHttpError, P as TransportsAPI, R as VerifyConnectionConfigNotFoundError, S as PatchEmailConfigHttpResponse, T as SendTestEmail404HttpError, U as clearCache, V as VerifyEmailConfigConnectionHttpResponse, W as deleteEmailConfig, X as verifyEmailConfigConnection, Y as validateEmailConfig, _ as GetEmailConfigdefaultHttpError, a as DeleteEmailConfigHttpResponse, b as PatchEmailConfig403HttpError, c as EmailConfigFieldPatch, d as ErrorsPublic, f as GetBasicAuthConfig, g as GetEmailConfigHttpResponse, h as GetEmailConfigHttpError, i as DeleteEmailConfigHttpError, j as SmtpConfigStatus, k as SendTestMailConfigNotFoundError, l as EmailConfigPatch, m as GetEmailConfig403HttpError, n as DeleteEmailConfig403HttpError, o as DeleteEmailConfigdefaultHttpError, p as GetEmailConfig, q as sendTestEmail, r as DeleteEmailConfig404HttpError, s as Email, t as DeleteConfigNotFoundError, u as ErrorPublic, v as GetMicrosoft365Config, w as SendTestEmail403HttpError, x as PatchEmailConfigHttpError, y as PatchEmailConfig400HttpError, z as VerifyEmailConfigConnection404HttpError } from "./chunks/transports-CqEiFxD3.js";
-export { DeleteConfigNotFoundError, DeleteEmailConfig403HttpError, DeleteEmailConfig404HttpError, DeleteEmailConfigHttpError, DeleteEmailConfigHttpResponse, DeleteEmailConfigdefaultHttpError, Email, EmailConfigFieldPatch, EmailConfigPatch, ErrorPublic, ErrorsPublic, GetBasicAuthConfig, GetEmailConfig, GetEmailConfig403HttpError, GetEmailConfigHttpError, GetEmailConfigHttpResponse, GetEmailConfigdefaultHttpError, GetMicrosoft365Config, PatchEmailConfig400HttpError, PatchEmailConfig403HttpError, PatchEmailConfigHttpError, PatchEmailConfigHttpResponse, PatchEmailConfigdefaultHttpError, SendTestEmail403HttpError, SendTestEmail404HttpError, SendTestEmailHttpError, SendTestEmailHttpResponse, SendTestEmaildefaultHttpError, SendTestMailConfigNotFoundError, SmtpCheck, SmtpConfigStatus, SmtpResult, TenantAdminError, TransportsAPI, UpdateEmailConfigError, ValidateEmailConfigHttpError, ValidateEmailConfigHttpResponse, VerifyConnectionConfigNotFoundError, VerifyEmailConfigConnection404HttpError, VerifyEmailConfigConnectionHttpError, VerifyEmailConfigConnectionHttpResponse, VerifyEmailConfigConnectiondefaultHttpError, clearCache, transportsExport as default, deleteEmailConfig, getEmailConfig, patchEmailConfig, sendTestEmail, validateEmailConfig, verifyEmailConfigConnection };
+import { y as ApiCallOptions } from "./chunks/auth-types-YrlH_R9f.js";
+import "./chunks/invoke-fetch-C1Z0RJYU.js";
+
+//#region src/public/rest/transports.d.ts
+type DeleteConfigNotFoundError = {
+  errors?: {
+    /** The error code. */
+    code: string;
+    /** Summary of the problem */
+    title: string;
+  }[];
+};
+/**
+ * An error object.
+ */
+type ErrorPublic = {
+  /** The error code. */
+  code: string;
+  /** Summary of the problem. */
+  title: string;
+};
+type ErrorsPublic = {
+  errors?: ErrorPublic[];
+};
+type SendTestMailConfigNotFoundError = {
+  errors?: {
+    /** The error code. */
+    code: string;
+    /** Summary of the problem */
+    title: string;
+  }[];
+};
+type TenantAdminError = {
+  errors?: {
+    /** The error code. */
+    code: string;
+    /** Summary of the problem */
+    title: string;
+  }[];
+};
+type UpdateEmailConfigError = {
+  errors?: {
+    /** The error code. */
+    code: string;
+    /** Summary of the problem */
+    title: string;
+  }[];
+};
+type VerifyConnectionConfigNotFoundError = {
+  errors?: {
+    /** The error code. */
+    code: string;
+    /** Summary of the problem */
+    title: string;
+  }[];
+};
+type Email = {
+  /** email body */
+  body?: string;
+  /** email recipient (email address) */
+  recipient?: string;
+  /** email subject */
+  subject?: string;
+};
+/**
+ * A JSON Patch document as defined in https://datatracker.ietf.org/doc/html/rfc6902.
+ */
+type EmailConfigFieldPatch = {
+  /** The operation to be performed. */
+  op: "replace, remove, add";
+  /** The path for the given resource field to patch. */
+  path: "/username" | "/serverAddress" | "/serverPort" | "/securityType" | "/emailAddress" | "/emailPassword";
+  /** The value to be used for this operation. */
+  value: string;
+};
+/**
+ * @example
+ * [
+ *   {
+ *     path: "/username",
+ *     value: "New name"
+ *   }
+ * ]
+ */
+type EmailConfigPatch = EmailConfigFieldPatch[];
+type GetBasicAuthConfig = {
+  /** The email address that should appear in From field when sending emails with this account */
+  emailAddress?: string;
+  /** The selected SMTP security mechanism. Could be either 'none', 'StartTLS' or 'SSL/TLS' */
+  securityType?: string;
+  /** The name that should appear in From field when sending emails with this account */
+  senderName?: string;
+  /** domain name or IP address of SMTP server */
+  serverAddress?: string;
+  /** smtp server port */
+  serverPort?: number;
+  /** user name used for SMTP login */
+  username?: string;
+};
+type GetEmailConfig = {
+  /** Number of authentication failures */
+  authFailures?: number;
+  /** used for SMTP authentication */
+  emailAddress?: string;
+  /** Indicates error with this email configuration. OK means that no error is indicated. Possible values are OK, CONFIG_NOT_SET, INCOMPLETE_CONFIG, INVALID_CREDENTIALS, PROVIDER_ERROR */
+  errorCode?: string;
+  /** Is the configuration valid */
+  isValid?: boolean;
+  lastUpdated?: string;
+  /** Last modification time. Formatted as a ISO 8601 string. */
+  modificationTime?: string;
+  /** Indicates if password is defined for this smtp config. The password itself is not returned! */
+  passwordExists?: boolean;
+  providerConfig?: GetMicrosoft365Config | GetBasicAuthConfig;
+  /** one of none, StartTLS or SSL/TLS */
+  securityType?: string;
+  /** domain name or IP address of SMTP server */
+  serverAddress?: string;
+  /** smtp server listening port */
+  serverPort?: number;
+  /** Name of the service provider for authentication */
+  serviceProvider?: "Microsoft365" | "BasicAuth";
+  /** Contains statusCode and statusReason */
+  status?: SmtpConfigStatus;
+  /** The tenant Id */
+  tenantId?: string;
+  /** user name */
+  username?: string;
+};
+type GetMicrosoft365Config = {
+  /** Microsoft365 client identifier */
+  clientId?: string;
+  /** The email address that should appear in From field when sending emails with this account */
+  emailAddress?: string;
+  /** Microsoft365 tenant identifier */
+  providerTenantId?: string;
+};
+/**
+ * SMTP basic authentication configuration. Provides server address, credentials, and sender information for standard SMTP email delivery.
+ */
+type PutBasicAuthConfig = {
+  /** The email address that should appear in From field when sending emails with this account */
+  emailAddress?: string;
+  /** password for SMTP basic authentication */
+  emailPassword?: string;
+  /** SMTP security mechanism to use. Could be either 'none', 'StartTLS' or 'SSL/TLS' */
+  securityType?: string;
+  /** The name that should appear in From field when sending emails with this account */
+  senderName?: string;
+  /** domain name or IP address of SMTP server */
+  serverAddress?: string;
+  /** smtp server port */
+  serverPort?: number;
+  /** user name used for SMTP login */
+  username?: string;
+};
+type PutEmailConfig = {
+  providerConfig?: PutMicrosoft365Config | PutBasicAuthConfig;
+  /** Name of the service provider for authentication */
+  serviceProvider?: "Microsoft365" | "BasicAuth";
+};
+/**
+ * Microsoft 365 authentication configuration. Provides OAuth credentials and tenant information for Microsoft 365 email delivery.
+ */
+type PutMicrosoft365Config = {
+  /** Microsoft365 client identifier */
+  clientId?: string;
+  /** secret to authenticate the Microsoft365 account */
+  clientSecret?: string;
+  /** The email address that should appear in From field when sending emails with this account */
+  emailAddress?: string;
+  /** Microsoft365 tenant identifier */
+  providerTenantId?: string;
+};
+type SmtpCheck = {
+  /** Indicates error with this email configuration. OK means that no error is indicated. Possible values are OK, CONFIG_NOT_SET, INCOMPLETE_CONFIG, INVALID_CREDENTIALS, PROVIDER_ERROR */
+  errorCode?: string;
+  /** true if smtp config is correct and complete. Will return false if smtp-config does not exist at all */
+  isValid?: boolean;
+};
+/**
+ * Contains statusCode and statusReason
+ */
+type SmtpConfigStatus = {
+  /** Status code */
+  statusCode?: number;
+  /** Status reason */
+  statusReason?: string;
+};
+type SmtpResult = {
+  /** could not resolve domain name, connection refused, connection timed out, SSL mismatch */
+  connectionFailed?: boolean;
+  /** error message from SMTP middleware .. a bit technical but could be useful to administrator */
+  message?: string;
+  /** smtp result code string from the SMTP server. eg. "250 2.6.0" */
+  smtpResponseCode?: number;
+  /** was SMTP operation successful or not. Other fields herein provide more detail */
+  success?: boolean;
+};
+/**
+ * Deletes the email configuration for the tenant.
+ *
+ * @throws DeleteEmailConfigHttpError
+ */
+declare function deleteEmailConfig(options?: ApiCallOptions): Promise<DeleteEmailConfigHttpResponse>;
+type DeleteEmailConfigHttpResponse = {
+  data: void;
+  headers: Headers;
+  status: 204;
+};
+type DeleteEmailConfigHttpError = DeleteEmailConfig403HttpError | DeleteEmailConfig404HttpError | DeleteEmailConfigdefaultHttpError;
+type DeleteEmailConfig403HttpError = {
+  data: TenantAdminError;
+  headers: Headers;
+  status: 403;
+};
+type DeleteEmailConfig404HttpError = {
+  data: DeleteConfigNotFoundError;
+  headers: Headers;
+  status: 404;
+};
+type DeleteEmailConfigdefaultHttpError = {
+  data: ErrorsPublic;
+  headers: Headers;
+  status: "default";
+};
+/**
+ * Returns the current email configuration and configuration status for the tenant.
+ *
+ * @throws GetEmailConfigHttpError
+ */
+declare function getEmailConfig(options?: ApiCallOptions): Promise<GetEmailConfigHttpResponse>;
+type GetEmailConfigHttpResponse = {
+  data: GetEmailConfig;
+  headers: Headers;
+  status: 200;
+};
+type GetEmailConfigHttpError = GetEmailConfig403HttpError | GetEmailConfigdefaultHttpError;
+type GetEmailConfig403HttpError = {
+  data: TenantAdminError;
+  headers: Headers;
+  status: 403;
+};
+type GetEmailConfigdefaultHttpError = {
+  data: ErrorsPublic;
+  headers: Headers;
+  status: "default";
+};
+/**
+ * @deprecated
+ *
+ * Patches the email configuration for the tenant. This endpoint is deprecated, use `PUT /transports/email-config` to replace the entire configuration instead.
+ *
+ * @param body an object with the body content
+ * @throws PatchEmailConfigHttpError
+ */
+declare function patchEmailConfig(body: EmailConfigPatch, options?: ApiCallOptions): Promise<PatchEmailConfigHttpResponse>;
+type PatchEmailConfigHttpResponse = {
+  data: void;
+  headers: Headers;
+  status: 204;
+};
+type PatchEmailConfigHttpError = PatchEmailConfig400HttpError | PatchEmailConfig403HttpError | PatchEmailConfigdefaultHttpError;
+type PatchEmailConfig400HttpError = {
+  data: UpdateEmailConfigError;
+  headers: Headers;
+  status: 400;
+};
+type PatchEmailConfig403HttpError = {
+  data: TenantAdminError;
+  headers: Headers;
+  status: 403;
+};
+type PatchEmailConfigdefaultHttpError = {
+  data: ErrorsPublic;
+  headers: Headers;
+  status: "default";
+};
+/**
+ * Creates or replaces the email configuration for the tenant. Validation of the configuration is done as part of the request.
+ *
+ * @param body an object with the body content
+ * @throws UpdateEmailConfigHttpError
+ */
+declare function updateEmailConfig(body: PutEmailConfig, options?: ApiCallOptions): Promise<UpdateEmailConfigHttpResponse>;
+type UpdateEmailConfigHttpResponse = {
+  data: void;
+  headers: Headers;
+  status: 204;
+};
+type UpdateEmailConfigHttpError = UpdateEmailConfig400HttpError | UpdateEmailConfig403HttpError | UpdateEmailConfigdefaultHttpError;
+type UpdateEmailConfig400HttpError = {
+  data: UpdateEmailConfigError;
+  headers: Headers;
+  status: 400;
+};
+type UpdateEmailConfig403HttpError = {
+  data: TenantAdminError;
+  headers: Headers;
+  status: 403;
+};
+type UpdateEmailConfigdefaultHttpError = {
+  data: ErrorsPublic;
+  headers: Headers;
+  status: "default";
+};
+/**
+ * Attempts to sends a test email using the active configuration, with the supplied email info (subject, body, recipient).
+ *
+ * @param body an object with the body content
+ * @throws SendTestEmailHttpError
+ */
+declare function sendTestEmail(body: Email, options?: ApiCallOptions): Promise<SendTestEmailHttpResponse>;
+type SendTestEmailHttpResponse = {
+  data: SmtpResult;
+  headers: Headers;
+  status: 200;
+};
+type SendTestEmailHttpError = SendTestEmail403HttpError | SendTestEmail404HttpError | SendTestEmaildefaultHttpError;
+type SendTestEmail403HttpError = {
+  data: TenantAdminError;
+  headers: Headers;
+  status: 403;
+};
+type SendTestEmail404HttpError = {
+  data: SendTestMailConfigNotFoundError;
+  headers: Headers;
+  status: 404;
+};
+type SendTestEmaildefaultHttpError = {
+  data: ErrorsPublic;
+  headers: Headers;
+  status: "default";
+};
+/**
+ * Returns the current isValid value for the email configuration for the tenant. Does not attempt to connect to a server to verify the connection or send a test email. Will return false if no email configuration exists.
+ *
+ * @throws ValidateEmailConfigHttpError
+ */
+declare function validateEmailConfig(options?: ApiCallOptions): Promise<ValidateEmailConfigHttpResponse>;
+type ValidateEmailConfigHttpResponse = {
+  data: SmtpCheck;
+  headers: Headers;
+  status: 200;
+};
+type ValidateEmailConfigHttpError = {
+  data: ErrorsPublic;
+  headers: Headers;
+  status: number;
+};
+/**
+ * Attempts to verify connection to email server using a low-level protocol handshake to confirm the server is reachable and the credentials are valid, without sending a test email.
+ *
+ * @throws VerifyEmailConfigConnectionHttpError
+ */
+declare function verifyEmailConfigConnection(options?: ApiCallOptions): Promise<VerifyEmailConfigConnectionHttpResponse>;
+type VerifyEmailConfigConnectionHttpResponse = {
+  data: SmtpResult;
+  headers: Headers;
+  status: 200;
+};
+type VerifyEmailConfigConnectionHttpError = VerifyEmailConfigConnection404HttpError | VerifyEmailConfigConnectiondefaultHttpError;
+type VerifyEmailConfigConnection404HttpError = {
+  data: VerifyConnectionConfigNotFoundError;
+  headers: Headers;
+  status: 404;
+};
+type VerifyEmailConfigConnectiondefaultHttpError = {
+  data: ErrorsPublic;
+  headers: Headers;
+  status: "default";
+};
+/**
+ * Clears the cache for transports api requests.
+ */
+declare function clearCache(): void;
+type TransportsAPI = {
+  /**
+   * Deletes the email configuration for the tenant.
+   *
+   * @throws DeleteEmailConfigHttpError
+   */
+  deleteEmailConfig: typeof deleteEmailConfig;
+  /**
+   * Returns the current email configuration and configuration status for the tenant.
+   *
+   * @throws GetEmailConfigHttpError
+   */
+  getEmailConfig: typeof getEmailConfig;
+  /**
+   * @deprecated
+   *
+   * Patches the email configuration for the tenant. This endpoint is deprecated, use `PUT /transports/email-config` to replace the entire configuration instead.
+   *
+   * @param body an object with the body content
+   * @throws PatchEmailConfigHttpError
+   */
+  patchEmailConfig: typeof patchEmailConfig;
+  /**
+   * Creates or replaces the email configuration for the tenant. Validation of the configuration is done as part of the request.
+   *
+   * @param body an object with the body content
+   * @throws UpdateEmailConfigHttpError
+   */
+  updateEmailConfig: typeof updateEmailConfig;
+  /**
+   * Attempts to sends a test email using the active configuration, with the supplied email info (subject, body, recipient).
+   *
+   * @param body an object with the body content
+   * @throws SendTestEmailHttpError
+   */
+  sendTestEmail: typeof sendTestEmail;
+  /**
+   * Returns the current isValid value for the email configuration for the tenant. Does not attempt to connect to a server to verify the connection or send a test email. Will return false if no email configuration exists.
+   *
+   * @throws ValidateEmailConfigHttpError
+   */
+  validateEmailConfig: typeof validateEmailConfig;
+  /**
+   * Attempts to verify connection to email server using a low-level protocol handshake to confirm the server is reachable and the credentials are valid, without sending a test email.
+   *
+   * @throws VerifyEmailConfigConnectionHttpError
+   */
+  verifyEmailConfigConnection: typeof verifyEmailConfigConnection;
+  /**
+   * Clears the cache for transports api requests.
+   */
+  clearCache: typeof clearCache;
+};
+/**
+ * Functions for the transports api
+ */
+declare const transportsExport: TransportsAPI;
+//#endregion
+export { DeleteConfigNotFoundError, DeleteEmailConfig403HttpError, DeleteEmailConfig404HttpError, DeleteEmailConfigHttpError, DeleteEmailConfigHttpResponse, DeleteEmailConfigdefaultHttpError, Email, EmailConfigFieldPatch, EmailConfigPatch, ErrorPublic, ErrorsPublic, GetBasicAuthConfig, GetEmailConfig, GetEmailConfig403HttpError, GetEmailConfigHttpError, GetEmailConfigHttpResponse, GetEmailConfigdefaultHttpError, GetMicrosoft365Config, PatchEmailConfig400HttpError, PatchEmailConfig403HttpError, PatchEmailConfigHttpError, PatchEmailConfigHttpResponse, PatchEmailConfigdefaultHttpError, PutBasicAuthConfig, PutEmailConfig, PutMicrosoft365Config, SendTestEmail403HttpError, SendTestEmail404HttpError, SendTestEmailHttpError, SendTestEmailHttpResponse, SendTestEmaildefaultHttpError, SendTestMailConfigNotFoundError, SmtpCheck, SmtpConfigStatus, SmtpResult, TenantAdminError, TransportsAPI, UpdateEmailConfig400HttpError, UpdateEmailConfig403HttpError, UpdateEmailConfigError, UpdateEmailConfigHttpError, UpdateEmailConfigHttpResponse, UpdateEmailConfigdefaultHttpError, ValidateEmailConfigHttpError, ValidateEmailConfigHttpResponse, VerifyConnectionConfigNotFoundError, VerifyEmailConfigConnection404HttpError, VerifyEmailConfigConnectionHttpError, VerifyEmailConfigConnectionHttpResponse, VerifyEmailConfigConnectiondefaultHttpError, clearCache, transportsExport as default, deleteEmailConfig, getEmailConfig, patchEmailConfig, sendTestEmail, updateEmailConfig, validateEmailConfig, verifyEmailConfigConnection };

package/transports.js

@@ -1,6 +1,5 @@
-import "./chunks/utils-BnC4lrlq.js";
-import "./chunks/public-runtime-modules-Dwjzb3l8.js";
-import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-PcVIxLW4.js";
+import "./chunks/public-runtime-modules-QhLPeQr5.js";
+import { n as invokeFetch, t as clearApiCache } from "./chunks/invoke-fetch-B7lGscuQ.js";
 
 //#region src/public/rest/transports.ts
 /**
@@ -30,7 +29,7 @@ async function getEmailConfig(options) {
 /**
 * @deprecated
 *
-* Patch the email configuration for the tenant.
+* Patches the email configuration for the tenant. This endpoint is deprecated, use `PUT /transports/email-config` to replace the entire configuration instead.
 *
 * @param body an object with the body content
 * @throws PatchEmailConfigHttpError
@@ -45,6 +44,21 @@ async function patchEmailConfig(body, options) {
 	});
 }
 /**
+* Creates or replaces the email configuration for the tenant. Validation of the configuration is done as part of the request.
+*
+* @param body an object with the body content
+* @throws UpdateEmailConfigHttpError
+*/
+async function updateEmailConfig(body, options) {
+	return invokeFetch("transports", {
+		method: "put",
+		pathTemplate: "/api/v1/transports/email-config",
+		body,
+		contentType: "application/json",
+		options
+	});
+}
+/**
 * Attempts to sends a test email using the active configuration, with the supplied email info (subject, body, recipient).
 *
 * @param body an object with the body content
@@ -96,6 +110,7 @@ const transportsExport = {
 	deleteEmailConfig,
 	getEmailConfig,
 	patchEmailConfig,
+	updateEmailConfig,
 	sendTestEmail,
 	validateEmailConfig,
 	verifyEmailConfigConnection,
@@ -104,4 +119,4 @@ const transportsExport = {
 var transports_default = transportsExport;
 
 //#endregion
-export { clearCache, transports_default as default, deleteEmailConfig, getEmailConfig, patchEmailConfig, sendTestEmail, validateEmailConfig, verifyEmailConfigConnection };
+export { clearCache, transports_default as default, deleteEmailConfig, getEmailConfig, patchEmailConfig, sendTestEmail, updateEmailConfig, validateEmailConfig, verifyEmailConfigConnection };