@connectedxm/admin-sdk 11.18.0 → 11.20.0

package/docs/AccountMergeStatus.md

@@ -0,0 +1,14 @@
+# AccountMergeStatus
+
+
+## Enum
+
+* `Pending` (value: `'pending'`)
+
+* `Processing` (value: `'processing'`)
+
+* `Completed` (value: `'completed'`)
+
+* `Failed` (value: `'failed'`)
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/AccountMergeWarning.md

@@ -0,0 +1,22 @@
+# AccountMergeWarning
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **string** |  | [default to undefined]
+**message** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { AccountMergeWarning } from '@connectedxm/admin-sdk';
+
+const instance: AccountMergeWarning = {
+    code,
+    message,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/AccountUpdateInputs.md

@@ -29,6 +29,7 @@ Name | Type | Description | Notes
 **internalRefId** | **string** |  | [optional] [default to undefined]
 **internalRefIdVerified** | **boolean** |  | [optional] [default to undefined]
 **verified** | **boolean** |  | [optional] [default to undefined]
+**doNotContact** | **boolean** |  | [optional] [default to undefined]
 **locale** | **string** |  | [optional] [default to undefined]
 **taxEntityUseCode** | **string** |  | [optional] [default to undefined]
 **attributes** | **{ [key: string]: any; }** |  | [optional] [default to undefined]
@@ -64,6 +65,7 @@ const instance: AccountUpdateInputs = {
     internalRefId,
     internalRefIdVerified,
     verified,
+    doNotContact,
     locale,
     taxEntityUseCode,
     attributes,

package/docs/AccountsMergesApi.md

@@ -0,0 +1,274 @@
+# AccountsMergesApi
+
+All URIs are relative to *https://admin-api.connected.dev*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**getAccountMerge**](#getaccountmerge) | **GET** /accounts/merges/{mergeId} | Get an account merge|
+|[**getAccountMergePreview**](#getaccountmergepreview) | **GET** /accounts/{accountId}/merge/preview | Preview an account merge|
+|[**getAccountMerges**](#getaccountmerges) | **GET** /accounts/{accountId}/merges | List an account\'s merges|
+|[**mergeAccount**](#mergeaccount) | **POST** /accounts/{accountId}/merge | Merge an account into another|
+|[**retryAccountMerge**](#retryaccountmerge) | **POST** /accounts/merges/{mergeId}/retry | Retry an account merge|
+
+# **getAccountMerge**
+> GetAccountMerge200Response getAccountMerge()
+
+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.
+
+### Example
+
+```typescript
+import {
+    AccountsMergesApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new AccountsMergesApi(configuration);
+
+let mergeId: string; //The merge identifier (default to undefined)
+
+const { status, data } = await apiInstance.getAccountMerge(
+    mergeId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **mergeId** | [**string**] | The merge identifier | defaults to undefined|
+
+
+### Return type
+
+**GetAccountMerge200Response**
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful response |  -  |
+
+[[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)
+
+# **getAccountMergePreview**
+> GetAccountMergePreview200Response getAccountMergePreview()
+
+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.
+
+### Example
+
+```typescript
+import {
+    AccountsMergesApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new AccountsMergesApi(configuration);
+
+let accountId: string; //The account identifier (default to undefined)
+let mergeAccountId: string; //Filter by mergeAccountId (default to undefined)
+
+const { status, data } = await apiInstance.getAccountMergePreview(
+    accountId,
+    mergeAccountId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **accountId** | [**string**] | The account identifier | defaults to undefined|
+| **mergeAccountId** | [**string**] | Filter by mergeAccountId | defaults to undefined|
+
+
+### Return type
+
+**GetAccountMergePreview200Response**
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful response |  -  |
+
+[[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)
+
+# **getAccountMerges**
+> GetAccountMerges200Response getAccountMerges()
+
+Returns every merge in which the given account was the surviving or the merged account, newest first; requires read access to accounts.
+
+### Example
+
+```typescript
+import {
+    AccountsMergesApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new AccountsMergesApi(configuration);
+
+let accountId: string; //The account identifier (default to undefined)
+
+const { status, data } = await apiInstance.getAccountMerges(
+    accountId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **accountId** | [**string**] | The account identifier | defaults to undefined|
+
+
+### Return type
+
+**GetAccountMerges200Response**
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful response |  -  |
+
+[[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)
+
+# **mergeAccount**
+> GetAccountMerge200Response mergeAccount(mergeAccountRequest)
+
+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.
+
+### Example
+
+```typescript
+import {
+    AccountsMergesApi,
+    Configuration,
+    MergeAccountRequest
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new AccountsMergesApi(configuration);
+
+let accountId: string; //The account identifier (default to undefined)
+let mergeAccountRequest: MergeAccountRequest; //
+
+const { status, data } = await apiInstance.mergeAccount(
+    accountId,
+    mergeAccountRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **mergeAccountRequest** | **MergeAccountRequest**|  | |
+| **accountId** | [**string**] | The account identifier | defaults to undefined|
+
+
+### Return type
+
+**GetAccountMerge200Response**
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful response |  -  |
+
+[[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)
+
+# **retryAccountMerge**
+> GetAccountMerge200Response retryAccountMerge()
+
+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.
+
+### Example
+
+```typescript
+import {
+    AccountsMergesApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new AccountsMergesApi(configuration);
+
+let mergeId: string; //The merge identifier (default to undefined)
+
+const { status, data } = await apiInstance.retryAccountMerge(
+    mergeId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **mergeId** | [**string**] | The merge identifier | defaults to undefined|
+
+
+### Return type
+
+**GetAccountMerge200Response**
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful response |  -  |
+
+[[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)
+

package/docs/GetAccountMerge200Response.md

@@ -0,0 +1,24 @@
+# GetAccountMerge200Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **string** |  | [default to undefined]
+**message** | **string** |  | [default to undefined]
+**data** | [**AccountMerge**](AccountMerge.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { GetAccountMerge200Response } from '@connectedxm/admin-sdk';
+
+const instance: GetAccountMerge200Response = {
+    status,
+    message,
+    data,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/GetAccountMergePreview200Response.md

@@ -0,0 +1,24 @@
+# GetAccountMergePreview200Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **string** |  | [default to undefined]
+**message** | **string** |  | [default to undefined]
+**data** | [**AccountMergePreview**](AccountMergePreview.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { GetAccountMergePreview200Response } from '@connectedxm/admin-sdk';
+
+const instance: GetAccountMergePreview200Response = {
+    status,
+    message,
+    data,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/GetAccountMerges200Response.md

@@ -0,0 +1,24 @@
+# GetAccountMerges200Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **string** |  | [default to undefined]
+**message** | **string** |  | [default to undefined]
+**data** | [**Array<AccountMerge>**](AccountMerge.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { GetAccountMerges200Response } from '@connectedxm/admin-sdk';
+
+const instance: GetAccountMerges200Response = {
+    status,
+    message,
+    data,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/MergeAccountRequest.md

@@ -0,0 +1,20 @@
+# MergeAccountRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**mergeAccountId** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { MergeAccountRequest } from '@connectedxm/admin-sdk';
+
+const instance: MergeAccountRequest = {
+    mergeAccountId,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/NotificationPreferences.md

@@ -24,6 +24,7 @@ Name | Type | Description | Notes
 **groupInvitationPush** | **boolean** |  | [default to undefined]
 **groupRequestAcceptedEmail** | **boolean** |  | [default to undefined]
 **groupRequestAcceptedPush** | **boolean** |  | [default to undefined]
+**optedOutAt** | **string** |  | [default to undefined]
 
 ## Example
 
@@ -50,6 +51,7 @@ const instance: NotificationPreferences = {
     groupInvitationPush,
     groupRequestAcceptedEmail,
     groupRequestAcceptedPush,
+    optedOutAt,
 };
 ```
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@connectedxm/admin-sdk",
-  "version": "11.18.0",
+  "version": "11.20.0",
   "description": "OpenAPI client for @connectedxm/admin-sdk",
   "author": "OpenAPI-Generator Contributors",
   "repository": {