@connectedxm/admin-sdk 10.0.0 → 10.2.1

package/dist/api.d.ts

@@ -2,7 +2,7 @@
  * Connected Admin API
  * The Admin API allows you to manage your Connected community programmatically.
  *
- * The version of the OpenAPI document: 10.0.0
+ * The version of the OpenAPI document: 10.2.1
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2321,6 +2321,8 @@ export interface BaseSurveyQuestion {
     'default': string | null;
     'searchListId': string | null;
     'searchList': BaseSearchList | null;
+    'matrixQuestionId': string | null;
+    'matrixSortOrder': number | null;
     'mutable': boolean;
     'min': string | null;
     'max': string | null;
@@ -9119,10 +9121,13 @@ export interface ImageDirectUpload {
     'uploadURL': string;
 }
 export interface ImageDirectUploadInputs {
-    'type': ImageType;
+    'type': ImageDirectUploadInputsTypeEnum;
     'name'?: string | null;
     'description'?: string | null;
 }
+export declare enum ImageDirectUploadInputsTypeEnum {
+    Admin = "admin"
+}
 export declare enum ImageModerationLevel {
     Safe = "safe",
     Warning = "warning"
@@ -11085,6 +11090,17 @@ export interface ReorderSurveyQuestionChoices200Response {
 export declare enum ReorderSurveyQuestionChoices200ResponseStatusEnum {
     Ok = "ok"
 }
+export interface ReorderSurveyQuestionMatrixRows200Response {
+    'status': ReorderSurveyQuestionMatrixRows200ResponseStatusEnum;
+    'message': string;
+    'data': Array<SurveyQuestion>;
+}
+export declare enum ReorderSurveyQuestionMatrixRows200ResponseStatusEnum {
+    Ok = "ok"
+}
+export interface ReorderSurveyQuestionMatrixRowsRequest {
+    'rowIds': Array<string>;
+}
 export interface ReorderSurveySectionQuestions200Response {
     'status': ReorderSurveySectionQuestions200ResponseStatusEnum;
     'message': string;
@@ -12108,6 +12124,8 @@ export interface SurveyQuestion {
     'default': string | null;
     'searchListId': string | null;
     'searchList': BaseSearchList | null;
+    'matrixQuestionId': string | null;
+    'matrixSortOrder': number | null;
     'mutable': boolean;
     'min': string | null;
     'max': string | null;
@@ -12120,6 +12138,7 @@ export interface SurveyQuestion {
     'choices': Array<BaseSurveyQuestionChoice>;
     'sections': Array<BaseSurveySectionQuestion>;
     'subQuestionOf': Array<SurveyQuestionChoiceSubQuestion>;
+    'matrixRows'?: Array<BaseSurveyQuestion>;
     'dashboardVisibility': boolean;
     'createdAt': string;
     'updatedAt': string;
@@ -12182,6 +12201,7 @@ export interface SurveyQuestionCreateInputs {
     'sectionId'?: string;
     'questionId'?: string;
     'choiceId'?: string;
+    'matrixQuestionId'?: string;
     'required'?: boolean;
     'label'?: string | null;
     'placeholder'?: string | null;
@@ -12198,9 +12218,15 @@ export interface SurveyQuestionCreateInputs {
     'sortOrder'?: number | null;
     'featured'?: boolean;
     'choices'?: Array<string> | null;
+    'matrixRows'?: Array<string> | null;
+    'matrixRowsType'?: SurveyQuestionCreateInputsMatrixRowsTypeEnum;
     'searchListId'?: string | null;
     'masked'?: boolean;
 }
+export declare enum SurveyQuestionCreateInputsMatrixRowsTypeEnum {
+    Radio = "radio",
+    Checkbox = "checkbox"
+}
 export interface SurveyQuestionResponse {
     'id': string;
     'value': string;
@@ -12247,7 +12273,8 @@ export declare enum SurveyQuestionType {
     Checkbox = "checkbox",
     Search = "search",
     File = "file",
-    Location = "location"
+    Location = "location",
+    Matrix = "matrix"
 }
 export interface SurveyQuestionUpdateInputs {
     'name'?: string | null;
@@ -12269,6 +12296,11 @@ export interface SurveyQuestionUpdateInputs {
     'sortOrder'?: number | null;
     'featured'?: boolean;
     'searchListId'?: string | null;
+    'matrixRowsType'?: SurveyQuestionUpdateInputsMatrixRowsTypeEnum;
+}
+export declare enum SurveyQuestionUpdateInputsMatrixRowsTypeEnum {
+    Radio = "radio",
+    Checkbox = "checkbox"
 }
 export interface SurveySection {
     'id': string;
@@ -77527,6 +77559,19 @@ export declare const SurveysQuestionsApiAxiosParamCreator: (configuration?: Conf
      * @throws {RequiredError}
      */
     getSurveyQuestionChoices: (surveyId: string, questionId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * 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.
+     * @summary List a matrix question\'s rows
+     * @param {string} surveyId The survey identifier
+     * @param {string} questionId The question identifier
+     * @param {number} [page] Page number
+     * @param {number} [pageSize] Number of items per page
+     * @param {string} [orderBy] Field to order by
+     * @param {string} [search] Search query
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getSurveyQuestionMatrixRows: (surveyId: string, questionId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * 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.
      * @summary List responses to a survey question
@@ -77584,6 +77629,16 @@ export declare const SurveysQuestionsApiAxiosParamCreator: (configuration?: Conf
      * @throws {RequiredError}
      */
     reorderSurveyQuestionChoices: (surveyId: string, questionId: string, reorderBookingSpaceQuestionChoicesRequest: ReorderBookingSpaceQuestionChoicesRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * 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.
+     * @summary Reorder a matrix question\'s rows
+     * @param {string} surveyId The survey identifier
+     * @param {string} questionId The question identifier
+     * @param {ReorderSurveyQuestionMatrixRowsRequest} reorderSurveyQuestionMatrixRowsRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    reorderSurveyQuestionMatrixRows: (surveyId: string, questionId: string, reorderSurveyQuestionMatrixRowsRequest: ReorderSurveyQuestionMatrixRowsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * 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.
      * @summary Update a survey question
@@ -77737,6 +77792,19 @@ export declare const SurveysQuestionsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getSurveyQuestionChoices(surveyId: string, questionId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSurveyQuestionChoices200Response>>;
+    /**
+     * 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.
+     * @summary List a matrix question\'s rows
+     * @param {string} surveyId The survey identifier
+     * @param {string} questionId The question identifier
+     * @param {number} [page] Page number
+     * @param {number} [pageSize] Number of items per page
+     * @param {string} [orderBy] Field to order by
+     * @param {string} [search] Search query
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getSurveyQuestionMatrixRows(surveyId: string, questionId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSurveyQuestions200Response>>;
     /**
      * 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.
      * @summary List responses to a survey question
@@ -77794,6 +77862,16 @@ export declare const SurveysQuestionsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     reorderSurveyQuestionChoices(surveyId: string, questionId: string, reorderBookingSpaceQuestionChoicesRequest: ReorderBookingSpaceQuestionChoicesRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReorderSurveyQuestionChoices200Response>>;
+    /**
+     * 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.
+     * @summary Reorder a matrix question\'s rows
+     * @param {string} surveyId The survey identifier
+     * @param {string} questionId The question identifier
+     * @param {ReorderSurveyQuestionMatrixRowsRequest} reorderSurveyQuestionMatrixRowsRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    reorderSurveyQuestionMatrixRows(surveyId: string, questionId: string, reorderSurveyQuestionMatrixRowsRequest: ReorderSurveyQuestionMatrixRowsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReorderSurveyQuestionMatrixRows200Response>>;
     /**
      * 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.
      * @summary Update a survey question
@@ -77920,6 +77998,14 @@ export declare const SurveysQuestionsApiFactory: (configuration?: Configuration,
      * @throws {RequiredError}
      */
     getSurveyQuestionChoices(requestParameters: SurveysQuestionsApiGetSurveyQuestionChoicesRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetSurveyQuestionChoices200Response>;
+    /**
+     * 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.
+     * @summary List a matrix question\'s rows
+     * @param {SurveysQuestionsApiGetSurveyQuestionMatrixRowsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getSurveyQuestionMatrixRows(requestParameters: SurveysQuestionsApiGetSurveyQuestionMatrixRowsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetSurveyQuestions200Response>;
     /**
      * 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.
      * @summary List responses to a survey question
@@ -77960,6 +78046,14 @@ export declare const SurveysQuestionsApiFactory: (configuration?: Configuration,
      * @throws {RequiredError}
      */
     reorderSurveyQuestionChoices(requestParameters: SurveysQuestionsApiReorderSurveyQuestionChoicesRequest, options?: RawAxiosRequestConfig): AxiosPromise<ReorderSurveyQuestionChoices200Response>;
+    /**
+     * 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.
+     * @summary Reorder a matrix question\'s rows
+     * @param {SurveysQuestionsApiReorderSurveyQuestionMatrixRowsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    reorderSurveyQuestionMatrixRows(requestParameters: SurveysQuestionsApiReorderSurveyQuestionMatrixRowsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ReorderSurveyQuestionMatrixRows200Response>;
     /**
      * 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.
      * @summary Update a survey question
@@ -78183,6 +78277,35 @@ export interface SurveysQuestionsApiGetSurveyQuestionChoicesRequest {
      */
     readonly search?: string;
 }
+/**
+ * Request parameters for getSurveyQuestionMatrixRows operation in SurveysQuestionsApi.
+ */
+export interface SurveysQuestionsApiGetSurveyQuestionMatrixRowsRequest {
+    /**
+     * The survey identifier
+     */
+    readonly surveyId: string;
+    /**
+     * The question identifier
+     */
+    readonly questionId: string;
+    /**
+     * Page number
+     */
+    readonly page?: number;
+    /**
+     * Number of items per page
+     */
+    readonly pageSize?: number;
+    /**
+     * Field to order by
+     */
+    readonly orderBy?: string;
+    /**
+     * Search query
+     */
+    readonly search?: string;
+}
 /**
  * Request parameters for getSurveyQuestionResponses operation in SurveysQuestionsApi.
  */
@@ -78290,6 +78413,20 @@ export interface SurveysQuestionsApiReorderSurveyQuestionChoicesRequest {
     readonly questionId: string;
     readonly reorderBookingSpaceQuestionChoicesRequest: ReorderBookingSpaceQuestionChoicesRequest;
 }
+/**
+ * Request parameters for reorderSurveyQuestionMatrixRows operation in SurveysQuestionsApi.
+ */
+export interface SurveysQuestionsApiReorderSurveyQuestionMatrixRowsRequest {
+    /**
+     * The survey identifier
+     */
+    readonly surveyId: string;
+    /**
+     * The question identifier
+     */
+    readonly questionId: string;
+    readonly reorderSurveyQuestionMatrixRowsRequest: ReorderSurveyQuestionMatrixRowsRequest;
+}
 /**
  * Request parameters for updateSurveyQuestion operation in SurveysQuestionsApi.
  */
@@ -78436,6 +78573,14 @@ export declare class SurveysQuestionsApi extends BaseAPI {
      * @throws {RequiredError}
      */
     getSurveyQuestionChoices(requestParameters: SurveysQuestionsApiGetSurveyQuestionChoicesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetSurveyQuestionChoices200Response, any, {}>>;
+    /**
+     * 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.
+     * @summary List a matrix question\'s rows
+     * @param {SurveysQuestionsApiGetSurveyQuestionMatrixRowsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getSurveyQuestionMatrixRows(requestParameters: SurveysQuestionsApiGetSurveyQuestionMatrixRowsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetSurveyQuestions200Response, any, {}>>;
     /**
      * 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.
      * @summary List responses to a survey question
@@ -78476,6 +78621,14 @@ export declare class SurveysQuestionsApi extends BaseAPI {
      * @throws {RequiredError}
      */
     reorderSurveyQuestionChoices(requestParameters: SurveysQuestionsApiReorderSurveyQuestionChoicesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ReorderSurveyQuestionChoices200Response, any, {}>>;
+    /**
+     * 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.
+     * @summary Reorder a matrix question\'s rows
+     * @param {SurveysQuestionsApiReorderSurveyQuestionMatrixRowsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    reorderSurveyQuestionMatrixRows(requestParameters: SurveysQuestionsApiReorderSurveyQuestionMatrixRowsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ReorderSurveyQuestionMatrixRows200Response, any, {}>>;
     /**
      * 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.
      * @summary Update a survey question