@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/dist/AdminApi.d.ts
CHANGED
|
@@ -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;
|
package/dist/AdminApi.js
CHANGED
|
@@ -36,6 +36,7 @@ class AdminApi {
|
|
|
36
36
|
this.accountsInterests = new api_1.AccountsInterestsApi(this.config);
|
|
37
37
|
this.accountsInvitations = new api_1.AccountsInvitationsApi(this.config);
|
|
38
38
|
this.accountsLeads = new api_1.AccountsLeadsApi(this.config);
|
|
39
|
+
this.accountsMerges = new api_1.AccountsMergesApi(this.config);
|
|
39
40
|
this.accountsTiers = new api_1.AccountsTiersApi(this.config);
|
|
40
41
|
this.activities = new api_1.ActivitiesApi(this.config);
|
|
41
42
|
this.activitiesSchedule = new api_1.ActivitiesScheduleApi(this.config);
|
package/dist/api.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Connected Admin API
|
|
3
3
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 11.
|
|
5
|
+
* The version of the OpenAPI document: 11.20.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -90,6 +90,7 @@ export interface Account {
|
|
|
90
90
|
'youtube': string | null;
|
|
91
91
|
'dietaryRestrictions': string | null;
|
|
92
92
|
'taxEntityUseCode': string | null;
|
|
93
|
+
'doNotContact': boolean;
|
|
93
94
|
'updatedAt': string;
|
|
94
95
|
}
|
|
95
96
|
export declare enum AccountAccess {
|
|
@@ -233,6 +234,63 @@ export interface AccountInvitation {
|
|
|
233
234
|
'email': string;
|
|
234
235
|
'createdAt': string;
|
|
235
236
|
}
|
|
237
|
+
export interface AccountMerge {
|
|
238
|
+
'id': string;
|
|
239
|
+
'survivorAccountId': string;
|
|
240
|
+
'survivorAccount': BaseAccount;
|
|
241
|
+
'mergedAccountId': string;
|
|
242
|
+
'mergedEmail': string | null;
|
|
243
|
+
'mergedName': string | null;
|
|
244
|
+
'mergedUsername': string | null;
|
|
245
|
+
'status': AccountMergeStatus;
|
|
246
|
+
'message': string | null;
|
|
247
|
+
'counts': {
|
|
248
|
+
[key: string]: any;
|
|
249
|
+
};
|
|
250
|
+
'user': BaseUser | null;
|
|
251
|
+
'startedAt': string | null;
|
|
252
|
+
'completedAt': string | null;
|
|
253
|
+
'createdAt': string;
|
|
254
|
+
'updatedAt': string;
|
|
255
|
+
}
|
|
256
|
+
export interface AccountMergePreview {
|
|
257
|
+
'survivorAccount': BaseAccount;
|
|
258
|
+
'mergedAccount': BaseAccount;
|
|
259
|
+
'counts': AccountMergePreviewCounts;
|
|
260
|
+
'filledFields': Array<string>;
|
|
261
|
+
'blocking': Array<AccountMergeWarning>;
|
|
262
|
+
'warnings': Array<AccountMergeWarning>;
|
|
263
|
+
}
|
|
264
|
+
export interface AccountMergePreviewCounts {
|
|
265
|
+
'logins': number;
|
|
266
|
+
'registrations': number;
|
|
267
|
+
'seriesRegistrations': number;
|
|
268
|
+
'bookings': number;
|
|
269
|
+
'payments': number;
|
|
270
|
+
'invoices': number;
|
|
271
|
+
'paymentIntents': number;
|
|
272
|
+
'groups': number;
|
|
273
|
+
'threadAccounts': number;
|
|
274
|
+
'activities': number;
|
|
275
|
+
'followers': number;
|
|
276
|
+
'following': number;
|
|
277
|
+
'leads': number;
|
|
278
|
+
'accountTiers': number;
|
|
279
|
+
'supportTickets': number;
|
|
280
|
+
'surveySubmissions': number;
|
|
281
|
+
'sponsorshipLevels': number;
|
|
282
|
+
'addresses': number;
|
|
283
|
+
}
|
|
284
|
+
export declare enum AccountMergeStatus {
|
|
285
|
+
Pending = "pending",
|
|
286
|
+
Processing = "processing",
|
|
287
|
+
Completed = "completed",
|
|
288
|
+
Failed = "failed"
|
|
289
|
+
}
|
|
290
|
+
export interface AccountMergeWarning {
|
|
291
|
+
'code': string;
|
|
292
|
+
'message': string;
|
|
293
|
+
}
|
|
236
294
|
export interface AccountUpdateInputs {
|
|
237
295
|
'accountAccess'?: AccountAccess | null;
|
|
238
296
|
'featured'?: boolean;
|
|
@@ -258,6 +316,7 @@ export interface AccountUpdateInputs {
|
|
|
258
316
|
'internalRefId'?: string | null;
|
|
259
317
|
'internalRefIdVerified'?: boolean;
|
|
260
318
|
'verified'?: boolean;
|
|
319
|
+
'doNotContact'?: boolean;
|
|
261
320
|
'locale'?: string | null;
|
|
262
321
|
'taxEntityUseCode'?: string | null;
|
|
263
322
|
'attributes'?: {
|
|
@@ -6680,6 +6739,30 @@ export interface GetAccountLikes200Response {
|
|
|
6680
6739
|
export declare enum GetAccountLikes200ResponseStatusEnum {
|
|
6681
6740
|
Ok = "ok"
|
|
6682
6741
|
}
|
|
6742
|
+
export interface GetAccountMerge200Response {
|
|
6743
|
+
'status': GetAccountMerge200ResponseStatusEnum;
|
|
6744
|
+
'message': string;
|
|
6745
|
+
'data': AccountMerge;
|
|
6746
|
+
}
|
|
6747
|
+
export declare enum GetAccountMerge200ResponseStatusEnum {
|
|
6748
|
+
Ok = "ok"
|
|
6749
|
+
}
|
|
6750
|
+
export interface GetAccountMergePreview200Response {
|
|
6751
|
+
'status': GetAccountMergePreview200ResponseStatusEnum;
|
|
6752
|
+
'message': string;
|
|
6753
|
+
'data': AccountMergePreview;
|
|
6754
|
+
}
|
|
6755
|
+
export declare enum GetAccountMergePreview200ResponseStatusEnum {
|
|
6756
|
+
Ok = "ok"
|
|
6757
|
+
}
|
|
6758
|
+
export interface GetAccountMerges200Response {
|
|
6759
|
+
'status': GetAccountMerges200ResponseStatusEnum;
|
|
6760
|
+
'message': string;
|
|
6761
|
+
'data': Array<AccountMerge>;
|
|
6762
|
+
}
|
|
6763
|
+
export declare enum GetAccountMerges200ResponseStatusEnum {
|
|
6764
|
+
Ok = "ok"
|
|
6765
|
+
}
|
|
6683
6766
|
export interface GetAccountNotificationPreferences200Response {
|
|
6684
6767
|
'status': GetAccountNotificationPreferences200ResponseStatusEnum;
|
|
6685
6768
|
'message': string;
|
|
@@ -10480,6 +10563,9 @@ export declare enum MentionInputsMarksEnum {
|
|
|
10480
10563
|
Underline = "underline",
|
|
10481
10564
|
Strike = "strike"
|
|
10482
10565
|
}
|
|
10566
|
+
export interface MergeAccountRequest {
|
|
10567
|
+
'mergeAccountId': string;
|
|
10568
|
+
}
|
|
10483
10569
|
export interface ModelFile {
|
|
10484
10570
|
'id': number;
|
|
10485
10571
|
'name': string;
|
|
@@ -10555,6 +10641,7 @@ export interface NotificationPreferences {
|
|
|
10555
10641
|
'groupInvitationPush': boolean;
|
|
10556
10642
|
'groupRequestAcceptedEmail': boolean;
|
|
10557
10643
|
'groupRequestAcceptedPush': boolean;
|
|
10644
|
+
'optedOutAt': string | null;
|
|
10558
10645
|
}
|
|
10559
10646
|
export interface NotificationStats {
|
|
10560
10647
|
'total': number;
|
|
@@ -16472,6 +16559,240 @@ export declare class AccountsLeadsApi extends BaseAPI {
|
|
|
16472
16559
|
*/
|
|
16473
16560
|
updateAccountLead(requestParameters: AccountsLeadsApiUpdateAccountLeadRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAccountLead200Response, any, {}, any>>;
|
|
16474
16561
|
}
|
|
16562
|
+
/**
|
|
16563
|
+
* AccountsMergesApi - axios parameter creator
|
|
16564
|
+
*/
|
|
16565
|
+
export declare const AccountsMergesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
16566
|
+
/**
|
|
16567
|
+
* 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.
|
|
16568
|
+
* @summary Get an account merge
|
|
16569
|
+
* @param {string} mergeId The merge identifier
|
|
16570
|
+
* @param {*} [options] Override http request option.
|
|
16571
|
+
* @throws {RequiredError}
|
|
16572
|
+
*/
|
|
16573
|
+
getAccountMerge: (mergeId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
16574
|
+
/**
|
|
16575
|
+
* 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.
|
|
16576
|
+
* @summary Preview an account merge
|
|
16577
|
+
* @param {string} accountId The account identifier
|
|
16578
|
+
* @param {string} mergeAccountId Filter by mergeAccountId
|
|
16579
|
+
* @param {*} [options] Override http request option.
|
|
16580
|
+
* @throws {RequiredError}
|
|
16581
|
+
*/
|
|
16582
|
+
getAccountMergePreview: (accountId: string, mergeAccountId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
16583
|
+
/**
|
|
16584
|
+
* Returns every merge in which the given account was the surviving or the merged account, newest first; requires read access to accounts.
|
|
16585
|
+
* @summary List an account\'s merges
|
|
16586
|
+
* @param {string} accountId The account identifier
|
|
16587
|
+
* @param {*} [options] Override http request option.
|
|
16588
|
+
* @throws {RequiredError}
|
|
16589
|
+
*/
|
|
16590
|
+
getAccountMerges: (accountId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
16591
|
+
/**
|
|
16592
|
+
* 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.
|
|
16593
|
+
* @summary Merge an account into another
|
|
16594
|
+
* @param {string} accountId The account identifier
|
|
16595
|
+
* @param {MergeAccountRequest} mergeAccountRequest
|
|
16596
|
+
* @param {*} [options] Override http request option.
|
|
16597
|
+
* @throws {RequiredError}
|
|
16598
|
+
*/
|
|
16599
|
+
mergeAccount: (accountId: string, mergeAccountRequest: MergeAccountRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
16600
|
+
/**
|
|
16601
|
+
* 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.
|
|
16602
|
+
* @summary Retry an account merge
|
|
16603
|
+
* @param {string} mergeId The merge identifier
|
|
16604
|
+
* @param {*} [options] Override http request option.
|
|
16605
|
+
* @throws {RequiredError}
|
|
16606
|
+
*/
|
|
16607
|
+
retryAccountMerge: (mergeId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
16608
|
+
};
|
|
16609
|
+
/**
|
|
16610
|
+
* AccountsMergesApi - functional programming interface
|
|
16611
|
+
*/
|
|
16612
|
+
export declare const AccountsMergesApiFp: (configuration?: Configuration) => {
|
|
16613
|
+
/**
|
|
16614
|
+
* 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.
|
|
16615
|
+
* @summary Get an account merge
|
|
16616
|
+
* @param {string} mergeId The merge identifier
|
|
16617
|
+
* @param {*} [options] Override http request option.
|
|
16618
|
+
* @throws {RequiredError}
|
|
16619
|
+
*/
|
|
16620
|
+
getAccountMerge(mergeId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAccountMerge200Response>>;
|
|
16621
|
+
/**
|
|
16622
|
+
* 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.
|
|
16623
|
+
* @summary Preview an account merge
|
|
16624
|
+
* @param {string} accountId The account identifier
|
|
16625
|
+
* @param {string} mergeAccountId Filter by mergeAccountId
|
|
16626
|
+
* @param {*} [options] Override http request option.
|
|
16627
|
+
* @throws {RequiredError}
|
|
16628
|
+
*/
|
|
16629
|
+
getAccountMergePreview(accountId: string, mergeAccountId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAccountMergePreview200Response>>;
|
|
16630
|
+
/**
|
|
16631
|
+
* Returns every merge in which the given account was the surviving or the merged account, newest first; requires read access to accounts.
|
|
16632
|
+
* @summary List an account\'s merges
|
|
16633
|
+
* @param {string} accountId The account identifier
|
|
16634
|
+
* @param {*} [options] Override http request option.
|
|
16635
|
+
* @throws {RequiredError}
|
|
16636
|
+
*/
|
|
16637
|
+
getAccountMerges(accountId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAccountMerges200Response>>;
|
|
16638
|
+
/**
|
|
16639
|
+
* 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.
|
|
16640
|
+
* @summary Merge an account into another
|
|
16641
|
+
* @param {string} accountId The account identifier
|
|
16642
|
+
* @param {MergeAccountRequest} mergeAccountRequest
|
|
16643
|
+
* @param {*} [options] Override http request option.
|
|
16644
|
+
* @throws {RequiredError}
|
|
16645
|
+
*/
|
|
16646
|
+
mergeAccount(accountId: string, mergeAccountRequest: MergeAccountRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAccountMerge200Response>>;
|
|
16647
|
+
/**
|
|
16648
|
+
* 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.
|
|
16649
|
+
* @summary Retry an account merge
|
|
16650
|
+
* @param {string} mergeId The merge identifier
|
|
16651
|
+
* @param {*} [options] Override http request option.
|
|
16652
|
+
* @throws {RequiredError}
|
|
16653
|
+
*/
|
|
16654
|
+
retryAccountMerge(mergeId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAccountMerge200Response>>;
|
|
16655
|
+
};
|
|
16656
|
+
/**
|
|
16657
|
+
* AccountsMergesApi - factory interface
|
|
16658
|
+
*/
|
|
16659
|
+
export declare const AccountsMergesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
16660
|
+
/**
|
|
16661
|
+
* 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.
|
|
16662
|
+
* @summary Get an account merge
|
|
16663
|
+
* @param {AccountsMergesApiGetAccountMergeRequest} requestParameters Request parameters.
|
|
16664
|
+
* @param {*} [options] Override http request option.
|
|
16665
|
+
* @throws {RequiredError}
|
|
16666
|
+
*/
|
|
16667
|
+
getAccountMerge(requestParameters: AccountsMergesApiGetAccountMergeRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAccountMerge200Response>;
|
|
16668
|
+
/**
|
|
16669
|
+
* 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.
|
|
16670
|
+
* @summary Preview an account merge
|
|
16671
|
+
* @param {AccountsMergesApiGetAccountMergePreviewRequest} requestParameters Request parameters.
|
|
16672
|
+
* @param {*} [options] Override http request option.
|
|
16673
|
+
* @throws {RequiredError}
|
|
16674
|
+
*/
|
|
16675
|
+
getAccountMergePreview(requestParameters: AccountsMergesApiGetAccountMergePreviewRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAccountMergePreview200Response>;
|
|
16676
|
+
/**
|
|
16677
|
+
* Returns every merge in which the given account was the surviving or the merged account, newest first; requires read access to accounts.
|
|
16678
|
+
* @summary List an account\'s merges
|
|
16679
|
+
* @param {AccountsMergesApiGetAccountMergesRequest} requestParameters Request parameters.
|
|
16680
|
+
* @param {*} [options] Override http request option.
|
|
16681
|
+
* @throws {RequiredError}
|
|
16682
|
+
*/
|
|
16683
|
+
getAccountMerges(requestParameters: AccountsMergesApiGetAccountMergesRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAccountMerges200Response>;
|
|
16684
|
+
/**
|
|
16685
|
+
* 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.
|
|
16686
|
+
* @summary Merge an account into another
|
|
16687
|
+
* @param {AccountsMergesApiMergeAccountRequest} requestParameters Request parameters.
|
|
16688
|
+
* @param {*} [options] Override http request option.
|
|
16689
|
+
* @throws {RequiredError}
|
|
16690
|
+
*/
|
|
16691
|
+
mergeAccount(requestParameters: AccountsMergesApiMergeAccountRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAccountMerge200Response>;
|
|
16692
|
+
/**
|
|
16693
|
+
* 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.
|
|
16694
|
+
* @summary Retry an account merge
|
|
16695
|
+
* @param {AccountsMergesApiRetryAccountMergeRequest} requestParameters Request parameters.
|
|
16696
|
+
* @param {*} [options] Override http request option.
|
|
16697
|
+
* @throws {RequiredError}
|
|
16698
|
+
*/
|
|
16699
|
+
retryAccountMerge(requestParameters: AccountsMergesApiRetryAccountMergeRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAccountMerge200Response>;
|
|
16700
|
+
};
|
|
16701
|
+
/**
|
|
16702
|
+
* Request parameters for getAccountMerge operation in AccountsMergesApi.
|
|
16703
|
+
*/
|
|
16704
|
+
export interface AccountsMergesApiGetAccountMergeRequest {
|
|
16705
|
+
/**
|
|
16706
|
+
* The merge identifier
|
|
16707
|
+
*/
|
|
16708
|
+
readonly mergeId: string;
|
|
16709
|
+
}
|
|
16710
|
+
/**
|
|
16711
|
+
* Request parameters for getAccountMergePreview operation in AccountsMergesApi.
|
|
16712
|
+
*/
|
|
16713
|
+
export interface AccountsMergesApiGetAccountMergePreviewRequest {
|
|
16714
|
+
/**
|
|
16715
|
+
* The account identifier
|
|
16716
|
+
*/
|
|
16717
|
+
readonly accountId: string;
|
|
16718
|
+
/**
|
|
16719
|
+
* Filter by mergeAccountId
|
|
16720
|
+
*/
|
|
16721
|
+
readonly mergeAccountId: string;
|
|
16722
|
+
}
|
|
16723
|
+
/**
|
|
16724
|
+
* Request parameters for getAccountMerges operation in AccountsMergesApi.
|
|
16725
|
+
*/
|
|
16726
|
+
export interface AccountsMergesApiGetAccountMergesRequest {
|
|
16727
|
+
/**
|
|
16728
|
+
* The account identifier
|
|
16729
|
+
*/
|
|
16730
|
+
readonly accountId: string;
|
|
16731
|
+
}
|
|
16732
|
+
/**
|
|
16733
|
+
* Request parameters for mergeAccount operation in AccountsMergesApi.
|
|
16734
|
+
*/
|
|
16735
|
+
export interface AccountsMergesApiMergeAccountRequest {
|
|
16736
|
+
/**
|
|
16737
|
+
* The account identifier
|
|
16738
|
+
*/
|
|
16739
|
+
readonly accountId: string;
|
|
16740
|
+
readonly mergeAccountRequest: MergeAccountRequest;
|
|
16741
|
+
}
|
|
16742
|
+
/**
|
|
16743
|
+
* Request parameters for retryAccountMerge operation in AccountsMergesApi.
|
|
16744
|
+
*/
|
|
16745
|
+
export interface AccountsMergesApiRetryAccountMergeRequest {
|
|
16746
|
+
/**
|
|
16747
|
+
* The merge identifier
|
|
16748
|
+
*/
|
|
16749
|
+
readonly mergeId: string;
|
|
16750
|
+
}
|
|
16751
|
+
/**
|
|
16752
|
+
* AccountsMergesApi - object-oriented interface
|
|
16753
|
+
*/
|
|
16754
|
+
export declare class AccountsMergesApi extends BaseAPI {
|
|
16755
|
+
/**
|
|
16756
|
+
* 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.
|
|
16757
|
+
* @summary Get an account merge
|
|
16758
|
+
* @param {AccountsMergesApiGetAccountMergeRequest} requestParameters Request parameters.
|
|
16759
|
+
* @param {*} [options] Override http request option.
|
|
16760
|
+
* @throws {RequiredError}
|
|
16761
|
+
*/
|
|
16762
|
+
getAccountMerge(requestParameters: AccountsMergesApiGetAccountMergeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAccountMerge200Response, any, {}, any>>;
|
|
16763
|
+
/**
|
|
16764
|
+
* 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.
|
|
16765
|
+
* @summary Preview an account merge
|
|
16766
|
+
* @param {AccountsMergesApiGetAccountMergePreviewRequest} requestParameters Request parameters.
|
|
16767
|
+
* @param {*} [options] Override http request option.
|
|
16768
|
+
* @throws {RequiredError}
|
|
16769
|
+
*/
|
|
16770
|
+
getAccountMergePreview(requestParameters: AccountsMergesApiGetAccountMergePreviewRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAccountMergePreview200Response, any, {}, any>>;
|
|
16771
|
+
/**
|
|
16772
|
+
* Returns every merge in which the given account was the surviving or the merged account, newest first; requires read access to accounts.
|
|
16773
|
+
* @summary List an account\'s merges
|
|
16774
|
+
* @param {AccountsMergesApiGetAccountMergesRequest} requestParameters Request parameters.
|
|
16775
|
+
* @param {*} [options] Override http request option.
|
|
16776
|
+
* @throws {RequiredError}
|
|
16777
|
+
*/
|
|
16778
|
+
getAccountMerges(requestParameters: AccountsMergesApiGetAccountMergesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAccountMerges200Response, any, {}, any>>;
|
|
16779
|
+
/**
|
|
16780
|
+
* 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.
|
|
16781
|
+
* @summary Merge an account into another
|
|
16782
|
+
* @param {AccountsMergesApiMergeAccountRequest} requestParameters Request parameters.
|
|
16783
|
+
* @param {*} [options] Override http request option.
|
|
16784
|
+
* @throws {RequiredError}
|
|
16785
|
+
*/
|
|
16786
|
+
mergeAccount(requestParameters: AccountsMergesApiMergeAccountRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAccountMerge200Response, any, {}, any>>;
|
|
16787
|
+
/**
|
|
16788
|
+
* 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.
|
|
16789
|
+
* @summary Retry an account merge
|
|
16790
|
+
* @param {AccountsMergesApiRetryAccountMergeRequest} requestParameters Request parameters.
|
|
16791
|
+
* @param {*} [options] Override http request option.
|
|
16792
|
+
* @throws {RequiredError}
|
|
16793
|
+
*/
|
|
16794
|
+
retryAccountMerge(requestParameters: AccountsMergesApiRetryAccountMergeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAccountMerge200Response, any, {}, any>>;
|
|
16795
|
+
}
|
|
16475
16796
|
/**
|
|
16476
16797
|
* AccountsTiersApi - axios parameter creator
|
|
16477
16798
|
*/
|