# SeriesApi

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

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**addSeriesEvent**](#addseriesevent) | **POST** /series/{seriesId}/events/{eventId} | Add an event to a series|
|[**createSeries**](#createseries) | **POST** /series | Create an event series|
|[**deleteSeries**](#deleteseries) | **DELETE** /series/{seriesId} | Delete an event series|
|[**getSeries**](#getseries) | **GET** /series/{seriesId} | Get a series|
|[**getSeriesEvents**](#getseriesevents) | **GET** /series/{seriesId}/events | List the events in a series|
|[**getSeriesList**](#getserieslist) | **GET** /series | List event series|
|[**getSeriesPayments**](#getseriespayments) | **GET** /series/{seriesId}/payments | List a series\' payments|
|[**removeSeriesEvent**](#removeseriesevent) | **DELETE** /series/{seriesId}/events/{eventId} | Remove an event from a series|
|[**updateSeries**](#updateseries) | **PUT** /series/{seriesId} | Update an event series|

# **addSeriesEvent**
> CreateSeries200Response addSeriesEvent()

Attaches an existing event to an event series so it appears as one of the series\' occurrences, requiring \"read\" and \"update\" permission on events.

### Example

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

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

let seriesId: string; //The series identifier (default to undefined)
let eventId: string; //The event identifier (default to undefined)

const { status, data } = await apiInstance.addSeriesEvent(
    seriesId,
    eventId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **seriesId** | [**string**] | The series identifier | defaults to undefined|
| **eventId** | [**string**] | The event identifier | defaults to undefined|


### Return type

**CreateSeries200Response**

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

# **createSeries**
> CreateSeries200Response createSeries(seriesCreateInputs)

Creates a new event series for the organization from the given details, requiring \"read\" and \"create\" permission on events.

### Example

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

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

let seriesCreateInputs: SeriesCreateInputs; //

const { status, data } = await apiInstance.createSeries(
    seriesCreateInputs
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **seriesCreateInputs** | **SeriesCreateInputs**|  | |


### Return type

**CreateSeries200Response**

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

# **deleteSeries**
> CreateAccountInvitations200Response deleteSeries()

Permanently deletes an event series from the organization, requiring \"read\" and \"del\" permission on events.

### Example

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

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

let seriesId: string; //The series identifier (default to undefined)

const { status, data } = await apiInstance.deleteSeries(
    seriesId
);
```

### Parameters

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

# **getSeries**
> CreateSeries200Response getSeries()

Returns the details of a single event series by its ID, and requires read access to events.

### Example

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

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

let seriesId: string; //The series identifier (default to undefined)

const { status, data } = await apiInstance.getSeries(
    seriesId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **seriesId** | [**string**] | The series identifier | defaults to undefined|


### Return type

**CreateSeries200Response**

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

# **getSeriesEvents**
> GetAccountEvents200Response getSeriesEvents()

Returns a paginated list of events belonging to a series, supporting search and ordering, and requires read access to events.

### Example

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

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

let seriesId: string; //The series 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.getSeriesEvents(
    seriesId,
    page,
    pageSize,
    orderBy,
    search
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **seriesId** | [**string**] | The series 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

**GetAccountEvents200Response**

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

# **getSeriesList**
> GetSeriesList200Response getSeriesList()

Returns a paginated list of event series for the organization, supporting search and ordering, and requires read access to events.

### Example

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

const configuration = new Configuration();
const apiInstance = new SeriesApi(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.getSeriesList(
    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

**GetSeriesList200Response**

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

# **getSeriesPayments**
> GetAccountPayments200Response getSeriesPayments()

Returns a paginated list of payments associated with a series, supporting search and ordering, and requires read access to both events and payments.

### Example

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

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

let seriesId: string; //The series 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.getSeriesPayments(
    seriesId,
    page,
    pageSize,
    orderBy,
    search
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **seriesId** | [**string**] | The series 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

**GetAccountPayments200Response**

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

# **removeSeriesEvent**
> CreateSeries200Response removeSeriesEvent()

Detaches an event from an event series so it no longer appears as one of the series\' occurrences, requiring \"read\" and \"update\" permission on events.

### Example

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

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

let seriesId: string; //The series identifier (default to undefined)
let eventId: string; //The event identifier (default to undefined)

const { status, data } = await apiInstance.removeSeriesEvent(
    seriesId,
    eventId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **seriesId** | [**string**] | The series identifier | defaults to undefined|
| **eventId** | [**string**] | The event identifier | defaults to undefined|


### Return type

**CreateSeries200Response**

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

# **updateSeries**
> CreateSeries200Response updateSeries(seriesUpdateInputs)

Updates the details of an existing event series, excluding its id, image, and timestamps, requiring \"read\" and \"update\" permission on events.

### Example

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

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

let seriesId: string; //The series identifier (default to undefined)
let seriesUpdateInputs: SeriesUpdateInputs; //

const { status, data } = await apiInstance.updateSeries(
    seriesId,
    seriesUpdateInputs
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **seriesUpdateInputs** | **SeriesUpdateInputs**|  | |
| **seriesId** | [**string**] | The series identifier | defaults to undefined|


### Return type

**CreateSeries200Response**

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