@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/esm/api.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).
|
|
@@ -1956,6 +1956,10 @@ export var GroupRequestStatus;
|
|
|
1956
1956
|
GroupRequestStatus["Requested"] = "requested";
|
|
1957
1957
|
GroupRequestStatus["Rejected"] = "rejected";
|
|
1958
1958
|
})(GroupRequestStatus || (GroupRequestStatus = {}));
|
|
1959
|
+
export var ImageDirectUploadInputsTypeEnum;
|
|
1960
|
+
(function (ImageDirectUploadInputsTypeEnum) {
|
|
1961
|
+
ImageDirectUploadInputsTypeEnum["Admin"] = "admin";
|
|
1962
|
+
})(ImageDirectUploadInputsTypeEnum || (ImageDirectUploadInputsTypeEnum = {}));
|
|
1959
1963
|
export var ImageModerationLevel;
|
|
1960
1964
|
(function (ImageModerationLevel) {
|
|
1961
1965
|
ImageModerationLevel["Safe"] = "safe";
|
|
@@ -2338,6 +2342,10 @@ export var ReorderSurveyQuestionChoices200ResponseStatusEnum;
|
|
|
2338
2342
|
(function (ReorderSurveyQuestionChoices200ResponseStatusEnum) {
|
|
2339
2343
|
ReorderSurveyQuestionChoices200ResponseStatusEnum["Ok"] = "ok";
|
|
2340
2344
|
})(ReorderSurveyQuestionChoices200ResponseStatusEnum || (ReorderSurveyQuestionChoices200ResponseStatusEnum = {}));
|
|
2345
|
+
export var ReorderSurveyQuestionMatrixRows200ResponseStatusEnum;
|
|
2346
|
+
(function (ReorderSurveyQuestionMatrixRows200ResponseStatusEnum) {
|
|
2347
|
+
ReorderSurveyQuestionMatrixRows200ResponseStatusEnum["Ok"] = "ok";
|
|
2348
|
+
})(ReorderSurveyQuestionMatrixRows200ResponseStatusEnum || (ReorderSurveyQuestionMatrixRows200ResponseStatusEnum = {}));
|
|
2341
2349
|
export var ReorderSurveySectionQuestions200ResponseStatusEnum;
|
|
2342
2350
|
(function (ReorderSurveySectionQuestions200ResponseStatusEnum) {
|
|
2343
2351
|
ReorderSurveySectionQuestions200ResponseStatusEnum["Ok"] = "ok";
|
|
@@ -2559,6 +2567,11 @@ export var SupportedLocale;
|
|
|
2559
2567
|
SupportedLocale["Uz"] = "uz";
|
|
2560
2568
|
SupportedLocale["Vi"] = "vi";
|
|
2561
2569
|
})(SupportedLocale || (SupportedLocale = {}));
|
|
2570
|
+
export var SurveyQuestionCreateInputsMatrixRowsTypeEnum;
|
|
2571
|
+
(function (SurveyQuestionCreateInputsMatrixRowsTypeEnum) {
|
|
2572
|
+
SurveyQuestionCreateInputsMatrixRowsTypeEnum["Radio"] = "radio";
|
|
2573
|
+
SurveyQuestionCreateInputsMatrixRowsTypeEnum["Checkbox"] = "checkbox";
|
|
2574
|
+
})(SurveyQuestionCreateInputsMatrixRowsTypeEnum || (SurveyQuestionCreateInputsMatrixRowsTypeEnum = {}));
|
|
2562
2575
|
export var SurveyQuestionType;
|
|
2563
2576
|
(function (SurveyQuestionType) {
|
|
2564
2577
|
SurveyQuestionType["Text"] = "text";
|
|
@@ -2572,7 +2585,13 @@ export var SurveyQuestionType;
|
|
|
2572
2585
|
SurveyQuestionType["Search"] = "search";
|
|
2573
2586
|
SurveyQuestionType["File"] = "file";
|
|
2574
2587
|
SurveyQuestionType["Location"] = "location";
|
|
2588
|
+
SurveyQuestionType["Matrix"] = "matrix";
|
|
2575
2589
|
})(SurveyQuestionType || (SurveyQuestionType = {}));
|
|
2590
|
+
export var SurveyQuestionUpdateInputsMatrixRowsTypeEnum;
|
|
2591
|
+
(function (SurveyQuestionUpdateInputsMatrixRowsTypeEnum) {
|
|
2592
|
+
SurveyQuestionUpdateInputsMatrixRowsTypeEnum["Radio"] = "radio";
|
|
2593
|
+
SurveyQuestionUpdateInputsMatrixRowsTypeEnum["Checkbox"] = "checkbox";
|
|
2594
|
+
})(SurveyQuestionUpdateInputsMatrixRowsTypeEnum || (SurveyQuestionUpdateInputsMatrixRowsTypeEnum = {}));
|
|
2576
2595
|
export var SurveyStatus;
|
|
2577
2596
|
(function (SurveyStatus) {
|
|
2578
2597
|
SurveyStatus["Draft"] = "draft";
|
|
@@ -85013,11 +85032,11 @@ export const OrganizationPaymentsApiAxiosParamCreator = function (configuration)
|
|
|
85013
85032
|
* @param {*} [options] Override http request option.
|
|
85014
85033
|
* @throws {RequiredError}
|
|
85015
85034
|
*/
|
|
85016
|
-
|
|
85035
|
+
refundPayment: (paymentId_1, refundLineItem_1, eventId_1, ...args_1) => __awaiter(this, [paymentId_1, refundLineItem_1, eventId_1, ...args_1], void 0, function* (paymentId, refundLineItem, eventId, options = {}) {
|
|
85017
85036
|
// verify required parameter 'paymentId' is not null or undefined
|
|
85018
|
-
assertParamExists('
|
|
85037
|
+
assertParamExists('refundPayment', 'paymentId', paymentId);
|
|
85019
85038
|
// verify required parameter 'refundLineItem' is not null or undefined
|
|
85020
|
-
assertParamExists('
|
|
85039
|
+
assertParamExists('refundPayment', 'refundLineItem', refundLineItem);
|
|
85021
85040
|
const localVarPath = `/payments/{paymentId}/refund`
|
|
85022
85041
|
.replace(`{${"paymentId"}}`, encodeURIComponent(String(paymentId)));
|
|
85023
85042
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
@@ -85047,6 +85066,40 @@ export const OrganizationPaymentsApiAxiosParamCreator = function (configuration)
|
|
|
85047
85066
|
options: localVarRequestOptions,
|
|
85048
85067
|
};
|
|
85049
85068
|
}),
|
|
85069
|
+
/**
|
|
85070
|
+
* 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.
|
|
85071
|
+
* @summary Email a receipt for a payment
|
|
85072
|
+
* @param {string} paymentId The payment identifier
|
|
85073
|
+
* @param {*} [options] Override http request option.
|
|
85074
|
+
* @throws {RequiredError}
|
|
85075
|
+
*/
|
|
85076
|
+
sendPaymentReceipt: (paymentId_1, ...args_1) => __awaiter(this, [paymentId_1, ...args_1], void 0, function* (paymentId, options = {}) {
|
|
85077
|
+
// verify required parameter 'paymentId' is not null or undefined
|
|
85078
|
+
assertParamExists('sendPaymentReceipt', 'paymentId', paymentId);
|
|
85079
|
+
const localVarPath = `/payments/{paymentId}/receipt`
|
|
85080
|
+
.replace(`{${"paymentId"}}`, encodeURIComponent(String(paymentId)));
|
|
85081
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
85082
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
85083
|
+
let baseOptions;
|
|
85084
|
+
if (configuration) {
|
|
85085
|
+
baseOptions = configuration.baseOptions;
|
|
85086
|
+
}
|
|
85087
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
85088
|
+
const localVarHeaderParameter = {};
|
|
85089
|
+
const localVarQueryParameter = {};
|
|
85090
|
+
// authentication ApiKeyAuth required
|
|
85091
|
+
yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
|
|
85092
|
+
// authentication OrganizationId required
|
|
85093
|
+
yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
|
|
85094
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
85095
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
85096
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
85097
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
85098
|
+
return {
|
|
85099
|
+
url: toPathString(localVarUrlObj),
|
|
85100
|
+
options: localVarRequestOptions,
|
|
85101
|
+
};
|
|
85102
|
+
}),
|
|
85050
85103
|
/**
|
|
85051
85104
|
* Toggles the specified payment integration, identified by integrationId, to be the organization\'s default payment integration, requiring update permission on the org resource.
|
|
85052
85105
|
* @summary Set an organization payment integration as default
|
|
@@ -85255,12 +85308,28 @@ export const OrganizationPaymentsApiFp = function (configuration) {
|
|
|
85255
85308
|
* @param {*} [options] Override http request option.
|
|
85256
85309
|
* @throws {RequiredError}
|
|
85257
85310
|
*/
|
|
85258
|
-
|
|
85311
|
+
refundPayment(paymentId, refundLineItem, eventId, options) {
|
|
85312
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
85313
|
+
var _a, _b, _c;
|
|
85314
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.refundPayment(paymentId, refundLineItem, eventId, options);
|
|
85315
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
85316
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['OrganizationPaymentsApi.refundPayment']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
85317
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
85318
|
+
});
|
|
85319
|
+
},
|
|
85320
|
+
/**
|
|
85321
|
+
* 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.
|
|
85322
|
+
* @summary Email a receipt for a payment
|
|
85323
|
+
* @param {string} paymentId The payment identifier
|
|
85324
|
+
* @param {*} [options] Override http request option.
|
|
85325
|
+
* @throws {RequiredError}
|
|
85326
|
+
*/
|
|
85327
|
+
sendPaymentReceipt(paymentId, options) {
|
|
85259
85328
|
return __awaiter(this, void 0, void 0, function* () {
|
|
85260
85329
|
var _a, _b, _c;
|
|
85261
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.
|
|
85330
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.sendPaymentReceipt(paymentId, options);
|
|
85262
85331
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
85263
|
-
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['OrganizationPaymentsApi.
|
|
85332
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['OrganizationPaymentsApi.sendPaymentReceipt']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
85264
85333
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
85265
85334
|
});
|
|
85266
85335
|
},
|
|
@@ -85378,12 +85447,22 @@ export const OrganizationPaymentsApiFactory = function (configuration, basePath,
|
|
|
85378
85447
|
/**
|
|
85379
85448
|
* 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.
|
|
85380
85449
|
* @summary Refund line items on a payment
|
|
85381
|
-
* @param {
|
|
85450
|
+
* @param {OrganizationPaymentsApiRefundPaymentRequest} requestParameters Request parameters.
|
|
85451
|
+
* @param {*} [options] Override http request option.
|
|
85452
|
+
* @throws {RequiredError}
|
|
85453
|
+
*/
|
|
85454
|
+
refundPayment(requestParameters, options) {
|
|
85455
|
+
return localVarFp.refundPayment(requestParameters.paymentId, requestParameters.refundLineItem, requestParameters.eventId, options).then((request) => request(axios, basePath));
|
|
85456
|
+
},
|
|
85457
|
+
/**
|
|
85458
|
+
* 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.
|
|
85459
|
+
* @summary Email a receipt for a payment
|
|
85460
|
+
* @param {OrganizationPaymentsApiSendPaymentReceiptRequest} requestParameters Request parameters.
|
|
85382
85461
|
* @param {*} [options] Override http request option.
|
|
85383
85462
|
* @throws {RequiredError}
|
|
85384
85463
|
*/
|
|
85385
|
-
|
|
85386
|
-
return localVarFp.
|
|
85464
|
+
sendPaymentReceipt(requestParameters, options) {
|
|
85465
|
+
return localVarFp.sendPaymentReceipt(requestParameters.paymentId, options).then((request) => request(axios, basePath));
|
|
85387
85466
|
},
|
|
85388
85467
|
/**
|
|
85389
85468
|
* Toggles the specified payment integration, identified by integrationId, to be the organization\'s default payment integration, requiring update permission on the org resource.
|
|
@@ -85484,12 +85563,22 @@ export class OrganizationPaymentsApi extends BaseAPI {
|
|
|
85484
85563
|
/**
|
|
85485
85564
|
* 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.
|
|
85486
85565
|
* @summary Refund line items on a payment
|
|
85487
|
-
* @param {
|
|
85566
|
+
* @param {OrganizationPaymentsApiRefundPaymentRequest} requestParameters Request parameters.
|
|
85488
85567
|
* @param {*} [options] Override http request option.
|
|
85489
85568
|
* @throws {RequiredError}
|
|
85490
85569
|
*/
|
|
85491
|
-
|
|
85492
|
-
return OrganizationPaymentsApiFp(this.configuration).
|
|
85570
|
+
refundPayment(requestParameters, options) {
|
|
85571
|
+
return OrganizationPaymentsApiFp(this.configuration).refundPayment(requestParameters.paymentId, requestParameters.refundLineItem, requestParameters.eventId, options).then((request) => request(this.axios, this.basePath));
|
|
85572
|
+
}
|
|
85573
|
+
/**
|
|
85574
|
+
* 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.
|
|
85575
|
+
* @summary Email a receipt for a payment
|
|
85576
|
+
* @param {OrganizationPaymentsApiSendPaymentReceiptRequest} requestParameters Request parameters.
|
|
85577
|
+
* @param {*} [options] Override http request option.
|
|
85578
|
+
* @throws {RequiredError}
|
|
85579
|
+
*/
|
|
85580
|
+
sendPaymentReceipt(requestParameters, options) {
|
|
85581
|
+
return OrganizationPaymentsApiFp(this.configuration).sendPaymentReceipt(requestParameters.paymentId, options).then((request) => request(this.axios, this.basePath));
|
|
85493
85582
|
}
|
|
85494
85583
|
/**
|
|
85495
85584
|
* Toggles the specified payment integration, identified by integrationId, to be the organization\'s default payment integration, requiring update permission on the org resource.
|
|
@@ -100805,6 +100894,60 @@ export const SurveysQuestionsApiAxiosParamCreator = function (configuration) {
|
|
|
100805
100894
|
options: localVarRequestOptions,
|
|
100806
100895
|
};
|
|
100807
100896
|
}),
|
|
100897
|
+
/**
|
|
100898
|
+
* 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.
|
|
100899
|
+
* @summary List a matrix question\'s rows
|
|
100900
|
+
* @param {string} surveyId The survey identifier
|
|
100901
|
+
* @param {string} questionId The question identifier
|
|
100902
|
+
* @param {number} [page] Page number
|
|
100903
|
+
* @param {number} [pageSize] Number of items per page
|
|
100904
|
+
* @param {string} [orderBy] Field to order by
|
|
100905
|
+
* @param {string} [search] Search query
|
|
100906
|
+
* @param {*} [options] Override http request option.
|
|
100907
|
+
* @throws {RequiredError}
|
|
100908
|
+
*/
|
|
100909
|
+
getSurveyQuestionMatrixRows: (surveyId_1, questionId_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1) => __awaiter(this, [surveyId_1, questionId_1, page_1, pageSize_1, orderBy_1, search_1, ...args_1], void 0, function* (surveyId, questionId, page, pageSize, orderBy, search, options = {}) {
|
|
100910
|
+
// verify required parameter 'surveyId' is not null or undefined
|
|
100911
|
+
assertParamExists('getSurveyQuestionMatrixRows', 'surveyId', surveyId);
|
|
100912
|
+
// verify required parameter 'questionId' is not null or undefined
|
|
100913
|
+
assertParamExists('getSurveyQuestionMatrixRows', 'questionId', questionId);
|
|
100914
|
+
const localVarPath = `/surveys/{surveyId}/questions/{questionId}/matrixRows`
|
|
100915
|
+
.replace(`{${"surveyId"}}`, encodeURIComponent(String(surveyId)))
|
|
100916
|
+
.replace(`{${"questionId"}}`, encodeURIComponent(String(questionId)));
|
|
100917
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
100918
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
100919
|
+
let baseOptions;
|
|
100920
|
+
if (configuration) {
|
|
100921
|
+
baseOptions = configuration.baseOptions;
|
|
100922
|
+
}
|
|
100923
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
100924
|
+
const localVarHeaderParameter = {};
|
|
100925
|
+
const localVarQueryParameter = {};
|
|
100926
|
+
// authentication ApiKeyAuth required
|
|
100927
|
+
yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
|
|
100928
|
+
// authentication OrganizationId required
|
|
100929
|
+
yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
|
|
100930
|
+
if (page !== undefined) {
|
|
100931
|
+
localVarQueryParameter['page'] = page;
|
|
100932
|
+
}
|
|
100933
|
+
if (pageSize !== undefined) {
|
|
100934
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
100935
|
+
}
|
|
100936
|
+
if (orderBy !== undefined) {
|
|
100937
|
+
localVarQueryParameter['orderBy'] = orderBy;
|
|
100938
|
+
}
|
|
100939
|
+
if (search !== undefined) {
|
|
100940
|
+
localVarQueryParameter['search'] = search;
|
|
100941
|
+
}
|
|
100942
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
100943
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
100944
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
100945
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
100946
|
+
return {
|
|
100947
|
+
url: toPathString(localVarUrlObj),
|
|
100948
|
+
options: localVarRequestOptions,
|
|
100949
|
+
};
|
|
100950
|
+
}),
|
|
100808
100951
|
/**
|
|
100809
100952
|
* 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.
|
|
100810
100953
|
* @summary List responses to a survey question
|
|
@@ -101045,6 +101188,49 @@ export const SurveysQuestionsApiAxiosParamCreator = function (configuration) {
|
|
|
101045
101188
|
options: localVarRequestOptions,
|
|
101046
101189
|
};
|
|
101047
101190
|
}),
|
|
101191
|
+
/**
|
|
101192
|
+
* 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.
|
|
101193
|
+
* @summary Reorder a matrix question\'s rows
|
|
101194
|
+
* @param {string} surveyId The survey identifier
|
|
101195
|
+
* @param {string} questionId The question identifier
|
|
101196
|
+
* @param {ReorderSurveyQuestionMatrixRowsRequest} reorderSurveyQuestionMatrixRowsRequest
|
|
101197
|
+
* @param {*} [options] Override http request option.
|
|
101198
|
+
* @throws {RequiredError}
|
|
101199
|
+
*/
|
|
101200
|
+
reorderSurveyQuestionMatrixRows: (surveyId_1, questionId_1, reorderSurveyQuestionMatrixRowsRequest_1, ...args_1) => __awaiter(this, [surveyId_1, questionId_1, reorderSurveyQuestionMatrixRowsRequest_1, ...args_1], void 0, function* (surveyId, questionId, reorderSurveyQuestionMatrixRowsRequest, options = {}) {
|
|
101201
|
+
// verify required parameter 'surveyId' is not null or undefined
|
|
101202
|
+
assertParamExists('reorderSurveyQuestionMatrixRows', 'surveyId', surveyId);
|
|
101203
|
+
// verify required parameter 'questionId' is not null or undefined
|
|
101204
|
+
assertParamExists('reorderSurveyQuestionMatrixRows', 'questionId', questionId);
|
|
101205
|
+
// verify required parameter 'reorderSurveyQuestionMatrixRowsRequest' is not null or undefined
|
|
101206
|
+
assertParamExists('reorderSurveyQuestionMatrixRows', 'reorderSurveyQuestionMatrixRowsRequest', reorderSurveyQuestionMatrixRowsRequest);
|
|
101207
|
+
const localVarPath = `/surveys/{surveyId}/questions/{questionId}/matrixRows/reorder`
|
|
101208
|
+
.replace(`{${"surveyId"}}`, encodeURIComponent(String(surveyId)))
|
|
101209
|
+
.replace(`{${"questionId"}}`, encodeURIComponent(String(questionId)));
|
|
101210
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
101211
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
101212
|
+
let baseOptions;
|
|
101213
|
+
if (configuration) {
|
|
101214
|
+
baseOptions = configuration.baseOptions;
|
|
101215
|
+
}
|
|
101216
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'PUT' }, baseOptions), options);
|
|
101217
|
+
const localVarHeaderParameter = {};
|
|
101218
|
+
const localVarQueryParameter = {};
|
|
101219
|
+
// authentication ApiKeyAuth required
|
|
101220
|
+
yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
|
|
101221
|
+
// authentication OrganizationId required
|
|
101222
|
+
yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
|
|
101223
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
101224
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
101225
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
101226
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
101227
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
101228
|
+
localVarRequestOptions.data = serializeDataIfNeeded(reorderSurveyQuestionMatrixRowsRequest, localVarRequestOptions, configuration);
|
|
101229
|
+
return {
|
|
101230
|
+
url: toPathString(localVarUrlObj),
|
|
101231
|
+
options: localVarRequestOptions,
|
|
101232
|
+
};
|
|
101233
|
+
}),
|
|
101048
101234
|
/**
|
|
101049
101235
|
* 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.
|
|
101050
101236
|
* @summary Update a survey question
|
|
@@ -101397,6 +101583,27 @@ export const SurveysQuestionsApiFp = function (configuration) {
|
|
|
101397
101583
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
101398
101584
|
});
|
|
101399
101585
|
},
|
|
101586
|
+
/**
|
|
101587
|
+
* 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.
|
|
101588
|
+
* @summary List a matrix question\'s rows
|
|
101589
|
+
* @param {string} surveyId The survey identifier
|
|
101590
|
+
* @param {string} questionId The question identifier
|
|
101591
|
+
* @param {number} [page] Page number
|
|
101592
|
+
* @param {number} [pageSize] Number of items per page
|
|
101593
|
+
* @param {string} [orderBy] Field to order by
|
|
101594
|
+
* @param {string} [search] Search query
|
|
101595
|
+
* @param {*} [options] Override http request option.
|
|
101596
|
+
* @throws {RequiredError}
|
|
101597
|
+
*/
|
|
101598
|
+
getSurveyQuestionMatrixRows(surveyId, questionId, page, pageSize, orderBy, search, options) {
|
|
101599
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
101600
|
+
var _a, _b, _c;
|
|
101601
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getSurveyQuestionMatrixRows(surveyId, questionId, page, pageSize, orderBy, search, options);
|
|
101602
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
101603
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['SurveysQuestionsApi.getSurveyQuestionMatrixRows']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
101604
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
101605
|
+
});
|
|
101606
|
+
},
|
|
101400
101607
|
/**
|
|
101401
101608
|
* 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.
|
|
101402
101609
|
* @summary List responses to a survey question
|
|
@@ -101494,6 +101701,24 @@ export const SurveysQuestionsApiFp = function (configuration) {
|
|
|
101494
101701
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
101495
101702
|
});
|
|
101496
101703
|
},
|
|
101704
|
+
/**
|
|
101705
|
+
* 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.
|
|
101706
|
+
* @summary Reorder a matrix question\'s rows
|
|
101707
|
+
* @param {string} surveyId The survey identifier
|
|
101708
|
+
* @param {string} questionId The question identifier
|
|
101709
|
+
* @param {ReorderSurveyQuestionMatrixRowsRequest} reorderSurveyQuestionMatrixRowsRequest
|
|
101710
|
+
* @param {*} [options] Override http request option.
|
|
101711
|
+
* @throws {RequiredError}
|
|
101712
|
+
*/
|
|
101713
|
+
reorderSurveyQuestionMatrixRows(surveyId, questionId, reorderSurveyQuestionMatrixRowsRequest, options) {
|
|
101714
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
101715
|
+
var _a, _b, _c;
|
|
101716
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.reorderSurveyQuestionMatrixRows(surveyId, questionId, reorderSurveyQuestionMatrixRowsRequest, options);
|
|
101717
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
101718
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['SurveysQuestionsApi.reorderSurveyQuestionMatrixRows']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
101719
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
101720
|
+
});
|
|
101721
|
+
},
|
|
101497
101722
|
/**
|
|
101498
101723
|
* 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.
|
|
101499
101724
|
* @summary Update a survey question
|
|
@@ -101669,6 +101894,16 @@ export const SurveysQuestionsApiFactory = function (configuration, basePath, axi
|
|
|
101669
101894
|
getSurveyQuestionChoices(requestParameters, options) {
|
|
101670
101895
|
return localVarFp.getSurveyQuestionChoices(requestParameters.surveyId, requestParameters.questionId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
101671
101896
|
},
|
|
101897
|
+
/**
|
|
101898
|
+
* 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.
|
|
101899
|
+
* @summary List a matrix question\'s rows
|
|
101900
|
+
* @param {SurveysQuestionsApiGetSurveyQuestionMatrixRowsRequest} requestParameters Request parameters.
|
|
101901
|
+
* @param {*} [options] Override http request option.
|
|
101902
|
+
* @throws {RequiredError}
|
|
101903
|
+
*/
|
|
101904
|
+
getSurveyQuestionMatrixRows(requestParameters, options) {
|
|
101905
|
+
return localVarFp.getSurveyQuestionMatrixRows(requestParameters.surveyId, requestParameters.questionId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
101906
|
+
},
|
|
101672
101907
|
/**
|
|
101673
101908
|
* 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.
|
|
101674
101909
|
* @summary List responses to a survey question
|
|
@@ -101719,6 +101954,16 @@ export const SurveysQuestionsApiFactory = function (configuration, basePath, axi
|
|
|
101719
101954
|
reorderSurveyQuestionChoices(requestParameters, options) {
|
|
101720
101955
|
return localVarFp.reorderSurveyQuestionChoices(requestParameters.surveyId, requestParameters.questionId, requestParameters.reorderBookingSpaceQuestionChoicesRequest, options).then((request) => request(axios, basePath));
|
|
101721
101956
|
},
|
|
101957
|
+
/**
|
|
101958
|
+
* 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.
|
|
101959
|
+
* @summary Reorder a matrix question\'s rows
|
|
101960
|
+
* @param {SurveysQuestionsApiReorderSurveyQuestionMatrixRowsRequest} requestParameters Request parameters.
|
|
101961
|
+
* @param {*} [options] Override http request option.
|
|
101962
|
+
* @throws {RequiredError}
|
|
101963
|
+
*/
|
|
101964
|
+
reorderSurveyQuestionMatrixRows(requestParameters, options) {
|
|
101965
|
+
return localVarFp.reorderSurveyQuestionMatrixRows(requestParameters.surveyId, requestParameters.questionId, requestParameters.reorderSurveyQuestionMatrixRowsRequest, options).then((request) => request(axios, basePath));
|
|
101966
|
+
},
|
|
101722
101967
|
/**
|
|
101723
101968
|
* 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.
|
|
101724
101969
|
* @summary Update a survey question
|
|
@@ -101865,6 +102110,16 @@ export class SurveysQuestionsApi extends BaseAPI {
|
|
|
101865
102110
|
getSurveyQuestionChoices(requestParameters, options) {
|
|
101866
102111
|
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));
|
|
101867
102112
|
}
|
|
102113
|
+
/**
|
|
102114
|
+
* 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.
|
|
102115
|
+
* @summary List a matrix question\'s rows
|
|
102116
|
+
* @param {SurveysQuestionsApiGetSurveyQuestionMatrixRowsRequest} requestParameters Request parameters.
|
|
102117
|
+
* @param {*} [options] Override http request option.
|
|
102118
|
+
* @throws {RequiredError}
|
|
102119
|
+
*/
|
|
102120
|
+
getSurveyQuestionMatrixRows(requestParameters, options) {
|
|
102121
|
+
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));
|
|
102122
|
+
}
|
|
101868
102123
|
/**
|
|
101869
102124
|
* 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.
|
|
101870
102125
|
* @summary List responses to a survey question
|
|
@@ -101915,6 +102170,16 @@ export class SurveysQuestionsApi extends BaseAPI {
|
|
|
101915
102170
|
reorderSurveyQuestionChoices(requestParameters, options) {
|
|
101916
102171
|
return SurveysQuestionsApiFp(this.configuration).reorderSurveyQuestionChoices(requestParameters.surveyId, requestParameters.questionId, requestParameters.reorderBookingSpaceQuestionChoicesRequest, options).then((request) => request(this.axios, this.basePath));
|
|
101917
102172
|
}
|
|
102173
|
+
/**
|
|
102174
|
+
* 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.
|
|
102175
|
+
* @summary Reorder a matrix question\'s rows
|
|
102176
|
+
* @param {SurveysQuestionsApiReorderSurveyQuestionMatrixRowsRequest} requestParameters Request parameters.
|
|
102177
|
+
* @param {*} [options] Override http request option.
|
|
102178
|
+
* @throws {RequiredError}
|
|
102179
|
+
*/
|
|
102180
|
+
reorderSurveyQuestionMatrixRows(requestParameters, options) {
|
|
102181
|
+
return SurveysQuestionsApiFp(this.configuration).reorderSurveyQuestionMatrixRows(requestParameters.surveyId, requestParameters.questionId, requestParameters.reorderSurveyQuestionMatrixRowsRequest, options).then((request) => request(this.axios, this.basePath));
|
|
102182
|
+
}
|
|
101918
102183
|
/**
|
|
101919
102184
|
* 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.
|
|
101920
102185
|
* @summary Update a survey question
|
package/dist/esm/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/esm/base.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/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/esm/common.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).
|
|
@@ -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).
|
|
@@ -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.
|
|
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).
|
|
@@ -16,6 +16,8 @@ Name | Type | Description | Notes
|
|
|
16
16
|
**_default** | **string** | | [default to undefined]
|
|
17
17
|
**searchListId** | **string** | | [default to undefined]
|
|
18
18
|
**searchList** | [**BaseSearchList**](BaseSearchList.md) | | [default to undefined]
|
|
19
|
+
**matrixQuestionId** | **string** | | [default to undefined]
|
|
20
|
+
**matrixSortOrder** | **number** | | [default to undefined]
|
|
19
21
|
**mutable** | **boolean** | | [default to undefined]
|
|
20
22
|
**min** | **string** | | [default to undefined]
|
|
21
23
|
**max** | **string** | | [default to undefined]
|
|
@@ -44,6 +46,8 @@ const instance: BaseSurveyQuestion = {
|
|
|
44
46
|
_default,
|
|
45
47
|
searchListId,
|
|
46
48
|
searchList,
|
|
49
|
+
matrixQuestionId,
|
|
50
|
+
matrixSortOrder,
|
|
47
51
|
mutable,
|
|
48
52
|
min,
|
|
49
53
|
max,
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**type** |
|
|
8
|
+
**type** | **string** | | [default to undefined]
|
|
9
9
|
**name** | **string** | | [optional] [default to undefined]
|
|
10
10
|
**description** | **string** | | [optional] [default to undefined]
|
|
11
11
|
|
|
@@ -11,7 +11,8 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
11
11
|
|[**getPayment**](#getpayment) | **GET** /payments/{paymentId} | Get a payment|
|
|
12
12
|
|[**getPaymentTaxMetadata**](#getpaymenttaxmetadata) | **GET** /payments/{paymentId}/tax-metadata | Get a payment\'s tax metadata|
|
|
13
13
|
|[**getPayments**](#getpayments) | **GET** /payments | List an organization\'s payments|
|
|
14
|
-
|[**
|
|
14
|
+
|[**refundPayment**](#refundpayment) | **POST** /payments/{paymentId}/refund | Refund line items on a payment|
|
|
15
|
+
|[**sendPaymentReceipt**](#sendpaymentreceipt) | **POST** /payments/{paymentId}/receipt | Email a receipt for a payment|
|
|
15
16
|
|[**toggleOrganizationPaymentIntegration**](#toggleorganizationpaymentintegration) | **PUT** /organization/payment/{integrationId}/toggle | Set an organization payment integration as default|
|
|
16
17
|
|[**updateOrganizationPaymentIntegration**](#updateorganizationpaymentintegration) | **PUT** /organization/payment/{integrationId} | Update an organization payment integration|
|
|
17
18
|
|
|
@@ -391,8 +392,8 @@ const { status, data } = await apiInstance.getPayments(
|
|
|
391
392
|
|
|
392
393
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
393
394
|
|
|
394
|
-
# **
|
|
395
|
-
> GetPayment200Response
|
|
395
|
+
# **refundPayment**
|
|
396
|
+
> GetPayment200Response refundPayment(refundLineItem)
|
|
396
397
|
|
|
397
398
|
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.
|
|
398
399
|
|
|
@@ -411,7 +412,7 @@ let paymentId: string; //The payment identifier (default to undefined)
|
|
|
411
412
|
let refundLineItem: Array<RefundLineItem>; //
|
|
412
413
|
let eventId: string; //Filter by eventId (optional) (default to undefined)
|
|
413
414
|
|
|
414
|
-
const { status, data } = await apiInstance.
|
|
415
|
+
const { status, data } = await apiInstance.refundPayment(
|
|
415
416
|
paymentId,
|
|
416
417
|
refundLineItem,
|
|
417
418
|
eventId
|
|
@@ -441,6 +442,57 @@ const { status, data } = await apiInstance.refundOrganizationPayment(
|
|
|
441
442
|
- **Accept**: application/json
|
|
442
443
|
|
|
443
444
|
|
|
445
|
+
### HTTP response details
|
|
446
|
+
| Status code | Description | Response headers |
|
|
447
|
+
|-------------|-------------|------------------|
|
|
448
|
+
|**200** | Successful response | - |
|
|
449
|
+
|
|
450
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
451
|
+
|
|
452
|
+
# **sendPaymentReceipt**
|
|
453
|
+
> CreateAccountInvitations200Response sendPaymentReceipt()
|
|
454
|
+
|
|
455
|
+
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.
|
|
456
|
+
|
|
457
|
+
### Example
|
|
458
|
+
|
|
459
|
+
```typescript
|
|
460
|
+
import {
|
|
461
|
+
OrganizationPaymentsApi,
|
|
462
|
+
Configuration
|
|
463
|
+
} from '@connectedxm/admin-sdk';
|
|
464
|
+
|
|
465
|
+
const configuration = new Configuration();
|
|
466
|
+
const apiInstance = new OrganizationPaymentsApi(configuration);
|
|
467
|
+
|
|
468
|
+
let paymentId: string; //The payment identifier (default to undefined)
|
|
469
|
+
|
|
470
|
+
const { status, data } = await apiInstance.sendPaymentReceipt(
|
|
471
|
+
paymentId
|
|
472
|
+
);
|
|
473
|
+
```
|
|
474
|
+
|
|
475
|
+
### Parameters
|
|
476
|
+
|
|
477
|
+
|Name | Type | Description | Notes|
|
|
478
|
+
|------------- | ------------- | ------------- | -------------|
|
|
479
|
+
| **paymentId** | [**string**] | The payment identifier | defaults to undefined|
|
|
480
|
+
|
|
481
|
+
|
|
482
|
+
### Return type
|
|
483
|
+
|
|
484
|
+
**CreateAccountInvitations200Response**
|
|
485
|
+
|
|
486
|
+
### Authorization
|
|
487
|
+
|
|
488
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
489
|
+
|
|
490
|
+
### HTTP request headers
|
|
491
|
+
|
|
492
|
+
- **Content-Type**: Not defined
|
|
493
|
+
- **Accept**: application/json
|
|
494
|
+
|
|
495
|
+
|
|
444
496
|
### HTTP response details
|
|
445
497
|
| Status code | Description | Response headers |
|
|
446
498
|
|-------------|-------------|------------------|
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# ReorderSurveyQuestionMatrixRows200Response
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**status** | **string** | | [default to undefined]
|
|
9
|
+
**message** | **string** | | [default to undefined]
|
|
10
|
+
**data** | [**Array<SurveyQuestion>**](SurveyQuestion.md) | | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { ReorderSurveyQuestionMatrixRows200Response } from '@connectedxm/admin-sdk';
|
|
16
|
+
|
|
17
|
+
const instance: ReorderSurveyQuestionMatrixRows200Response = {
|
|
18
|
+
status,
|
|
19
|
+
message,
|
|
20
|
+
data,
|
|
21
|
+
};
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|