@connectedxm/admin-sdk 1.0.0

package/docs/SearchlistsValuesApi.md

@@ -0,0 +1,403 @@
+# SearchlistsValuesApi
+
+All URIs are relative to *https://admin-api.connected.dev*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**bulkUploadSearchListValues**](#bulkuploadsearchlistvalues) | **POST** /searchlists/{searchListId}/values/bulk | Bulk Upload Search List Values|
+|[**createSearchListValue**](#createsearchlistvalue) | **POST** /searchlists/{searchListId}/values | Create Search List Value|
+|[**deleteSearchListValue**](#deletesearchlistvalue) | **DELETE** /searchlists/{searchListId}/values/{valueId} | Delete Search List Value|
+|[**getSearchListConnectedQuestions**](#getsearchlistconnectedquestions) | **GET** /searchlists/{searchListId}/questions | Get Search List Connected Questions|
+|[**getSearchListValue**](#getsearchlistvalue) | **GET** /searchlists/{searchListId}/values/{valueId} | Get Search List Value|
+|[**getSearchListValues**](#getsearchlistvalues) | **GET** /searchlists/{searchListId}/values | Get Search List Values|
+|[**updateSearchListValue**](#updatesearchlistvalue) | **PUT** /searchlists/{searchListId}/values/{valueId} | Update Search List Value|
+
+# **bulkUploadSearchListValues**
+> CreateAccountAddress200Response bulkUploadSearchListValues()
+
+Bulk Upload Search List Values endpoint
+
+### Example
+
+```typescript
+import {
+    SearchlistsValuesApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SearchlistsValuesApi(configuration);
+
+let searchListId: string; //The searchList identifier (default to undefined)
+let values: Array<string>; //Filter by values (default to undefined)
+
+const { status, data } = await apiInstance.bulkUploadSearchListValues(
+    searchListId,
+    values
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **searchListId** | [**string**] | The searchList identifier | defaults to undefined|
+| **values** | **Array&lt;string&gt;** | Filter by values | defaults to undefined|
+
+
+### Return type
+
+**CreateAccountAddress200Response**
+
+### 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)
+
+# **createSearchListValue**
+> CreateAccountAddress200Response createSearchListValue(searchListValueCreateInputs)
+
+Create Search List Value endpoint
+
+### Example
+
+```typescript
+import {
+    SearchlistsValuesApi,
+    Configuration,
+    SearchListValueCreateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SearchlistsValuesApi(configuration);
+
+let searchListId: string; //The searchList identifier (default to undefined)
+let searchListValueCreateInputs: SearchListValueCreateInputs; //
+
+const { status, data } = await apiInstance.createSearchListValue(
+    searchListId,
+    searchListValueCreateInputs
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **searchListValueCreateInputs** | **SearchListValueCreateInputs**|  | |
+| **searchListId** | [**string**] | The searchList identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateAccountAddress200Response**
+
+### 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)
+
+# **deleteSearchListValue**
+> CreateAccountInvitations200Response deleteSearchListValue()
+
+Delete Search List Value endpoint
+
+### Example
+
+```typescript
+import {
+    SearchlistsValuesApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SearchlistsValuesApi(configuration);
+
+let searchListId: string; //The searchList identifier (default to undefined)
+let valueId: string; //The value identifier (default to undefined)
+
+const { status, data } = await apiInstance.deleteSearchListValue(
+    searchListId,
+    valueId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **searchListId** | [**string**] | The searchList identifier | defaults to undefined|
+| **valueId** | [**string**] | The value identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateAccountInvitations200Response**
+
+### 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)
+
+# **getSearchListConnectedQuestions**
+> CreateAccountAddress200Response getSearchListConnectedQuestions()
+
+Get Search List Connected Questions endpoint
+
+### Example
+
+```typescript
+import {
+    SearchlistsValuesApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SearchlistsValuesApi(configuration);
+
+let searchListId: string; //The searchList identifier (default to undefined)
+
+const { status, data } = await apiInstance.getSearchListConnectedQuestions(
+    searchListId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **searchListId** | [**string**] | The searchList identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateAccountAddress200Response**
+
+### 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)
+
+# **getSearchListValue**
+> GetSearchListValue200Response getSearchListValue()
+
+Get Search List Value endpoint
+
+### Example
+
+```typescript
+import {
+    SearchlistsValuesApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SearchlistsValuesApi(configuration);
+
+let searchListId: string; //The searchList identifier (default to undefined)
+let valueId: string; //The value identifier (default to undefined)
+
+const { status, data } = await apiInstance.getSearchListValue(
+    searchListId,
+    valueId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **searchListId** | [**string**] | The searchList identifier | defaults to undefined|
+| **valueId** | [**string**] | The value identifier | defaults to undefined|
+
+
+### Return type
+
+**GetSearchListValue200Response**
+
+### 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)
+
+# **getSearchListValues**
+> GetAccountInvitations200Response getSearchListValues()
+
+Get Search List Values endpoint
+
+### Example
+
+```typescript
+import {
+    SearchlistsValuesApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SearchlistsValuesApi(configuration);
+
+let searchListId: string; //The searchList identifier (default to undefined)
+let page: number; //Page number (optional) (default to 1)
+let pageSize: number; //Number of items per page (optional) (default to 25)
+let orderBy: string; //Field to order by (optional) (default to undefined)
+let search: string; //Search query (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getSearchListValues(
+    searchListId,
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **searchListId** | [**string**] | The searchList identifier | defaults to undefined|
+| **page** | [**number**] | Page number | (optional) defaults to 1|
+| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
+| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
+| **search** | [**string**] | Search query | (optional) defaults to undefined|
+
+
+### Return type
+
+**GetAccountInvitations200Response**
+
+### 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)
+
+# **updateSearchListValue**
+> CreateAccountAddress200Response updateSearchListValue(searchListValueUpdateInputs)
+
+Update Search List Value endpoint
+
+### Example
+
+```typescript
+import {
+    SearchlistsValuesApi,
+    Configuration,
+    SearchListValueUpdateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SearchlistsValuesApi(configuration);
+
+let searchListId: string; //The searchList identifier (default to undefined)
+let valueId: string; //The value identifier (default to undefined)
+let searchListValueUpdateInputs: SearchListValueUpdateInputs; //
+
+const { status, data } = await apiInstance.updateSearchListValue(
+    searchListId,
+    valueId,
+    searchListValueUpdateInputs
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **searchListValueUpdateInputs** | **SearchListValueUpdateInputs**|  | |
+| **searchListId** | [**string**] | The searchList identifier | defaults to undefined|
+| **valueId** | [**string**] | The value identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateAccountAddress200Response**
+
+### 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)
+

package/docs/SegmentInputs.md

@@ -0,0 +1,20 @@
+# SegmentInputs
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { SegmentInputs } from '@connectedxm/admin-sdk';
+
+const instance: SegmentInputs = {
+    type,
+};
+```
+
+[[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/SelfApi.md

@@ -0,0 +1,263 @@
+# SelfApi
+
+All URIs are relative to *https://admin-api.connected.dev*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**getSelf**](#getself) | **GET** /self | Get Self|
+|[**getSelfOrgMembership**](#getselforgmembership) | **GET** /self/organization-membership | Get Self Org Membership|
+|[**getSelfOrganizations**](#getselforganizations) | **GET** /self/organizations | Get Self Organizations|
+|[**selfLeaveOrganization**](#selfleaveorganization) | **DELETE** /self/organizations/{organizationId} | Self Leave Organization|
+|[**updateSelf**](#updateself) | **PUT** /self | Update Self|
+
+# **getSelf**
+> GetSelf200Response getSelf()
+
+Get Self endpoint
+
+### Example
+
+```typescript
+import {
+    SelfApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SelfApi(configuration);
+
+const { status, data } = await apiInstance.getSelf();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**GetSelf200Response**
+
+### 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)
+
+# **getSelfOrgMembership**
+> CreateAccountAddress200Response getSelfOrgMembership()
+
+Get Self Org Membership endpoint
+
+### Example
+
+```typescript
+import {
+    SelfApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SelfApi(configuration);
+
+const { status, data } = await apiInstance.getSelfOrgMembership();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**CreateAccountAddress200Response**
+
+### 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)
+
+# **getSelfOrganizations**
+> GetSelfOrganizations200Response getSelfOrganizations()
+
+Get Self Organizations endpoint
+
+### Example
+
+```typescript
+import {
+    SelfApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SelfApi(configuration);
+
+let page: number; //Page number (optional) (default to 1)
+let pageSize: number; //Number of items per page (optional) (default to 25)
+let orderBy: string; //Field to order by (optional) (default to undefined)
+let search: string; //Search query (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getSelfOrganizations(
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **page** | [**number**] | Page number | (optional) defaults to 1|
+| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
+| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
+| **search** | [**string**] | Search query | (optional) defaults to undefined|
+
+
+### Return type
+
+**GetSelfOrganizations200Response**
+
+### 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)
+
+# **selfLeaveOrganization**
+> UpdateSelf200Response selfLeaveOrganization()
+
+Self Leave Organization endpoint
+
+### Example
+
+```typescript
+import {
+    SelfApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SelfApi(configuration);
+
+let organizationId: string; //The organization identifier (default to undefined)
+
+const { status, data } = await apiInstance.selfLeaveOrganization(
+    organizationId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **organizationId** | [**string**] | The organization identifier | defaults to undefined|
+
+
+### Return type
+
+**UpdateSelf200Response**
+
+### 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)
+
+# **updateSelf**
+> UpdateSelf200Response updateSelf(userUpdateInputs)
+
+Update Self endpoint
+
+### Example
+
+```typescript
+import {
+    SelfApi,
+    Configuration,
+    UserUpdateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SelfApi(configuration);
+
+let userUpdateInputs: UserUpdateInputs; //
+
+const { status, data } = await apiInstance.updateSelf(
+    userUpdateInputs
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **userUpdateInputs** | **UserUpdateInputs**|  | |
+
+
+### Return type
+
+**UpdateSelf200Response**
+
+### 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)
+