@connectedxm/admin-sdk 11.21.0 → 11.22.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 +1 -0
- package/README.md +2 -2
- package/api.ts +141 -1
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +75 -1
- package/dist/api.js +121 -27
- 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/api.d.ts +75 -1
- package/dist/esm/api.js +95 -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/AccountsMergesApi.md +64 -0
- package/docs/GetAllAccountMerges200Response.md +26 -0
- package/package.json +1 -1
package/dist/esm/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.22.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -6876,6 +6876,15 @@ export interface GetAdvertisements200Response {
|
|
|
6876
6876
|
export declare enum GetAdvertisements200ResponseStatusEnum {
|
|
6877
6877
|
Ok = "ok"
|
|
6878
6878
|
}
|
|
6879
|
+
export interface GetAllAccountMerges200Response {
|
|
6880
|
+
'status': GetAllAccountMerges200ResponseStatusEnum;
|
|
6881
|
+
'message': string;
|
|
6882
|
+
'data': Array<AccountMerge>;
|
|
6883
|
+
'count'?: number;
|
|
6884
|
+
}
|
|
6885
|
+
export declare enum GetAllAccountMerges200ResponseStatusEnum {
|
|
6886
|
+
Ok = "ok"
|
|
6887
|
+
}
|
|
6879
6888
|
export interface GetAnnouncementAudience200Response {
|
|
6880
6889
|
'status': GetAnnouncementAudience200ResponseStatusEnum;
|
|
6881
6890
|
'message': string;
|
|
@@ -16595,6 +16604,18 @@ export declare const AccountsMergesApiAxiosParamCreator: (configuration?: Config
|
|
|
16595
16604
|
* @throws {RequiredError}
|
|
16596
16605
|
*/
|
|
16597
16606
|
getAccountMerges: (accountId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
16607
|
+
/**
|
|
16608
|
+
* Returns a paginated list of the organization\'s account merges, newest first, optionally filtered by status and searched by the merged account\'s name or email or the surviving account\'s; requires read access to accounts.
|
|
16609
|
+
* @summary List every account merge in the organization
|
|
16610
|
+
* @param {AccountMergeStatus} [status] Filter by status
|
|
16611
|
+
* @param {number} [page] Page number
|
|
16612
|
+
* @param {number} [pageSize] Number of items per page
|
|
16613
|
+
* @param {string} [orderBy] Field to order by
|
|
16614
|
+
* @param {string} [search] Search query
|
|
16615
|
+
* @param {*} [options] Override http request option.
|
|
16616
|
+
* @throws {RequiredError}
|
|
16617
|
+
*/
|
|
16618
|
+
getAllAccountMerges: (status?: AccountMergeStatus, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
16598
16619
|
/**
|
|
16599
16620
|
* 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.
|
|
16600
16621
|
* @summary Merge an account into another
|
|
@@ -16642,6 +16663,18 @@ export declare const AccountsMergesApiFp: (configuration?: Configuration) => {
|
|
|
16642
16663
|
* @throws {RequiredError}
|
|
16643
16664
|
*/
|
|
16644
16665
|
getAccountMerges(accountId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAccountMerges200Response>>;
|
|
16666
|
+
/**
|
|
16667
|
+
* Returns a paginated list of the organization\'s account merges, newest first, optionally filtered by status and searched by the merged account\'s name or email or the surviving account\'s; requires read access to accounts.
|
|
16668
|
+
* @summary List every account merge in the organization
|
|
16669
|
+
* @param {AccountMergeStatus} [status] Filter by status
|
|
16670
|
+
* @param {number} [page] Page number
|
|
16671
|
+
* @param {number} [pageSize] Number of items per page
|
|
16672
|
+
* @param {string} [orderBy] Field to order by
|
|
16673
|
+
* @param {string} [search] Search query
|
|
16674
|
+
* @param {*} [options] Override http request option.
|
|
16675
|
+
* @throws {RequiredError}
|
|
16676
|
+
*/
|
|
16677
|
+
getAllAccountMerges(status?: AccountMergeStatus, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAllAccountMerges200Response>>;
|
|
16645
16678
|
/**
|
|
16646
16679
|
* 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.
|
|
16647
16680
|
* @summary Merge an account into another
|
|
@@ -16688,6 +16721,14 @@ export declare const AccountsMergesApiFactory: (configuration?: Configuration, b
|
|
|
16688
16721
|
* @throws {RequiredError}
|
|
16689
16722
|
*/
|
|
16690
16723
|
getAccountMerges(requestParameters: AccountsMergesApiGetAccountMergesRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAccountMerges200Response>;
|
|
16724
|
+
/**
|
|
16725
|
+
* Returns a paginated list of the organization\'s account merges, newest first, optionally filtered by status and searched by the merged account\'s name or email or the surviving account\'s; requires read access to accounts.
|
|
16726
|
+
* @summary List every account merge in the organization
|
|
16727
|
+
* @param {AccountsMergesApiGetAllAccountMergesRequest} requestParameters Request parameters.
|
|
16728
|
+
* @param {*} [options] Override http request option.
|
|
16729
|
+
* @throws {RequiredError}
|
|
16730
|
+
*/
|
|
16731
|
+
getAllAccountMerges(requestParameters?: AccountsMergesApiGetAllAccountMergesRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAllAccountMerges200Response>;
|
|
16691
16732
|
/**
|
|
16692
16733
|
* 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.
|
|
16693
16734
|
* @summary Merge an account into another
|
|
@@ -16736,6 +16777,31 @@ export interface AccountsMergesApiGetAccountMergesRequest {
|
|
|
16736
16777
|
*/
|
|
16737
16778
|
readonly accountId: string;
|
|
16738
16779
|
}
|
|
16780
|
+
/**
|
|
16781
|
+
* Request parameters for getAllAccountMerges operation in AccountsMergesApi.
|
|
16782
|
+
*/
|
|
16783
|
+
export interface AccountsMergesApiGetAllAccountMergesRequest {
|
|
16784
|
+
/**
|
|
16785
|
+
* Filter by status
|
|
16786
|
+
*/
|
|
16787
|
+
readonly status?: AccountMergeStatus;
|
|
16788
|
+
/**
|
|
16789
|
+
* Page number
|
|
16790
|
+
*/
|
|
16791
|
+
readonly page?: number;
|
|
16792
|
+
/**
|
|
16793
|
+
* Number of items per page
|
|
16794
|
+
*/
|
|
16795
|
+
readonly pageSize?: number;
|
|
16796
|
+
/**
|
|
16797
|
+
* Field to order by
|
|
16798
|
+
*/
|
|
16799
|
+
readonly orderBy?: string;
|
|
16800
|
+
/**
|
|
16801
|
+
* Search query
|
|
16802
|
+
*/
|
|
16803
|
+
readonly search?: string;
|
|
16804
|
+
}
|
|
16739
16805
|
/**
|
|
16740
16806
|
* Request parameters for mergeAccount operation in AccountsMergesApi.
|
|
16741
16807
|
*/
|
|
@@ -16783,6 +16849,14 @@ export declare class AccountsMergesApi extends BaseAPI {
|
|
|
16783
16849
|
* @throws {RequiredError}
|
|
16784
16850
|
*/
|
|
16785
16851
|
getAccountMerges(requestParameters: AccountsMergesApiGetAccountMergesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAccountMerges200Response, any, {}, any>>;
|
|
16852
|
+
/**
|
|
16853
|
+
* Returns a paginated list of the organization\'s account merges, newest first, optionally filtered by status and searched by the merged account\'s name or email or the surviving account\'s; requires read access to accounts.
|
|
16854
|
+
* @summary List every account merge in the organization
|
|
16855
|
+
* @param {AccountsMergesApiGetAllAccountMergesRequest} requestParameters Request parameters.
|
|
16856
|
+
* @param {*} [options] Override http request option.
|
|
16857
|
+
* @throws {RequiredError}
|
|
16858
|
+
*/
|
|
16859
|
+
getAllAccountMerges(requestParameters?: AccountsMergesApiGetAllAccountMergesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAllAccountMerges200Response, any, {}, any>>;
|
|
16786
16860
|
/**
|
|
16787
16861
|
* 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.
|
|
16788
16862
|
* @summary Merge an account into another
|
package/dist/esm/api.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Connected Admin API
|
|
5
5
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 11.
|
|
7
|
+
* The version of the OpenAPI document: 11.22.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -823,6 +823,10 @@ export var GetAdvertisements200ResponseStatusEnum;
|
|
|
823
823
|
(function (GetAdvertisements200ResponseStatusEnum) {
|
|
824
824
|
GetAdvertisements200ResponseStatusEnum["Ok"] = "ok";
|
|
825
825
|
})(GetAdvertisements200ResponseStatusEnum || (GetAdvertisements200ResponseStatusEnum = {}));
|
|
826
|
+
export var GetAllAccountMerges200ResponseStatusEnum;
|
|
827
|
+
(function (GetAllAccountMerges200ResponseStatusEnum) {
|
|
828
|
+
GetAllAccountMerges200ResponseStatusEnum["Ok"] = "ok";
|
|
829
|
+
})(GetAllAccountMerges200ResponseStatusEnum || (GetAllAccountMerges200ResponseStatusEnum = {}));
|
|
826
830
|
export var GetAnnouncementAudience200ResponseStatusEnum;
|
|
827
831
|
(function (GetAnnouncementAudience200ResponseStatusEnum) {
|
|
828
832
|
GetAnnouncementAudience200ResponseStatusEnum["Ok"] = "ok";
|
|
@@ -6963,6 +6967,56 @@ export const AccountsMergesApiAxiosParamCreator = function (configuration) {
|
|
|
6963
6967
|
options: localVarRequestOptions,
|
|
6964
6968
|
};
|
|
6965
6969
|
}),
|
|
6970
|
+
/**
|
|
6971
|
+
* Returns a paginated list of the organization\'s account merges, newest first, optionally filtered by status and searched by the merged account\'s name or email or the surviving account\'s; requires read access to accounts.
|
|
6972
|
+
* @summary List every account merge in the organization
|
|
6973
|
+
* @param {AccountMergeStatus} [status] Filter by status
|
|
6974
|
+
* @param {number} [page] Page number
|
|
6975
|
+
* @param {number} [pageSize] Number of items per page
|
|
6976
|
+
* @param {string} [orderBy] Field to order by
|
|
6977
|
+
* @param {string} [search] Search query
|
|
6978
|
+
* @param {*} [options] Override http request option.
|
|
6979
|
+
* @throws {RequiredError}
|
|
6980
|
+
*/
|
|
6981
|
+
getAllAccountMerges: (status_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1) => __awaiter(this, [status_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1], void 0, function* (status, page, pageSize, orderBy, search, options = {}) {
|
|
6982
|
+
const localVarPath = `/accounts/merges`;
|
|
6983
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
6984
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
6985
|
+
let baseOptions;
|
|
6986
|
+
if (configuration) {
|
|
6987
|
+
baseOptions = configuration.baseOptions;
|
|
6988
|
+
}
|
|
6989
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
6990
|
+
const localVarHeaderParameter = {};
|
|
6991
|
+
const localVarQueryParameter = {};
|
|
6992
|
+
// authentication ApiKeyAuth required
|
|
6993
|
+
yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
|
|
6994
|
+
// authentication OrganizationId required
|
|
6995
|
+
yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
|
|
6996
|
+
if (status !== undefined) {
|
|
6997
|
+
localVarQueryParameter['status'] = status;
|
|
6998
|
+
}
|
|
6999
|
+
if (page !== undefined) {
|
|
7000
|
+
localVarQueryParameter['page'] = page;
|
|
7001
|
+
}
|
|
7002
|
+
if (pageSize !== undefined) {
|
|
7003
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
7004
|
+
}
|
|
7005
|
+
if (orderBy !== undefined) {
|
|
7006
|
+
localVarQueryParameter['orderBy'] = orderBy;
|
|
7007
|
+
}
|
|
7008
|
+
if (search !== undefined) {
|
|
7009
|
+
localVarQueryParameter['search'] = search;
|
|
7010
|
+
}
|
|
7011
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
7012
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
7013
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
7014
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
7015
|
+
return {
|
|
7016
|
+
url: toPathString(localVarUrlObj),
|
|
7017
|
+
options: localVarRequestOptions,
|
|
7018
|
+
};
|
|
7019
|
+
}),
|
|
6966
7020
|
/**
|
|
6967
7021
|
* Starts a background merge of mergeAccountId into the surviving account accountId: its logins, registrations, payments, and other related data move to the survivor and the merged account is then deleted. Returns the merge record to poll; requires read, create, update and delete permission on accounts.
|
|
6968
7022
|
* @summary Merge an account into another
|
|
@@ -7093,6 +7147,26 @@ export const AccountsMergesApiFp = function (configuration) {
|
|
|
7093
7147
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
7094
7148
|
});
|
|
7095
7149
|
},
|
|
7150
|
+
/**
|
|
7151
|
+
* Returns a paginated list of the organization\'s account merges, newest first, optionally filtered by status and searched by the merged account\'s name or email or the surviving account\'s; requires read access to accounts.
|
|
7152
|
+
* @summary List every account merge in the organization
|
|
7153
|
+
* @param {AccountMergeStatus} [status] Filter by status
|
|
7154
|
+
* @param {number} [page] Page number
|
|
7155
|
+
* @param {number} [pageSize] Number of items per page
|
|
7156
|
+
* @param {string} [orderBy] Field to order by
|
|
7157
|
+
* @param {string} [search] Search query
|
|
7158
|
+
* @param {*} [options] Override http request option.
|
|
7159
|
+
* @throws {RequiredError}
|
|
7160
|
+
*/
|
|
7161
|
+
getAllAccountMerges(status, page, pageSize, orderBy, search, options) {
|
|
7162
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
7163
|
+
var _a, _b, _c;
|
|
7164
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getAllAccountMerges(status, page, pageSize, orderBy, search, options);
|
|
7165
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
7166
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AccountsMergesApi.getAllAccountMerges']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
7167
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
7168
|
+
});
|
|
7169
|
+
},
|
|
7096
7170
|
/**
|
|
7097
7171
|
* Starts a background merge of mergeAccountId into the surviving account accountId: its logins, registrations, payments, and other related data move to the survivor and the merged account is then deleted. Returns the merge record to poll; requires read, create, update and delete permission on accounts.
|
|
7098
7172
|
* @summary Merge an account into another
|
|
@@ -7164,6 +7238,16 @@ export const AccountsMergesApiFactory = function (configuration, basePath, axios
|
|
|
7164
7238
|
getAccountMerges(requestParameters, options) {
|
|
7165
7239
|
return localVarFp.getAccountMerges(requestParameters.accountId, options).then((request) => request(axios, basePath));
|
|
7166
7240
|
},
|
|
7241
|
+
/**
|
|
7242
|
+
* Returns a paginated list of the organization\'s account merges, newest first, optionally filtered by status and searched by the merged account\'s name or email or the surviving account\'s; requires read access to accounts.
|
|
7243
|
+
* @summary List every account merge in the organization
|
|
7244
|
+
* @param {AccountsMergesApiGetAllAccountMergesRequest} requestParameters Request parameters.
|
|
7245
|
+
* @param {*} [options] Override http request option.
|
|
7246
|
+
* @throws {RequiredError}
|
|
7247
|
+
*/
|
|
7248
|
+
getAllAccountMerges(requestParameters = {}, options) {
|
|
7249
|
+
return localVarFp.getAllAccountMerges(requestParameters.status, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
7250
|
+
},
|
|
7167
7251
|
/**
|
|
7168
7252
|
* Starts a background merge of mergeAccountId into the surviving account accountId: its logins, registrations, payments, and other related data move to the survivor and the merged account is then deleted. Returns the merge record to poll; requires read, create, update and delete permission on accounts.
|
|
7169
7253
|
* @summary Merge an account into another
|
|
@@ -7220,6 +7304,16 @@ export class AccountsMergesApi extends BaseAPI {
|
|
|
7220
7304
|
getAccountMerges(requestParameters, options) {
|
|
7221
7305
|
return AccountsMergesApiFp(this.configuration).getAccountMerges(requestParameters.accountId, options).then((request) => request(this.axios, this.basePath));
|
|
7222
7306
|
}
|
|
7307
|
+
/**
|
|
7308
|
+
* Returns a paginated list of the organization\'s account merges, newest first, optionally filtered by status and searched by the merged account\'s name or email or the surviving account\'s; requires read access to accounts.
|
|
7309
|
+
* @summary List every account merge in the organization
|
|
7310
|
+
* @param {AccountsMergesApiGetAllAccountMergesRequest} requestParameters Request parameters.
|
|
7311
|
+
* @param {*} [options] Override http request option.
|
|
7312
|
+
* @throws {RequiredError}
|
|
7313
|
+
*/
|
|
7314
|
+
getAllAccountMerges(requestParameters = {}, options) {
|
|
7315
|
+
return AccountsMergesApiFp(this.configuration).getAllAccountMerges(requestParameters.status, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
7316
|
+
}
|
|
7223
7317
|
/**
|
|
7224
7318
|
* Starts a background merge of mergeAccountId into the surviving account accountId: its logins, registrations, payments, and other related data move to the survivor and the merged account is then deleted. Returns the merge record to poll; requires read, create, update and delete permission on accounts.
|
|
7225
7319
|
* @summary Merge an account into another
|
package/dist/esm/base.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.22.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/base.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Connected Admin API
|
|
5
5
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 11.
|
|
7
|
+
* The version of the OpenAPI document: 11.22.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/common.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.22.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/common.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Connected Admin API
|
|
5
5
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 11.
|
|
7
|
+
* The version of the OpenAPI document: 11.22.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Connected Admin API
|
|
3
3
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 11.
|
|
5
|
+
* The version of the OpenAPI document: 11.22.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
* Connected Admin API
|
|
4
4
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
5
5
|
*
|
|
6
|
-
* The version of the OpenAPI document: 11.
|
|
6
|
+
* The version of the OpenAPI document: 11.22.0
|
|
7
7
|
*
|
|
8
8
|
*
|
|
9
9
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -7,6 +7,7 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
7
7
|
|[**getAccountMerge**](#getaccountmerge) | **GET** /accounts/merges/{mergeId} | Get an account merge|
|
|
8
8
|
|[**getAccountMergePreview**](#getaccountmergepreview) | **GET** /accounts/{accountId}/merge/preview | Preview an account merge|
|
|
9
9
|
|[**getAccountMerges**](#getaccountmerges) | **GET** /accounts/{accountId}/merges | List an account\'s merges|
|
|
10
|
+
|[**getAllAccountMerges**](#getallaccountmerges) | **GET** /accounts/merges | List every account merge in the organization|
|
|
10
11
|
|[**mergeAccount**](#mergeaccount) | **POST** /accounts/{accountId}/merge | Merge an account into another|
|
|
11
12
|
|[**retryAccountMerge**](#retryaccountmerge) | **POST** /accounts/merges/{mergeId}/retry | Retry an account merge|
|
|
12
13
|
|
|
@@ -159,6 +160,69 @@ const { status, data } = await apiInstance.getAccountMerges(
|
|
|
159
160
|
- **Accept**: application/json
|
|
160
161
|
|
|
161
162
|
|
|
163
|
+
### HTTP response details
|
|
164
|
+
| Status code | Description | Response headers |
|
|
165
|
+
|-------------|-------------|------------------|
|
|
166
|
+
|**200** | Successful response | - |
|
|
167
|
+
|
|
168
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
169
|
+
|
|
170
|
+
# **getAllAccountMerges**
|
|
171
|
+
> GetAllAccountMerges200Response getAllAccountMerges()
|
|
172
|
+
|
|
173
|
+
Returns a paginated list of the organization\'s account merges, newest first, optionally filtered by status and searched by the merged account\'s name or email or the surviving account\'s; requires read access to accounts.
|
|
174
|
+
|
|
175
|
+
### Example
|
|
176
|
+
|
|
177
|
+
```typescript
|
|
178
|
+
import {
|
|
179
|
+
AccountsMergesApi,
|
|
180
|
+
Configuration
|
|
181
|
+
} from '@connectedxm/admin-sdk';
|
|
182
|
+
|
|
183
|
+
const configuration = new Configuration();
|
|
184
|
+
const apiInstance = new AccountsMergesApi(configuration);
|
|
185
|
+
|
|
186
|
+
let status: AccountMergeStatus; //Filter by status (optional) (default to undefined)
|
|
187
|
+
let page: number; //Page number (optional) (default to 1)
|
|
188
|
+
let pageSize: number; //Number of items per page (optional) (default to 25)
|
|
189
|
+
let orderBy: string; //Field to order by (optional) (default to undefined)
|
|
190
|
+
let search: string; //Search query (optional) (default to undefined)
|
|
191
|
+
|
|
192
|
+
const { status, data } = await apiInstance.getAllAccountMerges(
|
|
193
|
+
status,
|
|
194
|
+
page,
|
|
195
|
+
pageSize,
|
|
196
|
+
orderBy,
|
|
197
|
+
search
|
|
198
|
+
);
|
|
199
|
+
```
|
|
200
|
+
|
|
201
|
+
### Parameters
|
|
202
|
+
|
|
203
|
+
|Name | Type | Description | Notes|
|
|
204
|
+
|------------- | ------------- | ------------- | -------------|
|
|
205
|
+
| **status** | **AccountMergeStatus** | Filter by status | (optional) defaults to undefined|
|
|
206
|
+
| **page** | [**number**] | Page number | (optional) defaults to 1|
|
|
207
|
+
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
|
|
208
|
+
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
|
|
209
|
+
| **search** | [**string**] | Search query | (optional) defaults to undefined|
|
|
210
|
+
|
|
211
|
+
|
|
212
|
+
### Return type
|
|
213
|
+
|
|
214
|
+
**GetAllAccountMerges200Response**
|
|
215
|
+
|
|
216
|
+
### Authorization
|
|
217
|
+
|
|
218
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
219
|
+
|
|
220
|
+
### HTTP request headers
|
|
221
|
+
|
|
222
|
+
- **Content-Type**: Not defined
|
|
223
|
+
- **Accept**: application/json
|
|
224
|
+
|
|
225
|
+
|
|
162
226
|
### HTTP response details
|
|
163
227
|
| Status code | Description | Response headers |
|
|
164
228
|
|-------------|-------------|------------------|
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# GetAllAccountMerges200Response
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**status** | **string** | | [default to undefined]
|
|
9
|
+
**message** | **string** | | [default to undefined]
|
|
10
|
+
**data** | [**Array<AccountMerge>**](AccountMerge.md) | | [default to undefined]
|
|
11
|
+
**count** | **number** | | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { GetAllAccountMerges200Response } from '@connectedxm/admin-sdk';
|
|
17
|
+
|
|
18
|
+
const instance: GetAllAccountMerges200Response = {
|
|
19
|
+
status,
|
|
20
|
+
message,
|
|
21
|
+
data,
|
|
22
|
+
count,
|
|
23
|
+
};
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|