@connectedxm/admin-sdk 1.0.0

package/docs/GroupsMembersApi.md

@@ -0,0 +1,233 @@
+# GroupsMembersApi
+
+All URIs are relative to *https://admin-api.connected.dev*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**addGroupMember**](#addgroupmember) | **POST** /groups/{groupId}/members/{accountId} | Add Group Member|
+|[**getGroupMembers**](#getgroupmembers) | **GET** /groups/{groupId}/members | Get Group Members|
+|[**removeAllGroupMembers**](#removeallgroupmembers) | **DELETE** /groups/{groupId}/members | Remove All Group Members|
+|[**removeGroupMember**](#removegroupmember) | **DELETE** /groups/{groupId}/members/{accountId} | Remove Group Member|
+
+# **addGroupMember**
+> AddAccountGroup200Response addGroupMember()
+
+Add Group Member endpoint
+
+### Example
+
+```typescript
+import {
+    GroupsMembersApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new GroupsMembersApi(configuration);
+
+let groupId: string; //The group identifier (default to undefined)
+let accountId: string; //The account identifier (default to undefined)
+
+const { status, data } = await apiInstance.addGroupMember(
+    groupId,
+    accountId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **groupId** | [**string**] | The group identifier | defaults to undefined|
+| **accountId** | [**string**] | The account identifier | defaults to undefined|
+
+
+### Return type
+
+**AddAccountGroup200Response**
+
+### 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)
+
+# **getGroupMembers**
+> GetAccountGroups200Response getGroupMembers()
+
+Get Group Members endpoint
+
+### Example
+
+```typescript
+import {
+    GroupsMembersApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new GroupsMembersApi(configuration);
+
+let groupId: string; //The group 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.getGroupMembers(
+    groupId,
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **groupId** | [**string**] | The group 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
+
+**GetAccountGroups200Response**
+
+### 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)
+
+# **removeAllGroupMembers**
+> CreateGroup200Response removeAllGroupMembers()
+
+Remove All Group Members endpoint
+
+### Example
+
+```typescript
+import {
+    GroupsMembersApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new GroupsMembersApi(configuration);
+
+let groupId: string; //The group identifier (default to undefined)
+
+const { status, data } = await apiInstance.removeAllGroupMembers(
+    groupId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **groupId** | [**string**] | The group identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateGroup200Response**
+
+### 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)
+
+# **removeGroupMember**
+> AddAccountGroup200Response removeGroupMember()
+
+Remove Group Member endpoint
+
+### Example
+
+```typescript
+import {
+    GroupsMembersApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new GroupsMembersApi(configuration);
+
+let groupId: string; //The group identifier (default to undefined)
+let accountId: string; //The account identifier (default to undefined)
+
+const { status, data } = await apiInstance.removeGroupMember(
+    groupId,
+    accountId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **groupId** | [**string**] | The group identifier | defaults to undefined|
+| **accountId** | [**string**] | The account identifier | defaults to undefined|
+
+
+### Return type
+
+**AddAccountGroup200Response**
+
+### 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/GroupsModeratorsApi.md

@@ -0,0 +1,181 @@
+# GroupsModeratorsApi
+
+All URIs are relative to *https://admin-api.connected.dev*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**addGroupModerator**](#addgroupmoderator) | **POST** /groups/{groupId}/moderators/{accountId} | Add Group Moderator|
+|[**getGroupModerators**](#getgroupmoderators) | **GET** /groups/{groupId}/moderators | Get Group Moderators|
+|[**removeGroupModerator**](#removegroupmoderator) | **DELETE** /groups/{groupId}/moderators/{accountId} | Remove Group Moderator|
+
+# **addGroupModerator**
+> AddAccountGroup200Response addGroupModerator()
+
+Add Group Moderator endpoint
+
+### Example
+
+```typescript
+import {
+    GroupsModeratorsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new GroupsModeratorsApi(configuration);
+
+let groupId: string; //The group identifier (default to undefined)
+let accountId: string; //The account identifier (default to undefined)
+
+const { status, data } = await apiInstance.addGroupModerator(
+    groupId,
+    accountId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **groupId** | [**string**] | The group identifier | defaults to undefined|
+| **accountId** | [**string**] | The account identifier | defaults to undefined|
+
+
+### Return type
+
+**AddAccountGroup200Response**
+
+### 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)
+
+# **getGroupModerators**
+> GetAccountInvitations200Response getGroupModerators()
+
+Get Group Moderators endpoint
+
+### Example
+
+```typescript
+import {
+    GroupsModeratorsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new GroupsModeratorsApi(configuration);
+
+let groupId: string; //The group 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.getGroupModerators(
+    groupId,
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **groupId** | [**string**] | The group 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)
+
+# **removeGroupModerator**
+> CreateAccountAddress200Response removeGroupModerator()
+
+Remove Group Moderator endpoint
+
+### Example
+
+```typescript
+import {
+    GroupsModeratorsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new GroupsModeratorsApi(configuration);
+
+let groupId: string; //The group identifier (default to undefined)
+let accountId: string; //The account identifier (default to undefined)
+
+const { status, data } = await apiInstance.removeGroupModerator(
+    groupId,
+    accountId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **groupId** | [**string**] | The group identifier | defaults to undefined|
+| **accountId** | [**string**] | The account 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)
+

package/docs/GroupsRequestsApi.md

@@ -0,0 +1,294 @@
+# GroupsRequestsApi
+
+All URIs are relative to *https://admin-api.connected.dev*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**acceptGroupRequest**](#acceptgrouprequest) | **PUT** /groups/{groupId}/requests/{requestId}/accept | Accept Group Request|
+|[**deleteGroupRequest**](#deletegrouprequest) | **DELETE** /groups/{groupId}/requests/{requestId} | Delete Group Request|
+|[**getGroupRequest**](#getgrouprequest) | **GET** /groups/{groupId}/requests/{requestId} | Get Group Request|
+|[**getGroupRequests**](#getgrouprequests) | **GET** /groups/{groupId}/requests | Get Group Requests|
+|[**rejectGroupRequest**](#rejectgrouprequest) | **PUT** /groups/{groupId}/requests/{requestId}/reject | Reject Group Request|
+
+# **acceptGroupRequest**
+> GetGroupRequest200Response acceptGroupRequest()
+
+Accept Group Request endpoint
+
+### Example
+
+```typescript
+import {
+    GroupsRequestsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new GroupsRequestsApi(configuration);
+
+let groupId: string; //The group identifier (default to undefined)
+let requestId: string; //The request identifier (default to undefined)
+
+const { status, data } = await apiInstance.acceptGroupRequest(
+    groupId,
+    requestId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **groupId** | [**string**] | The group identifier | defaults to undefined|
+| **requestId** | [**string**] | The request identifier | defaults to undefined|
+
+
+### Return type
+
+**GetGroupRequest200Response**
+
+### 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)
+
+# **deleteGroupRequest**
+> CreateAccountInvitations200Response deleteGroupRequest()
+
+Delete Group Request endpoint
+
+### Example
+
+```typescript
+import {
+    GroupsRequestsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new GroupsRequestsApi(configuration);
+
+let groupId: string; //The group identifier (default to undefined)
+let requestId: string; //The request identifier (default to undefined)
+
+const { status, data } = await apiInstance.deleteGroupRequest(
+    groupId,
+    requestId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **groupId** | [**string**] | The group identifier | defaults to undefined|
+| **requestId** | [**string**] | The request 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)
+
+# **getGroupRequest**
+> GetGroupRequest200Response getGroupRequest()
+
+Get Group Request endpoint
+
+### Example
+
+```typescript
+import {
+    GroupsRequestsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new GroupsRequestsApi(configuration);
+
+let groupId: string; //The group identifier (default to undefined)
+let requestId: string; //The request identifier (default to undefined)
+
+const { status, data } = await apiInstance.getGroupRequest(
+    groupId,
+    requestId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **groupId** | [**string**] | The group identifier | defaults to undefined|
+| **requestId** | [**string**] | The request identifier | defaults to undefined|
+
+
+### Return type
+
+**GetGroupRequest200Response**
+
+### 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)
+
+# **getGroupRequests**
+> GetGroupRequests200Response getGroupRequests()
+
+Get Group Requests endpoint
+
+### Example
+
+```typescript
+import {
+    GroupsRequestsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new GroupsRequestsApi(configuration);
+
+let groupId: string; //The group identifier (default to undefined)
+let status: GroupRequestStatus; //Filter by status (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.getGroupRequests(
+    groupId,
+    status,
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **groupId** | [**string**] | The group identifier | defaults to undefined|
+| **status** | **GroupRequestStatus** | Filter by status | 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
+
+**GetGroupRequests200Response**
+
+### 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)
+
+# **rejectGroupRequest**
+> GetGroupRequest200Response rejectGroupRequest()
+
+Reject Group Request endpoint
+
+### Example
+
+```typescript
+import {
+    GroupsRequestsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new GroupsRequestsApi(configuration);
+
+let groupId: string; //The group identifier (default to undefined)
+let requestId: string; //The request identifier (default to undefined)
+
+const { status, data } = await apiInstance.rejectGroupRequest(
+    groupId,
+    requestId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **groupId** | [**string**] | The group identifier | defaults to undefined|
+| **requestId** | [**string**] | The request identifier | defaults to undefined|
+
+
+### Return type
+
+**GetGroupRequest200Response**
+
+### 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)
+