@connectedxm/admin-sdk 9.0.1 → 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 +296 -14
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +175 -14
- package/dist/api.js +219 -24
- 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 +175 -14
- package/dist/esm/api.js +200 -5
- 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/BaseEventPassAttendee.md +4 -0
- package/docs/BaseEventRegistration.md +2 -0
- package/docs/BaseSurveyQuestion.md +4 -0
- package/docs/EventRegistration.md +2 -0
- package/docs/EventRoomTypeReservationPassesInnerAttendee.md +2 -0
- package/docs/EventsRegistrationsApi.md +1 -1
- package/docs/ImageDirectUploadInputs.md +1 -1
- package/docs/Organization.md +2 -0
- package/docs/OrganizationUpdateInputs.md +4 -0
- 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@
|
|
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@
|
|
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:
|
|
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).
|
|
@@ -1196,7 +1196,7 @@ export interface BaseCoupon {
|
|
|
1196
1196
|
'registration': BaseCouponRegistration | null;
|
|
1197
1197
|
}
|
|
1198
1198
|
export interface BaseCouponRegistration {
|
|
1199
|
-
'accountId': string;
|
|
1199
|
+
'accountId': string | null;
|
|
1200
1200
|
}
|
|
1201
1201
|
export interface BaseDashboard {
|
|
1202
1202
|
'id': string;
|
|
@@ -1410,7 +1410,9 @@ export interface BaseEventPass {
|
|
|
1410
1410
|
|
|
1411
1411
|
|
|
1412
1412
|
export interface BaseEventPassAttendee {
|
|
1413
|
-
'
|
|
1413
|
+
'alternateId': number;
|
|
1414
|
+
'email': string | null;
|
|
1415
|
+
'account': BaseEventPassAttendeeAccount | null;
|
|
1414
1416
|
}
|
|
1415
1417
|
export interface BaseEventPassAttendeeAccount {
|
|
1416
1418
|
'id': string;
|
|
@@ -1485,8 +1487,9 @@ export interface BaseEventPassTypeRefundSchedule {
|
|
|
1485
1487
|
export interface BaseEventRegistration {
|
|
1486
1488
|
'id': string;
|
|
1487
1489
|
'alternateId': number;
|
|
1488
|
-
'accountId': string;
|
|
1489
|
-
'account': BaseAccount;
|
|
1490
|
+
'accountId': string | null;
|
|
1491
|
+
'account': BaseAccount | null;
|
|
1492
|
+
'email': string | null;
|
|
1490
1493
|
'eventId': string;
|
|
1491
1494
|
'event': BaseEvent;
|
|
1492
1495
|
}
|
|
@@ -2494,6 +2497,8 @@ export interface BaseSurveyQuestion {
|
|
|
2494
2497
|
'default': string | null;
|
|
2495
2498
|
'searchListId': string | null;
|
|
2496
2499
|
'searchList': BaseSearchList | null;
|
|
2500
|
+
'matrixQuestionId': string | null;
|
|
2501
|
+
'matrixSortOrder': number | null;
|
|
2497
2502
|
'mutable': boolean;
|
|
2498
2503
|
'min': string | null;
|
|
2499
2504
|
'max': string | null;
|
|
@@ -5677,8 +5682,9 @@ export interface EventQuestionUpdateInputs {
|
|
|
5677
5682
|
export interface EventRegistration {
|
|
5678
5683
|
'id': string;
|
|
5679
5684
|
'alternateId': number;
|
|
5680
|
-
'accountId': string;
|
|
5681
|
-
'account': BaseAccount;
|
|
5685
|
+
'accountId': string | null;
|
|
5686
|
+
'account': BaseAccount | null;
|
|
5687
|
+
'email': string | null;
|
|
5682
5688
|
'eventId': string;
|
|
5683
5689
|
'event': BaseEvent;
|
|
5684
5690
|
'passes': Array<BaseEventPass>;
|
|
@@ -5863,7 +5869,8 @@ export interface EventRoomTypeReservationPassesInner {
|
|
|
5863
5869
|
|
|
5864
5870
|
export interface EventRoomTypeReservationPassesInnerAttendee {
|
|
5865
5871
|
'id': string;
|
|
5866
|
-
'
|
|
5872
|
+
'alternateId': number;
|
|
5873
|
+
'account': BaseEventPassAttendeeAccount | null;
|
|
5867
5874
|
}
|
|
5868
5875
|
export interface EventRoomTypeReservationUpdateInputs {
|
|
5869
5876
|
'eventRoomTypeId'?: string;
|
|
@@ -10314,11 +10321,14 @@ export interface ImageDirectUpload {
|
|
|
10314
10321
|
'uploadURL': string;
|
|
10315
10322
|
}
|
|
10316
10323
|
export interface ImageDirectUploadInputs {
|
|
10317
|
-
'type':
|
|
10324
|
+
'type': ImageDirectUploadInputsTypeEnum;
|
|
10318
10325
|
'name'?: string | null;
|
|
10319
10326
|
'description'?: string | null;
|
|
10320
10327
|
}
|
|
10321
10328
|
|
|
10329
|
+
export enum ImageDirectUploadInputsTypeEnum {
|
|
10330
|
+
Admin = 'admin'
|
|
10331
|
+
}
|
|
10322
10332
|
|
|
10323
10333
|
|
|
10324
10334
|
export enum ImageModerationLevel {
|
|
@@ -11379,6 +11389,7 @@ export interface Organization {
|
|
|
11379
11389
|
'inviteOnly': boolean;
|
|
11380
11390
|
'googleTagManagerId': string | null;
|
|
11381
11391
|
'googleMapsApiKey': string | null;
|
|
11392
|
+
'turnstileSiteKey': string | null;
|
|
11382
11393
|
'options': object | null;
|
|
11383
11394
|
'modulesOrder': Array<ModulesOrder>;
|
|
11384
11395
|
}
|
|
@@ -11711,6 +11722,8 @@ export interface OrganizationUpdateInputs {
|
|
|
11711
11722
|
'inviteOnly'?: boolean;
|
|
11712
11723
|
'googleTagManagerId'?: string | null;
|
|
11713
11724
|
'googleMapsApiKey'?: string | null;
|
|
11725
|
+
'turnstileSiteKey'?: string | null;
|
|
11726
|
+
'turnstileSecretKey'?: string | null;
|
|
11714
11727
|
'options'?: object | null;
|
|
11715
11728
|
'modulesOrder'?: Array<ModulesOrder>;
|
|
11716
11729
|
}
|
|
@@ -12477,6 +12490,19 @@ export enum ReorderSurveyQuestionChoices200ResponseStatusEnum {
|
|
|
12477
12490
|
Ok = 'ok'
|
|
12478
12491
|
}
|
|
12479
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
|
+
}
|
|
12480
12506
|
export interface ReorderSurveySectionQuestions200Response {
|
|
12481
12507
|
'status': ReorderSurveySectionQuestions200ResponseStatusEnum;
|
|
12482
12508
|
'message': string;
|
|
@@ -13582,6 +13608,8 @@ export interface SurveyQuestion {
|
|
|
13582
13608
|
'default': string | null;
|
|
13583
13609
|
'searchListId': string | null;
|
|
13584
13610
|
'searchList': BaseSearchList | null;
|
|
13611
|
+
'matrixQuestionId': string | null;
|
|
13612
|
+
'matrixSortOrder': number | null;
|
|
13585
13613
|
'mutable': boolean;
|
|
13586
13614
|
'min': string | null;
|
|
13587
13615
|
'max': string | null;
|
|
@@ -13594,6 +13622,7 @@ export interface SurveyQuestion {
|
|
|
13594
13622
|
'choices': Array<BaseSurveyQuestionChoice>;
|
|
13595
13623
|
'sections': Array<BaseSurveySectionQuestion>;
|
|
13596
13624
|
'subQuestionOf': Array<SurveyQuestionChoiceSubQuestion>;
|
|
13625
|
+
'matrixRows'?: Array<BaseSurveyQuestion>;
|
|
13597
13626
|
'dashboardVisibility': boolean;
|
|
13598
13627
|
'createdAt': string;
|
|
13599
13628
|
'updatedAt': string;
|
|
@@ -13658,6 +13687,7 @@ export interface SurveyQuestionCreateInputs {
|
|
|
13658
13687
|
'sectionId'?: string;
|
|
13659
13688
|
'questionId'?: string;
|
|
13660
13689
|
'choiceId'?: string;
|
|
13690
|
+
'matrixQuestionId'?: string;
|
|
13661
13691
|
'required'?: boolean;
|
|
13662
13692
|
'label'?: string | null;
|
|
13663
13693
|
'placeholder'?: string | null;
|
|
@@ -13674,10 +13704,16 @@ export interface SurveyQuestionCreateInputs {
|
|
|
13674
13704
|
'sortOrder'?: number | null;
|
|
13675
13705
|
'featured'?: boolean;
|
|
13676
13706
|
'choices'?: Array<string> | null;
|
|
13707
|
+
'matrixRows'?: Array<string> | null;
|
|
13708
|
+
'matrixRowsType'?: SurveyQuestionCreateInputsMatrixRowsTypeEnum;
|
|
13677
13709
|
'searchListId'?: string | null;
|
|
13678
13710
|
'masked'?: boolean;
|
|
13679
13711
|
}
|
|
13680
13712
|
|
|
13713
|
+
export enum SurveyQuestionCreateInputsMatrixRowsTypeEnum {
|
|
13714
|
+
Radio = 'radio',
|
|
13715
|
+
Checkbox = 'checkbox'
|
|
13716
|
+
}
|
|
13681
13717
|
|
|
13682
13718
|
export interface SurveyQuestionResponse {
|
|
13683
13719
|
'id': string;
|
|
@@ -13726,7 +13762,8 @@ export enum SurveyQuestionType {
|
|
|
13726
13762
|
Checkbox = 'checkbox',
|
|
13727
13763
|
Search = 'search',
|
|
13728
13764
|
File = 'file',
|
|
13729
|
-
Location = 'location'
|
|
13765
|
+
Location = 'location',
|
|
13766
|
+
Matrix = 'matrix'
|
|
13730
13767
|
}
|
|
13731
13768
|
|
|
13732
13769
|
|
|
@@ -13750,8 +13787,13 @@ export interface SurveyQuestionUpdateInputs {
|
|
|
13750
13787
|
'sortOrder'?: number | null;
|
|
13751
13788
|
'featured'?: boolean;
|
|
13752
13789
|
'searchListId'?: string | null;
|
|
13790
|
+
'matrixRowsType'?: SurveyQuestionUpdateInputsMatrixRowsTypeEnum;
|
|
13753
13791
|
}
|
|
13754
13792
|
|
|
13793
|
+
export enum SurveyQuestionUpdateInputsMatrixRowsTypeEnum {
|
|
13794
|
+
Radio = 'radio',
|
|
13795
|
+
Checkbox = 'checkbox'
|
|
13796
|
+
}
|
|
13755
13797
|
|
|
13756
13798
|
export interface SurveySection {
|
|
13757
13799
|
'id': string;
|
|
@@ -73351,7 +73393,7 @@ export class EventsQuestionsTranslationsApi extends BaseAPI {
|
|
|
73351
73393
|
export const EventsRegistrationsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
73352
73394
|
return {
|
|
73353
73395
|
/**
|
|
73354
|
-
* Creates a new registration on an event
|
|
73396
|
+
* Creates a new registration on an event for an existing account; requires read and create permission on attendees.
|
|
73355
73397
|
* @summary Create an event registration
|
|
73356
73398
|
* @param {string} eventId The event identifier
|
|
73357
73399
|
* @param {EventRegistrationCreateInputs} eventRegistrationCreateInputs
|
|
@@ -74026,7 +74068,7 @@ export const EventsRegistrationsApiFp = function(configuration?: Configuration)
|
|
|
74026
74068
|
const localVarAxiosParamCreator = EventsRegistrationsApiAxiosParamCreator(configuration)
|
|
74027
74069
|
return {
|
|
74028
74070
|
/**
|
|
74029
|
-
* Creates a new registration on an event
|
|
74071
|
+
* Creates a new registration on an event for an existing account; requires read and create permission on attendees.
|
|
74030
74072
|
* @summary Create an event registration
|
|
74031
74073
|
* @param {string} eventId The event identifier
|
|
74032
74074
|
* @param {EventRegistrationCreateInputs} eventRegistrationCreateInputs
|
|
@@ -74230,7 +74272,7 @@ export const EventsRegistrationsApiFactory = function (configuration?: Configura
|
|
|
74230
74272
|
const localVarFp = EventsRegistrationsApiFp(configuration)
|
|
74231
74273
|
return {
|
|
74232
74274
|
/**
|
|
74233
|
-
* Creates a new registration on an event
|
|
74275
|
+
* Creates a new registration on an event for an existing account; requires read and create permission on attendees.
|
|
74234
74276
|
* @summary Create an event registration
|
|
74235
74277
|
* @param {EventsRegistrationsApiCreateEventRegistrationRequest} requestParameters Request parameters.
|
|
74236
74278
|
* @param {*} [options] Override http request option.
|
|
@@ -74666,7 +74708,7 @@ export interface EventsRegistrationsApiUpdateEventRegistrationRequest {
|
|
|
74666
74708
|
*/
|
|
74667
74709
|
export class EventsRegistrationsApi extends BaseAPI {
|
|
74668
74710
|
/**
|
|
74669
|
-
* Creates a new registration on an event
|
|
74711
|
+
* Creates a new registration on an event for an existing account; requires read and create permission on attendees.
|
|
74670
74712
|
* @summary Create an event registration
|
|
74671
74713
|
* @param {EventsRegistrationsApiCreateEventRegistrationRequest} requestParameters Request parameters.
|
|
74672
74714
|
* @param {*} [options] Override http request option.
|
|
@@ -142567,6 +142609,70 @@ export const SurveysQuestionsApiAxiosParamCreator = function (configuration?: Co
|
|
|
142567
142609
|
options: localVarRequestOptions,
|
|
142568
142610
|
};
|
|
142569
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
|
+
},
|
|
142570
142676
|
/**
|
|
142571
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.
|
|
142572
142678
|
* @summary List responses to a survey question
|
|
@@ -142845,6 +142951,55 @@ export const SurveysQuestionsApiAxiosParamCreator = function (configuration?: Co
|
|
|
142845
142951
|
options: localVarRequestOptions,
|
|
142846
142952
|
};
|
|
142847
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
|
+
},
|
|
142848
143003
|
/**
|
|
142849
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.
|
|
142850
143005
|
* @summary Update a survey question
|
|
@@ -143183,6 +143338,24 @@ export const SurveysQuestionsApiFp = function(configuration?: Configuration) {
|
|
|
143183
143338
|
const localVarOperationServerBasePath = operationServerMap['SurveysQuestionsApi.getSurveyQuestionChoices']?.[localVarOperationServerIndex]?.url;
|
|
143184
143339
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
143185
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
|
+
},
|
|
143186
143359
|
/**
|
|
143187
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.
|
|
143188
143361
|
* @summary List responses to a survey question
|
|
@@ -143265,6 +143438,21 @@ export const SurveysQuestionsApiFp = function(configuration?: Configuration) {
|
|
|
143265
143438
|
const localVarOperationServerBasePath = operationServerMap['SurveysQuestionsApi.reorderSurveyQuestionChoices']?.[localVarOperationServerIndex]?.url;
|
|
143266
143439
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
143267
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
|
+
},
|
|
143268
143456
|
/**
|
|
143269
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.
|
|
143270
143458
|
* @summary Update a survey question
|
|
@@ -143432,6 +143620,16 @@ export const SurveysQuestionsApiFactory = function (configuration?: Configuratio
|
|
|
143432
143620
|
getSurveyQuestionChoices(requestParameters: SurveysQuestionsApiGetSurveyQuestionChoicesRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetSurveyQuestionChoices200Response> {
|
|
143433
143621
|
return localVarFp.getSurveyQuestionChoices(requestParameters.surveyId, requestParameters.questionId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
143434
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
|
+
},
|
|
143435
143633
|
/**
|
|
143436
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.
|
|
143437
143635
|
* @summary List responses to a survey question
|
|
@@ -143482,6 +143680,16 @@ export const SurveysQuestionsApiFactory = function (configuration?: Configuratio
|
|
|
143482
143680
|
reorderSurveyQuestionChoices(requestParameters: SurveysQuestionsApiReorderSurveyQuestionChoicesRequest, options?: RawAxiosRequestConfig): AxiosPromise<ReorderSurveyQuestionChoices200Response> {
|
|
143483
143681
|
return localVarFp.reorderSurveyQuestionChoices(requestParameters.surveyId, requestParameters.questionId, requestParameters.reorderBookingSpaceQuestionChoicesRequest, options).then((request) => request(axios, basePath));
|
|
143484
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
|
+
},
|
|
143485
143693
|
/**
|
|
143486
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.
|
|
143487
143695
|
* @summary Update a survey question
|
|
@@ -143751,6 +143959,41 @@ export interface SurveysQuestionsApiGetSurveyQuestionChoicesRequest {
|
|
|
143751
143959
|
readonly search?: string
|
|
143752
143960
|
}
|
|
143753
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
|
+
|
|
143754
143997
|
/**
|
|
143755
143998
|
* Request parameters for getSurveyQuestionResponses operation in SurveysQuestionsApi.
|
|
143756
143999
|
*/
|
|
@@ -143880,6 +144123,23 @@ export interface SurveysQuestionsApiReorderSurveyQuestionChoicesRequest {
|
|
|
143880
144123
|
readonly reorderBookingSpaceQuestionChoicesRequest: ReorderBookingSpaceQuestionChoicesRequest
|
|
143881
144124
|
}
|
|
143882
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
|
+
|
|
143883
144143
|
/**
|
|
143884
144144
|
* Request parameters for updateSurveyQuestion operation in SurveysQuestionsApi.
|
|
143885
144145
|
*/
|
|
@@ -144071,6 +144331,17 @@ export class SurveysQuestionsApi extends BaseAPI {
|
|
|
144071
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));
|
|
144072
144332
|
}
|
|
144073
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
|
+
|
|
144074
144345
|
/**
|
|
144075
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.
|
|
144076
144347
|
* @summary List responses to a survey question
|
|
@@ -144126,6 +144397,17 @@ export class SurveysQuestionsApi extends BaseAPI {
|
|
|
144126
144397
|
return SurveysQuestionsApiFp(this.configuration).reorderSurveyQuestionChoices(requestParameters.surveyId, requestParameters.questionId, requestParameters.reorderBookingSpaceQuestionChoicesRequest, options).then((request) => request(this.axios, this.basePath));
|
|
144127
144398
|
}
|
|
144128
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
|
+
|
|
144129
144411
|
/**
|
|
144130
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.
|
|
144131
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:
|
|
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:
|
|
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:
|
|
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).
|