# ActivitiesApi

All URIs are relative to *https://admin-api.connected.dev*

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**archiveActivity**](#archiveactivity) | **PUT** /activities/{activityId}/archive | Archive a published activity|
|[**createActivity**](#createactivity) | **POST** /activities | Create an activity post|
|[**deleteActivity**](#deleteactivity) | **DELETE** /activities/{activityId} | Delete an activity|
|[**getActivities**](#getactivities) | **GET** /activities | List activities|
|[**getActivity**](#getactivity) | **GET** /activities/{activityId} | Get a single activity|
|[**getActivityComments**](#getactivitycomments) | **GET** /activities/{activityId}/comments | List an activity\'s comments|
|[**getActivityLikes**](#getactivitylikes) | **GET** /activities/{activityId}/likes | List an activity\'s likes|
|[**publishActivity**](#publishactivity) | **PUT** /activities/{activityId}/publish | Publish an activity immediately|
|[**updateActivity**](#updateactivity) | **PUT** /activities/{activityId} | Update an activity\'s details|

# **archiveActivity**
> CreateActivity200Response archiveActivity()

Archives a currently published activity, removing it from active feeds while retaining its record; requires update permission on activities and fails if the activity has not already been published.

### 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(createActivityRequest)

Creates a new activity feed post authored by the given account, optionally attaching an image via a base64 data URI; requires create permission on activities.

### Example

```typescript
import {
    ActivitiesApi,
    Configuration,
    CreateActivityRequest
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new ActivitiesApi(configuration);

let createActivityRequest: CreateActivityRequest; //

const { status, data } = await apiInstance.createActivity(
    createActivityRequest
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **createActivityRequest** | **CreateActivityRequest**|  | |


### 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)

# **deleteActivity**
> CreateAccountInvitations200Response deleteActivity()

Permanently deletes the specified activity post; requires delete permission on activities.

### 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()

Returns a paginated list of activity feed posts for the organization, filterable by moderation status, featured flag, activity status, and whether to include global (cross-organization) activities, requiring read permission on activities.

### 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 global: boolean; //Filter by global (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,
    global,
    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|
| **global** | [**boolean**] | Filter by global | (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()

Retrieves the details of a single activity feed post by its activityId, requiring read permission on activities.

### 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()

Returns a paginated list of comments left on the specified activity, supporting search and ordering, and requiring read permission on activities.

### 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()

Returns a paginated list of the accounts that liked the specified activity, supporting search and ordering, and requiring read permission on activities.

### 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()

Publishes an activity right away, making it visible in feeds; requires update permission on activities and fails if the activity is already published or is currently scheduled for a future publish.

### 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)

Updates the content and settings of an existing activity post identified by activityId; requires update permission on activities.

### 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)