@connectedxm/admin-sdk 11.18.0 → 11.20.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/.openapi-generator/FILES +10 -0
- package/AdminApi.ts +3 -0
- package/README.md +2 -2
- package/api.ts +571 -1
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/AdminApi.d.ts +2 -1
- package/dist/AdminApi.js +1 -0
- package/dist/api.d.ts +322 -1
- package/dist/api.js +444 -30
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/esm/AdminApi.d.ts +2 -1
- package/dist/esm/AdminApi.js +2 -1
- package/dist/esm/api.d.ts +322 -1
- package/dist/esm/api.js +411 -1
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +1 -1
- package/docs/Account.md +2 -0
- package/docs/AccountMerge.md +48 -0
- package/docs/AccountMergePreview.md +30 -0
- package/docs/AccountMergePreviewCounts.md +54 -0
- package/docs/AccountMergeStatus.md +14 -0
- package/docs/AccountMergeWarning.md +22 -0
- package/docs/AccountUpdateInputs.md +2 -0
- package/docs/AccountsMergesApi.md +274 -0
- package/docs/GetAccountMerge200Response.md +24 -0
- package/docs/GetAccountMergePreview200Response.md +24 -0
- package/docs/GetAccountMerges200Response.md +24 -0
- package/docs/MergeAccountRequest.md +20 -0
- package/docs/NotificationPreferences.md +2 -0
- package/package.json +1 -1
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.
|
|
7
|
+
* The version of the OpenAPI document: 11.20.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -102,6 +102,7 @@ export interface Account {
|
|
|
102
102
|
'youtube': string | null;
|
|
103
103
|
'dietaryRestrictions': string | null;
|
|
104
104
|
'taxEntityUseCode': string | null;
|
|
105
|
+
'doNotContact': boolean;
|
|
105
106
|
'updatedAt': string;
|
|
106
107
|
}
|
|
107
108
|
|
|
@@ -257,6 +258,66 @@ export interface AccountInvitation {
|
|
|
257
258
|
'email': string;
|
|
258
259
|
'createdAt': string;
|
|
259
260
|
}
|
|
261
|
+
export interface AccountMerge {
|
|
262
|
+
'id': string;
|
|
263
|
+
'survivorAccountId': string;
|
|
264
|
+
'survivorAccount': BaseAccount;
|
|
265
|
+
'mergedAccountId': string;
|
|
266
|
+
'mergedEmail': string | null;
|
|
267
|
+
'mergedName': string | null;
|
|
268
|
+
'mergedUsername': string | null;
|
|
269
|
+
'status': AccountMergeStatus;
|
|
270
|
+
'message': string | null;
|
|
271
|
+
'counts': { [key: string]: any; };
|
|
272
|
+
'user': BaseUser | null;
|
|
273
|
+
'startedAt': string | null;
|
|
274
|
+
'completedAt': string | null;
|
|
275
|
+
'createdAt': string;
|
|
276
|
+
'updatedAt': string;
|
|
277
|
+
}
|
|
278
|
+
|
|
279
|
+
|
|
280
|
+
export interface AccountMergePreview {
|
|
281
|
+
'survivorAccount': BaseAccount;
|
|
282
|
+
'mergedAccount': BaseAccount;
|
|
283
|
+
'counts': AccountMergePreviewCounts;
|
|
284
|
+
'filledFields': Array<string>;
|
|
285
|
+
'blocking': Array<AccountMergeWarning>;
|
|
286
|
+
'warnings': Array<AccountMergeWarning>;
|
|
287
|
+
}
|
|
288
|
+
export interface AccountMergePreviewCounts {
|
|
289
|
+
'logins': number;
|
|
290
|
+
'registrations': number;
|
|
291
|
+
'seriesRegistrations': number;
|
|
292
|
+
'bookings': number;
|
|
293
|
+
'payments': number;
|
|
294
|
+
'invoices': number;
|
|
295
|
+
'paymentIntents': number;
|
|
296
|
+
'groups': number;
|
|
297
|
+
'threadAccounts': number;
|
|
298
|
+
'activities': number;
|
|
299
|
+
'followers': number;
|
|
300
|
+
'following': number;
|
|
301
|
+
'leads': number;
|
|
302
|
+
'accountTiers': number;
|
|
303
|
+
'supportTickets': number;
|
|
304
|
+
'surveySubmissions': number;
|
|
305
|
+
'sponsorshipLevels': number;
|
|
306
|
+
'addresses': number;
|
|
307
|
+
}
|
|
308
|
+
|
|
309
|
+
export enum AccountMergeStatus {
|
|
310
|
+
Pending = 'pending',
|
|
311
|
+
Processing = 'processing',
|
|
312
|
+
Completed = 'completed',
|
|
313
|
+
Failed = 'failed'
|
|
314
|
+
}
|
|
315
|
+
|
|
316
|
+
|
|
317
|
+
export interface AccountMergeWarning {
|
|
318
|
+
'code': string;
|
|
319
|
+
'message': string;
|
|
320
|
+
}
|
|
260
321
|
export interface AccountUpdateInputs {
|
|
261
322
|
'accountAccess'?: AccountAccess | null;
|
|
262
323
|
'featured'?: boolean;
|
|
@@ -282,6 +343,7 @@ export interface AccountUpdateInputs {
|
|
|
282
343
|
'internalRefId'?: string | null;
|
|
283
344
|
'internalRefIdVerified'?: boolean;
|
|
284
345
|
'verified'?: boolean;
|
|
346
|
+
'doNotContact'?: boolean;
|
|
285
347
|
'locale'?: string | null;
|
|
286
348
|
'taxEntityUseCode'?: string | null;
|
|
287
349
|
'attributes'?: { [key: string]: any; } | null;
|
|
@@ -7288,6 +7350,36 @@ export enum GetAccountLikes200ResponseStatusEnum {
|
|
|
7288
7350
|
Ok = 'ok'
|
|
7289
7351
|
}
|
|
7290
7352
|
|
|
7353
|
+
export interface GetAccountMerge200Response {
|
|
7354
|
+
'status': GetAccountMerge200ResponseStatusEnum;
|
|
7355
|
+
'message': string;
|
|
7356
|
+
'data': AccountMerge;
|
|
7357
|
+
}
|
|
7358
|
+
|
|
7359
|
+
export enum GetAccountMerge200ResponseStatusEnum {
|
|
7360
|
+
Ok = 'ok'
|
|
7361
|
+
}
|
|
7362
|
+
|
|
7363
|
+
export interface GetAccountMergePreview200Response {
|
|
7364
|
+
'status': GetAccountMergePreview200ResponseStatusEnum;
|
|
7365
|
+
'message': string;
|
|
7366
|
+
'data': AccountMergePreview;
|
|
7367
|
+
}
|
|
7368
|
+
|
|
7369
|
+
export enum GetAccountMergePreview200ResponseStatusEnum {
|
|
7370
|
+
Ok = 'ok'
|
|
7371
|
+
}
|
|
7372
|
+
|
|
7373
|
+
export interface GetAccountMerges200Response {
|
|
7374
|
+
'status': GetAccountMerges200ResponseStatusEnum;
|
|
7375
|
+
'message': string;
|
|
7376
|
+
'data': Array<AccountMerge>;
|
|
7377
|
+
}
|
|
7378
|
+
|
|
7379
|
+
export enum GetAccountMerges200ResponseStatusEnum {
|
|
7380
|
+
Ok = 'ok'
|
|
7381
|
+
}
|
|
7382
|
+
|
|
7291
7383
|
export interface GetAccountNotificationPreferences200Response {
|
|
7292
7384
|
'status': GetAccountNotificationPreferences200ResponseStatusEnum;
|
|
7293
7385
|
'message': string;
|
|
@@ -11842,6 +11934,9 @@ export enum MentionInputsMarksEnum {
|
|
|
11842
11934
|
Strike = 'strike'
|
|
11843
11935
|
}
|
|
11844
11936
|
|
|
11937
|
+
export interface MergeAccountRequest {
|
|
11938
|
+
'mergeAccountId': string;
|
|
11939
|
+
}
|
|
11845
11940
|
export interface ModelFile {
|
|
11846
11941
|
'id': number;
|
|
11847
11942
|
'name': string;
|
|
@@ -11929,6 +12024,7 @@ export interface NotificationPreferences {
|
|
|
11929
12024
|
'groupInvitationPush': boolean;
|
|
11930
12025
|
'groupRequestAcceptedEmail': boolean;
|
|
11931
12026
|
'groupRequestAcceptedPush': boolean;
|
|
12027
|
+
'optedOutAt': string | null;
|
|
11932
12028
|
}
|
|
11933
12029
|
export interface NotificationStats {
|
|
11934
12030
|
'total': number;
|
|
@@ -20689,6 +20785,480 @@ export class AccountsLeadsApi extends BaseAPI {
|
|
|
20689
20785
|
|
|
20690
20786
|
|
|
20691
20787
|
|
|
20788
|
+
/**
|
|
20789
|
+
* AccountsMergesApi - axios parameter creator
|
|
20790
|
+
*/
|
|
20791
|
+
export const AccountsMergesApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
20792
|
+
return {
|
|
20793
|
+
/**
|
|
20794
|
+
* 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.
|
|
20795
|
+
* @summary Get an account merge
|
|
20796
|
+
* @param {string} mergeId The merge identifier
|
|
20797
|
+
* @param {*} [options] Override http request option.
|
|
20798
|
+
* @throws {RequiredError}
|
|
20799
|
+
*/
|
|
20800
|
+
getAccountMerge: async (mergeId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
20801
|
+
// verify required parameter 'mergeId' is not null or undefined
|
|
20802
|
+
assertParamExists('getAccountMerge', 'mergeId', mergeId)
|
|
20803
|
+
const localVarPath = `/accounts/merges/{mergeId}`
|
|
20804
|
+
.replace('{mergeId}', encodeURIComponent(String(mergeId)));
|
|
20805
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
20806
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
20807
|
+
let baseOptions;
|
|
20808
|
+
if (configuration) {
|
|
20809
|
+
baseOptions = configuration.baseOptions;
|
|
20810
|
+
}
|
|
20811
|
+
|
|
20812
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
20813
|
+
const localVarHeaderParameter = {} as any;
|
|
20814
|
+
const localVarQueryParameter = {} as any;
|
|
20815
|
+
|
|
20816
|
+
// authentication ApiKeyAuth required
|
|
20817
|
+
await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
|
|
20818
|
+
|
|
20819
|
+
// authentication OrganizationId required
|
|
20820
|
+
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
20821
|
+
|
|
20822
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
20823
|
+
|
|
20824
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
20825
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
20826
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
20827
|
+
|
|
20828
|
+
return {
|
|
20829
|
+
url: toPathString(localVarUrlObj),
|
|
20830
|
+
options: localVarRequestOptions,
|
|
20831
|
+
};
|
|
20832
|
+
},
|
|
20833
|
+
/**
|
|
20834
|
+
* 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.
|
|
20835
|
+
* @summary Preview an account merge
|
|
20836
|
+
* @param {string} accountId The account identifier
|
|
20837
|
+
* @param {string} mergeAccountId Filter by mergeAccountId
|
|
20838
|
+
* @param {*} [options] Override http request option.
|
|
20839
|
+
* @throws {RequiredError}
|
|
20840
|
+
*/
|
|
20841
|
+
getAccountMergePreview: async (accountId: string, mergeAccountId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
20842
|
+
// verify required parameter 'accountId' is not null or undefined
|
|
20843
|
+
assertParamExists('getAccountMergePreview', 'accountId', accountId)
|
|
20844
|
+
// verify required parameter 'mergeAccountId' is not null or undefined
|
|
20845
|
+
assertParamExists('getAccountMergePreview', 'mergeAccountId', mergeAccountId)
|
|
20846
|
+
const localVarPath = `/accounts/{accountId}/merge/preview`
|
|
20847
|
+
.replace('{accountId}', encodeURIComponent(String(accountId)));
|
|
20848
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
20849
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
20850
|
+
let baseOptions;
|
|
20851
|
+
if (configuration) {
|
|
20852
|
+
baseOptions = configuration.baseOptions;
|
|
20853
|
+
}
|
|
20854
|
+
|
|
20855
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
20856
|
+
const localVarHeaderParameter = {} as any;
|
|
20857
|
+
const localVarQueryParameter = {} as any;
|
|
20858
|
+
|
|
20859
|
+
// authentication ApiKeyAuth required
|
|
20860
|
+
await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
|
|
20861
|
+
|
|
20862
|
+
// authentication OrganizationId required
|
|
20863
|
+
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
20864
|
+
|
|
20865
|
+
if (mergeAccountId !== undefined) {
|
|
20866
|
+
localVarQueryParameter['mergeAccountId'] = mergeAccountId;
|
|
20867
|
+
}
|
|
20868
|
+
|
|
20869
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
20870
|
+
|
|
20871
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
20872
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
20873
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
20874
|
+
|
|
20875
|
+
return {
|
|
20876
|
+
url: toPathString(localVarUrlObj),
|
|
20877
|
+
options: localVarRequestOptions,
|
|
20878
|
+
};
|
|
20879
|
+
},
|
|
20880
|
+
/**
|
|
20881
|
+
* Returns every merge in which the given account was the surviving or the merged account, newest first; requires read access to accounts.
|
|
20882
|
+
* @summary List an account\'s merges
|
|
20883
|
+
* @param {string} accountId The account identifier
|
|
20884
|
+
* @param {*} [options] Override http request option.
|
|
20885
|
+
* @throws {RequiredError}
|
|
20886
|
+
*/
|
|
20887
|
+
getAccountMerges: async (accountId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
20888
|
+
// verify required parameter 'accountId' is not null or undefined
|
|
20889
|
+
assertParamExists('getAccountMerges', 'accountId', accountId)
|
|
20890
|
+
const localVarPath = `/accounts/{accountId}/merges`
|
|
20891
|
+
.replace('{accountId}', encodeURIComponent(String(accountId)));
|
|
20892
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
20893
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
20894
|
+
let baseOptions;
|
|
20895
|
+
if (configuration) {
|
|
20896
|
+
baseOptions = configuration.baseOptions;
|
|
20897
|
+
}
|
|
20898
|
+
|
|
20899
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
20900
|
+
const localVarHeaderParameter = {} as any;
|
|
20901
|
+
const localVarQueryParameter = {} as any;
|
|
20902
|
+
|
|
20903
|
+
// authentication ApiKeyAuth required
|
|
20904
|
+
await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
|
|
20905
|
+
|
|
20906
|
+
// authentication OrganizationId required
|
|
20907
|
+
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
20908
|
+
|
|
20909
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
20910
|
+
|
|
20911
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
20912
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
20913
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
20914
|
+
|
|
20915
|
+
return {
|
|
20916
|
+
url: toPathString(localVarUrlObj),
|
|
20917
|
+
options: localVarRequestOptions,
|
|
20918
|
+
};
|
|
20919
|
+
},
|
|
20920
|
+
/**
|
|
20921
|
+
* 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.
|
|
20922
|
+
* @summary Merge an account into another
|
|
20923
|
+
* @param {string} accountId The account identifier
|
|
20924
|
+
* @param {MergeAccountRequest} mergeAccountRequest
|
|
20925
|
+
* @param {*} [options] Override http request option.
|
|
20926
|
+
* @throws {RequiredError}
|
|
20927
|
+
*/
|
|
20928
|
+
mergeAccount: async (accountId: string, mergeAccountRequest: MergeAccountRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
20929
|
+
// verify required parameter 'accountId' is not null or undefined
|
|
20930
|
+
assertParamExists('mergeAccount', 'accountId', accountId)
|
|
20931
|
+
// verify required parameter 'mergeAccountRequest' is not null or undefined
|
|
20932
|
+
assertParamExists('mergeAccount', 'mergeAccountRequest', mergeAccountRequest)
|
|
20933
|
+
const localVarPath = `/accounts/{accountId}/merge`
|
|
20934
|
+
.replace('{accountId}', encodeURIComponent(String(accountId)));
|
|
20935
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
20936
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
20937
|
+
let baseOptions;
|
|
20938
|
+
if (configuration) {
|
|
20939
|
+
baseOptions = configuration.baseOptions;
|
|
20940
|
+
}
|
|
20941
|
+
|
|
20942
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
20943
|
+
const localVarHeaderParameter = {} as any;
|
|
20944
|
+
const localVarQueryParameter = {} as any;
|
|
20945
|
+
|
|
20946
|
+
// authentication ApiKeyAuth required
|
|
20947
|
+
await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
|
|
20948
|
+
|
|
20949
|
+
// authentication OrganizationId required
|
|
20950
|
+
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
20951
|
+
|
|
20952
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
20953
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
20954
|
+
|
|
20955
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
20956
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
20957
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
20958
|
+
localVarRequestOptions.data = serializeDataIfNeeded(mergeAccountRequest, localVarRequestOptions, configuration)
|
|
20959
|
+
|
|
20960
|
+
return {
|
|
20961
|
+
url: toPathString(localVarUrlObj),
|
|
20962
|
+
options: localVarRequestOptions,
|
|
20963
|
+
};
|
|
20964
|
+
},
|
|
20965
|
+
/**
|
|
20966
|
+
* 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.
|
|
20967
|
+
* @summary Retry an account merge
|
|
20968
|
+
* @param {string} mergeId The merge identifier
|
|
20969
|
+
* @param {*} [options] Override http request option.
|
|
20970
|
+
* @throws {RequiredError}
|
|
20971
|
+
*/
|
|
20972
|
+
retryAccountMerge: async (mergeId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
20973
|
+
// verify required parameter 'mergeId' is not null or undefined
|
|
20974
|
+
assertParamExists('retryAccountMerge', 'mergeId', mergeId)
|
|
20975
|
+
const localVarPath = `/accounts/merges/{mergeId}/retry`
|
|
20976
|
+
.replace('{mergeId}', encodeURIComponent(String(mergeId)));
|
|
20977
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
20978
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
20979
|
+
let baseOptions;
|
|
20980
|
+
if (configuration) {
|
|
20981
|
+
baseOptions = configuration.baseOptions;
|
|
20982
|
+
}
|
|
20983
|
+
|
|
20984
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
20985
|
+
const localVarHeaderParameter = {} as any;
|
|
20986
|
+
const localVarQueryParameter = {} as any;
|
|
20987
|
+
|
|
20988
|
+
// authentication ApiKeyAuth required
|
|
20989
|
+
await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
|
|
20990
|
+
|
|
20991
|
+
// authentication OrganizationId required
|
|
20992
|
+
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
20993
|
+
|
|
20994
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
20995
|
+
|
|
20996
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
20997
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
20998
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
20999
|
+
|
|
21000
|
+
return {
|
|
21001
|
+
url: toPathString(localVarUrlObj),
|
|
21002
|
+
options: localVarRequestOptions,
|
|
21003
|
+
};
|
|
21004
|
+
},
|
|
21005
|
+
}
|
|
21006
|
+
};
|
|
21007
|
+
|
|
21008
|
+
/**
|
|
21009
|
+
* AccountsMergesApi - functional programming interface
|
|
21010
|
+
*/
|
|
21011
|
+
export const AccountsMergesApiFp = function(configuration?: Configuration) {
|
|
21012
|
+
const localVarAxiosParamCreator = AccountsMergesApiAxiosParamCreator(configuration)
|
|
21013
|
+
return {
|
|
21014
|
+
/**
|
|
21015
|
+
* 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.
|
|
21016
|
+
* @summary Get an account merge
|
|
21017
|
+
* @param {string} mergeId The merge identifier
|
|
21018
|
+
* @param {*} [options] Override http request option.
|
|
21019
|
+
* @throws {RequiredError}
|
|
21020
|
+
*/
|
|
21021
|
+
async getAccountMerge(mergeId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAccountMerge200Response>> {
|
|
21022
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getAccountMerge(mergeId, options);
|
|
21023
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
21024
|
+
const localVarOperationServerBasePath = operationServerMap['AccountsMergesApi.getAccountMerge']?.[localVarOperationServerIndex]?.url;
|
|
21025
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
21026
|
+
},
|
|
21027
|
+
/**
|
|
21028
|
+
* 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.
|
|
21029
|
+
* @summary Preview an account merge
|
|
21030
|
+
* @param {string} accountId The account identifier
|
|
21031
|
+
* @param {string} mergeAccountId Filter by mergeAccountId
|
|
21032
|
+
* @param {*} [options] Override http request option.
|
|
21033
|
+
* @throws {RequiredError}
|
|
21034
|
+
*/
|
|
21035
|
+
async getAccountMergePreview(accountId: string, mergeAccountId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAccountMergePreview200Response>> {
|
|
21036
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getAccountMergePreview(accountId, mergeAccountId, options);
|
|
21037
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
21038
|
+
const localVarOperationServerBasePath = operationServerMap['AccountsMergesApi.getAccountMergePreview']?.[localVarOperationServerIndex]?.url;
|
|
21039
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
21040
|
+
},
|
|
21041
|
+
/**
|
|
21042
|
+
* Returns every merge in which the given account was the surviving or the merged account, newest first; requires read access to accounts.
|
|
21043
|
+
* @summary List an account\'s merges
|
|
21044
|
+
* @param {string} accountId The account identifier
|
|
21045
|
+
* @param {*} [options] Override http request option.
|
|
21046
|
+
* @throws {RequiredError}
|
|
21047
|
+
*/
|
|
21048
|
+
async getAccountMerges(accountId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAccountMerges200Response>> {
|
|
21049
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getAccountMerges(accountId, options);
|
|
21050
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
21051
|
+
const localVarOperationServerBasePath = operationServerMap['AccountsMergesApi.getAccountMerges']?.[localVarOperationServerIndex]?.url;
|
|
21052
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
21053
|
+
},
|
|
21054
|
+
/**
|
|
21055
|
+
* 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.
|
|
21056
|
+
* @summary Merge an account into another
|
|
21057
|
+
* @param {string} accountId The account identifier
|
|
21058
|
+
* @param {MergeAccountRequest} mergeAccountRequest
|
|
21059
|
+
* @param {*} [options] Override http request option.
|
|
21060
|
+
* @throws {RequiredError}
|
|
21061
|
+
*/
|
|
21062
|
+
async mergeAccount(accountId: string, mergeAccountRequest: MergeAccountRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAccountMerge200Response>> {
|
|
21063
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.mergeAccount(accountId, mergeAccountRequest, options);
|
|
21064
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
21065
|
+
const localVarOperationServerBasePath = operationServerMap['AccountsMergesApi.mergeAccount']?.[localVarOperationServerIndex]?.url;
|
|
21066
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
21067
|
+
},
|
|
21068
|
+
/**
|
|
21069
|
+
* 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.
|
|
21070
|
+
* @summary Retry an account merge
|
|
21071
|
+
* @param {string} mergeId The merge identifier
|
|
21072
|
+
* @param {*} [options] Override http request option.
|
|
21073
|
+
* @throws {RequiredError}
|
|
21074
|
+
*/
|
|
21075
|
+
async retryAccountMerge(mergeId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAccountMerge200Response>> {
|
|
21076
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.retryAccountMerge(mergeId, options);
|
|
21077
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
21078
|
+
const localVarOperationServerBasePath = operationServerMap['AccountsMergesApi.retryAccountMerge']?.[localVarOperationServerIndex]?.url;
|
|
21079
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
21080
|
+
},
|
|
21081
|
+
}
|
|
21082
|
+
};
|
|
21083
|
+
|
|
21084
|
+
/**
|
|
21085
|
+
* AccountsMergesApi - factory interface
|
|
21086
|
+
*/
|
|
21087
|
+
export const AccountsMergesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
21088
|
+
const localVarFp = AccountsMergesApiFp(configuration)
|
|
21089
|
+
return {
|
|
21090
|
+
/**
|
|
21091
|
+
* 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.
|
|
21092
|
+
* @summary Get an account merge
|
|
21093
|
+
* @param {AccountsMergesApiGetAccountMergeRequest} requestParameters Request parameters.
|
|
21094
|
+
* @param {*} [options] Override http request option.
|
|
21095
|
+
* @throws {RequiredError}
|
|
21096
|
+
*/
|
|
21097
|
+
getAccountMerge(requestParameters: AccountsMergesApiGetAccountMergeRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAccountMerge200Response> {
|
|
21098
|
+
return localVarFp.getAccountMerge(requestParameters.mergeId, options).then((request) => request(axios, basePath));
|
|
21099
|
+
},
|
|
21100
|
+
/**
|
|
21101
|
+
* 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.
|
|
21102
|
+
* @summary Preview an account merge
|
|
21103
|
+
* @param {AccountsMergesApiGetAccountMergePreviewRequest} requestParameters Request parameters.
|
|
21104
|
+
* @param {*} [options] Override http request option.
|
|
21105
|
+
* @throws {RequiredError}
|
|
21106
|
+
*/
|
|
21107
|
+
getAccountMergePreview(requestParameters: AccountsMergesApiGetAccountMergePreviewRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAccountMergePreview200Response> {
|
|
21108
|
+
return localVarFp.getAccountMergePreview(requestParameters.accountId, requestParameters.mergeAccountId, options).then((request) => request(axios, basePath));
|
|
21109
|
+
},
|
|
21110
|
+
/**
|
|
21111
|
+
* Returns every merge in which the given account was the surviving or the merged account, newest first; requires read access to accounts.
|
|
21112
|
+
* @summary List an account\'s merges
|
|
21113
|
+
* @param {AccountsMergesApiGetAccountMergesRequest} requestParameters Request parameters.
|
|
21114
|
+
* @param {*} [options] Override http request option.
|
|
21115
|
+
* @throws {RequiredError}
|
|
21116
|
+
*/
|
|
21117
|
+
getAccountMerges(requestParameters: AccountsMergesApiGetAccountMergesRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAccountMerges200Response> {
|
|
21118
|
+
return localVarFp.getAccountMerges(requestParameters.accountId, options).then((request) => request(axios, basePath));
|
|
21119
|
+
},
|
|
21120
|
+
/**
|
|
21121
|
+
* 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.
|
|
21122
|
+
* @summary Merge an account into another
|
|
21123
|
+
* @param {AccountsMergesApiMergeAccountRequest} requestParameters Request parameters.
|
|
21124
|
+
* @param {*} [options] Override http request option.
|
|
21125
|
+
* @throws {RequiredError}
|
|
21126
|
+
*/
|
|
21127
|
+
mergeAccount(requestParameters: AccountsMergesApiMergeAccountRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAccountMerge200Response> {
|
|
21128
|
+
return localVarFp.mergeAccount(requestParameters.accountId, requestParameters.mergeAccountRequest, options).then((request) => request(axios, basePath));
|
|
21129
|
+
},
|
|
21130
|
+
/**
|
|
21131
|
+
* 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.
|
|
21132
|
+
* @summary Retry an account merge
|
|
21133
|
+
* @param {AccountsMergesApiRetryAccountMergeRequest} requestParameters Request parameters.
|
|
21134
|
+
* @param {*} [options] Override http request option.
|
|
21135
|
+
* @throws {RequiredError}
|
|
21136
|
+
*/
|
|
21137
|
+
retryAccountMerge(requestParameters: AccountsMergesApiRetryAccountMergeRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAccountMerge200Response> {
|
|
21138
|
+
return localVarFp.retryAccountMerge(requestParameters.mergeId, options).then((request) => request(axios, basePath));
|
|
21139
|
+
},
|
|
21140
|
+
};
|
|
21141
|
+
};
|
|
21142
|
+
|
|
21143
|
+
/**
|
|
21144
|
+
* Request parameters for getAccountMerge operation in AccountsMergesApi.
|
|
21145
|
+
*/
|
|
21146
|
+
export interface AccountsMergesApiGetAccountMergeRequest {
|
|
21147
|
+
/**
|
|
21148
|
+
* The merge identifier
|
|
21149
|
+
*/
|
|
21150
|
+
readonly mergeId: string
|
|
21151
|
+
}
|
|
21152
|
+
|
|
21153
|
+
/**
|
|
21154
|
+
* Request parameters for getAccountMergePreview operation in AccountsMergesApi.
|
|
21155
|
+
*/
|
|
21156
|
+
export interface AccountsMergesApiGetAccountMergePreviewRequest {
|
|
21157
|
+
/**
|
|
21158
|
+
* The account identifier
|
|
21159
|
+
*/
|
|
21160
|
+
readonly accountId: string
|
|
21161
|
+
|
|
21162
|
+
/**
|
|
21163
|
+
* Filter by mergeAccountId
|
|
21164
|
+
*/
|
|
21165
|
+
readonly mergeAccountId: string
|
|
21166
|
+
}
|
|
21167
|
+
|
|
21168
|
+
/**
|
|
21169
|
+
* Request parameters for getAccountMerges operation in AccountsMergesApi.
|
|
21170
|
+
*/
|
|
21171
|
+
export interface AccountsMergesApiGetAccountMergesRequest {
|
|
21172
|
+
/**
|
|
21173
|
+
* The account identifier
|
|
21174
|
+
*/
|
|
21175
|
+
readonly accountId: string
|
|
21176
|
+
}
|
|
21177
|
+
|
|
21178
|
+
/**
|
|
21179
|
+
* Request parameters for mergeAccount operation in AccountsMergesApi.
|
|
21180
|
+
*/
|
|
21181
|
+
export interface AccountsMergesApiMergeAccountRequest {
|
|
21182
|
+
/**
|
|
21183
|
+
* The account identifier
|
|
21184
|
+
*/
|
|
21185
|
+
readonly accountId: string
|
|
21186
|
+
|
|
21187
|
+
readonly mergeAccountRequest: MergeAccountRequest
|
|
21188
|
+
}
|
|
21189
|
+
|
|
21190
|
+
/**
|
|
21191
|
+
* Request parameters for retryAccountMerge operation in AccountsMergesApi.
|
|
21192
|
+
*/
|
|
21193
|
+
export interface AccountsMergesApiRetryAccountMergeRequest {
|
|
21194
|
+
/**
|
|
21195
|
+
* The merge identifier
|
|
21196
|
+
*/
|
|
21197
|
+
readonly mergeId: string
|
|
21198
|
+
}
|
|
21199
|
+
|
|
21200
|
+
/**
|
|
21201
|
+
* AccountsMergesApi - object-oriented interface
|
|
21202
|
+
*/
|
|
21203
|
+
export class AccountsMergesApi extends BaseAPI {
|
|
21204
|
+
/**
|
|
21205
|
+
* 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.
|
|
21206
|
+
* @summary Get an account merge
|
|
21207
|
+
* @param {AccountsMergesApiGetAccountMergeRequest} requestParameters Request parameters.
|
|
21208
|
+
* @param {*} [options] Override http request option.
|
|
21209
|
+
* @throws {RequiredError}
|
|
21210
|
+
*/
|
|
21211
|
+
public getAccountMerge(requestParameters: AccountsMergesApiGetAccountMergeRequest, options?: RawAxiosRequestConfig) {
|
|
21212
|
+
return AccountsMergesApiFp(this.configuration).getAccountMerge(requestParameters.mergeId, options).then((request) => request(this.axios, this.basePath));
|
|
21213
|
+
}
|
|
21214
|
+
|
|
21215
|
+
/**
|
|
21216
|
+
* 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.
|
|
21217
|
+
* @summary Preview an account merge
|
|
21218
|
+
* @param {AccountsMergesApiGetAccountMergePreviewRequest} requestParameters Request parameters.
|
|
21219
|
+
* @param {*} [options] Override http request option.
|
|
21220
|
+
* @throws {RequiredError}
|
|
21221
|
+
*/
|
|
21222
|
+
public getAccountMergePreview(requestParameters: AccountsMergesApiGetAccountMergePreviewRequest, options?: RawAxiosRequestConfig) {
|
|
21223
|
+
return AccountsMergesApiFp(this.configuration).getAccountMergePreview(requestParameters.accountId, requestParameters.mergeAccountId, options).then((request) => request(this.axios, this.basePath));
|
|
21224
|
+
}
|
|
21225
|
+
|
|
21226
|
+
/**
|
|
21227
|
+
* Returns every merge in which the given account was the surviving or the merged account, newest first; requires read access to accounts.
|
|
21228
|
+
* @summary List an account\'s merges
|
|
21229
|
+
* @param {AccountsMergesApiGetAccountMergesRequest} requestParameters Request parameters.
|
|
21230
|
+
* @param {*} [options] Override http request option.
|
|
21231
|
+
* @throws {RequiredError}
|
|
21232
|
+
*/
|
|
21233
|
+
public getAccountMerges(requestParameters: AccountsMergesApiGetAccountMergesRequest, options?: RawAxiosRequestConfig) {
|
|
21234
|
+
return AccountsMergesApiFp(this.configuration).getAccountMerges(requestParameters.accountId, options).then((request) => request(this.axios, this.basePath));
|
|
21235
|
+
}
|
|
21236
|
+
|
|
21237
|
+
/**
|
|
21238
|
+
* 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.
|
|
21239
|
+
* @summary Merge an account into another
|
|
21240
|
+
* @param {AccountsMergesApiMergeAccountRequest} requestParameters Request parameters.
|
|
21241
|
+
* @param {*} [options] Override http request option.
|
|
21242
|
+
* @throws {RequiredError}
|
|
21243
|
+
*/
|
|
21244
|
+
public mergeAccount(requestParameters: AccountsMergesApiMergeAccountRequest, options?: RawAxiosRequestConfig) {
|
|
21245
|
+
return AccountsMergesApiFp(this.configuration).mergeAccount(requestParameters.accountId, requestParameters.mergeAccountRequest, options).then((request) => request(this.axios, this.basePath));
|
|
21246
|
+
}
|
|
21247
|
+
|
|
21248
|
+
/**
|
|
21249
|
+
* 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.
|
|
21250
|
+
* @summary Retry an account merge
|
|
21251
|
+
* @param {AccountsMergesApiRetryAccountMergeRequest} requestParameters Request parameters.
|
|
21252
|
+
* @param {*} [options] Override http request option.
|
|
21253
|
+
* @throws {RequiredError}
|
|
21254
|
+
*/
|
|
21255
|
+
public retryAccountMerge(requestParameters: AccountsMergesApiRetryAccountMergeRequest, options?: RawAxiosRequestConfig) {
|
|
21256
|
+
return AccountsMergesApiFp(this.configuration).retryAccountMerge(requestParameters.mergeId, options).then((request) => request(this.axios, this.basePath));
|
|
21257
|
+
}
|
|
21258
|
+
}
|
|
21259
|
+
|
|
21260
|
+
|
|
21261
|
+
|
|
20692
21262
|
/**
|
|
20693
21263
|
* AccountsTiersApi - axios parameter creator
|
|
20694
21264
|
*/
|
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.
|
|
7
|
+
* The version of the OpenAPI document: 11.20.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.
|
|
7
|
+
* The version of the OpenAPI document: 11.20.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.
|
|
6
|
+
* The version of the OpenAPI document: 11.20.0
|
|
7
7
|
*
|
|
8
8
|
*
|
|
9
9
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|