@connectedxm/admin-sdk 11.12.0 → 11.14.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 +6 -1
- package/README.md +2 -2
- package/api.ts +137 -12
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +86 -13
- package/dist/api.js +110 -25
- 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 +86 -13
- package/dist/esm/api.js +90 -5
- 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/EventsPassesResponsesApi.md +56 -0
- package/docs/EventsSessionsApi.md +3 -3
- 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.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.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -9572,6 +9572,14 @@ export interface ImportEventPassAttributes200Response {
|
|
|
9572
9572
|
export declare enum ImportEventPassAttributes200ResponseStatusEnum {
|
|
9573
9573
|
Ok = "ok"
|
|
9574
9574
|
}
|
|
9575
|
+
export interface ImportEventPassResponses200Response {
|
|
9576
|
+
'status': ImportEventPassResponses200ResponseStatusEnum;
|
|
9577
|
+
'message': string;
|
|
9578
|
+
'data': PassResponseImportSummary;
|
|
9579
|
+
}
|
|
9580
|
+
export declare enum ImportEventPassResponses200ResponseStatusEnum {
|
|
9581
|
+
Ok = "ok"
|
|
9582
|
+
}
|
|
9575
9583
|
export interface ImportItem {
|
|
9576
9584
|
'id': string;
|
|
9577
9585
|
'importId': string;
|
|
@@ -11076,6 +11084,31 @@ export interface PassExchange {
|
|
|
11076
11084
|
'pass': BaseEventPass;
|
|
11077
11085
|
'createdAt': string;
|
|
11078
11086
|
}
|
|
11087
|
+
export interface PassResponseImportResult {
|
|
11088
|
+
'index': number;
|
|
11089
|
+
'passId': string;
|
|
11090
|
+
'status': PassResponseImportResultStatusEnum;
|
|
11091
|
+
'message': string | null;
|
|
11092
|
+
}
|
|
11093
|
+
export declare enum PassResponseImportResultStatusEnum {
|
|
11094
|
+
Resolved = "resolved",
|
|
11095
|
+
Invalid = "invalid"
|
|
11096
|
+
}
|
|
11097
|
+
export interface PassResponseImportSummary {
|
|
11098
|
+
'enqueued': number;
|
|
11099
|
+
'results': Array<PassResponseImportResult>;
|
|
11100
|
+
}
|
|
11101
|
+
export interface PassResponsesImportInputs {
|
|
11102
|
+
'rows': Array<PassResponsesImportInputsRowsInner>;
|
|
11103
|
+
}
|
|
11104
|
+
export interface PassResponsesImportInputsRowsInner {
|
|
11105
|
+
'passId': string;
|
|
11106
|
+
'values': Array<PassResponsesImportInputsRowsInnerValuesInner>;
|
|
11107
|
+
}
|
|
11108
|
+
export interface PassResponsesImportInputsRowsInnerValuesInner {
|
|
11109
|
+
'questionId': string;
|
|
11110
|
+
'value': string;
|
|
11111
|
+
}
|
|
11079
11112
|
export declare enum PassTypeAccessLevel {
|
|
11080
11113
|
Regular = "regular",
|
|
11081
11114
|
Virtual = "virtual",
|
|
@@ -12292,11 +12325,7 @@ export interface SeriesRegistrationQuestionResponse {
|
|
|
12292
12325
|
'updatedAt': string;
|
|
12293
12326
|
}
|
|
12294
12327
|
export interface SeriesRegistrationResponsesUpdateInputs {
|
|
12295
|
-
'responses': Array<
|
|
12296
|
-
}
|
|
12297
|
-
export interface SeriesRegistrationResponsesUpdateInputsResponsesInner {
|
|
12298
|
-
'questionId': string;
|
|
12299
|
-
'value': string;
|
|
12328
|
+
'responses': Array<PassResponsesImportInputsRowsInnerValuesInner>;
|
|
12300
12329
|
}
|
|
12301
12330
|
export interface SeriesRegistrationUpdateInputs {
|
|
12302
12331
|
'status'?: PurchaseStatus;
|
|
@@ -40540,6 +40569,15 @@ export declare const EventsPassesResponsesApiAxiosParamCreator: (configuration?:
|
|
|
40540
40569
|
* @throws {RequiredError}
|
|
40541
40570
|
*/
|
|
40542
40571
|
getEventPassResponses: (eventId: string, passId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
40572
|
+
/**
|
|
40573
|
+
* 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.
|
|
40574
|
+
* @summary Bulk set registration question answers across many passes
|
|
40575
|
+
* @param {string} eventId The event identifier
|
|
40576
|
+
* @param {PassResponsesImportInputs} passResponsesImportInputs
|
|
40577
|
+
* @param {*} [options] Override http request option.
|
|
40578
|
+
* @throws {RequiredError}
|
|
40579
|
+
*/
|
|
40580
|
+
importEventPassResponses: (eventId: string, passResponsesImportInputs: PassResponsesImportInputs, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
40543
40581
|
/**
|
|
40544
40582
|
* Updates the response value for one registration question on the specified event pass, requires read permission on events and read/update permission on attendees.
|
|
40545
40583
|
* @summary Update a single registration question response
|
|
@@ -40604,6 +40642,15 @@ export declare const EventsPassesResponsesApiFp: (configuration?: Configuration)
|
|
|
40604
40642
|
* @throws {RequiredError}
|
|
40605
40643
|
*/
|
|
40606
40644
|
getEventPassResponses(eventId: string, passId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetEventPassResponses200Response>>;
|
|
40645
|
+
/**
|
|
40646
|
+
* 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.
|
|
40647
|
+
* @summary Bulk set registration question answers across many passes
|
|
40648
|
+
* @param {string} eventId The event identifier
|
|
40649
|
+
* @param {PassResponsesImportInputs} passResponsesImportInputs
|
|
40650
|
+
* @param {*} [options] Override http request option.
|
|
40651
|
+
* @throws {RequiredError}
|
|
40652
|
+
*/
|
|
40653
|
+
importEventPassResponses(eventId: string, passResponsesImportInputs: PassResponsesImportInputs, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ImportEventPassResponses200Response>>;
|
|
40607
40654
|
/**
|
|
40608
40655
|
* Updates the response value for one registration question on the specified event pass, requires read permission on events and read/update permission on attendees.
|
|
40609
40656
|
* @summary Update a single registration question response
|
|
@@ -40655,6 +40702,14 @@ export declare const EventsPassesResponsesApiFactory: (configuration?: Configura
|
|
|
40655
40702
|
* @throws {RequiredError}
|
|
40656
40703
|
*/
|
|
40657
40704
|
getEventPassResponses(requestParameters: EventsPassesResponsesApiGetEventPassResponsesRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetEventPassResponses200Response>;
|
|
40705
|
+
/**
|
|
40706
|
+
* 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.
|
|
40707
|
+
* @summary Bulk set registration question answers across many passes
|
|
40708
|
+
* @param {EventsPassesResponsesApiImportEventPassResponsesRequest} requestParameters Request parameters.
|
|
40709
|
+
* @param {*} [options] Override http request option.
|
|
40710
|
+
* @throws {RequiredError}
|
|
40711
|
+
*/
|
|
40712
|
+
importEventPassResponses(requestParameters: EventsPassesResponsesApiImportEventPassResponsesRequest, options?: RawAxiosRequestConfig): AxiosPromise<ImportEventPassResponses200Response>;
|
|
40658
40713
|
/**
|
|
40659
40714
|
* Updates the response value for one registration question on the specified event pass, requires read permission on events and read/update permission on attendees.
|
|
40660
40715
|
* @summary Update a single registration question response
|
|
@@ -40751,6 +40806,16 @@ export interface EventsPassesResponsesApiGetEventPassResponsesRequest {
|
|
|
40751
40806
|
*/
|
|
40752
40807
|
readonly search?: string;
|
|
40753
40808
|
}
|
|
40809
|
+
/**
|
|
40810
|
+
* Request parameters for importEventPassResponses operation in EventsPassesResponsesApi.
|
|
40811
|
+
*/
|
|
40812
|
+
export interface EventsPassesResponsesApiImportEventPassResponsesRequest {
|
|
40813
|
+
/**
|
|
40814
|
+
* The event identifier
|
|
40815
|
+
*/
|
|
40816
|
+
readonly eventId: string;
|
|
40817
|
+
readonly passResponsesImportInputs: PassResponsesImportInputs;
|
|
40818
|
+
}
|
|
40754
40819
|
/**
|
|
40755
40820
|
* Request parameters for updateEventPassResponse operation in EventsPassesResponsesApi.
|
|
40756
40821
|
*/
|
|
@@ -40815,6 +40880,14 @@ export declare class EventsPassesResponsesApi extends BaseAPI {
|
|
|
40815
40880
|
* @throws {RequiredError}
|
|
40816
40881
|
*/
|
|
40817
40882
|
getEventPassResponses(requestParameters: EventsPassesResponsesApiGetEventPassResponsesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetEventPassResponses200Response, any, {}, any>>;
|
|
40883
|
+
/**
|
|
40884
|
+
* 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.
|
|
40885
|
+
* @summary Bulk set registration question answers across many passes
|
|
40886
|
+
* @param {EventsPassesResponsesApiImportEventPassResponsesRequest} requestParameters Request parameters.
|
|
40887
|
+
* @param {*} [options] Override http request option.
|
|
40888
|
+
* @throws {RequiredError}
|
|
40889
|
+
*/
|
|
40890
|
+
importEventPassResponses(requestParameters: EventsPassesResponsesApiImportEventPassResponsesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ImportEventPassResponses200Response, any, {}, any>>;
|
|
40818
40891
|
/**
|
|
40819
40892
|
* Updates the response value for one registration question on the specified event pass, requires read permission on events and read/update permission on attendees.
|
|
40820
40893
|
* @summary Update a single registration question response
|
|
@@ -49539,7 +49612,7 @@ export declare const EventsSessionsApiAxiosParamCreator: (configuration?: Config
|
|
|
49539
49612
|
*/
|
|
49540
49613
|
createEventSession: (eventId: string, eventSessionCreateInputs: EventSessionCreateInputs, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
49541
49614
|
/**
|
|
49542
|
-
* Queues a background job that gives every ready or needsInfo pass of the specified pass type access to the session. Passes that already hold access are skipped and ones whose access was canceled are left alone, but a draft access is promoted to ready
|
|
49615
|
+
* Queues a background job that gives every ready or needsInfo pass of the specified pass type access to the session. Passes that already hold access are skipped and ones whose access was canceled are left alone, but a draft access is promoted to ready unless it belongs to an open checkout. Returns as soon as the job is queued, without waiting for it; requires update permission on attendees.
|
|
49543
49616
|
* @summary Grant session access to every pass of a pass type
|
|
49544
49617
|
* @param {string} eventId The event identifier
|
|
49545
49618
|
* @param {string} sessionId The session identifier
|
|
@@ -49937,7 +50010,7 @@ export declare const EventsSessionsApiFp: (configuration?: Configuration) => {
|
|
|
49937
50010
|
*/
|
|
49938
50011
|
createEventSession(eventId: string, eventSessionCreateInputs: EventSessionCreateInputs, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateEventSession200Response>>;
|
|
49939
50012
|
/**
|
|
49940
|
-
* Queues a background job that gives every ready or needsInfo pass of the specified pass type access to the session. Passes that already hold access are skipped and ones whose access was canceled are left alone, but a draft access is promoted to ready
|
|
50013
|
+
* Queues a background job that gives every ready or needsInfo pass of the specified pass type access to the session. Passes that already hold access are skipped and ones whose access was canceled are left alone, but a draft access is promoted to ready unless it belongs to an open checkout. Returns as soon as the job is queued, without waiting for it; requires update permission on attendees.
|
|
49941
50014
|
* @summary Grant session access to every pass of a pass type
|
|
49942
50015
|
* @param {string} eventId The event identifier
|
|
49943
50016
|
* @param {string} sessionId The session identifier
|
|
@@ -49945,7 +50018,7 @@ export declare const EventsSessionsApiFp: (configuration?: Configuration) => {
|
|
|
49945
50018
|
* @param {*} [options] Override http request option.
|
|
49946
50019
|
* @throws {RequiredError}
|
|
49947
50020
|
*/
|
|
49948
|
-
createEventSessionPassTypeAccesses(eventId: string, sessionId: string, createEventSessionPassTypeAccessesRequest: CreateEventSessionPassTypeAccessesRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
50021
|
+
createEventSessionPassTypeAccesses(eventId: string, sessionId: string, createEventSessionPassTypeAccessesRequest: CreateEventSessionPassTypeAccessesRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAccountInvitations200Response>>;
|
|
49949
50022
|
/**
|
|
49950
50023
|
* Permanently deletes the specified session from the given event; requires update permission on events.
|
|
49951
50024
|
* @summary Delete an event session
|
|
@@ -50314,13 +50387,13 @@ export declare const EventsSessionsApiFactory: (configuration?: Configuration, b
|
|
|
50314
50387
|
*/
|
|
50315
50388
|
createEventSession(requestParameters: EventsSessionsApiCreateEventSessionRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateEventSession200Response>;
|
|
50316
50389
|
/**
|
|
50317
|
-
* Queues a background job that gives every ready or needsInfo pass of the specified pass type access to the session. Passes that already hold access are skipped and ones whose access was canceled are left alone, but a draft access is promoted to ready
|
|
50390
|
+
* Queues a background job that gives every ready or needsInfo pass of the specified pass type access to the session. Passes that already hold access are skipped and ones whose access was canceled are left alone, but a draft access is promoted to ready unless it belongs to an open checkout. Returns as soon as the job is queued, without waiting for it; requires update permission on attendees.
|
|
50318
50391
|
* @summary Grant session access to every pass of a pass type
|
|
50319
50392
|
* @param {EventsSessionsApiCreateEventSessionPassTypeAccessesRequest} requestParameters Request parameters.
|
|
50320
50393
|
* @param {*} [options] Override http request option.
|
|
50321
50394
|
* @throws {RequiredError}
|
|
50322
50395
|
*/
|
|
50323
|
-
createEventSessionPassTypeAccesses(requestParameters: EventsSessionsApiCreateEventSessionPassTypeAccessesRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
50396
|
+
createEventSessionPassTypeAccesses(requestParameters: EventsSessionsApiCreateEventSessionPassTypeAccessesRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAccountInvitations200Response>;
|
|
50324
50397
|
/**
|
|
50325
50398
|
* Permanently deletes the specified session from the given event; requires update permission on events.
|
|
50326
50399
|
* @summary Delete an event session
|
|
@@ -51339,13 +51412,13 @@ export declare class EventsSessionsApi extends BaseAPI {
|
|
|
51339
51412
|
*/
|
|
51340
51413
|
createEventSession(requestParameters: EventsSessionsApiCreateEventSessionRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateEventSession200Response, any, {}, any>>;
|
|
51341
51414
|
/**
|
|
51342
|
-
* Queues a background job that gives every ready or needsInfo pass of the specified pass type access to the session. Passes that already hold access are skipped and ones whose access was canceled are left alone, but a draft access is promoted to ready
|
|
51415
|
+
* Queues a background job that gives every ready or needsInfo pass of the specified pass type access to the session. Passes that already hold access are skipped and ones whose access was canceled are left alone, but a draft access is promoted to ready unless it belongs to an open checkout. Returns as soon as the job is queued, without waiting for it; requires update permission on attendees.
|
|
51343
51416
|
* @summary Grant session access to every pass of a pass type
|
|
51344
51417
|
* @param {EventsSessionsApiCreateEventSessionPassTypeAccessesRequest} requestParameters Request parameters.
|
|
51345
51418
|
* @param {*} [options] Override http request option.
|
|
51346
51419
|
* @throws {RequiredError}
|
|
51347
51420
|
*/
|
|
51348
|
-
createEventSessionPassTypeAccesses(requestParameters: EventsSessionsApiCreateEventSessionPassTypeAccessesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
51421
|
+
createEventSessionPassTypeAccesses(requestParameters: EventsSessionsApiCreateEventSessionPassTypeAccessesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateAccountInvitations200Response, any, {}, any>>;
|
|
51349
51422
|
/**
|
|
51350
51423
|
* Permanently deletes the specified session from the given event; requires update permission on events.
|
|
51351
51424
|
* @summary Delete an event session
|
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.0
|
|
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
|
|
@@ -56799,7 +56884,7 @@ export const EventsSessionsApiAxiosParamCreator = function (configuration) {
|
|
|
56799
56884
|
};
|
|
56800
56885
|
}),
|
|
56801
56886
|
/**
|
|
56802
|
-
* Queues a background job that gives every ready or needsInfo pass of the specified pass type access to the session. Passes that already hold access are skipped and ones whose access was canceled are left alone, but a draft access is promoted to ready
|
|
56887
|
+
* Queues a background job that gives every ready or needsInfo pass of the specified pass type access to the session. Passes that already hold access are skipped and ones whose access was canceled are left alone, but a draft access is promoted to ready unless it belongs to an open checkout. Returns as soon as the job is queued, without waiting for it; requires update permission on attendees.
|
|
56803
56888
|
* @summary Grant session access to every pass of a pass type
|
|
56804
56889
|
* @param {string} eventId The event identifier
|
|
56805
56890
|
* @param {string} sessionId The session identifier
|
|
@@ -58192,7 +58277,7 @@ export const EventsSessionsApiFp = function (configuration) {
|
|
|
58192
58277
|
});
|
|
58193
58278
|
},
|
|
58194
58279
|
/**
|
|
58195
|
-
* Queues a background job that gives every ready or needsInfo pass of the specified pass type access to the session. Passes that already hold access are skipped and ones whose access was canceled are left alone, but a draft access is promoted to ready
|
|
58280
|
+
* Queues a background job that gives every ready or needsInfo pass of the specified pass type access to the session. Passes that already hold access are skipped and ones whose access was canceled are left alone, but a draft access is promoted to ready unless it belongs to an open checkout. Returns as soon as the job is queued, without waiting for it; requires update permission on attendees.
|
|
58196
58281
|
* @summary Grant session access to every pass of a pass type
|
|
58197
58282
|
* @param {string} eventId The event identifier
|
|
58198
58283
|
* @param {string} sessionId The session identifier
|
|
@@ -58794,7 +58879,7 @@ export const EventsSessionsApiFactory = function (configuration, basePath, axios
|
|
|
58794
58879
|
return localVarFp.createEventSession(requestParameters.eventId, requestParameters.eventSessionCreateInputs, options).then((request) => request(axios, basePath));
|
|
58795
58880
|
},
|
|
58796
58881
|
/**
|
|
58797
|
-
* Queues a background job that gives every ready or needsInfo pass of the specified pass type access to the session. Passes that already hold access are skipped and ones whose access was canceled are left alone, but a draft access is promoted to ready
|
|
58882
|
+
* Queues a background job that gives every ready or needsInfo pass of the specified pass type access to the session. Passes that already hold access are skipped and ones whose access was canceled are left alone, but a draft access is promoted to ready unless it belongs to an open checkout. Returns as soon as the job is queued, without waiting for it; requires update permission on attendees.
|
|
58798
58883
|
* @summary Grant session access to every pass of a pass type
|
|
58799
58884
|
* @param {EventsSessionsApiCreateEventSessionPassTypeAccessesRequest} requestParameters Request parameters.
|
|
58800
58885
|
* @param {*} [options] Override http request option.
|
|
@@ -59160,7 +59245,7 @@ export class EventsSessionsApi extends BaseAPI {
|
|
|
59160
59245
|
return EventsSessionsApiFp(this.configuration).createEventSession(requestParameters.eventId, requestParameters.eventSessionCreateInputs, options).then((request) => request(this.axios, this.basePath));
|
|
59161
59246
|
}
|
|
59162
59247
|
/**
|
|
59163
|
-
* Queues a background job that gives every ready or needsInfo pass of the specified pass type access to the session. Passes that already hold access are skipped and ones whose access was canceled are left alone, but a draft access is promoted to ready
|
|
59248
|
+
* Queues a background job that gives every ready or needsInfo pass of the specified pass type access to the session. Passes that already hold access are skipped and ones whose access was canceled are left alone, but a draft access is promoted to ready unless it belongs to an open checkout. Returns as soon as the job is queued, without waiting for it; requires update permission on attendees.
|
|
59164
59249
|
* @summary Grant session access to every pass of a pass type
|
|
59165
59250
|
* @param {EventsSessionsApiCreateEventSessionPassTypeAccessesRequest} requestParameters Request parameters.
|
|
59166
59251
|
* @param {*} [options] Override http request option.
|
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.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: 11.
|
|
7
|
+
* The version of the OpenAPI document: 11.14.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: 11.
|
|
5
|
+
* The version of the OpenAPI document: 11.14.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: 11.
|
|
7
|
+
* The version of the OpenAPI document: 11.14.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: 11.
|
|
5
|
+
* The version of the OpenAPI document: 11.14.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: 11.
|
|
6
|
+
* The version of the OpenAPI document: 11.14.0
|
|
7
7
|
*
|
|
8
8
|
*
|
|
9
9
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -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
|
|-------------|-------------|------------------|
|
|
@@ -668,9 +668,9 @@ const { status, data } = await apiInstance.createEventSession(
|
|
|
668
668
|
[[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)
|
|
669
669
|
|
|
670
670
|
# **createEventSessionPassTypeAccesses**
|
|
671
|
-
>
|
|
671
|
+
> CreateAccountInvitations200Response createEventSessionPassTypeAccesses(createEventSessionPassTypeAccessesRequest)
|
|
672
672
|
|
|
673
|
-
Queues a background job that gives every ready or needsInfo pass of the specified pass type access to the session. Passes that already hold access are skipped and ones whose access was canceled are left alone, but a draft access is promoted to ready
|
|
673
|
+
Queues a background job that gives every ready or needsInfo pass of the specified pass type access to the session. Passes that already hold access are skipped and ones whose access was canceled are left alone, but a draft access is promoted to ready unless it belongs to an open checkout. Returns as soon as the job is queued, without waiting for it; requires update permission on attendees.
|
|
674
674
|
|
|
675
675
|
### Example
|
|
676
676
|
|
|
@@ -706,7 +706,7 @@ const { status, data } = await apiInstance.createEventSessionPassTypeAccesses(
|
|
|
706
706
|
|
|
707
707
|
### Return type
|
|
708
708
|
|
|
709
|
-
**
|
|
709
|
+
**CreateAccountInvitations200Response**
|
|
710
710
|
|
|
711
711
|
### Authorization
|
|
712
712
|
|
|
@@ -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)
|