@connectedxm/admin-sdk 11.18.0 → 11.19.0

package/dist/AdminApi.js

@@ -36,6 +36,7 @@ class AdminApi {
         this.accountsInterests = new api_1.AccountsInterestsApi(this.config);
         this.accountsInvitations = new api_1.AccountsInvitationsApi(this.config);
         this.accountsLeads = new api_1.AccountsLeadsApi(this.config);
+        this.accountsMerges = new api_1.AccountsMergesApi(this.config);
         this.accountsTiers = new api_1.AccountsTiersApi(this.config);
         this.activities = new api_1.ActivitiesApi(this.config);
         this.activitiesSchedule = new api_1.ActivitiesScheduleApi(this.config);

package/dist/api.d.ts

@@ -2,7 +2,7 @@
  * Connected Admin API
  * The Admin API allows you to manage your Connected community programmatically.
  *
- * The version of the OpenAPI document: 11.18.0
+ * The version of the OpenAPI document: 11.19.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -233,6 +233,63 @@ export interface AccountInvitation {
     'email': string;
     'createdAt': string;
 }
+export interface AccountMerge {
+    'id': string;
+    'survivorAccountId': string;
+    'survivorAccount': BaseAccount;
+    'mergedAccountId': string;
+    'mergedEmail': string | null;
+    'mergedName': string | null;
+    'mergedUsername': string | null;
+    'status': AccountMergeStatus;
+    'message': string | null;
+    'counts': {
+        [key: string]: any;
+    };
+    'user': BaseUser | null;
+    'startedAt': string | null;
+    'completedAt': string | null;
+    'createdAt': string;
+    'updatedAt': string;
+}
+export interface AccountMergePreview {
+    'survivorAccount': BaseAccount;
+    'mergedAccount': BaseAccount;
+    'counts': AccountMergePreviewCounts;
+    'filledFields': Array<string>;
+    'blocking': Array<AccountMergeWarning>;
+    'warnings': Array<AccountMergeWarning>;
+}
+export interface AccountMergePreviewCounts {
+    'logins': number;
+    'registrations': number;
+    'seriesRegistrations': number;
+    'bookings': number;
+    'payments': number;
+    'invoices': number;
+    'paymentIntents': number;
+    'groups': number;
+    'threadAccounts': number;
+    'activities': number;
+    'followers': number;
+    'following': number;
+    'leads': number;
+    'accountTiers': number;
+    'supportTickets': number;
+    'surveySubmissions': number;
+    'sponsorshipLevels': number;
+    'addresses': number;
+}
+export declare enum AccountMergeStatus {
+    Pending = "pending",
+    Processing = "processing",
+    Completed = "completed",
+    Failed = "failed"
+}
+export interface AccountMergeWarning {
+    'code': string;
+    'message': string;
+}
 export interface AccountUpdateInputs {
     'accountAccess'?: AccountAccess | null;
     'featured'?: boolean;
@@ -6680,6 +6737,30 @@ export interface GetAccountLikes200Response {
 export declare enum GetAccountLikes200ResponseStatusEnum {
     Ok = "ok"
 }
+export interface GetAccountMerge200Response {
+    'status': GetAccountMerge200ResponseStatusEnum;
+    'message': string;
+    'data': AccountMerge;
+}
+export declare enum GetAccountMerge200ResponseStatusEnum {
+    Ok = "ok"
+}
+export interface GetAccountMergePreview200Response {
+    'status': GetAccountMergePreview200ResponseStatusEnum;
+    'message': string;
+    'data': AccountMergePreview;
+}
+export declare enum GetAccountMergePreview200ResponseStatusEnum {
+    Ok = "ok"
+}
+export interface GetAccountMerges200Response {
+    'status': GetAccountMerges200ResponseStatusEnum;
+    'message': string;
+    'data': Array<AccountMerge>;
+}
+export declare enum GetAccountMerges200ResponseStatusEnum {
+    Ok = "ok"
+}
 export interface GetAccountNotificationPreferences200Response {
     'status': GetAccountNotificationPreferences200ResponseStatusEnum;
     'message': string;
@@ -10480,6 +10561,9 @@ export declare enum MentionInputsMarksEnum {
     Underline = "underline",
     Strike = "strike"
 }
+export interface MergeAccountRequest {
+    'mergeAccountId': string;
+}
 export interface ModelFile {
     'id': number;
     'name': string;
@@ -16472,6 +16556,240 @@ export declare class AccountsLeadsApi extends BaseAPI {
      */
     updateAccountLead(requestParameters: AccountsLeadsApiUpdateAccountLeadRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAccountLead200Response, any, {}, any>>;
 }
+/**
+ * AccountsMergesApi - axios parameter creator
+ */
+export declare const AccountsMergesApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * 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.
+     * @summary Get an account merge
+     * @param {string} mergeId The merge identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getAccountMerge: (mergeId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * 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.
+     * @summary Preview an account merge
+     * @param {string} accountId The account identifier
+     * @param {string} mergeAccountId Filter by mergeAccountId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getAccountMergePreview: (accountId: string, mergeAccountId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Returns every merge in which the given account was the surviving or the merged account, newest first; requires read access to accounts.
+     * @summary List an account\'s merges
+     * @param {string} accountId The account identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getAccountMerges: (accountId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * 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.
+     * @summary Merge an account into another
+     * @param {string} accountId The account identifier
+     * @param {MergeAccountRequest} mergeAccountRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    mergeAccount: (accountId: string, mergeAccountRequest: MergeAccountRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * 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.
+     * @summary Retry an account merge
+     * @param {string} mergeId The merge identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    retryAccountMerge: (mergeId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * AccountsMergesApi - functional programming interface
+ */
+export declare const AccountsMergesApiFp: (configuration?: Configuration) => {
+    /**
+     * 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.
+     * @summary Get an account merge
+     * @param {string} mergeId The merge identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getAccountMerge(mergeId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAccountMerge200Response>>;
+    /**
+     * 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.
+     * @summary Preview an account merge
+     * @param {string} accountId The account identifier
+     * @param {string} mergeAccountId Filter by mergeAccountId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getAccountMergePreview(accountId: string, mergeAccountId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAccountMergePreview200Response>>;
+    /**
+     * Returns every merge in which the given account was the surviving or the merged account, newest first; requires read access to accounts.
+     * @summary List an account\'s merges
+     * @param {string} accountId The account identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getAccountMerges(accountId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAccountMerges200Response>>;
+    /**
+     * 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.
+     * @summary Merge an account into another
+     * @param {string} accountId The account identifier
+     * @param {MergeAccountRequest} mergeAccountRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    mergeAccount(accountId: string, mergeAccountRequest: MergeAccountRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAccountMerge200Response>>;
+    /**
+     * 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.
+     * @summary Retry an account merge
+     * @param {string} mergeId The merge identifier
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    retryAccountMerge(mergeId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAccountMerge200Response>>;
+};
+/**
+ * AccountsMergesApi - factory interface
+ */
+export declare const AccountsMergesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * 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.
+     * @summary Get an account merge
+     * @param {AccountsMergesApiGetAccountMergeRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getAccountMerge(requestParameters: AccountsMergesApiGetAccountMergeRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAccountMerge200Response>;
+    /**
+     * 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.
+     * @summary Preview an account merge
+     * @param {AccountsMergesApiGetAccountMergePreviewRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getAccountMergePreview(requestParameters: AccountsMergesApiGetAccountMergePreviewRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAccountMergePreview200Response>;
+    /**
+     * Returns every merge in which the given account was the surviving or the merged account, newest first; requires read access to accounts.
+     * @summary List an account\'s merges
+     * @param {AccountsMergesApiGetAccountMergesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getAccountMerges(requestParameters: AccountsMergesApiGetAccountMergesRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAccountMerges200Response>;
+    /**
+     * 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.
+     * @summary Merge an account into another
+     * @param {AccountsMergesApiMergeAccountRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    mergeAccount(requestParameters: AccountsMergesApiMergeAccountRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAccountMerge200Response>;
+    /**
+     * 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.
+     * @summary Retry an account merge
+     * @param {AccountsMergesApiRetryAccountMergeRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    retryAccountMerge(requestParameters: AccountsMergesApiRetryAccountMergeRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAccountMerge200Response>;
+};
+/**
+ * Request parameters for getAccountMerge operation in AccountsMergesApi.
+ */
+export interface AccountsMergesApiGetAccountMergeRequest {
+    /**
+     * The merge identifier
+     */
+    readonly mergeId: string;
+}
+/**
+ * Request parameters for getAccountMergePreview operation in AccountsMergesApi.
+ */
+export interface AccountsMergesApiGetAccountMergePreviewRequest {
+    /**
+     * The account identifier
+     */
+    readonly accountId: string;
+    /**
+     * Filter by mergeAccountId
+     */
+    readonly mergeAccountId: string;
+}
+/**
+ * Request parameters for getAccountMerges operation in AccountsMergesApi.
+ */
+export interface AccountsMergesApiGetAccountMergesRequest {
+    /**
+     * The account identifier
+     */
+    readonly accountId: string;
+}
+/**
+ * Request parameters for mergeAccount operation in AccountsMergesApi.
+ */
+export interface AccountsMergesApiMergeAccountRequest {
+    /**
+     * The account identifier
+     */
+    readonly accountId: string;
+    readonly mergeAccountRequest: MergeAccountRequest;
+}
+/**
+ * Request parameters for retryAccountMerge operation in AccountsMergesApi.
+ */
+export interface AccountsMergesApiRetryAccountMergeRequest {
+    /**
+     * The merge identifier
+     */
+    readonly mergeId: string;
+}
+/**
+ * AccountsMergesApi - object-oriented interface
+ */
+export declare class AccountsMergesApi extends BaseAPI {
+    /**
+     * 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.
+     * @summary Get an account merge
+     * @param {AccountsMergesApiGetAccountMergeRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getAccountMerge(requestParameters: AccountsMergesApiGetAccountMergeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAccountMerge200Response, any, {}, any>>;
+    /**
+     * 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.
+     * @summary Preview an account merge
+     * @param {AccountsMergesApiGetAccountMergePreviewRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getAccountMergePreview(requestParameters: AccountsMergesApiGetAccountMergePreviewRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAccountMergePreview200Response, any, {}, any>>;
+    /**
+     * Returns every merge in which the given account was the surviving or the merged account, newest first; requires read access to accounts.
+     * @summary List an account\'s merges
+     * @param {AccountsMergesApiGetAccountMergesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getAccountMerges(requestParameters: AccountsMergesApiGetAccountMergesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAccountMerges200Response, any, {}, any>>;
+    /**
+     * 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.
+     * @summary Merge an account into another
+     * @param {AccountsMergesApiMergeAccountRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    mergeAccount(requestParameters: AccountsMergesApiMergeAccountRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAccountMerge200Response, any, {}, any>>;
+    /**
+     * 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.
+     * @summary Retry an account merge
+     * @param {AccountsMergesApiRetryAccountMergeRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    retryAccountMerge(requestParameters: AccountsMergesApiRetryAccountMergeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAccountMerge200Response, any, {}, any>>;
+}
 /**
  * AccountsTiersApi - axios parameter creator
  */