# SeriesRegistrationsApi

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

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**createSeriesRegistration**](#createseriesregistration) | **POST** /series/{seriesId}/registrations | Create a series registration|
|[**deleteSeriesRegistration**](#deleteseriesregistration) | **DELETE** /series/{seriesId}/registrations/{registrationId} | Delete a series registration|
|[**getSeriesRegistration**](#getseriesregistration) | **GET** /series/{seriesId}/registrations/{registrationId} | Get a series registration|
|[**getSeriesRegistrationPasses**](#getseriesregistrationpasses) | **GET** /series/{seriesId}/registrations/{registrationId}/passes | List a series registration\'s event passes|
|[**getSeriesRegistrationPayments**](#getseriesregistrationpayments) | **GET** /series/{seriesId}/registrations/{registrationId}/payments | List a series registration\'s payments|
|[**getSeriesRegistrationResponses**](#getseriesregistrationresponses) | **GET** /series/{seriesId}/registrations/{registrationId}/responses | Get a series registration\'s question responses|
|[**getSeriesRegistrations**](#getseriesregistrations) | **GET** /series/{seriesId}/registrations | List a series\' registrations|
|[**updateSeriesRegistration**](#updateseriesregistration) | **PUT** /series/{seriesId}/registrations/{registrationId} | Update a series registration\'s status|
|[**updateSeriesRegistrationResponses**](#updateseriesregistrationresponses) | **PUT** /series/{seriesId}/registrations/{registrationId}/responses | Update a series registration\'s question responses|

# **createSeriesRegistration**
> CreateSeriesRegistration200Response createSeriesRegistration(seriesRegistrationCreateInputs)

Registers an account for a series (which must have registration enabled), creating the registration with a \"ready\" status when done by an admin; requires read and create permissions on events.

### Example

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

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

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

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

### Parameters

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


### Return type

**CreateSeriesRegistration200Response**

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

# **deleteSeriesRegistration**
> CreateAccountInvitations200Response deleteSeriesRegistration()

Permanently deletes an account\'s registration for a series, identified by seriesId and registrationId; requires read and delete permissions on events.

### Example

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

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

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

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

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **seriesId** | [**string**] | The series identifier | defaults to undefined|
| **registrationId** | [**string**] | The registration 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)

# **getSeriesRegistration**
> CreateSeriesRegistration200Response getSeriesRegistration()

Returns a single registration record for the given series, identified by its registration ID, requires the \"read\" permission on the events module.

### Example

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

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

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

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

### Parameters

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


### Return type

**CreateSeriesRegistration200Response**

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

# **getSeriesRegistrationPasses**
> GetEventAddOnPasses200Response getSeriesRegistrationPasses()

Returns a paginated list of event passes issued under a given series registration, supporting search and ordering, requires the \"read\" permission on both the events and attendees modules.

### Example

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

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

let seriesId: string; //The series identifier (default to undefined)
let registrationId: string; //The registration 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.getSeriesRegistrationPasses(
    seriesId,
    registrationId,
    page,
    pageSize,
    orderBy,
    search
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **seriesId** | [**string**] | The series identifier | defaults to undefined|
| **registrationId** | [**string**] | The registration 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

**GetEventAddOnPasses200Response**

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

# **getSeriesRegistrationPayments**
> GetAccountPayments200Response getSeriesRegistrationPayments()

Returns a paginated list of payment records associated with a given series registration, supporting search and ordering, requires the \"read\" permission on both the events and payments modules.

### Example

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

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

let seriesId: string; //The series identifier (default to undefined)
let registrationId: string; //The registration 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.getSeriesRegistrationPayments(
    seriesId,
    registrationId,
    page,
    pageSize,
    orderBy,
    search
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **seriesId** | [**string**] | The series identifier | defaults to undefined|
| **registrationId** | [**string**] | The registration 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)

# **getSeriesRegistrationResponses**
> GetSeriesRegistrationResponses200Response getSeriesRegistrationResponses()

Returns the registration question responses submitted for a given registration within a series, requiring read access to events and attendees.

### Example

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

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

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

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

### Parameters

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


### Return type

**GetSeriesRegistrationResponses200Response**

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

# **getSeriesRegistrations**
> GetSeriesRegistrations200Response getSeriesRegistrations()

Returns a paginated list of registrations for a series, supporting search, ordering, and filtering by purchase status, and requires read access to events.

### Example

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

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

let seriesId: string; //The series identifier (default to undefined)
let status: PurchaseStatus; //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.getSeriesRegistrations(
    seriesId,
    status,
    page,
    pageSize,
    orderBy,
    search
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **seriesId** | [**string**] | The series identifier | defaults to undefined|
| **status** | **PurchaseStatus** | 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

**GetSeriesRegistrations200Response**

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

# **updateSeriesRegistration**
> CreateSeriesRegistration200Response updateSeriesRegistration(seriesRegistrationUpdateInputs)

Updates a registration under an event series, currently limited to changing its status, and requires \"update\" permission on events (as well as \"read\" permission on events).

### Example

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

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

let seriesId: string; //The series identifier (default to undefined)
let registrationId: string; //The registration identifier (default to undefined)
let seriesRegistrationUpdateInputs: SeriesRegistrationUpdateInputs; //

const { status, data } = await apiInstance.updateSeriesRegistration(
    seriesId,
    registrationId,
    seriesRegistrationUpdateInputs
);
```

### Parameters

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


### Return type

**CreateSeriesRegistration200Response**

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

# **updateSeriesRegistrationResponses**
> CreateAccountInvitations200Response updateSeriesRegistrationResponses(seriesRegistrationResponsesUpdateInputs)

Overwrites the registrant\'s question/answer responses for a registration on an event series, submitted on the registrant\'s behalf by an admin, and requires \"read\" permission on events plus \"read\" and \"update\" permission on attendees.

### Example

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

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

let seriesId: string; //The series identifier (default to undefined)
let registrationId: string; //The registration identifier (default to undefined)
let seriesRegistrationResponsesUpdateInputs: SeriesRegistrationResponsesUpdateInputs; //

const { status, data } = await apiInstance.updateSeriesRegistrationResponses(
    seriesId,
    registrationId,
    seriesRegistrationResponsesUpdateInputs
);
```

### Parameters

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


### Return type

**CreateAccountInvitations200Response**

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