@connectedxm/admin-sdk 11.9.0 → 11.10.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/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.9.0
5
+ * The version of the OpenAPI document: 11.10.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -9561,6 +9561,14 @@ export interface ImportCreateInputs {
9561
9561
  'values'?: Array<AddEventAccessUserRequest> | null;
9562
9562
  'type'?: ImportType | null;
9563
9563
  }
9564
+ export interface ImportEventPassAttributes200Response {
9565
+ 'status': ImportEventPassAttributes200ResponseStatusEnum;
9566
+ 'message': string;
9567
+ 'data': PassAttributeImportSummary;
9568
+ }
9569
+ export declare enum ImportEventPassAttributes200ResponseStatusEnum {
9570
+ Ok = "ok"
9571
+ }
9564
9572
  export interface ImportItem {
9565
9573
  'id': string;
9566
9574
  'importId': string;
@@ -10999,6 +11007,29 @@ export interface PassAttribute {
10999
11007
  'createdAt': string;
11000
11008
  'updatedAt': string;
11001
11009
  }
11010
+ export interface PassAttributeImportResult {
11011
+ 'index': number;
11012
+ 'passId': string;
11013
+ 'status': PassAttributeImportResultStatusEnum;
11014
+ 'message': string | null;
11015
+ }
11016
+ export declare enum PassAttributeImportResultStatusEnum {
11017
+ Resolved = "resolved",
11018
+ Invalid = "invalid"
11019
+ }
11020
+ export interface PassAttributeImportSummary {
11021
+ 'created': number;
11022
+ 'updated': number;
11023
+ 'unchanged': number;
11024
+ 'results': Array<PassAttributeImportResult>;
11025
+ }
11026
+ export interface PassAttributesImportInputs {
11027
+ 'rows': Array<PassAttributesImportInputsRowsInner>;
11028
+ }
11029
+ export interface PassAttributesImportInputsRowsInner {
11030
+ 'passId': string;
11031
+ 'values': Array<PassAttributesUpdateInputsValuesInner>;
11032
+ }
11002
11033
  export interface PassAttributesUpdateInputs {
11003
11034
  'values': Array<PassAttributesUpdateInputsValuesInner>;
11004
11035
  }
@@ -13638,6 +13669,7 @@ export interface UserApiKey {
13638
13669
  'key': string;
13639
13670
  'name': string;
13640
13671
  'description'?: string;
13672
+ 'scope': UserApiKeyScope;
13641
13673
  'startDate': string;
13642
13674
  'endDate': string;
13643
13675
  'createdAt': string;
@@ -13646,10 +13678,15 @@ export interface UserApiKey {
13646
13678
  }
13647
13679
  export interface UserApiKeyCreateInputs {
13648
13680
  'name': string;
13681
+ 'scope'?: UserApiKeyScope;
13649
13682
  'startDate': string;
13650
13683
  'endDate'?: string;
13651
13684
  'description'?: string | null;
13652
13685
  }
13686
+ export declare enum UserApiKeyScope {
13687
+ Read = "read",
13688
+ Full = "full"
13689
+ }
13653
13690
  export interface UserImageUpdateInputs {
13654
13691
  'imageDataUri'?: UserImageUpdateInputsImageDataUri;
13655
13692
  'userId'?: UserImageUpdateInputsImageDataUri;
@@ -39945,6 +39982,15 @@ export declare const EventsPassesAttributesApiAxiosParamCreator: (configuration?
39945
39982
  * @throws {RequiredError}
39946
39983
  */
39947
39984
  getEventPassAttributes: (eventId: string, passId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
39985
+ /**
39986
+ * Creates or updates attribute values 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, and each attributeId may be an attribute id or its name. Rows whose pass or attribute cannot be resolved are reported back as invalid and skipped rather than failing the batch. Requires read permission on events and read/update permission on attendees.
39987
+ * @summary Bulk set custom attribute values across many passes
39988
+ * @param {string} eventId The event identifier
39989
+ * @param {PassAttributesImportInputs} passAttributesImportInputs
39990
+ * @param {*} [options] Override http request option.
39991
+ * @throws {RequiredError}
39992
+ */
39993
+ importEventPassAttributes: (eventId: string, passAttributesImportInputs: PassAttributesImportInputs, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
39948
39994
  /**
39949
39995
  * Deletes a single custom attribute value that had been set on the specified event pass, requires read permission on events and read/update permission on attendees.
39950
39996
  * @summary Remove a custom attribute from a pass
@@ -39983,6 +40029,15 @@ export declare const EventsPassesAttributesApiFp: (configuration?: Configuration
39983
40029
  * @throws {RequiredError}
39984
40030
  */
39985
40031
  getEventPassAttributes(eventId: string, passId: string, page?: number, pageSize?: number, orderBy?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetEventPassAttributes200Response>>;
40032
+ /**
40033
+ * Creates or updates attribute values 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, and each attributeId may be an attribute id or its name. Rows whose pass or attribute cannot be resolved are reported back as invalid and skipped rather than failing the batch. Requires read permission on events and read/update permission on attendees.
40034
+ * @summary Bulk set custom attribute values across many passes
40035
+ * @param {string} eventId The event identifier
40036
+ * @param {PassAttributesImportInputs} passAttributesImportInputs
40037
+ * @param {*} [options] Override http request option.
40038
+ * @throws {RequiredError}
40039
+ */
40040
+ importEventPassAttributes(eventId: string, passAttributesImportInputs: PassAttributesImportInputs, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ImportEventPassAttributes200Response>>;
39986
40041
  /**
39987
40042
  * Deletes a single custom attribute value that had been set on the specified event pass, requires read permission on events and read/update permission on attendees.
39988
40043
  * @summary Remove a custom attribute from a pass
@@ -40016,6 +40071,14 @@ export declare const EventsPassesAttributesApiFactory: (configuration?: Configur
40016
40071
  * @throws {RequiredError}
40017
40072
  */
40018
40073
  getEventPassAttributes(requestParameters: EventsPassesAttributesApiGetEventPassAttributesRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetEventPassAttributes200Response>;
40074
+ /**
40075
+ * Creates or updates attribute values 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, and each attributeId may be an attribute id or its name. Rows whose pass or attribute cannot be resolved are reported back as invalid and skipped rather than failing the batch. Requires read permission on events and read/update permission on attendees.
40076
+ * @summary Bulk set custom attribute values across many passes
40077
+ * @param {EventsPassesAttributesApiImportEventPassAttributesRequest} requestParameters Request parameters.
40078
+ * @param {*} [options] Override http request option.
40079
+ * @throws {RequiredError}
40080
+ */
40081
+ importEventPassAttributes(requestParameters: EventsPassesAttributesApiImportEventPassAttributesRequest, options?: RawAxiosRequestConfig): AxiosPromise<ImportEventPassAttributes200Response>;
40019
40082
  /**
40020
40083
  * Deletes a single custom attribute value that had been set on the specified event pass, requires read permission on events and read/update permission on attendees.
40021
40084
  * @summary Remove a custom attribute from a pass
@@ -40062,6 +40125,16 @@ export interface EventsPassesAttributesApiGetEventPassAttributesRequest {
40062
40125
  */
40063
40126
  readonly search?: string;
40064
40127
  }
40128
+ /**
40129
+ * Request parameters for importEventPassAttributes operation in EventsPassesAttributesApi.
40130
+ */
40131
+ export interface EventsPassesAttributesApiImportEventPassAttributesRequest {
40132
+ /**
40133
+ * The event identifier
40134
+ */
40135
+ readonly eventId: string;
40136
+ readonly passAttributesImportInputs: PassAttributesImportInputs;
40137
+ }
40065
40138
  /**
40066
40139
  * Request parameters for removeEventPassAttribute operation in EventsPassesAttributesApi.
40067
40140
  */
@@ -40105,6 +40178,14 @@ export declare class EventsPassesAttributesApi extends BaseAPI {
40105
40178
  * @throws {RequiredError}
40106
40179
  */
40107
40180
  getEventPassAttributes(requestParameters: EventsPassesAttributesApiGetEventPassAttributesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GetEventPassAttributes200Response, any, {}, any>>;
40181
+ /**
40182
+ * Creates or updates attribute values 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, and each attributeId may be an attribute id or its name. Rows whose pass or attribute cannot be resolved are reported back as invalid and skipped rather than failing the batch. Requires read permission on events and read/update permission on attendees.
40183
+ * @summary Bulk set custom attribute values across many passes
40184
+ * @param {EventsPassesAttributesApiImportEventPassAttributesRequest} requestParameters Request parameters.
40185
+ * @param {*} [options] Override http request option.
40186
+ * @throws {RequiredError}
40187
+ */
40188
+ importEventPassAttributes(requestParameters: EventsPassesAttributesApiImportEventPassAttributesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ImportEventPassAttributes200Response, any, {}, any>>;
40108
40189
  /**
40109
40190
  * Deletes a single custom attribute value that had been set on the specified event pass, requires read permission on events and read/update permission on attendees.
40110
40191
  * @summary Remove a custom attribute from a pass
@@ -73967,7 +74048,7 @@ export declare class SelfApi extends BaseAPI {
73967
74048
  */
73968
74049
  export declare const SelfApikeysApiAxiosParamCreator: (configuration?: Configuration) => {
73969
74050
  /**
73970
- * Generates a new personal API key for the authenticated user with the given name, description, and validity window, returning the full key value only once at creation time.
74051
+ * Generates a new personal API key for the authenticated user with the given name, description, scope, and validity window, returning the full key value only once at creation time.
73971
74052
  * @summary Create an API key for the current user
73972
74053
  * @param {UserApiKeyCreateInputs} userApiKeyCreateInputs
73973
74054
  * @param {*} [options] Override http request option.
@@ -74007,7 +74088,7 @@ export declare const SelfApikeysApiAxiosParamCreator: (configuration?: Configura
74007
74088
  */
74008
74089
  export declare const SelfApikeysApiFp: (configuration?: Configuration) => {
74009
74090
  /**
74010
- * Generates a new personal API key for the authenticated user with the given name, description, and validity window, returning the full key value only once at creation time.
74091
+ * Generates a new personal API key for the authenticated user with the given name, description, scope, and validity window, returning the full key value only once at creation time.
74011
74092
  * @summary Create an API key for the current user
74012
74093
  * @param {UserApiKeyCreateInputs} userApiKeyCreateInputs
74013
74094
  * @param {*} [options] Override http request option.
@@ -74047,7 +74128,7 @@ export declare const SelfApikeysApiFp: (configuration?: Configuration) => {
74047
74128
  */
74048
74129
  export declare const SelfApikeysApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
74049
74130
  /**
74050
- * Generates a new personal API key for the authenticated user with the given name, description, and validity window, returning the full key value only once at creation time.
74131
+ * Generates a new personal API key for the authenticated user with the given name, description, scope, and validity window, returning the full key value only once at creation time.
74051
74132
  * @summary Create an API key for the current user
74052
74133
  * @param {SelfApikeysApiCreateSelfApiKeyRequest} requestParameters Request parameters.
74053
74134
  * @param {*} [options] Override http request option.
@@ -74129,7 +74210,7 @@ export interface SelfApikeysApiGetSelfApiKeysRequest {
74129
74210
  */
74130
74211
  export declare class SelfApikeysApi extends BaseAPI {
74131
74212
  /**
74132
- * Generates a new personal API key for the authenticated user with the given name, description, and validity window, returning the full key value only once at creation time.
74213
+ * Generates a new personal API key for the authenticated user with the given name, description, scope, and validity window, returning the full key value only once at creation time.
74133
74214
  * @summary Create an API key for the current user
74134
74215
  * @param {SelfApikeysApiCreateSelfApiKeyRequest} requestParameters Request parameters.
74135
74216
  * @param {*} [options] Override http request option.
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.9.0
7
+ * The version of the OpenAPI document: 11.10.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2047,6 +2047,10 @@ export var ImageType;
2047
2047
  ImageType["Event"] = "event";
2048
2048
  ImageType["Activation"] = "activation";
2049
2049
  })(ImageType || (ImageType = {}));
2050
+ export var ImportEventPassAttributes200ResponseStatusEnum;
2051
+ (function (ImportEventPassAttributes200ResponseStatusEnum) {
2052
+ ImportEventPassAttributes200ResponseStatusEnum["Ok"] = "ok";
2053
+ })(ImportEventPassAttributes200ResponseStatusEnum || (ImportEventPassAttributes200ResponseStatusEnum = {}));
2050
2054
  export var ImportItemStatus;
2051
2055
  (function (ImportItemStatus) {
2052
2056
  ImportItemStatus["Pending"] = "pending";
@@ -2338,6 +2342,11 @@ export var PageType;
2338
2342
  PageType["Terms"] = "terms";
2339
2343
  PageType["Team"] = "team";
2340
2344
  })(PageType || (PageType = {}));
2345
+ export var PassAttributeImportResultStatusEnum;
2346
+ (function (PassAttributeImportResultStatusEnum) {
2347
+ PassAttributeImportResultStatusEnum["Resolved"] = "resolved";
2348
+ PassAttributeImportResultStatusEnum["Invalid"] = "invalid";
2349
+ })(PassAttributeImportResultStatusEnum || (PassAttributeImportResultStatusEnum = {}));
2341
2350
  export var PassChangeLogType;
2342
2351
  (function (PassChangeLogType) {
2343
2352
  PassChangeLogType["Status"] = "status";
@@ -2879,6 +2888,11 @@ export var UpsertLinkPreview200ResponseStatusEnum;
2879
2888
  (function (UpsertLinkPreview200ResponseStatusEnum) {
2880
2889
  UpsertLinkPreview200ResponseStatusEnum["Ok"] = "ok";
2881
2890
  })(UpsertLinkPreview200ResponseStatusEnum || (UpsertLinkPreview200ResponseStatusEnum = {}));
2891
+ export var UserApiKeyScope;
2892
+ (function (UserApiKeyScope) {
2893
+ UserApiKeyScope["Read"] = "read";
2894
+ UserApiKeyScope["Full"] = "full";
2895
+ })(UserApiKeyScope || (UserApiKeyScope = {}));
2882
2896
  export var UserRole;
2883
2897
  (function (UserRole) {
2884
2898
  UserRole["Manager"] = "manager";
@@ -42524,6 +42538,45 @@ export const EventsPassesAttributesApiAxiosParamCreator = function (configuratio
42524
42538
  options: localVarRequestOptions,
42525
42539
  };
42526
42540
  }),
42541
+ /**
42542
+ * Creates or updates attribute values 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, and each attributeId may be an attribute id or its name. Rows whose pass or attribute cannot be resolved are reported back as invalid and skipped rather than failing the batch. Requires read permission on events and read/update permission on attendees.
42543
+ * @summary Bulk set custom attribute values across many passes
42544
+ * @param {string} eventId The event identifier
42545
+ * @param {PassAttributesImportInputs} passAttributesImportInputs
42546
+ * @param {*} [options] Override http request option.
42547
+ * @throws {RequiredError}
42548
+ */
42549
+ importEventPassAttributes: (eventId_1, passAttributesImportInputs_1, ...args_1) => __awaiter(this, [eventId_1, passAttributesImportInputs_1, ...args_1], void 0, function* (eventId, passAttributesImportInputs, options = {}) {
42550
+ // verify required parameter 'eventId' is not null or undefined
42551
+ assertParamExists('importEventPassAttributes', 'eventId', eventId);
42552
+ // verify required parameter 'passAttributesImportInputs' is not null or undefined
42553
+ assertParamExists('importEventPassAttributes', 'passAttributesImportInputs', passAttributesImportInputs);
42554
+ const localVarPath = `/events/{eventId}/passes/attributes/import`
42555
+ .replace('{eventId}', encodeURIComponent(String(eventId)));
42556
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
42557
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
42558
+ let baseOptions;
42559
+ if (configuration) {
42560
+ baseOptions = configuration.baseOptions;
42561
+ }
42562
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
42563
+ const localVarHeaderParameter = {};
42564
+ const localVarQueryParameter = {};
42565
+ // authentication ApiKeyAuth required
42566
+ yield setApiKeyToObject(localVarHeaderParameter, "api-key", configuration);
42567
+ // authentication OrganizationId required
42568
+ yield setApiKeyToObject(localVarHeaderParameter, "organization", configuration);
42569
+ localVarHeaderParameter['Content-Type'] = 'application/json';
42570
+ localVarHeaderParameter['Accept'] = 'application/json';
42571
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
42572
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
42573
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
42574
+ localVarRequestOptions.data = serializeDataIfNeeded(passAttributesImportInputs, localVarRequestOptions, configuration);
42575
+ return {
42576
+ url: toPathString(localVarUrlObj),
42577
+ options: localVarRequestOptions,
42578
+ };
42579
+ }),
42527
42580
  /**
42528
42581
  * Deletes a single custom attribute value that had been set on the specified event pass, requires read permission on events and read/update permission on attendees.
42529
42582
  * @summary Remove a custom attribute from a pass
@@ -42638,6 +42691,23 @@ export const EventsPassesAttributesApiFp = function (configuration) {
42638
42691
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
42639
42692
  });
42640
42693
  },
42694
+ /**
42695
+ * Creates or updates attribute values 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, and each attributeId may be an attribute id or its name. Rows whose pass or attribute cannot be resolved are reported back as invalid and skipped rather than failing the batch. Requires read permission on events and read/update permission on attendees.
42696
+ * @summary Bulk set custom attribute values across many passes
42697
+ * @param {string} eventId The event identifier
42698
+ * @param {PassAttributesImportInputs} passAttributesImportInputs
42699
+ * @param {*} [options] Override http request option.
42700
+ * @throws {RequiredError}
42701
+ */
42702
+ importEventPassAttributes(eventId, passAttributesImportInputs, options) {
42703
+ return __awaiter(this, void 0, void 0, function* () {
42704
+ var _a, _b, _c;
42705
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.importEventPassAttributes(eventId, passAttributesImportInputs, options);
42706
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
42707
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['EventsPassesAttributesApi.importEventPassAttributes']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
42708
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
42709
+ });
42710
+ },
42641
42711
  /**
42642
42712
  * Deletes a single custom attribute value that had been set on the specified event pass, requires read permission on events and read/update permission on attendees.
42643
42713
  * @summary Remove a custom attribute from a pass
@@ -42692,6 +42762,16 @@ export const EventsPassesAttributesApiFactory = function (configuration, basePat
42692
42762
  getEventPassAttributes(requestParameters, options) {
42693
42763
  return localVarFp.getEventPassAttributes(requestParameters.eventId, requestParameters.passId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(axios, basePath));
42694
42764
  },
42765
+ /**
42766
+ * Creates or updates attribute values 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, and each attributeId may be an attribute id or its name. Rows whose pass or attribute cannot be resolved are reported back as invalid and skipped rather than failing the batch. Requires read permission on events and read/update permission on attendees.
42767
+ * @summary Bulk set custom attribute values across many passes
42768
+ * @param {EventsPassesAttributesApiImportEventPassAttributesRequest} requestParameters Request parameters.
42769
+ * @param {*} [options] Override http request option.
42770
+ * @throws {RequiredError}
42771
+ */
42772
+ importEventPassAttributes(requestParameters, options) {
42773
+ return localVarFp.importEventPassAttributes(requestParameters.eventId, requestParameters.passAttributesImportInputs, options).then((request) => request(axios, basePath));
42774
+ },
42695
42775
  /**
42696
42776
  * Deletes a single custom attribute value that had been set on the specified event pass, requires read permission on events and read/update permission on attendees.
42697
42777
  * @summary Remove a custom attribute from a pass
@@ -42728,6 +42808,16 @@ export class EventsPassesAttributesApi extends BaseAPI {
42728
42808
  getEventPassAttributes(requestParameters, options) {
42729
42809
  return EventsPassesAttributesApiFp(this.configuration).getEventPassAttributes(requestParameters.eventId, requestParameters.passId, requestParameters.page, requestParameters.pageSize, requestParameters.orderBy, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
42730
42810
  }
42811
+ /**
42812
+ * Creates or updates attribute values 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, and each attributeId may be an attribute id or its name. Rows whose pass or attribute cannot be resolved are reported back as invalid and skipped rather than failing the batch. Requires read permission on events and read/update permission on attendees.
42813
+ * @summary Bulk set custom attribute values across many passes
42814
+ * @param {EventsPassesAttributesApiImportEventPassAttributesRequest} requestParameters Request parameters.
42815
+ * @param {*} [options] Override http request option.
42816
+ * @throws {RequiredError}
42817
+ */
42818
+ importEventPassAttributes(requestParameters, options) {
42819
+ return EventsPassesAttributesApiFp(this.configuration).importEventPassAttributes(requestParameters.eventId, requestParameters.passAttributesImportInputs, options).then((request) => request(this.axios, this.basePath));
42820
+ }
42731
42821
  /**
42732
42822
  * Deletes a single custom attribute value that had been set on the specified event pass, requires read permission on events and read/update permission on attendees.
42733
42823
  * @summary Remove a custom attribute from a pass
@@ -93941,7 +94031,7 @@ export class SelfApi extends BaseAPI {
93941
94031
  export const SelfApikeysApiAxiosParamCreator = function (configuration) {
93942
94032
  return {
93943
94033
  /**
93944
- * Generates a new personal API key for the authenticated user with the given name, description, and validity window, returning the full key value only once at creation time.
94034
+ * Generates a new personal API key for the authenticated user with the given name, description, scope, and validity window, returning the full key value only once at creation time.
93945
94035
  * @summary Create an API key for the current user
93946
94036
  * @param {UserApiKeyCreateInputs} userApiKeyCreateInputs
93947
94037
  * @param {*} [options] Override http request option.
@@ -94098,7 +94188,7 @@ export const SelfApikeysApiFp = function (configuration) {
94098
94188
  const localVarAxiosParamCreator = SelfApikeysApiAxiosParamCreator(configuration);
94099
94189
  return {
94100
94190
  /**
94101
- * Generates a new personal API key for the authenticated user with the given name, description, and validity window, returning the full key value only once at creation time.
94191
+ * Generates a new personal API key for the authenticated user with the given name, description, scope, and validity window, returning the full key value only once at creation time.
94102
94192
  * @summary Create an API key for the current user
94103
94193
  * @param {UserApiKeyCreateInputs} userApiKeyCreateInputs
94104
94194
  * @param {*} [options] Override http request option.
@@ -94173,7 +94263,7 @@ export const SelfApikeysApiFactory = function (configuration, basePath, axios) {
94173
94263
  const localVarFp = SelfApikeysApiFp(configuration);
94174
94264
  return {
94175
94265
  /**
94176
- * Generates a new personal API key for the authenticated user with the given name, description, and validity window, returning the full key value only once at creation time.
94266
+ * Generates a new personal API key for the authenticated user with the given name, description, scope, and validity window, returning the full key value only once at creation time.
94177
94267
  * @summary Create an API key for the current user
94178
94268
  * @param {SelfApikeysApiCreateSelfApiKeyRequest} requestParameters Request parameters.
94179
94269
  * @param {*} [options] Override http request option.
@@ -94219,7 +94309,7 @@ export const SelfApikeysApiFactory = function (configuration, basePath, axios) {
94219
94309
  */
94220
94310
  export class SelfApikeysApi extends BaseAPI {
94221
94311
  /**
94222
- * Generates a new personal API key for the authenticated user with the given name, description, and validity window, returning the full key value only once at creation time.
94312
+ * Generates a new personal API key for the authenticated user with the given name, description, scope, and validity window, returning the full key value only once at creation time.
94223
94313
  * @summary Create an API key for the current user
94224
94314
  * @param {SelfApikeysApiCreateSelfApiKeyRequest} requestParameters Request parameters.
94225
94315
  * @param {*} [options] Override http request option.
@@ -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.9.0
5
+ * The version of the OpenAPI document: 11.10.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.9.0
7
+ * The version of the OpenAPI document: 11.10.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.9.0
5
+ * The version of the OpenAPI document: 11.10.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -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.9.0
7
+ * The version of the OpenAPI document: 11.10.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.9.0
5
+ * The version of the OpenAPI document: 11.10.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.9.0
6
+ * The version of the OpenAPI document: 11.10.0
7
7
  *
8
8
  *
9
9
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -5,6 +5,7 @@ All URIs are relative to *https://admin-api.connected.dev*
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
7
7
  |[**getEventPassAttributes**](#geteventpassattributes) | **GET** /events/{eventId}/passes/{passId}/attributes | List an event pass\&#39;s attributes|
8
+ |[**importEventPassAttributes**](#importeventpassattributes) | **POST** /events/{eventId}/passes/attributes/import | Bulk set custom attribute values across many passes|
8
9
  |[**removeEventPassAttribute**](#removeeventpassattribute) | **DELETE** /events/{eventId}/passes/{passId}/attributes/{attributeId} | Remove a custom attribute from a pass|
9
10
  |[**updateEventPassAttributes**](#updateeventpassattributes) | **PUT** /events/{eventId}/passes/{passId}/attributes | Set custom attribute values on a pass|
10
11
 
@@ -67,6 +68,61 @@ const { status, data } = await apiInstance.getEventPassAttributes(
67
68
  - **Accept**: application/json
68
69
 
69
70
 
71
+ ### HTTP response details
72
+ | Status code | Description | Response headers |
73
+ |-------------|-------------|------------------|
74
+ |**200** | Successful response | - |
75
+
76
+ [[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)
77
+
78
+ # **importEventPassAttributes**
79
+ > ImportEventPassAttributes200Response importEventPassAttributes(passAttributesImportInputs)
80
+
81
+ Creates or updates attribute values 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, and each attributeId may be an attribute id or its name. Rows whose pass or attribute cannot be resolved are reported back as invalid and skipped rather than failing the batch. Requires read permission on events and read/update permission on attendees.
82
+
83
+ ### Example
84
+
85
+ ```typescript
86
+ import {
87
+ EventsPassesAttributesApi,
88
+ Configuration,
89
+ PassAttributesImportInputs
90
+ } from '@connectedxm/admin-sdk';
91
+
92
+ const configuration = new Configuration();
93
+ const apiInstance = new EventsPassesAttributesApi(configuration);
94
+
95
+ let eventId: string; //The event identifier (default to undefined)
96
+ let passAttributesImportInputs: PassAttributesImportInputs; //
97
+
98
+ const { status, data } = await apiInstance.importEventPassAttributes(
99
+ eventId,
100
+ passAttributesImportInputs
101
+ );
102
+ ```
103
+
104
+ ### Parameters
105
+
106
+ |Name | Type | Description | Notes|
107
+ |------------- | ------------- | ------------- | -------------|
108
+ | **passAttributesImportInputs** | **PassAttributesImportInputs**| | |
109
+ | **eventId** | [**string**] | The event identifier | defaults to undefined|
110
+
111
+
112
+ ### Return type
113
+
114
+ **ImportEventPassAttributes200Response**
115
+
116
+ ### Authorization
117
+
118
+ [ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)
119
+
120
+ ### HTTP request headers
121
+
122
+ - **Content-Type**: application/json
123
+ - **Accept**: application/json
124
+
125
+
70
126
  ### HTTP response details
71
127
  | Status code | Description | Response headers |
72
128
  |-------------|-------------|------------------|
@@ -0,0 +1,24 @@
1
+ # ImportEventPassAttributes200Response
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** | [**PassAttributeImportSummary**](PassAttributeImportSummary.md) | | [default to undefined]
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import { ImportEventPassAttributes200Response } from '@connectedxm/admin-sdk';
16
+
17
+ const instance: ImportEventPassAttributes200Response = {
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
+ # PassAttributeImportResult
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 { PassAttributeImportResult } from '@connectedxm/admin-sdk';
17
+
18
+ const instance: PassAttributeImportResult = {
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,26 @@
1
+ # PassAttributeImportSummary
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **created** | **number** | | [default to undefined]
9
+ **updated** | **number** | | [default to undefined]
10
+ **unchanged** | **number** | | [default to undefined]
11
+ **results** | [**Array&lt;PassAttributeImportResult&gt;**](PassAttributeImportResult.md) | | [default to undefined]
12
+
13
+ ## Example
14
+
15
+ ```typescript
16
+ import { PassAttributeImportSummary } from '@connectedxm/admin-sdk';
17
+
18
+ const instance: PassAttributeImportSummary = {
19
+ created,
20
+ updated,
21
+ unchanged,
22
+ results,
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,20 @@
1
+ # PassAttributesImportInputs
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **rows** | [**Array&lt;PassAttributesImportInputsRowsInner&gt;**](PassAttributesImportInputsRowsInner.md) | | [default to undefined]
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import { PassAttributesImportInputs } from '@connectedxm/admin-sdk';
14
+
15
+ const instance: PassAttributesImportInputs = {
16
+ rows,
17
+ };
18
+ ```
19
+
20
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,22 @@
1
+ # PassAttributesImportInputsRowsInner
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **passId** | **string** | | [default to undefined]
9
+ **values** | [**Array&lt;PassAttributesUpdateInputsValuesInner&gt;**](PassAttributesUpdateInputsValuesInner.md) | | [default to undefined]
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import { PassAttributesImportInputsRowsInner } from '@connectedxm/admin-sdk';
15
+
16
+ const instance: PassAttributesImportInputsRowsInner = {
17
+ passId,
18
+ values,
19
+ };
20
+ ```
21
+
22
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -12,7 +12,7 @@ All URIs are relative to *https://admin-api.connected.dev*
12
12
  # **createSelfApiKey**
13
13
  > CreateSelfApiKey200Response createSelfApiKey(userApiKeyCreateInputs)
14
14
 
15
- Generates a new personal API key for the authenticated user with the given name, description, and validity window, returning the full key value only once at creation time.
15
+ Generates a new personal API key for the authenticated user with the given name, description, scope, and validity window, returning the full key value only once at creation time.
16
16
 
17
17
  ### Example
18
18
 
@@ -10,6 +10,7 @@ Name | Type | Description | Notes
10
10
  **key** | **string** | | [default to undefined]
11
11
  **name** | **string** | | [default to undefined]
12
12
  **description** | **string** | | [optional] [default to undefined]
13
+ **scope** | [**UserApiKeyScope**](UserApiKeyScope.md) | | [default to undefined]
13
14
  **startDate** | **string** | | [default to undefined]
14
15
  **endDate** | **string** | | [default to undefined]
15
16
  **createdAt** | **string** | | [default to undefined]
@@ -27,6 +28,7 @@ const instance: UserApiKey = {
27
28
  key,
28
29
  name,
29
30
  description,
31
+ scope,
30
32
  startDate,
31
33
  endDate,
32
34
  createdAt,