@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.
@@ -1299,6 +1299,8 @@ docs/ReorderEventSponsorshipsRequest.md
1299
1299
  docs/ReorderSeriesQuestionChoices200Response.md
1300
1300
  docs/ReorderSurveyQuestionChoiceSubQuestions200Response.md
1301
1301
  docs/ReorderSurveyQuestionChoices200Response.md
1302
+ docs/ReorderSurveyQuestionMatrixRows200Response.md
1303
+ docs/ReorderSurveyQuestionMatrixRowsRequest.md
1302
1304
  docs/ReorderSurveySectionQuestions200Response.md
1303
1305
  docs/ReportFilters.md
1304
1306
  docs/ReportType.md
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- ## @connectedxm/admin-sdk@10.0.0
1
+ ## @connectedxm/admin-sdk@10.3.0
2
2
 
3
3
  This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
4
4
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
36
36
  _published:_
37
37
 
38
38
  ```
39
- npm install @connectedxm/admin-sdk@10.0.0 --save
39
+ npm install @connectedxm/admin-sdk@10.3.0 --save
40
40
  ```
41
41
 
42
42
  _unPublished (not recommended):_
package/api.ts CHANGED
@@ -4,7 +4,7 @@
4
4
  * Connected Admin API
5
5
  * The Admin API allows you to manage your Connected community programmatically.
6
6
  *
7
- * The version of the OpenAPI document: 10.0.0
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).
@@ -2497,6 +2497,8 @@ export interface BaseSurveyQuestion {
2497
2497
  'default': string | null;
2498
2498
  'searchListId': string | null;
2499
2499
  'searchList': BaseSearchList | null;
2500
+ 'matrixQuestionId': string | null;
2501
+ 'matrixSortOrder': number | null;
2500
2502
  'mutable': boolean;
2501
2503
  'min': string | null;
2502
2504
  'max': string | null;
@@ -10319,11 +10321,14 @@ export interface ImageDirectUpload {
10319
10321
  'uploadURL': string;
10320
10322
  }
10321
10323
  export interface ImageDirectUploadInputs {
10322
- 'type': ImageType;
10324
+ 'type': ImageDirectUploadInputsTypeEnum;
10323
10325
  'name'?: string | null;
10324
10326
  'description'?: string | null;
10325
10327
  }
10326
10328
 
10329
+ export enum ImageDirectUploadInputsTypeEnum {
10330
+ Admin = 'admin'
10331
+ }
10327
10332
 
10328
10333
 
10329
10334
  export enum ImageModerationLevel {
@@ -12485,6 +12490,19 @@ export enum ReorderSurveyQuestionChoices200ResponseStatusEnum {
12485
12490
  Ok = 'ok'
12486
12491
  }
12487
12492
 
12493
+ export interface ReorderSurveyQuestionMatrixRows200Response {
12494
+ 'status': ReorderSurveyQuestionMatrixRows200ResponseStatusEnum;
12495
+ 'message': string;
12496
+ 'data': Array<SurveyQuestion>;
12497
+ }
12498
+
12499
+ export enum ReorderSurveyQuestionMatrixRows200ResponseStatusEnum {
12500
+ Ok = 'ok'
12501
+ }
12502
+
12503
+ export interface ReorderSurveyQuestionMatrixRowsRequest {
12504
+ 'rowIds': Array<string>;
12505
+ }
12488
12506
  export interface ReorderSurveySectionQuestions200Response {
12489
12507
  'status': ReorderSurveySectionQuestions200ResponseStatusEnum;
12490
12508
  'message': string;
@@ -13590,6 +13608,8 @@ export interface SurveyQuestion {
13590
13608
  'default': string | null;
13591
13609
  'searchListId': string | null;
13592
13610
  'searchList': BaseSearchList | null;
13611
+ 'matrixQuestionId': string | null;
13612
+ 'matrixSortOrder': number | null;
13593
13613
  'mutable': boolean;
13594
13614
  'min': string | null;
13595
13615
  'max': string | null;
@@ -13602,6 +13622,7 @@ export interface SurveyQuestion {
13602
13622
  'choices': Array<BaseSurveyQuestionChoice>;
13603
13623
  'sections': Array<BaseSurveySectionQuestion>;
13604
13624
  'subQuestionOf': Array<SurveyQuestionChoiceSubQuestion>;
13625
+ 'matrixRows'?: Array<BaseSurveyQuestion>;
13605
13626
  'dashboardVisibility': boolean;
13606
13627
  'createdAt': string;
13607
13628
  'updatedAt': string;
@@ -13666,6 +13687,7 @@ export interface SurveyQuestionCreateInputs {
13666
13687
  'sectionId'?: string;
13667
13688
  'questionId'?: string;
13668
13689
  'choiceId'?: string;
13690
+ 'matrixQuestionId'?: string;
13669
13691
  'required'?: boolean;
13670
13692
  'label'?: string | null;
13671
13693
  'placeholder'?: string | null;
@@ -13682,10 +13704,16 @@ export interface SurveyQuestionCreateInputs {
13682
13704
  'sortOrder'?: number | null;
13683
13705
  'featured'?: boolean;
13684
13706
  'choices'?: Array<string> | null;
13707
+ 'matrixRows'?: Array<string> | null;
13708
+ 'matrixRowsType'?: SurveyQuestionCreateInputsMatrixRowsTypeEnum;
13685
13709
  'searchListId'?: string | null;
13686
13710
  'masked'?: boolean;
13687
13711
  }
13688
13712
 
13713
+ export enum SurveyQuestionCreateInputsMatrixRowsTypeEnum {
13714
+ Radio = 'radio',
13715
+ Checkbox = 'checkbox'
13716
+ }
13689
13717
 
13690
13718
  export interface SurveyQuestionResponse {
13691
13719
  'id': string;
@@ -13734,7 +13762,8 @@ export enum SurveyQuestionType {
13734
13762
  Checkbox = 'checkbox',
13735
13763
  Search = 'search',
13736
13764
  File = 'file',
13737
- Location = 'location'
13765
+ Location = 'location',
13766
+ Matrix = 'matrix'
13738
13767
  }
13739
13768
 
13740
13769
 
@@ -13758,8 +13787,13 @@ export interface SurveyQuestionUpdateInputs {
13758
13787
  'sortOrder'?: number | null;
13759
13788
  'featured'?: boolean;
13760
13789
  'searchListId'?: string | null;
13790
+ 'matrixRowsType'?: SurveyQuestionUpdateInputsMatrixRowsTypeEnum;
13761
13791
  }
13762
13792
 
13793
+ export enum SurveyQuestionUpdateInputsMatrixRowsTypeEnum {
13794
+ Radio = 'radio',
13795
+ Checkbox = 'checkbox'
13796
+ }
13763
13797
 
13764
13798
  export interface SurveySection {
13765
13799
  'id': string;
@@ -122666,11 +122700,11 @@ export const OrganizationPaymentsApiAxiosParamCreator = function (configuration?
122666
122700
  * @param {*} [options] Override http request option.
122667
122701
  * @throws {RequiredError}
122668
122702
  */
122669
- refundOrganizationPayment: async (paymentId: string, refundLineItem: Array<RefundLineItem>, eventId?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
122703
+ refundPayment: async (paymentId: string, refundLineItem: Array<RefundLineItem>, eventId?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
122670
122704
  // verify required parameter 'paymentId' is not null or undefined
122671
- assertParamExists('refundOrganizationPayment', 'paymentId', paymentId)
122705
+ assertParamExists('refundPayment', 'paymentId', paymentId)
122672
122706
  // verify required parameter 'refundLineItem' is not null or undefined
122673
- assertParamExists('refundOrganizationPayment', 'refundLineItem', refundLineItem)
122707
+ assertParamExists('refundPayment', 'refundLineItem', refundLineItem)
122674
122708
  const localVarPath = `/payments/{paymentId}/refund`
122675
122709
  .replace(`{${"paymentId"}}`, encodeURIComponent(String(paymentId)));
122676
122710
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
@@ -122707,6 +122741,46 @@ export const OrganizationPaymentsApiAxiosParamCreator = function (configuration?
122707
122741
  options: localVarRequestOptions,
122708
122742
  };
122709
122743
  },
122744
+ /**
122745
+ * 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.
122746
+ * @summary Email a receipt for a payment
122747
+ * @param {string} paymentId The payment identifier
122748
+ * @param {*} [options] Override http request option.
122749
+ * @throws {RequiredError}
122750
+ */
122751
+ sendPaymentReceipt: async (paymentId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
122752
+ // verify required parameter 'paymentId' is not null or undefined
122753
+ assertParamExists('sendPaymentReceipt', 'paymentId', paymentId)
122754
+ const localVarPath = `/payments/{paymentId}/receipt`
122755
+ .replace(`{${"paymentId"}}`, encodeURIComponent(String(paymentId)));
122756
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
122757
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
122758
+ let baseOptions;
122759
+ if (configuration) {
122760
+ baseOptions = configuration.baseOptions;
122761
+ }
122762
+
122763
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
122764
+ const localVarHeaderParameter = {} as any;
122765
+ const localVarQueryParameter = {} as any;
122766
+
122767
+ // authentication ApiKeyAuth required
122768
+ await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
122769
+
122770
+ // authentication OrganizationId required
122771
+ await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
122772
+
122773
+ localVarHeaderParameter['Accept'] = 'application/json';
122774
+
122775
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
122776
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
122777
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
122778
+
122779
+ return {
122780
+ url: toPathString(localVarUrlObj),
122781
+ options: localVarRequestOptions,
122782
+ };
122783
+ },
122710
122784
  /**
122711
122785
  * Toggles the specified payment integration, identified by integrationId, to be the organization\'s default payment integration, requiring update permission on the org resource.
122712
122786
  * @summary Set an organization payment integration as default
@@ -122907,10 +122981,23 @@ export const OrganizationPaymentsApiFp = function(configuration?: Configuration)
122907
122981
  * @param {*} [options] Override http request option.
122908
122982
  * @throws {RequiredError}
122909
122983
  */
122910
- async refundOrganizationPayment(paymentId: string, refundLineItem: Array<RefundLineItem>, eventId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPayment200Response>> {
122911
- const localVarAxiosArgs = await localVarAxiosParamCreator.refundOrganizationPayment(paymentId, refundLineItem, eventId, options);
122984
+ async refundPayment(paymentId: string, refundLineItem: Array<RefundLineItem>, eventId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPayment200Response>> {
122985
+ const localVarAxiosArgs = await localVarAxiosParamCreator.refundPayment(paymentId, refundLineItem, eventId, options);
122912
122986
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
122913
- const localVarOperationServerBasePath = operationServerMap['OrganizationPaymentsApi.refundOrganizationPayment']?.[localVarOperationServerIndex]?.url;
122987
+ const localVarOperationServerBasePath = operationServerMap['OrganizationPaymentsApi.refundPayment']?.[localVarOperationServerIndex]?.url;
122988
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
122989
+ },
122990
+ /**
122991
+ * 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.
122992
+ * @summary Email a receipt for a payment
122993
+ * @param {string} paymentId The payment identifier
122994
+ * @param {*} [options] Override http request option.
122995
+ * @throws {RequiredError}
122996
+ */
122997
+ async sendPaymentReceipt(paymentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAccountInvitations200Response>> {
122998
+ const localVarAxiosArgs = await localVarAxiosParamCreator.sendPaymentReceipt(paymentId, options);
122999
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
123000
+ const localVarOperationServerBasePath = operationServerMap['OrganizationPaymentsApi.sendPaymentReceipt']?.[localVarOperationServerIndex]?.url;
122914
123001
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
122915
123002
  },
122916
123003
  /**
@@ -123022,12 +123109,22 @@ export const OrganizationPaymentsApiFactory = function (configuration?: Configur
123022
123109
  /**
123023
123110
  * 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.
123024
123111
  * @summary Refund line items on a payment
123025
- * @param {OrganizationPaymentsApiRefundOrganizationPaymentRequest} requestParameters Request parameters.
123112
+ * @param {OrganizationPaymentsApiRefundPaymentRequest} requestParameters Request parameters.
123113
+ * @param {*} [options] Override http request option.
123114
+ * @throws {RequiredError}
123115
+ */
123116
+ refundPayment(requestParameters: OrganizationPaymentsApiRefundPaymentRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetPayment200Response> {
123117
+ return localVarFp.refundPayment(requestParameters.paymentId, requestParameters.refundLineItem, requestParameters.eventId, options).then((request) => request(axios, basePath));
123118
+ },
123119
+ /**
123120
+ * 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.
123121
+ * @summary Email a receipt for a payment
123122
+ * @param {OrganizationPaymentsApiSendPaymentReceiptRequest} requestParameters Request parameters.
123026
123123
  * @param {*} [options] Override http request option.
123027
123124
  * @throws {RequiredError}
123028
123125
  */
123029
- refundOrganizationPayment(requestParameters: OrganizationPaymentsApiRefundOrganizationPaymentRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetPayment200Response> {
123030
- return localVarFp.refundOrganizationPayment(requestParameters.paymentId, requestParameters.refundLineItem, requestParameters.eventId, options).then((request) => request(axios, basePath));
123126
+ sendPaymentReceipt(requestParameters: OrganizationPaymentsApiSendPaymentReceiptRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAccountInvitations200Response> {
123127
+ return localVarFp.sendPaymentReceipt(requestParameters.paymentId, options).then((request) => request(axios, basePath));
123031
123128
  },
123032
123129
  /**
123033
123130
  * Toggles the specified payment integration, identified by integrationId, to be the organization\'s default payment integration, requiring update permission on the org resource.
@@ -123150,9 +123247,9 @@ export interface OrganizationPaymentsApiGetPaymentsRequest {
123150
123247
  }
123151
123248
 
123152
123249
  /**
123153
- * Request parameters for refundOrganizationPayment operation in OrganizationPaymentsApi.
123250
+ * Request parameters for refundPayment operation in OrganizationPaymentsApi.
123154
123251
  */
123155
- export interface OrganizationPaymentsApiRefundOrganizationPaymentRequest {
123252
+ export interface OrganizationPaymentsApiRefundPaymentRequest {
123156
123253
  /**
123157
123254
  * The payment identifier
123158
123255
  */
@@ -123166,6 +123263,16 @@ export interface OrganizationPaymentsApiRefundOrganizationPaymentRequest {
123166
123263
  readonly eventId?: string
123167
123264
  }
123168
123265
 
123266
+ /**
123267
+ * Request parameters for sendPaymentReceipt operation in OrganizationPaymentsApi.
123268
+ */
123269
+ export interface OrganizationPaymentsApiSendPaymentReceiptRequest {
123270
+ /**
123271
+ * The payment identifier
123272
+ */
123273
+ readonly paymentId: string
123274
+ }
123275
+
123169
123276
  /**
123170
123277
  * Request parameters for toggleOrganizationPaymentIntegration operation in OrganizationPaymentsApi.
123171
123278
  */
@@ -123272,12 +123379,23 @@ export class OrganizationPaymentsApi extends BaseAPI {
123272
123379
  /**
123273
123380
  * 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.
123274
123381
  * @summary Refund line items on a payment
123275
- * @param {OrganizationPaymentsApiRefundOrganizationPaymentRequest} requestParameters Request parameters.
123382
+ * @param {OrganizationPaymentsApiRefundPaymentRequest} requestParameters Request parameters.
123276
123383
  * @param {*} [options] Override http request option.
123277
123384
  * @throws {RequiredError}
123278
123385
  */
123279
- public refundOrganizationPayment(requestParameters: OrganizationPaymentsApiRefundOrganizationPaymentRequest, options?: RawAxiosRequestConfig) {
123280
- return OrganizationPaymentsApiFp(this.configuration).refundOrganizationPayment(requestParameters.paymentId, requestParameters.refundLineItem, requestParameters.eventId, options).then((request) => request(this.axios, this.basePath));
123386
+ public refundPayment(requestParameters: OrganizationPaymentsApiRefundPaymentRequest, options?: RawAxiosRequestConfig) {
123387
+ return OrganizationPaymentsApiFp(this.configuration).refundPayment(requestParameters.paymentId, requestParameters.refundLineItem, requestParameters.eventId, options).then((request) => request(this.axios, this.basePath));
123388
+ }
123389
+
123390
+ /**
123391
+ * 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.
123392
+ * @summary Email a receipt for a payment
123393
+ * @param {OrganizationPaymentsApiSendPaymentReceiptRequest} requestParameters Request parameters.
123394
+ * @param {*} [options] Override http request option.
123395
+ * @throws {RequiredError}
123396
+ */
123397
+ public sendPaymentReceipt(requestParameters: OrganizationPaymentsApiSendPaymentReceiptRequest, options?: RawAxiosRequestConfig) {
123398
+ return OrganizationPaymentsApiFp(this.configuration).sendPaymentReceipt(requestParameters.paymentId, options).then((request) => request(this.axios, this.basePath));
123281
123399
  }
123282
123400
 
123283
123401
  /**
@@ -142575,6 +142693,70 @@ export const SurveysQuestionsApiAxiosParamCreator = function (configuration?: Co
142575
142693
  options: localVarRequestOptions,
142576
142694
  };
142577
142695
  },
142696
+ /**
142697
+ * 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.
142698
+ * @summary List a matrix question\'s rows
142699
+ * @param {string} surveyId The survey identifier
142700
+ * @param {string} questionId The question identifier
142701
+ * @param {number} [page] Page number
142702
+ * @param {number} [pageSize] Number of items per page
142703
+ * @param {string} [orderBy] Field to order by
142704
+ * @param {string} [search] Search query
142705
+ * @param {*} [options] Override http request option.
142706
+ * @throws {RequiredError}
142707
+ */
142708
+ getSurveyQuestionMatrixRows: async (surveyId: string, questionId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
142709
+ // verify required parameter 'surveyId' is not null or undefined
142710
+ assertParamExists('getSurveyQuestionMatrixRows', 'surveyId', surveyId)
142711
+ // verify required parameter 'questionId' is not null or undefined
142712
+ assertParamExists('getSurveyQuestionMatrixRows', 'questionId', questionId)
142713
+ const localVarPath = `/surveys/{surveyId}/questions/{questionId}/matrixRows`
142714
+ .replace(`{${"surveyId"}}`, encodeURIComponent(String(surveyId)))
142715
+ .replace(`{${"questionId"}}`, encodeURIComponent(String(questionId)));
142716
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
142717
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
142718
+ let baseOptions;
142719
+ if (configuration) {
142720
+ baseOptions = configuration.baseOptions;
142721
+ }
142722
+
142723
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
142724
+ const localVarHeaderParameter = {} as any;
142725
+ const localVarQueryParameter = {} as any;
142726
+
142727
+ // authentication ApiKeyAuth required
142728
+ await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
142729
+
142730
+ // authentication OrganizationId required
142731
+ await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
142732
+
142733
+ if (page !== undefined) {
142734
+ localVarQueryParameter['page'] = page;
142735
+ }
142736
+
142737
+ if (pageSize !== undefined) {
142738
+ localVarQueryParameter['pageSize'] = pageSize;
142739
+ }
142740
+
142741
+ if (orderBy !== undefined) {
142742
+ localVarQueryParameter['orderBy'] = orderBy;
142743
+ }
142744
+
142745
+ if (search !== undefined) {
142746
+ localVarQueryParameter['search'] = search;
142747
+ }
142748
+
142749
+ localVarHeaderParameter['Accept'] = 'application/json';
142750
+
142751
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
142752
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
142753
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
142754
+
142755
+ return {
142756
+ url: toPathString(localVarUrlObj),
142757
+ options: localVarRequestOptions,
142758
+ };
142759
+ },
142578
142760
  /**
142579
142761
  * Returns a paginated list of submitted responses for a survey question from completed submissions, supporting search by respondent name or email; file-upload responses include a temporary signed download URL, and read access to the surveys module is required.
142580
142762
  * @summary List responses to a survey question
@@ -142853,6 +143035,55 @@ export const SurveysQuestionsApiAxiosParamCreator = function (configuration?: Co
142853
143035
  options: localVarRequestOptions,
142854
143036
  };
142855
143037
  },
143038
+ /**
143039
+ * 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.
143040
+ * @summary Reorder a matrix question\'s rows
143041
+ * @param {string} surveyId The survey identifier
143042
+ * @param {string} questionId The question identifier
143043
+ * @param {ReorderSurveyQuestionMatrixRowsRequest} reorderSurveyQuestionMatrixRowsRequest
143044
+ * @param {*} [options] Override http request option.
143045
+ * @throws {RequiredError}
143046
+ */
143047
+ reorderSurveyQuestionMatrixRows: async (surveyId: string, questionId: string, reorderSurveyQuestionMatrixRowsRequest: ReorderSurveyQuestionMatrixRowsRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
143048
+ // verify required parameter 'surveyId' is not null or undefined
143049
+ assertParamExists('reorderSurveyQuestionMatrixRows', 'surveyId', surveyId)
143050
+ // verify required parameter 'questionId' is not null or undefined
143051
+ assertParamExists('reorderSurveyQuestionMatrixRows', 'questionId', questionId)
143052
+ // verify required parameter 'reorderSurveyQuestionMatrixRowsRequest' is not null or undefined
143053
+ assertParamExists('reorderSurveyQuestionMatrixRows', 'reorderSurveyQuestionMatrixRowsRequest', reorderSurveyQuestionMatrixRowsRequest)
143054
+ const localVarPath = `/surveys/{surveyId}/questions/{questionId}/matrixRows/reorder`
143055
+ .replace(`{${"surveyId"}}`, encodeURIComponent(String(surveyId)))
143056
+ .replace(`{${"questionId"}}`, encodeURIComponent(String(questionId)));
143057
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
143058
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
143059
+ let baseOptions;
143060
+ if (configuration) {
143061
+ baseOptions = configuration.baseOptions;
143062
+ }
143063
+
143064
+ const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
143065
+ const localVarHeaderParameter = {} as any;
143066
+ const localVarQueryParameter = {} as any;
143067
+
143068
+ // authentication ApiKeyAuth required
143069
+ await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
143070
+
143071
+ // authentication OrganizationId required
143072
+ await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
143073
+
143074
+ localVarHeaderParameter['Content-Type'] = 'application/json';
143075
+ localVarHeaderParameter['Accept'] = 'application/json';
143076
+
143077
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
143078
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
143079
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
143080
+ localVarRequestOptions.data = serializeDataIfNeeded(reorderSurveyQuestionMatrixRowsRequest, localVarRequestOptions, configuration)
143081
+
143082
+ return {
143083
+ url: toPathString(localVarUrlObj),
143084
+ options: localVarRequestOptions,
143085
+ };
143086
+ },
142856
143087
  /**
142857
143088
  * Updates a question\'s fields (such as name, description, type, or required flag) on the given survey, and reorders it among the survey\'s other questions when a new sortOrder is provided; requires the update surveys permission.
142858
143089
  * @summary Update a survey question
@@ -143191,6 +143422,24 @@ export const SurveysQuestionsApiFp = function(configuration?: Configuration) {
143191
143422
  const localVarOperationServerBasePath = operationServerMap['SurveysQuestionsApi.getSurveyQuestionChoices']?.[localVarOperationServerIndex]?.url;
143192
143423
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
143193
143424
  },
143425
+ /**
143426
+ * 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.
143427
+ * @summary List a matrix question\'s rows
143428
+ * @param {string} surveyId The survey identifier
143429
+ * @param {string} questionId The question identifier
143430
+ * @param {number} [page] Page number
143431
+ * @param {number} [pageSize] Number of items per page
143432
+ * @param {string} [orderBy] Field to order by
143433
+ * @param {string} [search] Search query
143434
+ * @param {*} [options] Override http request option.
143435
+ * @throws {RequiredError}
143436
+ */
143437
+ async getSurveyQuestionMatrixRows(surveyId: string, questionId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSurveyQuestions200Response>> {
143438
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getSurveyQuestionMatrixRows(surveyId, questionId, page, pageSize, orderBy, search, options);
143439
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
143440
+ const localVarOperationServerBasePath = operationServerMap['SurveysQuestionsApi.getSurveyQuestionMatrixRows']?.[localVarOperationServerIndex]?.url;
143441
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
143442
+ },
143194
143443
  /**
143195
143444
  * Returns a paginated list of submitted responses for a survey question from completed submissions, supporting search by respondent name or email; file-upload responses include a temporary signed download URL, and read access to the surveys module is required.
143196
143445
  * @summary List responses to a survey question
@@ -143273,6 +143522,21 @@ export const SurveysQuestionsApiFp = function(configuration?: Configuration) {
143273
143522
  const localVarOperationServerBasePath = operationServerMap['SurveysQuestionsApi.reorderSurveyQuestionChoices']?.[localVarOperationServerIndex]?.url;
143274
143523
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
143275
143524
  },
143525
+ /**
143526
+ * 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.
143527
+ * @summary Reorder a matrix question\'s rows
143528
+ * @param {string} surveyId The survey identifier
143529
+ * @param {string} questionId The question identifier
143530
+ * @param {ReorderSurveyQuestionMatrixRowsRequest} reorderSurveyQuestionMatrixRowsRequest
143531
+ * @param {*} [options] Override http request option.
143532
+ * @throws {RequiredError}
143533
+ */
143534
+ async reorderSurveyQuestionMatrixRows(surveyId: string, questionId: string, reorderSurveyQuestionMatrixRowsRequest: ReorderSurveyQuestionMatrixRowsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReorderSurveyQuestionMatrixRows200Response>> {
143535
+ const localVarAxiosArgs = await localVarAxiosParamCreator.reorderSurveyQuestionMatrixRows(surveyId, questionId, reorderSurveyQuestionMatrixRowsRequest, options);
143536
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
143537
+ const localVarOperationServerBasePath = operationServerMap['SurveysQuestionsApi.reorderSurveyQuestionMatrixRows']?.[localVarOperationServerIndex]?.url;
143538
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
143539
+ },
143276
143540
  /**
143277
143541
  * Updates a question\'s fields (such as name, description, type, or required flag) on the given survey, and reorders it among the survey\'s other questions when a new sortOrder is provided; requires the update surveys permission.
143278
143542
  * @summary Update a survey question
@@ -143440,6 +143704,16 @@ export const SurveysQuestionsApiFactory = function (configuration?: Configuratio
143440
143704
  getSurveyQuestionChoices(requestParameters: SurveysQuestionsApiGetSurveyQuestionChoicesRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetSurveyQuestionChoices200Response> {
143441
143705
  return localVarFp.getSurveyQuestionChoices(requestParameters.surveyId, requestParameters.questionId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
143442
143706
  },
143707
+ /**
143708
+ * 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.
143709
+ * @summary List a matrix question\'s rows
143710
+ * @param {SurveysQuestionsApiGetSurveyQuestionMatrixRowsRequest} requestParameters Request parameters.
143711
+ * @param {*} [options] Override http request option.
143712
+ * @throws {RequiredError}
143713
+ */
143714
+ getSurveyQuestionMatrixRows(requestParameters: SurveysQuestionsApiGetSurveyQuestionMatrixRowsRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetSurveyQuestions200Response> {
143715
+ return localVarFp.getSurveyQuestionMatrixRows(requestParameters.surveyId, requestParameters.questionId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
143716
+ },
143443
143717
  /**
143444
143718
  * Returns a paginated list of submitted responses for a survey question from completed submissions, supporting search by respondent name or email; file-upload responses include a temporary signed download URL, and read access to the surveys module is required.
143445
143719
  * @summary List responses to a survey question
@@ -143490,6 +143764,16 @@ export const SurveysQuestionsApiFactory = function (configuration?: Configuratio
143490
143764
  reorderSurveyQuestionChoices(requestParameters: SurveysQuestionsApiReorderSurveyQuestionChoicesRequest, options?: RawAxiosRequestConfig): AxiosPromise<ReorderSurveyQuestionChoices200Response> {
143491
143765
  return localVarFp.reorderSurveyQuestionChoices(requestParameters.surveyId, requestParameters.questionId, requestParameters.reorderBookingSpaceQuestionChoicesRequest, options).then((request) => request(axios, basePath));
143492
143766
  },
143767
+ /**
143768
+ * 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.
143769
+ * @summary Reorder a matrix question\'s rows
143770
+ * @param {SurveysQuestionsApiReorderSurveyQuestionMatrixRowsRequest} requestParameters Request parameters.
143771
+ * @param {*} [options] Override http request option.
143772
+ * @throws {RequiredError}
143773
+ */
143774
+ reorderSurveyQuestionMatrixRows(requestParameters: SurveysQuestionsApiReorderSurveyQuestionMatrixRowsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ReorderSurveyQuestionMatrixRows200Response> {
143775
+ return localVarFp.reorderSurveyQuestionMatrixRows(requestParameters.surveyId, requestParameters.questionId, requestParameters.reorderSurveyQuestionMatrixRowsRequest, options).then((request) => request(axios, basePath));
143776
+ },
143493
143777
  /**
143494
143778
  * Updates a question\'s fields (such as name, description, type, or required flag) on the given survey, and reorders it among the survey\'s other questions when a new sortOrder is provided; requires the update surveys permission.
143495
143779
  * @summary Update a survey question
@@ -143759,6 +144043,41 @@ export interface SurveysQuestionsApiGetSurveyQuestionChoicesRequest {
143759
144043
  readonly search?: string
143760
144044
  }
143761
144045
 
144046
+ /**
144047
+ * Request parameters for getSurveyQuestionMatrixRows operation in SurveysQuestionsApi.
144048
+ */
144049
+ export interface SurveysQuestionsApiGetSurveyQuestionMatrixRowsRequest {
144050
+ /**
144051
+ * The survey identifier
144052
+ */
144053
+ readonly surveyId: string
144054
+
144055
+ /**
144056
+ * The question identifier
144057
+ */
144058
+ readonly questionId: string
144059
+
144060
+ /**
144061
+ * Page number
144062
+ */
144063
+ readonly page?: number
144064
+
144065
+ /**
144066
+ * Number of items per page
144067
+ */
144068
+ readonly pageSize?: number
144069
+
144070
+ /**
144071
+ * Field to order by
144072
+ */
144073
+ readonly orderBy?: string
144074
+
144075
+ /**
144076
+ * Search query
144077
+ */
144078
+ readonly search?: string
144079
+ }
144080
+
143762
144081
  /**
143763
144082
  * Request parameters for getSurveyQuestionResponses operation in SurveysQuestionsApi.
143764
144083
  */
@@ -143888,6 +144207,23 @@ export interface SurveysQuestionsApiReorderSurveyQuestionChoicesRequest {
143888
144207
  readonly reorderBookingSpaceQuestionChoicesRequest: ReorderBookingSpaceQuestionChoicesRequest
143889
144208
  }
143890
144209
 
144210
+ /**
144211
+ * Request parameters for reorderSurveyQuestionMatrixRows operation in SurveysQuestionsApi.
144212
+ */
144213
+ export interface SurveysQuestionsApiReorderSurveyQuestionMatrixRowsRequest {
144214
+ /**
144215
+ * The survey identifier
144216
+ */
144217
+ readonly surveyId: string
144218
+
144219
+ /**
144220
+ * The question identifier
144221
+ */
144222
+ readonly questionId: string
144223
+
144224
+ readonly reorderSurveyQuestionMatrixRowsRequest: ReorderSurveyQuestionMatrixRowsRequest
144225
+ }
144226
+
143891
144227
  /**
143892
144228
  * Request parameters for updateSurveyQuestion operation in SurveysQuestionsApi.
143893
144229
  */
@@ -144079,6 +144415,17 @@ export class SurveysQuestionsApi extends BaseAPI {
144079
144415
  return SurveysQuestionsApiFp(this.configuration).getSurveyQuestionChoices(requestParameters.surveyId, requestParameters.questionId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
144080
144416
  }
144081
144417
 
144418
+ /**
144419
+ * 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.
144420
+ * @summary List a matrix question\'s rows
144421
+ * @param {SurveysQuestionsApiGetSurveyQuestionMatrixRowsRequest} requestParameters Request parameters.
144422
+ * @param {*} [options] Override http request option.
144423
+ * @throws {RequiredError}
144424
+ */
144425
+ public getSurveyQuestionMatrixRows(requestParameters: SurveysQuestionsApiGetSurveyQuestionMatrixRowsRequest, options?: RawAxiosRequestConfig) {
144426
+ 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));
144427
+ }
144428
+
144082
144429
  /**
144083
144430
  * Returns a paginated list of submitted responses for a survey question from completed submissions, supporting search by respondent name or email; file-upload responses include a temporary signed download URL, and read access to the surveys module is required.
144084
144431
  * @summary List responses to a survey question
@@ -144134,6 +144481,17 @@ export class SurveysQuestionsApi extends BaseAPI {
144134
144481
  return SurveysQuestionsApiFp(this.configuration).reorderSurveyQuestionChoices(requestParameters.surveyId, requestParameters.questionId, requestParameters.reorderBookingSpaceQuestionChoicesRequest, options).then((request) => request(this.axios, this.basePath));
144135
144482
  }
144136
144483
 
144484
+ /**
144485
+ * 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.
144486
+ * @summary Reorder a matrix question\'s rows
144487
+ * @param {SurveysQuestionsApiReorderSurveyQuestionMatrixRowsRequest} requestParameters Request parameters.
144488
+ * @param {*} [options] Override http request option.
144489
+ * @throws {RequiredError}
144490
+ */
144491
+ public reorderSurveyQuestionMatrixRows(requestParameters: SurveysQuestionsApiReorderSurveyQuestionMatrixRowsRequest, options?: RawAxiosRequestConfig) {
144492
+ return SurveysQuestionsApiFp(this.configuration).reorderSurveyQuestionMatrixRows(requestParameters.surveyId, requestParameters.questionId, requestParameters.reorderSurveyQuestionMatrixRowsRequest, options).then((request) => request(this.axios, this.basePath));
144493
+ }
144494
+
144137
144495
  /**
144138
144496
  * Updates a question\'s fields (such as name, description, type, or required flag) on the given survey, and reorders it among the survey\'s other questions when a new sortOrder is provided; requires the update surveys permission.
144139
144497
  * @summary Update a survey question
package/base.ts CHANGED
@@ -4,7 +4,7 @@
4
4
  * Connected Admin API
5
5
  * The Admin API allows you to manage your Connected community programmatically.
6
6
  *
7
- * The version of the OpenAPI document: 10.0.0
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/common.ts CHANGED
@@ -4,7 +4,7 @@
4
4
  * Connected Admin API
5
5
  * The Admin API allows you to manage your Connected community programmatically.
6
6
  *
7
- * The version of the OpenAPI document: 10.0.0
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/configuration.ts CHANGED
@@ -3,7 +3,7 @@
3
3
  * Connected Admin API
4
4
  * The Admin API allows you to manage your Connected community programmatically.
5
5
  *
6
- * The version of the OpenAPI document: 10.0.0
6
+ * The version of the OpenAPI document: 10.3.0
7
7
  *
8
8
  *
9
9
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).