@connectedxm/admin-sdk 11.22.0 → 11.23.0

package/dist/api.d.ts

@@ -2,7 +2,7 @@
  * Connected Admin API
  * The Admin API allows you to manage your Connected community programmatically.
  *
- * The version of the OpenAPI document: 11.22.0
+ * The version of the OpenAPI document: 11.23.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -8615,6 +8615,14 @@ export interface GetLoginDevices200Response {
 export declare enum GetLoginDevices200ResponseStatusEnum {
     Ok = "ok"
 }
+export interface GetLoginMfa200Response {
+    'status': GetLoginMfa200ResponseStatusEnum;
+    'message': string;
+    'data': LoginMfa;
+}
+export declare enum GetLoginMfa200ResponseStatusEnum {
+    Ok = "ok"
+}
 export interface GetLogins200Response {
     'status': GetLogins200ResponseStatusEnum;
     'message': string;
@@ -10091,6 +10099,16 @@ export interface LoginAllOfCount {
     'accounts': number;
     'devices': number;
 }
+export interface LoginMfa {
+    'supported': boolean;
+    'methods': Array<LoginMfaMethod>;
+    'preferred': LoginMfaMethod | null;
+}
+export declare enum LoginMfaMethod {
+    Totp = "totp",
+    Sms = "sms",
+    Email = "email"
+}
 export interface MarkNotificationsReadInputs {
     'notificationIds': Array<string>;
 }
@@ -12527,6 +12545,9 @@ export interface SeriesUpdateInputs {
     'paymentIntegrationId'?: string | null;
     'entityId'?: string | null;
 }
+export interface SetLoginPreferredMfaRequest {
+    'method': LoginMfaMethod;
+}
 export interface SideEffect {
     'id': string;
     'newPassOfPassTypeId': string | null;
@@ -65186,6 +65207,23 @@ export declare const LoginsApiAxiosParamCreator: (configuration?: Configuration)
      * @throws {RequiredError}
      */
     deleteLogin: (username: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Deletes the authenticator app (TOTP) registered to the email login with the given username, for a user who lost their device, and returns its updated MFA settings. The user can then sign in with their password and register a new authenticator. Deleting when none is registered succeeds. Requires read and update permissions on accounts.
+     * @summary Delete a login\'s authenticator app
+     * @param {string} username The username identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteLoginMfaToken: (username: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Turns off the given MFA method for the email login with the given username and returns its updated MFA settings. An authenticator app that is turned off stays registered, so the user can turn it back on without setting it up again; use DeleteLoginMfaToken when the device is lost. Requires read and update permissions on accounts.
+     * @summary Turn off one of a login\'s MFA methods
+     * @param {string} username The username identifier
+     * @param {string} method The method identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    disableLoginMfa: (username: string, method: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Returns the login record identified by username, including its profile and status details; requires the read permission on accounts.
      * @summary Get a single login
@@ -65218,6 +65256,14 @@ export declare const LoginsApiAxiosParamCreator: (configuration?: Configuration)
      * @throws {RequiredError}
      */
     getLoginDevices: (username: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Returns the MFA methods the login has turned on and which one is preferred; only email logins support MFA. Each call is a live Cognito lookup that counts the login as a monthly active user, so fetch it only when an admin views a single login, never for lists. Requires the read permission on accounts.
+     * @summary Get a login\'s MFA settings
+     * @param {string} username The username identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getLoginMfa: (username: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Returns a paginated list of logins for the organization, optionally filtered by linked account and with search and ordering support; requires the read permission on accounts.
      * @summary List logins
@@ -65230,6 +65276,15 @@ export declare const LoginsApiAxiosParamCreator: (configuration?: Configuration)
      * @throws {RequiredError}
      */
     getLogins: (accountId?: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Turns on the given MFA method for the email login with the given username, makes it the preferred one, and returns its updated MFA settings. The method must be set up for the user and allowed by the user pool. Requires read and update permissions on accounts.
+     * @summary Set a login\'s preferred MFA method
+     * @param {string} username The username identifier
+     * @param {SetLoginPreferredMfaRequest} setLoginPreferredMfaRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    setLoginPreferredMfa: (username: string, setLoginPreferredMfaRequest: SetLoginPreferredMfaRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Changes the email address for the given login username in both the database and Cognito, marking the new email as verified, and requires the \"update\" permission on accounts.
      * @summary Update a login\'s email
@@ -65269,6 +65324,23 @@ export declare const LoginsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     deleteLogin(username: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetLogin200Response>>;
+    /**
+     * Deletes the authenticator app (TOTP) registered to the email login with the given username, for a user who lost their device, and returns its updated MFA settings. The user can then sign in with their password and register a new authenticator. Deleting when none is registered succeeds. Requires read and update permissions on accounts.
+     * @summary Delete a login\'s authenticator app
+     * @param {string} username The username identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteLoginMfaToken(username: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetLoginMfa200Response>>;
+    /**
+     * Turns off the given MFA method for the email login with the given username and returns its updated MFA settings. An authenticator app that is turned off stays registered, so the user can turn it back on without setting it up again; use DeleteLoginMfaToken when the device is lost. Requires read and update permissions on accounts.
+     * @summary Turn off one of a login\'s MFA methods
+     * @param {string} username The username identifier
+     * @param {string} method The method identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    disableLoginMfa(username: string, method: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetLoginMfa200Response>>;
     /**
      * Returns the login record identified by username, including its profile and status details; requires the read permission on accounts.
      * @summary Get a single login
@@ -65301,6 +65373,14 @@ export declare const LoginsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getLoginDevices(username: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetLoginDevices200Response>>;
+    /**
+     * Returns the MFA methods the login has turned on and which one is preferred; only email logins support MFA. Each call is a live Cognito lookup that counts the login as a monthly active user, so fetch it only when an admin views a single login, never for lists. Requires the read permission on accounts.
+     * @summary Get a login\'s MFA settings
+     * @param {string} username The username identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getLoginMfa(username: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetLoginMfa200Response>>;
     /**
      * Returns a paginated list of logins for the organization, optionally filtered by linked account and with search and ordering support; requires the read permission on accounts.
      * @summary List logins
@@ -65313,6 +65393,15 @@ export declare const LoginsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getLogins(accountId?: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetLogins200Response>>;
+    /**
+     * Turns on the given MFA method for the email login with the given username, makes it the preferred one, and returns its updated MFA settings. The method must be set up for the user and allowed by the user pool. Requires read and update permissions on accounts.
+     * @summary Set a login\'s preferred MFA method
+     * @param {string} username The username identifier
+     * @param {SetLoginPreferredMfaRequest} setLoginPreferredMfaRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    setLoginPreferredMfa(username: string, setLoginPreferredMfaRequest: SetLoginPreferredMfaRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetLoginMfa200Response>>;
     /**
      * Changes the email address for the given login username in both the database and Cognito, marking the new email as verified, and requires the \"update\" permission on accounts.
      * @summary Update a login\'s email
@@ -65352,6 +65441,22 @@ export declare const LoginsApiFactory: (configuration?: Configuration, basePath?
      * @throws {RequiredError}
      */
     deleteLogin(requestParameters: LoginsApiDeleteLoginRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetLogin200Response>;
+    /**
+     * Deletes the authenticator app (TOTP) registered to the email login with the given username, for a user who lost their device, and returns its updated MFA settings. The user can then sign in with their password and register a new authenticator. Deleting when none is registered succeeds. Requires read and update permissions on accounts.
+     * @summary Delete a login\'s authenticator app
+     * @param {LoginsApiDeleteLoginMfaTokenRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteLoginMfaToken(requestParameters: LoginsApiDeleteLoginMfaTokenRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetLoginMfa200Response>;
+    /**
+     * Turns off the given MFA method for the email login with the given username and returns its updated MFA settings. An authenticator app that is turned off stays registered, so the user can turn it back on without setting it up again; use DeleteLoginMfaToken when the device is lost. Requires read and update permissions on accounts.
+     * @summary Turn off one of a login\'s MFA methods
+     * @param {LoginsApiDisableLoginMfaRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    disableLoginMfa(requestParameters: LoginsApiDisableLoginMfaRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetLoginMfa200Response>;
     /**
      * Returns the login record identified by username, including its profile and status details; requires the read permission on accounts.
      * @summary Get a single login
@@ -65376,6 +65481,14 @@ export declare const LoginsApiFactory: (configuration?: Configuration, basePath?
      * @throws {RequiredError}
      */
     getLoginDevices(requestParameters: LoginsApiGetLoginDevicesRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetLoginDevices200Response>;
+    /**
+     * Returns the MFA methods the login has turned on and which one is preferred; only email logins support MFA. Each call is a live Cognito lookup that counts the login as a monthly active user, so fetch it only when an admin views a single login, never for lists. Requires the read permission on accounts.
+     * @summary Get a login\'s MFA settings
+     * @param {LoginsApiGetLoginMfaRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getLoginMfa(requestParameters: LoginsApiGetLoginMfaRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetLoginMfa200Response>;
     /**
      * Returns a paginated list of logins for the organization, optionally filtered by linked account and with search and ordering support; requires the read permission on accounts.
      * @summary List logins
@@ -65384,6 +65497,14 @@ export declare const LoginsApiFactory: (configuration?: Configuration, basePath?
      * @throws {RequiredError}
      */
     getLogins(requestParameters?: LoginsApiGetLoginsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetLogins200Response>;
+    /**
+     * Turns on the given MFA method for the email login with the given username, makes it the preferred one, and returns its updated MFA settings. The method must be set up for the user and allowed by the user pool. Requires read and update permissions on accounts.
+     * @summary Set a login\'s preferred MFA method
+     * @param {LoginsApiSetLoginPreferredMfaRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    setLoginPreferredMfa(requestParameters: LoginsApiSetLoginPreferredMfaRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetLoginMfa200Response>;
     /**
      * Changes the email address for the given login username in both the database and Cognito, marking the new email as verified, and requires the \"update\" permission on accounts.
      * @summary Update a login\'s email
@@ -65419,6 +65540,28 @@ export interface LoginsApiDeleteLoginRequest {
      */
     readonly username: string;
 }
+/**
+ * Request parameters for deleteLoginMfaToken operation in LoginsApi.
+ */
+export interface LoginsApiDeleteLoginMfaTokenRequest {
+    /**
+     * The username identifier
+     */
+    readonly username: string;
+}
+/**
+ * Request parameters for disableLoginMfa operation in LoginsApi.
+ */
+export interface LoginsApiDisableLoginMfaRequest {
+    /**
+     * The username identifier
+     */
+    readonly username: string;
+    /**
+     * The method identifier
+     */
+    readonly method: string;
+}
 /**
  * Request parameters for getLogin operation in LoginsApi.
  */
@@ -65478,6 +65621,15 @@ export interface LoginsApiGetLoginDevicesRequest {
      */
     readonly search?: string;
 }
+/**
+ * Request parameters for getLoginMfa operation in LoginsApi.
+ */
+export interface LoginsApiGetLoginMfaRequest {
+    /**
+     * The username identifier
+     */
+    readonly username: string;
+}
 /**
  * Request parameters for getLogins operation in LoginsApi.
  */
@@ -65503,6 +65655,16 @@ export interface LoginsApiGetLoginsRequest {
      */
     readonly search?: string;
 }
+/**
+ * Request parameters for setLoginPreferredMfa operation in LoginsApi.
+ */
+export interface LoginsApiSetLoginPreferredMfaRequest {
+    /**
+     * The username identifier
+     */
+    readonly username: string;
+    readonly setLoginPreferredMfaRequest: SetLoginPreferredMfaRequest;
+}
 /**
  * Request parameters for updateLoginEmail operation in LoginsApi.
  */
@@ -65543,6 +65705,22 @@ export declare class LoginsApi extends BaseAPI {
      * @throws {RequiredError}
      */
     deleteLogin(requestParameters: LoginsApiDeleteLoginRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetLogin200Response, any, {}, any>>;
+    /**
+     * Deletes the authenticator app (TOTP) registered to the email login with the given username, for a user who lost their device, and returns its updated MFA settings. The user can then sign in with their password and register a new authenticator. Deleting when none is registered succeeds. Requires read and update permissions on accounts.
+     * @summary Delete a login\'s authenticator app
+     * @param {LoginsApiDeleteLoginMfaTokenRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteLoginMfaToken(requestParameters: LoginsApiDeleteLoginMfaTokenRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetLoginMfa200Response, any, {}, any>>;
+    /**
+     * Turns off the given MFA method for the email login with the given username and returns its updated MFA settings. An authenticator app that is turned off stays registered, so the user can turn it back on without setting it up again; use DeleteLoginMfaToken when the device is lost. Requires read and update permissions on accounts.
+     * @summary Turn off one of a login\'s MFA methods
+     * @param {LoginsApiDisableLoginMfaRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    disableLoginMfa(requestParameters: LoginsApiDisableLoginMfaRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetLoginMfa200Response, any, {}, any>>;
     /**
      * Returns the login record identified by username, including its profile and status details; requires the read permission on accounts.
      * @summary Get a single login
@@ -65567,6 +65745,14 @@ export declare class LoginsApi extends BaseAPI {
      * @throws {RequiredError}
      */
     getLoginDevices(requestParameters: LoginsApiGetLoginDevicesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetLoginDevices200Response, any, {}, any>>;
+    /**
+     * Returns the MFA methods the login has turned on and which one is preferred; only email logins support MFA. Each call is a live Cognito lookup that counts the login as a monthly active user, so fetch it only when an admin views a single login, never for lists. Requires the read permission on accounts.
+     * @summary Get a login\'s MFA settings
+     * @param {LoginsApiGetLoginMfaRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getLoginMfa(requestParameters: LoginsApiGetLoginMfaRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetLoginMfa200Response, any, {}, any>>;
     /**
      * Returns a paginated list of logins for the organization, optionally filtered by linked account and with search and ordering support; requires the read permission on accounts.
      * @summary List logins
@@ -65575,6 +65761,14 @@ export declare class LoginsApi extends BaseAPI {
      * @throws {RequiredError}
      */
     getLogins(requestParameters?: LoginsApiGetLoginsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetLogins200Response, any, {}, any>>;
+    /**
+     * Turns on the given MFA method for the email login with the given username, makes it the preferred one, and returns its updated MFA settings. The method must be set up for the user and allowed by the user pool. Requires read and update permissions on accounts.
+     * @summary Set a login\'s preferred MFA method
+     * @param {LoginsApiSetLoginPreferredMfaRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    setLoginPreferredMfa(requestParameters: LoginsApiSetLoginPreferredMfaRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetLoginMfa200Response, any, {}, any>>;
     /**
      * Changes the email address for the given login username in both the database and Cognito, marking the new email as verified, and requires the \"update\" permission on accounts.
      * @summary Update a login\'s email