@connectedxm/admin-sdk 11.13.0 → 11.14.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +6 -1
- package/README.md +2 -2
- package/api.ts +135 -6
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +83 -6
- package/dist/api.js +106 -21
- 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 +83 -6
- package/dist/esm/api.js +86 -1
- 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/BaseEventSession.md +2 -0
- package/docs/EventSession.md +2 -0
- package/docs/EventSessionCreateInputs.md +2 -0
- package/docs/EventSessionUpdateInputs.md +2 -0
- package/docs/EventsPassesResponsesApi.md +56 -0
- package/docs/ImportEventPassResponses200Response.md +24 -0
- package/docs/PassResponseImportResult.md +26 -0
- package/docs/PassResponseImportSummary.md +22 -0
- package/docs/PassResponsesImportInputs.md +20 -0
- package/docs/PassResponsesImportInputsRowsInner.md +22 -0
- package/docs/{SeriesRegistrationResponsesUpdateInputsResponsesInner.md → PassResponsesImportInputsRowsInnerValuesInner.md} +3 -3
- package/docs/SeriesRegistrationResponsesUpdateInputs.md +1 -1
- 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: 11.
|
|
7
|
+
* The version of the OpenAPI document: 11.14.1
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -2051,6 +2051,10 @@ export var ImportEventPassAttributes200ResponseStatusEnum;
|
|
|
2051
2051
|
(function (ImportEventPassAttributes200ResponseStatusEnum) {
|
|
2052
2052
|
ImportEventPassAttributes200ResponseStatusEnum["Ok"] = "ok";
|
|
2053
2053
|
})(ImportEventPassAttributes200ResponseStatusEnum || (ImportEventPassAttributes200ResponseStatusEnum = {}));
|
|
2054
|
+
export var ImportEventPassResponses200ResponseStatusEnum;
|
|
2055
|
+
(function (ImportEventPassResponses200ResponseStatusEnum) {
|
|
2056
|
+
ImportEventPassResponses200ResponseStatusEnum["Ok"] = "ok";
|
|
2057
|
+
})(ImportEventPassResponses200ResponseStatusEnum || (ImportEventPassResponses200ResponseStatusEnum = {}));
|
|
2054
2058
|
export var ImportItemStatus;
|
|
2055
2059
|
(function (ImportItemStatus) {
|
|
2056
2060
|
ImportItemStatus["Pending"] = "pending";
|
|
@@ -2358,6 +2362,11 @@ export var PassChangeLogType;
|
|
|
2358
2362
|
PassChangeLogType["Email"] = "email";
|
|
2359
2363
|
PassChangeLogType["InternalRefId"] = "internalRefId";
|
|
2360
2364
|
})(PassChangeLogType || (PassChangeLogType = {}));
|
|
2365
|
+
export var PassResponseImportResultStatusEnum;
|
|
2366
|
+
(function (PassResponseImportResultStatusEnum) {
|
|
2367
|
+
PassResponseImportResultStatusEnum["Resolved"] = "resolved";
|
|
2368
|
+
PassResponseImportResultStatusEnum["Invalid"] = "invalid";
|
|
2369
|
+
})(PassResponseImportResultStatusEnum || (PassResponseImportResultStatusEnum = {}));
|
|
2361
2370
|
export var PassTypeAccessLevel;
|
|
2362
2371
|
(function (PassTypeAccessLevel) {
|
|
2363
2372
|
PassTypeAccessLevel["Regular"] = "regular";
|
|
@@ -43403,6 +43412,45 @@ export const EventsPassesResponsesApiAxiosParamCreator = function (configuration
|
|
|
43403
43412
|
options: localVarRequestOptions,
|
|
43404
43413
|
};
|
|
43405
43414
|
}),
|
|
43415
|
+
/**
|
|
43416
|
+
* Creates or updates question answers on up to 500 passes in one call, the write half of a CSV import. Each row\'s passId may be a pass id or the pass\'s alternateId. Each questionId must be a question id — question names are not unique on an event, so there is no name fallback. Values are given in the human form the pass export produces: choice questions accept a choice\'s label or id, checkbox cells accept a comma-separated list (use semicolons if a label itself contains a comma), toggles accept yes/no, and dates accept yyyy-MM-dd. File questions cannot be imported. Rows whose pass, question or value cannot be resolved are reported back as invalid and skipped rather than failing the batch. Resolution is synchronous, so every rejected row comes back in the response; the write is queued and runs on the effects side, so the response reports what was accepted rather than what changed. Requires read permission on events and read/update permission on attendees.
|
|
43417
|
+
* @summary Bulk set registration question answers across many passes
|
|
43418
|
+
* @param {string} eventId The event identifier
|
|
43419
|
+
* @param {PassResponsesImportInputs} passResponsesImportInputs
|
|
43420
|
+
* @param {*} [options] Override http request option.
|
|
43421
|
+
* @throws {RequiredError}
|
|
43422
|
+
*/
|
|
43423
|
+
importEventPassResponses: (eventId_1, passResponsesImportInputs_1, ...args_1) => __awaiter(this, [eventId_1, passResponsesImportInputs_1, ...args_1], void 0, function* (eventId, passResponsesImportInputs, options = {}) {
|
|
43424
|
+
// verify required parameter 'eventId' is not null or undefined
|
|
43425
|
+
assertParamExists('importEventPassResponses', 'eventId', eventId);
|
|
43426
|
+
// verify required parameter 'passResponsesImportInputs' is not null or undefined
|
|
43427
|
+
assertParamExists('importEventPassResponses', 'passResponsesImportInputs', passResponsesImportInputs);
|
|
43428
|
+
const localVarPath = `/events/{eventId}/passes/responses/import`
|
|
43429
|
+
.replace('{eventId}', encodeURIComponent(String(eventId)));
|
|
43430
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
43431
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
43432
|
+
let baseOptions;
|
|
43433
|
+
if (configuration) {
|
|
43434
|
+
baseOptions = configuration.baseOptions;
|
|
43435
|
+
}
|
|
43436
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
43437
|
+
const localVarHeaderParameter = {};
|
|
43438
|
+
const localVarQueryParameter = {};
|
|
43439
|
+
// authentication ApiKeyAuth required
|
|
43440
|
+
yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
|
|
43441
|
+
// authentication OrganizationId required
|
|
43442
|
+
yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
|
|
43443
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
43444
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
43445
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
43446
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
43447
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
43448
|
+
localVarRequestOptions.data = serializeDataIfNeeded(passResponsesImportInputs, localVarRequestOptions, configuration);
|
|
43449
|
+
return {
|
|
43450
|
+
url: toPathString(localVarUrlObj),
|
|
43451
|
+
options: localVarRequestOptions,
|
|
43452
|
+
};
|
|
43453
|
+
}),
|
|
43406
43454
|
/**
|
|
43407
43455
|
* Updates the response value for one registration question on the specified event pass, requires read permission on events and read/update permission on attendees.
|
|
43408
43456
|
* @summary Update a single registration question response
|
|
@@ -43566,6 +43614,23 @@ export const EventsPassesResponsesApiFp = function (configuration) {
|
|
|
43566
43614
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
43567
43615
|
});
|
|
43568
43616
|
},
|
|
43617
|
+
/**
|
|
43618
|
+
* Creates or updates question answers on up to 500 passes in one call, the write half of a CSV import. Each row\'s passId may be a pass id or the pass\'s alternateId. Each questionId must be a question id — question names are not unique on an event, so there is no name fallback. Values are given in the human form the pass export produces: choice questions accept a choice\'s label or id, checkbox cells accept a comma-separated list (use semicolons if a label itself contains a comma), toggles accept yes/no, and dates accept yyyy-MM-dd. File questions cannot be imported. Rows whose pass, question or value cannot be resolved are reported back as invalid and skipped rather than failing the batch. Resolution is synchronous, so every rejected row comes back in the response; the write is queued and runs on the effects side, so the response reports what was accepted rather than what changed. Requires read permission on events and read/update permission on attendees.
|
|
43619
|
+
* @summary Bulk set registration question answers across many passes
|
|
43620
|
+
* @param {string} eventId The event identifier
|
|
43621
|
+
* @param {PassResponsesImportInputs} passResponsesImportInputs
|
|
43622
|
+
* @param {*} [options] Override http request option.
|
|
43623
|
+
* @throws {RequiredError}
|
|
43624
|
+
*/
|
|
43625
|
+
importEventPassResponses(eventId, passResponsesImportInputs, options) {
|
|
43626
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
43627
|
+
var _a, _b, _c;
|
|
43628
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.importEventPassResponses(eventId, passResponsesImportInputs, options);
|
|
43629
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
43630
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['EventsPassesResponsesApi.importEventPassResponses']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
43631
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
43632
|
+
});
|
|
43633
|
+
},
|
|
43569
43634
|
/**
|
|
43570
43635
|
* Updates the response value for one registration question on the specified event pass, requires read permission on events and read/update permission on attendees.
|
|
43571
43636
|
* @summary Update a single registration question response
|
|
@@ -43642,6 +43707,16 @@ export const EventsPassesResponsesApiFactory = function (configuration, basePath
|
|
|
43642
43707
|
getEventPassResponses(requestParameters, options) {
|
|
43643
43708
|
return localVarFp.getEventPassResponses(requestParameters.eventId, requestParameters.passId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
43644
43709
|
},
|
|
43710
|
+
/**
|
|
43711
|
+
* Creates or updates question answers on up to 500 passes in one call, the write half of a CSV import. Each row\'s passId may be a pass id or the pass\'s alternateId. Each questionId must be a question id — question names are not unique on an event, so there is no name fallback. Values are given in the human form the pass export produces: choice questions accept a choice\'s label or id, checkbox cells accept a comma-separated list (use semicolons if a label itself contains a comma), toggles accept yes/no, and dates accept yyyy-MM-dd. File questions cannot be imported. Rows whose pass, question or value cannot be resolved are reported back as invalid and skipped rather than failing the batch. Resolution is synchronous, so every rejected row comes back in the response; the write is queued and runs on the effects side, so the response reports what was accepted rather than what changed. Requires read permission on events and read/update permission on attendees.
|
|
43712
|
+
* @summary Bulk set registration question answers across many passes
|
|
43713
|
+
* @param {EventsPassesResponsesApiImportEventPassResponsesRequest} requestParameters Request parameters.
|
|
43714
|
+
* @param {*} [options] Override http request option.
|
|
43715
|
+
* @throws {RequiredError}
|
|
43716
|
+
*/
|
|
43717
|
+
importEventPassResponses(requestParameters, options) {
|
|
43718
|
+
return localVarFp.importEventPassResponses(requestParameters.eventId, requestParameters.passResponsesImportInputs, options).then((request) => request(axios, basePath));
|
|
43719
|
+
},
|
|
43645
43720
|
/**
|
|
43646
43721
|
* Updates the response value for one registration question on the specified event pass, requires read permission on events and read/update permission on attendees.
|
|
43647
43722
|
* @summary Update a single registration question response
|
|
@@ -43698,6 +43773,16 @@ export class EventsPassesResponsesApi extends BaseAPI {
|
|
|
43698
43773
|
getEventPassResponses(requestParameters, options) {
|
|
43699
43774
|
return EventsPassesResponsesApiFp(this.configuration).getEventPassResponses(requestParameters.eventId, requestParameters.passId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
43700
43775
|
}
|
|
43776
|
+
/**
|
|
43777
|
+
* Creates or updates question answers on up to 500 passes in one call, the write half of a CSV import. Each row\'s passId may be a pass id or the pass\'s alternateId. Each questionId must be a question id — question names are not unique on an event, so there is no name fallback. Values are given in the human form the pass export produces: choice questions accept a choice\'s label or id, checkbox cells accept a comma-separated list (use semicolons if a label itself contains a comma), toggles accept yes/no, and dates accept yyyy-MM-dd. File questions cannot be imported. Rows whose pass, question or value cannot be resolved are reported back as invalid and skipped rather than failing the batch. Resolution is synchronous, so every rejected row comes back in the response; the write is queued and runs on the effects side, so the response reports what was accepted rather than what changed. Requires read permission on events and read/update permission on attendees.
|
|
43778
|
+
* @summary Bulk set registration question answers across many passes
|
|
43779
|
+
* @param {EventsPassesResponsesApiImportEventPassResponsesRequest} requestParameters Request parameters.
|
|
43780
|
+
* @param {*} [options] Override http request option.
|
|
43781
|
+
* @throws {RequiredError}
|
|
43782
|
+
*/
|
|
43783
|
+
importEventPassResponses(requestParameters, options) {
|
|
43784
|
+
return EventsPassesResponsesApiFp(this.configuration).importEventPassResponses(requestParameters.eventId, requestParameters.passResponsesImportInputs, options).then((request) => request(this.axios, this.basePath));
|
|
43785
|
+
}
|
|
43701
43786
|
/**
|
|
43702
43787
|
* Updates the response value for one registration question on the specified event pass, requires read permission on events and read/update permission on attendees.
|
|
43703
43788
|
* @summary Update a single registration question response
|
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: 11.
|
|
5
|
+
* The version of the OpenAPI document: 11.14.1
|
|
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: 11.
|
|
7
|
+
* The version of the OpenAPI document: 11.14.1
|
|
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: 11.
|
|
5
|
+
* The version of the OpenAPI document: 11.14.1
|
|
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: 11.
|
|
7
|
+
* The version of the OpenAPI document: 11.14.1
|
|
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: 11.
|
|
5
|
+
* The version of the OpenAPI document: 11.14.1
|
|
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: 11.
|
|
6
|
+
* The version of the OpenAPI document: 11.14.1
|
|
7
7
|
*
|
|
8
8
|
*
|
|
9
9
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/docs/BaseEventSession.md
CHANGED
|
@@ -16,6 +16,7 @@ Name | Type | Description | Notes
|
|
|
16
16
|
**endTime** | **string** | | [default to undefined]
|
|
17
17
|
**registrationEnd** | **string** | | [optional] [default to undefined]
|
|
18
18
|
**onsiteRegistration** | **boolean** | | [default to undefined]
|
|
19
|
+
**skipOnsiteValidations** | **boolean** | | [default to undefined]
|
|
19
20
|
**allowQuickRegister** | **boolean** | | [default to undefined]
|
|
20
21
|
**tracks** | [**Array<BaseEventTrack>**](BaseEventTrack.md) | | [default to undefined]
|
|
21
22
|
**nonSession** | **boolean** | | [default to undefined]
|
|
@@ -49,6 +50,7 @@ const instance: BaseEventSession = {
|
|
|
49
50
|
endTime,
|
|
50
51
|
registrationEnd,
|
|
51
52
|
onsiteRegistration,
|
|
53
|
+
skipOnsiteValidations,
|
|
52
54
|
allowQuickRegister,
|
|
53
55
|
tracks,
|
|
54
56
|
nonSession,
|
package/docs/EventSession.md
CHANGED
|
@@ -16,6 +16,7 @@ Name | Type | Description | Notes
|
|
|
16
16
|
**endTime** | **string** | | [default to undefined]
|
|
17
17
|
**registrationEnd** | **string** | | [optional] [default to undefined]
|
|
18
18
|
**onsiteRegistration** | **boolean** | | [default to undefined]
|
|
19
|
+
**skipOnsiteValidations** | **boolean** | | [default to undefined]
|
|
19
20
|
**allowQuickRegister** | **boolean** | | [default to undefined]
|
|
20
21
|
**tracks** | [**Array<BaseEventTrack>**](BaseEventTrack.md) | | [default to undefined]
|
|
21
22
|
**nonSession** | **boolean** | | [default to undefined]
|
|
@@ -65,6 +66,7 @@ const instance: EventSession = {
|
|
|
65
66
|
endTime,
|
|
66
67
|
registrationEnd,
|
|
67
68
|
onsiteRegistration,
|
|
69
|
+
skipOnsiteValidations,
|
|
68
70
|
allowQuickRegister,
|
|
69
71
|
tracks,
|
|
70
72
|
nonSession,
|
|
@@ -19,6 +19,7 @@ Name | Type | Description | Notes
|
|
|
19
19
|
**sortOrder** | **number** | | [optional] [default to undefined]
|
|
20
20
|
**registrationEnabled** | **boolean** | | [optional] [default to undefined]
|
|
21
21
|
**onsiteRegistration** | **boolean** | | [optional] [default to undefined]
|
|
22
|
+
**skipOnsiteValidations** | **boolean** | | [optional] [default to undefined]
|
|
22
23
|
**allowQuickRegister** | **boolean** | | [optional] [default to undefined]
|
|
23
24
|
**limit** | **number** | | [optional] [default to undefined]
|
|
24
25
|
**price** | **number** | | [optional] [default to undefined]
|
|
@@ -55,6 +56,7 @@ const instance: EventSessionCreateInputs = {
|
|
|
55
56
|
sortOrder,
|
|
56
57
|
registrationEnabled,
|
|
57
58
|
onsiteRegistration,
|
|
59
|
+
skipOnsiteValidations,
|
|
58
60
|
allowQuickRegister,
|
|
59
61
|
limit,
|
|
60
62
|
price,
|
|
@@ -19,6 +19,7 @@ Name | Type | Description | Notes
|
|
|
19
19
|
**sortOrder** | **number** | | [optional] [default to undefined]
|
|
20
20
|
**registrationEnabled** | **boolean** | | [optional] [default to undefined]
|
|
21
21
|
**onsiteRegistration** | **boolean** | | [optional] [default to undefined]
|
|
22
|
+
**skipOnsiteValidations** | **boolean** | | [optional] [default to undefined]
|
|
22
23
|
**allowQuickRegister** | **boolean** | | [optional] [default to undefined]
|
|
23
24
|
**limit** | **number** | | [optional] [default to undefined]
|
|
24
25
|
**price** | **number** | | [optional] [default to undefined]
|
|
@@ -55,6 +56,7 @@ const instance: EventSessionUpdateInputs = {
|
|
|
55
56
|
sortOrder,
|
|
56
57
|
registrationEnabled,
|
|
57
58
|
onsiteRegistration,
|
|
59
|
+
skipOnsiteValidations,
|
|
58
60
|
allowQuickRegister,
|
|
59
61
|
limit,
|
|
60
62
|
price,
|
|
@@ -7,6 +7,7 @@ All URIs are relative to *https://admin-api.connected.dev*
|
|
|
7
7
|
|[**getEventPassResponse**](#geteventpassresponse) | **GET** /events/{eventId}/passes/{passId}/responses/{questionId} | Get an event pass\'s response to a question|
|
|
8
8
|
|[**getEventPassResponseChanges**](#geteventpassresponsechanges) | **GET** /events/{eventId}/passes/{passId}/responses/{questionId}/changes | List a pass response\'s edit history|
|
|
9
9
|
|[**getEventPassResponses**](#geteventpassresponses) | **GET** /events/{eventId}/passes/{passId}/responses | List a pass\'s registration question responses|
|
|
10
|
+
|[**importEventPassResponses**](#importeventpassresponses) | **POST** /events/{eventId}/passes/responses/import | Bulk set registration question answers across many passes|
|
|
10
11
|
|[**updateEventPassResponse**](#updateeventpassresponse) | **PUT** /events/{eventId}/passes/{passId}/responses/{questionId} | Update a single registration question response|
|
|
11
12
|
|[**updateEventPassResponses**](#updateeventpassresponses) | **PUT** /events/{eventId}/registrations/{registrationId}/passes/{passId}/responses | Update all registration question responses for a pass|
|
|
12
13
|
|
|
@@ -195,6 +196,61 @@ const { status, data } = await apiInstance.getEventPassResponses(
|
|
|
195
196
|
- **Accept**: application/json
|
|
196
197
|
|
|
197
198
|
|
|
199
|
+
### HTTP response details
|
|
200
|
+
| Status code | Description | Response headers |
|
|
201
|
+
|-------------|-------------|------------------|
|
|
202
|
+
|**200** | Successful response | - |
|
|
203
|
+
|
|
204
|
+
[[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)
|
|
205
|
+
|
|
206
|
+
# **importEventPassResponses**
|
|
207
|
+
> ImportEventPassResponses200Response importEventPassResponses(passResponsesImportInputs)
|
|
208
|
+
|
|
209
|
+
Creates or updates question answers on up to 500 passes in one call, the write half of a CSV import. Each row\'s passId may be a pass id or the pass\'s alternateId. Each questionId must be a question id — question names are not unique on an event, so there is no name fallback. Values are given in the human form the pass export produces: choice questions accept a choice\'s label or id, checkbox cells accept a comma-separated list (use semicolons if a label itself contains a comma), toggles accept yes/no, and dates accept yyyy-MM-dd. File questions cannot be imported. Rows whose pass, question or value cannot be resolved are reported back as invalid and skipped rather than failing the batch. Resolution is synchronous, so every rejected row comes back in the response; the write is queued and runs on the effects side, so the response reports what was accepted rather than what changed. Requires read permission on events and read/update permission on attendees.
|
|
210
|
+
|
|
211
|
+
### Example
|
|
212
|
+
|
|
213
|
+
```typescript
|
|
214
|
+
import {
|
|
215
|
+
EventsPassesResponsesApi,
|
|
216
|
+
Configuration,
|
|
217
|
+
PassResponsesImportInputs
|
|
218
|
+
} from '@connectedxm/admin-sdk';
|
|
219
|
+
|
|
220
|
+
const configuration = new Configuration();
|
|
221
|
+
const apiInstance = new EventsPassesResponsesApi(configuration);
|
|
222
|
+
|
|
223
|
+
let eventId: string; //The event identifier (default to undefined)
|
|
224
|
+
let passResponsesImportInputs: PassResponsesImportInputs; //
|
|
225
|
+
|
|
226
|
+
const { status, data } = await apiInstance.importEventPassResponses(
|
|
227
|
+
eventId,
|
|
228
|
+
passResponsesImportInputs
|
|
229
|
+
);
|
|
230
|
+
```
|
|
231
|
+
|
|
232
|
+
### Parameters
|
|
233
|
+
|
|
234
|
+
|Name | Type | Description | Notes|
|
|
235
|
+
|------------- | ------------- | ------------- | -------------|
|
|
236
|
+
| **passResponsesImportInputs** | **PassResponsesImportInputs**| | |
|
|
237
|
+
| **eventId** | [**string**] | The event identifier | defaults to undefined|
|
|
238
|
+
|
|
239
|
+
|
|
240
|
+
### Return type
|
|
241
|
+
|
|
242
|
+
**ImportEventPassResponses200Response**
|
|
243
|
+
|
|
244
|
+
### Authorization
|
|
245
|
+
|
|
246
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
|
|
247
|
+
|
|
248
|
+
### HTTP request headers
|
|
249
|
+
|
|
250
|
+
- **Content-Type**: application/json
|
|
251
|
+
- **Accept**: application/json
|
|
252
|
+
|
|
253
|
+
|
|
198
254
|
### HTTP response details
|
|
199
255
|
| Status code | Description | Response headers |
|
|
200
256
|
|-------------|-------------|------------------|
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# ImportEventPassResponses200Response
|
|
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** | [**PassResponseImportSummary**](PassResponseImportSummary.md) | | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { ImportEventPassResponses200Response } from '@connectedxm/admin-sdk';
|
|
16
|
+
|
|
17
|
+
const instance: ImportEventPassResponses200Response = {
|
|
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)
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# PassResponseImportResult
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**index** | **number** | | [default to undefined]
|
|
9
|
+
**passId** | **string** | | [default to undefined]
|
|
10
|
+
**status** | **string** | | [default to undefined]
|
|
11
|
+
**message** | **string** | | [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { PassResponseImportResult } from '@connectedxm/admin-sdk';
|
|
17
|
+
|
|
18
|
+
const instance: PassResponseImportResult = {
|
|
19
|
+
index,
|
|
20
|
+
passId,
|
|
21
|
+
status,
|
|
22
|
+
message,
|
|
23
|
+
};
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# PassResponseImportSummary
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**enqueued** | **number** | | [default to undefined]
|
|
9
|
+
**results** | [**Array<PassResponseImportResult>**](PassResponseImportResult.md) | | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { PassResponseImportSummary } from '@connectedxm/admin-sdk';
|
|
15
|
+
|
|
16
|
+
const instance: PassResponseImportSummary = {
|
|
17
|
+
enqueued,
|
|
18
|
+
results,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# PassResponsesImportInputs
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**rows** | [**Array<PassResponsesImportInputsRowsInner>**](PassResponsesImportInputsRowsInner.md) | | [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { PassResponsesImportInputs } from '@connectedxm/admin-sdk';
|
|
14
|
+
|
|
15
|
+
const instance: PassResponsesImportInputs = {
|
|
16
|
+
rows,
|
|
17
|
+
};
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# PassResponsesImportInputsRowsInner
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**passId** | **string** | | [default to undefined]
|
|
9
|
+
**values** | [**Array<PassResponsesImportInputsRowsInnerValuesInner>**](PassResponsesImportInputsRowsInnerValuesInner.md) | | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { PassResponsesImportInputsRowsInner } from '@connectedxm/admin-sdk';
|
|
15
|
+
|
|
16
|
+
const instance: PassResponsesImportInputsRowsInner = {
|
|
17
|
+
passId,
|
|
18
|
+
values,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
#
|
|
1
|
+
# PassResponsesImportInputsRowsInnerValuesInner
|
|
2
2
|
|
|
3
3
|
|
|
4
4
|
## Properties
|
|
@@ -11,9 +11,9 @@ Name | Type | Description | Notes
|
|
|
11
11
|
## Example
|
|
12
12
|
|
|
13
13
|
```typescript
|
|
14
|
-
import {
|
|
14
|
+
import { PassResponsesImportInputsRowsInnerValuesInner } from '@connectedxm/admin-sdk';
|
|
15
15
|
|
|
16
|
-
const instance:
|
|
16
|
+
const instance: PassResponsesImportInputsRowsInnerValuesInner = {
|
|
17
17
|
questionId,
|
|
18
18
|
value,
|
|
19
19
|
};
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**responses** | [**Array<
|
|
8
|
+
**responses** | [**Array<PassResponsesImportInputsRowsInnerValuesInner>**](PassResponsesImportInputsRowsInnerValuesInner.md) | | [default to undefined]
|
|
9
9
|
|
|
10
10
|
## Example
|
|
11
11
|
|