@connectedxm/admin-sdk 10.0.0 → 10.2.1

package/docs/BaseSurveyQuestion.md

@@ -16,6 +16,8 @@ Name | Type | Description | Notes
 **_default** | **string** |  | [default to undefined]
 **searchListId** | **string** |  | [default to undefined]
 **searchList** | [**BaseSearchList**](BaseSearchList.md) |  | [default to undefined]
+**matrixQuestionId** | **string** |  | [default to undefined]
+**matrixSortOrder** | **number** |  | [default to undefined]
 **mutable** | **boolean** |  | [default to undefined]
 **min** | **string** |  | [default to undefined]
 **max** | **string** |  | [default to undefined]
@@ -44,6 +46,8 @@ const instance: BaseSurveyQuestion = {
     _default,
     searchListId,
     searchList,
+    matrixQuestionId,
+    matrixSortOrder,
     mutable,
     min,
     max,

package/docs/ImageDirectUploadInputs.md

@@ -5,7 +5,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**type** | [**ImageType**](ImageType.md) |  | [default to undefined]
+**type** | **string** |  | [default to undefined]
 **name** | **string** |  | [optional] [default to undefined]
 **description** | **string** |  | [optional] [default to undefined]
 

package/docs/ReorderSurveyQuestionMatrixRows200Response.md

@@ -0,0 +1,24 @@
+# ReorderSurveyQuestionMatrixRows200Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **string** |  | [default to undefined]
+**message** | **string** |  | [default to undefined]
+**data** | [**Array<SurveyQuestion>**](SurveyQuestion.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { ReorderSurveyQuestionMatrixRows200Response } from '@connectedxm/admin-sdk';
+
+const instance: ReorderSurveyQuestionMatrixRows200Response = {
+    status,
+    message,
+    data,
+};
+```
+
+[[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/ReorderSurveyQuestionMatrixRowsRequest.md

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

@@ -16,6 +16,8 @@ Name | Type | Description | Notes
 **_default** | **string** |  | [default to undefined]
 **searchListId** | **string** |  | [default to undefined]
 **searchList** | [**BaseSearchList**](BaseSearchList.md) |  | [default to undefined]
+**matrixQuestionId** | **string** |  | [default to undefined]
+**matrixSortOrder** | **number** |  | [default to undefined]
 **mutable** | **boolean** |  | [default to undefined]
 **min** | **string** |  | [default to undefined]
 **max** | **string** |  | [default to undefined]
@@ -28,6 +30,7 @@ Name | Type | Description | Notes
 **choices** | [**Array<BaseSurveyQuestionChoice>**](BaseSurveyQuestionChoice.md) |  | [default to undefined]
 **sections** | [**Array<BaseSurveySectionQuestion>**](BaseSurveySectionQuestion.md) |  | [default to undefined]
 **subQuestionOf** | [**Array<SurveyQuestionChoiceSubQuestion>**](SurveyQuestionChoiceSubQuestion.md) |  | [default to undefined]
+**matrixRows** | [**Array<BaseSurveyQuestion>**](BaseSurveyQuestion.md) |  | [optional] [default to undefined]
 **dashboardVisibility** | **boolean** |  | [default to undefined]
 **createdAt** | **string** |  | [default to undefined]
 **updatedAt** | **string** |  | [default to undefined]
@@ -50,6 +53,8 @@ const instance: SurveyQuestion = {
     _default,
     searchListId,
     searchList,
+    matrixQuestionId,
+    matrixSortOrder,
     mutable,
     min,
     max,
@@ -62,6 +67,7 @@ const instance: SurveyQuestion = {
     choices,
     sections,
     subQuestionOf,
+    matrixRows,
     dashboardVisibility,
     createdAt,
     updatedAt,

package/docs/SurveyQuestionCreateInputs.md

@@ -10,6 +10,7 @@ Name | Type | Description | Notes
 **sectionId** | **string** |  | [optional] [default to undefined]
 **questionId** | **string** |  | [optional] [default to undefined]
 **choiceId** | **string** |  | [optional] [default to undefined]
+**matrixQuestionId** | **string** |  | [optional] [default to undefined]
 **required** | **boolean** |  | [optional] [default to undefined]
 **label** | **string** |  | [optional] [default to undefined]
 **placeholder** | **string** |  | [optional] [default to undefined]
@@ -26,6 +27,8 @@ Name | Type | Description | Notes
 **sortOrder** | **number** |  | [optional] [default to undefined]
 **featured** | **boolean** |  | [optional] [default to undefined]
 **choices** | **Array<string>** |  | [optional] [default to undefined]
+**matrixRows** | **Array<string>** |  | [optional] [default to undefined]
+**matrixRowsType** | **string** |  | [optional] [default to undefined]
 **searchListId** | **string** |  | [optional] [default to undefined]
 **masked** | **boolean** |  | [optional] [default to undefined]
 
@@ -40,6 +43,7 @@ const instance: SurveyQuestionCreateInputs = {
     sectionId,
     questionId,
     choiceId,
+    matrixQuestionId,
     required,
     label,
     placeholder,
@@ -56,6 +60,8 @@ const instance: SurveyQuestionCreateInputs = {
     sortOrder,
     featured,
     choices,
+    matrixRows,
+    matrixRowsType,
     searchListId,
     masked,
 };

package/docs/SurveyQuestionType.md

@@ -25,4 +25,6 @@
 
 * `Location` (value: `'location'`)
 
+* `Matrix` (value: `'matrix'`)
+
 [[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/SurveyQuestionUpdateInputs.md

@@ -24,6 +24,7 @@ Name | Type | Description | Notes
 **sortOrder** | **number** |  | [optional] [default to undefined]
 **featured** | **boolean** |  | [optional] [default to undefined]
 **searchListId** | **string** |  | [optional] [default to undefined]
+**matrixRowsType** | **string** |  | [optional] [default to undefined]
 
 ## Example
 
@@ -50,6 +51,7 @@ const instance: SurveyQuestionUpdateInputs = {
     sortOrder,
     featured,
     searchListId,
+    matrixRowsType,
 };
 ```
 

package/docs/SurveysQuestionsApi.md

@@ -15,11 +15,13 @@ All URIs are relative to *https://admin-api.connected.dev*
 |[**getSurveyQuestionChoice**](#getsurveyquestionchoice) | **GET** /surveys/{surveyId}/questions/{questionId}/choices/{choiceId} | Get a survey question choice|
 |[**getSurveyQuestionChoiceSubQuestions**](#getsurveyquestionchoicesubquestions) | **GET** /surveys/{surveyId}/questions/{questionId}/choices/{choiceId}/subQuestions | List a choice\'s follow-up sub-questions|
 |[**getSurveyQuestionChoices**](#getsurveyquestionchoices) | **GET** /surveys/{surveyId}/questions/{questionId}/choices | List a survey question\'s choices|
+|[**getSurveyQuestionMatrixRows**](#getsurveyquestionmatrixrows) | **GET** /surveys/{surveyId}/questions/{questionId}/matrixRows | List a matrix question\'s rows|
 |[**getSurveyQuestionResponses**](#getsurveyquestionresponses) | **GET** /surveys/{surveyId}/questions/{questionId}/responses | List responses to a survey question|
 |[**getSurveyQuestions**](#getsurveyquestions) | **GET** /surveys/{surveyId}/questions | List a survey\'s questions|
 |[**removeSurveyQuestionChoiceSubQuestion**](#removesurveyquestionchoicesubquestion) | **DELETE** /surveys/{surveyId}/questions/{questionId}/choices/{choiceId}/subQuestions/{subQuestionId} | Remove a follow-up sub-question from a choice|
 |[**reorderSurveyQuestionChoiceSubQuestions**](#reordersurveyquestionchoicesubquestions) | **PUT** /surveys/{surveyId}/questions/{questionId}/choices/{choiceId}/subQuestions/reorder | Reorder a choice\'s follow-up sub-questions|
 |[**reorderSurveyQuestionChoices**](#reordersurveyquestionchoices) | **PUT** /surveys/{surveyId}/questions/{questionId}/choices/reorder | Reorder a survey question\'s choices|
+|[**reorderSurveyQuestionMatrixRows**](#reordersurveyquestionmatrixrows) | **PUT** /surveys/{surveyId}/questions/{questionId}/matrixRows/reorder | Reorder a matrix question\'s rows|
 |[**updateSurveyQuestion**](#updatesurveyquestion) | **PUT** /surveys/{surveyId}/questions/{questionId} | Update a survey question|
 |[**updateSurveyQuestionChoice**](#updatesurveyquestionchoice) | **PUT** /surveys/{surveyId}/questions/{questionId}/choices/{choiceId} | Update a survey question choice|
 |[**updateSurveyQuestionChoiceSubQuestion**](#updatesurveyquestionchoicesubquestion) | **PUT** /surveys/{surveyId}/questions/{questionId}/choices/{choiceId}/subQuestions/{subQuestionId} | Reorder a choice\'s sub-question|
@@ -662,6 +664,72 @@ const { status, data } = await apiInstance.getSurveyQuestionChoices(
  - **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)
+
+# **getSurveyQuestionMatrixRows**
+> GetSurveyQuestions200Response getSurveyQuestionMatrixRows()
+
+Returns a paginated list of the row questions that belong to a matrix survey question, ordered by their matrix sort order and supporting search by row name, label, or description; requires read access to the surveys module.
+
+### Example
+
+```typescript
+import {
+    SurveysQuestionsApi,
+    Configuration
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SurveysQuestionsApi(configuration);
+
+let surveyId: string; //The survey 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.getSurveyQuestionMatrixRows(
+    surveyId,
+    questionId,
+    page,
+    pageSize,
+    orderBy,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **surveyId** | [**string**] | The survey 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
+
+**GetSurveyQuestions200Response**
+
+### 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 |
 |-------------|-------------|------------------|
@@ -970,6 +1038,64 @@ const { status, data } = await apiInstance.reorderSurveyQuestionChoices(
  - **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)
+
+# **reorderSurveyQuestionMatrixRows**
+> ReorderSurveyQuestionMatrixRows200Response reorderSurveyQuestionMatrixRows(reorderSurveyQuestionMatrixRowsRequest)
+
+Sets the display order of the rows belonging to a matrix survey question to match the given full list of row IDs, rejecting the request if any row is missing or unknown, and requires update permission on surveys.
+
+### Example
+
+```typescript
+import {
+    SurveysQuestionsApi,
+    Configuration,
+    ReorderSurveyQuestionMatrixRowsRequest
+} from '@connectedxm/admin-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SurveysQuestionsApi(configuration);
+
+let surveyId: string; //The survey identifier (default to undefined)
+let questionId: string; //The question identifier (default to undefined)
+let reorderSurveyQuestionMatrixRowsRequest: ReorderSurveyQuestionMatrixRowsRequest; //
+
+const { status, data } = await apiInstance.reorderSurveyQuestionMatrixRows(
+    surveyId,
+    questionId,
+    reorderSurveyQuestionMatrixRowsRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **reorderSurveyQuestionMatrixRowsRequest** | **ReorderSurveyQuestionMatrixRowsRequest**|  | |
+| **surveyId** | [**string**] | The survey identifier | defaults to undefined|
+| **questionId** | [**string**] | The question identifier | defaults to undefined|
+
+
+### Return type
+
+**ReorderSurveyQuestionMatrixRows200Response**
+
+### 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 |
 |-------------|-------------|------------------|

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@connectedxm/admin-sdk",
-  "version": "10.0.0",
+  "version": "10.2.1",
   "description": "OpenAPI client for @connectedxm/admin-sdk",
   "author": "OpenAPI-Generator Contributors",
   "repository": {