@connectedxm/admin-sdk 10.0.0 → 10.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +2 -0
- package/README.md +2 -2
- package/api.ts +277 -3
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +156 -3
- package/dist/api.js +215 -20
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/esm/api.d.ts +156 -3
- package/dist/esm/api.js +196 -1
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +1 -1
- package/docs/BaseSurveyQuestion.md +4 -0
- package/docs/ImageDirectUploadInputs.md +1 -1
- package/docs/ReorderSurveyQuestionMatrixRows200Response.md +24 -0
- package/docs/ReorderSurveyQuestionMatrixRowsRequest.md +20 -0
- package/docs/SurveyQuestion.md +6 -0
- package/docs/SurveyQuestionCreateInputs.md +6 -0
- package/docs/SurveyQuestionType.md +2 -0
- package/docs/SurveyQuestionUpdateInputs.md +2 -0
- package/docs/SurveysQuestionsApi.md +126 -0
- package/package.json +1 -1
package/.openapi-generator/FILES
CHANGED
|
@@ -1299,6 +1299,8 @@ docs/ReorderEventSponsorshipsRequest.md
|
|
|
1299
1299
|
docs/ReorderSeriesQuestionChoices200Response.md
|
|
1300
1300
|
docs/ReorderSurveyQuestionChoiceSubQuestions200Response.md
|
|
1301
1301
|
docs/ReorderSurveyQuestionChoices200Response.md
|
|
1302
|
+
docs/ReorderSurveyQuestionMatrixRows200Response.md
|
|
1303
|
+
docs/ReorderSurveyQuestionMatrixRowsRequest.md
|
|
1302
1304
|
docs/ReorderSurveySectionQuestions200Response.md
|
|
1303
1305
|
docs/ReportFilters.md
|
|
1304
1306
|
docs/ReportType.md
|
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## @connectedxm/admin-sdk@10.
|
|
1
|
+
## @connectedxm/admin-sdk@10.2.1
|
|
2
2
|
|
|
3
3
|
This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
|
|
4
4
|
|
|
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
|
|
|
36
36
|
_published:_
|
|
37
37
|
|
|
38
38
|
```
|
|
39
|
-
npm install @connectedxm/admin-sdk@10.
|
|
39
|
+
npm install @connectedxm/admin-sdk@10.2.1 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
package/api.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Connected Admin API
|
|
5
5
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 10.
|
|
7
|
+
* The version of the OpenAPI document: 10.2.1
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -2497,6 +2497,8 @@ export interface BaseSurveyQuestion {
|
|
|
2497
2497
|
'default': string | null;
|
|
2498
2498
|
'searchListId': string | null;
|
|
2499
2499
|
'searchList': BaseSearchList | null;
|
|
2500
|
+
'matrixQuestionId': string | null;
|
|
2501
|
+
'matrixSortOrder': number | null;
|
|
2500
2502
|
'mutable': boolean;
|
|
2501
2503
|
'min': string | null;
|
|
2502
2504
|
'max': string | null;
|
|
@@ -10319,11 +10321,14 @@ export interface ImageDirectUpload {
|
|
|
10319
10321
|
'uploadURL': string;
|
|
10320
10322
|
}
|
|
10321
10323
|
export interface ImageDirectUploadInputs {
|
|
10322
|
-
'type':
|
|
10324
|
+
'type': ImageDirectUploadInputsTypeEnum;
|
|
10323
10325
|
'name'?: string | null;
|
|
10324
10326
|
'description'?: string | null;
|
|
10325
10327
|
}
|
|
10326
10328
|
|
|
10329
|
+
export enum ImageDirectUploadInputsTypeEnum {
|
|
10330
|
+
Admin = 'admin'
|
|
10331
|
+
}
|
|
10327
10332
|
|
|
10328
10333
|
|
|
10329
10334
|
export enum ImageModerationLevel {
|
|
@@ -12485,6 +12490,19 @@ export enum ReorderSurveyQuestionChoices200ResponseStatusEnum {
|
|
|
12485
12490
|
Ok = 'ok'
|
|
12486
12491
|
}
|
|
12487
12492
|
|
|
12493
|
+
export interface ReorderSurveyQuestionMatrixRows200Response {
|
|
12494
|
+
'status': ReorderSurveyQuestionMatrixRows200ResponseStatusEnum;
|
|
12495
|
+
'message': string;
|
|
12496
|
+
'data': Array<SurveyQuestion>;
|
|
12497
|
+
}
|
|
12498
|
+
|
|
12499
|
+
export enum ReorderSurveyQuestionMatrixRows200ResponseStatusEnum {
|
|
12500
|
+
Ok = 'ok'
|
|
12501
|
+
}
|
|
12502
|
+
|
|
12503
|
+
export interface ReorderSurveyQuestionMatrixRowsRequest {
|
|
12504
|
+
'rowIds': Array<string>;
|
|
12505
|
+
}
|
|
12488
12506
|
export interface ReorderSurveySectionQuestions200Response {
|
|
12489
12507
|
'status': ReorderSurveySectionQuestions200ResponseStatusEnum;
|
|
12490
12508
|
'message': string;
|
|
@@ -13590,6 +13608,8 @@ export interface SurveyQuestion {
|
|
|
13590
13608
|
'default': string | null;
|
|
13591
13609
|
'searchListId': string | null;
|
|
13592
13610
|
'searchList': BaseSearchList | null;
|
|
13611
|
+
'matrixQuestionId': string | null;
|
|
13612
|
+
'matrixSortOrder': number | null;
|
|
13593
13613
|
'mutable': boolean;
|
|
13594
13614
|
'min': string | null;
|
|
13595
13615
|
'max': string | null;
|
|
@@ -13602,6 +13622,7 @@ export interface SurveyQuestion {
|
|
|
13602
13622
|
'choices': Array<BaseSurveyQuestionChoice>;
|
|
13603
13623
|
'sections': Array<BaseSurveySectionQuestion>;
|
|
13604
13624
|
'subQuestionOf': Array<SurveyQuestionChoiceSubQuestion>;
|
|
13625
|
+
'matrixRows'?: Array<BaseSurveyQuestion>;
|
|
13605
13626
|
'dashboardVisibility': boolean;
|
|
13606
13627
|
'createdAt': string;
|
|
13607
13628
|
'updatedAt': string;
|
|
@@ -13666,6 +13687,7 @@ export interface SurveyQuestionCreateInputs {
|
|
|
13666
13687
|
'sectionId'?: string;
|
|
13667
13688
|
'questionId'?: string;
|
|
13668
13689
|
'choiceId'?: string;
|
|
13690
|
+
'matrixQuestionId'?: string;
|
|
13669
13691
|
'required'?: boolean;
|
|
13670
13692
|
'label'?: string | null;
|
|
13671
13693
|
'placeholder'?: string | null;
|
|
@@ -13682,10 +13704,16 @@ export interface SurveyQuestionCreateInputs {
|
|
|
13682
13704
|
'sortOrder'?: number | null;
|
|
13683
13705
|
'featured'?: boolean;
|
|
13684
13706
|
'choices'?: Array<string> | null;
|
|
13707
|
+
'matrixRows'?: Array<string> | null;
|
|
13708
|
+
'matrixRowsType'?: SurveyQuestionCreateInputsMatrixRowsTypeEnum;
|
|
13685
13709
|
'searchListId'?: string | null;
|
|
13686
13710
|
'masked'?: boolean;
|
|
13687
13711
|
}
|
|
13688
13712
|
|
|
13713
|
+
export enum SurveyQuestionCreateInputsMatrixRowsTypeEnum {
|
|
13714
|
+
Radio = 'radio',
|
|
13715
|
+
Checkbox = 'checkbox'
|
|
13716
|
+
}
|
|
13689
13717
|
|
|
13690
13718
|
export interface SurveyQuestionResponse {
|
|
13691
13719
|
'id': string;
|
|
@@ -13734,7 +13762,8 @@ export enum SurveyQuestionType {
|
|
|
13734
13762
|
Checkbox = 'checkbox',
|
|
13735
13763
|
Search = 'search',
|
|
13736
13764
|
File = 'file',
|
|
13737
|
-
Location = 'location'
|
|
13765
|
+
Location = 'location',
|
|
13766
|
+
Matrix = 'matrix'
|
|
13738
13767
|
}
|
|
13739
13768
|
|
|
13740
13769
|
|
|
@@ -13758,8 +13787,13 @@ export interface SurveyQuestionUpdateInputs {
|
|
|
13758
13787
|
'sortOrder'?: number | null;
|
|
13759
13788
|
'featured'?: boolean;
|
|
13760
13789
|
'searchListId'?: string | null;
|
|
13790
|
+
'matrixRowsType'?: SurveyQuestionUpdateInputsMatrixRowsTypeEnum;
|
|
13761
13791
|
}
|
|
13762
13792
|
|
|
13793
|
+
export enum SurveyQuestionUpdateInputsMatrixRowsTypeEnum {
|
|
13794
|
+
Radio = 'radio',
|
|
13795
|
+
Checkbox = 'checkbox'
|
|
13796
|
+
}
|
|
13763
13797
|
|
|
13764
13798
|
export interface SurveySection {
|
|
13765
13799
|
'id': string;
|
|
@@ -142575,6 +142609,70 @@ export const SurveysQuestionsApiAxiosParamCreator = function (configuration?: Co
|
|
|
142575
142609
|
options: localVarRequestOptions,
|
|
142576
142610
|
};
|
|
142577
142611
|
},
|
|
142612
|
+
/**
|
|
142613
|
+
* 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.
|
|
142614
|
+
* @summary List a matrix question\'s rows
|
|
142615
|
+
* @param {string} surveyId The survey identifier
|
|
142616
|
+
* @param {string} questionId The question identifier
|
|
142617
|
+
* @param {number} [page] Page number
|
|
142618
|
+
* @param {number} [pageSize] Number of items per page
|
|
142619
|
+
* @param {string} [orderBy] Field to order by
|
|
142620
|
+
* @param {string} [search] Search query
|
|
142621
|
+
* @param {*} [options] Override http request option.
|
|
142622
|
+
* @throws {RequiredError}
|
|
142623
|
+
*/
|
|
142624
|
+
getSurveyQuestionMatrixRows: async (surveyId: string, questionId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
142625
|
+
// verify required parameter 'surveyId' is not null or undefined
|
|
142626
|
+
assertParamExists('getSurveyQuestionMatrixRows', 'surveyId', surveyId)
|
|
142627
|
+
// verify required parameter 'questionId' is not null or undefined
|
|
142628
|
+
assertParamExists('getSurveyQuestionMatrixRows', 'questionId', questionId)
|
|
142629
|
+
const localVarPath = `/surveys/{surveyId}/questions/{questionId}/matrixRows`
|
|
142630
|
+
.replace(`{${"surveyId"}}`, encodeURIComponent(String(surveyId)))
|
|
142631
|
+
.replace(`{${"questionId"}}`, encodeURIComponent(String(questionId)));
|
|
142632
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
142633
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
142634
|
+
let baseOptions;
|
|
142635
|
+
if (configuration) {
|
|
142636
|
+
baseOptions = configuration.baseOptions;
|
|
142637
|
+
}
|
|
142638
|
+
|
|
142639
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
142640
|
+
const localVarHeaderParameter = {} as any;
|
|
142641
|
+
const localVarQueryParameter = {} as any;
|
|
142642
|
+
|
|
142643
|
+
// authentication ApiKeyAuth required
|
|
142644
|
+
await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
|
|
142645
|
+
|
|
142646
|
+
// authentication OrganizationId required
|
|
142647
|
+
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
142648
|
+
|
|
142649
|
+
if (page !== undefined) {
|
|
142650
|
+
localVarQueryParameter['page'] = page;
|
|
142651
|
+
}
|
|
142652
|
+
|
|
142653
|
+
if (pageSize !== undefined) {
|
|
142654
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
142655
|
+
}
|
|
142656
|
+
|
|
142657
|
+
if (orderBy !== undefined) {
|
|
142658
|
+
localVarQueryParameter['orderBy'] = orderBy;
|
|
142659
|
+
}
|
|
142660
|
+
|
|
142661
|
+
if (search !== undefined) {
|
|
142662
|
+
localVarQueryParameter['search'] = search;
|
|
142663
|
+
}
|
|
142664
|
+
|
|
142665
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
142666
|
+
|
|
142667
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
142668
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
142669
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
142670
|
+
|
|
142671
|
+
return {
|
|
142672
|
+
url: toPathString(localVarUrlObj),
|
|
142673
|
+
options: localVarRequestOptions,
|
|
142674
|
+
};
|
|
142675
|
+
},
|
|
142578
142676
|
/**
|
|
142579
142677
|
* Returns a paginated list of submitted responses for a survey question from completed submissions, supporting search by respondent name or email; file-upload responses include a temporary signed download URL, and read access to the surveys module is required.
|
|
142580
142678
|
* @summary List responses to a survey question
|
|
@@ -142853,6 +142951,55 @@ export const SurveysQuestionsApiAxiosParamCreator = function (configuration?: Co
|
|
|
142853
142951
|
options: localVarRequestOptions,
|
|
142854
142952
|
};
|
|
142855
142953
|
},
|
|
142954
|
+
/**
|
|
142955
|
+
* 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.
|
|
142956
|
+
* @summary Reorder a matrix question\'s rows
|
|
142957
|
+
* @param {string} surveyId The survey identifier
|
|
142958
|
+
* @param {string} questionId The question identifier
|
|
142959
|
+
* @param {ReorderSurveyQuestionMatrixRowsRequest} reorderSurveyQuestionMatrixRowsRequest
|
|
142960
|
+
* @param {*} [options] Override http request option.
|
|
142961
|
+
* @throws {RequiredError}
|
|
142962
|
+
*/
|
|
142963
|
+
reorderSurveyQuestionMatrixRows: async (surveyId: string, questionId: string, reorderSurveyQuestionMatrixRowsRequest: ReorderSurveyQuestionMatrixRowsRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
142964
|
+
// verify required parameter 'surveyId' is not null or undefined
|
|
142965
|
+
assertParamExists('reorderSurveyQuestionMatrixRows', 'surveyId', surveyId)
|
|
142966
|
+
// verify required parameter 'questionId' is not null or undefined
|
|
142967
|
+
assertParamExists('reorderSurveyQuestionMatrixRows', 'questionId', questionId)
|
|
142968
|
+
// verify required parameter 'reorderSurveyQuestionMatrixRowsRequest' is not null or undefined
|
|
142969
|
+
assertParamExists('reorderSurveyQuestionMatrixRows', 'reorderSurveyQuestionMatrixRowsRequest', reorderSurveyQuestionMatrixRowsRequest)
|
|
142970
|
+
const localVarPath = `/surveys/{surveyId}/questions/{questionId}/matrixRows/reorder`
|
|
142971
|
+
.replace(`{${"surveyId"}}`, encodeURIComponent(String(surveyId)))
|
|
142972
|
+
.replace(`{${"questionId"}}`, encodeURIComponent(String(questionId)));
|
|
142973
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
142974
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
142975
|
+
let baseOptions;
|
|
142976
|
+
if (configuration) {
|
|
142977
|
+
baseOptions = configuration.baseOptions;
|
|
142978
|
+
}
|
|
142979
|
+
|
|
142980
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
|
|
142981
|
+
const localVarHeaderParameter = {} as any;
|
|
142982
|
+
const localVarQueryParameter = {} as any;
|
|
142983
|
+
|
|
142984
|
+
// authentication ApiKeyAuth required
|
|
142985
|
+
await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
|
|
142986
|
+
|
|
142987
|
+
// authentication OrganizationId required
|
|
142988
|
+
await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
|
|
142989
|
+
|
|
142990
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
142991
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
142992
|
+
|
|
142993
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
142994
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
142995
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
142996
|
+
localVarRequestOptions.data = serializeDataIfNeeded(reorderSurveyQuestionMatrixRowsRequest, localVarRequestOptions, configuration)
|
|
142997
|
+
|
|
142998
|
+
return {
|
|
142999
|
+
url: toPathString(localVarUrlObj),
|
|
143000
|
+
options: localVarRequestOptions,
|
|
143001
|
+
};
|
|
143002
|
+
},
|
|
142856
143003
|
/**
|
|
142857
143004
|
* Updates a question\'s fields (such as name, description, type, or required flag) on the given survey, and reorders it among the survey\'s other questions when a new sortOrder is provided; requires the update surveys permission.
|
|
142858
143005
|
* @summary Update a survey question
|
|
@@ -143191,6 +143338,24 @@ export const SurveysQuestionsApiFp = function(configuration?: Configuration) {
|
|
|
143191
143338
|
const localVarOperationServerBasePath = operationServerMap['SurveysQuestionsApi.getSurveyQuestionChoices']?.[localVarOperationServerIndex]?.url;
|
|
143192
143339
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
143193
143340
|
},
|
|
143341
|
+
/**
|
|
143342
|
+
* 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.
|
|
143343
|
+
* @summary List a matrix question\'s rows
|
|
143344
|
+
* @param {string} surveyId The survey identifier
|
|
143345
|
+
* @param {string} questionId The question identifier
|
|
143346
|
+
* @param {number} [page] Page number
|
|
143347
|
+
* @param {number} [pageSize] Number of items per page
|
|
143348
|
+
* @param {string} [orderBy] Field to order by
|
|
143349
|
+
* @param {string} [search] Search query
|
|
143350
|
+
* @param {*} [options] Override http request option.
|
|
143351
|
+
* @throws {RequiredError}
|
|
143352
|
+
*/
|
|
143353
|
+
async getSurveyQuestionMatrixRows(surveyId: string, questionId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSurveyQuestions200Response>> {
|
|
143354
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getSurveyQuestionMatrixRows(surveyId, questionId, page, pageSize, orderBy, search, options);
|
|
143355
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
143356
|
+
const localVarOperationServerBasePath = operationServerMap['SurveysQuestionsApi.getSurveyQuestionMatrixRows']?.[localVarOperationServerIndex]?.url;
|
|
143357
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
143358
|
+
},
|
|
143194
143359
|
/**
|
|
143195
143360
|
* Returns a paginated list of submitted responses for a survey question from completed submissions, supporting search by respondent name or email; file-upload responses include a temporary signed download URL, and read access to the surveys module is required.
|
|
143196
143361
|
* @summary List responses to a survey question
|
|
@@ -143273,6 +143438,21 @@ export const SurveysQuestionsApiFp = function(configuration?: Configuration) {
|
|
|
143273
143438
|
const localVarOperationServerBasePath = operationServerMap['SurveysQuestionsApi.reorderSurveyQuestionChoices']?.[localVarOperationServerIndex]?.url;
|
|
143274
143439
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
143275
143440
|
},
|
|
143441
|
+
/**
|
|
143442
|
+
* 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.
|
|
143443
|
+
* @summary Reorder a matrix question\'s rows
|
|
143444
|
+
* @param {string} surveyId The survey identifier
|
|
143445
|
+
* @param {string} questionId The question identifier
|
|
143446
|
+
* @param {ReorderSurveyQuestionMatrixRowsRequest} reorderSurveyQuestionMatrixRowsRequest
|
|
143447
|
+
* @param {*} [options] Override http request option.
|
|
143448
|
+
* @throws {RequiredError}
|
|
143449
|
+
*/
|
|
143450
|
+
async reorderSurveyQuestionMatrixRows(surveyId: string, questionId: string, reorderSurveyQuestionMatrixRowsRequest: ReorderSurveyQuestionMatrixRowsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReorderSurveyQuestionMatrixRows200Response>> {
|
|
143451
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.reorderSurveyQuestionMatrixRows(surveyId, questionId, reorderSurveyQuestionMatrixRowsRequest, options);
|
|
143452
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
143453
|
+
const localVarOperationServerBasePath = operationServerMap['SurveysQuestionsApi.reorderSurveyQuestionMatrixRows']?.[localVarOperationServerIndex]?.url;
|
|
143454
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
143455
|
+
},
|
|
143276
143456
|
/**
|
|
143277
143457
|
* Updates a question\'s fields (such as name, description, type, or required flag) on the given survey, and reorders it among the survey\'s other questions when a new sortOrder is provided; requires the update surveys permission.
|
|
143278
143458
|
* @summary Update a survey question
|
|
@@ -143440,6 +143620,16 @@ export const SurveysQuestionsApiFactory = function (configuration?: Configuratio
|
|
|
143440
143620
|
getSurveyQuestionChoices(requestParameters: SurveysQuestionsApiGetSurveyQuestionChoicesRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetSurveyQuestionChoices200Response> {
|
|
143441
143621
|
return localVarFp.getSurveyQuestionChoices(requestParameters.surveyId, requestParameters.questionId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
143442
143622
|
},
|
|
143623
|
+
/**
|
|
143624
|
+
* 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.
|
|
143625
|
+
* @summary List a matrix question\'s rows
|
|
143626
|
+
* @param {SurveysQuestionsApiGetSurveyQuestionMatrixRowsRequest} requestParameters Request parameters.
|
|
143627
|
+
* @param {*} [options] Override http request option.
|
|
143628
|
+
* @throws {RequiredError}
|
|
143629
|
+
*/
|
|
143630
|
+
getSurveyQuestionMatrixRows(requestParameters: SurveysQuestionsApiGetSurveyQuestionMatrixRowsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetSurveyQuestions200Response> {
|
|
143631
|
+
return localVarFp.getSurveyQuestionMatrixRows(requestParameters.surveyId, requestParameters.questionId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
143632
|
+
},
|
|
143443
143633
|
/**
|
|
143444
143634
|
* Returns a paginated list of submitted responses for a survey question from completed submissions, supporting search by respondent name or email; file-upload responses include a temporary signed download URL, and read access to the surveys module is required.
|
|
143445
143635
|
* @summary List responses to a survey question
|
|
@@ -143490,6 +143680,16 @@ export const SurveysQuestionsApiFactory = function (configuration?: Configuratio
|
|
|
143490
143680
|
reorderSurveyQuestionChoices(requestParameters: SurveysQuestionsApiReorderSurveyQuestionChoicesRequest, options?: RawAxiosRequestConfig): AxiosPromise<ReorderSurveyQuestionChoices200Response> {
|
|
143491
143681
|
return localVarFp.reorderSurveyQuestionChoices(requestParameters.surveyId, requestParameters.questionId, requestParameters.reorderBookingSpaceQuestionChoicesRequest, options).then((request) => request(axios, basePath));
|
|
143492
143682
|
},
|
|
143683
|
+
/**
|
|
143684
|
+
* 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.
|
|
143685
|
+
* @summary Reorder a matrix question\'s rows
|
|
143686
|
+
* @param {SurveysQuestionsApiReorderSurveyQuestionMatrixRowsRequest} requestParameters Request parameters.
|
|
143687
|
+
* @param {*} [options] Override http request option.
|
|
143688
|
+
* @throws {RequiredError}
|
|
143689
|
+
*/
|
|
143690
|
+
reorderSurveyQuestionMatrixRows(requestParameters: SurveysQuestionsApiReorderSurveyQuestionMatrixRowsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ReorderSurveyQuestionMatrixRows200Response> {
|
|
143691
|
+
return localVarFp.reorderSurveyQuestionMatrixRows(requestParameters.surveyId, requestParameters.questionId, requestParameters.reorderSurveyQuestionMatrixRowsRequest, options).then((request) => request(axios, basePath));
|
|
143692
|
+
},
|
|
143493
143693
|
/**
|
|
143494
143694
|
* Updates a question\'s fields (such as name, description, type, or required flag) on the given survey, and reorders it among the survey\'s other questions when a new sortOrder is provided; requires the update surveys permission.
|
|
143495
143695
|
* @summary Update a survey question
|
|
@@ -143759,6 +143959,41 @@ export interface SurveysQuestionsApiGetSurveyQuestionChoicesRequest {
|
|
|
143759
143959
|
readonly search?: string
|
|
143760
143960
|
}
|
|
143761
143961
|
|
|
143962
|
+
/**
|
|
143963
|
+
* Request parameters for getSurveyQuestionMatrixRows operation in SurveysQuestionsApi.
|
|
143964
|
+
*/
|
|
143965
|
+
export interface SurveysQuestionsApiGetSurveyQuestionMatrixRowsRequest {
|
|
143966
|
+
/**
|
|
143967
|
+
* The survey identifier
|
|
143968
|
+
*/
|
|
143969
|
+
readonly surveyId: string
|
|
143970
|
+
|
|
143971
|
+
/**
|
|
143972
|
+
* The question identifier
|
|
143973
|
+
*/
|
|
143974
|
+
readonly questionId: string
|
|
143975
|
+
|
|
143976
|
+
/**
|
|
143977
|
+
* Page number
|
|
143978
|
+
*/
|
|
143979
|
+
readonly page?: number
|
|
143980
|
+
|
|
143981
|
+
/**
|
|
143982
|
+
* Number of items per page
|
|
143983
|
+
*/
|
|
143984
|
+
readonly pageSize?: number
|
|
143985
|
+
|
|
143986
|
+
/**
|
|
143987
|
+
* Field to order by
|
|
143988
|
+
*/
|
|
143989
|
+
readonly orderBy?: string
|
|
143990
|
+
|
|
143991
|
+
/**
|
|
143992
|
+
* Search query
|
|
143993
|
+
*/
|
|
143994
|
+
readonly search?: string
|
|
143995
|
+
}
|
|
143996
|
+
|
|
143762
143997
|
/**
|
|
143763
143998
|
* Request parameters for getSurveyQuestionResponses operation in SurveysQuestionsApi.
|
|
143764
143999
|
*/
|
|
@@ -143888,6 +144123,23 @@ export interface SurveysQuestionsApiReorderSurveyQuestionChoicesRequest {
|
|
|
143888
144123
|
readonly reorderBookingSpaceQuestionChoicesRequest: ReorderBookingSpaceQuestionChoicesRequest
|
|
143889
144124
|
}
|
|
143890
144125
|
|
|
144126
|
+
/**
|
|
144127
|
+
* Request parameters for reorderSurveyQuestionMatrixRows operation in SurveysQuestionsApi.
|
|
144128
|
+
*/
|
|
144129
|
+
export interface SurveysQuestionsApiReorderSurveyQuestionMatrixRowsRequest {
|
|
144130
|
+
/**
|
|
144131
|
+
* The survey identifier
|
|
144132
|
+
*/
|
|
144133
|
+
readonly surveyId: string
|
|
144134
|
+
|
|
144135
|
+
/**
|
|
144136
|
+
* The question identifier
|
|
144137
|
+
*/
|
|
144138
|
+
readonly questionId: string
|
|
144139
|
+
|
|
144140
|
+
readonly reorderSurveyQuestionMatrixRowsRequest: ReorderSurveyQuestionMatrixRowsRequest
|
|
144141
|
+
}
|
|
144142
|
+
|
|
143891
144143
|
/**
|
|
143892
144144
|
* Request parameters for updateSurveyQuestion operation in SurveysQuestionsApi.
|
|
143893
144145
|
*/
|
|
@@ -144079,6 +144331,17 @@ export class SurveysQuestionsApi extends BaseAPI {
|
|
|
144079
144331
|
return SurveysQuestionsApiFp(this.configuration).getSurveyQuestionChoices(requestParameters.surveyId, requestParameters.questionId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
144080
144332
|
}
|
|
144081
144333
|
|
|
144334
|
+
/**
|
|
144335
|
+
* 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.
|
|
144336
|
+
* @summary List a matrix question\'s rows
|
|
144337
|
+
* @param {SurveysQuestionsApiGetSurveyQuestionMatrixRowsRequest} requestParameters Request parameters.
|
|
144338
|
+
* @param {*} [options] Override http request option.
|
|
144339
|
+
* @throws {RequiredError}
|
|
144340
|
+
*/
|
|
144341
|
+
public getSurveyQuestionMatrixRows(requestParameters: SurveysQuestionsApiGetSurveyQuestionMatrixRowsRequest, options?: RawAxiosRequestConfig) {
|
|
144342
|
+
return SurveysQuestionsApiFp(this.configuration).getSurveyQuestionMatrixRows(requestParameters.surveyId, requestParameters.questionId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
144343
|
+
}
|
|
144344
|
+
|
|
144082
144345
|
/**
|
|
144083
144346
|
* Returns a paginated list of submitted responses for a survey question from completed submissions, supporting search by respondent name or email; file-upload responses include a temporary signed download URL, and read access to the surveys module is required.
|
|
144084
144347
|
* @summary List responses to a survey question
|
|
@@ -144134,6 +144397,17 @@ export class SurveysQuestionsApi extends BaseAPI {
|
|
|
144134
144397
|
return SurveysQuestionsApiFp(this.configuration).reorderSurveyQuestionChoices(requestParameters.surveyId, requestParameters.questionId, requestParameters.reorderBookingSpaceQuestionChoicesRequest, options).then((request) => request(this.axios, this.basePath));
|
|
144135
144398
|
}
|
|
144136
144399
|
|
|
144400
|
+
/**
|
|
144401
|
+
* 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.
|
|
144402
|
+
* @summary Reorder a matrix question\'s rows
|
|
144403
|
+
* @param {SurveysQuestionsApiReorderSurveyQuestionMatrixRowsRequest} requestParameters Request parameters.
|
|
144404
|
+
* @param {*} [options] Override http request option.
|
|
144405
|
+
* @throws {RequiredError}
|
|
144406
|
+
*/
|
|
144407
|
+
public reorderSurveyQuestionMatrixRows(requestParameters: SurveysQuestionsApiReorderSurveyQuestionMatrixRowsRequest, options?: RawAxiosRequestConfig) {
|
|
144408
|
+
return SurveysQuestionsApiFp(this.configuration).reorderSurveyQuestionMatrixRows(requestParameters.surveyId, requestParameters.questionId, requestParameters.reorderSurveyQuestionMatrixRowsRequest, options).then((request) => request(this.axios, this.basePath));
|
|
144409
|
+
}
|
|
144410
|
+
|
|
144137
144411
|
/**
|
|
144138
144412
|
* Updates a question\'s fields (such as name, description, type, or required flag) on the given survey, and reorders it among the survey\'s other questions when a new sortOrder is provided; requires the update surveys permission.
|
|
144139
144413
|
* @summary Update a survey question
|
package/base.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Connected Admin API
|
|
5
5
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 10.
|
|
7
|
+
* The version of the OpenAPI document: 10.2.1
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/common.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Connected Admin API
|
|
5
5
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 10.
|
|
7
|
+
* The version of the OpenAPI document: 10.2.1
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/configuration.ts
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
* Connected Admin API
|
|
4
4
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
5
5
|
*
|
|
6
|
-
* The version of the OpenAPI document: 10.
|
|
6
|
+
* The version of the OpenAPI document: 10.2.1
|
|
7
7
|
*
|
|
8
8
|
*
|
|
9
9
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|