@connectedxm/admin-sdk 1.0.0

package/docs/ActivitiesApi.md

@@ -0,0 +1,528 @@
+# ActivitiesApi
+
+All URIs are relative to *https://admin-api.connected.dev*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**archiveActivity**](#archiveactivity) | **PUT** /activities/{activityId}/archive | Archive Activity|
+|[**createActivity**](#createactivity) | **POST** /activities | Create Activity|
+|[**deleteActivity**](#deleteactivity) | **DELETE** /activities/{activityId} | Delete Activity|
+|[**getActivities**](#getactivities) | **GET** /activities | Get Activities|
+|[**getActivity**](#getactivity) | **GET** /activities/{activityId} | Get Activity|
+|[**getActivityComments**](#getactivitycomments) | **GET** /activities/{activityId}/comments | Get Activity Comments|
+|[**getActivityLikes**](#getactivitylikes) | **GET** /activities/{activityId}/likes | Get Activity Likes|
+|[**publishActivity**](#publishactivity) | **PUT** /activities/{activityId}/publish | Publish Activity|
+|[**updateActivity**](#updateactivity) | **PUT** /activities/{activityId} | Update Activity|
+
+# **archiveActivity**
+> CreateActivity200Response archiveActivity()
+
+Archive Activity endpoint
+
+### Example
+
+```typescript
+import {
+    ActivitiesApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ActivitiesApi(configuration);
+
+let activityId: string; //The activity identifier (default to undefined)
+
+const { status, data } = await apiInstance.archiveActivity(
+    activityId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **activityId** | [**string**] | The activity identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateActivity200Response**
+
+### 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)
+
+# **createActivity**
+> CreateActivity200Response createActivity()
+
+Create Activity endpoint
+
+### Example
+
+```typescript
+import {
+    ActivitiesApi,
+    Configuration,
+    ActivityCreateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ActivitiesApi(configuration);
+
+let accountId: string; //Filter by accountId (default to undefined)
+let activity: ActivityCreateInputs; //Filter by activity (default to undefined)
+let imageDataUri: string; //Filter by imageDataUri (optional) (default to undefined)
+
+const { status, data } = await apiInstance.createActivity(
+    accountId,
+    activity,
+    imageDataUri
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **accountId** | [**string**] | Filter by accountId | defaults to undefined|
+| **activity** | **ActivityCreateInputs** | Filter by activity | defaults to undefined|
+| **imageDataUri** | [**string**] | Filter by imageDataUri | (optional) defaults to undefined|
+
+
+### Return type
+
+**CreateActivity200Response**
+
+### 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)
+
+# **deleteActivity**
+> CreateAccountInvitations200Response deleteActivity()
+
+Delete Activity endpoint
+
+### Example
+
+```typescript
+import {
+    ActivitiesApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ActivitiesApi(configuration);
+
+let activityId: string; //The activity identifier (default to undefined)
+
+const { status, data } = await apiInstance.deleteActivity(
+    activityId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **activityId** | [**string**] | The activity 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)
+
+# **getActivities**
+> GetAccountActivities200Response getActivities()
+
+Get Activities endpoint
+
+### Example
+
+```typescript
+import {
+    ActivitiesApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ActivitiesApi(configuration);
+
+let moderation: ModerationStatus; //Filter by moderation (optional) (default to undefined)
+let featured: object; //Filter by featured (optional) (default to undefined)
+let status: ActivityStatus; //Filter by status (optional) (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.getActivities(
+    moderation,
+    featured,
+    status,
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **moderation** | **ModerationStatus** | Filter by moderation | (optional) defaults to undefined|
+| **featured** | **object** | Filter by featured | (optional) defaults to undefined|
+| **status** | **ActivityStatus** | Filter by status | (optional) 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
+
+**GetAccountActivities200Response**
+
+### 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)
+
+# **getActivity**
+> CreateActivity200Response getActivity()
+
+Get Activity endpoint
+
+### Example
+
+```typescript
+import {
+    ActivitiesApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ActivitiesApi(configuration);
+
+let activityId: string; //The activity identifier (default to undefined)
+
+const { status, data } = await apiInstance.getActivity(
+    activityId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **activityId** | [**string**] | The activity identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateActivity200Response**
+
+### 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)
+
+# **getActivityComments**
+> GetAccountActivities200Response getActivityComments()
+
+Get Activity Comments endpoint
+
+### Example
+
+```typescript
+import {
+    ActivitiesApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ActivitiesApi(configuration);
+
+let activityId: string; //The activity 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.getActivityComments(
+    activityId,
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **activityId** | [**string**] | The activity 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
+
+**GetAccountActivities200Response**
+
+### 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)
+
+# **getActivityLikes**
+> GetAccountLikes200Response getActivityLikes()
+
+Get Activity Likes endpoint
+
+### Example
+
+```typescript
+import {
+    ActivitiesApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ActivitiesApi(configuration);
+
+let activityId: string; //The activity 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.getActivityLikes(
+    activityId,
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **activityId** | [**string**] | The activity 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
+
+**GetAccountLikes200Response**
+
+### 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)
+
+# **publishActivity**
+> CreateActivity200Response publishActivity()
+
+Publish Activity endpoint
+
+### Example
+
+```typescript
+import {
+    ActivitiesApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ActivitiesApi(configuration);
+
+let activityId: string; //The activity identifier (default to undefined)
+
+const { status, data } = await apiInstance.publishActivity(
+    activityId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **activityId** | [**string**] | The activity identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateActivity200Response**
+
+### 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)
+
+# **updateActivity**
+> CreateActivity200Response updateActivity(activityUpdateInputs)
+
+Update Activity endpoint
+
+### Example
+
+```typescript
+import {
+    ActivitiesApi,
+    Configuration,
+    ActivityUpdateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ActivitiesApi(configuration);
+
+let activityId: string; //The activity identifier (default to undefined)
+let activityUpdateInputs: ActivityUpdateInputs; //
+
+const { status, data } = await apiInstance.updateActivity(
+    activityId,
+    activityUpdateInputs
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **activityUpdateInputs** | **ActivityUpdateInputs**|  | |
+| **activityId** | [**string**] | The activity identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateActivity200Response**
+
+### 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/ActivitiesScheduleApi.md

@@ -0,0 +1,114 @@
+# ActivitiesScheduleApi
+
+All URIs are relative to *https://admin-api.connected.dev*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**cancelActivitySchedule**](#cancelactivityschedule) | **DELETE** /activities/{activityId}/schedule | Cancel Activity Schedule|
+|[**updateActivitySchedule**](#updateactivityschedule) | **PUT** /activities/{activityId}/schedule | Update Activity Schedule|
+
+# **cancelActivitySchedule**
+> CreateActivity200Response cancelActivitySchedule()
+
+Cancel Activity Schedule endpoint
+
+### Example
+
+```typescript
+import {
+    ActivitiesScheduleApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ActivitiesScheduleApi(configuration);
+
+let activityId: string; //The activity identifier (default to undefined)
+
+const { status, data } = await apiInstance.cancelActivitySchedule(
+    activityId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **activityId** | [**string**] | The activity identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateActivity200Response**
+
+### 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)
+
+# **updateActivitySchedule**
+> CreateActivity200Response updateActivitySchedule(body)
+
+Update Activity Schedule endpoint
+
+### Example
+
+```typescript
+import {
+    ActivitiesScheduleApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ActivitiesScheduleApi(configuration);
+
+let activityId: string; //The activity identifier (default to undefined)
+let body: object; //
+
+const { status, data } = await apiInstance.updateActivitySchedule(
+    activityId,
+    body
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **body** | **object**|  | |
+| **activityId** | [**string**] | The activity identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateActivity200Response**
+
+### 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/Activity.md

@@ -0,0 +1,32 @@
+# Activity
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**image** | [**BaseImage**](BaseImage.md) |  | [default to undefined]
+**video** | [**BaseVideo**](BaseVideo.md) |  | [default to undefined]
+**meeting** | [**BaseMeeting**](BaseMeeting.md) |  | [default to undefined]
+**group** | [**BaseGroup**](BaseGroup.md) |  | [default to undefined]
+**event** | [**BaseEvent**](BaseEvent.md) |  | [default to undefined]
+**content** | [**BaseChannelContent**](BaseChannelContent.md) |  | [default to undefined]
+**schedule** | [**BaseSchedule**](BaseSchedule.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { Activity } from '@connectedxm/admin-sdk';
+
+const instance: Activity = {
+    image,
+    video,
+    meeting,
+    group,
+    event,
+    content,
+    schedule,
+};
+```
+
+[[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/ActivityCreateInputs.md

@@ -0,0 +1,40 @@
+# ActivityCreateInputs
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **string** |  | [default to undefined]
+**entities** | [**Array<ActivityEntityInputs>**](ActivityEntityInputs.md) |  | [optional] [default to undefined]
+**featured** | **boolean** |  | [optional] [default to undefined]
+**imageId** | **string** |  | [optional] [default to undefined]
+**videoId** | **string** |  | [optional] [default to undefined]
+**eventId** | **string** |  | [optional] [default to undefined]
+**groupId** | **string** |  | [optional] [default to undefined]
+**contentId** | **string** |  | [optional] [default to undefined]
+**commentedId** | **string** |  | [optional] [default to undefined]
+**meetingId** | **string** |  | [optional] [default to undefined]
+**createdAt** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ActivityCreateInputs } from '@connectedxm/admin-sdk';
+
+const instance: ActivityCreateInputs = {
+    message,
+    entities,
+    featured,
+    imageId,
+    videoId,
+    eventId,
+    groupId,
+    contentId,
+    commentedId,
+    meetingId,
+    createdAt,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)