@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/dist/api.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Connected Admin API
|
|
3
3
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document:
|
|
5
|
+
* The version of the OpenAPI document: 10.2.1
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -1098,7 +1098,7 @@ export interface BaseCoupon {
|
|
|
1098
1098
|
'registration': BaseCouponRegistration | null;
|
|
1099
1099
|
}
|
|
1100
1100
|
export interface BaseCouponRegistration {
|
|
1101
|
-
'accountId': string;
|
|
1101
|
+
'accountId': string | null;
|
|
1102
1102
|
}
|
|
1103
1103
|
export interface BaseDashboard {
|
|
1104
1104
|
'id': string;
|
|
@@ -1298,7 +1298,9 @@ export interface BaseEventPass {
|
|
|
1298
1298
|
'updatedAt': string;
|
|
1299
1299
|
}
|
|
1300
1300
|
export interface BaseEventPassAttendee {
|
|
1301
|
-
'
|
|
1301
|
+
'alternateId': number;
|
|
1302
|
+
'email': string | null;
|
|
1303
|
+
'account': BaseEventPassAttendeeAccount | null;
|
|
1302
1304
|
}
|
|
1303
1305
|
export interface BaseEventPassAttendeeAccount {
|
|
1304
1306
|
'id': string;
|
|
@@ -1371,8 +1373,9 @@ export interface BaseEventPassTypeRefundSchedule {
|
|
|
1371
1373
|
export interface BaseEventRegistration {
|
|
1372
1374
|
'id': string;
|
|
1373
1375
|
'alternateId': number;
|
|
1374
|
-
'accountId': string;
|
|
1375
|
-
'account': BaseAccount;
|
|
1376
|
+
'accountId': string | null;
|
|
1377
|
+
'account': BaseAccount | null;
|
|
1378
|
+
'email': string | null;
|
|
1376
1379
|
'eventId': string;
|
|
1377
1380
|
'event': BaseEvent;
|
|
1378
1381
|
}
|
|
@@ -2318,6 +2321,8 @@ export interface BaseSurveyQuestion {
|
|
|
2318
2321
|
'default': string | null;
|
|
2319
2322
|
'searchListId': string | null;
|
|
2320
2323
|
'searchList': BaseSearchList | null;
|
|
2324
|
+
'matrixQuestionId': string | null;
|
|
2325
|
+
'matrixSortOrder': number | null;
|
|
2321
2326
|
'mutable': boolean;
|
|
2322
2327
|
'min': string | null;
|
|
2323
2328
|
'max': string | null;
|
|
@@ -5187,8 +5192,9 @@ export interface EventQuestionUpdateInputs {
|
|
|
5187
5192
|
export interface EventRegistration {
|
|
5188
5193
|
'id': string;
|
|
5189
5194
|
'alternateId': number;
|
|
5190
|
-
'accountId': string;
|
|
5191
|
-
'account': BaseAccount;
|
|
5195
|
+
'accountId': string | null;
|
|
5196
|
+
'account': BaseAccount | null;
|
|
5197
|
+
'email': string | null;
|
|
5192
5198
|
'eventId': string;
|
|
5193
5199
|
'event': BaseEvent;
|
|
5194
5200
|
'passes': Array<BaseEventPass>;
|
|
@@ -5360,7 +5366,8 @@ export interface EventRoomTypeReservationPassesInner {
|
|
|
5360
5366
|
}
|
|
5361
5367
|
export interface EventRoomTypeReservationPassesInnerAttendee {
|
|
5362
5368
|
'id': string;
|
|
5363
|
-
'
|
|
5369
|
+
'alternateId': number;
|
|
5370
|
+
'account': BaseEventPassAttendeeAccount | null;
|
|
5364
5371
|
}
|
|
5365
5372
|
export interface EventRoomTypeReservationUpdateInputs {
|
|
5366
5373
|
'eventRoomTypeId'?: string;
|
|
@@ -9114,10 +9121,13 @@ export interface ImageDirectUpload {
|
|
|
9114
9121
|
'uploadURL': string;
|
|
9115
9122
|
}
|
|
9116
9123
|
export interface ImageDirectUploadInputs {
|
|
9117
|
-
'type':
|
|
9124
|
+
'type': ImageDirectUploadInputsTypeEnum;
|
|
9118
9125
|
'name'?: string | null;
|
|
9119
9126
|
'description'?: string | null;
|
|
9120
9127
|
}
|
|
9128
|
+
export declare enum ImageDirectUploadInputsTypeEnum {
|
|
9129
|
+
Admin = "admin"
|
|
9130
|
+
}
|
|
9121
9131
|
export declare enum ImageModerationLevel {
|
|
9122
9132
|
Safe = "safe",
|
|
9123
9133
|
Warning = "warning"
|
|
@@ -10076,6 +10086,7 @@ export interface Organization {
|
|
|
10076
10086
|
'inviteOnly': boolean;
|
|
10077
10087
|
'googleTagManagerId': string | null;
|
|
10078
10088
|
'googleMapsApiKey': string | null;
|
|
10089
|
+
'turnstileSiteKey': string | null;
|
|
10079
10090
|
'options': object | null;
|
|
10080
10091
|
'modulesOrder': Array<ModulesOrder>;
|
|
10081
10092
|
}
|
|
@@ -10395,6 +10406,8 @@ export interface OrganizationUpdateInputs {
|
|
|
10395
10406
|
'inviteOnly'?: boolean;
|
|
10396
10407
|
'googleTagManagerId'?: string | null;
|
|
10397
10408
|
'googleMapsApiKey'?: string | null;
|
|
10409
|
+
'turnstileSiteKey'?: string | null;
|
|
10410
|
+
'turnstileSecretKey'?: string | null;
|
|
10398
10411
|
'options'?: object | null;
|
|
10399
10412
|
'modulesOrder'?: Array<ModulesOrder>;
|
|
10400
10413
|
}
|
|
@@ -11077,6 +11090,17 @@ export interface ReorderSurveyQuestionChoices200Response {
|
|
|
11077
11090
|
export declare enum ReorderSurveyQuestionChoices200ResponseStatusEnum {
|
|
11078
11091
|
Ok = "ok"
|
|
11079
11092
|
}
|
|
11093
|
+
export interface ReorderSurveyQuestionMatrixRows200Response {
|
|
11094
|
+
'status': ReorderSurveyQuestionMatrixRows200ResponseStatusEnum;
|
|
11095
|
+
'message': string;
|
|
11096
|
+
'data': Array<SurveyQuestion>;
|
|
11097
|
+
}
|
|
11098
|
+
export declare enum ReorderSurveyQuestionMatrixRows200ResponseStatusEnum {
|
|
11099
|
+
Ok = "ok"
|
|
11100
|
+
}
|
|
11101
|
+
export interface ReorderSurveyQuestionMatrixRowsRequest {
|
|
11102
|
+
'rowIds': Array<string>;
|
|
11103
|
+
}
|
|
11080
11104
|
export interface ReorderSurveySectionQuestions200Response {
|
|
11081
11105
|
'status': ReorderSurveySectionQuestions200ResponseStatusEnum;
|
|
11082
11106
|
'message': string;
|
|
@@ -12100,6 +12124,8 @@ export interface SurveyQuestion {
|
|
|
12100
12124
|
'default': string | null;
|
|
12101
12125
|
'searchListId': string | null;
|
|
12102
12126
|
'searchList': BaseSearchList | null;
|
|
12127
|
+
'matrixQuestionId': string | null;
|
|
12128
|
+
'matrixSortOrder': number | null;
|
|
12103
12129
|
'mutable': boolean;
|
|
12104
12130
|
'min': string | null;
|
|
12105
12131
|
'max': string | null;
|
|
@@ -12112,6 +12138,7 @@ export interface SurveyQuestion {
|
|
|
12112
12138
|
'choices': Array<BaseSurveyQuestionChoice>;
|
|
12113
12139
|
'sections': Array<BaseSurveySectionQuestion>;
|
|
12114
12140
|
'subQuestionOf': Array<SurveyQuestionChoiceSubQuestion>;
|
|
12141
|
+
'matrixRows'?: Array<BaseSurveyQuestion>;
|
|
12115
12142
|
'dashboardVisibility': boolean;
|
|
12116
12143
|
'createdAt': string;
|
|
12117
12144
|
'updatedAt': string;
|
|
@@ -12174,6 +12201,7 @@ export interface SurveyQuestionCreateInputs {
|
|
|
12174
12201
|
'sectionId'?: string;
|
|
12175
12202
|
'questionId'?: string;
|
|
12176
12203
|
'choiceId'?: string;
|
|
12204
|
+
'matrixQuestionId'?: string;
|
|
12177
12205
|
'required'?: boolean;
|
|
12178
12206
|
'label'?: string | null;
|
|
12179
12207
|
'placeholder'?: string | null;
|
|
@@ -12190,9 +12218,15 @@ export interface SurveyQuestionCreateInputs {
|
|
|
12190
12218
|
'sortOrder'?: number | null;
|
|
12191
12219
|
'featured'?: boolean;
|
|
12192
12220
|
'choices'?: Array<string> | null;
|
|
12221
|
+
'matrixRows'?: Array<string> | null;
|
|
12222
|
+
'matrixRowsType'?: SurveyQuestionCreateInputsMatrixRowsTypeEnum;
|
|
12193
12223
|
'searchListId'?: string | null;
|
|
12194
12224
|
'masked'?: boolean;
|
|
12195
12225
|
}
|
|
12226
|
+
export declare enum SurveyQuestionCreateInputsMatrixRowsTypeEnum {
|
|
12227
|
+
Radio = "radio",
|
|
12228
|
+
Checkbox = "checkbox"
|
|
12229
|
+
}
|
|
12196
12230
|
export interface SurveyQuestionResponse {
|
|
12197
12231
|
'id': string;
|
|
12198
12232
|
'value': string;
|
|
@@ -12239,7 +12273,8 @@ export declare enum SurveyQuestionType {
|
|
|
12239
12273
|
Checkbox = "checkbox",
|
|
12240
12274
|
Search = "search",
|
|
12241
12275
|
File = "file",
|
|
12242
|
-
Location = "location"
|
|
12276
|
+
Location = "location",
|
|
12277
|
+
Matrix = "matrix"
|
|
12243
12278
|
}
|
|
12244
12279
|
export interface SurveyQuestionUpdateInputs {
|
|
12245
12280
|
'name'?: string | null;
|
|
@@ -12261,6 +12296,11 @@ export interface SurveyQuestionUpdateInputs {
|
|
|
12261
12296
|
'sortOrder'?: number | null;
|
|
12262
12297
|
'featured'?: boolean;
|
|
12263
12298
|
'searchListId'?: string | null;
|
|
12299
|
+
'matrixRowsType'?: SurveyQuestionUpdateInputsMatrixRowsTypeEnum;
|
|
12300
|
+
}
|
|
12301
|
+
export declare enum SurveyQuestionUpdateInputsMatrixRowsTypeEnum {
|
|
12302
|
+
Radio = "radio",
|
|
12303
|
+
Checkbox = "checkbox"
|
|
12264
12304
|
}
|
|
12265
12305
|
export interface SurveySection {
|
|
12266
12306
|
'id': string;
|
|
@@ -42779,7 +42819,7 @@ export declare class EventsQuestionsTranslationsApi extends BaseAPI {
|
|
|
42779
42819
|
*/
|
|
42780
42820
|
export declare const EventsRegistrationsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
42781
42821
|
/**
|
|
42782
|
-
* Creates a new registration on an event
|
|
42822
|
+
* Creates a new registration on an event for an existing account; requires read and create permission on attendees.
|
|
42783
42823
|
* @summary Create an event registration
|
|
42784
42824
|
* @param {string} eventId The event identifier
|
|
42785
42825
|
* @param {EventRegistrationCreateInputs} eventRegistrationCreateInputs
|
|
@@ -42919,7 +42959,7 @@ export declare const EventsRegistrationsApiAxiosParamCreator: (configuration?: C
|
|
|
42919
42959
|
*/
|
|
42920
42960
|
export declare const EventsRegistrationsApiFp: (configuration?: Configuration) => {
|
|
42921
42961
|
/**
|
|
42922
|
-
* Creates a new registration on an event
|
|
42962
|
+
* Creates a new registration on an event for an existing account; requires read and create permission on attendees.
|
|
42923
42963
|
* @summary Create an event registration
|
|
42924
42964
|
* @param {string} eventId The event identifier
|
|
42925
42965
|
* @param {EventRegistrationCreateInputs} eventRegistrationCreateInputs
|
|
@@ -43059,7 +43099,7 @@ export declare const EventsRegistrationsApiFp: (configuration?: Configuration) =
|
|
|
43059
43099
|
*/
|
|
43060
43100
|
export declare const EventsRegistrationsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
43061
43101
|
/**
|
|
43062
|
-
* Creates a new registration on an event
|
|
43102
|
+
* Creates a new registration on an event for an existing account; requires read and create permission on attendees.
|
|
43063
43103
|
* @summary Create an event registration
|
|
43064
43104
|
* @param {EventsRegistrationsApiCreateEventRegistrationRequest} requestParameters Request parameters.
|
|
43065
43105
|
* @param {*} [options] Override http request option.
|
|
@@ -43418,7 +43458,7 @@ export interface EventsRegistrationsApiUpdateEventRegistrationRequest {
|
|
|
43418
43458
|
*/
|
|
43419
43459
|
export declare class EventsRegistrationsApi extends BaseAPI {
|
|
43420
43460
|
/**
|
|
43421
|
-
* Creates a new registration on an event
|
|
43461
|
+
* Creates a new registration on an event for an existing account; requires read and create permission on attendees.
|
|
43422
43462
|
* @summary Create an event registration
|
|
43423
43463
|
* @param {EventsRegistrationsApiCreateEventRegistrationRequest} requestParameters Request parameters.
|
|
43424
43464
|
* @param {*} [options] Override http request option.
|
|
@@ -77519,6 +77559,19 @@ export declare const SurveysQuestionsApiAxiosParamCreator: (configuration?: Conf
|
|
|
77519
77559
|
* @throws {RequiredError}
|
|
77520
77560
|
*/
|
|
77521
77561
|
getSurveyQuestionChoices: (surveyId: string, questionId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
77562
|
+
/**
|
|
77563
|
+
* 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.
|
|
77564
|
+
* @summary List a matrix question\'s rows
|
|
77565
|
+
* @param {string} surveyId The survey identifier
|
|
77566
|
+
* @param {string} questionId The question identifier
|
|
77567
|
+
* @param {number} [page] Page number
|
|
77568
|
+
* @param {number} [pageSize] Number of items per page
|
|
77569
|
+
* @param {string} [orderBy] Field to order by
|
|
77570
|
+
* @param {string} [search] Search query
|
|
77571
|
+
* @param {*} [options] Override http request option.
|
|
77572
|
+
* @throws {RequiredError}
|
|
77573
|
+
*/
|
|
77574
|
+
getSurveyQuestionMatrixRows: (surveyId: string, questionId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
77522
77575
|
/**
|
|
77523
77576
|
* 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.
|
|
77524
77577
|
* @summary List responses to a survey question
|
|
@@ -77576,6 +77629,16 @@ export declare const SurveysQuestionsApiAxiosParamCreator: (configuration?: Conf
|
|
|
77576
77629
|
* @throws {RequiredError}
|
|
77577
77630
|
*/
|
|
77578
77631
|
reorderSurveyQuestionChoices: (surveyId: string, questionId: string, reorderBookingSpaceQuestionChoicesRequest: ReorderBookingSpaceQuestionChoicesRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
77632
|
+
/**
|
|
77633
|
+
* 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.
|
|
77634
|
+
* @summary Reorder a matrix question\'s rows
|
|
77635
|
+
* @param {string} surveyId The survey identifier
|
|
77636
|
+
* @param {string} questionId The question identifier
|
|
77637
|
+
* @param {ReorderSurveyQuestionMatrixRowsRequest} reorderSurveyQuestionMatrixRowsRequest
|
|
77638
|
+
* @param {*} [options] Override http request option.
|
|
77639
|
+
* @throws {RequiredError}
|
|
77640
|
+
*/
|
|
77641
|
+
reorderSurveyQuestionMatrixRows: (surveyId: string, questionId: string, reorderSurveyQuestionMatrixRowsRequest: ReorderSurveyQuestionMatrixRowsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
77579
77642
|
/**
|
|
77580
77643
|
* 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.
|
|
77581
77644
|
* @summary Update a survey question
|
|
@@ -77729,6 +77792,19 @@ export declare const SurveysQuestionsApiFp: (configuration?: Configuration) => {
|
|
|
77729
77792
|
* @throws {RequiredError}
|
|
77730
77793
|
*/
|
|
77731
77794
|
getSurveyQuestionChoices(surveyId: string, questionId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSurveyQuestionChoices200Response>>;
|
|
77795
|
+
/**
|
|
77796
|
+
* 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.
|
|
77797
|
+
* @summary List a matrix question\'s rows
|
|
77798
|
+
* @param {string} surveyId The survey identifier
|
|
77799
|
+
* @param {string} questionId The question identifier
|
|
77800
|
+
* @param {number} [page] Page number
|
|
77801
|
+
* @param {number} [pageSize] Number of items per page
|
|
77802
|
+
* @param {string} [orderBy] Field to order by
|
|
77803
|
+
* @param {string} [search] Search query
|
|
77804
|
+
* @param {*} [options] Override http request option.
|
|
77805
|
+
* @throws {RequiredError}
|
|
77806
|
+
*/
|
|
77807
|
+
getSurveyQuestionMatrixRows(surveyId: string, questionId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSurveyQuestions200Response>>;
|
|
77732
77808
|
/**
|
|
77733
77809
|
* 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.
|
|
77734
77810
|
* @summary List responses to a survey question
|
|
@@ -77786,6 +77862,16 @@ export declare const SurveysQuestionsApiFp: (configuration?: Configuration) => {
|
|
|
77786
77862
|
* @throws {RequiredError}
|
|
77787
77863
|
*/
|
|
77788
77864
|
reorderSurveyQuestionChoices(surveyId: string, questionId: string, reorderBookingSpaceQuestionChoicesRequest: ReorderBookingSpaceQuestionChoicesRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReorderSurveyQuestionChoices200Response>>;
|
|
77865
|
+
/**
|
|
77866
|
+
* 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.
|
|
77867
|
+
* @summary Reorder a matrix question\'s rows
|
|
77868
|
+
* @param {string} surveyId The survey identifier
|
|
77869
|
+
* @param {string} questionId The question identifier
|
|
77870
|
+
* @param {ReorderSurveyQuestionMatrixRowsRequest} reorderSurveyQuestionMatrixRowsRequest
|
|
77871
|
+
* @param {*} [options] Override http request option.
|
|
77872
|
+
* @throws {RequiredError}
|
|
77873
|
+
*/
|
|
77874
|
+
reorderSurveyQuestionMatrixRows(surveyId: string, questionId: string, reorderSurveyQuestionMatrixRowsRequest: ReorderSurveyQuestionMatrixRowsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReorderSurveyQuestionMatrixRows200Response>>;
|
|
77789
77875
|
/**
|
|
77790
77876
|
* 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.
|
|
77791
77877
|
* @summary Update a survey question
|
|
@@ -77912,6 +77998,14 @@ export declare const SurveysQuestionsApiFactory: (configuration?: Configuration,
|
|
|
77912
77998
|
* @throws {RequiredError}
|
|
77913
77999
|
*/
|
|
77914
78000
|
getSurveyQuestionChoices(requestParameters: SurveysQuestionsApiGetSurveyQuestionChoicesRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetSurveyQuestionChoices200Response>;
|
|
78001
|
+
/**
|
|
78002
|
+
* 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.
|
|
78003
|
+
* @summary List a matrix question\'s rows
|
|
78004
|
+
* @param {SurveysQuestionsApiGetSurveyQuestionMatrixRowsRequest} requestParameters Request parameters.
|
|
78005
|
+
* @param {*} [options] Override http request option.
|
|
78006
|
+
* @throws {RequiredError}
|
|
78007
|
+
*/
|
|
78008
|
+
getSurveyQuestionMatrixRows(requestParameters: SurveysQuestionsApiGetSurveyQuestionMatrixRowsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetSurveyQuestions200Response>;
|
|
77915
78009
|
/**
|
|
77916
78010
|
* 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.
|
|
77917
78011
|
* @summary List responses to a survey question
|
|
@@ -77952,6 +78046,14 @@ export declare const SurveysQuestionsApiFactory: (configuration?: Configuration,
|
|
|
77952
78046
|
* @throws {RequiredError}
|
|
77953
78047
|
*/
|
|
77954
78048
|
reorderSurveyQuestionChoices(requestParameters: SurveysQuestionsApiReorderSurveyQuestionChoicesRequest, options?: RawAxiosRequestConfig): AxiosPromise<ReorderSurveyQuestionChoices200Response>;
|
|
78049
|
+
/**
|
|
78050
|
+
* 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.
|
|
78051
|
+
* @summary Reorder a matrix question\'s rows
|
|
78052
|
+
* @param {SurveysQuestionsApiReorderSurveyQuestionMatrixRowsRequest} requestParameters Request parameters.
|
|
78053
|
+
* @param {*} [options] Override http request option.
|
|
78054
|
+
* @throws {RequiredError}
|
|
78055
|
+
*/
|
|
78056
|
+
reorderSurveyQuestionMatrixRows(requestParameters: SurveysQuestionsApiReorderSurveyQuestionMatrixRowsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ReorderSurveyQuestionMatrixRows200Response>;
|
|
77955
78057
|
/**
|
|
77956
78058
|
* 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.
|
|
77957
78059
|
* @summary Update a survey question
|
|
@@ -78175,6 +78277,35 @@ export interface SurveysQuestionsApiGetSurveyQuestionChoicesRequest {
|
|
|
78175
78277
|
*/
|
|
78176
78278
|
readonly search?: string;
|
|
78177
78279
|
}
|
|
78280
|
+
/**
|
|
78281
|
+
* Request parameters for getSurveyQuestionMatrixRows operation in SurveysQuestionsApi.
|
|
78282
|
+
*/
|
|
78283
|
+
export interface SurveysQuestionsApiGetSurveyQuestionMatrixRowsRequest {
|
|
78284
|
+
/**
|
|
78285
|
+
* The survey identifier
|
|
78286
|
+
*/
|
|
78287
|
+
readonly surveyId: string;
|
|
78288
|
+
/**
|
|
78289
|
+
* The question identifier
|
|
78290
|
+
*/
|
|
78291
|
+
readonly questionId: string;
|
|
78292
|
+
/**
|
|
78293
|
+
* Page number
|
|
78294
|
+
*/
|
|
78295
|
+
readonly page?: number;
|
|
78296
|
+
/**
|
|
78297
|
+
* Number of items per page
|
|
78298
|
+
*/
|
|
78299
|
+
readonly pageSize?: number;
|
|
78300
|
+
/**
|
|
78301
|
+
* Field to order by
|
|
78302
|
+
*/
|
|
78303
|
+
readonly orderBy?: string;
|
|
78304
|
+
/**
|
|
78305
|
+
* Search query
|
|
78306
|
+
*/
|
|
78307
|
+
readonly search?: string;
|
|
78308
|
+
}
|
|
78178
78309
|
/**
|
|
78179
78310
|
* Request parameters for getSurveyQuestionResponses operation in SurveysQuestionsApi.
|
|
78180
78311
|
*/
|
|
@@ -78282,6 +78413,20 @@ export interface SurveysQuestionsApiReorderSurveyQuestionChoicesRequest {
|
|
|
78282
78413
|
readonly questionId: string;
|
|
78283
78414
|
readonly reorderBookingSpaceQuestionChoicesRequest: ReorderBookingSpaceQuestionChoicesRequest;
|
|
78284
78415
|
}
|
|
78416
|
+
/**
|
|
78417
|
+
* Request parameters for reorderSurveyQuestionMatrixRows operation in SurveysQuestionsApi.
|
|
78418
|
+
*/
|
|
78419
|
+
export interface SurveysQuestionsApiReorderSurveyQuestionMatrixRowsRequest {
|
|
78420
|
+
/**
|
|
78421
|
+
* The survey identifier
|
|
78422
|
+
*/
|
|
78423
|
+
readonly surveyId: string;
|
|
78424
|
+
/**
|
|
78425
|
+
* The question identifier
|
|
78426
|
+
*/
|
|
78427
|
+
readonly questionId: string;
|
|
78428
|
+
readonly reorderSurveyQuestionMatrixRowsRequest: ReorderSurveyQuestionMatrixRowsRequest;
|
|
78429
|
+
}
|
|
78285
78430
|
/**
|
|
78286
78431
|
* Request parameters for updateSurveyQuestion operation in SurveysQuestionsApi.
|
|
78287
78432
|
*/
|
|
@@ -78428,6 +78573,14 @@ export declare class SurveysQuestionsApi extends BaseAPI {
|
|
|
78428
78573
|
* @throws {RequiredError}
|
|
78429
78574
|
*/
|
|
78430
78575
|
getSurveyQuestionChoices(requestParameters: SurveysQuestionsApiGetSurveyQuestionChoicesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetSurveyQuestionChoices200Response, any, {}>>;
|
|
78576
|
+
/**
|
|
78577
|
+
* 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.
|
|
78578
|
+
* @summary List a matrix question\'s rows
|
|
78579
|
+
* @param {SurveysQuestionsApiGetSurveyQuestionMatrixRowsRequest} requestParameters Request parameters.
|
|
78580
|
+
* @param {*} [options] Override http request option.
|
|
78581
|
+
* @throws {RequiredError}
|
|
78582
|
+
*/
|
|
78583
|
+
getSurveyQuestionMatrixRows(requestParameters: SurveysQuestionsApiGetSurveyQuestionMatrixRowsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetSurveyQuestions200Response, any, {}>>;
|
|
78431
78584
|
/**
|
|
78432
78585
|
* 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.
|
|
78433
78586
|
* @summary List responses to a survey question
|
|
@@ -78468,6 +78621,14 @@ export declare class SurveysQuestionsApi extends BaseAPI {
|
|
|
78468
78621
|
* @throws {RequiredError}
|
|
78469
78622
|
*/
|
|
78470
78623
|
reorderSurveyQuestionChoices(requestParameters: SurveysQuestionsApiReorderSurveyQuestionChoicesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ReorderSurveyQuestionChoices200Response, any, {}>>;
|
|
78624
|
+
/**
|
|
78625
|
+
* 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.
|
|
78626
|
+
* @summary Reorder a matrix question\'s rows
|
|
78627
|
+
* @param {SurveysQuestionsApiReorderSurveyQuestionMatrixRowsRequest} requestParameters Request parameters.
|
|
78628
|
+
* @param {*} [options] Override http request option.
|
|
78629
|
+
* @throws {RequiredError}
|
|
78630
|
+
*/
|
|
78631
|
+
reorderSurveyQuestionMatrixRows(requestParameters: SurveysQuestionsApiReorderSurveyQuestionMatrixRowsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ReorderSurveyQuestionMatrixRows200Response, any, {}>>;
|
|
78471
78632
|
/**
|
|
78472
78633
|
* 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.
|
|
78473
78634
|
* @summary Update a survey question
|