@connectedxm/admin-sdk 6.8.6 → 6.14.0

package/docs/SeriesRegistrationCreateInputs.md

@@ -0,0 +1,20 @@
+# SeriesRegistrationCreateInputs
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**accountId** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { SeriesRegistrationCreateInputs } from '@connectedxm/admin-sdk';
+
+const instance: SeriesRegistrationCreateInputs = {
+    accountId,
+};
+```
+
+[[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/SeriesRegistrationQuestionResponse.md

@@ -0,0 +1,34 @@
+# SeriesRegistrationQuestionResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**value** | **string** |  | [default to undefined]
+**questionId** | **string** |  | [default to undefined]
+**question** | [**BaseSeriesQuestion**](BaseSeriesQuestion.md) |  | [default to undefined]
+**fileId** | **number** |  | [default to undefined]
+**file** | [**BaseFile**](BaseFile.md) |  | [default to undefined]
+**createdAt** | **string** |  | [default to undefined]
+**updatedAt** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { SeriesRegistrationQuestionResponse } from '@connectedxm/admin-sdk';
+
+const instance: SeriesRegistrationQuestionResponse = {
+    id,
+    value,
+    questionId,
+    question,
+    fileId,
+    file,
+    createdAt,
+    updatedAt,
+};
+```
+
+[[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/SeriesRegistrationResponsesUpdateInputs.md

@@ -0,0 +1,20 @@
+# SeriesRegistrationResponsesUpdateInputs
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**responses** | [**Array<SeriesRegistrationResponsesUpdateInputsResponsesInner>**](SeriesRegistrationResponsesUpdateInputsResponsesInner.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { SeriesRegistrationResponsesUpdateInputs } from '@connectedxm/admin-sdk';
+
+const instance: SeriesRegistrationResponsesUpdateInputs = {
+    responses,
+};
+```
+
+[[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/SeriesRegistrationResponsesUpdateInputsResponsesInner.md

@@ -0,0 +1,22 @@
+# SeriesRegistrationResponsesUpdateInputsResponsesInner
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**questionId** | **string** |  | [default to undefined]
+**value** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { SeriesRegistrationResponsesUpdateInputsResponsesInner } from '@connectedxm/admin-sdk';
+
+const instance: SeriesRegistrationResponsesUpdateInputsResponsesInner = {
+    questionId,
+    value,
+};
+```
+
+[[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/SeriesRegistrationUpdateInputs.md

@@ -0,0 +1,20 @@
+# SeriesRegistrationUpdateInputs
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | [**PurchaseStatus**](PurchaseStatus.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { SeriesRegistrationUpdateInputs } from '@connectedxm/admin-sdk';
+
+const instance: SeriesRegistrationUpdateInputs = {
+    status,
+};
+```
+
+[[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/SeriesRegistrationsApi.md

@@ -0,0 +1,547 @@
+# SeriesRegistrationsApi
+
+All URIs are relative to *https://admin-api.connected.dev*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**createSeriesRegistration**](#createseriesregistration) | **POST** /series/{seriesId}/registrations | Create Series Registration|
+|[**deleteSeriesRegistration**](#deleteseriesregistration) | **DELETE** /series/{seriesId}/registrations/{registrationId} | Delete Series Registration|
+|[**getSeriesRegistration**](#getseriesregistration) | **GET** /series/{seriesId}/registrations/{registrationId} | Get Series Registration|
+|[**getSeriesRegistrationPasses**](#getseriesregistrationpasses) | **GET** /series/{seriesId}/registrations/{registrationId}/passes | Get Series Registration Passes|
+|[**getSeriesRegistrationPayments**](#getseriesregistrationpayments) | **GET** /series/{seriesId}/registrations/{registrationId}/payments | Get Series Registration Payments|
+|[**getSeriesRegistrationResponses**](#getseriesregistrationresponses) | **GET** /series/{seriesId}/registrations/{registrationId}/responses | Get Series Registration Responses|
+|[**getSeriesRegistrations**](#getseriesregistrations) | **GET** /series/{seriesId}/registrations | Get Series Registrations|
+|[**updateSeriesRegistration**](#updateseriesregistration) | **PUT** /series/{seriesId}/registrations/{registrationId} | Update Series Registration|
+|[**updateSeriesRegistrationResponses**](#updateseriesregistrationresponses) | **PUT** /series/{seriesId}/registrations/{registrationId}/responses | Update Series Registration Responses|
+
+# **createSeriesRegistration**
+> CreateAccountAddress200Response createSeriesRegistration(seriesRegistrationCreateInputs)
+
+Create Series Registration endpoint
+
+### 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
+
+**CreateAccountAddress200Response**
+
+### 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()
+
+Delete Series Registration endpoint
+
+### 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**
+> CreateAccountAddress200Response getSeriesRegistration()
+
+Get Series Registration endpoint
+
+### 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
+
+**CreateAccountAddress200Response**
+
+### 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**
+> GetAccountInvitations200Response getSeriesRegistrationPasses()
+
+Get Series Registration Passes endpoint
+
+### 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
+
+**GetAccountInvitations200Response**
+
+### 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**
+> GetAccountInvitations200Response getSeriesRegistrationPayments()
+
+Get Series Registration Payments endpoint
+
+### 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
+
+**GetAccountInvitations200Response**
+
+### 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**
+> CreateAccountAddress200Response getSeriesRegistrationResponses()
+
+Get Series Registration Responses endpoint
+
+### 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
+
+**CreateAccountAddress200Response**
+
+### 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**
+> GetAccountInvitations200Response getSeriesRegistrations()
+
+Get Series Registrations endpoint
+
+### 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
+
+**GetAccountInvitations200Response**
+
+### 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**
+> CreateAccountAddress200Response updateSeriesRegistration(seriesRegistrationUpdateInputs)
+
+Update Series Registration endpoint
+
+### 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
+
+**CreateAccountAddress200Response**
+
+### 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**
+> CreateAccountAddress200Response updateSeriesRegistrationResponses(seriesRegistrationResponsesUpdateInputs)
+
+Update Series Registration Responses endpoint
+
+### 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
+
+**CreateAccountAddress200Response**
+
+### 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/SeriesTranslation.md

@@ -0,0 +1,38 @@
+# SeriesTranslation
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** |  | [default to undefined]
+**locale** | **string** |  | [default to undefined]
+**name** | **string** |  | [default to undefined]
+**description** | **string** |  | [default to undefined]
+**longDescription** | **string** |  | [default to undefined]
+**subject** | **string** |  | [default to undefined]
+**replyTo** | **string** |  | [default to undefined]
+**body** | **string** |  | [default to undefined]
+**createdAt** | **string** |  | [default to undefined]
+**updatedAt** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { SeriesTranslation } from '@connectedxm/admin-sdk';
+
+const instance: SeriesTranslation = {
+    id,
+    locale,
+    name,
+    description,
+    longDescription,
+    subject,
+    replyTo,
+    body,
+    createdAt,
+    updatedAt,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)