@connectedxm/admin-sdk 11.21.0 → 11.22.0

package/.openapi-generator/FILES

@@ -795,6 +795,7 @@ docs/GetAccountsByInternalRefId200Response.md
 docs/GetAdvertisementClicks200Response.md
 docs/GetAdvertisementViews200Response.md
 docs/GetAdvertisements200Response.md
+docs/GetAllAccountMerges200Response.md
 docs/GetAnnouncementAudience200Response.md
 docs/GetAnnouncementTranslation200Response.md
 docs/GetAnnouncementTranslations200Response.md

package/README.md

@@ -1,4 +1,4 @@
-## @connectedxm/admin-sdk@11.21.0
+## @connectedxm/admin-sdk@11.22.0
 
 This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
 _published:_
 
 ```
-npm install @connectedxm/admin-sdk@11.21.0 --save
+npm install @connectedxm/admin-sdk@11.22.0 --save
 ```
 
 _unPublished (not recommended):_

package/api.ts

@@ -4,7 +4,7 @@
  * Connected Admin API
  * The Admin API allows you to manage your Connected community programmatically.
  *
- * The version of the OpenAPI document: 11.21.0
+ * The version of the OpenAPI document: 11.22.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -7517,6 +7517,17 @@ export enum GetAdvertisements200ResponseStatusEnum {
     Ok = 'ok'
 }
 
+export interface GetAllAccountMerges200Response {
+    'status': GetAllAccountMerges200ResponseStatusEnum;
+    'message': string;
+    'data': Array<AccountMerge>;
+    'count'?: number;
+}
+
+export enum GetAllAccountMerges200ResponseStatusEnum {
+    Ok = 'ok'
+}
+
 export interface GetAnnouncementAudience200Response {
     'status': GetAnnouncementAudience200ResponseStatusEnum;
     'message': string;
@@ -20924,6 +20935,67 @@ export const AccountsMergesApiAxiosParamCreator = function (configuration?: Conf
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * 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.
+         * @summary List every account merge in the organization
+         * @param {AccountMergeStatus} [status] Filter by status
+         * @param {number} [page] Page number
+         * @param {number} [pageSize] Number of items per page
+         * @param {string} [orderBy] Field to order by
+         * @param {string} [search] Search query
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getAllAccountMerges: async (status?: AccountMergeStatus, page?: number, pageSize?: number, orderBy?: string, search?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            const localVarPath = `/accounts/merges`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication ApiKeyAuth required
+            await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
+
+            // authentication OrganizationId required
+            await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
+
+            if (status !== undefined) {
+                localVarQueryParameter['status'] = status;
+            }
+
+            if (page !== undefined) {
+                localVarQueryParameter['page'] = page;
+            }
+
+            if (pageSize !== undefined) {
+                localVarQueryParameter['pageSize'] = pageSize;
+            }
+
+            if (orderBy !== undefined) {
+                localVarQueryParameter['orderBy'] = orderBy;
+            }
+
+            if (search !== undefined) {
+                localVarQueryParameter['search'] = search;
+            }
+
+            localVarHeaderParameter['Accept'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * 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
@@ -21058,6 +21130,23 @@ export const AccountsMergesApiFp = function(configuration?: Configuration) {
             const localVarOperationServerBasePath = operationServerMap['AccountsMergesApi.getAccountMerges']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
+        /**
+         * 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.
+         * @summary List every account merge in the organization
+         * @param {AccountMergeStatus} [status] Filter by status
+         * @param {number} [page] Page number
+         * @param {number} [pageSize] Number of items per page
+         * @param {string} [orderBy] Field to order by
+         * @param {string} [search] Search query
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getAllAccountMerges(status?: AccountMergeStatus, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAllAccountMerges200Response>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getAllAccountMerges(status, page, pageSize, orderBy, search, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['AccountsMergesApi.getAllAccountMerges']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          * 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
@@ -21124,6 +21213,16 @@ export const AccountsMergesApiFactory = function (configuration?: Configuration,
         getAccountMerges(requestParameters: AccountsMergesApiGetAccountMergesRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAccountMerges200Response> {
             return localVarFp.getAccountMerges(requestParameters.accountId, options).then((request) => request(axios, basePath));
         },
+        /**
+         * 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.
+         * @summary List every account merge in the organization
+         * @param {AccountsMergesApiGetAllAccountMergesRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getAllAccountMerges(requestParameters: AccountsMergesApiGetAllAccountMergesRequest = {}, options?: RawAxiosRequestConfig): AxiosPromise<GetAllAccountMerges200Response> {
+            return localVarFp.getAllAccountMerges(requestParameters.status, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
+        },
         /**
          * 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
@@ -21182,6 +21281,36 @@ export interface AccountsMergesApiGetAccountMergesRequest {
     readonly accountId: string
 }
 
+/**
+ * Request parameters for getAllAccountMerges operation in AccountsMergesApi.
+ */
+export interface AccountsMergesApiGetAllAccountMergesRequest {
+    /**
+     * Filter by status
+     */
+    readonly status?: AccountMergeStatus
+
+    /**
+     * Page number
+     */
+    readonly page?: number
+
+    /**
+     * Number of items per page
+     */
+    readonly pageSize?: number
+
+    /**
+     * Field to order by
+     */
+    readonly orderBy?: string
+
+    /**
+     * Search query
+     */
+    readonly search?: string
+}
+
 /**
  * Request parameters for mergeAccount operation in AccountsMergesApi.
  */
@@ -21241,6 +21370,17 @@ export class AccountsMergesApi extends BaseAPI {
         return AccountsMergesApiFp(this.configuration).getAccountMerges(requestParameters.accountId, options).then((request) => request(this.axios, this.basePath));
     }
 
+    /**
+     * 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.
+     * @summary List every account merge in the organization
+     * @param {AccountsMergesApiGetAllAccountMergesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public getAllAccountMerges(requestParameters: AccountsMergesApiGetAllAccountMergesRequest = {}, options?: RawAxiosRequestConfig) {
+        return AccountsMergesApiFp(this.configuration).getAllAccountMerges(requestParameters.status, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * 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

package/base.ts

@@ -4,7 +4,7 @@
  * Connected Admin API
  * The Admin API allows you to manage your Connected community programmatically.
  *
- * The version of the OpenAPI document: 11.21.0
+ * The version of the OpenAPI document: 11.22.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/common.ts

@@ -4,7 +4,7 @@
  * Connected Admin API
  * The Admin API allows you to manage your Connected community programmatically.
  *
- * The version of the OpenAPI document: 11.21.0
+ * The version of the OpenAPI document: 11.22.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/configuration.ts

@@ -3,7 +3,7 @@
  * Connected Admin API
  * The Admin API allows you to manage your Connected community programmatically.
  *
- * The version of the OpenAPI document: 11.21.0
+ * The version of the OpenAPI document: 11.22.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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.21.0
+ * The version of the OpenAPI document: 11.22.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -6876,6 +6876,15 @@ export interface GetAdvertisements200Response {
 export declare enum GetAdvertisements200ResponseStatusEnum {
     Ok = "ok"
 }
+export interface GetAllAccountMerges200Response {
+    'status': GetAllAccountMerges200ResponseStatusEnum;
+    'message': string;
+    'data': Array<AccountMerge>;
+    'count'?: number;
+}
+export declare enum GetAllAccountMerges200ResponseStatusEnum {
+    Ok = "ok"
+}
 export interface GetAnnouncementAudience200Response {
     'status': GetAnnouncementAudience200ResponseStatusEnum;
     'message': string;
@@ -16595,6 +16604,18 @@ export declare const AccountsMergesApiAxiosParamCreator: (configuration?: Config
      * @throws {RequiredError}
      */
     getAccountMerges: (accountId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * 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.
+     * @summary List every account merge in the organization
+     * @param {AccountMergeStatus} [status] Filter by status
+     * @param {number} [page] Page number
+     * @param {number} [pageSize] Number of items per page
+     * @param {string} [orderBy] Field to order by
+     * @param {string} [search] Search query
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getAllAccountMerges: (status?: AccountMergeStatus, page?: number, pageSize?: number, orderBy?: string, search?: 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
@@ -16642,6 +16663,18 @@ export declare const AccountsMergesApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getAccountMerges(accountId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAccountMerges200Response>>;
+    /**
+     * 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.
+     * @summary List every account merge in the organization
+     * @param {AccountMergeStatus} [status] Filter by status
+     * @param {number} [page] Page number
+     * @param {number} [pageSize] Number of items per page
+     * @param {string} [orderBy] Field to order by
+     * @param {string} [search] Search query
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getAllAccountMerges(status?: AccountMergeStatus, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetAllAccountMerges200Response>>;
     /**
      * 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
@@ -16688,6 +16721,14 @@ export declare const AccountsMergesApiFactory: (configuration?: Configuration, b
      * @throws {RequiredError}
      */
     getAccountMerges(requestParameters: AccountsMergesApiGetAccountMergesRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAccountMerges200Response>;
+    /**
+     * 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.
+     * @summary List every account merge in the organization
+     * @param {AccountsMergesApiGetAllAccountMergesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getAllAccountMerges(requestParameters?: AccountsMergesApiGetAllAccountMergesRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetAllAccountMerges200Response>;
     /**
      * 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
@@ -16736,6 +16777,31 @@ export interface AccountsMergesApiGetAccountMergesRequest {
      */
     readonly accountId: string;
 }
+/**
+ * Request parameters for getAllAccountMerges operation in AccountsMergesApi.
+ */
+export interface AccountsMergesApiGetAllAccountMergesRequest {
+    /**
+     * Filter by status
+     */
+    readonly status?: AccountMergeStatus;
+    /**
+     * Page number
+     */
+    readonly page?: number;
+    /**
+     * Number of items per page
+     */
+    readonly pageSize?: number;
+    /**
+     * Field to order by
+     */
+    readonly orderBy?: string;
+    /**
+     * Search query
+     */
+    readonly search?: string;
+}
 /**
  * Request parameters for mergeAccount operation in AccountsMergesApi.
  */
@@ -16783,6 +16849,14 @@ export declare class AccountsMergesApi extends BaseAPI {
      * @throws {RequiredError}
      */
     getAccountMerges(requestParameters: AccountsMergesApiGetAccountMergesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAccountMerges200Response, any, {}, any>>;
+    /**
+     * 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.
+     * @summary List every account merge in the organization
+     * @param {AccountsMergesApiGetAllAccountMergesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getAllAccountMerges(requestParameters?: AccountsMergesApiGetAllAccountMergesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetAllAccountMerges200Response, 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