@connectedxm/admin-sdk 1.0.0

package/docs/SurveysSectionsApi.md

@@ -0,0 +1,598 @@
+# SurveysSectionsApi
+
+All URIs are relative to *https://admin-api.connected.dev*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**addSurveySectionQuestion**](#addsurveysectionquestion) | **POST** /surveys/{surveyId}/sections/{sectionId}/questions/{questionId} | Add Survey Section Question|
+|[**createSurveySection**](#createsurveysection) | **POST** /surveys/{surveyId}/sections | Create Survey Section|
+|[**deleteSurveySection**](#deletesurveysection) | **DELETE** /surveys/{surveyId}/sections/{sectionId} | Delete Survey Section|
+|[**getSurveySection**](#getsurveysection) | **GET** /surveys/{surveyId}/sections/{sectionId} | Get Survey Section|
+|[**getSurveySectionQuestions**](#getsurveysectionquestions) | **GET** /surveys/{surveyId}/sections/{sectionId}/questions | Get Survey Section Questions|
+|[**getSurveySections**](#getsurveysections) | **GET** /surveys/{surveyId}/sections | Get Survey Sections|
+|[**removeSurveySectionQuestion**](#removesurveysectionquestion) | **DELETE** /surveys/{surveyId}/sections/{sectionId}/questions/{questionId} | Remove Survey Section Question|
+|[**reorderSurveySectionQuestions**](#reordersurveysectionquestions) | **PUT** /surveys/{surveyId}/sections/{sectionId}/questions/reorder | Reorder Survey Section Questions|
+|[**updateSurveySection**](#updatesurveysection) | **PUT** /surveys/{surveyId}/sections/{sectionId} | Update Survey Section|
+|[**updateSurveySectionQuestion**](#updatesurveysectionquestion) | **PUT** /surveys/{surveyId}/sections/{sectionId}/questions/{questionId} | Update Survey Section Question|
+
+# **addSurveySectionQuestion**
+> CreateAccountAddress200Response addSurveySectionQuestion()
+
+Add Survey Section Question endpoint
+
+### Example
+
+```typescript
+import {
+    SurveysSectionsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SurveysSectionsApi(configuration);
+
+let surveyId: string; //The survey identifier (default to undefined)
+let sectionId: string; //The section identifier (default to undefined)
+let questionId: string; //The question identifier (default to undefined)
+
+const { status, data } = await apiInstance.addSurveySectionQuestion(
+    surveyId,
+    sectionId,
+    questionId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **surveyId** | [**string**] | The survey identifier | defaults to undefined|
+| **sectionId** | [**string**] | The section 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)
+
+# **createSurveySection**
+> CreateSurveySection200Response createSurveySection(surveySectionCreateInputs)
+
+Create Survey Section endpoint
+
+### Example
+
+```typescript
+import {
+    SurveysSectionsApi,
+    Configuration,
+    SurveySectionCreateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SurveysSectionsApi(configuration);
+
+let surveyId: string; //The survey identifier (default to undefined)
+let surveySectionCreateInputs: SurveySectionCreateInputs; //
+
+const { status, data } = await apiInstance.createSurveySection(
+    surveyId,
+    surveySectionCreateInputs
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **surveySectionCreateInputs** | **SurveySectionCreateInputs**|  | |
+| **surveyId** | [**string**] | The survey identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateSurveySection200Response**
+
+### 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)
+
+# **deleteSurveySection**
+> CreateAccountInvitations200Response deleteSurveySection()
+
+Delete Survey Section endpoint
+
+### Example
+
+```typescript
+import {
+    SurveysSectionsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SurveysSectionsApi(configuration);
+
+let surveyId: string; //The survey identifier (default to undefined)
+let sectionId: string; //The section identifier (default to undefined)
+
+const { status, data } = await apiInstance.deleteSurveySection(
+    surveyId,
+    sectionId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **surveyId** | [**string**] | The survey identifier | defaults to undefined|
+| **sectionId** | [**string**] | The section 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)
+
+# **getSurveySection**
+> CreateSurveySection200Response getSurveySection()
+
+Get Survey Section endpoint
+
+### Example
+
+```typescript
+import {
+    SurveysSectionsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SurveysSectionsApi(configuration);
+
+let surveyId: string; //The survey identifier (default to undefined)
+let sectionId: string; //The section identifier (default to undefined)
+
+const { status, data } = await apiInstance.getSurveySection(
+    surveyId,
+    sectionId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **surveyId** | [**string**] | The survey identifier | defaults to undefined|
+| **sectionId** | [**string**] | The section identifier | defaults to undefined|
+
+
+### Return type
+
+**CreateSurveySection200Response**
+
+### 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)
+
+# **getSurveySectionQuestions**
+> GetAccountInvitations200Response getSurveySectionQuestions()
+
+Get Survey Section Questions endpoint
+
+### Example
+
+```typescript
+import {
+    SurveysSectionsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SurveysSectionsApi(configuration);
+
+let surveyId: string; //The survey identifier (default to undefined)
+let sectionId: string; //The section 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.getSurveySectionQuestions(
+    surveyId,
+    sectionId,
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **surveyId** | [**string**] | The survey identifier | defaults to undefined|
+| **sectionId** | [**string**] | The section 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)
+
+# **getSurveySections**
+> GetSurveySections200Response getSurveySections()
+
+Get Survey Sections endpoint
+
+### Example
+
+```typescript
+import {
+    SurveysSectionsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SurveysSectionsApi(configuration);
+
+let surveyId: string; //The survey 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.getSurveySections(
+    surveyId,
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **surveyId** | [**string**] | The survey 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
+
+**GetSurveySections200Response**
+
+### 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)
+
+# **removeSurveySectionQuestion**
+> CreateAccountAddress200Response removeSurveySectionQuestion()
+
+Remove Survey Section Question endpoint
+
+### Example
+
+```typescript
+import {
+    SurveysSectionsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SurveysSectionsApi(configuration);
+
+let surveyId: string; //The survey identifier (default to undefined)
+let sectionId: string; //The section identifier (default to undefined)
+let questionId: string; //The question identifier (default to undefined)
+
+const { status, data } = await apiInstance.removeSurveySectionQuestion(
+    surveyId,
+    sectionId,
+    questionId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **surveyId** | [**string**] | The survey identifier | defaults to undefined|
+| **sectionId** | [**string**] | The section 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)
+
+# **reorderSurveySectionQuestions**
+> CreateAccountAddress200Response reorderSurveySectionQuestions()
+
+Reorder Survey Section Questions endpoint
+
+### Example
+
+```typescript
+import {
+    SurveysSectionsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SurveysSectionsApi(configuration);
+
+let surveyId: string; //The survey identifier (default to undefined)
+let sectionId: string; //The section identifier (default to undefined)
+let questionIds: Array<string>; //Filter by questionIds (default to undefined)
+
+const { status, data } = await apiInstance.reorderSurveySectionQuestions(
+    surveyId,
+    sectionId,
+    questionIds
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **surveyId** | [**string**] | The survey identifier | defaults to undefined|
+| **sectionId** | [**string**] | The section identifier | defaults to undefined|
+| **questionIds** | **Array&lt;string&gt;** | Filter by questionIds | 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)
+
+# **updateSurveySection**
+> CreateSurveySection200Response updateSurveySection()
+
+Update Survey Section endpoint
+
+### Example
+
+```typescript
+import {
+    SurveysSectionsApi,
+    Configuration,
+    SurveySectionUpdateInputs
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SurveysSectionsApi(configuration);
+
+let surveyId: string; //The survey identifier (default to undefined)
+let sectionId: string; //The section identifier (default to undefined)
+let section: SurveySectionUpdateInputs; //Filter by section (default to undefined)
+
+const { status, data } = await apiInstance.updateSurveySection(
+    surveyId,
+    sectionId,
+    section
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **surveyId** | [**string**] | The survey identifier | defaults to undefined|
+| **sectionId** | [**string**] | The section identifier | defaults to undefined|
+| **section** | **SurveySectionUpdateInputs** | Filter by section | defaults to undefined|
+
+
+### Return type
+
+**CreateSurveySection200Response**
+
+### 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)
+
+# **updateSurveySectionQuestion**
+> CreateAccountAddress200Response updateSurveySectionQuestion()
+
+Update Survey Section Question endpoint
+
+### Example
+
+```typescript
+import {
+    SurveysSectionsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SurveysSectionsApi(configuration);
+
+let surveyId: string; //The survey identifier (default to undefined)
+let sectionId: string; //The section identifier (default to undefined)
+let questionId: string; //The question identifier (default to undefined)
+let sortOrder: number; //Filter by sortOrder (default to undefined)
+
+const { status, data } = await apiInstance.updateSurveySectionQuestion(
+    surveyId,
+    sectionId,
+    questionId,
+    sortOrder
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **surveyId** | [**string**] | The survey identifier | defaults to undefined|
+| **sectionId** | [**string**] | The section identifier | defaults to undefined|
+| **questionId** | [**string**] | The question identifier | defaults to undefined|
+| **sortOrder** | [**number**] | Filter by sortOrder | 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)
+