@connectedxm/admin-sdk 11.21.0 → 11.23.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/esm/api.js CHANGED
@@ -4,7 +4,7 @@
4
4
  * Connected Admin API
5
5
  * The Admin API allows you to manage your Connected community programmatically.
6
6
  *
7
- * The version of the OpenAPI document: 11.21.0
7
+ * The version of the OpenAPI document: 11.23.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -823,6 +823,10 @@ export var GetAdvertisements200ResponseStatusEnum;
823
823
  (function (GetAdvertisements200ResponseStatusEnum) {
824
824
  GetAdvertisements200ResponseStatusEnum["Ok"] = "ok";
825
825
  })(GetAdvertisements200ResponseStatusEnum || (GetAdvertisements200ResponseStatusEnum = {}));
826
+ export var GetAllAccountMerges200ResponseStatusEnum;
827
+ (function (GetAllAccountMerges200ResponseStatusEnum) {
828
+ GetAllAccountMerges200ResponseStatusEnum["Ok"] = "ok";
829
+ })(GetAllAccountMerges200ResponseStatusEnum || (GetAllAccountMerges200ResponseStatusEnum = {}));
826
830
  export var GetAnnouncementAudience200ResponseStatusEnum;
827
831
  (function (GetAnnouncementAudience200ResponseStatusEnum) {
828
832
  GetAnnouncementAudience200ResponseStatusEnum["Ok"] = "ok";
@@ -1623,6 +1627,10 @@ export var GetLoginDevices200ResponseStatusEnum;
1623
1627
  (function (GetLoginDevices200ResponseStatusEnum) {
1624
1628
  GetLoginDevices200ResponseStatusEnum["Ok"] = "ok";
1625
1629
  })(GetLoginDevices200ResponseStatusEnum || (GetLoginDevices200ResponseStatusEnum = {}));
1630
+ export var GetLoginMfa200ResponseStatusEnum;
1631
+ (function (GetLoginMfa200ResponseStatusEnum) {
1632
+ GetLoginMfa200ResponseStatusEnum["Ok"] = "ok";
1633
+ })(GetLoginMfa200ResponseStatusEnum || (GetLoginMfa200ResponseStatusEnum = {}));
1626
1634
  export var GetLogins200ResponseStatusEnum;
1627
1635
  (function (GetLogins200ResponseStatusEnum) {
1628
1636
  GetLogins200ResponseStatusEnum["Ok"] = "ok";
@@ -2162,6 +2170,12 @@ export var LocationQuestionOption;
2162
2170
  LocationQuestionOption["CountryState"] = "countryState";
2163
2171
  LocationQuestionOption["CountryStateCity"] = "countryStateCity";
2164
2172
  })(LocationQuestionOption || (LocationQuestionOption = {}));
2173
+ export var LoginMfaMethod;
2174
+ (function (LoginMfaMethod) {
2175
+ LoginMfaMethod["Totp"] = "totp";
2176
+ LoginMfaMethod["Sms"] = "sms";
2177
+ LoginMfaMethod["Email"] = "email";
2178
+ })(LoginMfaMethod || (LoginMfaMethod = {}));
2165
2179
  export var MatchQuestionType;
2166
2180
  (function (MatchQuestionType) {
2167
2181
  MatchQuestionType["Exclude"] = "exclude";
@@ -6963,6 +6977,56 @@ export const AccountsMergesApiAxiosParamCreator = function (configuration) {
6963
6977
  options: localVarRequestOptions,
6964
6978
  };
6965
6979
  }),
6980
+ /**
6981
+ * Returns a paginated list of the organization\'s account merges, newest first, optionally filtered by status and searched by the merged account\'s name or email or the surviving account\'s; requires read access to accounts.
6982
+ * @summary List every account merge in the organization
6983
+ * @param {AccountMergeStatus} [status] Filter by status
6984
+ * @param {number} [page] Page number
6985
+ * @param {number} [pageSize] Number of items per page
6986
+ * @param {string} [orderBy] Field to order by
6987
+ * @param {string} [search] Search query
6988
+ * @param {*} [options] Override http request option.
6989
+ * @throws {RequiredError}
6990
+ */
6991
+ getAllAccountMerges: (status_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1) => __awaiter(this, [status_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1], void 0, function* (status, page, pageSize, orderBy, search, options = {}) {
6992
+ const localVarPath = `/accounts/merges`;
6993
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
6994
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
6995
+ let baseOptions;
6996
+ if (configuration) {
6997
+ baseOptions = configuration.baseOptions;
6998
+ }
6999
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
7000
+ const localVarHeaderParameter = {};
7001
+ const localVarQueryParameter = {};
7002
+ // authentication ApiKeyAuth required
7003
+ yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
7004
+ // authentication OrganizationId required
7005
+ yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
7006
+ if (status !== undefined) {
7007
+ localVarQueryParameter['status'] = status;
7008
+ }
7009
+ if (page !== undefined) {
7010
+ localVarQueryParameter['page'] = page;
7011
+ }
7012
+ if (pageSize !== undefined) {
7013
+ localVarQueryParameter['pageSize'] = pageSize;
7014
+ }
7015
+ if (orderBy !== undefined) {
7016
+ localVarQueryParameter['orderBy'] = orderBy;
7017
+ }
7018
+ if (search !== undefined) {
7019
+ localVarQueryParameter['search'] = search;
7020
+ }
7021
+ localVarHeaderParameter['Accept'] = 'application/json';
7022
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
7023
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
7024
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
7025
+ return {
7026
+ url: toPathString(localVarUrlObj),
7027
+ options: localVarRequestOptions,
7028
+ };
7029
+ }),
6966
7030
  /**
6967
7031
  * Starts a background merge of mergeAccountId into the surviving account accountId: its logins, registrations, payments, and other related data move to the survivor and the merged account is then deleted. Returns the merge record to poll; requires read, create, update and delete permission on accounts.
6968
7032
  * @summary Merge an account into another
@@ -7093,6 +7157,26 @@ export const AccountsMergesApiFp = function (configuration) {
7093
7157
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
7094
7158
  });
7095
7159
  },
7160
+ /**
7161
+ * Returns a paginated list of the organization\'s account merges, newest first, optionally filtered by status and searched by the merged account\'s name or email or the surviving account\'s; requires read access to accounts.
7162
+ * @summary List every account merge in the organization
7163
+ * @param {AccountMergeStatus} [status] Filter by status
7164
+ * @param {number} [page] Page number
7165
+ * @param {number} [pageSize] Number of items per page
7166
+ * @param {string} [orderBy] Field to order by
7167
+ * @param {string} [search] Search query
7168
+ * @param {*} [options] Override http request option.
7169
+ * @throws {RequiredError}
7170
+ */
7171
+ getAllAccountMerges(status, page, pageSize, orderBy, search, options) {
7172
+ return __awaiter(this, void 0, void 0, function* () {
7173
+ var _a, _b, _c;
7174
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getAllAccountMerges(status, page, pageSize, orderBy, search, options);
7175
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
7176
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AccountsMergesApi.getAllAccountMerges']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
7177
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
7178
+ });
7179
+ },
7096
7180
  /**
7097
7181
  * Starts a background merge of mergeAccountId into the surviving account accountId: its logins, registrations, payments, and other related data move to the survivor and the merged account is then deleted. Returns the merge record to poll; requires read, create, update and delete permission on accounts.
7098
7182
  * @summary Merge an account into another
@@ -7164,6 +7248,16 @@ export const AccountsMergesApiFactory = function (configuration, basePath, axios
7164
7248
  getAccountMerges(requestParameters, options) {
7165
7249
  return localVarFp.getAccountMerges(requestParameters.accountId, options).then((request) => request(axios, basePath));
7166
7250
  },
7251
+ /**
7252
+ * Returns a paginated list of the organization\'s account merges, newest first, optionally filtered by status and searched by the merged account\'s name or email or the surviving account\'s; requires read access to accounts.
7253
+ * @summary List every account merge in the organization
7254
+ * @param {AccountsMergesApiGetAllAccountMergesRequest} requestParameters Request parameters.
7255
+ * @param {*} [options] Override http request option.
7256
+ * @throws {RequiredError}
7257
+ */
7258
+ getAllAccountMerges(requestParameters = {}, options) {
7259
+ return localVarFp.getAllAccountMerges(requestParameters.status, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
7260
+ },
7167
7261
  /**
7168
7262
  * Starts a background merge of mergeAccountId into the surviving account accountId: its logins, registrations, payments, and other related data move to the survivor and the merged account is then deleted. Returns the merge record to poll; requires read, create, update and delete permission on accounts.
7169
7263
  * @summary Merge an account into another
@@ -7220,6 +7314,16 @@ export class AccountsMergesApi extends BaseAPI {
7220
7314
  getAccountMerges(requestParameters, options) {
7221
7315
  return AccountsMergesApiFp(this.configuration).getAccountMerges(requestParameters.accountId, options).then((request) => request(this.axios, this.basePath));
7222
7316
  }
7317
+ /**
7318
+ * Returns a paginated list of the organization\'s account merges, newest first, optionally filtered by status and searched by the merged account\'s name or email or the surviving account\'s; requires read access to accounts.
7319
+ * @summary List every account merge in the organization
7320
+ * @param {AccountsMergesApiGetAllAccountMergesRequest} requestParameters Request parameters.
7321
+ * @param {*} [options] Override http request option.
7322
+ * @throws {RequiredError}
7323
+ */
7324
+ getAllAccountMerges(requestParameters = {}, options) {
7325
+ return AccountsMergesApiFp(this.configuration).getAllAccountMerges(requestParameters.status, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
7326
+ }
7223
7327
  /**
7224
7328
  * Starts a background merge of mergeAccountId into the surviving account accountId: its logins, registrations, payments, and other related data move to the survivor and the merged account is then deleted. Returns the merge record to poll; requires read, create, update and delete permission on accounts.
7225
7329
  * @summary Merge an account into another
@@ -79260,6 +79364,78 @@ export const LoginsApiAxiosParamCreator = function (configuration) {
79260
79364
  options: localVarRequestOptions,
79261
79365
  };
79262
79366
  }),
79367
+ /**
79368
+ * 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.
79369
+ * @summary Delete a login\'s authenticator app
79370
+ * @param {string} username The username identifier
79371
+ * @param {*} [options] Override http request option.
79372
+ * @throws {RequiredError}
79373
+ */
79374
+ deleteLoginMfaToken: (username_1, ...args_1) => __awaiter(this, [username_1, ...args_1], void 0, function* (username, options = {}) {
79375
+ // verify required parameter 'username' is not null or undefined
79376
+ assertParamExists('deleteLoginMfaToken', 'username', username);
79377
+ const localVarPath = `/logins/{username}/mfa/totp`
79378
+ .replace('{username}', encodeURIComponent(String(username)));
79379
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
79380
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
79381
+ let baseOptions;
79382
+ if (configuration) {
79383
+ baseOptions = configuration.baseOptions;
79384
+ }
79385
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
79386
+ const localVarHeaderParameter = {};
79387
+ const localVarQueryParameter = {};
79388
+ // authentication ApiKeyAuth required
79389
+ yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
79390
+ // authentication OrganizationId required
79391
+ yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
79392
+ localVarHeaderParameter['Accept'] = 'application/json';
79393
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
79394
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
79395
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
79396
+ return {
79397
+ url: toPathString(localVarUrlObj),
79398
+ options: localVarRequestOptions,
79399
+ };
79400
+ }),
79401
+ /**
79402
+ * 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.
79403
+ * @summary Turn off one of a login\'s MFA methods
79404
+ * @param {string} username The username identifier
79405
+ * @param {string} method The method identifier
79406
+ * @param {*} [options] Override http request option.
79407
+ * @throws {RequiredError}
79408
+ */
79409
+ disableLoginMfa: (username_1, method_1, ...args_1) => __awaiter(this, [username_1, method_1, ...args_1], void 0, function* (username, method, options = {}) {
79410
+ // verify required parameter 'username' is not null or undefined
79411
+ assertParamExists('disableLoginMfa', 'username', username);
79412
+ // verify required parameter 'method' is not null or undefined
79413
+ assertParamExists('disableLoginMfa', 'method', method);
79414
+ const localVarPath = `/logins/{username}/mfa/{method}/disable`
79415
+ .replace('{username}', encodeURIComponent(String(username)))
79416
+ .replace('{method}', encodeURIComponent(String(method)));
79417
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
79418
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
79419
+ let baseOptions;
79420
+ if (configuration) {
79421
+ baseOptions = configuration.baseOptions;
79422
+ }
79423
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'PUT' }, baseOptions), options);
79424
+ const localVarHeaderParameter = {};
79425
+ const localVarQueryParameter = {};
79426
+ // authentication ApiKeyAuth required
79427
+ yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
79428
+ // authentication OrganizationId required
79429
+ yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
79430
+ localVarHeaderParameter['Accept'] = 'application/json';
79431
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
79432
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
79433
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
79434
+ return {
79435
+ url: toPathString(localVarUrlObj),
79436
+ options: localVarRequestOptions,
79437
+ };
79438
+ }),
79263
79439
  /**
79264
79440
  * Returns the login record identified by username, including its profile and status details; requires the read permission on accounts.
79265
79441
  * @summary Get a single login
@@ -79394,6 +79570,40 @@ export const LoginsApiAxiosParamCreator = function (configuration) {
79394
79570
  options: localVarRequestOptions,
79395
79571
  };
79396
79572
  }),
79573
+ /**
79574
+ * 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.
79575
+ * @summary Get a login\'s MFA settings
79576
+ * @param {string} username The username identifier
79577
+ * @param {*} [options] Override http request option.
79578
+ * @throws {RequiredError}
79579
+ */
79580
+ getLoginMfa: (username_1, ...args_1) => __awaiter(this, [username_1, ...args_1], void 0, function* (username, options = {}) {
79581
+ // verify required parameter 'username' is not null or undefined
79582
+ assertParamExists('getLoginMfa', 'username', username);
79583
+ const localVarPath = `/logins/{username}/mfa`
79584
+ .replace('{username}', encodeURIComponent(String(username)));
79585
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
79586
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
79587
+ let baseOptions;
79588
+ if (configuration) {
79589
+ baseOptions = configuration.baseOptions;
79590
+ }
79591
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
79592
+ const localVarHeaderParameter = {};
79593
+ const localVarQueryParameter = {};
79594
+ // authentication ApiKeyAuth required
79595
+ yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
79596
+ // authentication OrganizationId required
79597
+ yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
79598
+ localVarHeaderParameter['Accept'] = 'application/json';
79599
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
79600
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
79601
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
79602
+ return {
79603
+ url: toPathString(localVarUrlObj),
79604
+ options: localVarRequestOptions,
79605
+ };
79606
+ }),
79397
79607
  /**
79398
79608
  * 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.
79399
79609
  * @summary List logins
@@ -79444,6 +79654,45 @@ export const LoginsApiAxiosParamCreator = function (configuration) {
79444
79654
  options: localVarRequestOptions,
79445
79655
  };
79446
79656
  }),
79657
+ /**
79658
+ * 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.
79659
+ * @summary Set a login\'s preferred MFA method
79660
+ * @param {string} username The username identifier
79661
+ * @param {SetLoginPreferredMfaRequest} setLoginPreferredMfaRequest
79662
+ * @param {*} [options] Override http request option.
79663
+ * @throws {RequiredError}
79664
+ */
79665
+ setLoginPreferredMfa: (username_1, setLoginPreferredMfaRequest_1, ...args_1) => __awaiter(this, [username_1, setLoginPreferredMfaRequest_1, ...args_1], void 0, function* (username, setLoginPreferredMfaRequest, options = {}) {
79666
+ // verify required parameter 'username' is not null or undefined
79667
+ assertParamExists('setLoginPreferredMfa', 'username', username);
79668
+ // verify required parameter 'setLoginPreferredMfaRequest' is not null or undefined
79669
+ assertParamExists('setLoginPreferredMfa', 'setLoginPreferredMfaRequest', setLoginPreferredMfaRequest);
79670
+ const localVarPath = `/logins/{username}/mfa/preferred`
79671
+ .replace('{username}', encodeURIComponent(String(username)));
79672
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
79673
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
79674
+ let baseOptions;
79675
+ if (configuration) {
79676
+ baseOptions = configuration.baseOptions;
79677
+ }
79678
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'PUT' }, baseOptions), options);
79679
+ const localVarHeaderParameter = {};
79680
+ const localVarQueryParameter = {};
79681
+ // authentication ApiKeyAuth required
79682
+ yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
79683
+ // authentication OrganizationId required
79684
+ yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
79685
+ localVarHeaderParameter['Content-Type'] = 'application/json';
79686
+ localVarHeaderParameter['Accept'] = 'application/json';
79687
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
79688
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
79689
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
79690
+ localVarRequestOptions.data = serializeDataIfNeeded(setLoginPreferredMfaRequest, localVarRequestOptions, configuration);
79691
+ return {
79692
+ url: toPathString(localVarUrlObj),
79693
+ options: localVarRequestOptions,
79694
+ };
79695
+ }),
79447
79696
  /**
79448
79697
  * 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.
79449
79698
  * @summary Update a login\'s email
@@ -79562,6 +79811,39 @@ export const LoginsApiFp = function (configuration) {
79562
79811
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
79563
79812
  });
79564
79813
  },
79814
+ /**
79815
+ * 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.
79816
+ * @summary Delete a login\'s authenticator app
79817
+ * @param {string} username The username identifier
79818
+ * @param {*} [options] Override http request option.
79819
+ * @throws {RequiredError}
79820
+ */
79821
+ deleteLoginMfaToken(username, options) {
79822
+ return __awaiter(this, void 0, void 0, function* () {
79823
+ var _a, _b, _c;
79824
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.deleteLoginMfaToken(username, options);
79825
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
79826
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['LoginsApi.deleteLoginMfaToken']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
79827
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
79828
+ });
79829
+ },
79830
+ /**
79831
+ * 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.
79832
+ * @summary Turn off one of a login\'s MFA methods
79833
+ * @param {string} username The username identifier
79834
+ * @param {string} method The method identifier
79835
+ * @param {*} [options] Override http request option.
79836
+ * @throws {RequiredError}
79837
+ */
79838
+ disableLoginMfa(username, method, options) {
79839
+ return __awaiter(this, void 0, void 0, function* () {
79840
+ var _a, _b, _c;
79841
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.disableLoginMfa(username, method, options);
79842
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
79843
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['LoginsApi.disableLoginMfa']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
79844
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
79845
+ });
79846
+ },
79565
79847
  /**
79566
79848
  * Returns the login record identified by username, including its profile and status details; requires the read permission on accounts.
79567
79849
  * @summary Get a single login
@@ -79618,6 +79900,22 @@ export const LoginsApiFp = function (configuration) {
79618
79900
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
79619
79901
  });
79620
79902
  },
79903
+ /**
79904
+ * 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.
79905
+ * @summary Get a login\'s MFA settings
79906
+ * @param {string} username The username identifier
79907
+ * @param {*} [options] Override http request option.
79908
+ * @throws {RequiredError}
79909
+ */
79910
+ getLoginMfa(username, options) {
79911
+ return __awaiter(this, void 0, void 0, function* () {
79912
+ var _a, _b, _c;
79913
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getLoginMfa(username, options);
79914
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
79915
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['LoginsApi.getLoginMfa']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
79916
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
79917
+ });
79918
+ },
79621
79919
  /**
79622
79920
  * 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.
79623
79921
  * @summary List logins
@@ -79638,6 +79936,23 @@ export const LoginsApiFp = function (configuration) {
79638
79936
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
79639
79937
  });
79640
79938
  },
79939
+ /**
79940
+ * 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.
79941
+ * @summary Set a login\'s preferred MFA method
79942
+ * @param {string} username The username identifier
79943
+ * @param {SetLoginPreferredMfaRequest} setLoginPreferredMfaRequest
79944
+ * @param {*} [options] Override http request option.
79945
+ * @throws {RequiredError}
79946
+ */
79947
+ setLoginPreferredMfa(username, setLoginPreferredMfaRequest, options) {
79948
+ return __awaiter(this, void 0, void 0, function* () {
79949
+ var _a, _b, _c;
79950
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.setLoginPreferredMfa(username, setLoginPreferredMfaRequest, options);
79951
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
79952
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['LoginsApi.setLoginPreferredMfa']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
79953
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
79954
+ });
79955
+ },
79641
79956
  /**
79642
79957
  * 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.
79643
79958
  * @summary Update a login\'s email
@@ -79700,6 +80015,26 @@ export const LoginsApiFactory = function (configuration, basePath, axios) {
79700
80015
  deleteLogin(requestParameters, options) {
79701
80016
  return localVarFp.deleteLogin(requestParameters.username, options).then((request) => request(axios, basePath));
79702
80017
  },
80018
+ /**
80019
+ * 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.
80020
+ * @summary Delete a login\'s authenticator app
80021
+ * @param {LoginsApiDeleteLoginMfaTokenRequest} requestParameters Request parameters.
80022
+ * @param {*} [options] Override http request option.
80023
+ * @throws {RequiredError}
80024
+ */
80025
+ deleteLoginMfaToken(requestParameters, options) {
80026
+ return localVarFp.deleteLoginMfaToken(requestParameters.username, options).then((request) => request(axios, basePath));
80027
+ },
80028
+ /**
80029
+ * 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.
80030
+ * @summary Turn off one of a login\'s MFA methods
80031
+ * @param {LoginsApiDisableLoginMfaRequest} requestParameters Request parameters.
80032
+ * @param {*} [options] Override http request option.
80033
+ * @throws {RequiredError}
80034
+ */
80035
+ disableLoginMfa(requestParameters, options) {
80036
+ return localVarFp.disableLoginMfa(requestParameters.username, requestParameters.method, options).then((request) => request(axios, basePath));
80037
+ },
79703
80038
  /**
79704
80039
  * Returns the login record identified by username, including its profile and status details; requires the read permission on accounts.
79705
80040
  * @summary Get a single login
@@ -79730,6 +80065,16 @@ export const LoginsApiFactory = function (configuration, basePath, axios) {
79730
80065
  getLoginDevices(requestParameters, options) {
79731
80066
  return localVarFp.getLoginDevices(requestParameters.username, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
79732
80067
  },
80068
+ /**
80069
+ * 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.
80070
+ * @summary Get a login\'s MFA settings
80071
+ * @param {LoginsApiGetLoginMfaRequest} requestParameters Request parameters.
80072
+ * @param {*} [options] Override http request option.
80073
+ * @throws {RequiredError}
80074
+ */
80075
+ getLoginMfa(requestParameters, options) {
80076
+ return localVarFp.getLoginMfa(requestParameters.username, options).then((request) => request(axios, basePath));
80077
+ },
79733
80078
  /**
79734
80079
  * 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.
79735
80080
  * @summary List logins
@@ -79740,6 +80085,16 @@ export const LoginsApiFactory = function (configuration, basePath, axios) {
79740
80085
  getLogins(requestParameters = {}, options) {
79741
80086
  return localVarFp.getLogins(requestParameters.accountId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
79742
80087
  },
80088
+ /**
80089
+ * 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.
80090
+ * @summary Set a login\'s preferred MFA method
80091
+ * @param {LoginsApiSetLoginPreferredMfaRequest} requestParameters Request parameters.
80092
+ * @param {*} [options] Override http request option.
80093
+ * @throws {RequiredError}
80094
+ */
80095
+ setLoginPreferredMfa(requestParameters, options) {
80096
+ return localVarFp.setLoginPreferredMfa(requestParameters.username, requestParameters.setLoginPreferredMfaRequest, options).then((request) => request(axios, basePath));
80097
+ },
79743
80098
  /**
79744
80099
  * 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.
79745
80100
  * @summary Update a login\'s email
@@ -79786,6 +80141,26 @@ export class LoginsApi extends BaseAPI {
79786
80141
  deleteLogin(requestParameters, options) {
79787
80142
  return LoginsApiFp(this.configuration).deleteLogin(requestParameters.username, options).then((request) => request(this.axios, this.basePath));
79788
80143
  }
80144
+ /**
80145
+ * 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.
80146
+ * @summary Delete a login\'s authenticator app
80147
+ * @param {LoginsApiDeleteLoginMfaTokenRequest} requestParameters Request parameters.
80148
+ * @param {*} [options] Override http request option.
80149
+ * @throws {RequiredError}
80150
+ */
80151
+ deleteLoginMfaToken(requestParameters, options) {
80152
+ return LoginsApiFp(this.configuration).deleteLoginMfaToken(requestParameters.username, options).then((request) => request(this.axios, this.basePath));
80153
+ }
80154
+ /**
80155
+ * 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.
80156
+ * @summary Turn off one of a login\'s MFA methods
80157
+ * @param {LoginsApiDisableLoginMfaRequest} requestParameters Request parameters.
80158
+ * @param {*} [options] Override http request option.
80159
+ * @throws {RequiredError}
80160
+ */
80161
+ disableLoginMfa(requestParameters, options) {
80162
+ return LoginsApiFp(this.configuration).disableLoginMfa(requestParameters.username, requestParameters.method, options).then((request) => request(this.axios, this.basePath));
80163
+ }
79789
80164
  /**
79790
80165
  * Returns the login record identified by username, including its profile and status details; requires the read permission on accounts.
79791
80166
  * @summary Get a single login
@@ -79816,6 +80191,16 @@ export class LoginsApi extends BaseAPI {
79816
80191
  getLoginDevices(requestParameters, options) {
79817
80192
  return LoginsApiFp(this.configuration).getLoginDevices(requestParameters.username, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
79818
80193
  }
80194
+ /**
80195
+ * 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.
80196
+ * @summary Get a login\'s MFA settings
80197
+ * @param {LoginsApiGetLoginMfaRequest} requestParameters Request parameters.
80198
+ * @param {*} [options] Override http request option.
80199
+ * @throws {RequiredError}
80200
+ */
80201
+ getLoginMfa(requestParameters, options) {
80202
+ return LoginsApiFp(this.configuration).getLoginMfa(requestParameters.username, options).then((request) => request(this.axios, this.basePath));
80203
+ }
79819
80204
  /**
79820
80205
  * 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.
79821
80206
  * @summary List logins
@@ -79826,6 +80211,16 @@ export class LoginsApi extends BaseAPI {
79826
80211
  getLogins(requestParameters = {}, options) {
79827
80212
  return LoginsApiFp(this.configuration).getLogins(requestParameters.accountId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
79828
80213
  }
80214
+ /**
80215
+ * 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.
80216
+ * @summary Set a login\'s preferred MFA method
80217
+ * @param {LoginsApiSetLoginPreferredMfaRequest} requestParameters Request parameters.
80218
+ * @param {*} [options] Override http request option.
80219
+ * @throws {RequiredError}
80220
+ */
80221
+ setLoginPreferredMfa(requestParameters, options) {
80222
+ return LoginsApiFp(this.configuration).setLoginPreferredMfa(requestParameters.username, requestParameters.setLoginPreferredMfaRequest, options).then((request) => request(this.axios, this.basePath));
80223
+ }
79829
80224
  /**
79830
80225
  * 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.
79831
80226
  * @summary Update a login\'s email
@@ -2,7 +2,7 @@
2
2
  * Connected Admin API
3
3
  * The Admin API allows you to manage your Connected community programmatically.
4
4
  *
5
- * The version of the OpenAPI document: 11.21.0
5
+ * The version of the OpenAPI document: 11.23.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/esm/base.js CHANGED
@@ -4,7 +4,7 @@
4
4
  * Connected Admin API
5
5
  * The Admin API allows you to manage your Connected community programmatically.
6
6
  *
7
- * The version of the OpenAPI document: 11.21.0
7
+ * The version of the OpenAPI document: 11.23.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Connected Admin API
3
3
  * The Admin API allows you to manage your Connected community programmatically.
4
4
  *
5
- * The version of the OpenAPI document: 11.21.0
5
+ * The version of the OpenAPI document: 11.23.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -4,7 +4,7 @@
4
4
  * Connected Admin API
5
5
  * The Admin API allows you to manage your Connected community programmatically.
6
6
  *
7
- * The version of the OpenAPI document: 11.21.0
7
+ * The version of the OpenAPI document: 11.23.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Connected Admin API
3
3
  * The Admin API allows you to manage your Connected community programmatically.
4
4
  *
5
- * The version of the OpenAPI document: 11.21.0
5
+ * The version of the OpenAPI document: 11.23.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -3,7 +3,7 @@
3
3
  * Connected Admin API
4
4
  * The Admin API allows you to manage your Connected community programmatically.
5
5
  *
6
- * The version of the OpenAPI document: 11.21.0
6
+ * The version of the OpenAPI document: 11.23.0
7
7
  *
8
8
  *
9
9
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).