@connectedxm/admin-sdk 6.8.6 → 6.14.0

package/docs/SeriesQuestionsApi.md

@@ -0,0 +1,421 @@
+# SeriesQuestionsApi
+
+All URIs are relative to *https://admin-api.connected.dev*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**createSeriesQuestion**](#createseriesquestion) | **POST** /series/{seriesId}/questions | Create Series Question|
+|[**deleteSeriesQuestion**](#deleteseriesquestion) | **DELETE** /series/{seriesId}/questions/{questionId} | Delete Series Question|
+|[**getSeriesQuestion**](#getseriesquestion) | **GET** /series/{seriesId}/questions/{questionId} | Get Series Question|
+|[**getSeriesQuestionChoice**](#getseriesquestionchoice) | **GET** /series/{seriesId}/questions/{questionId}/choices/{choiceId} | Get Series Question Choice|
+|[**getSeriesQuestionChoices**](#getseriesquestionchoices) | **GET** /series/{seriesId}/questions/{questionId}/choices | Get Series Question Choices|
+|[**getSeriesQuestions**](#getseriesquestions) | **GET** /series/{seriesId}/questions | Get Series Questions|
+|[**updateSeriesQuestion**](#updateseriesquestion) | **PUT** /series/{seriesId}/questions/{questionId} | Update Series Question|
+
+# **createSeriesQuestion**
+> CreateAccountAddress200Response createSeriesQuestion(seriesQuestionCreateInputs)
+
+Create Series Question endpoint
+
+### Example
+
+```typescript
+import {
+    SeriesQuestionsApi,
+    Configuration,
+    SeriesQuestionCreateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SeriesQuestionsApi(configuration);
+
+let seriesId: string; //The series identifier (default to undefined)
+let seriesQuestionCreateInputs: SeriesQuestionCreateInputs; //
+
+const { status, data } = await apiInstance.createSeriesQuestion(
+    seriesId,
+    seriesQuestionCreateInputs
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **seriesQuestionCreateInputs** | **SeriesQuestionCreateInputs**|  | |
+| **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)
+
+# **deleteSeriesQuestion**
+> CreateAccountInvitations200Response deleteSeriesQuestion()
+
+Delete Series Question endpoint
+
+### Example
+
+```typescript
+import {
+    SeriesQuestionsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SeriesQuestionsApi(configuration);
+
+let seriesId: string; //The series identifier (default to undefined)
+let questionId: string; //The question identifier (default to undefined)
+
+const { status, data } = await apiInstance.deleteSeriesQuestion(
+    seriesId,
+    questionId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **seriesId** | [**string**] | The series identifier | defaults to undefined|
+| **questionId** | [**string**] | The question 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)
+
+# **getSeriesQuestion**
+> CreateAccountAddress200Response getSeriesQuestion()
+
+Get Series Question endpoint
+
+### Example
+
+```typescript
+import {
+    SeriesQuestionsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SeriesQuestionsApi(configuration);
+
+let seriesId: string; //The series identifier (default to undefined)
+let questionId: string; //The question identifier (default to undefined)
+
+const { status, data } = await apiInstance.getSeriesQuestion(
+    seriesId,
+    questionId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **seriesId** | [**string**] | The series identifier | defaults to undefined|
+| **questionId** | [**string**] | The question 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)
+
+# **getSeriesQuestionChoice**
+> CreateAccountAddress200Response getSeriesQuestionChoice()
+
+Get Series Question Choice endpoint
+
+### Example
+
+```typescript
+import {
+    SeriesQuestionsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SeriesQuestionsApi(configuration);
+
+let seriesId: string; //The series identifier (default to undefined)
+let questionId: string; //The question identifier (default to undefined)
+let choiceId: string; //The choice identifier (default to undefined)
+
+const { status, data } = await apiInstance.getSeriesQuestionChoice(
+    seriesId,
+    questionId,
+    choiceId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **seriesId** | [**string**] | The series identifier | defaults to undefined|
+| **questionId** | [**string**] | The question identifier | defaults to undefined|
+| **choiceId** | [**string**] | The choice 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)
+
+# **getSeriesQuestionChoices**
+> GetAccountInvitations200Response getSeriesQuestionChoices()
+
+Get Series Question Choices endpoint
+
+### Example
+
+```typescript
+import {
+    SeriesQuestionsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SeriesQuestionsApi(configuration);
+
+let seriesId: string; //The series identifier (default to undefined)
+let questionId: string; //The question 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.getSeriesQuestionChoices(
+    seriesId,
+    questionId,
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **seriesId** | [**string**] | The series identifier | defaults to undefined|
+| **questionId** | [**string**] | The question 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)
+
+# **getSeriesQuestions**
+> GetAccountInvitations200Response getSeriesQuestions()
+
+Get Series Questions endpoint
+
+### Example
+
+```typescript
+import {
+    SeriesQuestionsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SeriesQuestionsApi(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.getSeriesQuestions(
+    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
+
+**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)
+
+# **updateSeriesQuestion**
+> CreateAccountAddress200Response updateSeriesQuestion()
+
+Update Series Question endpoint
+
+### Example
+
+```typescript
+import {
+    SeriesQuestionsApi,
+    Configuration,
+    SeriesQuestionUpdateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SeriesQuestionsApi(configuration);
+
+let seriesId: string; //The series identifier (default to undefined)
+let questionId: string; //The question identifier (default to undefined)
+let question: SeriesQuestionUpdateInputs; //Filter by question (default to undefined)
+
+const { status, data } = await apiInstance.updateSeriesQuestion(
+    seriesId,
+    questionId,
+    question
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **seriesId** | [**string**] | The series identifier | defaults to undefined|
+| **questionId** | [**string**] | The question identifier | defaults to undefined|
+| **question** | **SeriesQuestionUpdateInputs** | Filter by question | 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)
+

package/docs/SeriesQuestionsChoicesApi.md

@@ -0,0 +1,244 @@
+# SeriesQuestionsChoicesApi
+
+All URIs are relative to *https://admin-api.connected.dev*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**createSeriesQuestionChoice**](#createseriesquestionchoice) | **POST** /series/{seriesId}/questions/{questionId}/choices | Create Series Question Choice|
+|[**deleteSeriesQuestionChoice**](#deleteseriesquestionchoice) | **DELETE** /series/{seriesId}/questions/{questionId}/choices/{choiceId} | Delete Series Question Choice|
+|[**reorderSeriesQuestionChoices**](#reorderseriesquestionchoices) | **PUT** /series/{seriesId}/questions/{questionId}/choices/reorder | Reorder Series Question Choices|
+|[**updateSeriesQuestionChoice**](#updateseriesquestionchoice) | **PUT** /series/{seriesId}/questions/{questionId}/choices/{choiceId} | Update Series Question Choice|
+
+# **createSeriesQuestionChoice**
+> CreateAccountAddress200Response createSeriesQuestionChoice(seriesQuestionChoiceCreateInputs)
+
+Create Series Question Choice endpoint
+
+### Example
+
+```typescript
+import {
+    SeriesQuestionsChoicesApi,
+    Configuration,
+    SeriesQuestionChoiceCreateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SeriesQuestionsChoicesApi(configuration);
+
+let seriesId: string; //The series identifier (default to undefined)
+let questionId: string; //The question identifier (default to undefined)
+let seriesQuestionChoiceCreateInputs: SeriesQuestionChoiceCreateInputs; //
+
+const { status, data } = await apiInstance.createSeriesQuestionChoice(
+    seriesId,
+    questionId,
+    seriesQuestionChoiceCreateInputs
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **seriesQuestionChoiceCreateInputs** | **SeriesQuestionChoiceCreateInputs**|  | |
+| **seriesId** | [**string**] | The series identifier | defaults to undefined|
+| **questionId** | [**string**] | The question 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)
+
+# **deleteSeriesQuestionChoice**
+> CreateAccountInvitations200Response deleteSeriesQuestionChoice()
+
+Delete Series Question Choice endpoint
+
+### Example
+
+```typescript
+import {
+    SeriesQuestionsChoicesApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SeriesQuestionsChoicesApi(configuration);
+
+let seriesId: string; //The series identifier (default to undefined)
+let questionId: string; //The question identifier (default to undefined)
+let choiceId: string; //The choice identifier (default to undefined)
+
+const { status, data } = await apiInstance.deleteSeriesQuestionChoice(
+    seriesId,
+    questionId,
+    choiceId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **seriesId** | [**string**] | The series identifier | defaults to undefined|
+| **questionId** | [**string**] | The question identifier | defaults to undefined|
+| **choiceId** | [**string**] | The choice 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)
+
+# **reorderSeriesQuestionChoices**
+> CreateAccountAddress200Response reorderSeriesQuestionChoices()
+
+Reorder Series Question Choices endpoint
+
+### Example
+
+```typescript
+import {
+    SeriesQuestionsChoicesApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SeriesQuestionsChoicesApi(configuration);
+
+let seriesId: string; //The series identifier (default to undefined)
+let questionId: string; //The question identifier (default to undefined)
+let choicesIds: Array<string>; //Filter by choicesIds (default to undefined)
+
+const { status, data } = await apiInstance.reorderSeriesQuestionChoices(
+    seriesId,
+    questionId,
+    choicesIds
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **seriesId** | [**string**] | The series identifier | defaults to undefined|
+| **questionId** | [**string**] | The question identifier | defaults to undefined|
+| **choicesIds** | **Array&lt;string&gt;** | Filter by choicesIds | 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)
+
+# **updateSeriesQuestionChoice**
+> CreateAccountAddress200Response updateSeriesQuestionChoice()
+
+Update Series Question Choice endpoint
+
+### Example
+
+```typescript
+import {
+    SeriesQuestionsChoicesApi,
+    Configuration,
+    SeriesQuestionChoiceUpdateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SeriesQuestionsChoicesApi(configuration);
+
+let seriesId: string; //The series identifier (default to undefined)
+let questionId: string; //The question identifier (default to undefined)
+let choiceId: string; //The choice identifier (default to undefined)
+let choice: SeriesQuestionChoiceUpdateInputs; //Filter by choice (default to undefined)
+
+const { status, data } = await apiInstance.updateSeriesQuestionChoice(
+    seriesId,
+    questionId,
+    choiceId,
+    choice
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **seriesId** | [**string**] | The series identifier | defaults to undefined|
+| **questionId** | [**string**] | The question identifier | defaults to undefined|
+| **choiceId** | [**string**] | The choice identifier | defaults to undefined|
+| **choice** | **SeriesQuestionChoiceUpdateInputs** | Filter by choice | 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)
+

package/docs/SeriesRegistration.md

@@ -0,0 +1,40 @@
+# SeriesRegistration
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** |  | [default to undefined]
+**organizationId** | **string** |  | [default to undefined]
+**seriesId** | **string** |  | [default to undefined]
+**series** | [**BaseSeries**](BaseSeries.md) |  | [default to undefined]
+**accountId** | **string** |  | [default to undefined]
+**account** | [**BaseAccount**](BaseAccount.md) |  | [default to undefined]
+**status** | [**PurchaseStatus**](PurchaseStatus.md) |  | [default to undefined]
+**responses** | [**Array<BaseSeriesRegistrationQuestionResponse>**](BaseSeriesRegistrationQuestionResponse.md) |  | [optional] [default to undefined]
+**createdAt** | **string** |  | [default to undefined]
+**updatedAt** | **string** |  | [default to undefined]
+**_count** | [**EventAddOnAllOfCount**](EventAddOnAllOfCount.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { SeriesRegistration } from '@connectedxm/admin-sdk';
+
+const instance: SeriesRegistration = {
+    id,
+    organizationId,
+    seriesId,
+    series,
+    accountId,
+    account,
+    status,
+    responses,
+    createdAt,
+    updatedAt,
+    _count,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)