@connectedxm/admin-sdk 11.18.0 → 11.19.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/api.ts 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.18.0
7
+ * The version of the OpenAPI document: 11.19.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -257,6 +257,66 @@ export interface AccountInvitation {
257
257
  'email': string;
258
258
  'createdAt': string;
259
259
  }
260
+ export interface AccountMerge {
261
+ 'id': string;
262
+ 'survivorAccountId': string;
263
+ 'survivorAccount': BaseAccount;
264
+ 'mergedAccountId': string;
265
+ 'mergedEmail': string | null;
266
+ 'mergedName': string | null;
267
+ 'mergedUsername': string | null;
268
+ 'status': AccountMergeStatus;
269
+ 'message': string | null;
270
+ 'counts': { [key: string]: any; };
271
+ 'user': BaseUser | null;
272
+ 'startedAt': string | null;
273
+ 'completedAt': string | null;
274
+ 'createdAt': string;
275
+ 'updatedAt': string;
276
+ }
277
+
278
+
279
+ export interface AccountMergePreview {
280
+ 'survivorAccount': BaseAccount;
281
+ 'mergedAccount': BaseAccount;
282
+ 'counts': AccountMergePreviewCounts;
283
+ 'filledFields': Array<string>;
284
+ 'blocking': Array<AccountMergeWarning>;
285
+ 'warnings': Array<AccountMergeWarning>;
286
+ }
287
+ export interface AccountMergePreviewCounts {
288
+ 'logins': number;
289
+ 'registrations': number;
290
+ 'seriesRegistrations': number;
291
+ 'bookings': number;
292
+ 'payments': number;
293
+ 'invoices': number;
294
+ 'paymentIntents': number;
295
+ 'groups': number;
296
+ 'threadAccounts': number;
297
+ 'activities': number;
298
+ 'followers': number;
299
+ 'following': number;
300
+ 'leads': number;
301
+ 'accountTiers': number;
302
+ 'supportTickets': number;
303
+ 'surveySubmissions': number;
304
+ 'sponsorshipLevels': number;
305
+ 'addresses': number;
306
+ }
307
+
308
+ export enum AccountMergeStatus {
309
+ Pending = 'pending',
310
+ Processing = 'processing',
311
+ Completed = 'completed',
312
+ Failed = 'failed'
313
+ }
314
+
315
+
316
+ export interface AccountMergeWarning {
317
+ 'code': string;
318
+ 'message': string;
319
+ }
260
320
  export interface AccountUpdateInputs {
261
321
  'accountAccess'?: AccountAccess | null;
262
322
  'featured'?: boolean;
@@ -7288,6 +7348,36 @@ export enum GetAccountLikes200ResponseStatusEnum {
7288
7348
  Ok = 'ok'
7289
7349
  }
7290
7350
 
7351
+ export interface GetAccountMerge200Response {
7352
+ 'status': GetAccountMerge200ResponseStatusEnum;
7353
+ 'message': string;
7354
+ 'data': AccountMerge;
7355
+ }
7356
+
7357
+ export enum GetAccountMerge200ResponseStatusEnum {
7358
+ Ok = 'ok'
7359
+ }
7360
+
7361
+ export interface GetAccountMergePreview200Response {
7362
+ 'status': GetAccountMergePreview200ResponseStatusEnum;
7363
+ 'message': string;
7364
+ 'data': AccountMergePreview;
7365
+ }
7366
+
7367
+ export enum GetAccountMergePreview200ResponseStatusEnum {
7368
+ Ok = 'ok'
7369
+ }
7370
+
7371
+ export interface GetAccountMerges200Response {
7372
+ 'status': GetAccountMerges200ResponseStatusEnum;
7373
+ 'message': string;
7374
+ 'data': Array<AccountMerge>;
7375
+ }
7376
+
7377
+ export enum GetAccountMerges200ResponseStatusEnum {
7378
+ Ok = 'ok'
7379
+ }
7380
+
7291
7381
  export interface GetAccountNotificationPreferences200Response {
7292
7382
  'status': GetAccountNotificationPreferences200ResponseStatusEnum;
7293
7383
  'message': string;
@@ -11842,6 +11932,9 @@ export enum MentionInputsMarksEnum {
11842
11932
  Strike = 'strike'
11843
11933
  }
11844
11934
 
11935
+ export interface MergeAccountRequest {
11936
+ 'mergeAccountId': string;
11937
+ }
11845
11938
  export interface ModelFile {
11846
11939
  'id': number;
11847
11940
  'name': string;
@@ -20689,6 +20782,480 @@ export class AccountsLeadsApi extends BaseAPI {
20689
20782
 
20690
20783
 
20691
20784
 
20785
+ /**
20786
+ * AccountsMergesApi - axios parameter creator
20787
+ */
20788
+ export const AccountsMergesApiAxiosParamCreator = function (configuration?: Configuration) {
20789
+ return {
20790
+ /**
20791
+ * Returns a single account merge with its status (pending, processing, completed, or failed), failure message, and per-phase counts of what moved; poll it while the merge runs. Requires read access to accounts.
20792
+ * @summary Get an account merge
20793
+ * @param {string} mergeId The merge identifier
20794
+ * @param {*} [options] Override http request option.
20795
+ * @throws {RequiredError}
20796
+ */
20797
+ getAccountMerge: async (mergeId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
20798
+ // verify required parameter 'mergeId' is not null or undefined
20799
+ assertParamExists('getAccountMerge', 'mergeId', mergeId)
20800
+ const localVarPath = `/accounts/merges/{mergeId}`
20801
+ .replace('{mergeId}', encodeURIComponent(String(mergeId)));
20802
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
20803
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
20804
+ let baseOptions;
20805
+ if (configuration) {
20806
+ baseOptions = configuration.baseOptions;
20807
+ }
20808
+
20809
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
20810
+ const localVarHeaderParameter = {} as any;
20811
+ const localVarQueryParameter = {} as any;
20812
+
20813
+ // authentication ApiKeyAuth required
20814
+ await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
20815
+
20816
+ // authentication OrganizationId required
20817
+ await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
20818
+
20819
+ localVarHeaderParameter['Accept'] = 'application/json';
20820
+
20821
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
20822
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
20823
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
20824
+
20825
+ return {
20826
+ url: toPathString(localVarUrlObj),
20827
+ options: localVarRequestOptions,
20828
+ };
20829
+ },
20830
+ /**
20831
+ * Returns what merging mergeAccountId into the given surviving account would move, the profile fields the survivor would take from it, and any warnings or blocking conflicts; requires read access to accounts.
20832
+ * @summary Preview an account merge
20833
+ * @param {string} accountId The account identifier
20834
+ * @param {string} mergeAccountId Filter by mergeAccountId
20835
+ * @param {*} [options] Override http request option.
20836
+ * @throws {RequiredError}
20837
+ */
20838
+ getAccountMergePreview: async (accountId: string, mergeAccountId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
20839
+ // verify required parameter 'accountId' is not null or undefined
20840
+ assertParamExists('getAccountMergePreview', 'accountId', accountId)
20841
+ // verify required parameter 'mergeAccountId' is not null or undefined
20842
+ assertParamExists('getAccountMergePreview', 'mergeAccountId', mergeAccountId)
20843
+ const localVarPath = `/accounts/{accountId}/merge/preview`
20844
+ .replace('{accountId}', encodeURIComponent(String(accountId)));
20845
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
20846
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
20847
+ let baseOptions;
20848
+ if (configuration) {
20849
+ baseOptions = configuration.baseOptions;
20850
+ }
20851
+
20852
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
20853
+ const localVarHeaderParameter = {} as any;
20854
+ const localVarQueryParameter = {} as any;
20855
+
20856
+ // authentication ApiKeyAuth required
20857
+ await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
20858
+
20859
+ // authentication OrganizationId required
20860
+ await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
20861
+
20862
+ if (mergeAccountId !== undefined) {
20863
+ localVarQueryParameter['mergeAccountId'] = mergeAccountId;
20864
+ }
20865
+
20866
+ localVarHeaderParameter['Accept'] = 'application/json';
20867
+
20868
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
20869
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
20870
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
20871
+
20872
+ return {
20873
+ url: toPathString(localVarUrlObj),
20874
+ options: localVarRequestOptions,
20875
+ };
20876
+ },
20877
+ /**
20878
+ * Returns every merge in which the given account was the surviving or the merged account, newest first; requires read access to accounts.
20879
+ * @summary List an account\'s merges
20880
+ * @param {string} accountId The account identifier
20881
+ * @param {*} [options] Override http request option.
20882
+ * @throws {RequiredError}
20883
+ */
20884
+ getAccountMerges: async (accountId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
20885
+ // verify required parameter 'accountId' is not null or undefined
20886
+ assertParamExists('getAccountMerges', 'accountId', accountId)
20887
+ const localVarPath = `/accounts/{accountId}/merges`
20888
+ .replace('{accountId}', encodeURIComponent(String(accountId)));
20889
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
20890
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
20891
+ let baseOptions;
20892
+ if (configuration) {
20893
+ baseOptions = configuration.baseOptions;
20894
+ }
20895
+
20896
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
20897
+ const localVarHeaderParameter = {} as any;
20898
+ const localVarQueryParameter = {} as any;
20899
+
20900
+ // authentication ApiKeyAuth required
20901
+ await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
20902
+
20903
+ // authentication OrganizationId required
20904
+ await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
20905
+
20906
+ localVarHeaderParameter['Accept'] = 'application/json';
20907
+
20908
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
20909
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
20910
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
20911
+
20912
+ return {
20913
+ url: toPathString(localVarUrlObj),
20914
+ options: localVarRequestOptions,
20915
+ };
20916
+ },
20917
+ /**
20918
+ * 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.
20919
+ * @summary Merge an account into another
20920
+ * @param {string} accountId The account identifier
20921
+ * @param {MergeAccountRequest} mergeAccountRequest
20922
+ * @param {*} [options] Override http request option.
20923
+ * @throws {RequiredError}
20924
+ */
20925
+ mergeAccount: async (accountId: string, mergeAccountRequest: MergeAccountRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
20926
+ // verify required parameter 'accountId' is not null or undefined
20927
+ assertParamExists('mergeAccount', 'accountId', accountId)
20928
+ // verify required parameter 'mergeAccountRequest' is not null or undefined
20929
+ assertParamExists('mergeAccount', 'mergeAccountRequest', mergeAccountRequest)
20930
+ const localVarPath = `/accounts/{accountId}/merge`
20931
+ .replace('{accountId}', encodeURIComponent(String(accountId)));
20932
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
20933
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
20934
+ let baseOptions;
20935
+ if (configuration) {
20936
+ baseOptions = configuration.baseOptions;
20937
+ }
20938
+
20939
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
20940
+ const localVarHeaderParameter = {} as any;
20941
+ const localVarQueryParameter = {} as any;
20942
+
20943
+ // authentication ApiKeyAuth required
20944
+ await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
20945
+
20946
+ // authentication OrganizationId required
20947
+ await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
20948
+
20949
+ localVarHeaderParameter['Content-Type'] = 'application/json';
20950
+ localVarHeaderParameter['Accept'] = 'application/json';
20951
+
20952
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
20953
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
20954
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
20955
+ localVarRequestOptions.data = serializeDataIfNeeded(mergeAccountRequest, localVarRequestOptions, configuration)
20956
+
20957
+ return {
20958
+ url: toPathString(localVarUrlObj),
20959
+ options: localVarRequestOptions,
20960
+ };
20961
+ },
20962
+ /**
20963
+ * Restarts a failed or stalled account merge from the beginning; every step is safe to run again. Requires read, create, update and delete permission on accounts.
20964
+ * @summary Retry an account merge
20965
+ * @param {string} mergeId The merge identifier
20966
+ * @param {*} [options] Override http request option.
20967
+ * @throws {RequiredError}
20968
+ */
20969
+ retryAccountMerge: async (mergeId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
20970
+ // verify required parameter 'mergeId' is not null or undefined
20971
+ assertParamExists('retryAccountMerge', 'mergeId', mergeId)
20972
+ const localVarPath = `/accounts/merges/{mergeId}/retry`
20973
+ .replace('{mergeId}', encodeURIComponent(String(mergeId)));
20974
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
20975
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
20976
+ let baseOptions;
20977
+ if (configuration) {
20978
+ baseOptions = configuration.baseOptions;
20979
+ }
20980
+
20981
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
20982
+ const localVarHeaderParameter = {} as any;
20983
+ const localVarQueryParameter = {} as any;
20984
+
20985
+ // authentication ApiKeyAuth required
20986
+ await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
20987
+
20988
+ // authentication OrganizationId required
20989
+ await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
20990
+
20991
+ localVarHeaderParameter['Accept'] = 'application/json';
20992
+
20993
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
20994
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
20995
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
20996
+
20997
+ return {
20998
+ url: toPathString(localVarUrlObj),
20999
+ options: localVarRequestOptions,
21000
+ };
21001
+ },
21002
+ }
21003
+ };
21004
+
21005
+ /**
21006
+ * AccountsMergesApi - functional programming interface
21007
+ */
21008
+ export const AccountsMergesApiFp = function(configuration?: Configuration) {
21009
+ const localVarAxiosParamCreator = AccountsMergesApiAxiosParamCreator(configuration)
21010
+ return {
21011
+ /**
21012
+ * Returns a single account merge with its status (pending, processing, completed, or failed), failure message, and per-phase counts of what moved; poll it while the merge runs. Requires read access to accounts.
21013
+ * @summary Get an account merge
21014
+ * @param {string} mergeId The merge identifier
21015
+ * @param {*} [options] Override http request option.
21016
+ * @throws {RequiredError}
21017
+ */
21018
+ async getAccountMerge(mergeId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAccountMerge200Response>> {
21019
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getAccountMerge(mergeId, options);
21020
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
21021
+ const localVarOperationServerBasePath = operationServerMap['AccountsMergesApi.getAccountMerge']?.[localVarOperationServerIndex]?.url;
21022
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
21023
+ },
21024
+ /**
21025
+ * Returns what merging mergeAccountId into the given surviving account would move, the profile fields the survivor would take from it, and any warnings or blocking conflicts; requires read access to accounts.
21026
+ * @summary Preview an account merge
21027
+ * @param {string} accountId The account identifier
21028
+ * @param {string} mergeAccountId Filter by mergeAccountId
21029
+ * @param {*} [options] Override http request option.
21030
+ * @throws {RequiredError}
21031
+ */
21032
+ async getAccountMergePreview(accountId: string, mergeAccountId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAccountMergePreview200Response>> {
21033
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getAccountMergePreview(accountId, mergeAccountId, options);
21034
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
21035
+ const localVarOperationServerBasePath = operationServerMap['AccountsMergesApi.getAccountMergePreview']?.[localVarOperationServerIndex]?.url;
21036
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
21037
+ },
21038
+ /**
21039
+ * Returns every merge in which the given account was the surviving or the merged account, newest first; requires read access to accounts.
21040
+ * @summary List an account\'s merges
21041
+ * @param {string} accountId The account identifier
21042
+ * @param {*} [options] Override http request option.
21043
+ * @throws {RequiredError}
21044
+ */
21045
+ async getAccountMerges(accountId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAccountMerges200Response>> {
21046
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getAccountMerges(accountId, options);
21047
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
21048
+ const localVarOperationServerBasePath = operationServerMap['AccountsMergesApi.getAccountMerges']?.[localVarOperationServerIndex]?.url;
21049
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
21050
+ },
21051
+ /**
21052
+ * 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.
21053
+ * @summary Merge an account into another
21054
+ * @param {string} accountId The account identifier
21055
+ * @param {MergeAccountRequest} mergeAccountRequest
21056
+ * @param {*} [options] Override http request option.
21057
+ * @throws {RequiredError}
21058
+ */
21059
+ async mergeAccount(accountId: string, mergeAccountRequest: MergeAccountRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAccountMerge200Response>> {
21060
+ const localVarAxiosArgs = await localVarAxiosParamCreator.mergeAccount(accountId, mergeAccountRequest, options);
21061
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
21062
+ const localVarOperationServerBasePath = operationServerMap['AccountsMergesApi.mergeAccount']?.[localVarOperationServerIndex]?.url;
21063
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
21064
+ },
21065
+ /**
21066
+ * Restarts a failed or stalled account merge from the beginning; every step is safe to run again. Requires read, create, update and delete permission on accounts.
21067
+ * @summary Retry an account merge
21068
+ * @param {string} mergeId The merge identifier
21069
+ * @param {*} [options] Override http request option.
21070
+ * @throws {RequiredError}
21071
+ */
21072
+ async retryAccountMerge(mergeId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAccountMerge200Response>> {
21073
+ const localVarAxiosArgs = await localVarAxiosParamCreator.retryAccountMerge(mergeId, options);
21074
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
21075
+ const localVarOperationServerBasePath = operationServerMap['AccountsMergesApi.retryAccountMerge']?.[localVarOperationServerIndex]?.url;
21076
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
21077
+ },
21078
+ }
21079
+ };
21080
+
21081
+ /**
21082
+ * AccountsMergesApi - factory interface
21083
+ */
21084
+ export const AccountsMergesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
21085
+ const localVarFp = AccountsMergesApiFp(configuration)
21086
+ return {
21087
+ /**
21088
+ * Returns a single account merge with its status (pending, processing, completed, or failed), failure message, and per-phase counts of what moved; poll it while the merge runs. Requires read access to accounts.
21089
+ * @summary Get an account merge
21090
+ * @param {AccountsMergesApiGetAccountMergeRequest} requestParameters Request parameters.
21091
+ * @param {*} [options] Override http request option.
21092
+ * @throws {RequiredError}
21093
+ */
21094
+ getAccountMerge(requestParameters: AccountsMergesApiGetAccountMergeRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAccountMerge200Response> {
21095
+ return localVarFp.getAccountMerge(requestParameters.mergeId, options).then((request) => request(axios, basePath));
21096
+ },
21097
+ /**
21098
+ * Returns what merging mergeAccountId into the given surviving account would move, the profile fields the survivor would take from it, and any warnings or blocking conflicts; requires read access to accounts.
21099
+ * @summary Preview an account merge
21100
+ * @param {AccountsMergesApiGetAccountMergePreviewRequest} requestParameters Request parameters.
21101
+ * @param {*} [options] Override http request option.
21102
+ * @throws {RequiredError}
21103
+ */
21104
+ getAccountMergePreview(requestParameters: AccountsMergesApiGetAccountMergePreviewRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAccountMergePreview200Response> {
21105
+ return localVarFp.getAccountMergePreview(requestParameters.accountId, requestParameters.mergeAccountId, options).then((request) => request(axios, basePath));
21106
+ },
21107
+ /**
21108
+ * Returns every merge in which the given account was the surviving or the merged account, newest first; requires read access to accounts.
21109
+ * @summary List an account\'s merges
21110
+ * @param {AccountsMergesApiGetAccountMergesRequest} requestParameters Request parameters.
21111
+ * @param {*} [options] Override http request option.
21112
+ * @throws {RequiredError}
21113
+ */
21114
+ getAccountMerges(requestParameters: AccountsMergesApiGetAccountMergesRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAccountMerges200Response> {
21115
+ return localVarFp.getAccountMerges(requestParameters.accountId, options).then((request) => request(axios, basePath));
21116
+ },
21117
+ /**
21118
+ * 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.
21119
+ * @summary Merge an account into another
21120
+ * @param {AccountsMergesApiMergeAccountRequest} requestParameters Request parameters.
21121
+ * @param {*} [options] Override http request option.
21122
+ * @throws {RequiredError}
21123
+ */
21124
+ mergeAccount(requestParameters: AccountsMergesApiMergeAccountRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAccountMerge200Response> {
21125
+ return localVarFp.mergeAccount(requestParameters.accountId, requestParameters.mergeAccountRequest, options).then((request) => request(axios, basePath));
21126
+ },
21127
+ /**
21128
+ * Restarts a failed or stalled account merge from the beginning; every step is safe to run again. Requires read, create, update and delete permission on accounts.
21129
+ * @summary Retry an account merge
21130
+ * @param {AccountsMergesApiRetryAccountMergeRequest} requestParameters Request parameters.
21131
+ * @param {*} [options] Override http request option.
21132
+ * @throws {RequiredError}
21133
+ */
21134
+ retryAccountMerge(requestParameters: AccountsMergesApiRetryAccountMergeRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAccountMerge200Response> {
21135
+ return localVarFp.retryAccountMerge(requestParameters.mergeId, options).then((request) => request(axios, basePath));
21136
+ },
21137
+ };
21138
+ };
21139
+
21140
+ /**
21141
+ * Request parameters for getAccountMerge operation in AccountsMergesApi.
21142
+ */
21143
+ export interface AccountsMergesApiGetAccountMergeRequest {
21144
+ /**
21145
+ * The merge identifier
21146
+ */
21147
+ readonly mergeId: string
21148
+ }
21149
+
21150
+ /**
21151
+ * Request parameters for getAccountMergePreview operation in AccountsMergesApi.
21152
+ */
21153
+ export interface AccountsMergesApiGetAccountMergePreviewRequest {
21154
+ /**
21155
+ * The account identifier
21156
+ */
21157
+ readonly accountId: string
21158
+
21159
+ /**
21160
+ * Filter by mergeAccountId
21161
+ */
21162
+ readonly mergeAccountId: string
21163
+ }
21164
+
21165
+ /**
21166
+ * Request parameters for getAccountMerges operation in AccountsMergesApi.
21167
+ */
21168
+ export interface AccountsMergesApiGetAccountMergesRequest {
21169
+ /**
21170
+ * The account identifier
21171
+ */
21172
+ readonly accountId: string
21173
+ }
21174
+
21175
+ /**
21176
+ * Request parameters for mergeAccount operation in AccountsMergesApi.
21177
+ */
21178
+ export interface AccountsMergesApiMergeAccountRequest {
21179
+ /**
21180
+ * The account identifier
21181
+ */
21182
+ readonly accountId: string
21183
+
21184
+ readonly mergeAccountRequest: MergeAccountRequest
21185
+ }
21186
+
21187
+ /**
21188
+ * Request parameters for retryAccountMerge operation in AccountsMergesApi.
21189
+ */
21190
+ export interface AccountsMergesApiRetryAccountMergeRequest {
21191
+ /**
21192
+ * The merge identifier
21193
+ */
21194
+ readonly mergeId: string
21195
+ }
21196
+
21197
+ /**
21198
+ * AccountsMergesApi - object-oriented interface
21199
+ */
21200
+ export class AccountsMergesApi extends BaseAPI {
21201
+ /**
21202
+ * Returns a single account merge with its status (pending, processing, completed, or failed), failure message, and per-phase counts of what moved; poll it while the merge runs. Requires read access to accounts.
21203
+ * @summary Get an account merge
21204
+ * @param {AccountsMergesApiGetAccountMergeRequest} requestParameters Request parameters.
21205
+ * @param {*} [options] Override http request option.
21206
+ * @throws {RequiredError}
21207
+ */
21208
+ public getAccountMerge(requestParameters: AccountsMergesApiGetAccountMergeRequest, options?: RawAxiosRequestConfig) {
21209
+ return AccountsMergesApiFp(this.configuration).getAccountMerge(requestParameters.mergeId, options).then((request) => request(this.axios, this.basePath));
21210
+ }
21211
+
21212
+ /**
21213
+ * Returns what merging mergeAccountId into the given surviving account would move, the profile fields the survivor would take from it, and any warnings or blocking conflicts; requires read access to accounts.
21214
+ * @summary Preview an account merge
21215
+ * @param {AccountsMergesApiGetAccountMergePreviewRequest} requestParameters Request parameters.
21216
+ * @param {*} [options] Override http request option.
21217
+ * @throws {RequiredError}
21218
+ */
21219
+ public getAccountMergePreview(requestParameters: AccountsMergesApiGetAccountMergePreviewRequest, options?: RawAxiosRequestConfig) {
21220
+ return AccountsMergesApiFp(this.configuration).getAccountMergePreview(requestParameters.accountId, requestParameters.mergeAccountId, options).then((request) => request(this.axios, this.basePath));
21221
+ }
21222
+
21223
+ /**
21224
+ * Returns every merge in which the given account was the surviving or the merged account, newest first; requires read access to accounts.
21225
+ * @summary List an account\'s merges
21226
+ * @param {AccountsMergesApiGetAccountMergesRequest} requestParameters Request parameters.
21227
+ * @param {*} [options] Override http request option.
21228
+ * @throws {RequiredError}
21229
+ */
21230
+ public getAccountMerges(requestParameters: AccountsMergesApiGetAccountMergesRequest, options?: RawAxiosRequestConfig) {
21231
+ return AccountsMergesApiFp(this.configuration).getAccountMerges(requestParameters.accountId, options).then((request) => request(this.axios, this.basePath));
21232
+ }
21233
+
21234
+ /**
21235
+ * 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.
21236
+ * @summary Merge an account into another
21237
+ * @param {AccountsMergesApiMergeAccountRequest} requestParameters Request parameters.
21238
+ * @param {*} [options] Override http request option.
21239
+ * @throws {RequiredError}
21240
+ */
21241
+ public mergeAccount(requestParameters: AccountsMergesApiMergeAccountRequest, options?: RawAxiosRequestConfig) {
21242
+ return AccountsMergesApiFp(this.configuration).mergeAccount(requestParameters.accountId, requestParameters.mergeAccountRequest, options).then((request) => request(this.axios, this.basePath));
21243
+ }
21244
+
21245
+ /**
21246
+ * Restarts a failed or stalled account merge from the beginning; every step is safe to run again. Requires read, create, update and delete permission on accounts.
21247
+ * @summary Retry an account merge
21248
+ * @param {AccountsMergesApiRetryAccountMergeRequest} requestParameters Request parameters.
21249
+ * @param {*} [options] Override http request option.
21250
+ * @throws {RequiredError}
21251
+ */
21252
+ public retryAccountMerge(requestParameters: AccountsMergesApiRetryAccountMergeRequest, options?: RawAxiosRequestConfig) {
21253
+ return AccountsMergesApiFp(this.configuration).retryAccountMerge(requestParameters.mergeId, options).then((request) => request(this.axios, this.basePath));
21254
+ }
21255
+ }
21256
+
21257
+
21258
+
20692
21259
  /**
20693
21260
  * AccountsTiersApi - axios parameter creator
20694
21261
  */
package/base.ts 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.18.0
7
+ * The version of the OpenAPI document: 11.19.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/common.ts 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.18.0
7
+ * The version of the OpenAPI document: 11.19.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/configuration.ts CHANGED
@@ -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.18.0
6
+ * The version of the OpenAPI document: 11.19.0
7
7
  *
8
8
  *
9
9
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -9,7 +9,7 @@
9
9
  * const accounts = await adminApi.accounts.getAccounts();
10
10
  * const eventsPasses = await adminApi.eventsPasses.getEventPasses();
11
11
  */
12
- import { AccountsApi, AccountsAddressesApi, AccountsFollowersApi, AccountsFollowingApi, AccountsGroupsApi, AccountsInterestsApi, AccountsInvitationsApi, AccountsLeadsApi, AccountsTiersApi, ActivitiesApi, ActivitiesScheduleApi, AdvertisementsApi, AnnouncementsApi, AnnouncementsScheduleApi, AnnouncementsTranslationsApi, ApiLogsApi, AuthSessionsApi, BenefitsApi, BenefitsTranslationsApi, BookingsApi, BookingsAvailabilitiesApi, BookingsBlackoutsApi, BookingsPlacesApi, BookingsPlacesTranslationsApi, BookingsQuestionsApi, BookingsQuestionsChoicesApi, BookingsQuestionsChoicesTranslationsApi, BookingsQuestionsTranslationsApi, BookingsResponsesApi, BookingsSpacesApi, BookingsSpacesTranslationsApi, ChannelsApi, ChannelsTranslationsApi, DashboardsApi, DashboardsWidgetsApi, EmailReceiptsApi, EventsApi, EventsAccessApi, EventsActivationsApi, EventsActivationsSessionsApi, EventsActivationsTranslationsApi, EventsAddonsApi, EventsAddonsTranslationsApi, EventsAttributesApi, EventsBenefitsApi, EventsBlocksApi, EventsBypassApi, EventsCohostsApi, EventsCouponsApi, EventsEmailsApi, EventsEmailsTranslationsApi, EventsFaqsApi, EventsFaqsTranslationsApi, EventsFollowupsApi, EventsFollowupsTranslationsApi, EventsGroupcouponreminderApi, EventsMatchesApi, EventsMediaApi, EventsMediaTranslationsApi, EventsOnSiteApi, EventsPackagesApi, EventsPackagesPassesApi, EventsPackagesTranslationsApi, EventsPagesApi, EventsPagesTranslationsApi, EventsPasschangesApi, EventsPassesApi, EventsPassesAccessesApi, EventsPassesAddonsApi, EventsPassesAttributesApi, EventsPassesFollowupsApi, EventsPassesResponsesApi, EventsPasstypesApi, EventsPasstypesExchangetargetsApi, EventsPasstypesPriceschedulesApi, EventsPasstypesRefundschedulesApi, EventsPasstypesTranslationsApi, EventsQuestionsApi, EventsQuestionsTranslationsApi, EventsRegistrationsApi, EventsRegistrationsPackagesApi, EventsRegistrationsReservationsApi, EventsRoomsApi, EventsRoomtypesApi, EventsRoomtypesTranslationsApi, EventsSectionsApi, EventsSectionsTranslationsApi, EventsSessionsApi, EventsSessionsAccessesApi, EventsSessionsLocationsApi, EventsSessionsLocationsTranslationsApi, EventsSessionsMatchesApi, EventsSessionsPricesApi, EventsSessionsQuestionsApi, EventsSessionsQuestionsTranslationsApi, EventsSessionsSectionsApi, EventsSessionsSectionsTranslationsApi, EventsSessionsTimesApi, EventsSessionsTimesTranslationsApi, EventsSessionsTranslationsApi, EventsSpeakersApi, EventsSpeakersTranslationsApi, EventsSponsorsApi, EventsSponsorshiplevelsApi, EventsSponsorshiplevelsTranslationsApi, EventsSponsorshipsApi, EventsSponsorshipsTranslationsApi, EventsTemplatesApi, EventsTracksApi, EventsTracksTranslationsApi, EventsTransfersApi, EventsTranslationsApi, FilesApi, GroupsApi, GroupsEventsApi, GroupsInterestsApi, GroupsInvitationsApi, GroupsMembersApi, GroupsModeratorsApi, GroupsRequestsApi, GroupsSponsorsApi, GroupsTranslationsApi, ImportsApi, InterestsApi, InvoicesApi, InvoicesLineitemsApi, LoginsApi, LoginsAccountsApi, MeetingsApi, MeetingsLinksApi, MeetingsLivestreamsApi, MeetingsParticipantsApi, MeetingsPresetsApi, MeetingsRecordingsApi, MeetingsSessionsApi, NotificationsApi, OrganizationApi, OrganizationAttributesApi, OrganizationDomainsApi, OrganizationEntitiesApi, OrganizationIntegrationsApi, OrganizationLanguageoverridesApi, OrganizationModulesApi, OrganizationModulesCustomApi, OrganizationModulesCustomTranslationsApi, OrganizationModulesSettingsApi, OrganizationModulesSettingsTranslationsApi, OrganizationModulesTiersApi, OrganizationPaymentsApi, OrganizationSideeffectsApi, OrganizationTaxApi, OrganizationTeammembersApi, OrganizationUsersApi, OrganizationWebhooksApi, PaymentsApi, PreferencesApi, PushDevicesApi, ReportsApi, ReportsUsersApi, SearchlistsApi, SearchlistsValuesApi, SelfApi, SelfApikeysApi, SelfImagesApi, SeriesApi, SeriesQuestionsApi, SeriesQuestionsChoicesApi, SeriesQuestionsTranslationsApi, SeriesRegistrationsApi, SeriesTranslationsApi, SponsorsApi, SponsorsAccountsApi, SponsorsTranslationsApi, StorageFilesApi, StorageImagesApi, StorageVideosApi, StorageVideosCaptionsApi, StreamsApi, StreamsOutputsApi, StreamsSessionsApi, SupportApi, SupportMessagesApi, SupportNotesApi, SurveysApi, SurveysQuestionsApi, SurveysQuestionsTranslationsApi, SurveysSectionsApi, SurveysSectionsTranslationsApi, SurveysSessionsApi, SurveysSubmissionsApi, SurveysTranslationsApi, ThreadsApi, ThreadsAccountsApi, ThreadsMessagesApi, ThreadsMessagesFilesApi, ThreadsMessagesImagesApi, ThreadsMessagesReactionsApi, ThreadsMessagesVideosApi, ThreadsStorageApi, TiersApi } from "./api";
12
+ import { AccountsApi, AccountsAddressesApi, AccountsFollowersApi, AccountsFollowingApi, AccountsGroupsApi, AccountsInterestsApi, AccountsInvitationsApi, AccountsLeadsApi, AccountsMergesApi, AccountsTiersApi, ActivitiesApi, ActivitiesScheduleApi, AdvertisementsApi, AnnouncementsApi, AnnouncementsScheduleApi, AnnouncementsTranslationsApi, ApiLogsApi, AuthSessionsApi, BenefitsApi, BenefitsTranslationsApi, BookingsApi, BookingsAvailabilitiesApi, BookingsBlackoutsApi, BookingsPlacesApi, BookingsPlacesTranslationsApi, BookingsQuestionsApi, BookingsQuestionsChoicesApi, BookingsQuestionsChoicesTranslationsApi, BookingsQuestionsTranslationsApi, BookingsResponsesApi, BookingsSpacesApi, BookingsSpacesTranslationsApi, ChannelsApi, ChannelsTranslationsApi, DashboardsApi, DashboardsWidgetsApi, EmailReceiptsApi, EventsApi, EventsAccessApi, EventsActivationsApi, EventsActivationsSessionsApi, EventsActivationsTranslationsApi, EventsAddonsApi, EventsAddonsTranslationsApi, EventsAttributesApi, EventsBenefitsApi, EventsBlocksApi, EventsBypassApi, EventsCohostsApi, EventsCouponsApi, EventsEmailsApi, EventsEmailsTranslationsApi, EventsFaqsApi, EventsFaqsTranslationsApi, EventsFollowupsApi, EventsFollowupsTranslationsApi, EventsGroupcouponreminderApi, EventsMatchesApi, EventsMediaApi, EventsMediaTranslationsApi, EventsOnSiteApi, EventsPackagesApi, EventsPackagesPassesApi, EventsPackagesTranslationsApi, EventsPagesApi, EventsPagesTranslationsApi, EventsPasschangesApi, EventsPassesApi, EventsPassesAccessesApi, EventsPassesAddonsApi, EventsPassesAttributesApi, EventsPassesFollowupsApi, EventsPassesResponsesApi, EventsPasstypesApi, EventsPasstypesExchangetargetsApi, EventsPasstypesPriceschedulesApi, EventsPasstypesRefundschedulesApi, EventsPasstypesTranslationsApi, EventsQuestionsApi, EventsQuestionsTranslationsApi, EventsRegistrationsApi, EventsRegistrationsPackagesApi, EventsRegistrationsReservationsApi, EventsRoomsApi, EventsRoomtypesApi, EventsRoomtypesTranslationsApi, EventsSectionsApi, EventsSectionsTranslationsApi, EventsSessionsApi, EventsSessionsAccessesApi, EventsSessionsLocationsApi, EventsSessionsLocationsTranslationsApi, EventsSessionsMatchesApi, EventsSessionsPricesApi, EventsSessionsQuestionsApi, EventsSessionsQuestionsTranslationsApi, EventsSessionsSectionsApi, EventsSessionsSectionsTranslationsApi, EventsSessionsTimesApi, EventsSessionsTimesTranslationsApi, EventsSessionsTranslationsApi, EventsSpeakersApi, EventsSpeakersTranslationsApi, EventsSponsorsApi, EventsSponsorshiplevelsApi, EventsSponsorshiplevelsTranslationsApi, EventsSponsorshipsApi, EventsSponsorshipsTranslationsApi, EventsTemplatesApi, EventsTracksApi, EventsTracksTranslationsApi, EventsTransfersApi, EventsTranslationsApi, FilesApi, GroupsApi, GroupsEventsApi, GroupsInterestsApi, GroupsInvitationsApi, GroupsMembersApi, GroupsModeratorsApi, GroupsRequestsApi, GroupsSponsorsApi, GroupsTranslationsApi, ImportsApi, InterestsApi, InvoicesApi, InvoicesLineitemsApi, LoginsApi, LoginsAccountsApi, MeetingsApi, MeetingsLinksApi, MeetingsLivestreamsApi, MeetingsParticipantsApi, MeetingsPresetsApi, MeetingsRecordingsApi, MeetingsSessionsApi, NotificationsApi, OrganizationApi, OrganizationAttributesApi, OrganizationDomainsApi, OrganizationEntitiesApi, OrganizationIntegrationsApi, OrganizationLanguageoverridesApi, OrganizationModulesApi, OrganizationModulesCustomApi, OrganizationModulesCustomTranslationsApi, OrganizationModulesSettingsApi, OrganizationModulesSettingsTranslationsApi, OrganizationModulesTiersApi, OrganizationPaymentsApi, OrganizationSideeffectsApi, OrganizationTaxApi, OrganizationTeammembersApi, OrganizationUsersApi, OrganizationWebhooksApi, PaymentsApi, PreferencesApi, PushDevicesApi, ReportsApi, ReportsUsersApi, SearchlistsApi, SearchlistsValuesApi, SelfApi, SelfApikeysApi, SelfImagesApi, SeriesApi, SeriesQuestionsApi, SeriesQuestionsChoicesApi, SeriesQuestionsTranslationsApi, SeriesRegistrationsApi, SeriesTranslationsApi, SponsorsApi, SponsorsAccountsApi, SponsorsTranslationsApi, StorageFilesApi, StorageImagesApi, StorageVideosApi, StorageVideosCaptionsApi, StreamsApi, StreamsOutputsApi, StreamsSessionsApi, SupportApi, SupportMessagesApi, SupportNotesApi, SurveysApi, SurveysQuestionsApi, SurveysQuestionsTranslationsApi, SurveysSectionsApi, SurveysSectionsTranslationsApi, SurveysSessionsApi, SurveysSubmissionsApi, SurveysTranslationsApi, ThreadsApi, ThreadsAccountsApi, ThreadsMessagesApi, ThreadsMessagesFilesApi, ThreadsMessagesImagesApi, ThreadsMessagesReactionsApi, ThreadsMessagesVideosApi, ThreadsStorageApi, TiersApi } from "./api";
13
13
  export interface AdminApiConfig {
14
14
  /** Your API key for authentication */
15
15
  apiKey: string;
@@ -28,6 +28,7 @@ export declare class AdminApi {
28
28
  readonly accountsInterests: AccountsInterestsApi;
29
29
  readonly accountsInvitations: AccountsInvitationsApi;
30
30
  readonly accountsLeads: AccountsLeadsApi;
31
+ readonly accountsMerges: AccountsMergesApi;
31
32
  readonly accountsTiers: AccountsTiersApi;
32
33
  readonly activities: ActivitiesApi;
33
34
  readonly activitiesSchedule: ActivitiesScheduleApi;