@connectedxm/admin-sdk 10.0.0 → 10.3.0
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 +375 -17
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +205 -11
- package/dist/api.js +297 -32
- 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 +205 -11
- package/dist/esm/api.js +278 -13
- 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/OrganizationPaymentsApi.md +56 -4
- 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/base.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: 10.
|
|
5
|
+
* The version of the OpenAPI document: 10.3.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/base.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* Connected Admin API
|
|
6
6
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 10.
|
|
8
|
+
* The version of the OpenAPI document: 10.3.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/common.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: 10.
|
|
5
|
+
* The version of the OpenAPI document: 10.3.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/common.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* Connected Admin API
|
|
6
6
|
* The Admin API allows you to manage your Connected community programmatically.
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 10.
|
|
8
|
+
* The version of the OpenAPI document: 10.3.0
|
|
9
9
|
*
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/configuration.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: 10.
|
|
5
|
+
* The version of the OpenAPI document: 10.3.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/configuration.js
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.3.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/esm/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: 10.
|
|
5
|
+
* The version of the OpenAPI document: 10.3.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -2321,6 +2321,8 @@ export interface BaseSurveyQuestion {
|
|
|
2321
2321
|
'default': string | null;
|
|
2322
2322
|
'searchListId': string | null;
|
|
2323
2323
|
'searchList': BaseSearchList | null;
|
|
2324
|
+
'matrixQuestionId': string | null;
|
|
2325
|
+
'matrixSortOrder': number | null;
|
|
2324
2326
|
'mutable': boolean;
|
|
2325
2327
|
'min': string | null;
|
|
2326
2328
|
'max': string | null;
|
|
@@ -9119,10 +9121,13 @@ export interface ImageDirectUpload {
|
|
|
9119
9121
|
'uploadURL': string;
|
|
9120
9122
|
}
|
|
9121
9123
|
export interface ImageDirectUploadInputs {
|
|
9122
|
-
'type':
|
|
9124
|
+
'type': ImageDirectUploadInputsTypeEnum;
|
|
9123
9125
|
'name'?: string | null;
|
|
9124
9126
|
'description'?: string | null;
|
|
9125
9127
|
}
|
|
9128
|
+
export declare enum ImageDirectUploadInputsTypeEnum {
|
|
9129
|
+
Admin = "admin"
|
|
9130
|
+
}
|
|
9126
9131
|
export declare enum ImageModerationLevel {
|
|
9127
9132
|
Safe = "safe",
|
|
9128
9133
|
Warning = "warning"
|
|
@@ -11085,6 +11090,17 @@ export interface ReorderSurveyQuestionChoices200Response {
|
|
|
11085
11090
|
export declare enum ReorderSurveyQuestionChoices200ResponseStatusEnum {
|
|
11086
11091
|
Ok = "ok"
|
|
11087
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
|
+
}
|
|
11088
11104
|
export interface ReorderSurveySectionQuestions200Response {
|
|
11089
11105
|
'status': ReorderSurveySectionQuestions200ResponseStatusEnum;
|
|
11090
11106
|
'message': string;
|
|
@@ -12108,6 +12124,8 @@ export interface SurveyQuestion {
|
|
|
12108
12124
|
'default': string | null;
|
|
12109
12125
|
'searchListId': string | null;
|
|
12110
12126
|
'searchList': BaseSearchList | null;
|
|
12127
|
+
'matrixQuestionId': string | null;
|
|
12128
|
+
'matrixSortOrder': number | null;
|
|
12111
12129
|
'mutable': boolean;
|
|
12112
12130
|
'min': string | null;
|
|
12113
12131
|
'max': string | null;
|
|
@@ -12120,6 +12138,7 @@ export interface SurveyQuestion {
|
|
|
12120
12138
|
'choices': Array<BaseSurveyQuestionChoice>;
|
|
12121
12139
|
'sections': Array<BaseSurveySectionQuestion>;
|
|
12122
12140
|
'subQuestionOf': Array<SurveyQuestionChoiceSubQuestion>;
|
|
12141
|
+
'matrixRows'?: Array<BaseSurveyQuestion>;
|
|
12123
12142
|
'dashboardVisibility': boolean;
|
|
12124
12143
|
'createdAt': string;
|
|
12125
12144
|
'updatedAt': string;
|
|
@@ -12182,6 +12201,7 @@ export interface SurveyQuestionCreateInputs {
|
|
|
12182
12201
|
'sectionId'?: string;
|
|
12183
12202
|
'questionId'?: string;
|
|
12184
12203
|
'choiceId'?: string;
|
|
12204
|
+
'matrixQuestionId'?: string;
|
|
12185
12205
|
'required'?: boolean;
|
|
12186
12206
|
'label'?: string | null;
|
|
12187
12207
|
'placeholder'?: string | null;
|
|
@@ -12198,9 +12218,15 @@ export interface SurveyQuestionCreateInputs {
|
|
|
12198
12218
|
'sortOrder'?: number | null;
|
|
12199
12219
|
'featured'?: boolean;
|
|
12200
12220
|
'choices'?: Array<string> | null;
|
|
12221
|
+
'matrixRows'?: Array<string> | null;
|
|
12222
|
+
'matrixRowsType'?: SurveyQuestionCreateInputsMatrixRowsTypeEnum;
|
|
12201
12223
|
'searchListId'?: string | null;
|
|
12202
12224
|
'masked'?: boolean;
|
|
12203
12225
|
}
|
|
12226
|
+
export declare enum SurveyQuestionCreateInputsMatrixRowsTypeEnum {
|
|
12227
|
+
Radio = "radio",
|
|
12228
|
+
Checkbox = "checkbox"
|
|
12229
|
+
}
|
|
12204
12230
|
export interface SurveyQuestionResponse {
|
|
12205
12231
|
'id': string;
|
|
12206
12232
|
'value': string;
|
|
@@ -12247,7 +12273,8 @@ export declare enum SurveyQuestionType {
|
|
|
12247
12273
|
Checkbox = "checkbox",
|
|
12248
12274
|
Search = "search",
|
|
12249
12275
|
File = "file",
|
|
12250
|
-
Location = "location"
|
|
12276
|
+
Location = "location",
|
|
12277
|
+
Matrix = "matrix"
|
|
12251
12278
|
}
|
|
12252
12279
|
export interface SurveyQuestionUpdateInputs {
|
|
12253
12280
|
'name'?: string | null;
|
|
@@ -12269,6 +12296,11 @@ export interface SurveyQuestionUpdateInputs {
|
|
|
12269
12296
|
'sortOrder'?: number | null;
|
|
12270
12297
|
'featured'?: boolean;
|
|
12271
12298
|
'searchListId'?: string | null;
|
|
12299
|
+
'matrixRowsType'?: SurveyQuestionUpdateInputsMatrixRowsTypeEnum;
|
|
12300
|
+
}
|
|
12301
|
+
export declare enum SurveyQuestionUpdateInputsMatrixRowsTypeEnum {
|
|
12302
|
+
Radio = "radio",
|
|
12303
|
+
Checkbox = "checkbox"
|
|
12272
12304
|
}
|
|
12273
12305
|
export interface SurveySection {
|
|
12274
12306
|
'id': string;
|
|
@@ -67685,7 +67717,15 @@ export declare const OrganizationPaymentsApiAxiosParamCreator: (configuration?:
|
|
|
67685
67717
|
* @param {*} [options] Override http request option.
|
|
67686
67718
|
* @throws {RequiredError}
|
|
67687
67719
|
*/
|
|
67688
|
-
|
|
67720
|
+
refundPayment: (paymentId: string, refundLineItem: Array<RefundLineItem>, eventId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
67721
|
+
/**
|
|
67722
|
+
* Queues a receipt email to the account on the payment, itemized with every line item and net of any refunds, for an attendee who needs one for tax or reimbursement purposes; only captured charges are eligible, and requires read and update permissions on payments.
|
|
67723
|
+
* @summary Email a receipt for a payment
|
|
67724
|
+
* @param {string} paymentId The payment identifier
|
|
67725
|
+
* @param {*} [options] Override http request option.
|
|
67726
|
+
* @throws {RequiredError}
|
|
67727
|
+
*/
|
|
67728
|
+
sendPaymentReceipt: (paymentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
67689
67729
|
/**
|
|
67690
67730
|
* Toggles the specified payment integration, identified by integrationId, to be the organization\'s default payment integration, requiring update permission on the org resource.
|
|
67691
67731
|
* @summary Set an organization payment integration as default
|
|
@@ -67779,7 +67819,15 @@ export declare const OrganizationPaymentsApiFp: (configuration?: Configuration)
|
|
|
67779
67819
|
* @param {*} [options] Override http request option.
|
|
67780
67820
|
* @throws {RequiredError}
|
|
67781
67821
|
*/
|
|
67782
|
-
|
|
67822
|
+
refundPayment(paymentId: string, refundLineItem: Array<RefundLineItem>, eventId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPayment200Response>>;
|
|
67823
|
+
/**
|
|
67824
|
+
* Queues a receipt email to the account on the payment, itemized with every line item and net of any refunds, for an attendee who needs one for tax or reimbursement purposes; only captured charges are eligible, and requires read and update permissions on payments.
|
|
67825
|
+
* @summary Email a receipt for a payment
|
|
67826
|
+
* @param {string} paymentId The payment identifier
|
|
67827
|
+
* @param {*} [options] Override http request option.
|
|
67828
|
+
* @throws {RequiredError}
|
|
67829
|
+
*/
|
|
67830
|
+
sendPaymentReceipt(paymentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAccountInvitations200Response>>;
|
|
67783
67831
|
/**
|
|
67784
67832
|
* Toggles the specified payment integration, identified by integrationId, to be the organization\'s default payment integration, requiring update permission on the org resource.
|
|
67785
67833
|
* @summary Set an organization payment integration as default
|
|
@@ -67861,11 +67909,19 @@ export declare const OrganizationPaymentsApiFactory: (configuration?: Configurat
|
|
|
67861
67909
|
/**
|
|
67862
67910
|
* Issues a refund for one or more line items on the specified payment, identified by paymentId, requiring update permission on the payments resource; at least one line item with a positive amount must be provided.
|
|
67863
67911
|
* @summary Refund line items on a payment
|
|
67864
|
-
* @param {
|
|
67912
|
+
* @param {OrganizationPaymentsApiRefundPaymentRequest} requestParameters Request parameters.
|
|
67865
67913
|
* @param {*} [options] Override http request option.
|
|
67866
67914
|
* @throws {RequiredError}
|
|
67867
67915
|
*/
|
|
67868
|
-
|
|
67916
|
+
refundPayment(requestParameters: OrganizationPaymentsApiRefundPaymentRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetPayment200Response>;
|
|
67917
|
+
/**
|
|
67918
|
+
* Queues a receipt email to the account on the payment, itemized with every line item and net of any refunds, for an attendee who needs one for tax or reimbursement purposes; only captured charges are eligible, and requires read and update permissions on payments.
|
|
67919
|
+
* @summary Email a receipt for a payment
|
|
67920
|
+
* @param {OrganizationPaymentsApiSendPaymentReceiptRequest} requestParameters Request parameters.
|
|
67921
|
+
* @param {*} [options] Override http request option.
|
|
67922
|
+
* @throws {RequiredError}
|
|
67923
|
+
*/
|
|
67924
|
+
sendPaymentReceipt(requestParameters: OrganizationPaymentsApiSendPaymentReceiptRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAccountInvitations200Response>;
|
|
67869
67925
|
/**
|
|
67870
67926
|
* Toggles the specified payment integration, identified by integrationId, to be the organization\'s default payment integration, requiring update permission on the org resource.
|
|
67871
67927
|
* @summary Set an organization payment integration as default
|
|
@@ -67968,9 +68024,9 @@ export interface OrganizationPaymentsApiGetPaymentsRequest {
|
|
|
67968
68024
|
readonly search?: string;
|
|
67969
68025
|
}
|
|
67970
68026
|
/**
|
|
67971
|
-
* Request parameters for
|
|
68027
|
+
* Request parameters for refundPayment operation in OrganizationPaymentsApi.
|
|
67972
68028
|
*/
|
|
67973
|
-
export interface
|
|
68029
|
+
export interface OrganizationPaymentsApiRefundPaymentRequest {
|
|
67974
68030
|
/**
|
|
67975
68031
|
* The payment identifier
|
|
67976
68032
|
*/
|
|
@@ -67981,6 +68037,15 @@ export interface OrganizationPaymentsApiRefundOrganizationPaymentRequest {
|
|
|
67981
68037
|
*/
|
|
67982
68038
|
readonly eventId?: string;
|
|
67983
68039
|
}
|
|
68040
|
+
/**
|
|
68041
|
+
* Request parameters for sendPaymentReceipt operation in OrganizationPaymentsApi.
|
|
68042
|
+
*/
|
|
68043
|
+
export interface OrganizationPaymentsApiSendPaymentReceiptRequest {
|
|
68044
|
+
/**
|
|
68045
|
+
* The payment identifier
|
|
68046
|
+
*/
|
|
68047
|
+
readonly paymentId: string;
|
|
68048
|
+
}
|
|
67984
68049
|
/**
|
|
67985
68050
|
* Request parameters for toggleOrganizationPaymentIntegration operation in OrganizationPaymentsApi.
|
|
67986
68051
|
*/
|
|
@@ -68063,11 +68128,19 @@ export declare class OrganizationPaymentsApi extends BaseAPI {
|
|
|
68063
68128
|
/**
|
|
68064
68129
|
* Issues a refund for one or more line items on the specified payment, identified by paymentId, requiring update permission on the payments resource; at least one line item with a positive amount must be provided.
|
|
68065
68130
|
* @summary Refund line items on a payment
|
|
68066
|
-
* @param {
|
|
68131
|
+
* @param {OrganizationPaymentsApiRefundPaymentRequest} requestParameters Request parameters.
|
|
68132
|
+
* @param {*} [options] Override http request option.
|
|
68133
|
+
* @throws {RequiredError}
|
|
68134
|
+
*/
|
|
68135
|
+
refundPayment(requestParameters: OrganizationPaymentsApiRefundPaymentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPayment200Response, any, {}>>;
|
|
68136
|
+
/**
|
|
68137
|
+
* Queues a receipt email to the account on the payment, itemized with every line item and net of any refunds, for an attendee who needs one for tax or reimbursement purposes; only captured charges are eligible, and requires read and update permissions on payments.
|
|
68138
|
+
* @summary Email a receipt for a payment
|
|
68139
|
+
* @param {OrganizationPaymentsApiSendPaymentReceiptRequest} requestParameters Request parameters.
|
|
68067
68140
|
* @param {*} [options] Override http request option.
|
|
68068
68141
|
* @throws {RequiredError}
|
|
68069
68142
|
*/
|
|
68070
|
-
|
|
68143
|
+
sendPaymentReceipt(requestParameters: OrganizationPaymentsApiSendPaymentReceiptRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateAccountInvitations200Response, any, {}>>;
|
|
68071
68144
|
/**
|
|
68072
68145
|
* Toggles the specified payment integration, identified by integrationId, to be the organization\'s default payment integration, requiring update permission on the org resource.
|
|
68073
68146
|
* @summary Set an organization payment integration as default
|
|
@@ -77527,6 +77600,19 @@ export declare const SurveysQuestionsApiAxiosParamCreator: (configuration?: Conf
|
|
|
77527
77600
|
* @throws {RequiredError}
|
|
77528
77601
|
*/
|
|
77529
77602
|
getSurveyQuestionChoices: (surveyId: string, questionId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
77603
|
+
/**
|
|
77604
|
+
* 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.
|
|
77605
|
+
* @summary List a matrix question\'s rows
|
|
77606
|
+
* @param {string} surveyId The survey identifier
|
|
77607
|
+
* @param {string} questionId The question identifier
|
|
77608
|
+
* @param {number} [page] Page number
|
|
77609
|
+
* @param {number} [pageSize] Number of items per page
|
|
77610
|
+
* @param {string} [orderBy] Field to order by
|
|
77611
|
+
* @param {string} [search] Search query
|
|
77612
|
+
* @param {*} [options] Override http request option.
|
|
77613
|
+
* @throws {RequiredError}
|
|
77614
|
+
*/
|
|
77615
|
+
getSurveyQuestionMatrixRows: (surveyId: string, questionId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
77530
77616
|
/**
|
|
77531
77617
|
* 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.
|
|
77532
77618
|
* @summary List responses to a survey question
|
|
@@ -77584,6 +77670,16 @@ export declare const SurveysQuestionsApiAxiosParamCreator: (configuration?: Conf
|
|
|
77584
77670
|
* @throws {RequiredError}
|
|
77585
77671
|
*/
|
|
77586
77672
|
reorderSurveyQuestionChoices: (surveyId: string, questionId: string, reorderBookingSpaceQuestionChoicesRequest: ReorderBookingSpaceQuestionChoicesRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
77673
|
+
/**
|
|
77674
|
+
* 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.
|
|
77675
|
+
* @summary Reorder a matrix question\'s rows
|
|
77676
|
+
* @param {string} surveyId The survey identifier
|
|
77677
|
+
* @param {string} questionId The question identifier
|
|
77678
|
+
* @param {ReorderSurveyQuestionMatrixRowsRequest} reorderSurveyQuestionMatrixRowsRequest
|
|
77679
|
+
* @param {*} [options] Override http request option.
|
|
77680
|
+
* @throws {RequiredError}
|
|
77681
|
+
*/
|
|
77682
|
+
reorderSurveyQuestionMatrixRows: (surveyId: string, questionId: string, reorderSurveyQuestionMatrixRowsRequest: ReorderSurveyQuestionMatrixRowsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
77587
77683
|
/**
|
|
77588
77684
|
* 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.
|
|
77589
77685
|
* @summary Update a survey question
|
|
@@ -77737,6 +77833,19 @@ export declare const SurveysQuestionsApiFp: (configuration?: Configuration) => {
|
|
|
77737
77833
|
* @throws {RequiredError}
|
|
77738
77834
|
*/
|
|
77739
77835
|
getSurveyQuestionChoices(surveyId: string, questionId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSurveyQuestionChoices200Response>>;
|
|
77836
|
+
/**
|
|
77837
|
+
* 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.
|
|
77838
|
+
* @summary List a matrix question\'s rows
|
|
77839
|
+
* @param {string} surveyId The survey identifier
|
|
77840
|
+
* @param {string} questionId The question identifier
|
|
77841
|
+
* @param {number} [page] Page number
|
|
77842
|
+
* @param {number} [pageSize] Number of items per page
|
|
77843
|
+
* @param {string} [orderBy] Field to order by
|
|
77844
|
+
* @param {string} [search] Search query
|
|
77845
|
+
* @param {*} [options] Override http request option.
|
|
77846
|
+
* @throws {RequiredError}
|
|
77847
|
+
*/
|
|
77848
|
+
getSurveyQuestionMatrixRows(surveyId: string, questionId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSurveyQuestions200Response>>;
|
|
77740
77849
|
/**
|
|
77741
77850
|
* 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.
|
|
77742
77851
|
* @summary List responses to a survey question
|
|
@@ -77794,6 +77903,16 @@ export declare const SurveysQuestionsApiFp: (configuration?: Configuration) => {
|
|
|
77794
77903
|
* @throws {RequiredError}
|
|
77795
77904
|
*/
|
|
77796
77905
|
reorderSurveyQuestionChoices(surveyId: string, questionId: string, reorderBookingSpaceQuestionChoicesRequest: ReorderBookingSpaceQuestionChoicesRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReorderSurveyQuestionChoices200Response>>;
|
|
77906
|
+
/**
|
|
77907
|
+
* 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.
|
|
77908
|
+
* @summary Reorder a matrix question\'s rows
|
|
77909
|
+
* @param {string} surveyId The survey identifier
|
|
77910
|
+
* @param {string} questionId The question identifier
|
|
77911
|
+
* @param {ReorderSurveyQuestionMatrixRowsRequest} reorderSurveyQuestionMatrixRowsRequest
|
|
77912
|
+
* @param {*} [options] Override http request option.
|
|
77913
|
+
* @throws {RequiredError}
|
|
77914
|
+
*/
|
|
77915
|
+
reorderSurveyQuestionMatrixRows(surveyId: string, questionId: string, reorderSurveyQuestionMatrixRowsRequest: ReorderSurveyQuestionMatrixRowsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReorderSurveyQuestionMatrixRows200Response>>;
|
|
77797
77916
|
/**
|
|
77798
77917
|
* 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.
|
|
77799
77918
|
* @summary Update a survey question
|
|
@@ -77920,6 +78039,14 @@ export declare const SurveysQuestionsApiFactory: (configuration?: Configuration,
|
|
|
77920
78039
|
* @throws {RequiredError}
|
|
77921
78040
|
*/
|
|
77922
78041
|
getSurveyQuestionChoices(requestParameters: SurveysQuestionsApiGetSurveyQuestionChoicesRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetSurveyQuestionChoices200Response>;
|
|
78042
|
+
/**
|
|
78043
|
+
* 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.
|
|
78044
|
+
* @summary List a matrix question\'s rows
|
|
78045
|
+
* @param {SurveysQuestionsApiGetSurveyQuestionMatrixRowsRequest} requestParameters Request parameters.
|
|
78046
|
+
* @param {*} [options] Override http request option.
|
|
78047
|
+
* @throws {RequiredError}
|
|
78048
|
+
*/
|
|
78049
|
+
getSurveyQuestionMatrixRows(requestParameters: SurveysQuestionsApiGetSurveyQuestionMatrixRowsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetSurveyQuestions200Response>;
|
|
77923
78050
|
/**
|
|
77924
78051
|
* 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.
|
|
77925
78052
|
* @summary List responses to a survey question
|
|
@@ -77960,6 +78087,14 @@ export declare const SurveysQuestionsApiFactory: (configuration?: Configuration,
|
|
|
77960
78087
|
* @throws {RequiredError}
|
|
77961
78088
|
*/
|
|
77962
78089
|
reorderSurveyQuestionChoices(requestParameters: SurveysQuestionsApiReorderSurveyQuestionChoicesRequest, options?: RawAxiosRequestConfig): AxiosPromise<ReorderSurveyQuestionChoices200Response>;
|
|
78090
|
+
/**
|
|
78091
|
+
* 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.
|
|
78092
|
+
* @summary Reorder a matrix question\'s rows
|
|
78093
|
+
* @param {SurveysQuestionsApiReorderSurveyQuestionMatrixRowsRequest} requestParameters Request parameters.
|
|
78094
|
+
* @param {*} [options] Override http request option.
|
|
78095
|
+
* @throws {RequiredError}
|
|
78096
|
+
*/
|
|
78097
|
+
reorderSurveyQuestionMatrixRows(requestParameters: SurveysQuestionsApiReorderSurveyQuestionMatrixRowsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ReorderSurveyQuestionMatrixRows200Response>;
|
|
77963
78098
|
/**
|
|
77964
78099
|
* 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.
|
|
77965
78100
|
* @summary Update a survey question
|
|
@@ -78183,6 +78318,35 @@ export interface SurveysQuestionsApiGetSurveyQuestionChoicesRequest {
|
|
|
78183
78318
|
*/
|
|
78184
78319
|
readonly search?: string;
|
|
78185
78320
|
}
|
|
78321
|
+
/**
|
|
78322
|
+
* Request parameters for getSurveyQuestionMatrixRows operation in SurveysQuestionsApi.
|
|
78323
|
+
*/
|
|
78324
|
+
export interface SurveysQuestionsApiGetSurveyQuestionMatrixRowsRequest {
|
|
78325
|
+
/**
|
|
78326
|
+
* The survey identifier
|
|
78327
|
+
*/
|
|
78328
|
+
readonly surveyId: string;
|
|
78329
|
+
/**
|
|
78330
|
+
* The question identifier
|
|
78331
|
+
*/
|
|
78332
|
+
readonly questionId: string;
|
|
78333
|
+
/**
|
|
78334
|
+
* Page number
|
|
78335
|
+
*/
|
|
78336
|
+
readonly page?: number;
|
|
78337
|
+
/**
|
|
78338
|
+
* Number of items per page
|
|
78339
|
+
*/
|
|
78340
|
+
readonly pageSize?: number;
|
|
78341
|
+
/**
|
|
78342
|
+
* Field to order by
|
|
78343
|
+
*/
|
|
78344
|
+
readonly orderBy?: string;
|
|
78345
|
+
/**
|
|
78346
|
+
* Search query
|
|
78347
|
+
*/
|
|
78348
|
+
readonly search?: string;
|
|
78349
|
+
}
|
|
78186
78350
|
/**
|
|
78187
78351
|
* Request parameters for getSurveyQuestionResponses operation in SurveysQuestionsApi.
|
|
78188
78352
|
*/
|
|
@@ -78290,6 +78454,20 @@ export interface SurveysQuestionsApiReorderSurveyQuestionChoicesRequest {
|
|
|
78290
78454
|
readonly questionId: string;
|
|
78291
78455
|
readonly reorderBookingSpaceQuestionChoicesRequest: ReorderBookingSpaceQuestionChoicesRequest;
|
|
78292
78456
|
}
|
|
78457
|
+
/**
|
|
78458
|
+
* Request parameters for reorderSurveyQuestionMatrixRows operation in SurveysQuestionsApi.
|
|
78459
|
+
*/
|
|
78460
|
+
export interface SurveysQuestionsApiReorderSurveyQuestionMatrixRowsRequest {
|
|
78461
|
+
/**
|
|
78462
|
+
* The survey identifier
|
|
78463
|
+
*/
|
|
78464
|
+
readonly surveyId: string;
|
|
78465
|
+
/**
|
|
78466
|
+
* The question identifier
|
|
78467
|
+
*/
|
|
78468
|
+
readonly questionId: string;
|
|
78469
|
+
readonly reorderSurveyQuestionMatrixRowsRequest: ReorderSurveyQuestionMatrixRowsRequest;
|
|
78470
|
+
}
|
|
78293
78471
|
/**
|
|
78294
78472
|
* Request parameters for updateSurveyQuestion operation in SurveysQuestionsApi.
|
|
78295
78473
|
*/
|
|
@@ -78436,6 +78614,14 @@ export declare class SurveysQuestionsApi extends BaseAPI {
|
|
|
78436
78614
|
* @throws {RequiredError}
|
|
78437
78615
|
*/
|
|
78438
78616
|
getSurveyQuestionChoices(requestParameters: SurveysQuestionsApiGetSurveyQuestionChoicesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetSurveyQuestionChoices200Response, any, {}>>;
|
|
78617
|
+
/**
|
|
78618
|
+
* 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.
|
|
78619
|
+
* @summary List a matrix question\'s rows
|
|
78620
|
+
* @param {SurveysQuestionsApiGetSurveyQuestionMatrixRowsRequest} requestParameters Request parameters.
|
|
78621
|
+
* @param {*} [options] Override http request option.
|
|
78622
|
+
* @throws {RequiredError}
|
|
78623
|
+
*/
|
|
78624
|
+
getSurveyQuestionMatrixRows(requestParameters: SurveysQuestionsApiGetSurveyQuestionMatrixRowsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetSurveyQuestions200Response, any, {}>>;
|
|
78439
78625
|
/**
|
|
78440
78626
|
* 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.
|
|
78441
78627
|
* @summary List responses to a survey question
|
|
@@ -78476,6 +78662,14 @@ export declare class SurveysQuestionsApi extends BaseAPI {
|
|
|
78476
78662
|
* @throws {RequiredError}
|
|
78477
78663
|
*/
|
|
78478
78664
|
reorderSurveyQuestionChoices(requestParameters: SurveysQuestionsApiReorderSurveyQuestionChoicesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ReorderSurveyQuestionChoices200Response, any, {}>>;
|
|
78665
|
+
/**
|
|
78666
|
+
* 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.
|
|
78667
|
+
* @summary Reorder a matrix question\'s rows
|
|
78668
|
+
* @param {SurveysQuestionsApiReorderSurveyQuestionMatrixRowsRequest} requestParameters Request parameters.
|
|
78669
|
+
* @param {*} [options] Override http request option.
|
|
78670
|
+
* @throws {RequiredError}
|
|
78671
|
+
*/
|
|
78672
|
+
reorderSurveyQuestionMatrixRows(requestParameters: SurveysQuestionsApiReorderSurveyQuestionMatrixRowsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ReorderSurveyQuestionMatrixRows200Response, any, {}>>;
|
|
78479
78673
|
/**
|
|
78480
78674
|
* 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.
|
|
78481
78675
|
* @summary Update a survey question
|