# SupportApi

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

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**createSupportTicket**](#createsupportticket) | **POST** /supportTickets | Create a support ticket|
|[**deleteSupportTicket**](#deletesupportticket) | **DELETE** /supportTickets/{supportTicketId} | Delete a support ticket|
|[**getSupportTicket**](#getsupportticket) | **GET** /supportTickets/{supportTicketId} | Get a support ticket|
|[**getSupportTicketActivity**](#getsupportticketactivity) | **GET** /supportTickets/{supportTicketId}/activityLog | List a support ticket\'s activity log|
|[**getSupportTicketViewer**](#getsupportticketviewer) | **GET** /supportTickets/{supportTicketId}/viewer | List a support ticket\'s viewer/read records|
|[**getSupportTickets**](#getsupporttickets) | **GET** /supportTickets | List support tickets|
|[**updateSupportTicket**](#updatesupportticket) | **PUT** /supportTickets/{supportTicketId} | Update a support ticket|

# **createSupportTicket**
> CreateSupportTicket200Response createSupportTicket(supportTicketCreateInputs)

Creates a new support ticket for the organization, optionally associating it with an account; requires \"create\" permission on support.

### Example

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

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

let supportTicketCreateInputs: SupportTicketCreateInputs; //

const { status, data } = await apiInstance.createSupportTicket(
    supportTicketCreateInputs
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **supportTicketCreateInputs** | **SupportTicketCreateInputs**|  | |


### Return type

**CreateSupportTicket200Response**

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

# **deleteSupportTicket**
> CreateAccountInvitations200Response deleteSupportTicket()

Permanently deletes the specified support ticket and its associated data; requires \"del\" permission on support.

### Example

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

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

let supportTicketId: string; //The supportTicket identifier (default to undefined)

const { status, data } = await apiInstance.deleteSupportTicket(
    supportTicketId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **supportTicketId** | [**string**] | The supportTicket 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)

# **getSupportTicket**
> CreateSupportTicket200Response getSupportTicket()

Returns the full details of a single support ticket, including its event, activity logs, and current viewer/read state, requiring \"read\" permission on support.

### Example

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

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

let supportTicketId: string; //The supportTicket identifier (default to undefined)

const { status, data } = await apiInstance.getSupportTicket(
    supportTicketId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **supportTicketId** | [**string**] | The supportTicket identifier | defaults to undefined|


### Return type

**CreateSupportTicket200Response**

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

# **getSupportTicketActivity**
> GetSupportTicketActivity200Response getSupportTicketActivity()

Returns the full activity log for the given support ticket (e.g. status changes and assignment events), ordered as specified, and requires \"read\" permission on support.

### Example

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

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

let supportTicketId: string; //The supportTicket identifier (default to undefined)

const { status, data } = await apiInstance.getSupportTicketActivity(
    supportTicketId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **supportTicketId** | [**string**] | The supportTicket identifier | defaults to undefined|


### Return type

**GetSupportTicketActivity200Response**

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

# **getSupportTicketViewer**
> GetSupportTicketViewer200Response getSupportTicketViewer()

Returns a paginated list of viewer records for the given support ticket, showing which org members have seen it and their last-read timestamp, optionally filtered to a single orgMembershipId, requiring \"read\" permission on support.

### Example

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

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

let supportTicketId: string; //The supportTicket identifier (default to undefined)
let orgMembershipId: string; //Filter by orgMembershipId (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.getSupportTicketViewer(
    supportTicketId,
    orgMembershipId,
    page,
    pageSize,
    orderBy,
    search
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **supportTicketId** | [**string**] | The supportTicket identifier | defaults to undefined|
| **orgMembershipId** | [**string**] | Filter by orgMembershipId | (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

**GetSupportTicketViewer200Response**

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

# **getSupportTickets**
> GetAccountSupportTickets200Response getSupportTickets()

Returns a paginated list of support tickets for the organization, filterable by type, state, and assignment (\"me\" or \"unassigned\" relative to the current admin), with optional search and ordering, requiring \"read\" permission on support.

### Example

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

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

let type: string; //Filter by type (optional) (default to undefined)
let state: string; //Filter by state (optional) (default to undefined)
let assignment: 'me' | 'unassigned'; //Filter by assignment (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.getSupportTickets(
    type,
    state,
    assignment,
    page,
    pageSize,
    orderBy,
    search
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **type** | [**string**] | Filter by type | (optional) defaults to undefined|
| **state** | [**string**] | Filter by state | (optional) defaults to undefined|
| **assignment** | [**&#39;me&#39; | &#39;unassigned&#39;**]**Array<&#39;me&#39; &#124; &#39;unassigned&#39;>** | Filter by assignment | (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

**GetAccountSupportTickets200Response**

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

# **updateSupportTicket**
> CreateSupportTicket200Response updateSupportTicket(supportTicketUpdateInputs)

Updates fields on an existing support ticket, such as its state, type, or assignment; requires \"update\" permission on support.

### Example

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

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

let supportTicketId: string; //The supportTicket identifier (default to undefined)
let supportTicketUpdateInputs: SupportTicketUpdateInputs; //

const { status, data } = await apiInstance.updateSupportTicket(
    supportTicketId,
    supportTicketUpdateInputs
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **supportTicketUpdateInputs** | **SupportTicketUpdateInputs**|  | |
| **supportTicketId** | [**string**] | The supportTicket identifier | defaults to undefined|


### Return type

**CreateSupportTicket200Response**

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