/**
 * Identity Security Cloud API - Custom Password Instructions
 * Use these APIs to interact with the Identity Security Cloud platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs.
 *
 * The version of the OpenAPI document: v1
 *
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */
import type { Configuration } from '../configuration';
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
import type { RequestArgs } from './base';
import { BaseAPI } from './base';
/**
 *
 * @export
 * @interface CustomPasswordInstruction
 */
export interface CustomPasswordInstruction {
    /**
     * The page ID that represents the page for forget user name, reset password and unlock account flow.
     * @type {string}
     * @memberof CustomPasswordInstruction
     */
    'pageId'?: CustomPasswordInstructionPageIdEnum;
    /**
     * The custom instructions for the specified page. Allow basic HTML format and maximum length is 1000 characters. The custom instructions will be sanitized to avoid attacks. If the customization text includes a link, like `<A HREF=\\\"URL\\\">...</A>` clicking on this will open the link on the current browser page. If you want your link to be redirected to a different page, please redirect it to \"_blank\" like this: `<a href=\\\"URL\" target=\\\"_blank\\\" >link</a>`. This will open a new tab when the link is clicked. Notice we\'re only supporting _blank as the redirection target.
     * @type {string}
     * @memberof CustomPasswordInstruction
     */
    'pageContent'?: string;
    /**
     * The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\".
     * @type {string}
     * @memberof CustomPasswordInstruction
     */
    'locale'?: string;
}
export declare const CustomPasswordInstructionPageIdEnum: {
    readonly ChangePasswordEnterPassword: "change-password:enter-password";
    readonly ChangePasswordFinish: "change-password:finish";
    readonly FlowSelectionSelect: "flow-selection:select";
    readonly ForgetUsernameUserEmail: "forget-username:user-email";
    readonly MfaEnterCode: "mfa:enter-code";
    readonly MfaEnterKba: "mfa:enter-kba";
    readonly MfaSelect: "mfa:select";
    readonly ResetPasswordEnterPassword: "reset-password:enter-password";
    readonly ResetPasswordEnterUsername: "reset-password:enter-username";
    readonly ResetPasswordFinish: "reset-password:finish";
    readonly UnlockAccountEnterUsername: "unlock-account:enter-username";
    readonly UnlockAccountFinish: "unlock-account:finish";
};
export type CustomPasswordInstructionPageIdEnum = typeof CustomPasswordInstructionPageIdEnum[keyof typeof CustomPasswordInstructionPageIdEnum];
/**
 *
 * @export
 * @interface ErrorMessageDto
 */
export interface ErrorMessageDto {
    /**
     * The locale for the message text, a BCP 47 language tag.
     * @type {string}
     * @memberof ErrorMessageDto
     */
    'locale'?: string | null;
    /**
     *
     * @type {LocaleOrigin}
     * @memberof ErrorMessageDto
     */
    'localeOrigin'?: LocaleOrigin | null;
    /**
     * Actual text of the error message in the indicated locale.
     * @type {string}
     * @memberof ErrorMessageDto
     */
    'text'?: string;
}
/**
 *
 * @export
 * @interface ErrorResponseDto
 */
export interface ErrorResponseDto {
    /**
     * Fine-grained error code providing more detail of the error.
     * @type {string}
     * @memberof ErrorResponseDto
     */
    'detailCode'?: string;
    /**
     * Unique tracking id for the error.
     * @type {string}
     * @memberof ErrorResponseDto
     */
    'trackingId'?: string;
    /**
     * Generic localized reason for error
     * @type {Array<ErrorMessageDto>}
     * @memberof ErrorResponseDto
     */
    'messages'?: Array<ErrorMessageDto>;
    /**
     * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
     * @type {Array<ErrorMessageDto>}
     * @memberof ErrorResponseDto
     */
    'causes'?: Array<ErrorMessageDto>;
}
/**
 * An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.
 * @export
 * @enum {string}
 */
export declare const LocaleOrigin: {
    readonly Default: "DEFAULT";
    readonly Request: "REQUEST";
};
export type LocaleOrigin = typeof LocaleOrigin[keyof typeof LocaleOrigin];
/**
 * CustomPasswordInstructionsApi - axios parameter creator
 * @export
 */
export declare const CustomPasswordInstructionsApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     * This API creates the custom password instructions for the specified page ID.  The `pageId` determines which login and password-recovery screen your custom instructions appear on. The following table describes each supported page ID and where its text is displayed:  | Page ID | Where the custom text appears | | --- | --- | | `flow-selection:select` | Flow-selection landing screen, under \"Need help signing in?\", above the navigation links. | | `reset-password:enter-username` | Reset-password \"enter username\" step, under the prompt, above the username field. | | `unlock-account:enter-username` | Unlock-account \"enter username\" step, under the prompt, above the username field. | | `forget-username:user-email` | Forgot-username screen, under \"Enter the email address for\", above the email field. | | `reset-password:enter-password` | Reset-password \"new password\" step, under the header, above the password fields. | | `change-password:enter-password` | Same \"new password\" screen, but the authenticated app/sync-group change variant. | | `reset-password:finish` | Reset-password success screen, under the success icon/heading, above the return button. | | `change-password:finish` | Success screen for the authenticated app/sync-group change, under the heading. | | `mfa:select` | MFA method-selection step, under the prompt, above the list of MFA options. | | `mfa:enter-code` | MFA code-entry step, under the option label, above the code field. | | `mfa:enter-kba` | KBA step, under \"Please answer these security questions\", above the questions form. | | `unlock-account:finish` | Unlock-account success screen, under the success icon/heading, above the return button. |  In every case the text shows as an info-icon + paragraph block that only appears if custom text is configured for that page ID, positioned between the screen\'s built-in heading and its form controls.
     * @summary Create custom password instructions
     * @param {CustomPasswordInstruction} customPasswordInstruction
     * @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
     * @param {*} [axiosOptions] Override http request option.
     * @throws {RequiredError}
     */
    createCustomPasswordInstructionsV1: (customPasswordInstruction: CustomPasswordInstruction, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * This API delete the custom password instructions for the specified page ID.
     * @summary Delete custom password instructions by page id
     * @param {DeleteCustomPasswordInstructionsV1PageIdEnum} pageId The page ID of custom password instructions to delete.
     * @param {string} [locale] The locale for the custom instructions, a BCP47 language tag. The default value is \\\&quot;default\\\&quot;.
     * @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
     * @param {*} [axiosOptions] Override http request option.
     * @throws {RequiredError}
     */
    deleteCustomPasswordInstructionsV1: (pageId: DeleteCustomPasswordInstructionsV1PageIdEnum, locale?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * This API returns the custom password instructions for the specified page ID.
     * @summary Get custom password instructions by page id
     * @param {GetCustomPasswordInstructionsV1PageIdEnum} pageId The page ID of custom password instructions to query.
     * @param {string} [locale] The locale for the custom instructions, a BCP47 language tag. The default value is \\\&quot;default\\\&quot;.
     * @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
     * @param {*} [axiosOptions] Override http request option.
     * @throws {RequiredError}
     */
    getCustomPasswordInstructionsV1: (pageId: GetCustomPasswordInstructionsV1PageIdEnum, locale?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
};
/**
 * CustomPasswordInstructionsApi - functional programming interface
 * @export
 */
export declare const CustomPasswordInstructionsApiFp: (configuration?: Configuration) => {
    /**
     * This API creates the custom password instructions for the specified page ID.  The `pageId` determines which login and password-recovery screen your custom instructions appear on. The following table describes each supported page ID and where its text is displayed:  | Page ID | Where the custom text appears | | --- | --- | | `flow-selection:select` | Flow-selection landing screen, under \"Need help signing in?\", above the navigation links. | | `reset-password:enter-username` | Reset-password \"enter username\" step, under the prompt, above the username field. | | `unlock-account:enter-username` | Unlock-account \"enter username\" step, under the prompt, above the username field. | | `forget-username:user-email` | Forgot-username screen, under \"Enter the email address for\", above the email field. | | `reset-password:enter-password` | Reset-password \"new password\" step, under the header, above the password fields. | | `change-password:enter-password` | Same \"new password\" screen, but the authenticated app/sync-group change variant. | | `reset-password:finish` | Reset-password success screen, under the success icon/heading, above the return button. | | `change-password:finish` | Success screen for the authenticated app/sync-group change, under the heading. | | `mfa:select` | MFA method-selection step, under the prompt, above the list of MFA options. | | `mfa:enter-code` | MFA code-entry step, under the option label, above the code field. | | `mfa:enter-kba` | KBA step, under \"Please answer these security questions\", above the questions form. | | `unlock-account:finish` | Unlock-account success screen, under the success icon/heading, above the return button. |  In every case the text shows as an info-icon + paragraph block that only appears if custom text is configured for that page ID, positioned between the screen\'s built-in heading and its form controls.
     * @summary Create custom password instructions
     * @param {CustomPasswordInstruction} customPasswordInstruction
     * @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
     * @param {*} [axiosOptions] Override http request option.
     * @throws {RequiredError}
     */
    createCustomPasswordInstructionsV1(customPasswordInstruction: CustomPasswordInstruction, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CustomPasswordInstruction>>;
    /**
     * This API delete the custom password instructions for the specified page ID.
     * @summary Delete custom password instructions by page id
     * @param {DeleteCustomPasswordInstructionsV1PageIdEnum} pageId The page ID of custom password instructions to delete.
     * @param {string} [locale] The locale for the custom instructions, a BCP47 language tag. The default value is \\\&quot;default\\\&quot;.
     * @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
     * @param {*} [axiosOptions] Override http request option.
     * @throws {RequiredError}
     */
    deleteCustomPasswordInstructionsV1(pageId: DeleteCustomPasswordInstructionsV1PageIdEnum, locale?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
    /**
     * This API returns the custom password instructions for the specified page ID.
     * @summary Get custom password instructions by page id
     * @param {GetCustomPasswordInstructionsV1PageIdEnum} pageId The page ID of custom password instructions to query.
     * @param {string} [locale] The locale for the custom instructions, a BCP47 language tag. The default value is \\\&quot;default\\\&quot;.
     * @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
     * @param {*} [axiosOptions] Override http request option.
     * @throws {RequiredError}
     */
    getCustomPasswordInstructionsV1(pageId: GetCustomPasswordInstructionsV1PageIdEnum, locale?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CustomPasswordInstruction>>;
};
/**
 * CustomPasswordInstructionsApi - factory interface
 * @export
 */
export declare const CustomPasswordInstructionsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     * This API creates the custom password instructions for the specified page ID.  The `pageId` determines which login and password-recovery screen your custom instructions appear on. The following table describes each supported page ID and where its text is displayed:  | Page ID | Where the custom text appears | | --- | --- | | `flow-selection:select` | Flow-selection landing screen, under \"Need help signing in?\", above the navigation links. | | `reset-password:enter-username` | Reset-password \"enter username\" step, under the prompt, above the username field. | | `unlock-account:enter-username` | Unlock-account \"enter username\" step, under the prompt, above the username field. | | `forget-username:user-email` | Forgot-username screen, under \"Enter the email address for\", above the email field. | | `reset-password:enter-password` | Reset-password \"new password\" step, under the header, above the password fields. | | `change-password:enter-password` | Same \"new password\" screen, but the authenticated app/sync-group change variant. | | `reset-password:finish` | Reset-password success screen, under the success icon/heading, above the return button. | | `change-password:finish` | Success screen for the authenticated app/sync-group change, under the heading. | | `mfa:select` | MFA method-selection step, under the prompt, above the list of MFA options. | | `mfa:enter-code` | MFA code-entry step, under the option label, above the code field. | | `mfa:enter-kba` | KBA step, under \"Please answer these security questions\", above the questions form. | | `unlock-account:finish` | Unlock-account success screen, under the success icon/heading, above the return button. |  In every case the text shows as an info-icon + paragraph block that only appears if custom text is configured for that page ID, positioned between the screen\'s built-in heading and its form controls.
     * @summary Create custom password instructions
     * @param {CustomPasswordInstructionsApiCreateCustomPasswordInstructionsV1Request} requestParameters Request parameters.
     * @param {*} [axiosOptions] Override http request option.
     * @throws {RequiredError}
     */
    createCustomPasswordInstructionsV1(requestParameters: CustomPasswordInstructionsApiCreateCustomPasswordInstructionsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<CustomPasswordInstruction>;
    /**
     * This API delete the custom password instructions for the specified page ID.
     * @summary Delete custom password instructions by page id
     * @param {CustomPasswordInstructionsApiDeleteCustomPasswordInstructionsV1Request} requestParameters Request parameters.
     * @param {*} [axiosOptions] Override http request option.
     * @throws {RequiredError}
     */
    deleteCustomPasswordInstructionsV1(requestParameters: CustomPasswordInstructionsApiDeleteCustomPasswordInstructionsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<void>;
    /**
     * This API returns the custom password instructions for the specified page ID.
     * @summary Get custom password instructions by page id
     * @param {CustomPasswordInstructionsApiGetCustomPasswordInstructionsV1Request} requestParameters Request parameters.
     * @param {*} [axiosOptions] Override http request option.
     * @throws {RequiredError}
     */
    getCustomPasswordInstructionsV1(requestParameters: CustomPasswordInstructionsApiGetCustomPasswordInstructionsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<CustomPasswordInstruction>;
};
/**
 * Request parameters for createCustomPasswordInstructionsV1 operation in CustomPasswordInstructionsApi.
 * @export
 * @interface CustomPasswordInstructionsApiCreateCustomPasswordInstructionsV1Request
 */
export interface CustomPasswordInstructionsApiCreateCustomPasswordInstructionsV1Request {
    /**
     *
     * @type {CustomPasswordInstruction}
     * @memberof CustomPasswordInstructionsApiCreateCustomPasswordInstructionsV1
     */
    readonly customPasswordInstruction: CustomPasswordInstruction;
    /**
     * Use this header to enable this experimental API.
     * @type {string}
     * @memberof CustomPasswordInstructionsApiCreateCustomPasswordInstructionsV1
     */
    readonly xSailPointExperimental?: string;
}
/**
 * Request parameters for deleteCustomPasswordInstructionsV1 operation in CustomPasswordInstructionsApi.
 * @export
 * @interface CustomPasswordInstructionsApiDeleteCustomPasswordInstructionsV1Request
 */
export interface CustomPasswordInstructionsApiDeleteCustomPasswordInstructionsV1Request {
    /**
     * The page ID of custom password instructions to delete.
     * @type {'change-password:enter-password' | 'change-password:finish' | 'flow-selection:select' | 'forget-username:user-email' | 'mfa:enter-code' | 'mfa:enter-kba' | 'mfa:select' | 'reset-password:enter-password' | 'reset-password:enter-username' | 'reset-password:finish' | 'unlock-account:enter-username' | 'unlock-account:finish'}
     * @memberof CustomPasswordInstructionsApiDeleteCustomPasswordInstructionsV1
     */
    readonly pageId: DeleteCustomPasswordInstructionsV1PageIdEnum;
    /**
     * The locale for the custom instructions, a BCP47 language tag. The default value is \\\&quot;default\\\&quot;.
     * @type {string}
     * @memberof CustomPasswordInstructionsApiDeleteCustomPasswordInstructionsV1
     */
    readonly locale?: string;
    /**
     * Use this header to enable this experimental API.
     * @type {string}
     * @memberof CustomPasswordInstructionsApiDeleteCustomPasswordInstructionsV1
     */
    readonly xSailPointExperimental?: string;
}
/**
 * Request parameters for getCustomPasswordInstructionsV1 operation in CustomPasswordInstructionsApi.
 * @export
 * @interface CustomPasswordInstructionsApiGetCustomPasswordInstructionsV1Request
 */
export interface CustomPasswordInstructionsApiGetCustomPasswordInstructionsV1Request {
    /**
     * The page ID of custom password instructions to query.
     * @type {'change-password:enter-password' | 'change-password:finish' | 'flow-selection:select' | 'forget-username:user-email' | 'mfa:enter-code' | 'mfa:enter-kba' | 'mfa:select' | 'reset-password:enter-password' | 'reset-password:enter-username' | 'reset-password:finish' | 'unlock-account:enter-username' | 'unlock-account:finish'}
     * @memberof CustomPasswordInstructionsApiGetCustomPasswordInstructionsV1
     */
    readonly pageId: GetCustomPasswordInstructionsV1PageIdEnum;
    /**
     * The locale for the custom instructions, a BCP47 language tag. The default value is \\\&quot;default\\\&quot;.
     * @type {string}
     * @memberof CustomPasswordInstructionsApiGetCustomPasswordInstructionsV1
     */
    readonly locale?: string;
    /**
     * Use this header to enable this experimental API.
     * @type {string}
     * @memberof CustomPasswordInstructionsApiGetCustomPasswordInstructionsV1
     */
    readonly xSailPointExperimental?: string;
}
/**
 * CustomPasswordInstructionsApi - object-oriented interface
 * @export
 * @class CustomPasswordInstructionsApi
 * @extends {BaseAPI}
 */
export declare class CustomPasswordInstructionsApi extends BaseAPI {
    /**
     * This API creates the custom password instructions for the specified page ID.  The `pageId` determines which login and password-recovery screen your custom instructions appear on. The following table describes each supported page ID and where its text is displayed:  | Page ID | Where the custom text appears | | --- | --- | | `flow-selection:select` | Flow-selection landing screen, under \"Need help signing in?\", above the navigation links. | | `reset-password:enter-username` | Reset-password \"enter username\" step, under the prompt, above the username field. | | `unlock-account:enter-username` | Unlock-account \"enter username\" step, under the prompt, above the username field. | | `forget-username:user-email` | Forgot-username screen, under \"Enter the email address for\", above the email field. | | `reset-password:enter-password` | Reset-password \"new password\" step, under the header, above the password fields. | | `change-password:enter-password` | Same \"new password\" screen, but the authenticated app/sync-group change variant. | | `reset-password:finish` | Reset-password success screen, under the success icon/heading, above the return button. | | `change-password:finish` | Success screen for the authenticated app/sync-group change, under the heading. | | `mfa:select` | MFA method-selection step, under the prompt, above the list of MFA options. | | `mfa:enter-code` | MFA code-entry step, under the option label, above the code field. | | `mfa:enter-kba` | KBA step, under \"Please answer these security questions\", above the questions form. | | `unlock-account:finish` | Unlock-account success screen, under the success icon/heading, above the return button. |  In every case the text shows as an info-icon + paragraph block that only appears if custom text is configured for that page ID, positioned between the screen\'s built-in heading and its form controls.
     * @summary Create custom password instructions
     * @param {CustomPasswordInstructionsApiCreateCustomPasswordInstructionsV1Request} requestParameters Request parameters.
     * @param {*} [axiosOptions] Override http request option.
     * @throws {RequiredError}
     * @memberof CustomPasswordInstructionsApi
     */
    createCustomPasswordInstructionsV1(requestParameters: CustomPasswordInstructionsApiCreateCustomPasswordInstructionsV1Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CustomPasswordInstruction, any>>;
    /**
     * This API delete the custom password instructions for the specified page ID.
     * @summary Delete custom password instructions by page id
     * @param {CustomPasswordInstructionsApiDeleteCustomPasswordInstructionsV1Request} requestParameters Request parameters.
     * @param {*} [axiosOptions] Override http request option.
     * @throws {RequiredError}
     * @memberof CustomPasswordInstructionsApi
     */
    deleteCustomPasswordInstructionsV1(requestParameters: CustomPasswordInstructionsApiDeleteCustomPasswordInstructionsV1Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
    /**
     * This API returns the custom password instructions for the specified page ID.
     * @summary Get custom password instructions by page id
     * @param {CustomPasswordInstructionsApiGetCustomPasswordInstructionsV1Request} requestParameters Request parameters.
     * @param {*} [axiosOptions] Override http request option.
     * @throws {RequiredError}
     * @memberof CustomPasswordInstructionsApi
     */
    getCustomPasswordInstructionsV1(requestParameters: CustomPasswordInstructionsApiGetCustomPasswordInstructionsV1Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CustomPasswordInstruction, any>>;
}
/**
 * @export
 */
export declare const DeleteCustomPasswordInstructionsV1PageIdEnum: {
    readonly ChangePasswordEnterPassword: "change-password:enter-password";
    readonly ChangePasswordFinish: "change-password:finish";
    readonly FlowSelectionSelect: "flow-selection:select";
    readonly ForgetUsernameUserEmail: "forget-username:user-email";
    readonly MfaEnterCode: "mfa:enter-code";
    readonly MfaEnterKba: "mfa:enter-kba";
    readonly MfaSelect: "mfa:select";
    readonly ResetPasswordEnterPassword: "reset-password:enter-password";
    readonly ResetPasswordEnterUsername: "reset-password:enter-username";
    readonly ResetPasswordFinish: "reset-password:finish";
    readonly UnlockAccountEnterUsername: "unlock-account:enter-username";
    readonly UnlockAccountFinish: "unlock-account:finish";
};
export type DeleteCustomPasswordInstructionsV1PageIdEnum = typeof DeleteCustomPasswordInstructionsV1PageIdEnum[keyof typeof DeleteCustomPasswordInstructionsV1PageIdEnum];
/**
 * @export
 */
export declare const GetCustomPasswordInstructionsV1PageIdEnum: {
    readonly ChangePasswordEnterPassword: "change-password:enter-password";
    readonly ChangePasswordFinish: "change-password:finish";
    readonly FlowSelectionSelect: "flow-selection:select";
    readonly ForgetUsernameUserEmail: "forget-username:user-email";
    readonly MfaEnterCode: "mfa:enter-code";
    readonly MfaEnterKba: "mfa:enter-kba";
    readonly MfaSelect: "mfa:select";
    readonly ResetPasswordEnterPassword: "reset-password:enter-password";
    readonly ResetPasswordEnterUsername: "reset-password:enter-username";
    readonly ResetPasswordFinish: "reset-password:finish";
    readonly UnlockAccountEnterUsername: "unlock-account:enter-username";
    readonly UnlockAccountFinish: "unlock-account:finish";
};
export type GetCustomPasswordInstructionsV1PageIdEnum = typeof GetCustomPasswordInstructionsV1PageIdEnum[keyof typeof GetCustomPasswordInstructionsV1PageIdEnum];