@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.
@@ -1122,6 +1122,7 @@ docs/Import.md
1122
1122
  docs/ImportAllOfCount.md
1123
1123
  docs/ImportCreateInputs.md
1124
1124
  docs/ImportEventPassAttributes200Response.md
1125
+ docs/ImportEventPassResponses200Response.md
1125
1126
  docs/ImportItem.md
1126
1127
  docs/ImportItemStatus.md
1127
1128
  docs/ImportRooms200Response.md
@@ -1295,6 +1296,11 @@ docs/PassAttributesUpdateInputsValuesInner.md
1295
1296
  docs/PassChange.md
1296
1297
  docs/PassChangeLogType.md
1297
1298
  docs/PassExchange.md
1299
+ docs/PassResponseImportResult.md
1300
+ docs/PassResponseImportSummary.md
1301
+ docs/PassResponsesImportInputs.md
1302
+ docs/PassResponsesImportInputsRowsInner.md
1303
+ docs/PassResponsesImportInputsRowsInnerValuesInner.md
1298
1304
  docs/PassTypeAccessLevel.md
1299
1305
  docs/PassTypeCreateInputs.md
1300
1306
  docs/PassTypeExchangeTargetCreateInputs.md
@@ -1420,7 +1426,6 @@ docs/SeriesRegistration.md
1420
1426
  docs/SeriesRegistrationCreateInputs.md
1421
1427
  docs/SeriesRegistrationQuestionResponse.md
1422
1428
  docs/SeriesRegistrationResponsesUpdateInputs.md
1423
- docs/SeriesRegistrationResponsesUpdateInputsResponsesInner.md
1424
1429
  docs/SeriesRegistrationUpdateInputs.md
1425
1430
  docs/SeriesRegistrationsApi.md
1426
1431
  docs/SeriesTranslation.md
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- ## @connectedxm/admin-sdk@11.12.0
1
+ ## @connectedxm/admin-sdk@11.14.0
2
2
 
3
3
  This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
4
4
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
36
36
  _published:_
37
37
 
38
38
  ```
39
- npm install @connectedxm/admin-sdk@11.12.0 --save
39
+ npm install @connectedxm/admin-sdk@11.14.0 --save
40
40
  ```
41
41
 
42
42
  _unPublished (not recommended):_
package/api.ts CHANGED
@@ -4,7 +4,7 @@
4
4
  * Connected Admin API
5
5
  * The Admin API allows you to manage your Connected community programmatically.
6
6
  *
7
- * The version of the OpenAPI document: 11.12.0
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).
@@ -10844,6 +10844,16 @@ export enum ImportEventPassAttributes200ResponseStatusEnum {
10844
10844
  Ok = 'ok'
10845
10845
  }
10846
10846
 
10847
+ export interface ImportEventPassResponses200Response {
10848
+ 'status': ImportEventPassResponses200ResponseStatusEnum;
10849
+ 'message': string;
10850
+ 'data': PassResponseImportSummary;
10851
+ }
10852
+
10853
+ export enum ImportEventPassResponses200ResponseStatusEnum {
10854
+ Ok = 'ok'
10855
+ }
10856
+
10847
10857
  export interface ImportItem {
10848
10858
  'id': string;
10849
10859
  'importId': string;
@@ -12471,6 +12481,33 @@ export interface PassExchange {
12471
12481
  }
12472
12482
 
12473
12483
 
12484
+ export interface PassResponseImportResult {
12485
+ 'index': number;
12486
+ 'passId': string;
12487
+ 'status': PassResponseImportResultStatusEnum;
12488
+ 'message': string | null;
12489
+ }
12490
+
12491
+ export enum PassResponseImportResultStatusEnum {
12492
+ Resolved = 'resolved',
12493
+ Invalid = 'invalid'
12494
+ }
12495
+
12496
+ export interface PassResponseImportSummary {
12497
+ 'enqueued': number;
12498
+ 'results': Array<PassResponseImportResult>;
12499
+ }
12500
+ export interface PassResponsesImportInputs {
12501
+ 'rows': Array<PassResponsesImportInputsRowsInner>;
12502
+ }
12503
+ export interface PassResponsesImportInputsRowsInner {
12504
+ 'passId': string;
12505
+ 'values': Array<PassResponsesImportInputsRowsInnerValuesInner>;
12506
+ }
12507
+ export interface PassResponsesImportInputsRowsInnerValuesInner {
12508
+ 'questionId': string;
12509
+ 'value': string;
12510
+ }
12474
12511
 
12475
12512
  export enum PassTypeAccessLevel {
12476
12513
  Regular = 'regular',
@@ -13808,11 +13845,7 @@ export interface SeriesRegistrationQuestionResponse {
13808
13845
  'updatedAt': string;
13809
13846
  }
13810
13847
  export interface SeriesRegistrationResponsesUpdateInputs {
13811
- 'responses': Array<SeriesRegistrationResponsesUpdateInputsResponsesInner>;
13812
- }
13813
- export interface SeriesRegistrationResponsesUpdateInputsResponsesInner {
13814
- 'questionId': string;
13815
- 'value': string;
13848
+ 'responses': Array<PassResponsesImportInputsRowsInnerValuesInner>;
13816
13849
  }
13817
13850
  export interface SeriesRegistrationUpdateInputs {
13818
13851
  'status'?: PurchaseStatus;
@@ -68449,6 +68482,51 @@ export const EventsPassesResponsesApiAxiosParamCreator = function (configuration
68449
68482
  options: localVarRequestOptions,
68450
68483
  };
68451
68484
  },
68485
+ /**
68486
+ * 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.
68487
+ * @summary Bulk set registration question answers across many passes
68488
+ * @param {string} eventId The event identifier
68489
+ * @param {PassResponsesImportInputs} passResponsesImportInputs
68490
+ * @param {*} [options] Override http request option.
68491
+ * @throws {RequiredError}
68492
+ */
68493
+ importEventPassResponses: async (eventId: string, passResponsesImportInputs: PassResponsesImportInputs, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
68494
+ // verify required parameter 'eventId' is not null or undefined
68495
+ assertParamExists('importEventPassResponses', 'eventId', eventId)
68496
+ // verify required parameter 'passResponsesImportInputs' is not null or undefined
68497
+ assertParamExists('importEventPassResponses', 'passResponsesImportInputs', passResponsesImportInputs)
68498
+ const localVarPath = `/events/{eventId}/passes/responses/import`
68499
+ .replace('{eventId}', encodeURIComponent(String(eventId)));
68500
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
68501
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
68502
+ let baseOptions;
68503
+ if (configuration) {
68504
+ baseOptions = configuration.baseOptions;
68505
+ }
68506
+
68507
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
68508
+ const localVarHeaderParameter = {} as any;
68509
+ const localVarQueryParameter = {} as any;
68510
+
68511
+ // authentication ApiKeyAuth required
68512
+ await setApiKeyToObject(localVarHeaderParameter, "api-key", configuration)
68513
+
68514
+ // authentication OrganizationId required
68515
+ await setApiKeyToObject(localVarHeaderParameter, "organization", configuration)
68516
+
68517
+ localVarHeaderParameter['Content-Type'] = 'application/json';
68518
+ localVarHeaderParameter['Accept'] = 'application/json';
68519
+
68520
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
68521
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
68522
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
68523
+ localVarRequestOptions.data = serializeDataIfNeeded(passResponsesImportInputs, localVarRequestOptions, configuration)
68524
+
68525
+ return {
68526
+ url: toPathString(localVarUrlObj),
68527
+ options: localVarRequestOptions,
68528
+ };
68529
+ },
68452
68530
  /**
68453
68531
  * Updates the response value for one registration question on the specified event pass, requires read permission on events and read/update permission on attendees.
68454
68532
  * @summary Update a single registration question response
@@ -68616,6 +68694,20 @@ export const EventsPassesResponsesApiFp = function(configuration?: Configuration
68616
68694
  const localVarOperationServerBasePath = operationServerMap['EventsPassesResponsesApi.getEventPassResponses']?.[localVarOperationServerIndex]?.url;
68617
68695
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
68618
68696
  },
68697
+ /**
68698
+ * 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.
68699
+ * @summary Bulk set registration question answers across many passes
68700
+ * @param {string} eventId The event identifier
68701
+ * @param {PassResponsesImportInputs} passResponsesImportInputs
68702
+ * @param {*} [options] Override http request option.
68703
+ * @throws {RequiredError}
68704
+ */
68705
+ async importEventPassResponses(eventId: string, passResponsesImportInputs: PassResponsesImportInputs, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ImportEventPassResponses200Response>> {
68706
+ const localVarAxiosArgs = await localVarAxiosParamCreator.importEventPassResponses(eventId, passResponsesImportInputs, options);
68707
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
68708
+ const localVarOperationServerBasePath = operationServerMap['EventsPassesResponsesApi.importEventPassResponses']?.[localVarOperationServerIndex]?.url;
68709
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
68710
+ },
68619
68711
  /**
68620
68712
  * Updates the response value for one registration question on the specified event pass, requires read permission on events and read/update permission on attendees.
68621
68713
  * @summary Update a single registration question response
@@ -68687,6 +68779,16 @@ export const EventsPassesResponsesApiFactory = function (configuration?: Configu
68687
68779
  getEventPassResponses(requestParameters: EventsPassesResponsesApiGetEventPassResponsesRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetEventPassResponses200Response> {
68688
68780
  return localVarFp.getEventPassResponses(requestParameters.eventId, requestParameters.passId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
68689
68781
  },
68782
+ /**
68783
+ * 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.
68784
+ * @summary Bulk set registration question answers across many passes
68785
+ * @param {EventsPassesResponsesApiImportEventPassResponsesRequest} requestParameters Request parameters.
68786
+ * @param {*} [options] Override http request option.
68787
+ * @throws {RequiredError}
68788
+ */
68789
+ importEventPassResponses(requestParameters: EventsPassesResponsesApiImportEventPassResponsesRequest, options?: RawAxiosRequestConfig): AxiosPromise<ImportEventPassResponses200Response> {
68790
+ return localVarFp.importEventPassResponses(requestParameters.eventId, requestParameters.passResponsesImportInputs, options).then((request) => request(axios, basePath));
68791
+ },
68690
68792
  /**
68691
68793
  * Updates the response value for one registration question on the specified event pass, requires read permission on events and read/update permission on attendees.
68692
68794
  * @summary Update a single registration question response
@@ -68805,6 +68907,18 @@ export interface EventsPassesResponsesApiGetEventPassResponsesRequest {
68805
68907
  readonly search?: string
68806
68908
  }
68807
68909
 
68910
+ /**
68911
+ * Request parameters for importEventPassResponses operation in EventsPassesResponsesApi.
68912
+ */
68913
+ export interface EventsPassesResponsesApiImportEventPassResponsesRequest {
68914
+ /**
68915
+ * The event identifier
68916
+ */
68917
+ readonly eventId: string
68918
+
68919
+ readonly passResponsesImportInputs: PassResponsesImportInputs
68920
+ }
68921
+
68808
68922
  /**
68809
68923
  * Request parameters for updateEventPassResponse operation in EventsPassesResponsesApi.
68810
68924
  */
@@ -68886,6 +69000,17 @@ export class EventsPassesResponsesApi extends BaseAPI {
68886
69000
  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));
68887
69001
  }
68888
69002
 
69003
+ /**
69004
+ * 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.
69005
+ * @summary Bulk set registration question answers across many passes
69006
+ * @param {EventsPassesResponsesApiImportEventPassResponsesRequest} requestParameters Request parameters.
69007
+ * @param {*} [options] Override http request option.
69008
+ * @throws {RequiredError}
69009
+ */
69010
+ public importEventPassResponses(requestParameters: EventsPassesResponsesApiImportEventPassResponsesRequest, options?: RawAxiosRequestConfig) {
69011
+ return EventsPassesResponsesApiFp(this.configuration).importEventPassResponses(requestParameters.eventId, requestParameters.passResponsesImportInputs, options).then((request) => request(this.axios, this.basePath));
69012
+ }
69013
+
68889
69014
  /**
68890
69015
  * Updates the response value for one registration question on the specified event pass, requires read permission on events and read/update permission on attendees.
68891
69016
  * @summary Update a single registration question response
@@ -86333,7 +86458,7 @@ export const EventsSessionsApiAxiosParamCreator = function (configuration?: Conf
86333
86458
  };
86334
86459
  },
86335
86460
  /**
86336
- * 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. Returns the number of passes that were eligible when the job was queued; requires update permission on attendees.
86461
+ * 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.
86337
86462
  * @summary Grant session access to every pass of a pass type
86338
86463
  * @param {string} eventId The event identifier
86339
86464
  * @param {string} sessionId The session identifier
@@ -87893,7 +88018,7 @@ export const EventsSessionsApiFp = function(configuration?: Configuration) {
87893
88018
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
87894
88019
  },
87895
88020
  /**
87896
- * 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. Returns the number of passes that were eligible when the job was queued; requires update permission on attendees.
88021
+ * 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.
87897
88022
  * @summary Grant session access to every pass of a pass type
87898
88023
  * @param {string} eventId The event identifier
87899
88024
  * @param {string} sessionId The session identifier
@@ -87901,7 +88026,7 @@ export const EventsSessionsApiFp = function(configuration?: Configuration) {
87901
88026
  * @param {*} [options] Override http request option.
87902
88027
  * @throws {RequiredError}
87903
88028
  */
87904
- async createEventSessionPassTypeAccesses(eventId: string, sessionId: string, createEventSessionPassTypeAccessesRequest: CreateEventSessionPassTypeAccessesRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SyncAccounts200Response>> {
88029
+ async createEventSessionPassTypeAccesses(eventId: string, sessionId: string, createEventSessionPassTypeAccessesRequest: CreateEventSessionPassTypeAccessesRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateAccountInvitations200Response>> {
87905
88030
  const localVarAxiosArgs = await localVarAxiosParamCreator.createEventSessionPassTypeAccesses(eventId, sessionId, createEventSessionPassTypeAccessesRequest, options);
87906
88031
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
87907
88032
  const localVarOperationServerBasePath = operationServerMap['EventsSessionsApi.createEventSessionPassTypeAccesses']?.[localVarOperationServerIndex]?.url;
@@ -88421,13 +88546,13 @@ export const EventsSessionsApiFactory = function (configuration?: Configuration,
88421
88546
  return localVarFp.createEventSession(requestParameters.eventId, requestParameters.eventSessionCreateInputs, options).then((request) => request(axios, basePath));
88422
88547
  },
88423
88548
  /**
88424
- * 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. Returns the number of passes that were eligible when the job was queued; requires update permission on attendees.
88549
+ * 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.
88425
88550
  * @summary Grant session access to every pass of a pass type
88426
88551
  * @param {EventsSessionsApiCreateEventSessionPassTypeAccessesRequest} requestParameters Request parameters.
88427
88552
  * @param {*} [options] Override http request option.
88428
88553
  * @throws {RequiredError}
88429
88554
  */
88430
- createEventSessionPassTypeAccesses(requestParameters: EventsSessionsApiCreateEventSessionPassTypeAccessesRequest, options?: RawAxiosRequestConfig): AxiosPromise<SyncAccounts200Response> {
88555
+ createEventSessionPassTypeAccesses(requestParameters: EventsSessionsApiCreateEventSessionPassTypeAccessesRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateAccountInvitations200Response> {
88431
88556
  return localVarFp.createEventSessionPassTypeAccesses(requestParameters.eventId, requestParameters.sessionId, requestParameters.createEventSessionPassTypeAccessesRequest, options).then((request) => request(axios, basePath));
88432
88557
  },
88433
88558
  /**
@@ -89672,7 +89797,7 @@ export class EventsSessionsApi extends BaseAPI {
89672
89797
  }
89673
89798
 
89674
89799
  /**
89675
- * 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. Returns the number of passes that were eligible when the job was queued; requires update permission on attendees.
89800
+ * 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.
89676
89801
  * @summary Grant session access to every pass of a pass type
89677
89802
  * @param {EventsSessionsApiCreateEventSessionPassTypeAccessesRequest} requestParameters Request parameters.
89678
89803
  * @param {*} [options] Override http request option.
package/base.ts CHANGED
@@ -4,7 +4,7 @@
4
4
  * Connected Admin API
5
5
  * The Admin API allows you to manage your Connected community programmatically.
6
6
  *
7
- * The version of the OpenAPI document: 11.12.0
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/common.ts CHANGED
@@ -4,7 +4,7 @@
4
4
  * Connected Admin API
5
5
  * The Admin API allows you to manage your Connected community programmatically.
6
6
  *
7
- * The version of the OpenAPI document: 11.12.0
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/configuration.ts CHANGED
@@ -3,7 +3,7 @@
3
3
  * Connected Admin API
4
4
  * The Admin API allows you to manage your Connected community programmatically.
5
5
  *
6
- * The version of the OpenAPI document: 11.12.0
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).
package/dist/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.12.0
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<SeriesRegistrationResponsesUpdateInputsResponsesInner>;
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. Returns the number of passes that were eligible when the job was queued; requires update permission on attendees.
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. Returns the number of passes that were eligible when the job was queued; requires update permission on attendees.
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<SyncAccounts200Response>>;
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. Returns the number of passes that were eligible when the job was queued; requires update permission on attendees.
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<SyncAccounts200Response>;
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. Returns the number of passes that were eligible when the job was queued; requires update permission on attendees.
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<SyncAccounts200Response, any, {}, any>>;
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